| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the MenuButton.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _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.
- 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.
- Properties
- ----------
- +-----------------------------------------------+-------------------------------------------------------------------+------------------------------+
- | :ref:`ActionMode<enum_BaseButton_ActionMode>` | action_mode | ``0`` *(parent override)* |
- +-----------------------------------------------+-------------------------------------------------------------------+------------------------------+
- | :ref:`bool<class_bool>` | flat | ``true`` *(parent override)* |
- +-----------------------------------------------+-------------------------------------------------------------------+------------------------------+
- | :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``0`` *(parent override)* |
- +-----------------------------------------------+-------------------------------------------------------------------+------------------------------+
- | :ref:`bool<class_bool>` | :ref:`switch_on_hover<class_MenuButton_property_switch_on_hover>` | ``false`` |
- +-----------------------------------------------+-------------------------------------------------------------------+------------------------------+
- | :ref:`bool<class_bool>` | toggle_mode | ``true`` *(parent override)* |
- +-----------------------------------------------+-------------------------------------------------------------------+------------------------------+
- Methods
- -------
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- Theme Properties
- ----------------
- +---------------------------------+---------------------+------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | disabled | |
- +---------------------------------+---------------------+------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | focus | |
- +---------------------------------+---------------------+------------------------------+
- | :ref:`Font<class_Font>` | font | |
- +---------------------------------+---------------------+------------------------------+
- | :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
- +---------------------------------+---------------------+------------------------------+
- | :ref:`Color<class_Color>` | font_color_disabled | Color( 1, 1, 1, 0.3 ) |
- +---------------------------------+---------------------+------------------------------+
- | :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
- +---------------------------------+---------------------+------------------------------+
- | :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
- +---------------------------------+---------------------+------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | hover | |
- +---------------------------------+---------------------+------------------------------+
- | :ref:`int<class_int>` | hseparation | 3 |
- +---------------------------------+---------------------+------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | normal | |
- +---------------------------------+---------------------+------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | pressed | |
- +---------------------------------+---------------------+------------------------------+
- Signals
- -------
- .. _class_MenuButton_signal_about_to_show:
- - **about_to_show** **(** **)**
- Emitted when :ref:`PopupMenu<class_PopupMenu>` of this MenuButton is about to show.
- Property Descriptions
- ---------------------
- .. _class_MenuButton_property_switch_on_hover:
- - :ref:`bool<class_bool>` **switch_on_hover**
- +-----------+----------------------------+
- | *Default* | ``false`` |
- +-----------+----------------------------+
- | *Setter* | set_switch_on_hover(value) |
- +-----------+----------------------------+
- | *Getter* | 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.
- Method Descriptions
- -------------------
- .. _class_MenuButton_method_get_popup:
- - :ref:`PopupMenu<class_PopupMenu>` **get_popup** **(** **)** |const|
- Returns the :ref:`PopupMenu<class_PopupMenu>` contained in this button.
- ----
- .. _class_MenuButton_method_set_disable_shortcuts:
- - void **set_disable_shortcuts** **(** :ref:`bool<class_bool>` disabled **)**
- If ``true``, shortcuts are disabled and cannot be used to trigger the button.
- .. |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.)`
|
