MyGUI::MenuCtrl Class Reference

#include <MyGUI_MenuCtrl.h>

Inheritance diagram for MyGUI::MenuCtrl:
Inheritance graph
[legend]

Data Structures

struct  ItemInfo

Public Types

enum  ItemImage { ItemImageNone, ItemImagePopup }
typedef std::vector< ItemInfoVectorMenuItemInfo

Public Member Functions

 MenuCtrl ()
virtual void setVisible (bool _value)
void setVisibleSmooth (bool _value)
size_t getItemCount ()
 Get number of items.
MenuItemPtr 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.
MenuItemPtr insertItem (MenuItemPtr _to, const UString &_name, MenuItemType _type=MenuItemType::Normal, const std::string &_id="", Any _data=Any::Null)
 Insert an item into a array.
MenuItemPtr 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.
void removeItemAt (size_t _index)
 Remove item at a specified position.
void removeItem (MenuItemPtr _item)
 Remove item.
void removeAllItems ()
 Remove all items.
MenuItemPtr getItemAt (size_t _index)
 Get item from specified position.
size_t getItemIndex (MenuItemPtr _item)
 Get item index.
size_t findItemIndex (MenuItemPtr _item)
 Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.
MenuItemPtr findItemWith (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 (MenuItemPtr _item, Any _data)
 Replace an item data.
void clearItemDataAt (size_t _index)
 Clear an item data at a specified position.
void clearItemData (MenuItemPtr _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 (MenuItemPtr _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 (MenuItemPtr _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 (MenuItemPtr _item)
 Get item id.
MenuItemPtr getItemById (const std::string &_id)
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 (MenuItemPtr _item, const UString &_name)
 Replace an item name.
const UStringgetItemNameAt (size_t _index)
 Get item from specified position.
const UStringgetItemName (MenuItemPtr _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 (MenuItemPtr _item, bool _visible)
template<typename Type >
Type * createItemChildTAt (size_t _index)
template<typename Type >
Type * createItemChildT (MenuItemPtr _item)
MenuCtrlPtr getItemChildAt (size_t _index)
MenuCtrlPtr getItemChild (MenuItemPtr _item)
MenuCtrlPtr createItemChildAt (size_t _index)
MenuCtrlPtr createItemChild (MenuItemPtr _item)
void removeItemChildAt (size_t _index)
void removeItemChild (MenuItemPtr _item)
MenuItemType getItemTypeAt (size_t _index)
MenuItemType getItemType (MenuItemPtr _item)
void setItemTypeAt (size_t _index, MenuItemType _type)
void setItemType (MenuItemPtr _item, MenuItemType _type)
void setPopupAccept (bool _value)
bool getPopupAccept ()
MenuItemPtr getMenuItemParent ()
void _notifyDeleteItem (MenuItemPtr _item)
void _notifyUpdateName (MenuItemPtr _item)
void _wrapItemChild (MenuItemPtr _item, MenuCtrlPtr _widget)
virtual void _initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin *_info, WidgetPtr _parent, ICroppedRectangle *_croppedParent, IWidgetCreator *_creator, const std::string &_name)
 __declspec (deprecated("use : void Widget::setVisible(bool _value)")) void showMenu()
 __declspec (deprecated("use : void Widget::setVisible(bool _value)")) void hideMenu()
 __declspec (deprecated("use : bool Widget::isVisible()")) bool isShowMenu()
 __declspec (deprecated("use : void setItemChildVisibleAt(size_t _index, bool _visible)")) void showItemChildAt(size_t _index)
 __declspec (deprecated("use : void setItemChildVisible(MenuItemPtr _item, bool _visible)")) void showItemChild(MenuItemPtr _item)
 __declspec (deprecated("use : void setItemChildVisibleAt(size_t _index, bool _visible)")) void hideItemChildAt(size_t _index)
 __declspec (deprecated("use : void setItemChildVisible(MenuItemPtr _item, bool _visible)")) void hideItemChild(MenuItemPtr _item)

Data Fields

EventHandle_MenuCtrlPtrMenuItemPtr eventMenuCtrlAccept
EventHandle_MenuCtrlPtr eventMenuCtrlClose

Protected Member Functions

virtual ~MenuCtrl ()
void baseChangeWidgetSkin (ResourceSkin *_info)
virtual WidgetPtr baseCreateWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer, const std::string &_name)
virtual void onKeyChangeRootFocus (bool _focus)

Protected Attributes

bool mHideByAccept
bool mMenuDropMode
bool mIsMenuDrop
bool mHideByLostKey

Detailed Description

Definition at line 41 of file MyGUI_MenuCtrl.h.


Member Typedef Documentation

Definition at line 84 of file MyGUI_MenuCtrl.h.


Member Enumeration Documentation

Enumerator:
ItemImageNone 
ItemImagePopup 

Definition at line 49 of file MyGUI_MenuCtrl.h.


Constructor & Destructor Documentation

MyGUI::MenuCtrl::MenuCtrl (  ) 

Definition at line 40 of file MyGUI_MenuCtrl.cpp.

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

Definition at line 80 of file MyGUI_MenuCtrl.cpp.


Member Function Documentation

MyGUI::MenuCtrl::__declspec ( deprecated("use : void setItemChildVisible(MenuItemPtr _item, bool _visible)")   )  [inline]
Deprecated:
"use : void setItemChildVisible(MenuItemPtr _item, bool _visible)"

Definition at line 282 of file MyGUI_MenuCtrl.h.

MyGUI::MenuCtrl::__declspec ( deprecated("use : void setItemChildVisibleAt(size_t _index, bool _visible)")   )  [inline]
Deprecated:
"use : void setItemChildVisibleAt(size_t _index, bool _visible)"

Definition at line 280 of file MyGUI_MenuCtrl.h.

MyGUI::MenuCtrl::__declspec ( deprecated("use : void setItemChildVisible(MenuItemPtr _item, bool _visible)")   )  [inline]
Deprecated:
"use : void setItemChildVisible(MenuItemPtr _item, bool _visible)"

Definition at line 278 of file MyGUI_MenuCtrl.h.

MyGUI::MenuCtrl::__declspec ( deprecated("use : void setItemChildVisibleAt(size_t _index, bool _visible)")   )  [inline]
Deprecated:
"use : void setItemChildVisibleAt(size_t _index, bool _visible)"

Definition at line 276 of file MyGUI_MenuCtrl.h.

MyGUI::MenuCtrl::__declspec ( deprecated("use : bool Widget::isVisible()")   )  [inline]
Deprecated:
"use : bool Widget::isVisible()"

Definition at line 273 of file MyGUI_MenuCtrl.h.

MyGUI::MenuCtrl::__declspec ( deprecated("use : void Widget::setVisible(bool _value)")   )  [inline]
Deprecated:
"use : void Widget::setVisible(bool _value)"

Definition at line 271 of file MyGUI_MenuCtrl.h.

MyGUI::MenuCtrl::__declspec ( deprecated("use : void Widget::setVisible(bool _value)")   )  [inline]
Deprecated:
"use : void Widget::setVisible(bool _value)"

Definition at line 269 of file MyGUI_MenuCtrl.h.

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

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

Definition at line 57 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::_notifyDeleteItem ( MenuItemPtr  _item  ) 

Definition at line 299 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::_notifyUpdateName ( MenuItemPtr  _item  ) 

Definition at line 309 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::_wrapItemChild ( MenuItemPtr  _item,
MenuCtrlPtr  _widget 
)

Definition at line 513 of file MyGUI_MenuCtrl.cpp.

MenuItemPtr MyGUI::MenuCtrl::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 617 of file MyGUI_MenuCtrl.cpp.

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

Reimplemented from MyGUI::Widget.

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

Definition at line 86 of file MyGUI_MenuCtrl.cpp.

WidgetPtr MyGUI::MenuCtrl::baseCreateWidget ( WidgetStyle  _style,
const std::string &  _type,
const std::string &  _skin,
const IntCoord _coord,
Align  _align,
const std::string &  _layer,
const std::string &  _name 
) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 151 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::clearItemData ( MenuItemPtr  _item  )  [inline]

Clear an item data.

Definition at line 139 of file MyGUI_MenuCtrl.h.

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

Clear an item data at a specified position.

Definition at line 137 of file MyGUI_MenuCtrl.h.

MenuCtrlPtr MyGUI::MenuCtrl::createItemChild ( MenuItemPtr  _item  )  [inline]

Create child item (submenu) for item

Definition at line 215 of file MyGUI_MenuCtrl.h.

MenuCtrlPtr MyGUI::MenuCtrl::createItemChildAt ( size_t  _index  )  [inline]

Create child item (submenu) for item by index

Definition at line 212 of file MyGUI_MenuCtrl.h.

template<typename Type >
Type* MyGUI::MenuCtrl::createItemChildT ( MenuItemPtr  _item  )  [inline]

Create specific type child item (submenu) for item

Definition at line 203 of file MyGUI_MenuCtrl.h.

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

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

Definition at line 196 of file MyGUI_MenuCtrl.h.

size_t MyGUI::MenuCtrl::findItemIndex ( MenuItemPtr  _item  ) 

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

size_t MyGUI::MenuCtrl::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 669 of file MyGUI_MenuCtrl.cpp.

MenuItemPtr MyGUI::MenuCtrl::findItemWith ( const UString _name  ) 

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

Definition at line 642 of file MyGUI_MenuCtrl.cpp.

MenuItemPtr MyGUI::MenuCtrl::getItemAt ( size_t  _index  ) 

Get item from specified position.

Definition at line 627 of file MyGUI_MenuCtrl.cpp.

MenuItemPtr MyGUI::MenuCtrl::getItemById ( const std::string &  _id  ) 

Get item by id

Definition at line 651 of file MyGUI_MenuCtrl.cpp.

MenuCtrlPtr MyGUI::MenuCtrl::getItemChild ( MenuItemPtr  _item  )  [inline]

Get child item (submenu) from item

Definition at line 209 of file MyGUI_MenuCtrl.h.

MenuCtrlPtr MyGUI::MenuCtrl::getItemChildAt ( size_t  _index  ) 

Get child item (submenu) from item by index

Definition at line 257 of file MyGUI_MenuCtrl.cpp.

size_t MyGUI::MenuCtrl::getItemCount (  )  [inline]

Get number of items.

Definition at line 97 of file MyGUI_MenuCtrl.h.

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

Get item data.

Definition at line 150 of file MyGUI_MenuCtrl.h.

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

Get item data from specified position.

Definition at line 143 of file MyGUI_MenuCtrl.h.

const std::string& MyGUI::MenuCtrl::getItemId ( MenuItemPtr  _item  )  [inline]

Get item id.

Definition at line 163 of file MyGUI_MenuCtrl.h.

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

Get item id from specified position.

Definition at line 293 of file MyGUI_MenuCtrl.cpp.

size_t MyGUI::MenuCtrl::getItemIndex ( MenuItemPtr  _item  ) 

Get item index.

Definition at line 633 of file MyGUI_MenuCtrl.cpp.

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

Get item index by id

Definition at line 660 of file MyGUI_MenuCtrl.cpp.

const UString& MyGUI::MenuCtrl::getItemName ( MenuItemPtr  _item  )  [inline]

Get item from specified position.

Definition at line 181 of file MyGUI_MenuCtrl.h.

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

Get item from specified position.

Definition at line 196 of file MyGUI_MenuCtrl.cpp.

MenuItemType MyGUI::MenuCtrl::getItemType ( MenuItemPtr  _item  )  [inline]

Get item type (see MenuItemType) from item

Definition at line 228 of file MyGUI_MenuCtrl.h.

MenuItemType MyGUI::MenuCtrl::getItemTypeAt ( size_t  _index  ) 

Get item type (see MenuItemType) from item by index

Definition at line 319 of file MyGUI_MenuCtrl.cpp.

MenuItemPtr MyGUI::MenuCtrl::getMenuItemParent (  )  [inline]

Get parent menu item or nullptr if no item

Definition at line 241 of file MyGUI_MenuCtrl.h.

bool MyGUI::MenuCtrl::getPopupAccept (  )  [inline]

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

Definition at line 238 of file MyGUI_MenuCtrl.h.

MenuItemPtr MyGUI::MenuCtrl::insertItem ( MenuItemPtr  _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 612 of file MyGUI_MenuCtrl.cpp.

MenuItemPtr MyGUI::MenuCtrl::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 162 of file MyGUI_MenuCtrl.cpp.

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

Reimplemented from MyGUI::WidgetEvent.

Definition at line 492 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::removeAllItems (  ) 

Remove all items.

Definition at line 184 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::removeItem ( MenuItemPtr  _item  ) 

Remove item.

Definition at line 622 of file MyGUI_MenuCtrl.cpp.

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

Remove item at a specified position.

Definition at line 173 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::removeItemChild ( MenuItemPtr  _item  )  [inline]

Remove child item (submenu) for item

Definition at line 221 of file MyGUI_MenuCtrl.h.

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

Remove child item (submenu) for item by index

Definition at line 263 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::setItemChildVisible ( MenuItemPtr  _item,
bool  _visible 
) [inline]

Show or hide item (submenu)

Definition at line 189 of file MyGUI_MenuCtrl.h.

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

Show or hide item (submenu) at a specified position

Definition at line 385 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::setItemData ( MenuItemPtr  _item,
Any  _data 
) [inline]

Replace an item data.

Definition at line 134 of file MyGUI_MenuCtrl.h.

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

Replace an item data at a specified position.

Definition at line 251 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::setItemId ( MenuItemPtr  _item,
const std::string &  _id 
) [inline]

Replace an item id.

Definition at line 158 of file MyGUI_MenuCtrl.h.

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

Replace an item id at a specified position.

Definition at line 287 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::setItemName ( MenuItemPtr  _item,
const UString _name 
) [inline]

Replace an item name.

Definition at line 176 of file MyGUI_MenuCtrl.h.

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

Replace an item name at a specified position.

Definition at line 276 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::setItemType ( MenuItemPtr  _item,
MenuItemType  _type 
) [inline]

Set item type (see MenuItemType) from item

Definition at line 233 of file MyGUI_MenuCtrl.h.

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

Set item type (see MenuItemType) from item by index

Definition at line 325 of file MyGUI_MenuCtrl.cpp.

void MyGUI::MenuCtrl::setPopupAccept ( bool  _value  )  [inline]

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

Definition at line 236 of file MyGUI_MenuCtrl.h.

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

Hide or show widget

Reimplemented from MyGUI::Widget.

Definition at line 550 of file MyGUI_MenuCtrl.cpp.

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

Hide or show Menu smooth

Definition at line 572 of file MyGUI_MenuCtrl.cpp.


Field Documentation

Event : Enter pressed or mouse clicked.
signature : void method(MyGUI::MenuCtrlPtr _sender, MyGUI::MenuItemPtr _item)

Parameters:
_sender widget that called this event
_item Selected item

Definition at line 250 of file MyGUI_MenuCtrl.h.

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

Parameters:
_sender widget that called this event

Definition at line 256 of file MyGUI_MenuCtrl.h.

Definition at line 335 of file MyGUI_MenuCtrl.h.

Definition at line 339 of file MyGUI_MenuCtrl.h.

bool MyGUI::MenuCtrl::mIsMenuDrop [protected]

Definition at line 338 of file MyGUI_MenuCtrl.h.

Definition at line 337 of file MyGUI_MenuCtrl.h.


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

Generated on 3 Dec 2009 for MyGUI by  doxygen 1.6.1