MyGUI  3.2.1
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions
MyGUI::MultiListBox Class Reference

MultiListBox properties. Skin childs. MultiListBox widget description should be here. More...

#include <MyGUI_MultiListBox.h>

+ Inheritance diagram for MyGUI::MultiListBox:

Data Structures

struct  ColumnInfo

Public Types

typedef RTTIBase Base
typedef MultiListBox RTTIBase

Public Member Functions

virtual const std::string & getTypeName () const
virtual bool isType (const std::type_info &_type) const
template<typename Type >
bool isType () const
 MultiListBox ()
virtual void setPosition (const IntPoint &_value)
virtual void setSize (const IntSize &_value)
virtual void setCoord (const IntCoord &_value)
void setPosition (int _left, int _top)
void setSize (int _width, int _height)
void setCoord (int _left, int _top, int _width, int _height)
size_t getColumnCount () const
 Get number of columns.
void insertColumnAt (size_t _column, const UString &_name, int _width=0, Any _data=Any::Null)
void addColumn (const UString &_name, int _width=0, Any _data=Any::Null)
void removeColumnAt (size_t _column)
void removeAllColumns ()
void swapColumnsAt (size_t _index1, size_t _index2)
 Swap columns at a specified positions.
void setColumnNameAt (size_t _column, const UString &_name)
void setColumnName (MultiListItem *_item, const UString &_name)
void setColumnWidthAt (size_t _column, int _width)
void setColumnWidth (MultiListItem *_item, int _width)
const UStringgetColumnNameAt (size_t _column)
const UStringgetColumnName (MultiListItem *_item)
int getColumnWidthAt (size_t _column)
void sortByColumn (size_t _column, bool _backward=false)
size_t getColumnIndex (MultiListItem *_item)
 Get column index.
void setColumnResizingPolicy (MultiListItem *_item, ResizingPolicy _value)
void setColumnResizingPolicyAt (size_t _index, ResizingPolicy _value)
void setColumnDataAt (size_t _index, Any _data)
 Replace an item data at a specified position.
void clearColumnDataAt (size_t _index)
 Clear an item data at a specified position.
template<typename ValueType >
ValueType * getColumnDataAt (size_t _index, bool _throw=true)
 Get item data from specified position.
size_t getItemCount () const
void insertItemAt (size_t _index, const UString &_name, Any _data=Any::Null)
void addItem (const UString &_name, Any _data=Any::Null)
void removeItemAt (size_t _index)
 Remove item at a specified position.
void removeAllItems ()
void swapItemsAt (size_t _index1, size_t _index2)
 Swap items at a specified positions.
void setItemNameAt (size_t _index, const UString &_name)
 Replace an item name.
const UStringgetItemNameAt (size_t _index)
 Get item name from specified position.
size_t getIndexSelected () const
void setIndexSelected (size_t _index)
void clearIndexSelected ()
void setItemDataAt (size_t _index, Any _data)
 Replace an item data at a specified position.
void clearItemDataAt (size_t _index)
 Clear an item data at a specified position.
template<typename ValueType >
ValueType * getItemDataAt (size_t _index, bool _throw=true)
 Get item data from specified position.
void setSubItemNameAt (size_t _column, size_t _index, const UString &_name)
const UStringgetSubItemNameAt (size_t _column, size_t _index)
size_t findSubItemWith (size_t _column, const UString &_name)
void setSubItemDataAt (size_t _column, size_t _index, Any _data)
 Replace an item data at a specified position.
void clearSubItemDataAt (size_t _column, size_t _index)
 Clear an item data at a specified position.
template<typename ValueType >
ValueType * getSubItemDataAt (size_t _column, size_t _index, bool _throw=true)
 Get item data from specified position.
virtual size_t _getItemCount ()
virtual void _addItem (const MyGUI::UString &_name)
virtual void _removeItemAt (size_t _index)
virtual Widget_getItemAt (size_t _index)
virtual void _setItemNameAt (size_t _index, const UString &_name)
virtual const UString_getItemNameAt (size_t _index)

Static Public Member Functions

static const std::string & getClassTypeName ()

Data Fields

EventPair
< EventHandle_WidgetSizeT,
EventHandle_MultiListPtrSizeT
eventListSelectAccept
EventPair
< EventHandle_WidgetSizeT,
EventHandle_MultiListPtrSizeT
eventListChangePosition
EventHandle_MultiListPtrSizeTCUTFStringRefCUTFStringRefBoolRef requestOperatorLess

Protected Member Functions

virtual void initialiseOverride ()
virtual void shutdownOverride ()
virtual void onWidgetCreated (Widget *_widget)
virtual void onWidgetDestroy (Widget *_widget)

Detailed Description

MultiListBox properties. Skin childs. MultiListBox widget description should be here.

Definition at line 32 of file MyGUI_MultiListBox.h.


Member Typedef Documentation

Reimplemented from MyGUI::Widget.

Definition at line 38 of file MyGUI_MultiListBox.h.

Reimplemented from MyGUI::Widget.

