godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4.0
godot-docs/classes/class_menubar.rst
Godot Organization c39e8f8635 classref: Sync with current 4.0 branch (cfedb0a)
2023-07-24 10:19:37 +00:00

583 lines
24 KiB
ReStructuredText
Raw Permalink Blame History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/MenuBar.xml.
.. _class_MenuBar:
MenuBar
=======
**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
A horizontal menu bar that creates a :ref:`MenuButton<class_MenuButton>` for each :ref:`PopupMenu<class_PopupMenu>` child.
.. rst-class:: classref-introduction-group
Description
-----------
A horizontal menu bar that creates a :ref:`MenuButton<class_MenuButton>` for each :ref:`PopupMenu<class_PopupMenu>` child. New items are created by adding :ref:`PopupMenu<class_PopupMenu>`\ s to this node.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+--------------------------------------------------+----------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`flat<class_MenuBar_property_flat>` | ``false`` |
+--------------------------------------------------+----------------------------------------------------------------------+-----------+
| :ref:`String<class_String>` | :ref:`language<class_MenuBar_property_language>` | ``""`` |
+--------------------------------------------------+----------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`prefer_global_menu<class_MenuBar_property_prefer_global_menu>` | ``true`` |
+--------------------------------------------------+----------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`start_index<class_MenuBar_property_start_index>` | ``-1`` |
+--------------------------------------------------+----------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`switch_on_hover<class_MenuBar_property_switch_on_hover>` | ``true`` |
+--------------------------------------------------+----------------------------------------------------------------------+-----------+
| :ref:`TextDirection<enum_Control_TextDirection>` | :ref:`text_direction<class_MenuBar_property_text_direction>` | ``0`` |
+--------------------------------------------------+----------------------------------------------------------------------+-----------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_menu_count<class_MenuBar_method_get_menu_count>` **(** **)** |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PopupMenu<class_PopupMenu>` | :ref:`get_menu_popup<class_MenuBar_method_get_menu_popup>` **(** :ref:`int<class_int>` menu **)** |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_menu_title<class_MenuBar_method_get_menu_title>` **(** :ref:`int<class_int>` menu **)** |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_menu_tooltip<class_MenuBar_method_get_menu_tooltip>` **(** :ref:`int<class_int>` menu **)** |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_menu_disabled<class_MenuBar_method_is_menu_disabled>` **(** :ref:`int<class_int>` menu **)** |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_menu_hidden<class_MenuBar_method_is_menu_hidden>` **(** :ref:`int<class_int>` menu **)** |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_native_menu<class_MenuBar_method_is_native_menu>` **(** **)** |const| |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_disable_shortcuts<class_MenuBar_method_set_disable_shortcuts>` **(** :ref:`bool<class_bool>` disabled **)** |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_menu_disabled<class_MenuBar_method_set_menu_disabled>` **(** :ref:`int<class_int>` menu, :ref:`bool<class_bool>` disabled **)** |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_menu_hidden<class_MenuBar_method_set_menu_hidden>` **(** :ref:`int<class_int>` menu, :ref:`bool<class_bool>` hidden **)** |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_menu_title<class_MenuBar_method_set_menu_title>` **(** :ref:`int<class_int>` menu, :ref:`String<class_String>` title **)** |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_menu_tooltip<class_MenuBar_method_set_menu_tooltip>` **(** :ref:`int<class_int>` menu, :ref:`String<class_String>` tooltip **)** |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Theme Properties
----------------
.. table::
:widths: auto
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color<class_MenuBar_theme_color_font_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_disabled_color<class_MenuBar_theme_color_font_disabled_color>` | ``Color(0.875, 0.875, 0.875, 0.5)`` |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_focus_color<class_MenuBar_theme_color_font_focus_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_hover_color<class_MenuBar_theme_color_font_hover_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_hover_pressed_color<class_MenuBar_theme_color_font_hover_pressed_color>` | ``Color(1, 1, 1, 1)`` |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_outline_color<class_MenuBar_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_pressed_color<class_MenuBar_theme_color_font_pressed_color>` | ``Color(1, 1, 1, 1)`` |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`h_separation<class_MenuBar_theme_constant_h_separation>` | ``4`` |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`outline_size<class_MenuBar_theme_constant_outline_size>` | ``0`` |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Font<class_Font>` | :ref:`font<class_MenuBar_theme_font_font>` | |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`font_size<class_MenuBar_theme_font_size_font_size>` | |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_MenuBar_theme_style_disabled>` | |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_MenuBar_theme_style_focus>` | |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_MenuBar_theme_style_hover>` | |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_MenuBar_theme_style_normal>` | |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_MenuBar_theme_style_pressed>` | |
+---------------------------------+-------------------------------------------------------------------------------------+-------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_MenuBar_property_flat:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **flat** = ``false``
.. rst-class:: classref-property-setget
- void **set_flat** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_flat** **(** **)**
Flat **MenuBar** don't display item decoration.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_property_language:
.. rst-class:: classref-property
:ref:`String<class_String>` **language** = ``""``
.. rst-class:: classref-property-setget
- void **set_language** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_language** **(** **)**
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_property_prefer_global_menu:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **prefer_global_menu** = ``true``
.. rst-class:: classref-property-setget
- void **set_prefer_global_menu** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_prefer_global_menu** **(** **)**
If ``true``, **MenuBar** will use system global menu when supported.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_property_start_index:
.. rst-class:: classref-property
:ref:`int<class_int>` **start_index** = ``-1``
.. rst-class:: classref-property-setget
- void **set_start_index** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_start_index** **(** **)**
Position in the global menu to insert first **MenuBar** item at.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_property_switch_on_hover:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **switch_on_hover** = ``true``
.. rst-class:: classref-property-setget
- void **set_switch_on_hover** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_switch_on_hover** **(** **)**
If ``true``, when the cursor hovers above menu item, it will close the current :ref:`PopupMenu<class_PopupMenu>` and open the other one.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_property_text_direction:
.. rst-class:: classref-property
:ref:`TextDirection<enum_Control_TextDirection>` **text_direction** = ``0``
.. rst-class:: classref-property-setget
- void **set_text_direction** **(** :ref:`TextDirection<enum_Control_TextDirection>` value **)**
- :ref:`TextDirection<enum_Control_TextDirection>` **get_text_direction** **(** **)**
Base text writing direction.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_MenuBar_method_get_menu_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_menu_count** **(** **)** |const|
Returns number of menu items.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_method_get_menu_popup:
.. rst-class:: classref-method
:ref:`PopupMenu<class_PopupMenu>` **get_menu_popup** **(** :ref:`int<class_int>` menu **)** |const|
Returns :ref:`PopupMenu<class_PopupMenu>` associated with menu item.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_method_get_menu_title:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_menu_title** **(** :ref:`int<class_int>` menu **)** |const|
Returns menu item title.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_method_get_menu_tooltip:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_menu_tooltip** **(** :ref:`int<class_int>` menu **)** |const|
Returns menu item tooltip.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_method_is_menu_disabled:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_menu_disabled** **(** :ref:`int<class_int>` menu **)** |const|
Returns ``true``, if menu item is disabled.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_method_is_menu_hidden:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_menu_hidden** **(** :ref:`int<class_int>` menu **)** |const|
Returns ``true``, if menu item is hidden.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_method_is_native_menu:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_native_menu** **(** **)** |const|
Returns ``true``, if system global menu is supported and used by this **MenuBar**.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_method_set_disable_shortcuts:
.. rst-class:: classref-method
void **set_disable_shortcuts** **(** :ref:`bool<class_bool>` disabled **)**
If ``true``, shortcuts are disabled and cannot be used to trigger the button.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_method_set_menu_disabled:
.. rst-class:: classref-method
void **set_menu_disabled** **(** :ref:`int<class_int>` menu, :ref:`bool<class_bool>` disabled **)**
If ``true``, menu item is disabled.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_method_set_menu_hidden:
.. rst-class:: classref-method
void **set_menu_hidden** **(** :ref:`int<class_int>` menu, :ref:`bool<class_bool>` hidden **)**
If ``true``, menu item is hidden.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_method_set_menu_title:
.. rst-class:: classref-method
void **set_menu_title** **(** :ref:`int<class_int>` menu, :ref:`String<class_String>` title **)**
Sets menu item title.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_method_set_menu_tooltip:
.. rst-class:: classref-method
void **set_menu_tooltip** **(** :ref:`int<class_int>` menu, :ref:`String<class_String>` tooltip **)**
Sets menu item tooltip.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Theme Property Descriptions
---------------------------
.. _class_MenuBar_theme_color_font_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_color** = ``Color(0.875, 0.875, 0.875, 1)``
Default text :ref:`Color<class_Color>` of the menu item.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_color_font_disabled_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)``
Text :ref:`Color<class_Color>` used when the menu item is disabled.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_color_font_focus_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)``
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.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_color_font_hover_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)``
Text :ref:`Color<class_Color>` used when the menu item is being hovered.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_color_font_hover_pressed_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)``
Text :ref:`Color<class_Color>` used when the menu item is being hovered and pressed.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_color_font_outline_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_outline_color** = ``Color(1, 1, 1, 1)``
The tint of text outline of the menu item.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_color_font_pressed_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_pressed_color** = ``Color(1, 1, 1, 1)``
Text :ref:`Color<class_Color>` used when the menu item is being pressed.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_constant_h_separation:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **h_separation** = ``4``
The horizontal space between menu items.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_constant_outline_size:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **outline_size** = ``0``
The size of the text outline.
\ **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.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_font_font:
.. rst-class:: classref-themeproperty
:ref:`Font<class_Font>` **font**
:ref:`Font<class_Font>` of the menu item's text.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_font_size_font_size:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **font_size**
Font size of the menu item's text.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_style_disabled:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **disabled**
:ref:`StyleBox<class_StyleBox>` used when the menu item is disabled.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_style_focus:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **focus**
:ref:`StyleBox<class_StyleBox>` used when the menu item is focused. The ``focus`` :ref:`StyleBox<class_StyleBox>` is displayed *over* the base :ref:`StyleBox<class_StyleBox>`, so a partially transparent :ref:`StyleBox<class_StyleBox>` should be used to ensure the base :ref:`StyleBox<class_StyleBox>` remains visible. A :ref:`StyleBox<class_StyleBox>` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_style_hover:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **hover**
:ref:`StyleBox<class_StyleBox>` used when the menu item is being hovered.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_style_normal:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **normal**
Default :ref:`StyleBox<class_StyleBox>` for the menu item.
.. rst-class:: classref-item-separator
----
.. _class_MenuBar_theme_style_pressed:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **pressed**
:ref:`StyleBox<class_StyleBox>` used when the menu item is being pressed.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |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.)`
Reference in New Issue View Git Blame Copy Permalink