Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 9ffd5f53c4
Branches Tags
godot-docs
/
classes
/
class_menubutton.rst

class_menubutton.rst 8.5 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MenuButton.xml.
    7. 

  7. 

  8. .. _class_MenuButton:
    9. 

  9. 

  10. MenuButton
    11. 

  11. ==========
    12. 

  12. 

  13. **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>`
    14. 

  14. 

  15. A button that brings up a :ref:`PopupMenu<class_PopupMenu>` when clicked.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. A button that brings up a :ref:`PopupMenu<class_PopupMenu>` when clicked. To create new items inside this :ref:`PopupMenu<class_PopupMenu>`, use ``get_popup().add_item("My Item Name")``. You can also create them directly from Godot editor's inspector.
    23. 

  23. 

  24. See also :ref:`BaseButton<class_BaseButton>` which contains common properties and methods associated with this node.
    25. 

  25. 

  26. .. rst-class:: classref-reftable-group
    27. 

  27. 

  28. Properties
    29. 

  29. ----------
    30. 

  30. 

  31. .. table::
    32. 

  32.    :widths: auto
    33. 

  33. 

  34.    +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
    35. 

  35.    | :ref:`ActionMode<enum_BaseButton_ActionMode>` | action_mode                                                       | ``0`` (overrides :ref:`BaseButton<class_BaseButton_property_action_mode>`)    |
    36. 

  36.    +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
    37. 

  37.    | :ref:`bool<class_bool>`                       | flat                                                              | ``true`` (overrides :ref:`Button<class_Button_property_flat>`)                |
    38. 

  38.    +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
    39. 

  39.    | :ref:`FocusMode<enum_Control_FocusMode>`      | focus_mode                                                        | ``0`` (overrides :ref:`Control<class_Control_property_focus_mode>`)           |
    40. 

  40.    +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
    41. 

  41.    | :ref:`int<class_int>`                         | :ref:`item_count<class_MenuButton_property_item_count>`           | ``0``                                                                         |
    42. 

  42.    +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
    43. 

  43.    | :ref:`bool<class_bool>`                       | :ref:`switch_on_hover<class_MenuButton_property_switch_on_hover>` | ``false``                                                                     |
    44. 

  44.    +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
    45. 

  45.    | :ref:`bool<class_bool>`                       | toggle_mode                                                       | ``true`` (overrides :ref:`BaseButton<class_BaseButton_property_toggle_mode>`) |
    46. 

  46.    +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+
    47. 

  47. 

  48. .. rst-class:: classref-reftable-group
    49. 

  49. 

  50. Methods
    51. 

  51. -------
    52. 

  52. 

  53. .. table::
    54. 

  54.    :widths: auto
    55. 

  55. 

  56.    +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
    57. 

  57.    | :ref:`PopupMenu<class_PopupMenu>` | :ref:`get_popup<class_MenuButton_method_get_popup>`\ (\ ) |const|                                                     |
    58. 

  58.    +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
    59. 

  59.    | |void|                            | :ref:`set_disable_shortcuts<class_MenuButton_method_set_disable_shortcuts>`\ (\ disabled\: :ref:`bool<class_bool>`\ ) |
    60. 

  60.    +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
    61. 

  61.    | |void|                            | :ref:`show_popup<class_MenuButton_method_show_popup>`\ (\ )                                                           |
    62. 

  62.    +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------+
    63. 

  63. 

  64. .. rst-class:: classref-section-separator
    65. 

  65. 

  66. ----
    67. 

  67. 

  68. .. rst-class:: classref-descriptions-group
    69. 

  69. 

  70. Signals
    71. 

  71. -------
    72. 

  72. 

  73. .. _class_MenuButton_signal_about_to_popup:
    74. 

  74. 

  75. .. rst-class:: classref-signal
    76. 

  76. 

  77. **about_to_popup**\ (\ ) :ref:`🔗<class_MenuButton_signal_about_to_popup>`
    78. 

  78. 

  79. Emitted when the :ref:`PopupMenu<class_PopupMenu>` of this MenuButton is about to show.
    80. 

  80. 

  81. .. rst-class:: classref-section-separator
    82. 

  82. 

  83. ----
    84. 

  84. 

  85. .. rst-class:: classref-descriptions-group
    86. 

  86. 

  87. Property Descriptions
    88. 

  88. ---------------------
    89. 

  89. 

  90. .. _class_MenuButton_property_item_count:
    91. 

  91. 

  92. .. rst-class:: classref-property
    93. 

  93. 

  94. :ref:`int<class_int>` **item_count** = ``0`` :ref:`🔗<class_MenuButton_property_item_count>`
    95. 

  95. 

  96. .. rst-class:: classref-property-setget
    97. 

  97. 

  98. - |void| **set_item_count**\ (\ value\: :ref:`int<class_int>`\ )
    99. 

  99. - :ref:`int<class_int>` **get_item_count**\ (\ )
    100. 

  100. 

  101. The number of items currently in the list.
    102. 

  102. 

  103. .. rst-class:: classref-item-separator
    104. 

  104. 

  105. ----
    106. 

  106. 

  107. .. _class_MenuButton_property_switch_on_hover:
    108. 

  108. 

  109. .. rst-class:: classref-property
    110. 

  110. 

  111. :ref:`bool<class_bool>` **switch_on_hover** = ``false`` :ref:`🔗<class_MenuButton_property_switch_on_hover>`
    112. 

  112. 

  113. .. rst-class:: classref-property-setget
    114. 

  114. 

  115. - |void| **set_switch_on_hover**\ (\ value\: :ref:`bool<class_bool>`\ )
    116. 

  116. - :ref:`bool<class_bool>` **is_switch_on_hover**\ (\ )
    117. 

  117. 

  118. If ``true``, when the cursor hovers above another **MenuButton** within the same parent which also has :ref:`switch_on_hover<class_MenuButton_property_switch_on_hover>` enabled, it will close the current **MenuButton** and open the other one.
    119. 

  119. 

  120. .. rst-class:: classref-section-separator
    121. 

  121. 

  122. ----
    123. 

  123. 

  124. .. rst-class:: classref-descriptions-group
    125. 

  125. 

  126. Method Descriptions
    127. 

  127. -------------------
    128. 

  128. 

  129. .. _class_MenuButton_method_get_popup:
    130. 

  130. 

  131. .. rst-class:: classref-method
    132. 

  132. 

  133. :ref:`PopupMenu<class_PopupMenu>` **get_popup**\ (\ ) |const| :ref:`🔗<class_MenuButton_method_get_popup>`
    134. 

  134. 

  135. Returns the :ref:`PopupMenu<class_PopupMenu>` contained in this button.
    136. 

  136. 

  137. \ **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<class_Window_property_visible>` property.
    138. 

  138. 

  139. .. rst-class:: classref-item-separator
    140. 

  140. 

  141. ----
    142. 

  142. 

  143. .. _class_MenuButton_method_set_disable_shortcuts:
    144. 

  144. 

  145. .. rst-class:: classref-method
    146. 

  146. 

  147. |void| **set_disable_shortcuts**\ (\ disabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_MenuButton_method_set_disable_shortcuts>`
    148. 

  148. 

  149. If ``true``, shortcuts are disabled and cannot be used to trigger the button.
    150. 

  150. 

  151. .. rst-class:: classref-item-separator
    152. 

  152. 

  153. ----
    154. 

  154. 

  155. .. _class_MenuButton_method_show_popup:
    156. 

  156. 

  157. .. rst-class:: classref-method
    158. 

  158. 

  159. |void| **show_popup**\ (\ ) :ref:`🔗<class_MenuButton_method_show_popup>`
    160. 

  160. 

  161. Adjusts popup position and sizing for the **MenuButton**, then shows the :ref:`PopupMenu<class_PopupMenu>`. Prefer this over using ``get_popup().popup()``.
    162. 

  162. 

  163. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    164. 

  164. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    165. 

  165. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    166. 

  166. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    167. 

  167. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    168. 

  168. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    169. 

  169. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    170. 

  170. .. |void| replace:: :abbr:`void (No return value.)`
    171. 

  171.