#include <MyGUI_MenuItem.h>

Inheritance diagram for MyGUI::MenuItem:

Public Types
typedef RTTIBase	Base
typedef MenuItem	RTTIBase
Public Types inherited from MyGUI::Button
typedef RTTIBase	Base
typedef Button	RTTIBase
Public Types inherited from MyGUI::StaticText
typedef RTTIBase	Base
typedef StaticText	RTTIBase
Public Types inherited from MyGUI::Widget
typedef Widget	RTTIBase
Public Types inherited from MyGUI::IObject
typedef IObject	RTTIBase

Public Member Functions
virtual const std::string &	getTypeName () const
virtual bool	isType (const std::type_info &_type) const
template<typename Type >
bool	isType () const
	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 ()
Public Member Functions inherited from MyGUI::Button
	Button ()
void	setButtonPressed (bool _value)
	OLD Set button check state.
bool	getButtonPressed ()
	OLD Get buton check.
void	setStateCheck (bool _value)
	Set button check state.
bool	getStateCheck ()
	Get buton check.
void	setImageIndex (size_t _value)
	Set image index (image should be defined in skin)
size_t	getImageIndex ()
	Get image index.
void	setModeImage (bool _value)
bool	getModeImage ()
StaticImage *	getStaticImage ()
void	_setMouseFocus (bool _focus)
Public Member Functions inherited from MyGUI::StaticText
	StaticText ()
IntCoord	getTextRegion ()
IntSize	getTextSize ()
virtual void	setFontName (const std::string &_value)
const std::string &	getFontName ()
virtual void	setFontHeight (int _value)
int	getFontHeight ()
virtual void	setTextAlign (Align _value)
Align	getTextAlign ()
virtual void	setTextColour (const Colour &_value)
const Colour &	getTextColour ()
Public Member Functions inherited from MyGUI::Widget
template<typename Type >
Type *	castType (bool _throw=true)
template<typename Type >
const Type *	castType (bool _throw=true) 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="")
const std::string &	getName () const
	Get name of widget.
virtual void	setPosition (const IntPoint &_value)
virtual void	setSize (const IntSize &_value)
virtual void	setCoord (const IntCoord &_value)
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)
virtual void	setVisible (bool _value)
virtual void	setAlign (Align _value)
virtual const UString &	getCaption ()
void	setAlpha (float _value)
float	getAlpha ()
void	setInheritsAlpha (bool _value)
bool	isInheritsAlpha ()
bool	setState (const std::string &_value)
void	setColour (const Colour &_value)
bool	isRootWidget ()
Widget *	getParent ()
EnumeratorWidgetPtr	getEnumerator ()
size_t	getChildCount ()
Widget *	getChildAt (size_t _index)
Widget *	findWidget (const std::string &_name)
void	setNeedKeyFocus (bool _value)
bool	isNeedKeyFocus ()
void	setNeedMouseFocus (bool _value)
bool	isNeedMouseFocus ()
void	setInheritsPick (bool _value)
bool	isInheritsPick ()
void	setMaskPick (const std::string &_filename)
virtual void	setEnabled (bool _value)
void	setEnabledSilent (bool _value)
bool	isEnabled ()
void	setPointer (const std::string &_value)
const std::string &	getPointer ()
const std::string &	getLayerName ()
IntCoord	getClientCoord ()
Widget *	getClientWidget ()
ISubWidgetText *	getSubWidgetText ()
ISubWidgetRect *	getSubWidgetMain ()
void	setNeedToolTip (bool _value)
bool	getNeedToolTip ()
void	setEnableToolTip (bool _value)
bool	getEnableToolTip ()
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 ()
virtual void	_getContainer (Widget *&_container, size_t &_index)
void	_forcePeek (Widget *_widget)
void	_setUVSet (const FloatRect &_rect)
virtual void	_setTextureName (const std::string &_texture)
virtual const std::string &	_getTextureName ()
IWidgetCreator *	_getIWidgetCreator ()
IntCoord	_getTextRegion ()
IntSize	_getTextSize ()
void	_setFontName (const std::string &_font)
const std::string &	_getFontName ()
void	_setFontHeight (int _height)
int	_getFontHeight ()
void	_setTextAlign (Align _align)
Align	_getTextAlign ()
void	_setTextColour (const Colour &_colour)
const Colour &	_getTextColour ()
void	setCaptionWithNewLine (const std::string &_value)
void	setPosition (const IntCoord &_coord)
void	setPosition (int _left, int _top, int _width, int _height)
void	enableToolTip (bool _enable)
void	setInheritsPeek (bool _inherits)
bool	isInheritsPeek ()
void	setMaskPeek (const std::string &_filename)
IntCoord	getTextCoord ()
Public Member Functions inherited from MyGUI::IObject
virtual	~IObject ()
Public Member Functions inherited from MyGUI::ICroppedRectangle
	ICroppedRectangle ()
