MyGUI::MenuItem Class Reference

#include <MyGUI_MenuItem.h>

Inheritance diagram for MyGUI::MenuItem:

[legend]

Public Member Functions
	MenuItem ()
virtual void	setCaption (const UString &_value)
void	setItemName (const UString &_value)
	Replace an item name.
const UString &	getItemName ()
	Get item name.
void	setItemData (Any _value)
	Replace an item name.
template<typename ValueType >
ValueType *	getItemData (bool _throw=true)
	Get item data.
void	removeItem ()
	Remove item.
void	setItemId (const std::string &_value)
	Replace an item id at a specified position.
const std::string &	getItemId ()
	Get item id from specified position.
size_t	getItemIndex ()
	Get item index.
MenuCtrlPtr	createItemChild ()
template<typename Type >
Type *	createItemChildT ()
void	setItemType (MenuItemType _value)
MenuItemType	getItemType ()
void	setItemChildVisible (bool _value)
MenuCtrlPtr	getMenuCtrlParent ()
MenuCtrlPtr	getItemChild ()
virtual void	setProperty (const std::string &_key, const std::string &_value)
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 setItemChildVisible(bool _visible)")) void showItemChild()
	__declspec (deprecated("use : void setItemChildVisible(bool _visible)")) void hideItemChild()
Protected Member Functions
virtual	~MenuItem ()
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	baseChangeWidgetSkin (ResourceSkin *_info)
void	initialiseWidgetSkin (ResourceSkin *_info)
void	shutdownWidgetSkin ()

---

Detailed Description

Definition at line 33 of file MyGUI_MenuItem.h.

---

Constructor & Destructor Documentation

MyGUI::MenuItem::MenuItem

(

)

Definition at line 31 of file MyGUI_MenuItem.cpp.

MyGUI::MenuItem::~MenuItem

(

)

[protected, virtual]

Definition at line 57 of file MyGUI_MenuItem.cpp.

---

Member Function Documentation

MyGUI::MenuItem::__declspec

(

deprecated("use : void setItemChildVisible(bool _visible)")

)

[inline]

Deprecated:

"use : void setItemChildVisible(bool _visible)"

Definition at line 106 of file MyGUI_MenuItem.h.

MyGUI::MenuItem::__declspec

(

deprecated("use : void setItemChildVisible(bool _visible)")

)

[inline]

Deprecated:

"use : void setItemChildVisible(bool _visible)"

Definition at line 104 of file MyGUI_MenuItem.h.

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

Reimplemented from MyGUI::Button.

Definition at line 35 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::baseChangeWidgetSkin

(

ResourceSkin *

_info

)

[protected, virtual]

Reimplemented from MyGUI::Button.

Definition at line 71 of file MyGUI_MenuItem.cpp.

WidgetPtr MyGUI::MenuItem::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 63 of file MyGUI_MenuItem.cpp.

MenuCtrlPtr MyGUI::MenuItem::createItemChild

(

)

Create child item (submenu), MenuItem can have only one child

Definition at line 137 of file MyGUI_MenuItem.cpp.

template<typename Type >

Type* MyGUI::MenuItem::createItemChildT

(

)

[inline]

Create specific type child item (submenu), MenuItem can have only one child

Definition at line 75 of file MyGUI_MenuItem.h.

MenuCtrlPtr MyGUI::MenuItem::getItemChild

(

)

Get child item (submenu)

Definition at line 157 of file MyGUI_MenuItem.cpp.

template<typename ValueType >

ValueType* MyGUI::MenuItem::getItemData

(

bool

_throw = true

)

[inline]

Get item data.

Definition at line 54 of file MyGUI_MenuItem.h.

const std::string & MyGUI::MenuItem::getItemId

(

)

Get item id from specified position.

Definition at line 127 of file MyGUI_MenuItem.cpp.

size_t MyGUI::MenuItem::getItemIndex

(

)

Get item index.

Definition at line 132 of file MyGUI_MenuItem.cpp.

const UString & MyGUI::MenuItem::getItemName

(

)

Get item name.

Definition at line 102 of file MyGUI_MenuItem.cpp.

MenuItemType MyGUI::MenuItem::getItemType

(

)

Get item type (see MenuItemType)

Definition at line 147 of file MyGUI_MenuItem.cpp.

MenuCtrlPtr MyGUI::MenuItem::getMenuCtrlParent

(

)

[inline]

Get parent MenuCtrl

Definition at line 89 of file MyGUI_MenuItem.h.

void MyGUI::MenuItem::initialiseWidgetSkin

(

ResourceSkin *

_info

)

[protected]

Reimplemented from MyGUI::Button.

Definition at line 78 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::removeItem

(

)

Remove item.

Definition at line 117 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setCaption

(

const UString &

_value

)

[virtual]

Set widget caption

Reimplemented from MyGUI::Widget.

Definition at line 96 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setItemChildVisible

(

bool

_value

)

Hide or show child item (submenu)

Definition at line 152 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setItemData

(

Any

_value

)

Replace an item name.

Definition at line 112 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setItemId

(

const std::string &

_value

)

Replace an item id at a specified position.

Definition at line 122 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setItemName

(

const UString &

_value

)

Replace an item name.

Definition at line 107 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setItemType

(

MenuItemType

_value

)

Set item type (see MenuItemType)

Definition at line 142 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setProperty	(	const std::string &	_key,
		const std::string &	_value
	)			[virtual]

Reimplemented from MyGUI::Button.

Definition at line 162 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::shutdownWidgetSkin

(

)

[protected]

Reimplemented from MyGUI::Button.

Definition at line 82 of file MyGUI_MenuItem.cpp.

---

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

• MyGUI_MenuItem.h
• MyGUI_MenuItem.cpp