MyGUI  3.2.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
MyGUI::MenuItem Class Reference

#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::TextBox
typedef RTTIBase Base
typedef TextBox RTTIBase
- 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
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 UStringgetItemName ()
 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.
MenuControlcreateItemChild ()
template<typename Type >
Type * createItemChildT ()
void setItemType (MenuItemType _value)
MenuItemType getItemType ()
void setItemChildVisible (bool _value)
MenuControlgetMenuCtrlParent ()
MenuControlgetItemChild ()
bool getItemChecked () const
void setItemChecked (bool _value)
virtual IItemContainer_getItemContainer ()
IntSize _getContentSize ()
- Public Member Functions inherited from MyGUI::Button
 Button ()
void setStateSelected (bool _value)
 Set button selected state.
bool getStateSelected () const
 Get buton selected.
void setModeImage (bool _value)
bool getModeImage () const
void setImageResource (const std::string &_name)
void setImageGroup (const std::string &_name)
void setImageName (const std::string &_name)
void _setMouseFocus (bool _focus)
ImageBox_getImageBox ()
- Public Member Functions inherited from MyGUI::TextBox
 TextBox ()
virtual IntCoord getTextRegion ()
virtual IntSize getTextSize ()
virtual const UStringgetCaption ()
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 ColourgetTextColour ()
void setCaptionWithReplacing (const std::string &_value)
virtual void setTextShadowColour (const Colour &_value)
const ColourgetTextShadowColour ()
virtual void setTextShadow (bool _value)
bool getTextShadow ()
- Public Member Functions inherited from MyGUI::Widget
 Widget ()
WidgetcreateWidgetT (const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")
WidgetcreateWidgetT (const std::string &_type, const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")
WidgetcreateWidgetRealT (const std::string &_type, const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")
WidgetcreateWidgetRealT (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="")
WidgetcreateWidgetT (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="")
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)
const std::string & getName () const
 Get name of widget.
virtual void setVisible (bool _value)
bool getVisible () 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
WidgetgetParent () const
IntSize getParentSize () const
EnumeratorWidgetPtr getEnumerator () const
size_t getChildCount ()
WidgetgetChildAt (size_t _index)
WidgetfindWidget (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 ()
WidgetgetClientWidget ()
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)
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 ()
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)
- Public Member Functions inherited from MyGUI::IObject
template<typename Type >
Type * castType (bool _throw=true)
template<typename Type >
const Type * castType (bool _throw=true) const
 IObject ()
virtual ~IObject ()
- Public Member Functions inherited from MyGUI::ICroppedRectangle
 ICroppedRectangle ()
virtual ~ICroppedRectangle ()
ICroppedRectanglegetCroppedParent ()
IntPoint getPosition () const
IntSize getSize () const
const IntCoordgetCoord () const
const IntPointgetAbsolutePosition () 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
 UserData ()
virtual ~UserData ()
void setUserString (const std::string &_key, const std::string &_value)
const std::string & getUserString (const std::string &_key) const
const MapStringgetUserStrings () 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)
void _setInternalData (Any _data)
template<typename ValueType >
ValueType * _getInternalData (bool _throw=true)
- Public Member Functions inherited from MyGUI::WidgetInput
 WidgetInput ()
virtual ~WidgetInput ()
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::SkinItem
 SkinItem ()
ISubWidgetTextgetSubWidgetText ()
ISubWidgetRectgetSubWidgetMain ()
void _setTextureName (const std::string &_texture)
const std::string & _getTextureName () const
- Public Member Functions inherited from MyGUI::LayerItem
 LayerItem ()
virtual ~LayerItem ()
ILayergetLayer () const
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 ()
virtual void resizeLayerItemView (const IntSize &_oldView, const IntSize &_newView)=0
- 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::MemberObsolete< Button >
void setButtonPressed (bool _value)
bool getButtonPressed ()
void setStateCheck (bool _value)
bool getStateCheck ()
ImageBoxgetStaticImage ()
void setImageIndex (size_t _value)
size_t getImageIndex ()
- Public Member Functions inherited from MyGUI::IItem
 IItem ()
virtual ~IItem ()
- Public Member Functions inherited from MyGUI::MemberObsolete< MenuItem >
void showItemChild ()
void hideItemChild ()

Static Public Member Functions

