MyGUI::MultiList Class Reference

#include <MyGUI_MultiList.h>

Inheritance diagram for MyGUI::MultiList:
Inheritance graph
[legend]

Data Structures

struct  ColumnInfo

Public Member Functions

 MultiList ()
size_t getColumnCount ()
 Get number of columns.
void insertColumnAt (size_t _column, const UString &_name, int _width, Any _data=Any::Null)
void addColumn (const UString &_name, int _width, Any _data=Any::Null)
void removeColumnAt (size_t _column)
void removeAllColumns ()
void setColumnNameAt (size_t _column, const UString &_name)
void setColumnWidthAt (size_t _column, int _width)
const UStringgetColumnNameAt (size_t _column)
int getColumnWidthAt (size_t _column)
void sortByColumn (size_t _column, bool _backward=false)
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 ()
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 ()
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 void _initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin *_info, WidgetPtr _parent, ICroppedRectangle *_croppedParent, IWidgetCreator *_creator, const std::string &_name)
 __declspec (deprecated("use : size_t MultiList::getIndexSelected()")) size_t getItemIndexSelected()
 __declspec (deprecated("use : void MultiList::setIndexSelected(size_t _index)")) void setItemSelectedAt(size_t _index)
 __declspec (deprecated("use : void MultiList::clearIndexSelected()")) void clearItemSelected()
 __declspec (deprecated("use : size_t MultiList::findSubItemWith(size_t _column, const UString& _name)")) size_t findItem(size_t _column
void baseChangeWidgetSkin (ResourceSkin *_info)
void notifyListChangePosition (ListPtr _sender, size_t _position)
void notifyListChangeFocus (ListPtr _sender, size_t _position)
void notifyListChangeScrollPosition (ListPtr _sender, size_t _position)
void notifyButtonClick (WidgetPtr _sender)
void notifyListSelectAccept (ListPtr _sender, size_t _position)
void updateColumns ()
void redrawButtons ()
void updateOnlyEmpty ()
bool compare (ListPtr _list, size_t _left, size_t _right)
void sortList ()
void flipList ()
WidgetPtr getSeparator (size_t _index)
void setButtonImageIndex (ButtonPtr _button, size_t _index)
void updateBackSelected (size_t _index)

Data Fields

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

Detailed Description

Definition at line 42 of file MyGUI_MultiList.h.


Constructor & Destructor Documentation

MyGUI::MultiList::MultiList (  ) 

Definition at line 35 of file MyGUI_MultiList.cpp.


Member Function Documentation

MyGUI::MultiList::__declspec ( deprecated("use : size_t MultiList::findSubItemWith(size_t _column, const UString& _name)")   ) 
Deprecated:
"use : size_t MultiList::findSubItemWith(size_t _column, const UString& _name)"
MyGUI::MultiList::__declspec ( deprecated("use : void MultiList::clearIndexSelected()")   )  [inline]
Deprecated:
"use : void MultiList::clearIndexSelected()"

Definition at line 262 of file MyGUI_MultiList.h.

MyGUI::MultiList::__declspec ( deprecated("use : void MultiList::setIndexSelected(size_t _index)")   )  [inline]
Deprecated:
"use : void MultiList::setIndexSelected(size_t _index)"

Definition at line 260 of file MyGUI_MultiList.h.

MyGUI::MultiList::__declspec ( deprecated("use : size_t MultiList::getIndexSelected()")   )  [inline]
Deprecated:
"use : size_t MultiList::getIndexSelected()"

Definition at line 258 of file MyGUI_MultiList.h.

void MyGUI::MultiList::_initialise ( WidgetStyle  _style,
const IntCoord _coord,
Align  _align,
ResourceSkin _info,
WidgetPtr  _parent,
ICroppedRectangle _croppedParent,
IWidgetCreator _creator,
const std::string &  _name 
) [virtual]

Definition at line 50 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::addColumn ( const UString _name,
int  _width,
Any  _data = Any::Null 
) [inline]

Add new column at last position

Parameters:
_width Width of new column
_name Name of new column

Definition at line 70 of file MyGUI_MultiList.h.

void MyGUI::MultiList::addItem ( const UString _name,
Any  _data = Any::Null 
) [inline]

Add new item at the end

Definition at line 137 of file MyGUI_MultiList.h.

void MyGUI::MultiList::baseChangeWidgetSkin ( ResourceSkin _info  )  [virtual]

Reimplemented from MyGUI::Widget.

Definition at line 63 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::clearColumnDataAt ( size_t  _index  )  [inline]

Clear an item data at a specified position.

Definition at line 110 of file MyGUI_MultiList.h.

void MyGUI::MultiList::clearIndexSelected (  )  [inline]

Clear item selection

Definition at line 169 of file MyGUI_MultiList.h.

void MyGUI::MultiList::clearItemDataAt ( size_t  _index  )  [inline]

Clear an item data at a specified position.

Definition at line 179 of file MyGUI_MultiList.h.

void MyGUI::MultiList::clearSubItemDataAt ( size_t  _column,
size_t  _index 
) [inline]

Clear an item data at a specified position.

Definition at line 214 of file MyGUI_MultiList.h.

bool MyGUI::MultiList::compare ( ListPtr  _list,
size_t  _left,
size_t  _right 
)

Definition at line 489 of file MyGUI_MultiList.cpp.

size_t MyGUI::MultiList::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 308 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::flipList (  ) 

Definition at line 466 of file MyGUI_MultiList.cpp.

size_t MyGUI::MultiList::getColumnCount (  )  [inline]

Get number of columns.

Definition at line 57 of file MyGUI_MultiList.h.

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

Get item data from specified position.

Definition at line 114 of file MyGUI_MultiList.h.

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

Get _column name

Definition at line 168 of file MyGUI_MultiList.cpp.

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

Get _column width

Definition at line 174 of file MyGUI_MultiList.cpp.

size_t MyGUI::MultiList::getIndexSelected (  )  [inline]

Get index of selected item (ITEM_NONE if none selected)

Definition at line 163 of file MyGUI_MultiList.h.

size_t MyGUI::MultiList::getItemCount (  ) 
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 238 of file MyGUI_MultiList.cpp.

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

Get item data from specified position.

Definition at line 183 of file MyGUI_MultiList.h.

const UString& MyGUI::MultiList::getItemNameAt ( size_t  _index  )  [inline]

Get item name from specified position.

Definition at line 156 of file MyGUI_MultiList.h.

WidgetPtr MyGUI::MultiList::getSeparator ( size_t  _index  ) 

Definition at line 427 of file MyGUI_MultiList.cpp.

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

Get item data from specified position.

Definition at line 218 of file MyGUI_MultiList.h.

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

Get sub item name

Definition at line 299 of file MyGUI_MultiList.cpp.

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

Insert new column

Parameters:
_column New column will be inserted before _column
_name Name of new column
_width Width of new column

Definition at line 115 of file MyGUI_MultiList.cpp.

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

Insert new item before _index line

Definition at line 533 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::notifyButtonClick ( MyGUI::WidgetPtr  _sender  ) 

Definition at line 367 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::notifyListChangeFocus ( ListPtr  _sender,
size_t  _position 
)

Definition at line 348 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::notifyListChangePosition ( ListPtr  _sender,
size_t  _position 
)

Definition at line 328 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::notifyListChangeScrollPosition ( ListPtr  _sender,
size_t  _position 
)

Definition at line 359 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::notifyListSelectAccept ( ListPtr  _sender,
size_t  _position 
)

Definition at line 342 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::redrawButtons (  ) 

Definition at line 373 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::removeAllColumns (  ) 

Delete all columns

Definition at line 205 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::removeAllItems (  ) 

Delete all items

Reimplemented from MyGUI::BiIndexBase.

Definition at line 244 of file MyGUI_MultiList.cpp.

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

Delete column

Definition at line 180 of file MyGUI_MultiList.cpp.

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

Remove item at a specified position.

Reimplemented from MyGUI::BiIndexBase.

Definition at line 555 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::setButtonImageIndex ( ButtonPtr  _button,
size_t  _index 
)

Definition at line 387 of file MyGUI_MultiList.cpp.

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

Replace an item data at a specified position.

Definition at line 589 of file MyGUI_MultiList.cpp.

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

Set column name

Parameters:
_column Index of column
_name New name of column

Definition at line 154 of file MyGUI_MultiList.cpp.

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

Set column width

Parameters:
_column Index of column
_name New width of column

Definition at line 161 of file MyGUI_MultiList.cpp.

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

Select specified _index

Definition at line 276 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::setItemDataAt ( size_t  _index,
Any  _data 
) [inline]

Replace an item data at a specified position.

Definition at line 176 of file MyGUI_MultiList.h.

void MyGUI::MultiList::setItemNameAt ( size_t  _index,
const UString _name 
) [inline]

Replace an item name.

Definition at line 153 of file MyGUI_MultiList.h.

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

Replace an item data at a specified position.

Definition at line 595 of file MyGUI_MultiList.cpp.

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

Set sub item

Parameters:
_column Index of column
_index Index of line
_name New sub item value

Definition at line 287 of file MyGUI_MultiList.cpp.

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

Sort multilist by column

Definition at line 220 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::sortList (  ) 

Definition at line 498 of file MyGUI_MultiList.cpp.

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

Swap items at a specified positions.

Definition at line 576 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::updateBackSelected ( size_t  _index  ) 

Definition at line 261 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::updateColumns (  ) 

Definition at line 441 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::updateOnlyEmpty (  ) 

Definition at line 317 of file MyGUI_MultiList.cpp.


Field Documentation

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

Parameters:
_sender widget that called this event
_index of new item

Definition at line 243 of file MyGUI_MultiList.h.

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

Parameters:
_sender widget that called this event
_index of selected item

Definition at line 236 of file MyGUI_MultiList.h.

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

Parameters:
_sender widget that called this event
_column Index of column
_firstItem Strings for compare
_secondItem Strings for compare
_less Comparsion result (write your value here)

Definition at line 253 of file MyGUI_MultiList.h.


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

Generated on 3 Dec 2009 for MyGUI by  doxygen 1.6.1