MyGUI  3.0.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
MyGUI::ListBox Class Reference

#include <MyGUI_ListBox.h>

+ Inheritance diagram for MyGUI::ListBox:

Public Types

typedef RTTIBase Base
typedef ListBox RTTIBase
- Public Types inherited from MyGUI::ListCtrl
typedef RTTIBase Base
typedef ListCtrl RTTIBase
- Public Types inherited from MyGUI::DDContainer
typedef RTTIBase Base
typedef DDContainer 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
 ListBox ()
size_t getItemCount () const
 Get number of items.
void insertItemAt (size_t _index, const UString &_name, Any _data=Any::Null)
 Insert an item into a array at a specified position.
void addItem (const UString &_name, Any _data=Any::Null)
 Add an item to the end of a array.
void removeItemAt (size_t _index)
 Remove item at a specified position.
void removeAllItems ()
 Remove all items.
void swapItemsAt (size_t _index1, size_t _index2)
 Swap items at a specified positions.
size_t findItemIndexWith (const UString &_name)
 Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.
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 setItemNameAt (size_t _index, const UString &_name)
 Replace an item name at a specified position.
const UStringgetItemNameAt (size_t _index)
 Get item name from specified position.
void beginToItemAt (size_t _index)
 Move all elements so specified becomes visible.
void beginToItemFirst ()
 Move all elements so first becomes visible.
void beginToItemLast ()
 Move all elements so last becomes visible.
void beginToItemSelected ()
 Move all elements so selected becomes visible.
virtual void _initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin *_info, Widget *_parent, ICroppedRectangle *_croppedParent, IWidgetCreator *_creator, const std::string &_name)
- Public Member Functions inherited from MyGUI::ListCtrl
 ListCtrl ()
void insertItemAt (size_t _index, Any _data=Any::Null)
 Insert an item into a array at a specified position.
void addItem (Any _data=Any::Null)
 Add an item to the end of a array.
void redrawItemAt (size_t _index)
 Redraw at a specified position.
void redrawAllItems ()
 Redraw all items.
size_t getIndexByWidget (Widget *_widget)
WidgetgetWidgetDrag ()
WidgetgetWidgetByIndex (size_t _index)
void resetDrag ()
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)
 
- Public Member Functions inherited from MyGUI::DDContainer
 DDContainer ()
void setNeedDragDrop (bool _value)
bool getNeedDragDrop ()
virtual void setProperty (const std::string &_key, const std::string &_value)
 
- 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.
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 ()
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)

Static Public Member Functions

static const std::string & getClassTypeName ()

Protected Member Functions

virtual ~ListBox ()
void baseChangeWidgetSkin (ResourceSkin *_info)
- Protected Member Functions inherited from MyGUI::ListCtrl
virtual ~ListCtrl ()
virtual void onMouseButtonPressed (int _left, int _top, MouseButton _id)
virtual void onMouseButtonReleased (int _left, int _top, MouseButton _id)
virtual void onMouseDrag (int _left, int _top)
virtual void onMouseWheel (int _rel)
virtual void onKeyLostFocus (Widget *_new)
virtual void onKeySetFocus (Widget *_old)
void notifyKeyButtonPressed (Widget *_sender, KeyCode _key, Char _char)
void notifyKeyButtonReleased (Widget *_sender, KeyCode _key)
void notifyScrollChangePosition (VScroll *_sender, size_t _index)
void notifyMouseWheel (Widget *_sender, int _rel)
void notifyRootMouseChangeFocus (Widget *_sender, bool _focus)
void notifyMouseButtonDoubleClick (Widget *_sender)
void _requestGetContainer (Widget *_sender, Widget *&_container, size_t &_index)
void notifyMouseDrag (Widget *_sender, int _left, int _top)
void notifyMouseButtonPressed (Widget *_sender, int _left, int _top, MouseButton _id)
void notifyMouseButtonReleased (Widget *_sender, int _left, int _top, MouseButton _id)
virtual void removeDropItems ()
virtual void updateDropItems ()
virtual void updateDropItemsState (const DDWidgetState &_state)
void updateMetrics ()
void _updateAllVisible (size_t _index, bool _needUpdateContetntSize, bool _update)
void updateFromResize ()
WidgetgetItemWidget (size_t _index)
void _setContainerItemInfo (size_t _index, bool _set, bool _accept)
void resetCurrentActiveItem ()
void findCurrentActiveItem ()
virtual size_t _getContainerIndex (const IntPoint &_point)
virtual void _resetContainer (bool _update)
void _setScrollViewPage (size_t _size)
- Protected Member Functions inherited from MyGUI::DDContainer
virtual ~DDContainer ()
virtual void notifyInvalideDrop (DDContainer *_sender)
virtual void _getContainer (Widget *&_container, size_t &_index)
void mouseDrag ()
void mouseButtonReleased (MouseButton _id)
void mouseButtonPressed (MouseButton _id)
void endDrop (bool _reset)
- 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 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 onMouseMove (int _left, int _top)
virtual void onMouseButtonClick ()
virtual void onMouseButtonDoubleClick ()
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)

Additional Inherited Members