Definition at line 38 of file MyGUI_MultiListBox.h.


Constructor & Destructor Documentation

Definition at line 20 of file MyGUI_MultiListBox.cpp.


Member Function Documentation

void MyGUI::MultiListBox::_addItem ( const MyGUI::UString _name) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 580 of file MyGUI_MultiListBox.cpp.

Widget * MyGUI::MultiListBox::_getItemAt ( size_t  _index) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 763 of file MyGUI_MultiListBox.cpp.

size_t MyGUI::MultiListBox::_getItemCount ( ) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 575 of file MyGUI_MultiListBox.cpp.

const UString & MyGUI::MultiListBox::_getItemNameAt ( size_t  _index) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 596 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::_removeItemAt ( size_t  _index) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 586 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::_setItemNameAt ( size_t  _index,
const UString _name 
) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 591 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::addColumn ( const UString _name,
int  _width = 0,
Any  _data = Any::Null 
)

Add new column at last position

Parameters:
_widthWidth of new column
_nameName of new column
_dataAny data associated with new column

Definition at line 519 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::addItem ( const UString _name,
Any  _data = Any::Null 
)

Add new item at the end

Definition at line 529 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::clearColumnDataAt ( size_t  _index)

Clear an item data at a specified position.

Definition at line 524 of file MyGUI_MultiListBox.cpp.

Clear item selection

Definition at line 549 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::clearItemDataAt ( size_t  _index)

Clear an item data at a specified position.

Definition at line 559 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::clearSubItemDataAt ( size_t  _column,
size_t  _index 
)

Clear an item data at a specified position.

Definition at line 564 of file MyGUI_MultiListBox.cpp.

size_t MyGUI::MultiListBox::findSubItemWith ( size_t  _column,
const UString _name 
)

Search item in specified _column, returns index of the first occurrence in column or ITEM_NONE if item not found

Definition at line 216 of file MyGUI_MultiListBox.cpp.

static const std::string& MyGUI::MultiListBox::getClassTypeName ( ) [inline, static]

Reimplemented from MyGUI::Widget.

Definition at line 38 of file MyGUI_MultiListBox.h.

Get number of columns.

Definition at line 514 of file MyGUI_MultiListBox.cpp.

template<typename ValueType >
ValueType* MyGUI::MultiListBox::getColumnDataAt ( size_t  _index,
bool  _throw = true 
) [inline]

Get item data from specified position.

Definition at line 153 of file MyGUI_MultiListBox.h.

Get column index.

Definition at line 779 of file MyGUI_MultiListBox.cpp.

Get _column name

Definition at line 774 of file MyGUI_MultiListBox.cpp.

const UString & MyGUI::MultiListBox::getColumnNameAt ( size_t  _column)

Get _column name

Definition at line 109 of file MyGUI_MultiListBox.cpp.

int MyGUI::MultiListBox::getColumnWidthAt ( size_t  _column)

Get _column width

Definition at line 115 of file MyGUI_MultiListBox.cpp.

Get index of selected item (ITEM_NONE if none selected)

Definition at line 544 of file MyGUI_MultiListBox.cpp.

Note:
All indexes used here is indexes of unsorted Multilist. Even if you sorted it - all items indexes will be same as before sort. Get number of items (lines)

Definition at line 148 of file MyGUI_MultiListBox.cpp.

template<typename ValueType >
ValueType* MyGUI::MultiListBox::getItemDataAt ( size_t  _index,
bool  _throw = true 
) [inline]

Get item data from specified position.

Definition at line 222 of file MyGUI_MultiListBox.h.

const UString & MyGUI::MultiListBox::getItemNameAt ( size_t  _index)

Get item name from specified position.

Definition at line 539 of file MyGUI_MultiListBox.cpp.

template<typename ValueType >
ValueType* MyGUI::MultiListBox::getSubItemDataAt ( size_t  _column,
size_t  _index,
bool  _throw = true 
) [inline]

Get item data from specified position.

Definition at line 257 of file MyGUI_MultiListBox.h.

const UString & MyGUI::MultiListBox::getSubItemNameAt ( size_t  _column,
size_t  _index 
)

Get sub item name

Definition at line 208 of file MyGUI_MultiListBox.cpp.

virtual const std::string& MyGUI::MultiListBox::getTypeName ( ) const [inline, virtual]

Get type name as string

Reimplemented from MyGUI::Widget.

Definition at line 38 of file MyGUI_MultiListBox.h.

void MyGUI::MultiListBox::initialiseOverride ( ) [protected, virtual]
skin clilds:
HeaderPlace is child widget with type Widget. Место для заголовков колонок.
skin clilds:
Client is child widget with type Widget. Клиентская зона.
skin clilds:
Empty is child widget with type Widget. Виджет для заголовка в месте где нет списков.

Reimplemented from MyGUI::Widget.

Definition at line 35 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::insertColumnAt ( size_t  _column,
const UString _name,
int  _width = 0,
Any  _data = Any::Null 
)

Insert new column