virtual	~ICroppedRectangle ()
ICroppedRectangle *	getCroppedParent ()
const IntCoord &	getCoord () const
IntPoint	getPosition () const
IntSize	getSize () const
bool	isVisible () const
const IntPoint &	getAbsolutePosition () const
IntRect	getAbsoluteRect () const
IntCoord	getAbsoluteCoord () const
int	getAbsoluteLeft () const
int	getAbsoluteTop () const
Align	getAlign () 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
virtual void	_correctView ()
void	_setCroppedParent (ICroppedRectangle *_parent)
const IntRect &	_getMargin () const
int	_getMarginLeft () const
int	_getMarginRight () const
int	_getMarginTop () const
int	_getMarginBottom () const
void	show ()
void	hide ()
bool	isShow ()
Public Member Functions inherited from MyGUI::LayerItem
	LayerItem ()
virtual	~LayerItem ()
ILayer *	getLayer ()
virtual void	attachItemToNode (ILayer _layer, ILayerNode _node)
virtual void	detachFromLayer ()
virtual void	upLayerItem ()
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::UserData
	UserData ()
virtual	~UserData ()
void	setUserString (const std::string &_key, const std::string &_value)
const std::string &	getUserString (const std::string &_key)
bool	clearUserString (const std::string &_key)
bool	isUserString (const std::string &_key)
void	clearUserStrings ()
void	setUserData (Any _data)
template<typename ValueType >
ValueType *	getUserData (bool _throw=true)
void	_setInternalData (Any _data)
template<typename ValueType >
ValueType *	_getInternalData (bool _throw=true)
void *	getUserData ()
Public Member Functions inherited from MyGUI::WidgetEvent
virtual	~WidgetEvent ()
Public Member Functions inherited from MyGUI::IWidgetCreator
virtual	~IWidgetCreator ()
virtual void	_linkChildWidget (Widget *_widget)
virtual void	_unlinkChildWidget (Widget *_widget)
Public Member Functions inherited from MyGUI::delegates::IDelegateUnlink
virtual	~IDelegateUnlink ()
	IDelegateUnlink ()
bool	compare (IDelegateUnlink *_unlink) const

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

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 ()
Protected Member Functions inherited from MyGUI::Button
virtual	~Button ()
virtual void	onMouseLostFocus (Widget *_new)
virtual void	onMouseSetFocus (Widget *_old)
virtual void	onMouseButtonPressed (int _left, int _top, MouseButton _id)
virtual void	onMouseButtonReleased (int _left, int _top, MouseButton _id)
virtual void	baseUpdateEnable ()
bool	_setState (const std::string &_value)
void	setImageResource (const std::string &_name)
Protected Member Functions inherited from MyGUI::StaticText
virtual	~StaticText ()
Protected Member Functions inherited from MyGUI::Widget
	Widget (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin _info, Widget _parent, ICroppedRectangle _croppedParent, IWidgetCreator _creator, const std::string &_name)
