MyGUI::MenuItem Class Reference

#include <MyGUI_MenuItem.h>

Inheritance diagram for MyGUI::MenuItem:

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.
MenuCtrl *	createItemChild ()
template<typename Type >
Type *	createItemChildT ()
void	setItemType (MenuItemType _value)
MenuItemType	getItemType ()
void	setItemChildVisible (bool _value)
MenuCtrl *	getMenuCtrlParent ()
MenuCtrl *	getItemChild ()
virtual void	setProperty (const std::string &_key, const std::string &_value)
virtual void	_initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin _info, Widget _parent, ICroppedRectangle _croppedParent, IWidgetCreator _creator, const std::string &_name)
void	showItemChild ()
void	hideItemChild ()
Protected Member Functions
virtual	~MenuItem ()
virtual 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)
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 58 of file MyGUI_MenuItem.cpp.

Member Function Documentation

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

Reimplemented from MyGUI::Button.

Definition at line 36 of file MyGUI_MenuItem.cpp.

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

Reimplemented from MyGUI::Button.

Definition at line 72 of file MyGUI_MenuItem.cpp.

Widget * 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 64 of file MyGUI_MenuItem.cpp.

MenuCtrl * MyGUI::MenuItem::createItemChild ( )

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

Definition at line 138 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.

MenuCtrl * MyGUI::MenuItem::getItemChild ( )

Get child item (submenu)

Definition at line 158 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 128 of file MyGUI_MenuItem.cpp.

size_t MyGUI::MenuItem::getItemIndex ( )

Get item index.

Definition at line 133 of file MyGUI_MenuItem.cpp.

const UString & MyGUI::MenuItem::getItemName ( )

Get item name.

Definition at line 103 of file MyGUI_MenuItem.cpp.

MenuItemType MyGUI::MenuItem::getItemType ( )

Get item type (see MenuItemType)

Definition at line 148 of file MyGUI_MenuItem.cpp.

MenuCtrl* MyGUI::MenuItem::getMenuCtrlParent ( ) [inline]

Get parent MenuCtrl

Definition at line 89 of file MyGUI_MenuItem.h.

void MyGUI::MenuItem::hideItemChild ( ) [inline]

Definition at line 107 of file MyGUI_MenuItem.h.

void MyGUI::MenuItem::initialiseWidgetSkin ( ResourceSkin * _info ) [protected]

Reimplemented from MyGUI::Button.

Definition at line 79 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::removeItem ( )

Remove item.

Definition at line 118 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setCaption ( const UString & _value ) [virtual]

Set widget caption

Reimplemented from MyGUI::Widget.

Definition at line 97 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setItemChildVisible ( bool _value )

Hide or show child item (submenu)

Definition at line 153 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setItemData ( Any _value )

Replace an item name.

Definition at line 113 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setItemId ( const std::string & _value )

Replace an item id at a specified position.

Definition at line 123 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setItemName ( const UString & _value )

Replace an item name.

Definition at line 108 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setItemType ( MenuItemType _value )

Set item type (see MenuItemType)

Definition at line 143 of file MyGUI_MenuItem.cpp.

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

Set any widget property

Parameters:

	_key	Property name (for example Widget_Alpha or Edit_MultiLine)
	_value	Value converted to string

Reimplemented from MyGUI::Button.

Definition at line 163 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::showItemChild ( ) [inline]

Definition at line 105 of file MyGUI_MenuItem.h.

void MyGUI::MenuItem::shutdownWidgetSkin ( ) [protected]

Reimplemented from MyGUI::Button.

Definition at line 83 of file MyGUI_MenuItem.cpp.

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

MyGUI::MenuItem Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation