MyGUI 3.4.1
Public Types | Public Member Functions | Static Public Member Functions
MyGUI::PopupMenu Class Reference

widget description should be here. More...

#include <MyGUI_PopupMenu.h>

Inheritance diagram for MyGUI::PopupMenu:
Inheritance graph
[legend]

Public Types

typedef RTTIBase Base
 
typedef PopupMenu 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 override
 
virtual bool isType (const std::type_info &_type) const override
 
template<typename Type >
bool isType () const
 
 PopupMenu ()
 
- Public Member Functions inherited from MyGUI::MenuControl
virtual const std::string & getTypeName () const override
 
virtual bool isType (const std::type_info &_type) const override
 
template<typename Type >
bool isType () const
 
 MenuControl ()
 
void setVisible (bool _value) override
 
void setVisibleSmooth (bool _value)
 
size_t getItemCount () const
 Get number of items. More...
 
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. More...
 
MenuIteminsertItem (MenuItem *_to, const UString &_name, MenuItemType _type=MenuItemType::Normal, const std::string &_id="", Any _data=Any::Null)
 Insert an item into a array. More...
 
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. More...
 
void removeItemAt (size_t _index)
 Remove item at a specified position. More...
 
void removeItem (MenuItem *_item)
 Remove item. More...
 
void removeAllItems ()
 Remove all items. More...
 
MenuItemgetItemAt (size_t _index) const
 Get item from specified position. More...
 
size_t getItemIndex (const MenuItem *_item) const
 Get item index. More...
 
size_t findItemIndex (MenuItem *_item)
 Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found. More...
 
MenuItemfindItemWith (const UString &_name)
 Search item, returns the item of the first occurrence in array or nullptr if item not found. More...
 
void setItemDataAt (size_t _index, Any _data)
 Replace an item data at a specified position. More...
 
void setItemData (MenuItem *_item, Any _data)
 Replace an item data. More...
 
void clearItemDataAt (size_t _index)
 Clear an item data at a specified position. More...
 
void clearItemData (MenuItem *_item)
 Clear an item data. More...
 
template<typename ValueType >
ValueType * getItemDataAt (size_t _index, bool _throw=true)
 Get item data from specified position. More...
 
template<typename ValueType >
ValueType * getItemData (MenuItem *_item, bool _throw=true)
 Get item data. More...
 
void setItemIdAt (size_t _index, const std::string &_id)
 Replace an item id at a specified position. More...
 
void setItemId (MenuItem *_item, const std::string &_id)
 Replace an item id. More...
 
const std::string & getItemIdAt (size_t _index) const
 Get item id from specified position. More...
 
const std::string & getItemId (const MenuItem *_item) const
 Get item id. More...
 
MenuItemgetItemById (const std::string &_id) const
 
MenuItemfindItemById (const std::string &_id, bool _recursive=false)
 
size_t getItemIndexById (const std::string &_id) const
 
void setItemNameAt (size_t _index, const UString &_name)
 Replace an item name at a specified position. More...
 
void setItemName (MenuItem *_item, const UString &_name)
 Replace an item name. More...
 
const UStringgetItemNameAt (size_t _index) const
 Get item from specified position. More...
 
const UStringgetItemName (const MenuItem *_item) const
 Get item from specified position. More...
 
size_t findItemIndexWith (const UString &_name)
 Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found. More...
 
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) const
 
MenuControlgetItemChild (const MenuItem *_item) const
 
MenuControlcreateItemChildAt (size_t _index)
 
MenuControlcreateItemChild (MenuItem *_item)
 
void removeItemChildAt (size_t _index)
 
void removeItemChild (MenuItem *_item)
 
MenuItemType getItemTypeAt (size_t _index) const
 
MenuItemType getItemType (const MenuItem *_item) const
 
void setItemTypeAt (size_t _index, MenuItemType _type)
 
void setItemType (MenuItem *_item, MenuItemType _type)
 
void setPopupAccept (bool _value)
 
bool getPopupAccept () const
 
MenuItemgetMenuItemParent () const
 
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)
 
size_t _getItemCount () const override
 
void _addItem (const MyGUI::UString &_name) override
 
void _removeItemAt (size_t _index) override
 
Widget_getItemAt (size_t _index) const override
 
void _setItemNameAt (size_t _index, const UString &_name) override
 
const UString_getItemNameAt (size_t _index) const override
 
void _setItemSelected (IItem *_item) override
 
void _updateItems (size_t _index)
 
void _updateSizeForEmpty ()
 
- Public Member Functions inherited from MyGUI::Widget
virtual const std::string & getTypeName () const override
 
virtual bool isType (const std::type_info &_type) const override
 
template<typename Type >
bool isType () const
 
 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="")
 
void setPosition (const IntPoint &_value) override
 
void setSize (const IntSize &_value) override
 
void setCoord (const IntCoord &_value) override
 
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. More...
 
virtual void setVisible (bool _value)
 
bool getVisible () const
 
void setDepth (int _value)
 
int getDepth () 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 () const
 
WidgetgetChildAt (size_t _index) const
 
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 () const
 
WidgetgetClientWidget ()
 
const WidgetgetClientWidget () const
 
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) const
 
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 () const
 
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)
 
void _updateChilds ()
 
- Public Member Functions inherited from MyGUI::IObject
virtual const std::string & getTypeName () const
 
virtual bool isType (const std::type_info &_type) const
 
template<typename Type >
bool isType () const
 
template<typename Type >
Type * castType (bool _throw=true)
 
template<typename Type >
const Type * castType (bool _throw=true) const
 
 IObject ()=default
 
virtual ~IObject ()=default
 
- Public Member Functions inherited from MyGUI::ICroppedRectangle
 ICroppedRectangle ()
 
virtual ~ICroppedRectangle ()
 
ICroppedRectanglegetCroppedParent ()
 
virtual void setPosition (const IntPoint &_value)
 
virtual void setSize (const IntSize &_value)
 
virtual void setCoord (const IntCoord &_value)
 
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
virtual ~UserData ()=default
 
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) const
 
void _setInternalData (Any _data)
 
template<typename ValueType >
ValueType * _getInternalData (bool _throw=true) const
 
- Public Member Functions inherited from MyGUI::WidgetInput
 WidgetInput ()
 
virtual ~WidgetInput ()=default
 
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 () const
 
ISubWidgetRectgetSubWidgetMain () const
 
void _setTextureName (const std::string &_texture)
 
const std::string & _getTextureName () const
 
- Public Member Functions inherited from MyGUI::LayerItem
 LayerItem ()
 
ILayergetLayer () const
 
ILayerNodegetLayerNode () const
 
void attachItemToNode (ILayer *_layer, ILayerNode *_node) override
 
void detachFromLayer () override
 
void upLayerItem () override
 
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 ILayerItemgetLayerItemByPoint (int _left, int _top) const =0
 
virtual const IntCoordgetLayerItemCoord () const =0
 
virtual void resizeLayerItemView (const IntSize &_oldView, const IntSize &_newView)=0
 
virtual void attachItemToNode (ILayer *_layer, ILayerNode *_node)=0
 
virtual void detachFromLayer ()=0
 
virtual void upLayerItem ()=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
virtual ~IItemContainer ()
 
virtual size_t _getItemCount () const
 
virtual void _addItem (const MyGUI::UString &_name)
 
virtual void _removeItemAt (size_t _index)
 
virtual Widget_getItemAt (size_t _index) const
 
virtual void _setItemNameAt (size_t _index, const UString &_name)
 
virtual const UString_getItemNameAt (size_t _index) const
 
virtual void _setItemSelected (IItem *_item)
 
- 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 () const
 

Static Public Member Functions

static const std::string & getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::MenuControl
static const std::string & getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::Widget
static const std::string & getClassTypeName ()
 
- Static Public Member Functions inherited from MyGUI::IObject
static const std::string & getClassTypeName ()
 

Additional Inherited Members

- Data Fields inherited from MyGUI::MenuControl
EventHandle_MenuCtrlPtrMenuItemPtr eventMenuCtrlAccept
 
EventHandle_MenuCtrlPtr eventMenuCtrlClose
 
- Data Fields inherited from MyGUI::Widget
EventHandle_WidgetStringString eventChangeProperty
 
EventHandle_WidgetVoid eventChangeCoord
 
EventHandle_WidgetVoid eventWidgetDestroyed
 
- Data Fields inherited from MyGUI::WidgetInput
EventHandle_WidgetWidget eventMouseLostFocus
 
EventHandle_WidgetWidget eventMouseSetFocus
 
EventPairAddParameter< EventHandle_WidgetIntInt, EventHandle_WidgetIntIntButtoneventMouseDrag
 
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
 
- Protected Member Functions inherited from MyGUI::MenuControl
void initialiseOverride () override
 
