MyGUI 3.4.3
|
widget description should be here. More...
#include <MyGUI_MenuItem.h>
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 std::string_view | getTypeName () const override |
virtual bool | isType (const std::type_info &_type) const override |
template<typename Type> | |
bool | isType () const |
void | setCaption (const UString &_value) override |
void | setFontName (std::string_view _value) override |
void | setFontHeight (int _value) override |
void | setItemName (const UString &_value) |
Replace an item name. | |
const UString & | getItemName () const |
Get item name. | |
void | setItemData (Any _data) |
Replace an item name. | |
template<typename ValueType> | |
ValueType * | getItemData (bool _throw=true) |
Get item data. | |
void | removeItem () |
Remove item. | |
void | setItemId (std::string_view _id) |
Replace an item id at a specified position. | |
const std::string & | getItemId () const |
Get item id from specified position. | |
size_t | getItemIndex () const |
Get item index. | |
MenuControl * | createItemChild () |
template<typename Type> | |
Type * | createItemChildT () |
void | setItemType (MenuItemType _type) |
MenuItemType | getItemType () const |
void | setItemChildVisible (bool _visible) |
MenuControl * | getMenuCtrlParent () const |
MenuControl * | getItemChild () const |
bool | getItemChecked () const |
void | setItemChecked (bool _value) |
IItemContainer * | _getItemContainer () const override |
IntSize | _getContentSize () const |
Public Member Functions inherited from MyGUI::Button | |
template<typename Type> | |
bool | isType () const |
void | setStateSelected (bool _check) |
Set button selected state. | |
bool | getStateSelected () const |
Get buton selected. | |
void | setModeImage (bool _value) |
bool | getModeImage () const |
void | setImageResource (std::string_view _name) |
void | setImageGroup (std::string_view _name) |
void | setImageName (std::string_view _name) |
void | _setKeyFocus (bool _focus) |
void | _setMouseFocus (bool _focus) |
ImageBox * | _getImageBox () const |
Public Member Functions inherited from MyGUI::TextBox | |
template<typename Type> | |
bool | isType () const |
virtual IntCoord | getTextRegion () const |
virtual IntSize | getTextSize () const |
virtual const UString & | getCaption () const |
std::string_view | getFontName () const |
virtual int | getFontHeight () const |
virtual void | setTextAlign (Align _value) |
Align | getTextAlign () const |
virtual void | setTextColour (const Colour &_value) |
const Colour & | getTextColour () const |
void | setCaptionWithReplacing (std::string_view _value) |
virtual void | setTextShadowColour (const Colour &_value) |
const Colour & | getTextShadowColour () const |
virtual void | setTextShadow (bool _value) |
bool | getTextShadow () const |
Public Member Functions inherited from MyGUI::Widget | |
template<typename Type> | |
bool | isType () const |
Widget * | createWidgetT (std::string_view _type, std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _name={}) |
Widget * | createWidgetT (std::string_view _type, std::string_view _skin, int _left, int _top, int _width, int _height, Align _align, std::string_view _name={}) |
Widget * | createWidgetRealT (std::string_view _type, std::string_view _skin, const FloatCoord &_coord, Align _align, std::string_view _name={}) |
Widget * | createWidgetRealT (std::string_view _type, std::string_view _skin, float _left, float _top, float _width, float _height, Align _align, std::string_view _name={}) |
template<typename T> | |
T * | createWidget (std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _name={}) |
template<typename T> | |
T * | createWidget (std::string_view _skin, int _left, int _top, int _width, int _height, Align _align, std::string_view _name={}) |
template<typename T> | |
T * | createWidgetReal (std::string_view _skin, const FloatCoord &_coord, Align _align, std::string_view _name={}) |
template<typename T> | |
T * | createWidgetReal (std::string_view _skin, float _left, float _top, float _width, float _height, Align _align, std::string_view _name={}) |
Widget * | createWidgetT (WidgetStyle _style, std::string_view _type, std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _layer={}, std::string_view _name={}) |
template<typename T> | |
T * | createWidget (WidgetStyle _style, std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _layer={}, std::string_view _name={}) |
void | setPosition (const IntPoint &_point) override |
void | setSize (const IntSize &_size) override |
void | setCoord (const IntCoord &_coord) 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 &_point) |
void | setRealSize (const FloatSize &_size) |
void | setRealCoord (const FloatCoord &_coord) |
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 |
void | setDepth (int _value) |
int | getDepth () const |
bool | getInheritedVisible () const |
virtual void | setAlign (Align _value) |
Align | getAlign () const |
void | setAlpha (float _alpha) |
float | getAlpha () const |
void | setInheritsAlpha (bool _inherits) |
bool | getInheritsAlpha () const |
void | setColour (const Colour &_value) |
bool | isRootWidget () const |
Widget * | getParent () const |
IntSize | getParentSize () const |
EnumeratorWidgetPtr | getEnumerator () const |
size_t | getChildCount () const |
Widget * | getChildAt (size_t _index) const |
Widget * | findWidget (std::string_view _name) |
void | findWidgets (std::string_view _name, VectorWidgetPtr &_result) |
virtual void | setEnabled (bool _value) |
void | setEnabledSilent (bool _value) |
bool | getEnabled () const |
bool | getInheritedEnabled () const |
IntCoord | getClientCoord () const |
Widget * | getClientWidget () |
const Widget * | getClientWidget () const |
void | detachFromWidget (std::string_view _layer={}) |
void | attachToWidget (Widget *_parent, WidgetStyle _style=WidgetStyle::Child, std::string_view _layer={}) |
void | changeWidgetSkin (std::string_view _skinName) |
void | setWidgetStyle (WidgetStyle _style, std::string_view _layer={}) |
WidgetStyle | getWidgetStyle () const |
void | setProperty (std::string_view _key, std::string_view _value) |
virtual size_t | _getItemIndex (Widget *_item) const |
void | _forcePick (Widget *_widget) |
void | _initialise (WidgetStyle _style, const IntCoord &_coord, std::string_view _skinName, Widget *_parent, ICroppedRectangle *_croppedParent, std::string_view _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, std::string_view _type, std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _layer={}, std::string_view _name={}) |
virtual void | _resetContainer (bool _update) |
bool | _setWidgetState (std::string_view _state) |
void | _updateChilds () |
Public Member Functions inherited from MyGUI::IObject | |
template<typename Type> | |
bool | isType () const |
template<typename Type> | |
Type * | castType (bool _throw=true) |
template<typename Type> | |
const Type * | castType (bool _throw=true) const |
virtual | ~IObject ()=default |
Public Member Functions inherited from MyGUI::ICroppedRectangle | |
virtual | ~ICroppedRectangle ()=default |
ICroppedRectangle * | getCroppedParent () |
IntPoint | getPosition () const |
IntSize | getSize () const |
const IntCoord & | getCoord () const |
const IntPoint & | getAbsolutePosition () 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 (std::string_view _key, std::string_view _value) |
std::string_view | getUserString (std::string_view _key) const |
const MapString & | getUserStrings () const |
bool | clearUserString (std::string_view _key) |
bool | isUserString (std::string_view _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 | |
virtual | ~WidgetInput ()=default |
void | setNeedToolTip (bool _value) |
bool | getNeedToolTip () const |
void | setPointer (std::string_view _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::delegates::IDelegateUnlink | |
virtual | ~IDelegateUnlink ()=default |
IDelegateUnlink () | |
bool | compare (IDelegateUnlink *_unlink) const |
Public Member Functions inherited from MyGUI::SkinItem | |
ISubWidgetText * | getSubWidgetText () const |
ISubWidgetRect * | getSubWidgetMain () const |
void | _setTextureName (std::string_view _texture) |
const std::string & | _getTextureName () const |
Public Member Functions inherited from MyGUI::LayerItem | |
ILayer * | getLayer () const |
ILayerNode * | getLayerNode () 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 ()=default |
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 () const |
void | setStateCheck (bool _value) |
bool | getStateCheck () const |
ImageBox * | getStaticImage () const |
void | setImageIndex (size_t _index) |
size_t | getImageIndex () const |
Public Member Functions inherited from MyGUI::IItem | |
virtual | ~IItem ()=default |
Public Member Functions inherited from MyGUI::MemberObsolete< MenuItem > | |
void | showItemChild () |
void | hideItemChild () |
Static Public Member Functions | |
static std::string_view | getClassTypeName () |
Static Public Member Functions inherited from MyGUI::Button | |
static std::string_view | getClassTypeName () |
Static Public Member Functions inherited from MyGUI::TextBox | |
static std::string_view | getClassTypeName () |
Static Public Member Functions inherited from MyGUI::Widget | |
static std::string_view | getClassTypeName () |
Static Public Member Functions inherited from MyGUI::IObject | |
static std::string_view | getClassTypeName () |
Protected Member Functions | |
void | initialiseOverride () override |
void | shutdownOverride () override |
void | setPropertyOverride (std::string_view _key, std::string_view _value) override |
void | onWidgetCreated (Widget *_widget) override |
Protected Member Functions inherited from MyGUI::Button | |
void | onKeyLostFocus (Widget *_new) override |
void | onKeySetFocus (Widget *_old) override |
void | onMouseLostFocus (Widget *_new) override |
void | onMouseSetFocus (Widget *_old) override |
void | onMouseButtonPressed (int _left, int _top, MouseButton _id) override |
void | onMouseButtonReleased (int _left, int _top, MouseButton _id) override |
void | baseUpdateEnable () override |
bool | _setState (std::string_view _value) |
Protected Member Functions inherited from MyGUI::TextBox | |
void | setPropertyOverride (std::string_view _key, std::string_view _value) override |
Protected Member Functions inherited from MyGUI::Widget | |
~Widget () override=default | |
void | _updateView () |
Widget * | baseCreateWidget (WidgetStyle _style, std::string_view _type, std::string_view _skin, const IntCoord &_coord, Align _align, std::string_view _layer, std::string_view _name, bool _template) |
void | _destroyAllChildWidget () |
virtual size_t | _getContainerIndex (const IntPoint &_point) const |
ILayerItem * | getLayerItemByPoint (int _left, int _top) const override |
const IntCoord & | getLayerItemCoord () const override |
template<typename T> | |
void | assignWidget (T *&_widget, std::string_view _name) |
VectorWidgetPtr | getSkinWidgetsByName (std::string_view _name) const |
virtual void | onWidgetDestroy (Widget *_widget) |
void | setWidgetClient (Widget *_widget) |
Widget * | _getClientWidget () |
If there is client widget return it, otherwise return this. | |
const Widget * | _getClientWidget () const |
Protected Member Functions inherited from MyGUI::ICroppedRectangle | |
bool | _checkMargin () |
bool | _checkOutside () const |
Protected Member Functions inherited from MyGUI::WidgetInput | |
virtual void | onMouseDrag (int _left, int _top, MouseButton _id) |
virtual void | onMouseMove (int _left, int _top) |
virtual void | onMouseWheel (int _rel) |
virtual void | onMouseButtonClick () |
virtual void | onMouseButtonDoubleClick () |
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 (std::string_view _state) |
void | _setSubSkinVisible (bool _visible) |
Protected Member Functions inherited from MyGUI::LayerItem | |
void | attachToLayerItemNode (ILayerNode *_item, bool _deep) |
void | detachFromLayerItemNode (bool _deep) |
widget description should be here.
Definition at line 21 of file MyGUI_MenuItem.h.
typedef RTTIBase MyGUI::MenuItem::Base |
Definition at line 23 of file MyGUI_MenuItem.h.
typedef MenuItem MyGUI::MenuItem::RTTIBase |
Definition at line 23 of file MyGUI_MenuItem.h.
IntSize MyGUI::MenuItem::_getContentSize | ( | ) | const |
Definition at line 174 of file MyGUI_MenuItem.cpp.
|
overridevirtual |
Reimplemented from MyGUI::IItem.
Definition at line 169 of file MyGUI_MenuItem.cpp.
MenuControl * MyGUI::MenuItem::createItemChild | ( | ) |
Create child item (submenu), MenuItem can have only one child
Definition at line 116 of file MyGUI_MenuItem.cpp.
|
inline |
Create specific type child item (submenu), MenuItem can have only one child
Definition at line 66 of file MyGUI_MenuItem.h.
|
inlinestatic |
Definition at line 23 of file MyGUI_MenuItem.h.
bool MyGUI::MenuItem::getItemChecked | ( | ) | const |
Definition at line 189 of file MyGUI_MenuItem.cpp.
MenuControl * MyGUI::MenuItem::getItemChild | ( | ) | const |
Get child item (submenu)
Definition at line 136 of file MyGUI_MenuItem.cpp.
|
inline |
Get item data.
Definition at line 45 of file MyGUI_MenuItem.h.
const std::string & MyGUI::MenuItem::getItemId | ( | ) | const |
Get item id from specified position.
Definition at line 106 of file MyGUI_MenuItem.cpp.
size_t MyGUI::MenuItem::getItemIndex | ( | ) | const |
Get item index.
Definition at line 111 of file MyGUI_MenuItem.cpp.
const UString & MyGUI::MenuItem::getItemName | ( | ) | const |
Get item name.
Definition at line 81 of file MyGUI_MenuItem.cpp.
MenuItemType MyGUI::MenuItem::getItemType | ( | ) | const |
Get item type (see MenuItemType)
Definition at line 126 of file MyGUI_MenuItem.cpp.
MenuControl * MyGUI::MenuItem::getMenuCtrlParent | ( | ) | const |
Get parent MenuControl
Definition at line 164 of file MyGUI_MenuItem.cpp.
|
inlineoverridevirtual |
Get type name as string
Reimplemented from MyGUI::Button.
Definition at line 23 of file MyGUI_MenuItem.h.
|
overrideprotectedvirtual |
Reimplemented from MyGUI::Button.
Definition at line 13 of file MyGUI_MenuItem.cpp.
|
inline |
Compare with selected type
Definition at line 23 of file MyGUI_MenuItem.h.
|
inlineoverridevirtual |
Compare with selected type
Reimplemented from MyGUI::Button.
Definition at line 23 of file MyGUI_MenuItem.h.
|
overrideprotectedvirtual |
Reimplemented from MyGUI::Widget.
Definition at line 50 of file MyGUI_MenuItem.cpp.
void MyGUI::MenuItem::removeItem | ( | ) |
Remove item.
Definition at line 96 of file MyGUI_MenuItem.cpp.
|
overridevirtual |
Set widget caption
Reimplemented from MyGUI::TextBox.
Definition at line 61 of file MyGUI_MenuItem.cpp.
|
overridevirtual |
Set widget text font height. If set to 0 then default height from selected font is used
Reimplemented from MyGUI::TextBox.
Definition at line 74 of file MyGUI_MenuItem.cpp.
|
overridevirtual |
Set widget text font
Reimplemented from MyGUI::TextBox.
Definition at line 67 of file MyGUI_MenuItem.cpp.
void MyGUI::MenuItem::setItemChecked | ( | bool | _value | ) |
Definition at line 194 of file MyGUI_MenuItem.cpp.
void MyGUI::MenuItem::setItemChildVisible | ( | bool | _visible | ) |
Hide or show child item (submenu)
Definition at line 131 of file MyGUI_MenuItem.cpp.
void MyGUI::MenuItem::setItemData | ( | Any | _data | ) |
Replace an item name.
Definition at line 91 of file MyGUI_MenuItem.cpp.
void MyGUI::MenuItem::setItemId | ( | std::string_view | _id | ) |
Replace an item id at a specified position.
Definition at line 101 of file MyGUI_MenuItem.cpp.
void MyGUI::MenuItem::setItemName | ( | const UString & | _value | ) |
Replace an item name.
Definition at line 86 of file MyGUI_MenuItem.cpp.
void MyGUI::MenuItem::setItemType | ( | MenuItemType | _type | ) |
Set item type (see MenuItemType)
Definition at line 121 of file MyGUI_MenuItem.cpp.
|
overrideprotectedvirtual |
Reimplemented from MyGUI::Button.
Definition at line 141 of file MyGUI_MenuItem.cpp.
|
overrideprotectedvirtual |
Reimplemented from MyGUI::Button.
Definition at line 42 of file MyGUI_MenuItem.cpp.