- Data Fields inherited from MyGUI::ListCtrl
EventHandle_ListCtrlPtrWidgetPtr requestCreateWidgetItem
EventHandle_ListCtrlPtrWidgetPtrCIBCellDrawInfoRef requestDrawItem
EventHandle_ListCtrlPtrSizeT eventSelectItemAccept
EventHandle_ListCtrlPtrSizeT eventChangeItemPosition
EventHandle_ListCtrlPtrSizeT eventMouseItemActivate
EventHandle_ListCtrlPtrCIBNotifyCellDataRef eventNotifyItem
- Protected Types inherited from MyGUI::ListCtrl
typedef std::vector< ItemDataInfoVectorItemInfo
- Protected Attributes inherited from MyGUI::DDContainer
bool mDropResult
bool mNeedDrop
bool mStartDrop
WidgetmOldDrop
WidgetmCurrentSender
DDItemInfo mDropInfo
size_t mDropSenderIndex
WidgetmDropItem
IntCoord mDropDimension
IntPoint mClickInWidget
bool mNeedDragDrop
DDContainermReseiverContainer

Detailed Description

Definition at line 32 of file MyGUI_ListBox.h.

Member Typedef Documentation

Definition at line 35 of file MyGUI_ListBox.h.

Definition at line 35 of file MyGUI_ListBox.h.

Constructor & Destructor Documentation

MyGUI::ListBox::ListBox ( )

Definition at line 30 of file MyGUI_ListBox.cpp.

MyGUI::ListBox::~ListBox ( )
protectedvirtual

Definition at line 44 of file MyGUI_ListBox.cpp.

Member Function Documentation

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

Reimplemented from MyGUI::ListCtrl.

Definition at line 37 of file MyGUI_ListBox.cpp.

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

Add an item to the end of a array.

Definition at line 50 of file MyGUI_ListBox.h.

void MyGUI::ListBox::baseChangeWidgetSkin ( ResourceSkin _info)
protectedvirtual

Reimplemented from MyGUI::ListCtrl.

Definition at line 49 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::beginToItemAt ( size_t  _index)

Move all elements so specified becomes visible.

Definition at line 167 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::beginToItemFirst ( )
inline

Move all elements so first becomes visible.

Definition at line 112 of file MyGUI_ListBox.h.

void MyGUI::ListBox::beginToItemLast ( )
inline

Move all elements so last becomes visible.

Definition at line 115 of file MyGUI_ListBox.h.

void MyGUI::ListBox::beginToItemSelected ( )
inline

Move all elements so selected becomes visible.

Definition at line 118 of file MyGUI_ListBox.h.

void MyGUI::ListBox::clearIndexSelected ( )
inline

Clear item selection

Reimplemented from MyGUI::ListCtrl.

Definition at line 75 of file MyGUI_ListBox.h.

void MyGUI::ListBox::clearItemDataAt ( size_t  _index)
inline

Clear an item data at a specified position.

Reimplemented from MyGUI::ListCtrl.

Definition at line 85 of file MyGUI_ListBox.h.

size_t MyGUI::ListBox::findItemIndexWith ( const UString _name)

Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.

Definition at line 144 of file MyGUI_ListBox.cpp.

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

Reimplemented from MyGUI::ListCtrl.

Definition at line 35 of file MyGUI_ListBox.h.

size_t MyGUI::ListBox::getIndexSelected ( )
inline

Get index of selected item (ITEM_NONE if none selected)

Reimplemented from MyGUI::ListCtrl.

Definition at line 69 of file MyGUI_ListBox.h.

size_t MyGUI::ListBox::getItemCount ( ) const
inline

Get number of items.

Reimplemented from MyGUI::ListCtrl.

Definition at line 44 of file MyGUI_ListBox.h.

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

Get item data from specified position.

Reimplemented from MyGUI::ListCtrl.

Definition at line 89 of file MyGUI_ListBox.h.

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

Get item name from specified position.

Definition at line 160 of file MyGUI_ListBox.cpp.

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

Get type name as string

Reimplemented from MyGUI::ListCtrl.

Definition at line 35 of file MyGUI_ListBox.h.

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

Insert an item into a array at a specified position.

Definition at line 106 of file MyGUI_ListBox.cpp.

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

Compare with selected type

Reimplemented from MyGUI::ListCtrl.

Definition at line 35 of file MyGUI_ListBox.h.

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

Compare with selected type

Reimplemented from MyGUI::ListCtrl.

Definition at line 35 of file MyGUI_ListBox.h.

void MyGUI::ListBox::removeAllItems ( )

Remove all items.

Reimplemented from MyGUI::ListCtrl.

Definition at line 124 of file MyGUI_ListBox.cpp.

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

Remove item at a specified position.

Reimplemented from MyGUI::ListCtrl.

Definition at line 116 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::setIndexSelected ( size_t  _index)
inline

Select specified _index

Reimplemented from MyGUI::ListCtrl.

Definition at line 72 of file MyGUI_ListBox.h.

void MyGUI::ListBox::setItemDataAt ( size_t  _index,
Any  _data 
)
inline

Replace an item data at a specified position.

Reimplemented from MyGUI::ListCtrl.

Definition at line 82 of file MyGUI_ListBox.h.

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

Replace an item name at a specified position.

Definition at line 153 of file MyGUI_ListBox.cpp.

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

Swap items at a specified positions.

Definition at line 131 of file MyGUI_ListBox.cpp.


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