virtual	~Widget ()
void	_updateView ()
void	_setAlign (const IntSize &_oldsize, bool _update)
void	_setAlign (const IntCoord &_oldcoord, bool _update)
virtual void	_destroyChildWidget (Widget *_widget)
virtual void	_destroyAllChildWidget ()
virtual size_t	_getContainerIndex (const IntPoint &_point)
virtual void	_resetContainer (bool _update)
virtual ILayerItem *	getLayerItemByPoint (int _left, int _top)
virtual const IntCoord &	getLayerItemCoord ()
Protected Member Functions inherited from MyGUI::ICroppedRectangle
bool	_checkPoint (int _left, int _top)
bool	_checkMargin ()
bool	_checkOutside ()
Protected Member Functions inherited from MyGUI::LayerItem
void	attachToLayerItemNode (ILayerNode *_node, bool _deep)
void	detachFromLayerItemNode (bool _deep)
Protected Member Functions inherited from MyGUI::WidgetEvent
	WidgetEvent ()
virtual void	onMouseDrag (int _left, int _top)
virtual void	onMouseMove (int _left, int _top)
virtual void	onMouseWheel (int _rel)
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)
virtual void	onKeyChangeRootFocus (bool _focus)
Protected Member Functions inherited from MyGUI::IWidgetCreator
void	_deleteWidget (Widget *_widget)

Additional Inherited Members
Data Fields inherited from MyGUI::WidgetEvent
EventHandle_WidgetWidget	eventMouseLostFocus
EventHandle_WidgetWidget	eventMouseSetFocus
EventHandle_WidgetIntInt	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
EventHandle_WidgetStringString	eventActionInfo
EventHandle_WidgetRefWidgetRefSizeT	_requestGetContainer
EventHandle_WidgetStringString	eventChangeProperty
Protected Attributes inherited from MyGUI::Widget
MapWidgetStateInfo	mStateInfo
MaskPickInfo const *	mMaskPickInfo
MaskPickInfo	mOwnMaskPickInfo
VectorWidgetPtr	mWidgetChild
VectorWidgetPtr	mWidgetChildSkin
VectorSubWidget	mSubSkinChild
ISubWidgetText *	mText
ISubWidgetRect *	mMainSkin
bool	mEnabled
bool	mInheritsEnabled
bool	mSubSkinsVisible
bool	mInheritsVisible
float	mAlpha
float	mRealAlpha
bool	mInheritsAlpha
std::string	mName
std::string	mPointer
std::string	mTextureName
ITexture *	mTexture
Widget *	mParent
IWidgetCreator *	mIWidgetCreator
bool	mNeedKeyFocus
bool	mNeedMouseFocus
bool	mInheritsPick
Widget *	mWidgetClient
bool	mNeedToolTip
bool	mEnableToolTip
bool	mToolTipVisible
float	mToolTipCurrentTime
IntPoint	mToolTipOldPoint
size_t	mToolTipOldIndex
IntPoint	m_oldMousePoint
WidgetStyle	mWidgetStyle
FloatCoord	mRelativeCoord
bool	mDisableUpdateRelative

Detailed Description

Definition at line 33 of file MyGUI_MenuItem.h.

Member Typedef Documentation

typedef RTTIBase MyGUI::MenuItem::Base

Definition at line 36 of file MyGUI_MenuItem.h.

typedef MenuItem MyGUI::MenuItem::RTTIBase

Definition at line 36 of file MyGUI_MenuItem.h.

Constructor & Destructor Documentation

MyGUI::MenuItem::MenuItem ( )

Definition at line 31 of file MyGUI_MenuItem.cpp.

MyGUI::MenuItem::~MenuItem ( )

protectedvirtual

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 )

protectedvirtual

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
	)

protectedvirtual

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.

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

inlinestatic

Reimplemented from MyGUI::Button.

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

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

inlinevirtual

Get type name as string

Reimplemented from MyGUI::Button.

Definition at line 36 of file MyGUI_MenuItem.h.

void MyGUI::MenuItem::hideItemChild ( )

inline

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

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.

template<typename Type >

bool MyGUI::MenuItem::isType ( ) const

inline

Compare with selected type

Reimplemented from MyGUI::Button.

Definition at line 36 of file MyGUI_MenuItem.h.

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

inlinevirtual

Compare with selected type

Reimplemented from MyGUI::Button.

Definition at line 36 of file MyGUI_MenuItem.h.

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

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

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:

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation