widget description should be here. More...

#include <MyGUI_MenuControl.h>

Inheritance diagram for MyGUI::MenuControl:

[legend]

Data Structures
struct	ItemInfo

Public Types
typedef RTTIBase	Base

typedef MenuControl	RTTIBase

typedef std::vector< ItemInfo >	VectorMenuItemInfo

Public Types inherited from MyGUI::Widget
typedef RTTIBase	Base

typedef Widget	RTTIBase

Public Types inherited from MyGUI::IObject
typedef IObject	RTTIBase

Public Member Functions
virtual const std::string &	getTypeName () const override

virtual bool	isType (const std::type_info &_type) const override

template<typename Type >
bool	isType () const

	MenuControl ()

void	setVisible (bool _value) override

void	setVisibleSmooth (bool _value)

size_t	getItemCount () const
	Get number of items.

MenuItem *	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.

MenuItem *	insertItem (MenuItem *_to, const UString &_name, MenuItemType _type=MenuItemType::Normal, const std::string &_id="", Any _data=Any::Null)
	Insert an item into a array.

MenuItem *	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 (MenuItem *_item)
	Remove item.

void	removeAllItems ()
	Remove all items.

MenuItem *	getItemAt (size_t _index) const
	Get item from specified position.

size_t	getItemIndex (const MenuItem *_item) const
	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.

MenuItem *	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 (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) const
	Get item id from specified position.

const std::string &	getItemId (const MenuItem *_item) const
	Get item id.

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

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

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

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 UString &	getItemNameAt (size_t _index) const
	Get item from specified position.

const UString &	getItemName (const MenuItem *_item) const
	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)

MenuControl *	getItemChildAt (size_t _index) const

MenuControl *	getItemChild (const MenuItem *_item) const

MenuControl *	createItemChildAt (size_t _index)

MenuControl *	createItemChild (MenuItem *_item)

void	removeItemChildAt (size_t _index)

void	removeItemChild (MenuItem *_item)

MenuItemType	getItemTypeAt (size_t _index) const

MenuItemType	getItemType (const MenuItem *_item) const

void	setItemTypeAt (size_t _index, MenuItemType _type)

void	setItemType (MenuItem *_item, MenuItemType _type)

void	setPopupAccept (bool _value)

bool	getPopupAccept () const

MenuItem *	getMenuItemParent () const

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)

size_t	_getItemCount () const override

void	_addItem (const MyGUI::UString &_name) override

void	_removeItemAt (size_t _index) override

Widget *	_getItemAt (size_t _index) const override

void	_setItemNameAt (size_t _index, const UString &_name) override

const UString &	_getItemNameAt (size_t _index) const override

void	_setItemSelected (IItem *_item) override

void	_updateItems (size_t _index)

void	_updateSizeForEmpty ()

Public Member Functions inherited from MyGUI::Widget
template<typename Type >
bool	isType () const

	Widget ()

