MyGUI  3.2.0
Public Types | Public Member Functions | Static Public Member Functions
MyGUI::MenuBar Class Reference

#include <MyGUI_MenuBar.h>

+ Inheritance diagram for MyGUI::MenuBar:

Public Types

typedef RTTIBase Base
typedef MenuBar RTTIBase
- Public Types inherited from MyGUI::MenuControl
typedef RTTIBase Base
typedef MenuControl RTTIBase
typedef std::vector< ItemInfoVectorMenuItemInfo
- 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
 MenuBar ()
- Public Member Functions inherited from MyGUI::MenuControl
 MenuControl ()
virtual void setVisible (bool _value)
 
void setVisibleSmooth (bool _value)
size_t getItemCount () const
 Get number of items.
MenuIteminsertItemAt (size_t _index, const UString &_name, MenuItemType _type=MenuItemType::Normal, const std::string &_id="", Any _data=Any::Null)
 Insert an item into a array at a specified position.
MenuIteminsertItem (MenuItem *_to, const UString &_name, MenuItemType _type=MenuItemType::Normal, const std::string &_id="", Any _data=Any::Null)
 Insert an item into a array.
MenuItemaddItem (const UString &_name, MenuItemType _type=MenuItemType::Normal, const std::string &_id="", Any _data=Any::Null)
 Add an item to the end of a array.
void removeItemAt (size_t _index)
 Remove item at a specified position.
void removeItem (MenuItem *_item)
 Remove item.
void removeAllItems ()
 Remove all items.
MenuItemgetItemAt (size_t _index)
 Get item from specified position.
size_t getItemIndex (MenuItem *_item)
 Get item index.
size_t findItemIndex (MenuItem *_item)
 Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.
MenuItemfindItemWith (const UString &_name)
 Search item, returns the item of the first occurrence in array or nullptr if item not found.
void setItemDataAt (size_t _index, Any _data)
 Replace an item data at a specified position.
void setItemData (MenuItem *_item, Any _data)
 Replace an item data.
void clearItemDataAt (size_t _index)
 Clear an item data at a specified position.
void clearItemData (MenuItem *_item)
 Clear an item data.
template<typename ValueType >
ValueType * getItemDataAt (size_t _index, bool _throw=true)
 Get item data from specified position.
template<typename ValueType >
ValueType * getItemData (MenuItem *_item, bool _throw=true)
 Get item data.
void setItemIdAt (size_t _index, const std::string &_id)
 Replace an item id at a specified position.
void setItemId (MenuItem *_item, const std::string &_id)
 Replace an item id.
const std::string & getItemIdAt (size_t _index)
 Get item id from specified position.
const std::string & getItemId (MenuItem *_item)
 Get item id.
MenuItemgetItemById (const std::string &_id)
MenuItemfindItemById (const std::string &_id, bool _recursive=false)
size_t getItemIndexById (const std::string &_id)
void setItemNameAt (size_t _index, const UString &_name)
 Replace an item name at a specified position.
void setItemName (MenuItem *_item, const UString &_name)
 Replace an item name.
const UStringgetItemNameAt (size_t _index)
 Get item from specified position.
const UStringgetItemName (MenuItem *_item)
 Get item from specified position.
size_t findItemIndexWith (const UString &_name)
 Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.
void setItemChildVisibleAt (size_t _index, bool _visible)
void setItemChildVisible (MenuItem *_item, bool _visible)
template<typename Type >
Type * createItemChildTAt (size_t _index)
template<typename Type >
Type * createItemChildT (MenuItem *_item)
MenuControlgetItemChildAt (size_t _index)
MenuControlgetItemChild (MenuItem *_item)
MenuControlcreateItemChildAt (size_t _index)
MenuControlcreateItemChild (MenuItem *_item)
void removeItemChildAt (size_t _index)
void removeItemChild (MenuItem *_item)
MenuItemType getItemTypeAt (size_t _index)
MenuItemType getItemType (MenuItem *_item)
void setItemTypeAt (size_t _index, MenuItemType _type)
void setItemType (MenuItem *_item, MenuItemType _type)
void setPopupAccept (bool _value)
bool getPopupAccept () const
MenuItemgetMenuItemParent ()
void setVerticalAlignment (bool _value)
bool getVerticalAlignment () const
void _notifyDeleteItem (MenuItem *_item)
void _notifyDeletePopup (MenuItem *_item)
void _notifyUpdateName (MenuItem *_item)
void _wrapItemChild (MenuItem *_item, MenuControl *_widget)
virtual size_t _getItemCount ()
virtual void _addItem (const MyGUI::UString &_name)
virtual void _removeItemAt (size_t _index)
virtual Widget_getItemAt (size_t _index)
virtual void _setItemNameAt (size_t _index, const UString &_name)
virtual const UString_getItemNameAt (size_t _index)
virtual void _setItemSelected (IItem *_item)
void _updateItems (size_t _index)
void _updateSizeForEmpty ()
- 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.
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::IItemContainer
 IItemContainer ()
virtual ~IItemContainer ()
- Public Member Functions inherited from MyGUI::MemberObsolete< MenuControl >
void showMenu ()
void hideMenu ()
bool isShowMenu ()
void showItemChildAt (size_t _index)
void showItemChild (MenuItem *_item)
void hideItemChildAt (size_t _index)
void hideItemChild (MenuItem *_item)
void setAlignVert (bool _value)
bool getAlignVert ()

Static Public Member Functions

static const std::string & getClassTypeName ()

Additional Inherited Members

- Data Fields inherited from MyGUI::MenuControl
EventHandle_MenuCtrlPtrMenuItemPtr eventMenuCtrlAccept
EventHandle_MenuCtrlPtr eventMenuCtrlClose
- Protected Member Functions inherited from MyGUI::MenuControl
virtual void initialiseOverride ()
virtual void shutdownOverride ()
virtual void onKeyChangeRootFocus (bool _focus)
virtual void onWidgetCreated (Widget *_widget)
virtual void setPropertyOverride (const std::string &_key, const std::string &_value)
- Protected Attributes inherited from MyGUI::MenuControl
bool mHideByAccept
bool mMenuDropMode
bool mIsMenuDrop
bool mHideByLostKey
bool mResizeToContent

Detailed Description

Definition at line 31 of file MyGUI_MenuBar.h.

Member Typedef Documentation

Definition at line 34 of file MyGUI_MenuBar.h.

Definition at line 34 of file MyGUI_MenuBar.h.

Constructor & Destructor Documentation

MyGUI::MenuBar::MenuBar ( )

Definition at line 28 of file MyGUI_MenuBar.cpp.

Member Function Documentation

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

Reimplemented from MyGUI::MenuControl.

Definition at line 34 of file MyGUI_MenuBar.h.

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

Get type name as string

Reimplemented from MyGUI::MenuControl.

Definition at line 34 of file MyGUI_MenuBar.h.

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

Compare with selected type

Reimplemented from MyGUI::MenuControl.

Definition at line 34 of file MyGUI_MenuBar.h.

template<typename Type >
bool MyGUI::MenuBar::isType ( ) const
inline

Compare with selected type

Reimplemented from MyGUI::MenuControl.

Definition at line 34 of file MyGUI_MenuBar.h.


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