class_menubar.rst 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MenuBar.xml.
  6. .. _class_MenuBar:
  7. MenuBar
  8. =======
  9. **Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. A horizontal menu bar that creates a menu for each :ref:`PopupMenu<class_PopupMenu>` child.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. A horizontal menu bar that creates a menu for each :ref:`PopupMenu<class_PopupMenu>` child. New items are created by adding :ref:`PopupMenu<class_PopupMenu>`\ s to this node. Item title is determined by :ref:`Window.title<class_Window_property_title>`, or node name if :ref:`Window.title<class_Window_property_title>` is empty. Item title can be overridden using :ref:`set_menu_title()<class_MenuBar_method_set_menu_title>`.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+
  21. | :ref:`bool<class_bool>` | :ref:`flat<class_MenuBar_property_flat>` | ``false`` |
  22. +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+
  23. | :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``3`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
  24. +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+
  25. | :ref:`String<class_String>` | :ref:`language<class_MenuBar_property_language>` | ``""`` |
  26. +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+
  27. | :ref:`bool<class_bool>` | :ref:`prefer_global_menu<class_MenuBar_property_prefer_global_menu>` | ``true`` |
  28. +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+
  29. | :ref:`int<class_int>` | :ref:`start_index<class_MenuBar_property_start_index>` | ``-1`` |
  30. +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+
  31. | :ref:`bool<class_bool>` | :ref:`switch_on_hover<class_MenuBar_property_switch_on_hover>` | ``true`` |
  32. +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+
  33. | :ref:`TextDirection<enum_Control_TextDirection>` | :ref:`text_direction<class_MenuBar_property_text_direction>` | ``0`` |
  34. +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+
  35. .. rst-class:: classref-reftable-group
  36. Methods
  37. -------
  38. .. table::
  39. :widths: auto
  40. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`int<class_int>` | :ref:`get_menu_count<class_MenuBar_method_get_menu_count>`\ (\ ) |const| |
  42. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`PopupMenu<class_PopupMenu>` | :ref:`get_menu_popup<class_MenuBar_method_get_menu_popup>`\ (\ menu\: :ref:`int<class_int>`\ ) |const| |
  44. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`String<class_String>` | :ref:`get_menu_title<class_MenuBar_method_get_menu_title>`\ (\ menu\: :ref:`int<class_int>`\ ) |const| |
  46. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`String<class_String>` | :ref:`get_menu_tooltip<class_MenuBar_method_get_menu_tooltip>`\ (\ menu\: :ref:`int<class_int>`\ ) |const| |
  48. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`bool<class_bool>` | :ref:`is_menu_disabled<class_MenuBar_method_is_menu_disabled>`\ (\ menu\: :ref:`int<class_int>`\ ) |const| |
  50. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`bool<class_bool>` | :ref:`is_menu_hidden<class_MenuBar_method_is_menu_hidden>`\ (\ menu\: :ref:`int<class_int>`\ ) |const| |
  52. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`bool<class_bool>` | :ref:`is_native_menu<class_MenuBar_method_is_native_menu>`\ (\ ) |const| |
  54. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  55. | |void| | :ref:`set_disable_shortcuts<class_MenuBar_method_set_disable_shortcuts>`\ (\ disabled\: :ref:`bool<class_bool>`\ ) |
  56. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  57. | |void| | :ref:`set_menu_disabled<class_MenuBar_method_set_menu_disabled>`\ (\ menu\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) |
  58. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  59. | |void| | :ref:`set_menu_hidden<class_MenuBar_method_set_menu_hidden>`\ (\ menu\: :ref:`int<class_int>`, hidden\: :ref:`bool<class_bool>`\ ) |
  60. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  61. | |void| | :ref:`set_menu_title<class_MenuBar_method_set_menu_title>`\ (\ menu\: :ref:`int<class_int>`, title\: :ref:`String<class_String>`\ ) |
  62. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  63. | |void| | :ref:`set_menu_tooltip<class_MenuBar_method_set_menu_tooltip>`\ (\ menu\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) |
  64. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  65. .. rst-class:: classref-reftable-group
  66. Theme Properties
  67. ----------------
  68. .. table::
  69. :widths: auto
  70. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  71. | :ref:`Color<class_Color>` | :ref:`font_color<class_MenuBar_theme_color_font_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
  72. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  73. | :ref:`Color<class_Color>` | :ref:`font_disabled_color<class_MenuBar_theme_color_font_disabled_color>` | ``Color(0.875, 0.875, 0.875, 0.5)`` |
  74. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  75. | :ref:`Color<class_Color>` | :ref:`font_focus_color<class_MenuBar_theme_color_font_focus_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
  76. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  77. | :ref:`Color<class_Color>` | :ref:`font_hover_color<class_MenuBar_theme_color_font_hover_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
  78. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  79. | :ref:`Color<class_Color>` | :ref:`font_hover_pressed_color<class_MenuBar_theme_color_font_hover_pressed_color>` | ``Color(1, 1, 1, 1)`` |
  80. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  81. | :ref:`Color<class_Color>` | :ref:`font_outline_color<class_MenuBar_theme_color_font_outline_color>` | ``Color(0, 0, 0, 1)`` |
  82. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  83. | :ref:`Color<class_Color>` | :ref:`font_pressed_color<class_MenuBar_theme_color_font_pressed_color>` | ``Color(1, 1, 1, 1)`` |
  84. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  85. | :ref:`int<class_int>` | :ref:`h_separation<class_MenuBar_theme_constant_h_separation>` | ``4`` |
  86. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  87. | :ref:`int<class_int>` | :ref:`outline_size<class_MenuBar_theme_constant_outline_size>` | ``0`` |
  88. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  89. | :ref:`Font<class_Font>` | :ref:`font<class_MenuBar_theme_font_font>` | |
  90. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  91. | :ref:`int<class_int>` | :ref:`font_size<class_MenuBar_theme_font_size_font_size>` | |
  92. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  93. | :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_MenuBar_theme_style_disabled>` | |
  94. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  95. | :ref:`StyleBox<class_StyleBox>` | :ref:`disabled_mirrored<class_MenuBar_theme_style_disabled_mirrored>` | |
  96. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  97. | :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_MenuBar_theme_style_hover>` | |
  98. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  99. | :ref:`StyleBox<class_StyleBox>` | :ref:`hover_mirrored<class_MenuBar_theme_style_hover_mirrored>` | |
  100. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  101. | :ref:`StyleBox<class_StyleBox>` | :ref:`hover_pressed<class_MenuBar_theme_style_hover_pressed>` | |
  102. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  103. | :ref:`StyleBox<class_StyleBox>` | :ref:`hover_pressed_mirrored<class_MenuBar_theme_style_hover_pressed_mirrored>` | |
  104. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  105. | :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_MenuBar_theme_style_normal>` | |
  106. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  107. | :ref:`StyleBox<class_StyleBox>` | :ref:`normal_mirrored<class_MenuBar_theme_style_normal_mirrored>` | |
  108. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  109. | :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_MenuBar_theme_style_pressed>` | |
  110. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  111. | :ref:`StyleBox<class_StyleBox>` | :ref:`pressed_mirrored<class_MenuBar_theme_style_pressed_mirrored>` | |
  112. +---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
  113. .. rst-class:: classref-section-separator
  114. ----
  115. .. rst-class:: classref-descriptions-group
  116. Property Descriptions
  117. ---------------------
  118. .. _class_MenuBar_property_flat:
  119. .. rst-class:: classref-property
  120. :ref:`bool<class_bool>` **flat** = ``false`` :ref:`🔗<class_MenuBar_property_flat>`
  121. .. rst-class:: classref-property-setget
  122. - |void| **set_flat**\ (\ value\: :ref:`bool<class_bool>`\ )
  123. - :ref:`bool<class_bool>` **is_flat**\ (\ )
  124. Flat **MenuBar** don't display item decoration.
  125. .. rst-class:: classref-item-separator
  126. ----
  127. .. _class_MenuBar_property_language:
  128. .. rst-class:: classref-property
  129. :ref:`String<class_String>` **language** = ``""`` :ref:`🔗<class_MenuBar_property_language>`
  130. .. rst-class:: classref-property-setget
  131. - |void| **set_language**\ (\ value\: :ref:`String<class_String>`\ )
  132. - :ref:`String<class_String>` **get_language**\ (\ )
  133. Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
  134. .. rst-class:: classref-item-separator
  135. ----
  136. .. _class_MenuBar_property_prefer_global_menu:
  137. .. rst-class:: classref-property
  138. :ref:`bool<class_bool>` **prefer_global_menu** = ``true`` :ref:`🔗<class_MenuBar_property_prefer_global_menu>`
  139. .. rst-class:: classref-property-setget
  140. - |void| **set_prefer_global_menu**\ (\ value\: :ref:`bool<class_bool>`\ )
  141. - :ref:`bool<class_bool>` **is_prefer_global_menu**\ (\ )
  142. If ``true``, **MenuBar** will use system global menu when supported.
  143. \ **Note:** If ``true`` and global menu is supported, this node is not displayed, has zero size, and all its child nodes except :ref:`PopupMenu<class_PopupMenu>`\ s are inaccessible.
  144. \ **Note:** This property overrides the value of the :ref:`PopupMenu.prefer_native_menu<class_PopupMenu_property_prefer_native_menu>` property of the child nodes.
  145. .. rst-class:: classref-item-separator
  146. ----
  147. .. _class_MenuBar_property_start_index:
  148. .. rst-class:: classref-property
  149. :ref:`int<class_int>` **start_index** = ``-1`` :ref:`🔗<class_MenuBar_property_start_index>`
  150. .. rst-class:: classref-property-setget
  151. - |void| **set_start_index**\ (\ value\: :ref:`int<class_int>`\ )
  152. - :ref:`int<class_int>` **get_start_index**\ (\ )
  153. Position order in the global menu to insert **MenuBar** items at. All menu items in the **MenuBar** are always inserted as a continuous range. Menus with lower :ref:`start_index<class_MenuBar_property_start_index>` are inserted first. Menus with :ref:`start_index<class_MenuBar_property_start_index>` equal to ``-1`` are inserted last.
  154. .. rst-class:: classref-item-separator
  155. ----
  156. .. _class_MenuBar_property_switch_on_hover:
  157. .. rst-class:: classref-property
  158. :ref:`bool<class_bool>` **switch_on_hover** = ``true`` :ref:`🔗<class_MenuBar_property_switch_on_hover>`
  159. .. rst-class:: classref-property-setget
  160. - |void| **set_switch_on_hover**\ (\ value\: :ref:`bool<class_bool>`\ )
  161. - :ref:`bool<class_bool>` **is_switch_on_hover**\ (\ )
  162. If ``true``, when the cursor hovers above menu item, it will close the current :ref:`PopupMenu<class_PopupMenu>` and open the other one.
  163. .. rst-class:: classref-item-separator
  164. ----
  165. .. _class_MenuBar_property_text_direction:
  166. .. rst-class:: classref-property
  167. :ref:`TextDirection<enum_Control_TextDirection>` **text_direction** = ``0`` :ref:`🔗<class_MenuBar_property_text_direction>`
  168. .. rst-class:: classref-property-setget
  169. - |void| **set_text_direction**\ (\ value\: :ref:`TextDirection<enum_Control_TextDirection>`\ )
  170. - :ref:`TextDirection<enum_Control_TextDirection>` **get_text_direction**\ (\ )
  171. Base text writing direction.
  172. .. rst-class:: classref-section-separator
  173. ----
  174. .. rst-class:: classref-descriptions-group
  175. Method Descriptions
  176. -------------------
  177. .. _class_MenuBar_method_get_menu_count:
  178. .. rst-class:: classref-method
  179. :ref:`int<class_int>` **get_menu_count**\ (\ ) |const| :ref:`🔗<class_MenuBar_method_get_menu_count>`
  180. Returns number of menu items.
  181. .. rst-class:: classref-item-separator
  182. ----
  183. .. _class_MenuBar_method_get_menu_popup:
  184. .. rst-class:: classref-method
  185. :ref:`PopupMenu<class_PopupMenu>` **get_menu_popup**\ (\ menu\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_MenuBar_method_get_menu_popup>`
  186. Returns :ref:`PopupMenu<class_PopupMenu>` associated with menu item.
  187. .. rst-class:: classref-item-separator
  188. ----
  189. .. _class_MenuBar_method_get_menu_title:
  190. .. rst-class:: classref-method
  191. :ref:`String<class_String>` **get_menu_title**\ (\ menu\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_MenuBar_method_get_menu_title>`
  192. Returns menu item title.
  193. .. rst-class:: classref-item-separator
  194. ----
  195. .. _class_MenuBar_method_get_menu_tooltip:
  196. .. rst-class:: classref-method
  197. :ref:`String<class_String>` **get_menu_tooltip**\ (\ menu\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_MenuBar_method_get_menu_tooltip>`
  198. Returns menu item tooltip.
  199. .. rst-class:: classref-item-separator
  200. ----
  201. .. _class_MenuBar_method_is_menu_disabled:
  202. .. rst-class:: classref-method
  203. :ref:`bool<class_bool>` **is_menu_disabled**\ (\ menu\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_MenuBar_method_is_menu_disabled>`
  204. Returns ``true``, if menu item is disabled.
  205. .. rst-class:: classref-item-separator
  206. ----
  207. .. _class_MenuBar_method_is_menu_hidden:
  208. .. rst-class:: classref-method
  209. :ref:`bool<class_bool>` **is_menu_hidden**\ (\ menu\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_MenuBar_method_is_menu_hidden>`
  210. Returns ``true``, if menu item is hidden.
  211. .. rst-class:: classref-item-separator
  212. ----
  213. .. _class_MenuBar_method_is_native_menu:
  214. .. rst-class:: classref-method
  215. :ref:`bool<class_bool>` **is_native_menu**\ (\ ) |const| :ref:`🔗<class_MenuBar_method_is_native_menu>`
  216. Returns ``true``, if system global menu is supported and used by this **MenuBar**.
  217. .. rst-class:: classref-item-separator
  218. ----
  219. .. _class_MenuBar_method_set_disable_shortcuts:
  220. .. rst-class:: classref-method
  221. |void| **set_disable_shortcuts**\ (\ disabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_MenuBar_method_set_disable_shortcuts>`
  222. If ``true``, shortcuts are disabled and cannot be used to trigger the button.
  223. .. rst-class:: classref-item-separator
  224. ----
  225. .. _class_MenuBar_method_set_menu_disabled:
  226. .. rst-class:: classref-method
  227. |void| **set_menu_disabled**\ (\ menu\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_MenuBar_method_set_menu_disabled>`
  228. If ``true``, menu item is disabled.
  229. .. rst-class:: classref-item-separator
  230. ----
  231. .. _class_MenuBar_method_set_menu_hidden:
  232. .. rst-class:: classref-method
  233. |void| **set_menu_hidden**\ (\ menu\: :ref:`int<class_int>`, hidden\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_MenuBar_method_set_menu_hidden>`
  234. If ``true``, menu item is hidden.
  235. .. rst-class:: classref-item-separator
  236. ----
  237. .. _class_MenuBar_method_set_menu_title:
  238. .. rst-class:: classref-method
  239. |void| **set_menu_title**\ (\ menu\: :ref:`int<class_int>`, title\: :ref:`String<class_String>`\ ) :ref:`🔗<class_MenuBar_method_set_menu_title>`
  240. Sets menu item title.
  241. .. rst-class:: classref-item-separator
  242. ----
  243. .. _class_MenuBar_method_set_menu_tooltip:
  244. .. rst-class:: classref-method
  245. |void| **set_menu_tooltip**\ (\ menu\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`🔗<class_MenuBar_method_set_menu_tooltip>`
  246. Sets menu item tooltip.
  247. .. rst-class:: classref-section-separator
  248. ----
  249. .. rst-class:: classref-descriptions-group
  250. Theme Property Descriptions
  251. ---------------------------
  252. .. _class_MenuBar_theme_color_font_color:
  253. .. rst-class:: classref-themeproperty
  254. :ref:`Color<class_Color>` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗<class_MenuBar_theme_color_font_color>`
  255. Default text :ref:`Color<class_Color>` of the menu item.
  256. .. rst-class:: classref-item-separator
  257. ----
  258. .. _class_MenuBar_theme_color_font_disabled_color:
  259. .. rst-class:: classref-themeproperty
  260. :ref:`Color<class_Color>` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗<class_MenuBar_theme_color_font_disabled_color>`
  261. Text :ref:`Color<class_Color>` used when the menu item is disabled.
  262. .. rst-class:: classref-item-separator
  263. ----
  264. .. _class_MenuBar_theme_color_font_focus_color:
  265. .. rst-class:: classref-themeproperty
  266. :ref:`Color<class_Color>` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗<class_MenuBar_theme_color_font_focus_color>`
  267. Text :ref:`Color<class_Color>` used when the menu item is focused. Only replaces the normal text color of the menu item. Disabled, hovered, and pressed states take precedence over this color.
  268. .. rst-class:: classref-item-separator
  269. ----
  270. .. _class_MenuBar_theme_color_font_hover_color:
  271. .. rst-class:: classref-themeproperty
  272. :ref:`Color<class_Color>` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗<class_MenuBar_theme_color_font_hover_color>`
  273. Text :ref:`Color<class_Color>` used when the menu item is being hovered.
  274. .. rst-class:: classref-item-separator
  275. ----
  276. .. _class_MenuBar_theme_color_font_hover_pressed_color:
  277. .. rst-class:: classref-themeproperty
  278. :ref:`Color<class_Color>` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_MenuBar_theme_color_font_hover_pressed_color>`
  279. Text :ref:`Color<class_Color>` used when the menu item is being hovered and pressed.
  280. .. rst-class:: classref-item-separator
  281. ----
  282. .. _class_MenuBar_theme_color_font_outline_color:
  283. .. rst-class:: classref-themeproperty
  284. :ref:`Color<class_Color>` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗<class_MenuBar_theme_color_font_outline_color>`
  285. The tint of text outline of the menu item.
  286. .. rst-class:: classref-item-separator
  287. ----
  288. .. _class_MenuBar_theme_color_font_pressed_color:
  289. .. rst-class:: classref-themeproperty
  290. :ref:`Color<class_Color>` **font_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_MenuBar_theme_color_font_pressed_color>`
  291. Text :ref:`Color<class_Color>` used when the menu item is being pressed.
  292. .. rst-class:: classref-item-separator
  293. ----
  294. .. _class_MenuBar_theme_constant_h_separation:
  295. .. rst-class:: classref-themeproperty
  296. :ref:`int<class_int>` **h_separation** = ``4`` :ref:`🔗<class_MenuBar_theme_constant_h_separation>`
  297. The horizontal space between menu items.
  298. .. rst-class:: classref-item-separator
  299. ----
  300. .. _class_MenuBar_theme_constant_outline_size:
  301. .. rst-class:: classref-themeproperty
  302. :ref:`int<class_int>` **outline_size** = ``0`` :ref:`🔗<class_MenuBar_theme_constant_outline_size>`
  303. The size of the text outline.
  304. \ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field<class_FontFile_property_multichannel_signed_distance_field>` enabled, its :ref:`FontFile.msdf_pixel_range<class_FontFile_property_msdf_pixel_range>` must be set to at least *twice* the value of :ref:`outline_size<class_MenuBar_theme_constant_outline_size>` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
  305. .. rst-class:: classref-item-separator
  306. ----
  307. .. _class_MenuBar_theme_font_font:
  308. .. rst-class:: classref-themeproperty
  309. :ref:`Font<class_Font>` **font** :ref:`🔗<class_MenuBar_theme_font_font>`
  310. :ref:`Font<class_Font>` of the menu item's text.
  311. .. rst-class:: classref-item-separator
  312. ----
  313. .. _class_MenuBar_theme_font_size_font_size:
  314. .. rst-class:: classref-themeproperty
  315. :ref:`int<class_int>` **font_size** :ref:`🔗<class_MenuBar_theme_font_size_font_size>`
  316. Font size of the menu item's text.
  317. .. rst-class:: classref-item-separator
  318. ----
  319. .. _class_MenuBar_theme_style_disabled:
  320. .. rst-class:: classref-themeproperty
  321. :ref:`StyleBox<class_StyleBox>` **disabled** :ref:`🔗<class_MenuBar_theme_style_disabled>`
  322. :ref:`StyleBox<class_StyleBox>` used when the menu item is disabled.
  323. .. rst-class:: classref-item-separator
  324. ----
  325. .. _class_MenuBar_theme_style_disabled_mirrored:
  326. .. rst-class:: classref-themeproperty
  327. :ref:`StyleBox<class_StyleBox>` **disabled_mirrored** :ref:`🔗<class_MenuBar_theme_style_disabled_mirrored>`
  328. :ref:`StyleBox<class_StyleBox>` used when the menu item is disabled (for right-to-left layouts).
  329. .. rst-class:: classref-item-separator
  330. ----
  331. .. _class_MenuBar_theme_style_hover:
  332. .. rst-class:: classref-themeproperty
  333. :ref:`StyleBox<class_StyleBox>` **hover** :ref:`🔗<class_MenuBar_theme_style_hover>`
  334. :ref:`StyleBox<class_StyleBox>` used when the menu item is being hovered.
  335. .. rst-class:: classref-item-separator
  336. ----
  337. .. _class_MenuBar_theme_style_hover_mirrored:
  338. .. rst-class:: classref-themeproperty
  339. :ref:`StyleBox<class_StyleBox>` **hover_mirrored** :ref:`🔗<class_MenuBar_theme_style_hover_mirrored>`
  340. :ref:`StyleBox<class_StyleBox>` used when the menu item is being hovered (for right-to-left layouts).
  341. .. rst-class:: classref-item-separator
  342. ----
  343. .. _class_MenuBar_theme_style_hover_pressed:
  344. .. rst-class:: classref-themeproperty
  345. :ref:`StyleBox<class_StyleBox>` **hover_pressed** :ref:`🔗<class_MenuBar_theme_style_hover_pressed>`
  346. :ref:`StyleBox<class_StyleBox>` used when the menu item is being pressed and hovered at the same time.
  347. .. rst-class:: classref-item-separator
  348. ----
  349. .. _class_MenuBar_theme_style_hover_pressed_mirrored:
  350. .. rst-class:: classref-themeproperty
  351. :ref:`StyleBox<class_StyleBox>` **hover_pressed_mirrored** :ref:`🔗<class_MenuBar_theme_style_hover_pressed_mirrored>`
  352. :ref:`StyleBox<class_StyleBox>` used when the menu item is being pressed and hovered at the same time (for right-to-left layouts).
  353. .. rst-class:: classref-item-separator
  354. ----
  355. .. _class_MenuBar_theme_style_normal:
  356. .. rst-class:: classref-themeproperty
  357. :ref:`StyleBox<class_StyleBox>` **normal** :ref:`🔗<class_MenuBar_theme_style_normal>`
  358. Default :ref:`StyleBox<class_StyleBox>` for the menu item.
  359. .. rst-class:: classref-item-separator
  360. ----
  361. .. _class_MenuBar_theme_style_normal_mirrored:
  362. .. rst-class:: classref-themeproperty
  363. :ref:`StyleBox<class_StyleBox>` **normal_mirrored** :ref:`🔗<class_MenuBar_theme_style_normal_mirrored>`
  364. Default :ref:`StyleBox<class_StyleBox>` for the menu item (for right-to-left layouts).
  365. .. rst-class:: classref-item-separator
  366. ----
  367. .. _class_MenuBar_theme_style_pressed:
  368. .. rst-class:: classref-themeproperty
  369. :ref:`StyleBox<class_StyleBox>` **pressed** :ref:`🔗<class_MenuBar_theme_style_pressed>`
  370. :ref:`StyleBox<class_StyleBox>` used when the menu item is being pressed.
  371. .. rst-class:: classref-item-separator
  372. ----
  373. .. _class_MenuBar_theme_style_pressed_mirrored:
  374. .. rst-class:: classref-themeproperty
  375. :ref:`StyleBox<class_StyleBox>` **pressed_mirrored** :ref:`🔗<class_MenuBar_theme_style_pressed_mirrored>`
  376. :ref:`StyleBox<class_StyleBox>` used when the menu item is being pressed (for right-to-left layouts).
  377. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  378. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  379. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  380. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  381. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  382. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  383. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  384. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  385. .. |void| replace:: :abbr:`void (No return value.)`