Widget *	createWidgetT (const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")

Widget *	createWidgetT (const std::string &_type, const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")

Widget *	createWidgetRealT (const std::string &_type, const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")

Widget *	createWidgetRealT (const std::string &_type, const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")

template<typename T >
T *	createWidget (const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")

template<typename T >
T *	createWidget (const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")

template<typename T >
T *	createWidgetReal (const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")

template<typename T >
T *	createWidgetReal (const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")

Widget *	createWidgetT (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")

template<typename T >
T *	createWidget (WidgetStyle _style, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")

void	setPosition (const IntPoint &_value) override

void	setSize (const IntSize &_value) override

void	setCoord (const IntCoord &_value) override

void	setPosition (int _left, int _top)

void	setSize (int _width, int _height)

void	setCoord (int _left, int _top, int _width, int _height)

void	setRealPosition (const FloatPoint &_value)

void	setRealSize (const FloatSize &_value)

void	setRealCoord (const FloatCoord &_value)

void	setRealPosition (float _left, float _top)

void	setRealSize (float _width, float _height)

void	setRealCoord (float _left, float _top, float _width, float _height)

const std::string &	getName () const
	Get name of widget.

bool	getVisible () const

void	setDepth (int _value)

int	getDepth () const

bool	getInheritedVisible () const

virtual void	setAlign (Align _value)

Align	getAlign () const

void	setAlpha (float _value)

float	getAlpha () const

void	setInheritsAlpha (bool _value)

bool	getInheritsAlpha () const

void	setColour (const Colour &_value)

bool	isRootWidget () const

Widget *	getParent () const

IntSize	getParentSize () const

EnumeratorWidgetPtr	getEnumerator () const

size_t	getChildCount () const

Widget *	getChildAt (size_t _index) const

Widget *	findWidget (const std::string &_name)

void	findWidgets (const std::string &_name, VectorWidgetPtr &_result)

virtual void	setEnabled (bool _value)

void	setEnabledSilent (bool _value)

bool	getEnabled () const

bool	getInheritedEnabled () const

IntCoord	getClientCoord () const

Widget *	getClientWidget ()

const Widget *	getClientWidget () const

void	detachFromWidget (const std::string &_layer="")

void	attachToWidget (Widget *_parent, WidgetStyle _style=WidgetStyle::Child, const std::string &_layer="")

void	changeWidgetSkin (const std::string &_skinName)

void	setWidgetStyle (WidgetStyle _style, const std::string &_layer="")

WidgetStyle	getWidgetStyle () const

void	setProperty (const std::string &_key, const std::string &_value)

virtual size_t	_getItemIndex (Widget *_item) const

void	_forcePick (Widget *_widget)

void	_initialise (WidgetStyle _style, const IntCoord &_coord, const std::string &_skinName, Widget _parent, ICroppedRectangle _croppedParent, const std::string &_name)

void	_shutdown ()

void	_destroyChildWidget (Widget *_widget)

void	_setContainer (Widget *_value)

Widget *	_getContainer () const

void	_setAlign (const IntSize &_oldsize, const IntSize &_newSize)

bool	_checkPoint (int _left, int _top) const

Widget *	_createSkinWidget (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	_resetContainer (bool _update)

bool	_setWidgetState (const std::string &_value)

void	_updateChilds ()

Public Member Functions inherited from MyGUI::IObject
template<typename Type >
bool	isType () const

template<typename Type >
Type *	castType (bool _throw=true)

template<typename Type >
const Type *	castType (bool _throw=true) const

	IObject ()=default

virtual	~IObject ()=default

Public Member Functions inherited from MyGUI::ICroppedRectangle
	ICroppedRectangle ()

virtual	~ICroppedRectangle ()

ICroppedRectangle *	getCroppedParent ()

IntPoint	getPosition () const

IntSize	getSize () const

const IntCoord &	getCoord () const

const IntPoint &	getAbsolutePosition () const

IntRect	getAbsoluteRect () const

IntCoord	getAbsoluteCoord () const

int	getAbsoluteLeft () const

int	getAbsoluteTop () const

int	getLeft () const

int	getRight () const

int	getTop () const

int	getBottom () const

int	getWidth () const

int	getHeight () const

bool	_isMargin () const

int	_getViewLeft () const

int	_getViewRight () const

int	_getViewTop () const

int	_getViewBottom () const

int	_getViewWidth () const

int	_getViewHeight () const

void	_setCroppedParent (ICroppedRectangle *_parent)

const IntRect &	_getMargin () const

int	_getMarginLeft () const

int	_getMarginRight () const

int	_getMarginTop () const

int	_getMarginBottom () const

Public Member Functions inherited from MyGUI::UserData
virtual	~UserData ()=default

void	setUserString (const std::string &_key, const std::string &_value)

const std::string &	getUserString (const std::string &_key) const

const MapString &	getUserStrings () const

bool	clearUserString (const std::string &_key)

bool	isUserString (const std::string &_key) const

void	clearUserStrings ()

void	setUserData (Any _data)

template<typename ValueType >
ValueType *	getUserData (bool _throw=true) const

void	_setInternalData (Any _data)

template<typename ValueType >
ValueType *	_getInternalData (bool _throw=true) const

Public Member Functions inherited from MyGUI::WidgetInput
	WidgetInput ()

virtual	~WidgetInput ()=default

void	setNeedToolTip (bool _value)

bool	getNeedToolTip () const

void	setPointer (const std::string &_value)

const std::string &	getPointer () const

void	setNeedKeyFocus (bool _value)

bool	getNeedKeyFocus () const

void	setNeedMouseFocus (bool _value)

bool	getNeedMouseFocus () const

void	setInheritsPick (bool _value)

bool	getInheritsPick () const

void	setMaskPick (const std::string &_filename)

void	setMaskPick (const MaskPickInfo &_info)

bool	isMaskPickInside (const IntPoint &_point, const IntCoord &_coord) const

bool	getRootMouseFocus () const

bool	getRootKeyFocus () const

void	_riseMouseLostFocus (Widget *_new)

void	_riseMouseSetFocus (Widget *_old)

void	_riseMouseDrag (int _left, int _top, MouseButton _id)

void	_riseMouseMove (int _left, int _top)

void	_riseMouseWheel (int _rel)

void	_riseMouseButtonPressed (int _left, int _top, MouseButton _id)

void	_riseMouseButtonReleased (int _left, int _top, MouseButton _id)

void	_riseMouseButtonClick ()

void	_riseMouseButtonDoubleClick ()

void	_riseKeyLostFocus (Widget *_new)

void	_riseKeySetFocus (Widget *_old)

void	_riseKeyButtonPressed (KeyCode _key, Char _char)

void	_riseKeyButtonReleased (KeyCode _key)

void	_riseMouseChangeRootFocus (bool _focus)

void	_riseKeyChangeRootFocus (bool _focus)

void	_setRootMouseFocus (bool _value)

void	_setRootKeyFocus (bool _value)

Public Member Functions inherited from MyGUI::delegates::IDelegateUnlink
virtual	~IDelegateUnlink ()=default

	IDelegateUnlink ()

bool	compare (IDelegateUnlink *_unlink) const

Public Member Functions inherited from MyGUI::SkinItem
	SkinItem ()

ISubWidgetText *	getSubWidgetText () const

ISubWidgetRect *	getSubWidgetMain () const

void	_setTextureName (const std::string &_texture)

const std::string &	_getTextureName () const

Public Member Functions inherited from MyGUI::LayerItem
	LayerItem ()

ILayer *	getLayer () const

ILayerNode *	getLayerNode () const

void	attachItemToNode (ILayer _layer, ILayerNode _node) override

void	detachFromLayer () override

void	upLayerItem () override

void	setRenderItemTexture (ITexture *_texture)

void	addChildItem (LayerItem *_item)

void	removeChildItem (LayerItem *_item)

void	addChildNode (LayerItem *_item)

void	removeChildNode (LayerItem *_item)

void	addRenderItem (ISubWidget *_item)

void	removeAllRenderItems ()

void	saveLayerItem ()

void	restoreLayerItem ()

Public Member Functions inherited from MyGUI::ILayerItem
virtual	~ILayerItem ()

Public Member Functions inherited from MyGUI::MemberObsolete< Widget >
bool	isEnabled ()

bool	isInheritsAlpha ()

bool	isNeedKeyFocus ()

bool	isNeedMouseFocus ()

bool	isInheritsPick ()

bool	isVisible ()

Public Member Functions inherited from MyGUI::IItemContainer
virtual	~IItemContainer ()

Public Member Functions inherited from MyGUI::MemberObsolete< MenuControl >
void	showMenu ()

void	hideMenu ()

bool	isShowMenu ()

void	showItemChildAt (size_t _index)

void	showItemChild (MenuItem *_item)

void	hideItemChildAt (size_t _index)

void	hideItemChild (MenuItem *_item)

void	setAlignVert (bool _value)

bool	getAlignVert () const

Static Public Member Functions
static const std::string &	getClassTypeName ()

Static Public Member Functions inherited from MyGUI::Widget
static const std::string &	getClassTypeName ()

Static Public Member Functions inherited from MyGUI::IObject
static const std::string &	getClassTypeName ()

Data Fields
EventHandle_MenuCtrlPtrMenuItemPtr	eventMenuCtrlAccept

EventHandle_MenuCtrlPtr	eventMenuCtrlClose

Data Fields inherited from MyGUI::Widget
EventHandle_WidgetStringString	eventChangeProperty

EventHandle_WidgetVoid	eventChangeCoord

EventHandle_WidgetVoid	eventWidgetDestroyed

Data Fields inherited from MyGUI::WidgetInput
EventHandle_WidgetWidget	eventMouseLostFocus

EventHandle_WidgetWidget	eventMouseSetFocus

EventPairAddParameter< EventHandle_WidgetIntInt, EventHandle_WidgetIntIntButton >	eventMouseDrag

EventHandle_WidgetIntInt	eventMouseMove

EventHandle_WidgetInt	eventMouseWheel

EventHandle_WidgetIntIntButton	eventMouseButtonPressed

EventHandle_WidgetIntIntButton	eventMouseButtonReleased

EventHandle_WidgetVoid	eventMouseButtonClick

EventHandle_WidgetVoid	eventMouseButtonDoubleClick

EventHandle_WidgetWidget	eventKeyLostFocus

EventHandle_WidgetWidget	eventKeySetFocus

EventHandle_WidgetKeyCodeChar	eventKeyButtonPressed

EventHandle_WidgetKeyCode	eventKeyButtonReleased

EventHandle_WidgetBool	eventRootMouseChangeFocus

EventHandle_WidgetBool	eventRootKeyChangeFocus

EventHandle_WidgetToolTip	eventToolTip

Protected Member Functions
void	initialiseOverride () override

void	shutdownOverride () override

void	onKeyChangeRootFocus (bool _focus) override

void	onWidgetCreated (Widget *_widget) override

void	setPropertyOverride (const std::string &_key, const std::string &_value) override

Protected Member Functions inherited from MyGUI::Widget
	~Widget () override=default

void	_updateView ()

Widget *	baseCreateWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer, const std::string &_name, bool _template)

void	_destroyAllChildWidget ()

virtual size_t	_getContainerIndex (const IntPoint &_point) const

virtual void	baseUpdateEnable ()

ILayerItem *	getLayerItemByPoint (int _left, int _top) const override

const IntCoord &	getLayerItemCoord () const override

template<typename T >
void	assignWidget (T *&_widget, const std::string &_name)

VectorWidgetPtr	getSkinWidgetsByName (const std::string &_name) const

virtual void	onWidgetDestroy (Widget *_widget)

void	setWidgetClient (Widget *_widget)

Widget *	_getClientWidget ()
	If there is client widget return it, otherwise return this.

const Widget *	_getClientWidget () const

Protected Member Functions inherited from MyGUI::ICroppedRectangle
bool	_checkMargin ()

bool	_checkOutside () const

Protected Member Functions inherited from MyGUI::WidgetInput
virtual void	onMouseLostFocus (Widget *_new)

virtual void	onMouseSetFocus (Widget *_old)

virtual void	onMouseDrag (int _left, int _top, MouseButton _id)

virtual void	onMouseMove (int _left, int _top)

virtual void	onMouseWheel (int _rel)

virtual void	onMouseButtonPressed (int _left, int _top, MouseButton _id)

virtual void	onMouseButtonReleased (int _left, int _top, MouseButton _id)

virtual void	onMouseButtonClick ()

virtual void	onMouseButtonDoubleClick ()

virtual void	onKeyLostFocus (Widget *_new)

virtual void	onKeySetFocus (Widget *_old)

virtual void	onKeyButtonPressed (KeyCode _key, Char _char)

virtual void	onKeyButtonReleased (KeyCode _key)

virtual void	onMouseChangeRootFocus (bool _focus)

Protected Member Functions inherited from MyGUI::SkinItem
void	_createSkinItem (ResourceSkin *_info)

void	_deleteSkinItem ()

void	_setSkinItemAlign (const IntSize &_size)

void	_setSkinItemVisible (bool _value)

void	_setSkinItemColour (const Colour &_value)

void	_setSkinItemAlpha (float _value)

void	_correctSkinItemView ()

void	_updateSkinItemView ()

bool	_setSkinItemState (const std::string &_state)

void	_setSubSkinVisible (bool _visible)

Protected Member Functions inherited from MyGUI::LayerItem
void	attachToLayerItemNode (ILayerNode *_node, bool _deep)

void	detachFromLayerItemNode (bool _deep)

Protected Attributes
bool	mHideByAccept

bool	mMenuDropMode

bool	mIsMenuDrop

bool	mHideByLostKey

bool	mResizeToContent

Protected Attributes inherited from MyGUI::ICroppedRectangle
IntRect	mMargin

IntCoord	mCoord

IntPoint	mAbsolutePosition

bool	mIsMargin

ICroppedRectangle *	mCroppedParent

Detailed Description

widget description should be here.

Definition at line 30 of file MyGUI_MenuControl.h.

Member Typedef Documentation

◆ Base

typedef RTTIBase MyGUI::MenuControl::Base

Definition at line 35 of file MyGUI_MenuControl.h.

◆ RTTIBase

typedef MenuControl MyGUI::MenuControl::RTTIBase

Definition at line 35 of file MyGUI_MenuControl.h.

◆ VectorMenuItemInfo

typedef std::vector<ItemInfo> MyGUI::MenuControl::VectorMenuItemInfo

Definition at line 69 of file MyGUI_MenuControl.h.

Constructor & Destructor Documentation

◆ MenuControl()

MyGUI::MenuControl::MenuControl ( )

Definition at line 25 of file MyGUI_MenuControl.cpp.

Member Function Documentation

◆ _addItem()

void MyGUI::MenuControl::_addItem ( const MyGUI::UString & _name )

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 805 of file MyGUI_MenuControl.cpp.

◆ _getItemAt()

Widget * MyGUI::MenuControl::_getItemAt ( size_t _index ) const

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 817 of file MyGUI_MenuControl.cpp.

◆ _getItemCount()

size_t MyGUI::MenuControl::_getItemCount ( ) const

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 800 of file MyGUI_MenuControl.cpp.

◆ _getItemNameAt()

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

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 827 of file MyGUI_MenuControl.cpp.

◆ _notifyDeleteItem()

void MyGUI::MenuControl::_notifyDeleteItem ( MenuItem * _item )

Definition at line 250 of file MyGUI_MenuControl.cpp.

◆ _notifyDeletePopup()

void MyGUI::MenuControl::_notifyDeletePopup ( MenuItem * _item )

Definition at line 265 of file MyGUI_MenuControl.cpp.

◆ _notifyUpdateName()

void MyGUI::MenuControl::_notifyUpdateName ( MenuItem * _item )

Definition at line 271 of file MyGUI_MenuControl.cpp.

◆ _removeItemAt()

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

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 810 of file MyGUI_MenuControl.cpp.

◆ _setItemNameAt()

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

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 822 of file MyGUI_MenuControl.cpp.

◆ _setItemSelected()

void MyGUI::MenuControl::_setItemSelected ( IItem * _item )

overridevirtual

Reimplemented from MyGUI::IItemContainer.

Definition at line 832 of file MyGUI_MenuControl.cpp.

◆ _updateItems()

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

Definition at line 857 of file MyGUI_MenuControl.cpp.

◆ _updateSizeForEmpty()

void MyGUI::MenuControl::_updateSizeForEmpty ( )

Definition at line 863 of file MyGUI_MenuControl.cpp.

◆ _wrapItemChild()

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

Definition at line 485 of file MyGUI_MenuControl.cpp.

◆ addItem()

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 592 of file MyGUI_MenuControl.cpp.

◆ clearItemData()

void MyGUI::MenuControl::clearItemData ( MenuItem * _item )

Clear an item data.

Definition at line 700 of file MyGUI_MenuControl.cpp.

◆ clearItemDataAt()

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

Clear an item data at a specified position.

Definition at line 695 of file MyGUI_MenuControl.cpp.

◆ createItemChild()

MenuControl * MyGUI::MenuControl::createItemChild ( MenuItem * _item )

Create child item (submenu) for item

Definition at line 740 of file MyGUI_MenuControl.cpp.

◆ createItemChildAt()

MenuControl * MyGUI::MenuControl::createItemChildAt ( size_t _index )

Create child item (submenu) for item by index

Definition at line 735 of file MyGUI_MenuControl.cpp.

◆ createItemChildT()

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.

◆ createItemChildTAt()

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.

◆ findItemById()

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

Find item by id

Definition at line 648 of file MyGUI_MenuControl.cpp.

◆ findItemIndex()

size_t MyGUI::MenuControl::findItemIndex ( MenuItem * _item )

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

Definition at line 675 of file MyGUI_MenuControl.cpp.

◆ findItemIndexWith()

size_t MyGUI::MenuControl::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 665 of file MyGUI_MenuControl.cpp.

◆ findItemWith()

MenuItem * MyGUI::MenuControl::findItemWith ( const UString & _name )

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

Definition at line 618 of file MyGUI_MenuControl.cpp.

◆ getClassTypeName()

static const std::string & MyGUI::MenuControl::getClassTypeName ( )

inlinestatic

Definition at line 35 of file MyGUI_MenuControl.h.

◆ getItemAt()

MenuItem * MyGUI::MenuControl::getItemAt ( size_t _index ) const

Get item from specified position.

Definition at line 602 of file MyGUI_MenuControl.cpp.

◆ getItemById()

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

Get item by id

Definition at line 628 of file MyGUI_MenuControl.cpp.

◆ getItemChild()

MenuControl * MyGUI::MenuControl::getItemChild ( const MenuItem * _item ) const

Get child item (submenu) from item

Definition at line 730 of file MyGUI_MenuControl.cpp.

◆ getItemChildAt()

MenuControl * MyGUI::MenuControl::getItemChildAt ( size_t _index ) const

Get child item (submenu) from item by index

Definition at line 208 of file MyGUI_MenuControl.cpp.

◆ getItemCount()

size_t MyGUI::MenuControl::getItemCount ( ) const

Get number of items.

Definition at line 685 of file MyGUI_MenuControl.cpp.

◆ getItemData()

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.

◆ getItemDataAt()

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.

◆ getItemId()

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

Get item id.

Definition at line 710 of file MyGUI_MenuControl.cpp.

◆ getItemIdAt()

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

Get item id from specified position.

Definition at line 244 of file MyGUI_MenuControl.cpp.

◆ getItemIndex()

size_t MyGUI::MenuControl::getItemIndex ( const MenuItem * _item ) const

Get item index.

Definition at line 608 of file MyGUI_MenuControl.cpp.

◆ getItemIndexById()

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

Get item index by id

Definition at line 638 of file MyGUI_MenuControl.cpp.

◆ getItemName()

const UString & MyGUI::MenuControl::getItemName ( const MenuItem * _item ) const

Get item from specified position.

Definition at line 720 of file MyGUI_MenuControl.cpp.

◆ getItemNameAt()

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

Get item from specified position.

Definition at line 153 of file MyGUI_MenuControl.cpp.

◆ getItemType()

MenuItemType MyGUI::MenuControl::getItemType ( const MenuItem * _item ) const

Get item type (see MenuItemType) from item

Definition at line 750 of file MyGUI_MenuControl.cpp.

◆ getItemTypeAt()

MenuItemType MyGUI::MenuControl::getItemTypeAt ( size_t _index ) const

Get item type (see MenuItemType) from item by index

Definition at line 281 of file MyGUI_MenuControl.cpp.

◆ getMenuItemParent()

MenuItem * MyGUI::MenuControl::getMenuItemParent ( ) const

Get parent menu item or nullptr if no item

Definition at line 770 of file MyGUI_MenuControl.cpp.

◆ getPopupAccept()

bool MyGUI::MenuControl::getPopupAccept ( ) const

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

Definition at line 765 of file MyGUI_MenuControl.cpp.

◆ getTypeName()

virtual const std::string & MyGUI::MenuControl::getTypeName ( ) const

inlineoverridevirtual

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.

◆ getVerticalAlignment()

bool MyGUI::MenuControl::getVerticalAlignment ( ) const

Get vertical alignment mode flag

Definition at line 876 of file MyGUI_MenuControl.cpp.

◆ initialiseOverride()

void MyGUI::MenuControl::initialiseOverride ( )

overrideprotectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 42 of file MyGUI_MenuControl.cpp.

◆ insertItem()

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 587 of file MyGUI_MenuControl.cpp.

◆ insertItemAt()

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 115 of file MyGUI_MenuControl.cpp.

◆ isType() [1/2]

template<typename Type >

bool MyGUI::MenuControl::isType ( ) const

inline

Compare with selected type

Definition at line 35 of file MyGUI_MenuControl.h.

◆ isType() [2/2]

virtual bool MyGUI::MenuControl::isType ( const std::type_info & _type ) const

inlineoverridevirtual

Compare with selected type

Reimplemented from MyGUI::Widget.

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

Definition at line 35 of file MyGUI_MenuControl.h.

◆ onKeyChangeRootFocus()

void MyGUI::MenuControl::onKeyChangeRootFocus ( bool _focus )

overrideprotectedvirtual

Reimplemented from MyGUI::WidgetInput.

Definition at line 466 of file MyGUI_MenuControl.cpp.

◆ onWidgetCreated()

void MyGUI::MenuControl::onWidgetCreated ( Widget * _widget )

overrideprotectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 104 of file MyGUI_MenuControl.cpp.

◆ removeAllItems()

void MyGUI::MenuControl::removeAllItems ( )

Remove all items.

Definition at line 140 of file MyGUI_MenuControl.cpp.

◆ removeItem()

void MyGUI::MenuControl::removeItem ( MenuItem * _item )

Remove item.

Definition at line 597 of file MyGUI_MenuControl.cpp.

◆ removeItemAt()

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

Remove item at a specified position.

Definition at line 128 of file MyGUI_MenuControl.cpp.

◆ removeItemChild()

void MyGUI::MenuControl::removeItemChild ( MenuItem * _item )

Remove child item (submenu) for item

Definition at line 745 of file MyGUI_MenuControl.cpp.

◆ removeItemChildAt()

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

Remove child item (submenu) for item by index

Definition at line 214 of file MyGUI_MenuControl.cpp.

◆ setItemChildVisible()

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

Show or hide item (submenu)

Definition at line 725 of file MyGUI_MenuControl.cpp.

◆ setItemChildVisibleAt()

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

Show or hide item (submenu) at a specified position

Definition at line 332 of file MyGUI_MenuControl.cpp.

◆ setItemData()

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

Replace an item data.

Definition at line 690 of file MyGUI_MenuControl.cpp.

◆ setItemDataAt()

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

Replace an item data at a specified position.

Definition at line 202 of file MyGUI_MenuControl.cpp.

◆ setItemId()

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

Replace an item id.

Definition at line 705 of file MyGUI_MenuControl.cpp.

◆ setItemIdAt()

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

Replace an item id at a specified position.

Definition at line 238 of file MyGUI_MenuControl.cpp.

◆ setItemName()

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

Replace an item name.

Definition at line 715 of file MyGUI_MenuControl.cpp.

◆ setItemNameAt()

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

Replace an item name at a specified position.

Definition at line 227 of file MyGUI_MenuControl.cpp.

◆ setItemType()

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

Set item type (see MenuItemType) from item

Definition at line 755 of file MyGUI_MenuControl.cpp.

◆ setItemTypeAt()

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

Set item type (see MenuItemType) from item by index

Definition at line 287 of file MyGUI_MenuControl.cpp.

◆ setPopupAccept()

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

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

Definition at line 760 of file MyGUI_MenuControl.cpp.

◆ setPropertyOverride()

void MyGUI::MenuControl::setPropertyOverride	(	const std::string &	_key,
		const std::string &	_value
	)

overrideprotectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 881 of file MyGUI_MenuControl.cpp.

◆ setVerticalAlignment()

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

Set vertical alignment mode

Definition at line 869 of file MyGUI_MenuControl.cpp.

◆ setVisible()

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

overridevirtual

Hide or show widget

Reimplemented from MyGUI::Widget.

Definition at line 526 of file MyGUI_MenuControl.cpp.

◆ setVisibleSmooth()

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

Hide or show Menu smooth

Definition at line 547 of file MyGUI_MenuControl.cpp.

◆ shutdownOverride()

void MyGUI::MenuControl::shutdownOverride ( )

overrideprotectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 94 of file MyGUI_MenuControl.cpp.

Field Documentation

◆ eventMenuCtrlAccept

EventHandle_MenuCtrlPtrMenuItemPtr MyGUI::MenuControl::eventMenuCtrlAccept

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

Parameters

_sender	widget that called this event
_item	Selected item

Definition at line 246 of file MyGUI_MenuControl.h.

◆ eventMenuCtrlClose

EventHandle_MenuCtrlPtr MyGUI::MenuControl::eventMenuCtrlClose

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

Parameters

_sender widget that called this event

Definition at line 252 of file MyGUI_MenuControl.h.

◆ mHideByAccept

bool MyGUI::MenuControl::mHideByAccept

protected

Definition at line 306 of file MyGUI_MenuControl.h.

◆ mHideByLostKey

bool MyGUI::MenuControl::mHideByLostKey

protected

Definition at line 310 of file MyGUI_MenuControl.h.

◆ mIsMenuDrop

bool MyGUI::MenuControl::mIsMenuDrop

protected

Definition at line 309 of file MyGUI_MenuControl.h.

◆ mMenuDropMode

bool MyGUI::MenuControl::mMenuDropMode

protected

Definition at line 308 of file MyGUI_MenuControl.h.

◆ mResizeToContent

bool MyGUI::MenuControl::mResizeToContent

protected

Definition at line 311 of file MyGUI_MenuControl.h.

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

Data Structures

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Base

◆ RTTIBase

◆ VectorMenuItemInfo

Constructor & Destructor Documentation

◆ MenuControl()

Member Function Documentation

◆ _addItem()

◆ _getItemAt()

◆ _getItemCount()

◆ _getItemNameAt()

◆ _notifyDeleteItem()

◆ _notifyDeletePopup()

◆ _notifyUpdateName()

◆ _removeItemAt()

◆ _setItemNameAt()

◆ _setItemSelected()

◆ _updateItems()

◆ _updateSizeForEmpty()

◆ _wrapItemChild()

◆ addItem()

◆ clearItemData()

◆ clearItemDataAt()

◆ createItemChild()

◆ createItemChildAt()

◆ createItemChildT()

◆ createItemChildTAt()

◆ findItemById()

◆ findItemIndex()

◆ findItemIndexWith()

◆ findItemWith()

◆ getClassTypeName()

◆ getItemAt()

◆ getItemById()

◆ getItemChild()

◆ getItemChildAt()

◆ getItemCount()

◆ getItemData()

◆ getItemDataAt()

◆ getItemId()

◆ getItemIdAt()

◆ getItemIndex()

◆ getItemIndexById()

◆ getItemName()

◆ getItemNameAt()

◆ getItemType()

◆ getItemTypeAt()

◆ getMenuItemParent()

◆ getPopupAccept()

◆ getTypeName()

◆ getVerticalAlignment()

◆ initialiseOverride()

◆ insertItem()

◆ insertItemAt()

◆ isType() [1/2]

◆ isType() [2/2]

◆ onKeyChangeRootFocus()

◆ onWidgetCreated()

◆ removeAllItems()

◆ removeItem()

◆ removeItemAt()

◆ removeItemChild()

◆ removeItemChildAt()

◆ setItemChildVisible()

◆ setItemChildVisibleAt()

◆ setItemData()

◆ setItemDataAt()

◆ setItemId()

◆ setItemIdAt()

◆ setItemName()

◆ setItemNameAt()

◆ setItemType()