MyGUI  3.2.1
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Data Fields | Protected Types | Protected Member Functions
MyGUI::ItemBox Class Reference

ItemBox properties. Skin childs. ItemBox widget description should be here. More...

#include <MyGUI_ItemBox.h>

+ Inheritance diagram for MyGUI::ItemBox:

Data Structures

struct  ItemDataInfo

Public Types

typedef RTTIBase Base
typedef ItemBox 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
 ItemBox ()
size_t getItemCount () const
 Get number of items.
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 removeItemAt (size_t _index)
 Remove item at a specified position.
void removeAllItems ()
 Remove all items.
void redrawItemAt (size_t _index)
 Redraw at a specified position.
void redrawAllItems ()
 Redraw all items.
size_t getIndexSelected () const
 Get index of selected item (ITEM_NONE if none selected)
void setIndexSelected (size_t _index)
 Select specified _index.
void clearIndexSelected ()
 Clear item selection.
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 setVerticalAlignment (bool _value)
bool getVerticalAlignment () const
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)
void setViewOffset (const IntPoint &_value)
IntPoint getViewOffset ()
virtual IntSize getViewSize ()
virtual void _resetContainer (bool _update)

Static Public Member Functions

static const std::string & getClassTypeName ()

Data Fields

EventHandle_ItemBoxPtrWidgetPtr requestCreateWidgetItem
EventHandle_ItemBoxPtrIntCoordRefBool requestCoordItem
EventHandle_ItemBoxPtrWidgetPtrCIBCellDrawInfoRef requestDrawItem
EventHandle_ItemBoxPtrSizeT eventSelectItemAccept
EventHandle_ItemBoxPtrSizeT eventChangeItemPosition
EventHandle_ItemBoxPtrSizeT eventMouseItemActivate
EventHandle_ItemBoxPtrCIBNotifyCellDataRef eventNotifyItem

Protected Types

typedef std::vector< ItemDataInfoVectorItemInfo

Protected Member Functions

virtual void initialiseOverride ()
virtual void shutdownOverride ()
virtual void onMouseButtonPressed (int _left, int _top, MouseButton _id)
virtual void onMouseButtonReleased (int _left, int _top, MouseButton _id)
virtual void onKeyButtonPressed (KeyCode _key, Char _char)
virtual void onKeyButtonReleased (KeyCode _key)
virtual void onMouseDrag (int _left, int _top, MouseButton _id)
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 (ScrollBar *_sender, size_t _index)
void notifyMouseWheel (Widget *_sender, int _rel)
void notifyRootMouseChangeFocus (Widget *_sender, bool _focus)
void notifyMouseButtonDoubleClick (Widget *_sender)
virtual size_t _getItemIndex (Widget *_item)
void notifyMouseDrag (Widget *_sender, int _left, int _top, MouseButton _id)
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 (bool _redraw)
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 setPropertyOverride (const std::string &_key, const std::string &_value)

Detailed Description

ItemBox properties. Skin childs. ItemBox widget description should be here.

Definition at line 29 of file MyGUI_ItemBox.h.


Member Typedef Documentation

Reimplemented from MyGUI::DDContainer.

Definition at line 34 of file MyGUI_ItemBox.h.

Reimplemented from MyGUI::DDContainer.

Definition at line 34 of file MyGUI_ItemBox.h.

typedef std::vector<ItemDataInfo> MyGUI::ItemBox::VectorItemInfo [protected]

Definition at line 202 of file MyGUI_ItemBox.h.


Constructor & Destructor Documentation

Definition at line 20 of file MyGUI_ItemBox.cpp.


Member Function Documentation

size_t MyGUI::ItemBox::_getContainerIndex ( const IntPoint _point) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 490 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 291 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 505 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::_setContainerItemInfo ( size_t  _index,
bool  _set,
bool  _accept 
) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Definition at line 301 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::_updateAllVisible ( bool  _redraw) [protected]

Definition at line 130 of file MyGUI_ItemBox.cpp.

Add an item to the end of a array.

Definition at line 873 of file MyGUI_ItemBox.cpp.

Clear item selection.

Definition at line 883 of file MyGUI_ItemBox.cpp.

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

Clear an item data at a specified position.

Definition at line 888 of file MyGUI_ItemBox.cpp.

Definition at line 255 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::DDContainer.

Definition at line 34 of file MyGUI_ItemBox.h.

Get item index by item Widget pointer

Definition at line 478 of file MyGUI_ItemBox.cpp.

Get index of selected item (ITEM_NONE if none selected)

Definition at line 878 of file MyGUI_ItemBox.cpp.

size_t MyGUI::ItemBox::getItemCount ( ) const

Get number of items.

Definition at line 868 of file MyGUI_ItemBox.cpp.

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

Get item data from specified position.

Definition at line 88 of file MyGUI_ItemBox.h.

Widget * MyGUI::ItemBox::getItemWidget ( size_t  _index) [protected]

Definition at line 182 of file MyGUI_ItemBox.cpp.

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

Get type name as string

Reimplemented from MyGUI::DDContainer.

Definition at line 34 of file MyGUI_ItemBox.h.

Get vertical alignment grid mode flag

Definition at line 893 of file MyGUI_ItemBox.cpp.

Get view area offset.

Definition at line 994 of file MyGUI_ItemBox.cpp.

Reimplemented from MyGUI::ScrollViewBase.

Definition at line 833 of file MyGUI_ItemBox.cpp.

Get item Widget pointer by item index if it is visible

Note:
returned widget can be deleted, so this pointer is valid only at time when you got it and can be invalid next frame

Definition at line 520 of file MyGUI_ItemBox.cpp.

Get widget created for drop

Definition at line 898 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::initialiseOverride ( ) [protected, virtual]
skin clilds:
Client is child widget with type Widget. Клиентская зона.
skin clilds:
VScroll is child widget with type ScrollBar. Вертикальная полоса прокрутки.
skin clilds:
HScroll is child widget with type ScrollBar. Горизонтальная полоса прокрутки.

Reimplemented from MyGUI::Widget.

Definition at line 36 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::insertItemAt ( size_t  _index,
Any  _data = Any::Null 
)

Insert an item into a array at a specified position.

Definition at line 332 of file MyGUI_ItemBox.cpp.

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

Compare with selected type

Reimplemented from MyGUI::DDContainer.

Definition at line 34 of file MyGUI_ItemBox.h.

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

Compare with selected type

Reimplemented from MyGUI::DDContainer.

Definition at line 34 of file MyGUI_ItemBox.h.

void MyGUI::ItemBox::notifyKeyButtonPressed ( Widget _sender,
KeyCode  _key,
Char  _char 
) [protected]

Definition at line 468 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::notifyKeyButtonReleased ( Widget _sender,
KeyCode  _key 
) [protected]

Definition at line 473 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::notifyMouseButtonDoubleClick ( Widget _sender) [protected]

Definition at line 451 of file MyGUI_ItemBox.cpp.

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

Definition at line 597 of file MyGUI_ItemBox.cpp.

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

Definition at line 631 of file MyGUI_ItemBox.cpp.

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

Definition at line 592 of file MyGUI_ItemBox.cpp.

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

Definition at line 718 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::notifyRootMouseChangeFocus ( Widget _sender,
bool  _focus 
) [protected]

Definition at line 640 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::notifyScrollChangePosition ( ScrollBar _sender,
size_t  _index 
) [protected]

Definition at line 704 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::WidgetInput.