void shutdownOverride () override
 
void onKeyChangeRootFocus (bool _focus) override
 
void onWidgetCreated (Widget *_widget) override
 
void setPropertyOverride (const std::string &_key, const std::string &_value) override
 
- Protected Member Functions inherited from MyGUI::Widget
 ~Widget () override=default
 
virtual void shutdownOverride ()
 
virtual void initialiseOverride ()
 
void _updateView ()
 
WidgetbaseCreateWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer, const std::string &_name, bool _template)
 
void _destroyAllChildWidget ()
 
virtual size_t _getContainerIndex (const IntPoint &_point) const
 
virtual void baseUpdateEnable ()
 
ILayerItemgetLayerItemByPoint (int _left, int _top) const override
 
const IntCoordgetLayerItemCoord () const override
 
template<typename T >
void assignWidget (T *&_widget, const std::string &_name)
 
VectorWidgetPtr getSkinWidgetsByName (const std::string &_name) const
 
virtual void onWidgetCreated (Widget *_widget)
 
virtual void onWidgetDestroy (Widget *_widget)
 
void setWidgetClient (Widget *_widget)
 
Widget_getClientWidget ()
 If there is client widget return it, otherwise return this. More...
 
const Widget_getClientWidget () const
 
virtual void setPropertyOverride (const std::string &_key, const std::string &_value)
 
- Protected Member Functions inherited from MyGUI::ICroppedRectangle
bool _checkMargin ()
 
bool _checkOutside () const
 
- Protected Member Functions inherited from MyGUI::WidgetInput
virtual void onMouseLostFocus (Widget *_new)
 
virtual void onMouseSetFocus (Widget *_old)
 
virtual void onMouseDrag (int _left, int _top, MouseButton _id)
 
virtual void onMouseMove (int _left, int _top)
 
virtual void onMouseWheel (int _rel)
 
virtual void onMouseButtonPressed (int _left, int _top, MouseButton _id)
 
virtual void onMouseButtonReleased (int _left, int _top, MouseButton _id)
 
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::SkinItem
void _createSkinItem (ResourceSkin *_info)
 
void _deleteSkinItem ()
 
void _setSkinItemAlign (const IntSize &_size)
 
void _setSkinItemVisible (bool _value)
 
void _setSkinItemColour (const Colour &_value)
 
void _setSkinItemAlpha (float _value)
 
void _correctSkinItemView ()
 
void _updateSkinItemView ()
 
bool _setSkinItemState (const std::string &_state)
 
void _setSubSkinVisible (bool _visible)
 
- Protected Member Functions inherited from MyGUI::LayerItem
void attachToLayerItemNode (ILayerNode *_node, bool _deep)
 
void detachFromLayerItemNode (bool _deep)
 
- Protected Attributes inherited from MyGUI::MenuControl
bool mHideByAccept
 
bool mMenuDropMode
 
bool mIsMenuDrop
 
bool mHideByLostKey
 
bool mResizeToContent
 
- Protected Attributes inherited from MyGUI::ICroppedRectangle
IntRect mMargin
 
IntCoord mCoord
 
IntPoint mAbsolutePosition
 
bool mIsMargin
 
ICroppedRectanglemCroppedParent
 

Detailed Description

widget description should be here.

Definition at line 19 of file MyGUI_PopupMenu.h.

Member Typedef Documentation

◆ Base

Definition at line 22 of file MyGUI_PopupMenu.h.

◆ RTTIBase

Definition at line 22 of file MyGUI_PopupMenu.h.

Constructor & Destructor Documentation

◆ PopupMenu()

MyGUI::PopupMenu::PopupMenu ( )

Definition at line 13 of file MyGUI_PopupMenu.cpp.

Member Function Documentation

◆ getClassTypeName()

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

Definition at line 22 of file MyGUI_PopupMenu.h.

◆ getTypeName()

virtual const std::string & MyGUI::PopupMenu::getTypeName ( ) const
inlineoverridevirtual

Get type name as string

Reimplemented from MyGUI::MenuControl.

Definition at line 22 of file MyGUI_PopupMenu.h.

◆ isType() [1/2]

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

Compare with selected type

Definition at line 22 of file MyGUI_PopupMenu.h.

◆ isType() [2/2]

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

Compare with selected type

Reimplemented from MyGUI::MenuControl.

Definition at line 22 of file MyGUI_PopupMenu.h.


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