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

#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 ()
 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 setItemBoxAlignVert (bool _value)
bool getItemBoxAlignVert ()
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)
virtual void _initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin *_info, Widget *_parent, ICroppedRectangle *_croppedParent, IWidgetCreator *_creator, const std::string &_name)
void setPosition (const IntCoord &_coord)
void setPosition (int _left, int _top, int _width, int _height)
size_t getItemIndexSelected ()
void setItemSelectedAt (size_t _index)
void clearItemSelected ()
void insertItem (size_t _index, Any _data=Any::Null)
void setItemData (size_t _index, Any _data)
void deleteItem (size_t _index)
void deleteAllItems ()
size_t getItemSelect ()
void resetItemSelect ()
void setItemSelect (size_t _index)
WidgetgetWidgetDrop ()
void resetDrop ()

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 ~ItemBox ()
void baseChangeWidgetSkin (ResourceSkin *_info)
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 (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 _resetContainer (bool _update)

Detailed Description

Definition at line 42 of file MyGUI_ItemBox.h.


Member Typedef Documentation

Reimplemented from MyGUI::DDContainer.

Definition at line 46 of file MyGUI_ItemBox.h.

Reimplemented from MyGUI::DDContainer.

Definition at line 46 of file MyGUI_ItemBox.h.

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

Definition at line 245 of file MyGUI_ItemBox.h.


Constructor & Destructor Documentation

Definition at line 37 of file MyGUI_ItemBox.cpp.

MyGUI::ItemBox::~ItemBox ( ) [protected, virtual]

Definition at line 60 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 541 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::DDContainer.

Definition at line 53 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::_requestGetContainer ( Widget _sender,
Widget *&  _container,
size_t &  _index 
) [protected]

Definition at line 336 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 556 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 354 of file MyGUI_ItemBox.cpp.

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

Definition at line 171 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::addItem ( Any  _data = Any::Null) [inline]

Add an item to the end of a array.

Definition at line 61 of file MyGUI_ItemBox.h.

void MyGUI::ItemBox::baseChangeWidgetSkin ( ResourceSkin _info) [protected, virtual]

Reimplemented from MyGUI::DDContainer.

Definition at line 65 of file MyGUI_ItemBox.cpp.

Clear item selection.

Definition at line 86 of file MyGUI_ItemBox.h.

void MyGUI::ItemBox::clearItemDataAt ( size_t  _index) [inline]

Clear an item data at a specified position.

Definition at line 96 of file MyGUI_ItemBox.h.

Deprecated:
"use : void ItemBox::clearIndexSelected()"

Definition at line 211 of file MyGUI_ItemBox.h.

void MyGUI::ItemBox::deleteAllItems ( ) [inline]
Deprecated:
"use : void ItemBox::removeAllItems()"

Definition at line 220 of file MyGUI_ItemBox.h.

void MyGUI::ItemBox::deleteItem ( size_t  _index) [inline]
Deprecated:
"use : void ItemBox::removeItemAt(size_t _index)"

Definition at line 218 of file MyGUI_ItemBox.h.

Definition at line 300 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::DDContainer.

Definition at line 46 of file MyGUI_ItemBox.h.

Get item index by item Widget pointer

Definition at line 529 of file MyGUI_ItemBox.cpp.

size_t MyGUI::ItemBox::getIndexSelected ( ) [inline]

Get index of selected item (ITEM_NONE if none selected)

Definition at line 80 of file MyGUI_ItemBox.h.

Get vertical alignment grid mode flag

Definition at line 110 of file MyGUI_ItemBox.h.

size_t MyGUI::ItemBox::getItemCount ( ) const [inline]

Get number of items.

Definition at line 55 of file MyGUI_ItemBox.h.

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

Get item data from specified position.

Definition at line 100 of file MyGUI_ItemBox.h.

Deprecated:
"use : size_t ItemBox::getItemIndexSelected()"

Definition at line 207 of file MyGUI_ItemBox.h.

size_t MyGUI::ItemBox::getItemSelect ( ) [inline]
Deprecated:
"use : size_t ItemBox::getIndexSelected()"

Definition at line 222 of file MyGUI_ItemBox.h.

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

Definition at line 224 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 46 of file MyGUI_ItemBox.h.

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 571 of file MyGUI_ItemBox.cpp.

Get widget created for drop

Definition at line 116 of file MyGUI_ItemBox.h.

Deprecated:
"use : Widget* ItemBox::getWidgetDrag()"

Definition at line 229 of file MyGUI_ItemBox.h.

void MyGUI::ItemBox::insertItem ( size_t  _index,
Any  _data = Any::Null 
) [inline]
Deprecated:
"use : void ItemBox::insertItemAt(size_t _index, Any _data)"

Definition at line 214 of file MyGUI_ItemBox.h.

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

Insert an item into a array at a specified position.

Definition at line 385 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 46 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 46 of file MyGUI_ItemBox.h.

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

Definition at line 519 of file MyGUI_ItemBox.cpp.

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

Definition at line 524 of file MyGUI_ItemBox.cpp.

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

Definition at line 503 of file MyGUI_ItemBox.cpp.

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

Definition at line 648 of file MyGUI_ItemBox.cpp.

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

Definition at line 682 of file MyGUI_ItemBox.cpp.

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

Definition at line 643 of file MyGUI_ItemBox.cpp.

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

Definition at line 769 of file MyGUI_ItemBox.cpp.

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

Definition at line 691 of file MyGUI_ItemBox.cpp.

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

Definition at line 755 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::WidgetEvent.

Definition at line 273 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::WidgetEvent.

Definition at line 265 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::DDContainer.

Definition at line 585 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::DDContainer.

Definition at line 590 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::DDContainer.

Definition at line 595 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::WidgetEvent.

Definition at line 258 of file MyGUI_ItemBox.cpp.

Redraw all items.

Definition at line 845 of file MyGUI_ItemBox.cpp.

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

Redraw at a specified position.

Definition at line 459 of file MyGUI_ItemBox.cpp.

Remove all items.

Definition at line 443 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::DDContainer.

Definition at line 600 of file MyGUI_ItemBox.cpp.

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

Remove item at a specified position.

Definition at line 413 of file MyGUI_ItemBox.cpp.

Definition at line 281 of file MyGUI_ItemBox.cpp.

Interrupt drag as if widget was dropped into empty space

Definition at line 850 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::resetDrop ( ) [inline]
Deprecated:
"use : void ItemBox::resetDrag()"

Definition at line 231 of file MyGUI_ItemBox.h.

Deprecated:
"use : void ItemBox::clearIndexSelected()"

Definition at line 224 of file MyGUI_ItemBox.h.

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

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 143 of file MyGUI_ItemBox.cpp.

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

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 140 of file MyGUI_ItemBox.h.

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

Select specified _index.

Definition at line 471 of file MyGUI_ItemBox.cpp.

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

Set vertical alignment grid mode

Definition at line 510 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::setItemData ( size_t  _index,
Any  _data 
) [inline]
Deprecated:
"use : void ItemBox::setItemDataAt(size_t _index, Any _data)"

Definition at line 216 of file MyGUI_ItemBox.h.

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

Replace an item data at a specified position.

Definition at line 370 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::setItemSelect ( size_t  _index) [inline]
Deprecated:
"use : void ItemBox::setIndexSelected(size_t _index)"

Definition at line 226 of file MyGUI_ItemBox.h.

void MyGUI::ItemBox::setItemSelectedAt ( size_t  _index) [inline]
Deprecated:
"use : void ItemBox::setIndexSelected(size_t _index)"

Definition at line 209 of file MyGUI_ItemBox.h.

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

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 132 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::setPosition ( int  _left,
int  _top 
) [inline]

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 136 of file MyGUI_ItemBox.h.

void MyGUI::ItemBox::setPosition ( const IntCoord _coord) [inline]
Deprecated:
"use : void Widget::setCoord(const IntCoord& _coord)"

Reimplemented from MyGUI::Widget.

Definition at line 202 of file MyGUI_ItemBox.h.

void MyGUI::ItemBox::setPosition ( int  _left,
int  _top,
int  _width,
int  _height 
) [inline]
Deprecated:
"use : void Widget::setCoord(int _left, int _top, int _width, int _height)"

Reimplemented from MyGUI::Widget.

Definition at line 204 of file MyGUI_ItemBox.h.

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

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 137 of file MyGUI_ItemBox.cpp.

void MyGUI::ItemBox::setSize ( int  _width,
int  _height 
) [inline]

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 138 of file MyGUI_ItemBox.h.

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

Reimplemented from MyGUI::DDContainer.

Definition at line 605 of file MyGUI_ItemBox.cpp.

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

Reimplemented from MyGUI::DDContainer.

Definition at line 627 of file MyGUI_ItemBox.cpp.

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

Definition at line 160 of file MyGUI_ItemBox.cpp.

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

Definition at line 724 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 178 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 185 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 192 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 171 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 156 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 148 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 164 of file MyGUI_ItemBox.h.


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