Parameters:
_columnNew column will be inserted before _column
_nameName of new column
_widthWidth of new column
_dataAny data associated with new column

Definition at line 601 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::insertItemAt ( size_t  _index,
const UString _name,
Any  _data = Any::Null 
)

Insert new item before _index line

Definition at line 436 of file MyGUI_MultiListBox.cpp.

template<typename Type >
bool MyGUI::MultiListBox::isType ( ) const [inline]

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 38 of file MyGUI_MultiListBox.h.

virtual bool MyGUI::MultiListBox::isType ( const std::type_info &  _type) const [inline, virtual]

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 38 of file MyGUI_MultiListBox.h.

void MyGUI::MultiListBox::onWidgetCreated ( Widget _widget) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 659 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::onWidgetDestroy ( Widget _widget) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 670 of file MyGUI_MultiListBox.cpp.

Delete all columns

Definition at line 121 of file MyGUI_MultiListBox.cpp.

Delete all items

Reimplemented from MyGUI::BiIndexBase.

Definition at line 155 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::removeColumnAt ( size_t  _column)

Delete column

Definition at line 627 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::removeItemAt ( size_t  _index)

Remove item at a specified position.

Reimplemented from MyGUI::BiIndexBase.

Definition at line 461 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setColumnDataAt ( size_t  _index,
Any  _data 
)

Replace an item data at a specified position.

Definition at line 500 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setColumnName ( MultiListItem _item,
const UString _name 
)

Set column name

Parameters:
_itemcolumn
_nameNew name of column

Definition at line 769 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setColumnNameAt ( size_t  _column,
const UString _name 
)

Set column name

Parameters:
_columnIndex of column
_nameNew name of column

Definition at line 93 of file MyGUI_MultiListBox.cpp.

Set resizing policy of column.

See also:
ResizingPolicy
Parameters:
_itemPointer to column
_valueNew resizing policy for column

Definition at line 790 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setColumnResizingPolicyAt ( size_t  _index,
ResizingPolicy  _value 
)

Set resizing policy of column.

See also:
ResizingPolicy
Parameters:
_indexIndex of column
_valueNew resizing policy for column

Definition at line 795 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setColumnWidth ( MultiListItem _item,
int  _width 
)

Set column width

Parameters:
_itemcolumn
_widthNew width of column

Definition at line 802 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setColumnWidthAt ( size_t  _column,
int  _width 
)

Set column width

Parameters:
_columnIndex of column
_widthNew width of column

Definition at line 102 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setCoord ( const IntCoord _value) [virtual]

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 820 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setCoord ( int  _left,
int  _top,
int  _width,
int  _height 
)

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 838 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setIndexSelected ( size_t  _index)

Select specified _index

Definition at line 184 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setItemDataAt ( size_t  _index,
Any  _data 
)

Replace an item data at a specified position.

Definition at line 554 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setItemNameAt ( size_t  _index,
const UString _name 
)

Replace an item name.

Definition at line 534 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setPosition ( const IntPoint _value) [virtual]

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 807 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setPosition ( int  _left,
int  _top 
)

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 828 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setSize ( const IntSize _value) [virtual]

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 812 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setSize ( int  _width,
int  _height 
)

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 833 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setSubItemDataAt ( size_t  _column,
size_t  _index,
Any  _data 
)

Replace an item data at a specified position.

Definition at line 506 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::setSubItemNameAt ( size_t  _column,
size_t  _index,
const UString _name 
)

Set sub item

Parameters:
_columnIndex of column
_indexIndex of line
_nameNew sub item value

Definition at line 196 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::shutdownOverride ( ) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 86 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::sortByColumn ( size_t  _column,
bool  _backward = false 
)

Sort multilist by column

Definition at line 127 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::swapColumnsAt ( size_t  _index1,
size_t  _index2 
)

Swap columns at a specified positions.

Definition at line 636 of file MyGUI_MultiListBox.cpp.

void MyGUI::MultiListBox::swapItemsAt ( size_t  _index1,
size_t  _index2 
)

Swap items at a specified positions.

Definition at line 487 of file MyGUI_MultiListBox.cpp.


Field Documentation

Event : Selected item position changed.
signature : void method(MyGUI::MultiListBox* _sender, size_t _index)

Parameters:
_senderwidget that called this event
_indexof new item

Definition at line 278 of file MyGUI_MultiListBox.h.

Event : Enter pressed or double click.
signature : void method(MyGUI::MultiListBox* _sender, size_t _index)

Parameters:
_senderwidget that called this event
_indexof selected item

Definition at line 271 of file MyGUI_MultiListBox.h.

Event : Less than operator for sort multilist by columns.
signature : void method(MyGUI::MultiListBox* _sender, size_t _column, const MyGUI::UString& _firstItem, const MyGUI::UString& _secondItem, bool& _less)

Parameters:
_senderwidget that called this event
_columnIndex of column
_firstItemStrings for compare
_secondItemStrings for compare
_lessComparsion result (write your value here)

Definition at line 288 of file MyGUI_MultiListBox.h.


The documentation for this class was generated from the following files: