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

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

#include <MyGUI_MenuControl.h>

+ Inheritance diagram for MyGUI::MenuControl:

Data Structures

struct  ItemInfo

Public Types

typedef RTTIBase Base
typedef MenuControl RTTIBase
typedef std::vector< ItemInfoVectorMenuItemInfo

Public Member Functions

virtual const std::string & getTypeName () const
virtual bool isType (const std::type_info &_type) const
template<typename Type >
bool isType () const
 MenuControl ()
virtual void setVisible (bool _value)
void setVisibleSmooth (bool _value)
size_t getItemCount () const
 Get number of items.
MenuIteminsertItemAt (size_t _index, const UString &_name, MenuItemType _type=MenuItemType::Normal, const std::string &_id="", Any _data=Any::Null)
 Insert an item into a array at a specified position.
MenuIteminsertItem (MenuItem *_to, const UString &_name, MenuItemType _type=MenuItemType::Normal, const std::string &_id="", Any _data=Any::Null)
 Insert an item into a array.
MenuItemaddItem (const UString &_name, MenuItemType _type=MenuItemType::Normal, const std::string &_id="", 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 removeItem (MenuItem *_item)
 Remove item.
void removeAllItems ()
 Remove all items.
MenuItemgetItemAt (size_t _index)
 Get item from specified position.
size_t getItemIndex (MenuItem *_item)
 Get item index.
size_t findItemIndex (MenuItem *_item)
 Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.
MenuItemfindItemWith (const UString &_name)
 Search item, returns the item of the first occurrence in array or nullptr if item not found.
void setItemDataAt (size_t _index, Any _data)
 Replace an item data at a specified position.
void setItemData (MenuItem *_item, Any _data)
 Replace an item data.
void clearItemDataAt (size_t _index)
 Clear an item data at a specified position.
void clearItemData (MenuItem *_item)
 Clear an item data.
template<typename ValueType >
ValueType * getItemDataAt (size_t _index, bool _throw=true)
 Get item data from specified position.
template<typename ValueType >
ValueType * getItemData (MenuItem *_item, bool _throw=true)
 Get item data.
void setItemIdAt (size_t _index, const std::string &_id)
 Replace an item id at a specified position.
void setItemId (MenuItem *_item, const std::string &_id)
 Replace an item id.
const std::string & getItemIdAt (size_t _index)
 Get item id from specified position.
const std::string & getItemId (MenuItem *_item)
 Get item id.
MenuItemgetItemById (const std::string &_id)
MenuItemfindItemById (const std::string &_id, bool _recursive=false)
size_t getItemIndexById (const std::string &_id)
void setItemNameAt (size_t _index, const UString &_name)
 Replace an item name at a specified position.
void setItemName (MenuItem *_item, const UString &_name)
 Replace an item name.
const UStringgetItemNameAt (size_t _index)
 Get item from specified position.
const UStringgetItemName (MenuItem *_item)
 Get item from specified position.
size_t findItemIndexWith (const UString &_name)
 Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.
void setItemChildVisibleAt (size_t _index, bool _visible)
void setItemChildVisible (MenuItem *_item, bool _visible)
template<typename Type >
Type * createItemChildTAt (size_t _index)
template<typename Type >
Type * createItemChildT (MenuItem *_item)
MenuControlgetItemChildAt (size_t _index)
MenuControlgetItemChild (MenuItem *_item)
MenuControlcreateItemChildAt (size_t _index)
MenuControlcreateItemChild (MenuItem *_item)
void removeItemChildAt (size_t _index)
void removeItemChild (MenuItem *_item)
MenuItemType getItemTypeAt (size_t _index)
MenuItemType getItemType (MenuItem *_item)
void setItemTypeAt (size_t _index, MenuItemType _type)
void setItemType (MenuItem *_item, MenuItemType _type)
void setPopupAccept (bool _value)
bool getPopupAccept () const
MenuItemgetMenuItemParent ()
void setVerticalAlignment (bool _value)
bool getVerticalAlignment () const
void _notifyDeleteItem (MenuItem *_item)
void _notifyDeletePopup (MenuItem *_item)
void _notifyUpdateName (MenuItem *_item)
void _wrapItemChild (MenuItem *_item, MenuControl *_widget)
virtual size_t _getItemCount ()
virtual void _addItem (const MyGUI::UString &_name)
virtual void _removeItemAt (size_t _index)
virtual Widget_getItemAt (size_t _index)
virtual void _setItemNameAt (size_t _index, const UString &_name)
virtual const UString_getItemNameAt (size_t _index)
virtual void _setItemSelected (IItem *_item)
void _updateItems (size_t _index)
void _updateSizeForEmpty ()

Static Public Member Functions

static const std::string & getClassTypeName ()

Data Fields

EventHandle_MenuCtrlPtrMenuItemPtr eventMenuCtrlAccept
EventHandle_MenuCtrlPtr eventMenuCtrlClose

Protected Member Functions

virtual void initialiseOverride ()
virtual void shutdownOverride ()
virtual void onKeyChangeRootFocus (bool _focus)
virtual void onWidgetCreated (Widget *_widget)
virtual void setPropertyOverride (const std::string &_key, const std::string &_value)

Protected Attributes

bool mHideByAccept
bool mMenuDropMode
bool mIsMenuDrop
bool mHideByLostKey
bool mResizeToContent

Detailed Description

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

Definition at line 30 of file MyGUI_MenuControl.h.


Member Typedef Documentation

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::MenuBar, and MyGUI::PopupMenu.

Definition at line 35 of file MyGUI_MenuControl.h.

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::MenuBar, and MyGUI::PopupMenu.

Definition at line 35 of file MyGUI_MenuControl.h.

Definition at line 69 of file MyGUI_MenuControl.h.


Constructor & Destructor Documentation

Definition at line 25 of file MyGUI_MenuControl.cpp.


Member Function Documentation

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 818 of file MyGUI_MenuControl.cpp.

Widget * MyGUI::MenuControl::_getItemAt ( size_t  _index) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 830 of file MyGUI_MenuControl.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 813 of file MyGUI_MenuControl.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 840 of file MyGUI_MenuControl.cpp.

Definition at line 258 of file MyGUI_MenuControl.cpp.

Definition at line 273 of file MyGUI_MenuControl.cpp.

Definition at line 279 of file MyGUI_MenuControl.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 823 of file MyGUI_MenuControl.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 835 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::_setItemSelected ( IItem _item) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 845 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::_updateItems ( size_t  _index)

Definition at line 870 of file MyGUI_MenuControl.cpp.

Definition at line 876 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::_wrapItemChild ( MenuItem _item,
MenuControl _widget 
)

Definition at line 493 of file MyGUI_MenuControl.cpp.

MenuItem * MyGUI::MenuControl::addItem ( const UString _name,
MenuItemType  _type = MenuItemType::Normal,
const std::string &  _id = "",
Any  _data = Any::Null 
)

Add an item to the end of a array.

Definition at line 600 of file MyGUI_MenuControl.cpp.

Clear an item data.

Definition at line 713 of file MyGUI_MenuControl.cpp.

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

Clear an item data at a specified position.

Definition at line 708 of file MyGUI_MenuControl.cpp.

Create child item (submenu) for item

Definition at line 753 of file MyGUI_MenuControl.cpp.

Create child item (submenu) for item by index

Definition at line 748 of file MyGUI_MenuControl.cpp.

template<typename Type >
Type* MyGUI::MenuControl::createItemChildT ( MenuItem _item) [inline]

Create specific type child item (submenu) for item

Definition at line 191 of file MyGUI_MenuControl.h.

template<typename Type >
Type* MyGUI::MenuControl::createItemChildTAt ( size_t  _index) [inline]

Create specific type child item (submenu) for item by index

Definition at line 184 of file MyGUI_MenuControl.h.

MenuItem * MyGUI::MenuControl::findItemById ( const std::string &  _id,
bool  _recursive = false 
)

Find item by id

Definition at line 656 of file MyGUI_MenuControl.cpp.

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

Definition at line 683 of file MyGUI_MenuControl.cpp.

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

Definition at line 673 of file MyGUI_MenuControl.cpp.

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

Definition at line 626 of file MyGUI_MenuControl.cpp.

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

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::MenuBar, and MyGUI::PopupMenu.

Definition at line 35 of file MyGUI_MenuControl.h.

Get item from specified position.

Definition at line 610 of file MyGUI_MenuControl.cpp.

MenuItem * MyGUI::MenuControl::getItemById ( const std::string &  _id)

Get item by id

Definition at line 636 of file MyGUI_MenuControl.cpp.

Get child item (submenu) from item

Definition at line 743 of file MyGUI_MenuControl.cpp.

Get child item (submenu) from item by index

Definition at line 216 of file MyGUI_MenuControl.cpp.

Get number of items.

Definition at line 698 of file MyGUI_MenuControl.cpp.

template<typename ValueType >
ValueType* MyGUI::MenuControl::getItemData ( MenuItem _item,
bool  _throw = true 
) [inline]

Get item data.

Definition at line 135 of file MyGUI_MenuControl.h.

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

Get item data from specified position.

Definition at line 128 of file MyGUI_MenuControl.h.

const std::string & MyGUI::MenuControl::getItemId ( MenuItem _item)

Get item id.

Definition at line 723 of file MyGUI_MenuControl.cpp.

const std::string & MyGUI::MenuControl::getItemIdAt ( size_t  _index)

Get item id from specified position.

Definition at line 252 of file MyGUI_MenuControl.cpp.

Get item index.

Definition at line 616 of file MyGUI_MenuControl.cpp.

size_t MyGUI::MenuControl::getItemIndexById ( const std::string &  _id)

Get item index by id

Definition at line 646 of file MyGUI_MenuControl.cpp.

Get item from specified position.

Definition at line 733 of file MyGUI_MenuControl.cpp.

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

Get item from specified position.

Definition at line 161 of file MyGUI_MenuControl.cpp.

Get item type (see MenuItemType) from item

Definition at line 763 of file MyGUI_MenuControl.cpp.

Get item type (see MenuItemType) from item by index

Definition at line 289 of file MyGUI_MenuControl.cpp.

Get parent menu item or nullptr if no item

Definition at line 783 of file MyGUI_MenuControl.cpp.

Get mode when clicking on item with submenu generate eventMenuCtrlAccept and closes menu

Definition at line 778 of file MyGUI_MenuControl.cpp.

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

Get type name as string

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::MenuBar, and MyGUI::PopupMenu.

Definition at line 35 of file MyGUI_MenuControl.h.

Get vertical alignment mode flag

Definition at line 889 of file MyGUI_MenuControl.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 43 of file MyGUI_MenuControl.cpp.

MenuItem * MyGUI::MenuControl::insertItem ( MenuItem _to,
const UString _name,
MenuItemType  _type = MenuItemType::Normal,
const std::string &  _id = "",
Any  _data = Any::Null 
)

Insert an item into a array.

Definition at line 595 of file MyGUI_MenuControl.cpp.

MenuItem * MyGUI::MenuControl::insertItemAt ( size_t  _index,
const UString _name,
MenuItemType  _type = MenuItemType::Normal,
const std::string &  _id = "",
Any  _data = Any::Null 
)

Insert an item into a array at a specified position.

Definition at line 123 of file MyGUI_MenuControl.cpp.

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

Compare with selected type

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::MenuBar, and MyGUI::PopupMenu.

Definition at line 35 of file MyGUI_MenuControl.h.

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

Compare with selected type

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::MenuBar, and MyGUI::PopupMenu.

Definition at line 35 of file MyGUI_MenuControl.h.

void MyGUI::MenuControl::onKeyChangeRootFocus ( bool  _focus) [protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 474 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::onWidgetCreated ( Widget _widget) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 112 of file MyGUI_MenuControl.cpp.

Remove all items.

Definition at line 148 of file MyGUI_MenuControl.cpp.

Remove item.

Definition at line 605 of file MyGUI_MenuControl.cpp.

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

Remove item at a specified position.

Definition at line 136 of file MyGUI_MenuControl.cpp.

Remove child item (submenu) for item

Definition at line 758 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::removeItemChildAt ( size_t  _index)

Remove child item (submenu) for item by index

Definition at line 222 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::setItemChildVisible ( MenuItem _item,
bool  _visible 
)

Show or hide item (submenu)

Definition at line 738 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::setItemChildVisibleAt ( size_t  _index,
bool  _visible 
)

Show or hide item (submenu) at a specified position

Definition at line 340 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::setItemData ( MenuItem _item,
Any  _data 
)

Replace an item data.

Definition at line 703 of file MyGUI_MenuControl.cpp.

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

Replace an item data at a specified position.

Definition at line 210 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::setItemId ( MenuItem _item,
const std::string &  _id 
)

Replace an item id.

Definition at line 718 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::setItemIdAt ( size_t  _index,
const std::string &  _id 
)

Replace an item id at a specified position.

Definition at line 246 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::setItemName ( MenuItem _item,
const UString _name 
)

Replace an item name.

Definition at line 728 of file MyGUI_MenuControl.cpp.

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

Replace an item name at a specified position.

Definition at line 235 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::setItemType ( MenuItem _item,
MenuItemType  _type 
)

Set item type (see MenuItemType) from item

Definition at line 768 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::setItemTypeAt ( size_t  _index,
MenuItemType  _type 
)

Set item type (see MenuItemType) from item by index

Definition at line 295 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::setPopupAccept ( bool  _value)

Set mode when clicking on item with submenu generate eventMenuCtrlAccept and closes menu

Definition at line 773 of file MyGUI_MenuControl.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 894 of file MyGUI_MenuControl.cpp.

Set vertical alignment mode

Definition at line 882 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::setVisible ( bool  _value) [virtual]

Hide or show widget

Reimplemented from MyGUI::Widget.

Definition at line 534 of file MyGUI_MenuControl.cpp.

void MyGUI::MenuControl::setVisibleSmooth ( bool  _value)

Hide or show Menu smooth

Definition at line 555 of file MyGUI_MenuControl.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 102 of file MyGUI_MenuControl.cpp.


Field Documentation

Event : Enter pressed or mouse clicked.
signature : void method(MyGUI::MenuControl* _sender, MyGUI::MenuItem* _item)

Parameters:
_senderwidget that called this event
_itemSelected item

Definition at line 246 of file MyGUI_MenuControl.h.

Event : Menu was closed by select or focus change.
signature : void method(MyGUI::MenuControl* _sender)

Parameters:
_senderwidget that called this event

Definition at line 252 of file MyGUI_MenuControl.h.

Definition at line 308 of file MyGUI_MenuControl.h.

Definition at line 312 of file MyGUI_MenuControl.h.

Definition at line 311 of file MyGUI_MenuControl.h.

Definition at line 310 of file MyGUI_MenuControl.h.

Definition at line 313 of file MyGUI_MenuControl.h.


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