:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/MenuButton.xml. .. _class_MenuButton: MenuButton ========== **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` A button that brings up a :ref:`PopupMenu` when clicked. .. rst-class:: classref-introduction-group Description ----------- A button that brings up a :ref:`PopupMenu` when clicked. To create new items inside this :ref:`PopupMenu`, use ``get_popup().add_item("My Item Name")``. You can also create them directly from Godot editor's inspector. 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:`int` | :ref:`item_count` | ``0`` | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :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 **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`show_popup` **(** **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`font_disabled_color` | ``Color(1, 1, 1, 0.3)`` | +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`h_separation` | ``3`` | +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Font` | :ref:`font` | | +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`font_size` | | +---------------------------------+------------------------------------------------------------------------------+-----------------------------------+ | :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_popup: .. rst-class:: classref-signal **about_to_popup** **(** **)** Emitted when the :ref:`PopupMenu` of this MenuButton is about to show. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_MenuButton_property_item_count: .. rst-class:: classref-property :ref:`int` **item_count** = ``0`` .. rst-class:: classref-property-setget - void **set_item_count** **(** :ref:`int` value **)** - :ref:`int` **get_item_count** **(** **)** The number of items currently in the list. .. rst-class:: classref-item-separator ---- .. _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:`Window.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-item-separator ---- .. _class_MenuButton_method_show_popup: .. rst-class:: classref-method void **show_popup** **(** **)** Adjusts popup position and sizing for the **MenuButton**, then shows the :ref:`PopupMenu`. Prefer this over using ``get_popup().popup()``. .. 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.875, 0.875, 0.875, 1)`` Default text :ref:`Color` of the **MenuButton**. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_color_font_disabled_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_disabled_color** = ``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_focus_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 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_hover_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` Text :ref:`Color` used when the **MenuButton** is being hovered. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_color_font_outline_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_outline_color** = ``Color(1, 1, 1, 1)`` The tint of text outline of the **MenuButton**. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_color_font_pressed_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_pressed_color** = ``Color(1, 1, 1, 1)`` Text :ref:`Color` used when the **MenuButton** is being pressed. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_constant_h_separation: .. rst-class:: classref-themeproperty :ref:`int` **h_separation** = ``3`` The horizontal space between **MenuButton**'s icon and text. Negative values will be treated as ``0`` when used. .. rst-class:: classref-item-separator ---- .. _class_MenuButton_theme_constant_outline_size: .. rst-class:: classref-themeproperty :ref:`int` **outline_size** = ``0`` The size of the text outline. \ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field` enabled, its :ref:`FontFile.msdf_pixel_range` must be set to at least *twice* the value of :ref:`outline_size` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. .. 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_font_size_font_size: .. rst-class:: classref-themeproperty :ref:`int` **font_size** Font size 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. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. .. 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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`