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

MenuItem properties. Skin childs. MenuItem widget description should be here. More...

#include <MyGUI_MenuItem.h>

+ Inheritance diagram for MyGUI::MenuItem:

Public Types

typedef RTTIBase Base
typedef MenuItem 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)
virtual void setFontName (const std::string &_value)
virtual void setFontHeight (int _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 ()

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)

Detailed Description

MenuItem properties. Skin childs. MenuItem widget description should be here.

Definition at line 21 of file MyGUI_MenuItem.h.


Member Typedef Documentation

Reimplemented from MyGUI::Button.

Definition at line 26 of file MyGUI_MenuItem.h.

Reimplemented from MyGUI::Button.

Definition at line 26 of file MyGUI_MenuItem.h.


Constructor & Destructor Documentation

Definition at line 13 of file MyGUI_MenuItem.cpp.


Member Function Documentation

Definition at line 182 of file MyGUI_MenuItem.cpp.

Reimplemented from MyGUI::IItem.

Definition at line 177 of file MyGUI_MenuItem.cpp.

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 71 of file MyGUI_MenuItem.h.

static const std::string& MyGUI::MenuItem::getClassTypeName ( ) [inline, static]

Reimplemented from MyGUI::Button.

Definition at line 26 of file MyGUI_MenuItem.h.

Definition at line 197 of file MyGUI_MenuItem.cpp.

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 50 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.

Get item index.

Definition at line 119 of file MyGUI_MenuItem.cpp.

Get item name.

Definition at line 89 of file MyGUI_MenuItem.cpp.

Get item type (see MenuItemType)

Definition at line 134 of file MyGUI_MenuItem.cpp.

Get parent MenuControl

Definition at line 172 of file MyGUI_MenuItem.cpp.

virtual const std::string& MyGUI::MenuItem::getTypeName ( ) const [inline, virtual]

Get type name as string

Reimplemented from MyGUI::Button.

Definition at line 26 of file MyGUI_MenuItem.h.

void MyGUI::MenuItem::initialiseOverride ( ) [protected, virtual]

Reimplemented from MyGUI::Button.

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

virtual bool MyGUI::MenuItem::isType ( const std::type_info &  _type) const [inline, virtual]

Compare with selected type

Reimplemented from MyGUI::Button.

Definition at line 26 of file MyGUI_MenuItem.h.

void MyGUI::MenuItem::onWidgetCreated ( Widget _widget) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 58 of file MyGUI_MenuItem.cpp.

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 69 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setFontHeight ( int  _value) [virtual]

Set widget text font height

Reimplemented from MyGUI::TextBox.

Definition at line 82 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::setFontName ( const std::string &  _value) [virtual]

Set widget text font

Reimplemented from MyGUI::TextBox.

Definition at line 75 of file MyGUI_MenuItem.cpp.

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

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

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.

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 
) [protected, virtual]

Reimplemented from MyGUI::Button.

Definition at line 149 of file MyGUI_MenuItem.cpp.

void MyGUI::MenuItem::shutdownOverride ( ) [protected, virtual]

Reimplemented from MyGUI::Button.

Definition at line 50 of file MyGUI_MenuItem.cpp.


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