Files
godot-docs/classes/class_menubutton.rst
Rémi Verschelde ab3f908221 classref: Add property overview and setter/getter like in editor docs
Output from godotengine/godot#22013.
Fixes #1729.
2018-09-13 11:06:52 +02:00

82 lines
4.4 KiB
ReStructuredText

.. 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.
Methods
-------
+------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`PopupMenu<class_PopupMenu>` | :ref:`get_popup<class_MenuButton_get_popup>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_disable_shortcuts<class_MenuButton_set_disable_shortcuts>` **(** :ref:`bool<class_bool>` disabled **)** |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------+
Theme Properties
----------------
+---------------------------------+------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_MenuButton_disabled>` |
+---------------------------------+------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_MenuButton_focus>` |
+---------------------------------+------------------------------------------------------------------+
| :ref:`Font<class_Font>` | :ref:`font<class_MenuButton_font>` |
+---------------------------------+------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color<class_MenuButton_font_color>` |
+---------------------------------+------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_MenuButton_font_color_disabled>` |
+---------------------------------+------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color_hover<class_MenuButton_font_color_hover>` |
+---------------------------------+------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_MenuButton_font_color_pressed>` |
+---------------------------------+------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_MenuButton_hover>` |
+---------------------------------+------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`hseparation<class_MenuButton_hseparation>` |
+---------------------------------+------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_MenuButton_normal>` |
+---------------------------------+------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_MenuButton_pressed>` |
+---------------------------------+------------------------------------------------------------------+
Signals
-------
.. _class_MenuButton_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.
Method Descriptions
-------------------
.. _class_MenuButton_get_popup:
- :ref:`PopupMenu<class_PopupMenu>` **get_popup** **(** **)** const
Return the :ref:`PopupMenu<class_PopupMenu>` contained in this button.
.. _class_MenuButton_set_disable_shortcuts:
- void **set_disable_shortcuts** **(** :ref:`bool<class_bool>` disabled **)**