MyGUI  3.0.1
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions
MyGUI::MultiList Class Reference

#include <MyGUI_MultiList.h>

+ Inheritance diagram for MyGUI::MultiList:

Data Structures

struct  ColumnInfo

Public Types

typedef RTTIBase Base
typedef MultiList RTTIBase
- Public Types inherited from MyGUI::Widget
typedef Widget RTTIBase
- Public Types inherited from MyGUI::IObject
typedef IObject 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
 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 () 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 ()
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, Widget *_parent, ICroppedRectangle *_croppedParent, IWidgetCreator *_creator, const std::string &_name)
size_t getItemIndexSelected ()
void setItemSelectedAt (size_t _index)
void clearItemSelected ()
size_t findItem (size_t _column, const UString &_name)
const UStringgetSubItem (size_t _column, size_t _index)
void setSubItem (size_t _column, size_t _index, const UString &_name)
void deleteColumn (size_t _column)
void deleteAllColumns ()
int getColumnWidth (size_t _column)
const UStringgetColumnName (size_t _column)
void setColumnWidth (size_t _column, int _width)
void addColumn (int _width, const UString &_name)
void setColumnName (size_t _column, const UString &_name)
void insertColumn (size_t _column, int _width, const UString &_name)
size_t getItemSelect ()
void resetItemSelect ()
void setItemSelect (size_t _index)
void insertItem (size_t _index, const UString &_name)
void setItem (size_t _index, const UString &_name)
const UStringgetItem (size_t _index)
void deleteItem (size_t _index)
void deleteAllItems ()
- Public Member Functions inherited from MyGUI::Widget
template<typename Type >
Type * castType (bool _throw=true)
template<typename Type >
const Type * castType (bool _throw=true) const
 Widget ()
