MyGUI  3.0.1
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 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.
MenuCtrlcreateItemChild ()
template<typename Type >
Type * createItemChildT ()
void setItemType (MenuItemType _value)
MenuItemType getItemType ()
void setItemChildVisible (bool _value)
MenuCtrlgetMenuCtrlParent ()
MenuCtrlgetItemChild ()
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 ()

Static Public Member Functions

static const std::string & getClassTypeName ()

Protected Member Functions

virtual ~MenuItem ()
virtual WidgetbaseCreateWidget (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.


Member Typedef Documentation

Reimplemented from MyGUI::Button.

Definition at line 36 of file MyGUI_MenuItem.h.

Reimplemented from MyGUI::Button.

Definition at line 36 of file MyGUI_MenuItem.h.


Constructor & Destructor Documentation

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.

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 ( ) [inline, static]

Reimplemented from MyGUI::Button.

Definition at line 36 of file MyGUI_MenuItem.h.

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.

Get item index.

Definition at line 133 of file MyGUI_MenuItem.cpp.

Get item name.

Definition at line 103 of file MyGUI_MenuItem.cpp.

Get item type (see MenuItemType)

Definition at line 148 of file MyGUI_MenuItem.cpp.

Get parent MenuCtrl

Definition at line 89 of file MyGUI_MenuItem.h.

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

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

Compare with selected type

Reimplemented from MyGUI::Button.

Definition at line 36 of file MyGUI_MenuItem.h.

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.

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.

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:
_keyProperty name (for example Widget_Alpha or Edit_MultiLine)
_valueValue 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.

Reimplemented from MyGUI::Button.

Definition at line 83 of file MyGUI_MenuItem.cpp.


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