godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (4c3dc26)

Browse Source
This commit is contained in:
Godot Organization
2023-09-28 11:42:41 +00:00
parent 5f8512fc20
commit ec62d34434
75 changed files with 2739 additions and 3244 deletions
Download Patch File Download Diff File Expand all files Collapse all files

227
classes/class_menubutton.rst
View File

@@ -61,46 +61,6 @@ Methods
| void | :ref:`show_popup<class_MenuButton_method_show_popup>` **(** **)** |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Theme Properties
----------------
.. table::
:widths: auto
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color<class_MenuButton_theme_color_font_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_disabled_color<class_MenuButton_theme_color_font_disabled_color>` | ``Color(1, 1, 1, 0.3)`` |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_focus_color<class_MenuButton_theme_color_font_focus_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_hover_color<class_MenuButton_theme_color_font_hover_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_outline_color<class_MenuButton_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_pressed_color<class_MenuButton_theme_color_font_pressed_color>` | ``Color(1, 1, 1, 1)`` |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`h_separation<class_MenuButton_theme_constant_h_separation>` | ``4`` |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`outline_size<class_MenuButton_theme_constant_outline_size>` | ``0`` |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Font<class_Font>` | :ref:`font<class_MenuButton_theme_font_font>` | |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`font_size<class_MenuButton_theme_font_size_font_size>` | |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_MenuButton_theme_style_disabled>` | |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_MenuButton_theme_style_focus>` | |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_MenuButton_theme_style_hover>` | |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_MenuButton_theme_style_normal>` | |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_MenuButton_theme_style_pressed>` | |
+---------------------------------+------------------------------------------------------------------------------+-----------------------------------+
.. rst-class:: classref-section-separator
----
@@ -200,193 +160,6 @@ void **show_popup** **(** **)**
Adjusts popup position and sizing for the **MenuButton**, then shows the :ref:`PopupMenu<class_PopupMenu>`. Prefer this over using ``get_popup().popup()``.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Theme Property Descriptions
---------------------------
.. _class_MenuButton_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 **MenuButton**.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_theme_color_font_disabled_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_disabled_color** = ``Color(1, 1, 1, 0.3)``
Text :ref:`Color<class_Color>` used when the **MenuButton** is disabled.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_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 **MenuButton** is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_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 **MenuButton** is being hovered.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_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 **MenuButton**.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_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 **MenuButton** is being pressed.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_theme_constant_h_separation:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **h_separation** = ``4``
The horizontal space between **MenuButton**'s icon and text. Negative values will be treated as ``0`` when used.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_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_MenuButton_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_MenuButton_theme_font_font:
.. rst-class:: classref-themeproperty
:ref:`Font<class_Font>` **font**
:ref:`Font<class_Font>` of the **MenuButton**'s text.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_theme_font_size_font_size:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **font_size**
Font size of the **MenuButton**'s text.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_theme_style_disabled:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **disabled**
:ref:`StyleBox<class_StyleBox>` used when the **MenuButton** is disabled.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_theme_style_focus:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **focus**
:ref:`StyleBox<class_StyleBox>` used when the **MenuButton** 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_MenuButton_theme_style_hover:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **hover**
:ref:`StyleBox<class_StyleBox>` used when the **MenuButton** is being hovered.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_theme_style_normal:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **normal**
Default :ref:`StyleBox<class_StyleBox>` for the **MenuButton**.
.. rst-class:: classref-item-separator
----
.. _class_MenuButton_theme_style_pressed:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **pressed**
:ref:`StyleBox<class_StyleBox>` used when the **MenuButton** 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.)`