WidgetcreateWidgetT (const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")
WidgetcreateWidgetT (const std::string &_type, const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")
WidgetcreateWidgetRealT (const std::string &_type, const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")
WidgetcreateWidgetRealT (const std::string &_type, const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")
template<typename T >
T * createWidget (const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")
template<typename T >
T * createWidget (const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")
template<typename T >
T * createWidgetReal (const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")
template<typename T >
T * createWidgetReal (const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")
WidgetcreateWidgetT (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")
template<typename T >
T * createWidget (WidgetStyle _style, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")
const std::string & getName () const
 Get name of widget.
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)
void setRealPosition (const FloatPoint &_value)
void setRealSize (const FloatSize &_value)
void setRealCoord (const FloatCoord &_value)
void setRealPosition (float _left, float _top)
void setRealSize (float _width, float _height)
void setRealCoord (float _left, float _top, float _width, float _height)
virtual void setVisible (bool _value)
virtual void setAlign (Align _value)
virtual void setCaption (const UString &_value)
virtual const UStringgetCaption ()
void setAlpha (float _value)
float getAlpha ()
void setInheritsAlpha (bool _value)
bool isInheritsAlpha ()
bool setState (const std::string &_value)
void setColour (const Colour &_value)
bool isRootWidget ()
WidgetgetParent ()
EnumeratorWidgetPtr getEnumerator ()
size_t getChildCount ()
WidgetgetChildAt (size_t _index)
WidgetfindWidget (const std::string &_name)
void setNeedKeyFocus (bool _value)
bool isNeedKeyFocus ()
void setNeedMouseFocus (bool _value)
bool isNeedMouseFocus ()
void setInheritsPick (bool _value)
bool isInheritsPick ()
void setMaskPick (const std::string &_filename)
virtual void setEnabled (bool _value)
void setEnabledSilent (bool _value)
bool isEnabled ()
void setPointer (const std::string &_value)
const std::string & getPointer ()
const std::string & getLayerName ()
IntCoord getClientCoord ()
WidgetgetClientWidget ()
ISubWidgetTextgetSubWidgetText ()
ISubWidgetRectgetSubWidgetMain ()
void setNeedToolTip (bool _value)
bool getNeedToolTip ()
void setEnableToolTip (bool _value)
bool getEnableToolTip ()
void detachFromWidget (const std::string &_layer="")
void attachToWidget (Widget *_parent, WidgetStyle _style=WidgetStyle::Child, const std::string &_layer="")
void changeWidgetSkin (const std::string &_skinname)
void setWidgetStyle (WidgetStyle _style, const std::string &_layer="")
WidgetStyle getWidgetStyle ()
virtual void setProperty (const std::string &_key, const std::string &_value)
virtual void _getContainer (Widget *&_container, size_t &_index)
void _forcePeek (Widget *_widget)
void _setUVSet (const FloatRect &_rect)
virtual void _setTextureName (const std::string &_texture)
virtual const std::string & _getTextureName ()
IWidgetCreator_getIWidgetCreator ()
IntCoord _getTextRegion ()
IntSize _getTextSize ()
void _setFontName (const std::string &_font)
const std::string & _getFontName ()
void _setFontHeight (int _height)
int _getFontHeight ()
void _setTextAlign (Align _align)
Align _getTextAlign ()
void _setTextColour (const Colour &_colour)
const Colour_getTextColour ()
void setCaptionWithNewLine (const std::string &_value)
void setPosition (const IntCoord &_coord)
void setPosition (int _left, int _top, int _width, int _height)
void enableToolTip (bool _enable)
void setInheritsPeek (bool _inherits)
bool isInheritsPeek ()
void setMaskPeek (const std::string &_filename)
IntCoord getTextCoord ()
IntSize getTextSize ()
void setFontName (const std::string &_font)
const std::string & getFontName ()
void setFontHeight (int _height)
int getFontHeight ()
void setTextAlign (Align _align)
Align getTextAlign ()
void setTextColour (const Colour &_colour)
const ColourgetTextColour ()
- Public Member Functions inherited from MyGUI::IObject
virtual ~IObject ()
- Public Member Functions inherited from MyGUI::ICroppedRectangle
 ICroppedRectangle ()
virtual ~ICroppedRectangle ()
ICroppedRectanglegetCroppedParent ()
const IntCoordgetCoord () const
IntPoint getPosition () const
IntSize getSize () const
bool isVisible () const
const IntPointgetAbsolutePosition () const
IntRect getAbsoluteRect () const
IntCoord getAbsoluteCoord () const
int getAbsoluteLeft () const
int getAbsoluteTop () const
Align getAlign () const
int getLeft () const
int getRight () const
int getTop () const
int getBottom () const
int getWidth () const
int getHeight () const
bool _isMargin () const
int _getViewLeft () const
int _getViewRight () const
int _getViewTop () const
int _getViewBottom () const
int _getViewWidth () const
int _getViewHeight () const
virtual void _correctView ()
void _setCroppedParent (ICroppedRectangle *_parent)
const IntRect_getMargin () const
int _getMarginLeft () const
int _getMarginRight () const
int _getMarginTop () const
int _getMarginBottom () const
void show ()
void hide ()
bool isShow ()
- Public Member Functions inherited from MyGUI::LayerItem
 LayerItem ()
virtual ~LayerItem ()
ILayergetLayer ()
virtual void attachItemToNode (ILayer *_layer, ILayerNode *_node)
virtual void detachFromLayer ()
virtual void upLayerItem ()
void setRenderItemTexture (ITexture *_texture)
void addChildItem (LayerItem *_item)
void removeChildItem (LayerItem *_item)
void addChildNode (LayerItem *_item)
void removeChildNode (LayerItem *_item)
void addRenderItem (ISubWidget *_item)
void removeAllRenderItems ()
void saveLayerItem ()
void restoreLayerItem ()
- Public Member Functions inherited from MyGUI::ILayerItem
virtual ~ILayerItem ()
- Public Member Functions inherited from MyGUI::UserData
 UserData ()
virtual ~UserData ()
void setUserString (const std::string &_key, const std::string &_value)
const std::string & getUserString (const std::string &_key)
bool clearUserString (const std::string &_key)
bool isUserString (const std::string &_key)
void clearUserStrings ()
void setUserData (Any _data)
template<typename ValueType >
ValueType * getUserData (bool _throw=true)
void _setInternalData (Any _data)
template<typename ValueType >
ValueType * _getInternalData (bool _throw=true)
void * getUserData ()
- Public Member Functions inherited from MyGUI::WidgetEvent
virtual ~WidgetEvent ()
- Public Member Functions inherited from MyGUI::IWidgetCreator
virtual ~IWidgetCreator ()
virtual void _linkChildWidget (Widget *_widget)
virtual void _unlinkChildWidget (Widget *_widget)
- Public Member Functions inherited from MyGUI::BiIndexBase
virtual ~BiIndexBase ()

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 ~MultiList ()
void baseChangeWidgetSkin (ResourceSkin *_info)
void notifyListChangePosition (List *_sender, size_t _position)
void notifyListChangeFocus (List *_sender, size_t _position)
void notifyListChangeScrollPosition (List *_sender, size_t _position)
void notifyButtonClick (Widget *_sender)
void notifyListSelectAccept (List *_sender, size_t _position)
void updateColumns ()
void redrawButtons ()
void updateOnlyEmpty ()
bool compare (List *_list, size_t _left, size_t _right)
void sortList ()
void flipList ()
WidgetgetSeparator (size_t _index)
void setButtonImageIndex (Button *_button, size_t _index)
void updateBackSelected (size_t _index)
- Protected Member Functions inherited from MyGUI::Widget
 Widget (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin *_info, Widget *_parent, ICroppedRectangle *_croppedParent, IWidgetCreator *_creator, const std::string &_name)
virtual ~Widget ()
void _updateView ()
void _setAlign (const IntSize &_oldsize, bool _update)
void _setAlign (const IntCoord &_oldcoord, bool _update)
virtual WidgetbaseCreateWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer, const std::string &_name)
virtual void _destroyChildWidget (Widget *_widget)
virtual void _destroyAllChildWidget ()
virtual size_t _getContainerIndex (const IntPoint &_point)
virtual void _resetContainer (bool _update)
virtual void baseUpdateEnable ()
virtual ILayerItemgetLayerItemByPoint (int _left, int _top)
virtual const IntCoordgetLayerItemCoord ()
- Protected Member Functions inherited from MyGUI::ICroppedRectangle
bool _checkPoint (int _left, int _top)
bool _checkMargin ()
bool _checkOutside ()
- Protected Member Functions inherited from MyGUI::LayerItem
void attachToLayerItemNode (ILayerNode *_node, bool _deep)
void detachFromLayerItemNode (bool _deep)
- Protected Member Functions inherited from MyGUI::WidgetEvent
 WidgetEvent ()
virtual void onMouseLostFocus (Widget *_new)
virtual void onMouseSetFocus (Widget *_old)
virtual void onMouseDrag (int _left, int _top)
virtual void onMouseMove (int _left, int _top)
virtual void onMouseWheel (int _rel)
virtual void onMouseButtonPressed (int _left, int _top, MouseButton _id)
virtual void onMouseButtonReleased (int _left, int _top, MouseButton _id)
virtual void onMouseButtonClick ()
virtual void onMouseButtonDoubleClick ()
virtual void onKeyLostFocus (Widget *_new)
virtual void onKeySetFocus (Widget *_old)
virtual void onKeyButtonPressed (KeyCode _key, Char _char)
virtual void onKeyButtonReleased (KeyCode _key)
virtual void onMouseChangeRootFocus (bool _focus)
virtual void onKeyChangeRootFocus (bool _focus)
- Protected Member Functions inherited from MyGUI::IWidgetCreator
void _deleteWidget (Widget *_widget)
- Protected Member Functions inherited from MyGUI::BiIndexBase
size_t getIndexCount ()
size_t insertItemAt (size_t _index)
size_t convertToBack (size_t _index) const
size_t convertToFace (size_t _index) const
void swapItemsFaceAt (size_t _index1, size_t _index2)
void swapItemsBackAt (size_t _index1, size_t _index2)

Additional Inherited Members

- Protected Attributes inherited from MyGUI::Widget
MapWidgetStateInfo mStateInfo
MaskPickInfo const * mMaskPickInfo
MaskPickInfo mOwnMaskPickInfo
VectorWidgetPtr mWidgetChild
VectorWidgetPtr mWidgetChildSkin
VectorSubWidget mSubSkinChild
ISubWidgetTextmText
ISubWidgetRectmMainSkin
bool mEnabled
bool mInheritsEnabled
bool mSubSkinsVisible
bool mInheritsVisible
float mAlpha
float mRealAlpha
bool mInheritsAlpha
std::string mName
std::string mPointer
std::string mTextureName
ITexturemTexture
WidgetmParent
IWidgetCreatormIWidgetCreator
bool mNeedKeyFocus
bool mNeedMouseFocus
bool mInheritsPick
WidgetmWidgetClient
bool mNeedToolTip
bool mEnableToolTip
bool mToolTipVisible
float mToolTipCurrentTime
IntPoint mToolTipOldPoint
size_t mToolTipOldIndex
IntPoint m_oldMousePoint
WidgetStyle mWidgetStyle
FloatCoord mRelativeCoord
bool mDisableUpdateRelative

Detailed Description

Definition at line 42 of file MyGUI_MultiList.h.

Member Typedef Documentation

Definition at line 46 of file MyGUI_MultiList.h.

Definition at line 46 of file MyGUI_MultiList.h.

Constructor & Destructor Documentation

MyGUI::MultiList::MultiList ( )

Definition at line 35 of file MyGUI_MultiList.cpp.

MyGUI::MultiList::~MultiList ( )
protectedvirtual

Definition at line 57 of file MyGUI_MultiList.cpp.

Member Function Documentation

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

Reimplemented from MyGUI::Widget.

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
_widthWidth of new column
_nameName of new column

Definition at line 70 of file MyGUI_MultiList.h.

void MyGUI::MultiList::addColumn ( int  _width,
const UString _name 
)
inline
Deprecated:
"use : void MultiList::addColumn(const UString& _name, int _width, Any _data)"

Definition at line 282 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)
protectedvirtual

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::clearItemSelected ( )
inline
Deprecated:
"use : void MultiList::clearIndexSelected()"

Definition at line 263 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 ( List _list,
size_t  _left,
size_t  _right 
)
protected

Definition at line 517 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::deleteAllColumns ( )
inline
Deprecated:
"use : void MultiList::removeAllColumns()"

Definition at line 274 of file MyGUI_MultiList.h.

void MyGUI::MultiList::deleteAllItems ( )
inline
Deprecated:
"use : void MultiList::removeAllItems()"

Definition at line 302 of file MyGUI_MultiList.h.

void MyGUI::MultiList::deleteColumn ( size_t  _column)
inline
Deprecated:
"use : void MultiList::removeColumnAt(size_t _column)"

Definition at line 272 of file MyGUI_MultiList.h.

void MyGUI::MultiList::deleteItem ( size_t  _index)
inline
Deprecated:
"use : void MultiList::removeItemAt(size_t _index)"

Definition at line 300 of file MyGUI_MultiList.h.

size_t MyGUI::MultiList::findItem ( size_t  _column,
const UString _name 
)
inline
Deprecated:
"use : size_t MultiList::findSubItemWith(size_t _column, const UString& _name)"

Definition at line 266 of file MyGUI_MultiList.h.

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 323 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::flipList ( )
protected

Definition at line 493 of file MyGUI_MultiList.cpp.

static const std::string& MyGUI::MultiList::getClassTypeName ( )
inlinestatic

Reimplemented from MyGUI::Widget.

Definition at line 46 of file MyGUI_MultiList.h.

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::getColumnName ( size_t  _column)
inline
Deprecated:
"use : const UString& MultiList::getColumnNameAt(size_t _column)"

Definition at line 278 of file MyGUI_MultiList.h.

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

Get _column name

Definition at line 173 of file MyGUI_MultiList.cpp.

int MyGUI::MultiList::getColumnWidth ( size_t  _column)
inline
Deprecated:
"use : int MultiList::getColumnWidthAt(size_t _column)"

Definition at line 276 of file MyGUI_MultiList.h.

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

Get _column width

Definition at line 179 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.

const UString& MyGUI::MultiList::getItem ( size_t  _index)
inline
Deprecated:
"use : const UString& MultiList::getItemNameAt(size_t _index)"

Definition at line 298 of file MyGUI_MultiList.h.

size_t MyGUI::MultiList::getItemCount ( ) const
@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 248 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.

size_t MyGUI::MultiList::getItemIndexSelected ( )
inline
Deprecated:
"use : size_t MultiList::getIndexSelected()"

Definition at line 259 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.

size_t MyGUI::MultiList::getItemSelect ( )
inline
Deprecated:
"use : size_t MultiList::getIndexSelected()"

Definition at line 288 of file MyGUI_MultiList.h.

Widget * MyGUI::MultiList::getSeparator ( size_t  _index)
protected

Definition at line 451 of file MyGUI_MultiList.cpp.

const UString& MyGUI::MultiList::getSubItem ( size_t  _column,
size_t  _index 
)
inline
Deprecated:
"use : const UString& MultiList::getSubItemNameAt(size_t _column, size_t _index)"

Definition at line 268 of file MyGUI_MultiList.h.

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 314 of file MyGUI_MultiList.cpp.

virtual const std::string& MyGUI::MultiList::getTypeName ( ) const
inlinevirtual

Get type name as string

Reimplemented from MyGUI::Widget.

Definition at line 46 of file MyGUI_MultiList.h.

void MyGUI::MultiList::insertColumn ( size_t  _column,
int  _width,
const UString _name 
)
inline
Deprecated:
"use : void MultiList::insertColumnAt(size_t _column, const UString& _name, int _width, Any _data)"

Definition at line 286 of file MyGUI_MultiList.h.

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

Insert new column

Parameters
_columnNew column will be inserted before _column
_nameName of new column
_widthWidth of new column

Definition at line 119 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::insertItem ( size_t  _index,
const UString _name 
)
inline
Deprecated:
"use : void MultiList::insertItemAt(size_t _index, const UString& _name, Any _data)"

Definition at line 294 of file MyGUI_MultiList.h.

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

Insert new item before _index line

Definition at line 563 of file MyGUI_MultiList.cpp.

template<typename Type >
bool MyGUI::MultiList::isType ( ) const
inline

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 46 of file MyGUI_MultiList.h.

virtual bool MyGUI::MultiList::isType ( const std::type_info &  _type) const
inlinevirtual

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 46 of file MyGUI_MultiList.h.

void MyGUI::MultiList::notifyButtonClick ( MyGUI::Widget _sender)
protected

Definition at line 387 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::notifyListChangeFocus ( List _sender,
size_t  _position 
)
protected

Definition at line 365 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::notifyListChangePosition ( List _sender,
size_t  _position 
)
protected

Definition at line 344 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::notifyListChangeScrollPosition ( List _sender,
size_t  _position 
)
protected

Definition at line 378 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::notifyListSelectAccept ( List _sender,
size_t  _position 
)
protected

Definition at line 359 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::redrawButtons ( )
protected

Definition at line 393 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::removeAllColumns ( )

Delete all columns

Definition at line 212 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::removeAllItems ( )

Delete all items

Reimplemented from MyGUI::BiIndexBase.

Definition at line 254 of file MyGUI_MultiList.cpp.

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

Delete column

Definition at line 185 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 586 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::resetItemSelect ( )
inline
Deprecated:
"use : void MultiList::clearIndexSelected()"

Definition at line 290 of file MyGUI_MultiList.h.

void MyGUI::MultiList::setButtonImageIndex ( Button _button,
size_t  _index 
)
protected

Definition at line 409 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 622 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::setColumnName ( size_t  _column,
const UString _name 
)
inline
Deprecated:
"use : void MultiList::setColumnNameAt(size_t _column, const UString& _name)"

Definition at line 284 of file MyGUI_MultiList.h.

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

Set column name

Parameters
_columnIndex of column
_nameNew name of column

Definition at line 159 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::setColumnWidth ( size_t  _column,
int  _width 
)
inline
Deprecated:
"use : void MultiList::setColumnWidthAt(size_t _column, int _width)"

Definition at line 280 of file MyGUI_MultiList.h.

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

Set column width

Parameters
_columnIndex of column
_nameNew width of column

Definition at line 166 of file MyGUI_MultiList.cpp.

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

Select specified _index

Definition at line 291 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::setItem ( size_t  _index,
const UString _name 
)
inline
Deprecated:
"use : void MultiList::setItemNameAt(size_t _index, const UString& _name)"

Definition at line 296 of file MyGUI_MultiList.h.

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::setItemSelect ( size_t  _index)
inline
Deprecated:
"use : void MultiList::setIndexSelected(size_t _index)"

Definition at line 292 of file MyGUI_MultiList.h.

void MyGUI::MultiList::setItemSelectedAt ( size_t  _index)
inline
Deprecated:
"use : void MultiList::setIndexSelected(size_t _index)"

Definition at line 261 of file MyGUI_MultiList.h.

void MyGUI::MultiList::setSubItem ( size_t  _column,
size_t  _index,
const UString _name 
)
inline
Deprecated:
"use : void MultiList::setSubItemNameAt(size_t _column, size_t _index, const UString& _name)"

Definition at line 270 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 628 of file MyGUI_MultiList.cpp.

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

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

Sort multilist by column

Definition at line 228 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::sortList ( )
protected

Definition at line 526 of file MyGUI_MultiList.cpp.

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

Swap items at a specified positions.

Definition at line 609 of file MyGUI_MultiList.cpp.

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

Definition at line 272 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::updateColumns ( )
protected

Definition at line 466 of file MyGUI_MultiList.cpp.

void MyGUI::MultiList::updateOnlyEmpty ( )
protected

Definition at line 332 of file MyGUI_MultiList.cpp.

Field Documentation

EventPair<EventHandle_WidgetSizeT, EventHandle_MultiListPtrSizeT> MyGUI::MultiList::eventListChangePosition

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

Parameters
_senderwidget that called this event
_indexof new item

Definition at line 243 of file MyGUI_MultiList.h.

EventPair<EventHandle_WidgetSizeT, EventHandle_MultiListPtrSizeT> MyGUI::MultiList::eventListSelectAccept

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

Parameters
_senderwidget that called this event
_indexof selected item

Definition at line 236 of file MyGUI_MultiList.h.

Event : Less than operator for sort multilist by columns.
signature : void method(MyGUI::MultiList* _sender, size_t _column, const UString& _firstItem, const 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 253 of file MyGUI_MultiList.h.


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