MyGUI  3.2.0
Public Types | Public Member Functions | Static Public Member Functions | Data Fields | 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 Member Functions

virtual const std::string & getTypeName () const
virtual bool isType (const std::type_info &_type) const
template<typename Type >
bool isType () const
 ListBox ()
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.
int getOptimalHeight ()
 Return optimal height to fit all items in ListBox.
Item Methods.

Methods used to manipulate items.

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.
Item Selection Methods

Methods used to manipulate item selection.

size_t getIndexSelected () const
void setIndexSelected (size_t _index)
void clearIndexSelected ()
Item Data Methods

Methods used to manipulate item user data.

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.
Item Visibility Methods

Methods used to determine and manipulate item visibility.

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.
bool isItemVisibleAt (size_t _index, bool _fill=true)
bool isItemSelectedVisible (bool _fill=true)
 Same as ListBox::isItemVisibleAt for selected item.
void setScrollVisible (bool _visible)
 Set scroll visible when it needed.
void setScrollPosition (size_t _position)
 Set scroll position.
Widget Methods

Methods used to manipulate the widget's settings.

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 _checkAlign ()
void _setItemFocus (size_t _position, bool _focus)
void _sendEventChangeScroll (size_t _position)
virtual size_t _getItemCount ()
virtual void _addItem (const MyGUI::UString &_name)
virtual void _removeItemAt (size_t _index)
virtual void _setItemNameAt (size_t _index, const UString &_name)
virtual const UString_getItemNameAt (size_t _index)
virtual void _resetContainer (bool _update)

Static Public Member Functions

static const std::string & getClassTypeName ()

Data Fields

EventPair
< EventHandle_WidgetSizeT,
EventHandle_ListPtrSizeT
eventListSelectAccept
EventPair
< EventHandle_WidgetSizeT,
EventHandle_ListPtrSizeT
eventListChangePosition
EventPair
< EventHandle_WidgetSizeT,
EventHandle_ListPtrSizeT
eventListMouseItemActivate
EventPair
< EventHandle_WidgetSizeT,
EventHandle_ListPtrSizeT
eventListMouseItemFocus
EventPair
< EventHandle_WidgetSizeT,
EventHandle_ListPtrSizeT
eventListChangeScroll

Protected Member Functions

virtual void initialiseOverride ()
virtual void shutdownOverride ()
void onMouseWheel (int _rel)
void onKeyButtonPressed (KeyCode _key, Char _char)
void notifyScrollChangePosition (ScrollBar *_sender, size_t _rel)
void notifyMousePressed (Widget *_sender, int _left, int _top, MouseButton _id)
void notifyMouseDoubleClick (Widget *_sender)
void notifyMouseWheel (Widget *_sender, int _rel)
void notifyMouseSetFocus (Widget *_sender, Widget *_old)
void notifyMouseLostFocus (Widget *_sender, Widget *_new)
void updateScroll ()
void updateLine (bool _reset=false)
void _setScrollView (size_t _position)
void _redrawItemRange (size_t _start=0)
void _redrawItem (size_t _index)
void _selectIndex (size_t _index, bool _select)
virtual size_t _getItemIndex (Widget *_item)
virtual void setPropertyOverride (const std::string &_key, const std::string &_value)

Detailed Description

Definition at line 37 of file MyGUI_ListBox.h.


Member Typedef Documentation

Reimplemented from MyGUI::Widget.

Definition at line 42 of file MyGUI_ListBox.h.

Reimplemented from MyGUI::Widget.

Definition at line 42 of file MyGUI_ListBox.h.


Constructor & Destructor Documentation

Definition at line 33 of file MyGUI_ListBox.cpp.


Member Function Documentation

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 1057 of file MyGUI_ListBox.cpp.

Definition at line 911 of file MyGUI_ListBox.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 1052 of file MyGUI_ListBox.cpp.

size_t MyGUI::ListBox::_getItemIndex ( Widget _item) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 1017 of file MyGUI_ListBox.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 1072 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::_redrawItem ( size_t  _index) [protected]

Definition at line 515 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::_redrawItemRange ( size_t  _start = 0) [protected]

Definition at line 461 of file MyGUI_ListBox.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 1062 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::_resetContainer ( bool  _update) [virtual]

Reimplemented from MyGUI::Widget.

Definition at line 1027 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::_selectIndex ( size_t  _index,
bool  _select 
) [protected]

Definition at line 679 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::_sendEventChangeScroll ( size_t  _position)

Definition at line 875 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::_setItemFocus ( size_t  _position,
bool  _focus 
)

Definition at line 824 of file MyGUI_ListBox.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 1067 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::_setScrollView ( size_t  _position) [protected]

Definition at line 850 of file MyGUI_ListBox.cpp.

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

Add an item to the end of a array.

Definition at line 959 of file MyGUI_ListBox.cpp.

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

Move all elements so specified becomes visible.

Definition at line 701 of file MyGUI_ListBox.cpp.

Move all elements so first becomes visible.

Definition at line 979 of file MyGUI_ListBox.cpp.

Move all elements so last becomes visible.

Definition at line 985 of file MyGUI_ListBox.cpp.

Move all elements so selected becomes visible.

Definition at line 991 of file MyGUI_ListBox.cpp.

Clear item selection

Definition at line 969 of file MyGUI_ListBox.cpp.

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

Clear an item data at a specified position.

Definition at line 974 of file MyGUI_ListBox.cpp.

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 934 of file MyGUI_ListBox.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 42 of file MyGUI_ListBox.h.

Get index of selected item (ITEM_NONE if none selected)

Definition at line 964 of file MyGUI_ListBox.cpp.

size_t MyGUI::ListBox::getItemCount ( ) const

Get number of items.

Definition at line 954 of file MyGUI_ListBox.cpp.

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

Get item data from specified position.

Definition at line 109 of file MyGUI_ListBox.h.

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

Get item name from specified position.

Definition at line 798 of file MyGUI_ListBox.cpp.

Return optimal height to fit all items in ListBox.

Definition at line 944 of file MyGUI_ListBox.cpp.

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

Get type name as string

Reimplemented from MyGUI::Widget.

Definition at line 42 of file MyGUI_ListBox.h.

void MyGUI::ListBox::initialiseOverride ( ) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 47 of file MyGUI_ListBox.cpp.

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 534 of file MyGUI_ListBox.cpp.

bool MyGUI::ListBox::isItemSelectedVisible ( bool  _fill = true)

Same as ListBox::isItemVisibleAt for selected item.

Definition at line 997 of file MyGUI_ListBox.cpp.

bool MyGUI::ListBox::isItemVisibleAt ( size_t  _index,
bool  _fill = true 
)

Return true if item visible

Parameters:
_indexof item
_fillfalse: function return true when whole item is visible true: function return true when at least part of item is visible

Definition at line 724 of file MyGUI_ListBox.cpp.

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

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 42 of file MyGUI_ListBox.h.

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

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 42 of file MyGUI_ListBox.h.

void MyGUI::ListBox::notifyMouseDoubleClick ( Widget _sender) [protected]

Definition at line 293 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::notifyMouseLostFocus ( Widget _sender,
Widget _new 
) [protected]

Definition at line 815 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::notifyMousePressed ( Widget _sender,
int  _left,
int  _top,
MouseButton  _id 
) [protected]

Definition at line 247 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::notifyMouseSetFocus ( Widget _sender,
Widget _old 
) [protected]

Definition at line 804 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::notifyMouseWheel ( Widget _sender,
int  _rel 
) [protected]

Definition at line 212 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::notifyScrollChangePosition ( ScrollBar _sender,
size_t  _rel 
) [protected]

Definition at line 241 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::onKeyButtonPressed ( KeyCode  _key,
Char  _char 
) [protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 99 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::onMouseWheel ( int  _rel) [protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 92 of file MyGUI_ListBox.cpp.

Remove all items.

Definition at line 759 of file MyGUI_ListBox.cpp.

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

Remove item at a specified position.

Definition at line 596 of file MyGUI_ListBox.cpp.

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

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 312 of file MyGUI_ListBox.cpp.

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

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 1012 of file MyGUI_ListBox.cpp.

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

Select specified _index

Definition at line 668 of file MyGUI_ListBox.cpp.

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

Replace an item data at a specified position.

Definition at line 791 of file MyGUI_ListBox.cpp.

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

Replace an item name at a specified position.

Definition at line 784 of file MyGUI_ListBox.cpp.

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

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 299 of file MyGUI_ListBox.cpp.

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

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 1002 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::setPropertyOverride ( const std::string &  _key,
const std::string &  _value 
) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 1040 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::setScrollPosition ( size_t  _position)

Set scroll position.

Definition at line 838 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::setScrollVisible ( bool  _visible)

Set scroll visible when it needed.

Definition at line 830 of file MyGUI_ListBox.cpp.

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

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 304 of file MyGUI_ListBox.cpp.

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

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 1007 of file MyGUI_ListBox.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 84 of file MyGUI_ListBox.cpp.

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

Swap items at a specified positions.

Definition at line 882 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::updateLine ( bool  _reset = false) [protected]

Definition at line 349 of file MyGUI_ListBox.cpp.

void MyGUI::ListBox::updateScroll ( ) [protected]

Definition at line 320 of file MyGUI_ListBox.cpp.


Field Documentation

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

Parameters:
_senderwidget that called this event
_indexof new item

Definition at line 207 of file MyGUI_ListBox.h.

Event : Position of scroll changed.
signature : void method(MyGUI::ListBox* _sender, size_t _position)

Parameters:
_senderwidget that called this event
_positionof scroll

Definition at line 231 of file MyGUI_ListBox.h.

Event : Item was selected by mouse.
signature : void method(MyGUI::ListBox* _sender, size_t _index)

Parameters:
_senderwidget that called this event
_indexindex of selected item

Definition at line 215 of file MyGUI_ListBox.h.

Event : Mouse is over item.
signature : void method(MyGUI::ListBox* _sender, size_t _index)

Parameters:
_senderwidget that called this event
_indexof focused item

Definition at line 223 of file MyGUI_ListBox.h.

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

Parameters:
_senderwidget that called this event
_indexof selected item

Definition at line 199 of file MyGUI_ListBox.h.


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