Definition at line 999 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::onKeyButtonReleased ( KeyCode  _key) [protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 1006 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::onKeyLostFocus ( Widget _new) [protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 229 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::onKeySetFocus ( Widget _old) [protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 222 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::onMouseButtonPressed ( int  _left,
int  _top,
MouseButton  _id 
) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Definition at line 534 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::onMouseButtonReleased ( int  _left,
int  _top,
MouseButton  _id 
) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Definition at line 539 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::onMouseDrag ( int  _left,
int  _top,
MouseButton  _id 
) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Definition at line 544 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::WidgetInput.

Definition at line 215 of file MyGUI_ItemBox.cpp.

Redraw all items.

Definition at line 808 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::redrawItemAt ( size_t  _index)

Redraw at a specified position.

Definition at line 407 of file MyGUI_ItemBox.cpp.

Remove all items.

Definition at line 390 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::removeDropItems ( ) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Definition at line 549 of file MyGUI_ItemBox.cpp.

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

Remove item at a specified position.

Definition at line 360 of file MyGUI_ItemBox.cpp.

Definition at line 236 of file MyGUI_ItemBox.cpp.

Interrupt drag as if widget was dropped into empty space

Reimplemented from MyGUI::DDContainer.

Definition at line 813 of file MyGUI_ItemBox.cpp.

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

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 102 of file MyGUI_ItemBox.cpp.

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

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 913 of file MyGUI_ItemBox.cpp.

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

Select specified _index.

Definition at line 419 of file MyGUI_ItemBox.cpp.

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

Replace an item data at a specified position.

Definition at line 317 of file MyGUI_ItemBox.cpp.

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

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 91 of file MyGUI_ItemBox.cpp.

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

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 903 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::setPropertyOverride ( const std::string &  _key,
const std::string &  _value 
) [protected, virtual]
Properties:
VerticalAlignment is ItemBox property with type bool. Вертикальное выравнивание.

Reimplemented from MyGUI::DDContainer.

Definition at line 918 of file MyGUI_ItemBox.cpp.

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

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 96 of file MyGUI_ItemBox.cpp.

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

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 908 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::setVerticalAlignment ( bool  _value)

Set vertical alignment grid mode

Definition at line 458 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::setViewOffset ( const IntPoint _value)

Set view area offset.

Definition at line 933 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 82 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::updateDropItems ( ) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Definition at line 554 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::updateDropItemsState ( const DDWidgetState _state) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Definition at line 576 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::updateFromResize ( ) [protected]

Definition at line 119 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::updateMetrics ( ) [protected]

Definition at line 673 of file MyGUI_ItemBox.cpp.


Field Documentation

Event : Position of selected item was changed.
signature : void method(MyGUI::ItemBox* _sender, size_t _index)

Parameters:
_senderwidget that called this event
_indexitem index

Definition at line 173 of file MyGUI_ItemBox.h.

Event : Click on item.
signature : void method(MyGUI::ItemBox* _sender, size_t _index)

Parameters:
_senderwidget that called this event
_indexitem index

Definition at line 180 of file MyGUI_ItemBox.h.

Event : Notify about event in item widget.
signature : void method(MyGUI::ItemBox* _sender, const MyGUI::IBNotifyItemData& _info)

Parameters:
_senderwidget that called this event
_infoinfo about item notify

Definition at line 187 of file MyGUI_ItemBox.h.

Event : Doubleclick or enter pressed on item.
signature : void method(MyGUI::ItemBox* _sender, size_t _index)

Parameters:
_senderwidget that called this event
_indexitem index

Definition at line 166 of file MyGUI_ItemBox.h.

Event : Request for item coordinate.
signature : void method(MyGUI::ItemBox* _sender, MyGUI::IntCoord& _coord, bool _drag)

Parameters:
_senderwidget that called this event
_coordwrite heer item coordinate
_dragis this item dragging

Definition at line 151 of file MyGUI_ItemBox.h.

Event : Request for creating new item.
signature : void method(MyGUI::ItemBox* _sender, MyGUI::Widget* _item)

Parameters:
_senderwidget that called this event
_itemwidget item pointer

Definition at line 143 of file MyGUI_ItemBox.h.

Event : Request for item redraw.
signature : void method(MyGUI::ItemBox* _sender, MyGUI::Widget* _item, const MyGUI::IBDrawItemInfo& _info)

Parameters:
_senderwidget that called this event
_itemwidget item pointer
_infoitem info

Definition at line 159 of file MyGUI_ItemBox.h.


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