: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` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Special button that brings up a :ref:`PopupMenu` when clicked. .. rst-class:: classref-introduction-group Description ----------- Special button that brings up a :ref:`PopupMenu` when clicked. New items can be created inside this :ref:`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` which contains common properties and methods associated with this node. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`ActionMode` | action_mode | ``0`` (overrides :ref:`BaseButton`) | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | flat | ``true`` (overrides :ref:`Button`) | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`FocusMode` | focus_mode | ``0`` (overrides :ref:`Control`) | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`switch_on_hover` | ``false`` | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | toggle_mode | ``true`` (overrides :ref:`BaseButton`) | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`PopupMenu` | :ref:`get_popup` **(** **)** |const| | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_disable_shortcuts` **(** :ref:`bool` disabled **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color` | ``Color( 0.88, 0.88, 0.88, 1 )`` | +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_disabled` | ``Color( 1, 1, 1, 0.3 )`` | +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_focus` | ``Color( 0.94, 0.94, 0.94, 1 )`` | +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_hover` | ``Color( 0.94, 0.94, 0.94, 1 )`` | +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_pressed` | ``Color( 1, 1, 1, 1 )`` | +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`int` | :ref:`hseparation` | ``3`` | +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`Font` | :ref:`font` | | +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`disabled` | | +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`focus` | | +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`hover` | | +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`normal` | | +---------------------------------+------------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`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` 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` **switch_on_hover** = ``false`` .. rst-class:: classref-property-setget - void **set_switch_on_hover** **(** :ref:`bool` value **)** - :ref:`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` **get_popup** **(** **)** |const| Returns the :ref:`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` property. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_method_set_disable_shortcuts: .. rst-class:: classref-method void **set_disable_shortcuts** **(** :ref:`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` **font_color** = ``Color( 0.88, 0.88, 0.88, 1 )`` Default text :ref:`Color` of the **MenuButton**. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_color_font_color_disabled: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_disabled** = ``Color( 1, 1, 1, 0.3 )`` Text :ref:`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` **font_color_focus** = ``Color( 0.94, 0.94, 0.94, 1 )`` Text :ref:`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` **font_color_hover** = ``Color( 0.94, 0.94, 0.94, 1 )`` Text :ref:`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` **font_color_pressed** = ``Color( 1, 1, 1, 1 )`` Text :ref:`Color` used when the **MenuButton** is being pressed. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_constant_hseparation: .. rst-class:: classref-themeproperty :ref:`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` **font** :ref:`Font` of the **MenuButton**'s text. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_style_disabled: .. rst-class:: classref-themeproperty :ref:`StyleBox` **disabled** :ref:`StyleBox` used when the **MenuButton** is disabled. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_style_focus: .. rst-class:: classref-themeproperty :ref:`StyleBox` **focus** :ref:`StyleBox` used when the **MenuButton** is focused. It is displayed over the current :ref:`StyleBox`, so using :ref:`StyleBoxEmpty` will just disable the focus visual effect. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_style_hover: .. rst-class:: classref-themeproperty :ref:`StyleBox` **hover** :ref:`StyleBox` used when the **MenuButton** is being hovered. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_style_normal: .. rst-class:: classref-themeproperty :ref:`StyleBox` **normal** Default :ref:`StyleBox` for the **MenuButton**. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_style_pressed: .. rst-class:: classref-themeproperty :ref:`StyleBox` **pressed** :ref:`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.)`