123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MenuButton.xml.
- .. _class_MenuButton:
- MenuButton
- ==========
- **Inherits:** :ref:`Button<class_Button>` **<** :ref:`BaseButton<class_BaseButton>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Special button that brings up a :ref:`PopupMenu<class_PopupMenu>` when clicked.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- Special button that brings up a :ref:`PopupMenu<class_PopupMenu>` when clicked.
- New items can be created inside this :ref:`PopupMenu<class_PopupMenu>` using ``get_popup().add_item("My Item Name")``. You can also create them directly from the editor. To do so, select the **MenuButton** node, then in the toolbar at the top of the 2D editor, click **Items** then click **Add** in the popup. You will be able to give each item new properties.
- See also :ref:`BaseButton<class_BaseButton>` which contains common properties and methods associated with this node.
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
- | :ref:`ActionMode<enum_BaseButton_ActionMode>` | action_mode | ``0`` (overrides :ref:`BaseButton<class_BaseButton_property_action_mode>`) |
- +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | flat | ``true`` (overrides :ref:`Button<class_Button_property_flat>`) |
- +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
- | :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``0`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
- +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`switch_on_hover<class_MenuButton_property_switch_on_hover>` | ``false`` |
- +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | toggle_mode | ``true`` (overrides :ref:`BaseButton<class_BaseButton_property_toggle_mode>`) |
- +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
- .. rst-class:: classref-reftable-group
- Methods
- -------
- .. table::
- :widths: auto
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PopupMenu<class_PopupMenu>` | :ref:`get_popup<class_MenuButton_method_get_popup>` **(** **)** |const| |
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_disable_shortcuts<class_MenuButton_method_set_disable_shortcuts>` **(** :ref:`bool<class_bool>` disabled **)** |
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- .. rst-class:: classref-reftable-group
- Theme Properties
- ----------------
- .. table::
- :widths: auto
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`Color<class_Color>` | :ref:`font_color<class_MenuButton_theme_color_font_color>` | ``Color( 0.88, 0.88, 0.88, 1 )`` |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_MenuButton_theme_color_font_color_disabled>` | ``Color( 1, 1, 1, 0.3 )`` |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`Color<class_Color>` | :ref:`font_color_focus<class_MenuButton_theme_color_font_color_focus>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`Color<class_Color>` | :ref:`font_color_hover<class_MenuButton_theme_color_font_color_hover>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_MenuButton_theme_color_font_color_pressed>` | ``Color( 1, 1, 1, 1 )`` |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`int<class_int>` | :ref:`hseparation<class_MenuButton_theme_constant_hseparation>` | ``3`` |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`Font<class_Font>` | :ref:`font<class_MenuButton_theme_font_font>` | |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_MenuButton_theme_style_disabled>` | |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_MenuButton_theme_style_focus>` | |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_MenuButton_theme_style_hover>` | |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_MenuButton_theme_style_normal>` | |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_MenuButton_theme_style_pressed>` | |
- +---------------------------------+------------------------------------------------------------------------------+----------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Signals
- -------
- .. _class_MenuButton_signal_about_to_show:
- .. rst-class:: classref-signal
- **about_to_show** **(** **)**
- Emitted when :ref:`PopupMenu<class_PopupMenu>` of this MenuButton is about to show.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_MenuButton_property_switch_on_hover:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **switch_on_hover** = ``false``
- .. rst-class:: classref-property-setget
- - void **set_switch_on_hover** **(** :ref:`bool<class_bool>` value **)**
- - :ref:`bool<class_bool>` **is_switch_on_hover** **(** **)**
- If ``true``, when the cursor hovers above another **MenuButton** within the same parent which also has ``switch_on_hover`` enabled, it will close the current **MenuButton** and open the other one.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Method Descriptions
- -------------------
- .. _class_MenuButton_method_get_popup:
- .. rst-class:: classref-method
- :ref:`PopupMenu<class_PopupMenu>` **get_popup** **(** **)** |const|
- Returns the :ref:`PopupMenu<class_PopupMenu>` contained in this button.
- \ **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_method_set_disable_shortcuts:
- .. rst-class:: classref-method
- void **set_disable_shortcuts** **(** :ref:`bool<class_bool>` disabled **)**
- If ``true``, shortcuts are disabled and cannot be used to trigger the button.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Theme Property Descriptions
- ---------------------------
- .. _class_MenuButton_theme_color_font_color:
- .. rst-class:: classref-themeproperty
- :ref:`Color<class_Color>` **font_color** = ``Color( 0.88, 0.88, 0.88, 1 )``
- Default text :ref:`Color<class_Color>` of the **MenuButton**.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_theme_color_font_color_disabled:
- .. rst-class:: classref-themeproperty
- :ref:`Color<class_Color>` **font_color_disabled** = ``Color( 1, 1, 1, 0.3 )``
- Text :ref:`Color<class_Color>` used when the **MenuButton** is disabled.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_theme_color_font_color_focus:
- .. rst-class:: classref-themeproperty
- :ref:`Color<class_Color>` **font_color_focus** = ``Color( 0.94, 0.94, 0.94, 1 )``
- Text :ref:`Color<class_Color>` used when the **MenuButton** is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_theme_color_font_color_hover:
- .. rst-class:: classref-themeproperty
- :ref:`Color<class_Color>` **font_color_hover** = ``Color( 0.94, 0.94, 0.94, 1 )``
- Text :ref:`Color<class_Color>` used when the **MenuButton** is being hovered.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_theme_color_font_color_pressed:
- .. rst-class:: classref-themeproperty
- :ref:`Color<class_Color>` **font_color_pressed** = ``Color( 1, 1, 1, 1 )``
- Text :ref:`Color<class_Color>` used when the **MenuButton** is being pressed.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_theme_constant_hseparation:
- .. rst-class:: classref-themeproperty
- :ref:`int<class_int>` **hseparation** = ``3``
- The horizontal space between **MenuButton**'s icon and text.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_theme_font_font:
- .. rst-class:: classref-themeproperty
- :ref:`Font<class_Font>` **font**
- :ref:`Font<class_Font>` of the **MenuButton**'s text.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_theme_style_disabled:
- .. rst-class:: classref-themeproperty
- :ref:`StyleBox<class_StyleBox>` **disabled**
- :ref:`StyleBox<class_StyleBox>` used when the **MenuButton** is disabled.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_theme_style_focus:
- .. rst-class:: classref-themeproperty
- :ref:`StyleBox<class_StyleBox>` **focus**
- :ref:`StyleBox<class_StyleBox>` used when the **MenuButton** is focused. It is displayed over the current :ref:`StyleBox<class_StyleBox>`, so using :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` will just disable the focus visual effect.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_theme_style_hover:
- .. rst-class:: classref-themeproperty
- :ref:`StyleBox<class_StyleBox>` **hover**
- :ref:`StyleBox<class_StyleBox>` used when the **MenuButton** is being hovered.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_theme_style_normal:
- .. rst-class:: classref-themeproperty
- :ref:`StyleBox<class_StyleBox>` **normal**
- Default :ref:`StyleBox<class_StyleBox>` for the **MenuButton**.
- .. rst-class:: classref-item-separator
- ----
- .. _class_MenuButton_theme_style_pressed:
- .. rst-class:: classref-themeproperty
- :ref:`StyleBox<class_StyleBox>` **pressed**
- :ref:`StyleBox<class_StyleBox>` used when the **MenuButton** is being pressed.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|