:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/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 | ``3`` (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`\ (\ disabled\: :ref:`bool`\ ) | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`show_popup`\ (\ ) | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_MenuButton_signal_about_to_popup: .. rst-class:: classref-signal **about_to_popup**\ (\ ) :ref:`🔗` 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`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_item_count**\ (\ value\: :ref:`int`\ ) - :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`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_switch_on_hover**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_switch_on_hover**\ (\ ) If ``true``, when the cursor hovers above another **MenuButton** within the same parent which also has :ref:`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| :ref:`🔗` 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**\ (\ disabled\: :ref:`bool`\ ) :ref:`🔗` 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**\ (\ ) :ref:`🔗` Adjusts popup position and sizing for the **MenuButton**, then shows the :ref:`PopupMenu`. Prefer this over using ``get_popup().popup()``. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`