static const std::string & getClassTypeName ()

Protected Member Functions

virtual void initialiseOverride ()
virtual void shutdownOverride ()
virtual void setPropertyOverride (const std::string &_key, const std::string &_value)
virtual void onWidgetCreated (Widget *_widget)
- Protected Member Functions inherited from MyGUI::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)

Additional Inherited Members

- Data Fields inherited from MyGUI::Widget
EventHandle_WidgetStringString eventChangeProperty
- Protected Attributes inherited from MyGUI::ICroppedRectangle
IntRect mMargin
IntCoord mCoord
IntPoint mAbsolutePosition
bool mIsMargin
ICroppedRectanglemCroppedParent

Detailed Description

Definition at line 33 of file MyGUI_MenuItem.h.

Member Typedef Documentation

Definition at line 38 of file MyGUI_MenuItem.h.

Definition at line 38 of file MyGUI_MenuItem.h.

Constructor & Destructor Documentation

MyGUI::MenuItem::MenuItem ( )

Definition at line 28 of file MyGUI_MenuItem.cpp.

Member Function Documentation

IntSize MyGUI::MenuItem::_getContentSize ( )

Definition at line 175 of file MyGUI_MenuItem.cpp.

IItemContainer * MyGUI::MenuItem::_getItemContainer ( )
virtual

Reimplemented from MyGUI::IItem.

Definition at line 170 of file MyGUI_MenuItem.cpp.

MenuControl * MyGUI::MenuItem::createItemChild ( )

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

Definition at line 124 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 77 of file MyGUI_MenuItem.h.

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

Reimplemented from MyGUI::Button.

Definition at line 38 of file MyGUI_MenuItem.h.

bool MyGUI::MenuItem::getItemChecked ( ) const

Definition at line 190 of file MyGUI_MenuItem.cpp.

MenuControl * MyGUI::MenuItem::getItemChild ( )

Get child item (submenu)

Definition at line 144 of file MyGUI_MenuItem.cpp.

template<typename ValueType >
ValueType* MyGUI::MenuItem::getItemData ( bool  _throw = true)
inline

Get item data.

Definition at line 56 of file MyGUI_MenuItem.h.

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

Get item id from specified position.

Definition at line 114 of file MyGUI_MenuItem.cpp.

size_t MyGUI::MenuItem::getItemIndex ( )

Get item index.

Definition at line 119 of file MyGUI_MenuItem.cpp.

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

Get item name.

Definition at line 89 of file MyGUI_MenuItem.cpp.

MenuItemType MyGUI::MenuItem::getItemType ( )

Get item type (see MenuItemType)

Definition at line 134 of file MyGUI_MenuItem.cpp.

MenuControl * MyGUI::MenuItem::getMenuCtrlParent ( )

Get parent MenuControl

Definition at line 165 of file MyGUI_MenuItem.cpp.

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

Get type name as string

Reimplemented from MyGUI::Button.

Definition at line 38 of file MyGUI_MenuItem.h.

void MyGUI::MenuItem::initialiseOverride ( )
protectedvirtual

Reimplemented from MyGUI::Button.

Definition at line 36 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 38 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 38 of file MyGUI_MenuItem.h.

void MyGUI::MenuItem::onWidgetCreated ( Widget _widget)
protectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 72 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::removeItem ( )

Remove item.

Definition at line 104 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setCaption ( const UString _value)
virtual

Set widget caption

Reimplemented from MyGUI::TextBox.

Definition at line 83 of file MyGUI_MenuItem.cpp.

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

Definition at line 195 of file MyGUI_MenuItem.cpp.

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

Hide or show child item (submenu)

Definition at line 139 of file MyGUI_MenuItem.cpp.

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

Replace an item name.

Definition at line 99 of file MyGUI_MenuItem.cpp.

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

Replace an item id at a specified position.

Definition at line 109 of file MyGUI_MenuItem.cpp.

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

Replace an item name.

Definition at line 94 of file MyGUI_MenuItem.cpp.

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

Set item type (see MenuItemType)

Definition at line 129 of file MyGUI_MenuItem.cpp.

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

Reimplemented from MyGUI::Button.

Definition at line 149 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::shutdownOverride ( )
protectedvirtual

Reimplemented from MyGUI::Button.

Definition at line 64 of file MyGUI_MenuItem.cpp.


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