MyGUI
3.2.1
|
ListBox properties. Skin childs. ListBox widget description should be here. More...
#include <MyGUI_ListBox.h>
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 UString & | getItemNameAt (size_t _index) |
Get item name from specified position. | |
int | getOptimalHeight () |
Return optimal height to fit all items in ListBox. | |
void | setActivateOnClick (bool activateOnClick) |
Widget * | getWidgetByIndex (size_t _index) |
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 |
EventHandle_ListBoxPtrCIBNotifyCellDataRef | eventNotifyItem |
Protected Member Functions | |
virtual void | initialiseOverride () |
virtual void | shutdownOverride () |
void | onMouseWheel (int _rel) |
void | onKeyButtonPressed (KeyCode _key, Char _char) |
void | onKeyButtonReleased (KeyCode _key) |
void | notifyScrollChangePosition (ScrollBar *_sender, size_t _rel) |
void | notifyMousePressed (Widget *_sender, int _left, int _top, MouseButton _id) |
void | notifyMouseClick (Widget *_sender) |
void | notifyMouseDoubleClick (Widget *_sender) |
void | notifyMouseWheel (Widget *_sender, int _rel) |
void | notifyMouseSetFocus (Widget *_sender, Widget *_old) |
void | notifyMouseLostFocus (Widget *_sender, Widget *_new) |
void | notifyKeyButtonPressed (Widget *_sender, KeyCode _key, Char _char) |
void | notifyKeyButtonReleased (Widget *_sender, KeyCode _key) |
void | notifyMouseButtonReleased (Widget *_sender, int _left, int _top, MouseButton _id) |
void | updateScroll () |
void | updateLine (bool _reset=false) |
void | _activateItem (Widget *_sender) |
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) |
ListBox properties. Skin childs. ListBox widget description should be here.
Definition at line 27 of file MyGUI_ListBox.h.
typedef RTTIBase MyGUI::ListBox::Base |
Reimplemented from MyGUI::Widget.
Definition at line 32 of file MyGUI_ListBox.h.
typedef ListBox MyGUI::ListBox::RTTIBase |
Reimplemented from MyGUI::Widget.
Definition at line 32 of file MyGUI_ListBox.h.
Definition at line 18 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_activateItem | ( | MyGUI::Widget * | _sender | ) | [protected] |
Definition at line 1024 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_addItem | ( | const MyGUI::UString & | _name | ) | [virtual] |
Reimplemented from MyGUI::IItemContainer.
Definition at line 1069 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_checkAlign | ( | ) |
Definition at line 879 of file MyGUI_ListBox.cpp.
size_t MyGUI::ListBox::_getItemCount | ( | ) | [virtual] |
Reimplemented from MyGUI::IItemContainer.
Definition at line 1064 of file MyGUI_ListBox.cpp.
size_t MyGUI::ListBox::_getItemIndex | ( | Widget * | _item | ) | [protected, virtual] |
Reimplemented from MyGUI::Widget.
Definition at line 985 of file MyGUI_ListBox.cpp.
const UString & MyGUI::ListBox::_getItemNameAt | ( | size_t | _index | ) | [virtual] |
Reimplemented from MyGUI::IItemContainer.
Definition at line 1084 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_redrawItem | ( | size_t | _index | ) | [protected] |
Definition at line 481 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_redrawItemRange | ( | size_t | _start = 0 | ) | [protected] |
Definition at line 427 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_removeItemAt | ( | size_t | _index | ) | [virtual] |
Reimplemented from MyGUI::IItemContainer.
Definition at line 1074 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_resetContainer | ( | bool | _update | ) | [virtual] |
Reimplemented from MyGUI::Widget.
Definition at line 995 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_selectIndex | ( | size_t | _index, |
bool | _select | ||
) | [protected] |
Definition at line 645 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_sendEventChangeScroll | ( | size_t | _position | ) |
Definition at line 841 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_setItemFocus | ( | size_t | _position, |
bool | _focus | ||
) |
Definition at line 790 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_setItemNameAt | ( | size_t | _index, |
const UString & | _name | ||
) | [virtual] |
Reimplemented from MyGUI::IItemContainer.
Definition at line 1079 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::_setScrollView | ( | size_t | _position | ) | [protected] |
Definition at line 816 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 927 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::beginToItemAt | ( | size_t | _index | ) |
Move all elements so specified becomes visible.
Definition at line 667 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::beginToItemFirst | ( | ) |
Move all elements so first becomes visible.
Definition at line 947 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::beginToItemLast | ( | ) |
Move all elements so last becomes visible.
Definition at line 953 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::beginToItemSelected | ( | ) |
Move all elements so selected becomes visible.
Definition at line 959 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::clearIndexSelected | ( | ) |
Clear item selection
Definition at line 937 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::clearItemDataAt | ( | size_t | _index | ) |
Clear an item data at a specified position.
Definition at line 942 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 902 of file MyGUI_ListBox.cpp.
static const std::string& MyGUI::ListBox::getClassTypeName | ( | ) | [inline, static] |
Reimplemented from MyGUI::Widget.
Definition at line 32 of file MyGUI_ListBox.h.
size_t MyGUI::ListBox::getIndexSelected | ( | ) | const |
Get index of selected item (ITEM_NONE if none selected)
Definition at line 932 of file MyGUI_ListBox.cpp.
size_t MyGUI::ListBox::getItemCount | ( | ) | const |
Get number of items.
Definition at line 922 of file MyGUI_ListBox.cpp.
ValueType* MyGUI::ListBox::getItemDataAt | ( | size_t | _index, |
bool | _throw = true |
||
) | [inline] |
Get item data from specified position.
Definition at line 99 of file MyGUI_ListBox.h.
const UString & MyGUI::ListBox::getItemNameAt | ( | size_t | _index | ) |
Get item name from specified position.
Definition at line 764 of file MyGUI_ListBox.cpp.
int MyGUI::ListBox::getOptimalHeight | ( | ) |
Return optimal height to fit all items in ListBox.
Definition at line 912 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 32 of file MyGUI_ListBox.h.
Widget * MyGUI::ListBox::getWidgetByIndex | ( | size_t | _index | ) |
Get item Widget pointer by item index if it is visible
Definition at line 1123 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::initialiseOverride | ( | ) | [protected, virtual] |
Reimplemented from MyGUI::Widget.
Definition at line 33 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 500 of file MyGUI_ListBox.cpp.
bool MyGUI::ListBox::isItemSelectedVisible | ( | bool | _fill = true | ) |
Same as ListBox::isItemVisibleAt for selected item.
Definition at line 965 of file MyGUI_ListBox.cpp.
bool MyGUI::ListBox::isItemVisibleAt | ( | size_t | _index, |
bool | _fill = true |
||
) |
Return true if item visible
_index | of item |
_fill | false: function return true when whole item is visible true: function return true when at least part of item is visible |
Definition at line 690 of file MyGUI_ListBox.cpp.
bool MyGUI::ListBox::isType | ( | ) | const [inline] |
Compare with selected type
Reimplemented from MyGUI::Widget.
Definition at line 32 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 32 of file MyGUI_ListBox.h.
void MyGUI::ListBox::notifyKeyButtonPressed | ( | Widget * | _sender, |
KeyCode | _key, | ||
Char | _char | ||
) | [protected] |
Definition at line 1096 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::notifyKeyButtonReleased | ( | Widget * | _sender, |
KeyCode | _key | ||
) | [protected] |
Definition at line 1101 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::notifyMouseButtonReleased | ( | Widget * | _sender, |
int | _left, | ||
int | _top, | ||
MouseButton | _id | ||
) | [protected] |
Definition at line 1106 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::notifyMouseClick | ( | MyGUI::Widget * | _sender | ) | [protected] |
Definition at line 249 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::notifyMouseDoubleClick | ( | Widget * | _sender | ) | [protected] |
Definition at line 255 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::notifyMouseLostFocus | ( | Widget * | _sender, |
Widget * | _new | ||
) | [protected] |
Definition at line 781 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::notifyMousePressed | ( | Widget * | _sender, |
int | _left, | ||
int | _top, | ||
MouseButton | _id | ||
) | [protected] |
Definition at line 241 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::notifyMouseSetFocus | ( | Widget * | _sender, |
Widget * | _old | ||
) | [protected] |
Definition at line 770 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::notifyMouseWheel | ( | Widget * | _sender, |
int | _rel | ||
) | [protected] |
Definition at line 206 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::notifyScrollChangePosition | ( | ScrollBar * | _sender, |
size_t | _rel | ||
) | [protected] |
Definition at line 235 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::onKeyButtonPressed | ( | KeyCode | _key, |
Char | _char | ||
) | [protected, virtual] |
Reimplemented from MyGUI::WidgetInput.
Definition at line 89 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::onKeyButtonReleased | ( | KeyCode | _key | ) | [protected, virtual] |
Reimplemented from MyGUI::WidgetInput.
Definition at line 1111 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::onMouseWheel | ( | int | _rel | ) | [protected, virtual] |
Reimplemented from MyGUI::WidgetInput.
Definition at line 82 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::removeAllItems | ( | ) |
Remove all items.
Definition at line 725 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::removeItemAt | ( | size_t | _index | ) |
Remove item at a specified position.
Definition at line 562 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::setActivateOnClick | ( | bool | activateOnClick | ) |
Enable "Activate on click" mode that requires a full mouse click (press and release) to activate an item. By default, items are activated on mouse press.
Definition at line 1118 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 274 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 980 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::setIndexSelected | ( | size_t | _index | ) |
Select specified _index
Definition at line 634 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 757 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 750 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 261 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 970 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 1008 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::setScrollPosition | ( | size_t | _position | ) |
Set scroll position.
Definition at line 804 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::setScrollVisible | ( | bool | _visible | ) |
Set scroll visible when it needed.
Definition at line 796 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::setSize | ( | const IntSize & | _value | ) | [virtual] |
void MyGUI::ListBox::setSize | ( | int | _width, |
int | _height | ||
) |
See Widget::setSize(const IntSize& _size)
Reimplemented from MyGUI::Widget.
Definition at line 975 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::shutdownOverride | ( | ) | [protected, virtual] |
Reimplemented from MyGUI::Widget.
Definition at line 74 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::swapItemsAt | ( | size_t | _index1, |
size_t | _index2 | ||
) |
Swap items at a specified positions.
Definition at line 848 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::updateLine | ( | bool | _reset = false | ) | [protected] |
Definition at line 311 of file MyGUI_ListBox.cpp.
void MyGUI::ListBox::updateScroll | ( | ) | [protected] |
Definition at line 282 of file MyGUI_ListBox.cpp.
EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> MyGUI::ListBox::eventListChangePosition |
Event : Selected item position changed.
signature : void method(MyGUI::ListBox* _sender, size_t _index)
_sender | widget that called this event |
_index | of 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)
_sender | widget that called this event |
_position | of scroll |
Definition at line 228 of file MyGUI_ListBox.h.
EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> MyGUI::ListBox::eventListMouseItemActivate |
Event : Item was selected by mouse.
signature : void method(MyGUI::ListBox* _sender, size_t _index)
_sender | widget that called this event |
_index | index of selected item |
Definition at line 214 of file MyGUI_ListBox.h.
EventPair<EventHandle_WidgetSizeT, EventHandle_ListPtrSizeT> MyGUI::ListBox::eventListMouseItemFocus |
Event : Mouse is over item.
signature : void method(MyGUI::ListBox* _sender, size_t _index)
_sender | widget that called this event |
_index | of focused item |
Definition at line 221 of file MyGUI_ListBox.h.
Event : Enter pressed or double click.
signature : void method(MyGUI::ListBox* _sender, size_t _index)
_sender | widget that called this event |
_index | of selected item |
Definition at line 200 of file MyGUI_ListBox.h.
Event : Notify about event in item widget.
signature : void method(MyGUI::ListBox* _sender, const MyGUI::IBNotifyItemData& _info)
_sender | widget that called this event |
_info | info about item notify |
Definition at line 235 of file MyGUI_ListBox.h.