: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>`

**Category:** Core

Brief Description
-----------------

Special button that brings up a :ref:`PopupMenu<class_PopupMenu>` when clicked.

Properties
----------

+-------------------------+-------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`switch_on_hover<class_MenuButton_property_switch_on_hover>` |
+-------------------------+-------------------------------------------------------------------+

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          |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>`       | font_color_disabled |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>`       | font_color_hover    |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>`       | font_color_pressed  |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | hover               |
+---------------------------------+---------------------+
| :ref:`int<class_int>`           | hseparation         |
+---------------------------------+---------------------+
| :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.

Description
-----------

Special button that brings up a :ref:`PopupMenu<class_PopupMenu>` when clicked. That's pretty much all it does, as it's just a helper class when building GUIs.

Property Descriptions
---------------------

.. _class_MenuButton_property_switch_on_hover:

- :ref:`bool<class_bool>` **switch_on_hover**

+----------+----------------------------+
| *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 **)**