stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 18:29:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (705b7a0)

Browse Source
This commit is contained in:
Godot Organization
2024-05-31 13:54:35 +00:00
parent 32f1b6ea48
commit eacfba2716
835 changed files with 17350 additions and 17256 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_button.rst
+42 -42
View File
@@ -186,7 +186,7 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **alignment** = ``1``
:ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **alignment** = ``1`` :ref:`🔗<class_Button_property_alignment>`
.. rst-class:: classref-property-setget
@@ -203,7 +203,7 @@ Text alignment policy for the button's text, use one of the :ref:`HorizontalAlig
.. rst-class:: classref-property
:ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **autowrap_mode** = ``0``
:ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **autowrap_mode** = ``0`` :ref:`🔗<class_Button_property_autowrap_mode>`
.. rst-class:: classref-property-setget
@@ -220,7 +220,7 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF<class_TextServer_co
.. rst-class:: classref-property
:ref:`bool<class_bool>` **clip_text** = ``false``
:ref:`bool<class_bool>` **clip_text** = ``false`` :ref:`🔗<class_Button_property_clip_text>`
.. rst-class:: classref-property-setget
@@ -237,7 +237,7 @@ When this property is enabled, text that is too large to fit the button is clipp
.. rst-class:: classref-property
:ref:`bool<class_bool>` **expand_icon** = ``false``
:ref:`bool<class_bool>` **expand_icon** = ``false`` :ref:`🔗<class_Button_property_expand_icon>`
.. rst-class:: classref-property-setget
@@ -254,7 +254,7 @@ When enabled, the button's icon will expand/shrink to fit the button's size whil
.. rst-class:: classref-property
:ref:`bool<class_bool>` **flat** = ``false``
:ref:`bool<class_bool>` **flat** = ``false`` :ref:`🔗<class_Button_property_flat>`
.. rst-class:: classref-property-setget
@@ -271,7 +271,7 @@ Flat buttons don't display decoration.
.. rst-class:: classref-property
:ref:`Texture2D<class_Texture2D>` **icon**
:ref:`Texture2D<class_Texture2D>` **icon** :ref:`🔗<class_Button_property_icon>`
.. rst-class:: classref-property-setget
@@ -290,7 +290,7 @@ To edit margin and spacing of the icon, use :ref:`h_separation<class_Button_them
.. rst-class:: classref-property
:ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **icon_alignment** = ``0``
:ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **icon_alignment** = ``0`` :ref:`🔗<class_Button_property_icon_alignment>`
.. rst-class:: classref-property-setget
@@ -307,7 +307,7 @@ Specifies if the icon should be aligned horizontally to the left, right, or cent
.. rst-class:: classref-property
:ref:`String<class_String>` **language** = ``""``
:ref:`String<class_String>` **language** = ``""`` :ref:`🔗<class_Button_property_language>`
.. rst-class:: classref-property-setget
@@ -324,7 +324,7 @@ Language code used for line-breaking and text shaping algorithms, if left empty
.. rst-class:: classref-property
:ref:`String<class_String>` **text** = ``""``
:ref:`String<class_String>` **text** = ``""`` :ref:`🔗<class_Button_property_text>`
.. rst-class:: classref-property-setget
@@ -341,7 +341,7 @@ The button's text that will be displayed inside the button's area.
.. rst-class:: classref-property
:ref:`TextDirection<enum_Control_TextDirection>` **text_direction** = ``0``
:ref:`TextDirection<enum_Control_TextDirection>` **text_direction** = ``0`` :ref:`🔗<class_Button_property_text_direction>`
.. rst-class:: classref-property-setget
@@ -358,7 +358,7 @@ Base text writing direction.
.. rst-class:: classref-property
:ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **text_overrun_behavior** = ``0``
:ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **text_overrun_behavior** = ``0`` :ref:`🔗<class_Button_property_text_overrun_behavior>`
.. rst-class:: classref-property-setget
@@ -375,7 +375,7 @@ Sets the clipping behavior when the text exceeds the node's bounding rectangle.
.. rst-class:: classref-property
:ref:`VerticalAlignment<enum_@GlobalScope_VerticalAlignment>` **vertical_icon_alignment** = ``1``
:ref:`VerticalAlignment<enum_@GlobalScope_VerticalAlignment>` **vertical_icon_alignment** = ``1`` :ref:`🔗<class_Button_property_vertical_icon_alignment>`
.. rst-class:: classref-property-setget
@@ -397,7 +397,7 @@ Theme Property Descriptions
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_color** = ``Color(0.875, 0.875, 0.875, 1)``
:ref:`Color<class_Color>` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗<class_Button_theme_color_font_color>`
Default text :ref:`Color<class_Color>` of the **Button**.
@@ -409,7 +409,7 @@ Default text :ref:`Color<class_Color>` of the **Button**.
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)``
:ref:`Color<class_Color>` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` :ref:`🔗<class_Button_theme_color_font_disabled_color>`
Text :ref:`Color<class_Color>` used when the **Button** is disabled.
@@ -421,7 +421,7 @@ Text :ref:`Color<class_Color>` used when the **Button** is disabled.
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)``
:ref:`Color<class_Color>` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗<class_Button_theme_color_font_focus_color>`
Text :ref:`Color<class_Color>` used when the **Button** is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
@@ -433,7 +433,7 @@ Text :ref:`Color<class_Color>` used when the **Button** is focused. Only replace
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)``
:ref:`Color<class_Color>` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗<class_Button_theme_color_font_hover_color>`
Text :ref:`Color<class_Color>` used when the **Button** is being hovered.
@@ -445,7 +445,7 @@ Text :ref:`Color<class_Color>` used when the **Button** is being hovered.
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)``
:ref:`Color<class_Color>` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_Button_theme_color_font_hover_pressed_color>`
Text :ref:`Color<class_Color>` used when the **Button** is being hovered and pressed.
@@ -457,7 +457,7 @@ Text :ref:`Color<class_Color>` used when the **Button** is being hovered and pre
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_outline_color** = ``Color(0, 0, 0, 1)``
:ref:`Color<class_Color>` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗<class_Button_theme_color_font_outline_color>`
The tint of text outline of the **Button**.
@@ -469,7 +469,7 @@ The tint of text outline of the **Button**.
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_pressed_color** = ``Color(1, 1, 1, 1)``
:ref:`Color<class_Color>` **font_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_Button_theme_color_font_pressed_color>`
Text :ref:`Color<class_Color>` used when the **Button** is being pressed.
@@ -481,7 +481,7 @@ Text :ref:`Color<class_Color>` used when the **Button** is being pressed.
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **icon_disabled_color** = ``Color(1, 1, 1, 0.4)``
:ref:`Color<class_Color>` **icon_disabled_color** = ``Color(1, 1, 1, 0.4)`` :ref:`🔗<class_Button_theme_color_icon_disabled_color>`
Icon modulate :ref:`Color<class_Color>` used when the **Button** is disabled.
@@ -493,7 +493,7 @@ Icon modulate :ref:`Color<class_Color>` used when the **Button** is disabled.
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **icon_focus_color** = ``Color(1, 1, 1, 1)``
:ref:`Color<class_Color>` **icon_focus_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_Button_theme_color_icon_focus_color>`
Icon modulate :ref:`Color<class_Color>` used when the **Button** is focused. Only replaces the normal modulate color of the button. Disabled, hovered, and pressed states take precedence over this color.
@@ -505,7 +505,7 @@ Icon modulate :ref:`Color<class_Color>` used when the **Button** is focused. Onl
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **icon_hover_color** = ``Color(1, 1, 1, 1)``
:ref:`Color<class_Color>` **icon_hover_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_Button_theme_color_icon_hover_color>`
Icon modulate :ref:`Color<class_Color>` used when the **Button** is being hovered.
@@ -517,7 +517,7 @@ Icon modulate :ref:`Color<class_Color>` used when the **Button** is being hovere
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **icon_hover_pressed_color** = ``Color(1, 1, 1, 1)``
:ref:`Color<class_Color>` **icon_hover_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_Button_theme_color_icon_hover_pressed_color>`
Icon modulate :ref:`Color<class_Color>` used when the **Button** is being hovered and pressed.
@@ -529,7 +529,7 @@ Icon modulate :ref:`Color<class_Color>` used when the **Button** is being hovere
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **icon_normal_color** = ``Color(1, 1, 1, 1)``
:ref:`Color<class_Color>` **icon_normal_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_Button_theme_color_icon_normal_color>`
Default icon modulate :ref:`Color<class_Color>` of the **Button**.
@@ -541,7 +541,7 @@ Default icon modulate :ref:`Color<class_Color>` of the **Button**.
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **icon_pressed_color** = ``Color(1, 1, 1, 1)``
:ref:`Color<class_Color>` **icon_pressed_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_Button_theme_color_icon_pressed_color>`
Icon modulate :ref:`Color<class_Color>` used when the **Button** is being pressed.
@@ -553,7 +553,7 @@ Icon modulate :ref:`Color<class_Color>` used when the **Button** is being presse
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **h_separation** = ``4``
:ref:`int<class_int>` **h_separation** = ``4`` :ref:`🔗<class_Button_theme_constant_h_separation>`
The horizontal space between **Button**'s icon and text. Negative values will be treated as ``0`` when used.
@@ -565,7 +565,7 @@ The horizontal space between **Button**'s icon and text. Negative values will be
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **icon_max_width** = ``0``
:ref:`int<class_int>` **icon_max_width** = ``0`` :ref:`🔗<class_Button_theme_constant_icon_max_width>`
The maximum allowed width of the **Button**'s icon. This limit is applied on top of the default size of the icon, or its expanded size if :ref:`expand_icon<class_Button_property_expand_icon>` is ``true``. The height is adjusted according to the icon's ratio. If the button has additional icons (e.g. :ref:`CheckBox<class_CheckBox>`), they will also be limited.
@@ -577,7 +577,7 @@ The maximum allowed width of the **Button**'s icon. This limit is applied on top
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **outline_size** = ``0``
:ref:`int<class_int>` **outline_size** = ``0`` :ref:`🔗<class_Button_theme_constant_outline_size>`
The size of the text outline.
@@ -591,7 +591,7 @@ The size of the text outline.
.. rst-class:: classref-themeproperty
:ref:`Font<class_Font>` **font**
:ref:`Font<class_Font>` **font** :ref:`🔗<class_Button_theme_font_font>`
:ref:`Font<class_Font>` of the **Button**'s text.
@@ -603,7 +603,7 @@ The size of the text outline.
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **font_size**
:ref:`int<class_int>` **font_size** :ref:`🔗<class_Button_theme_font_size_font_size>`
Font size of the **Button**'s text.
@@ -615,7 +615,7 @@ Font size of the **Button**'s text.
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **icon**
:ref:`Texture2D<class_Texture2D>` **icon** :ref:`🔗<class_Button_theme_icon_icon>`
Default icon for the **Button**. Appears only if :ref:`icon<class_Button_property_icon>` is not assigned.
@@ -627,7 +627,7 @@ Default icon for the **Button**. Appears only if :ref:`icon<class_Button_propert
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **disabled**
:ref:`StyleBox<class_StyleBox>` **disabled** :ref:`🔗<class_Button_theme_style_disabled>`
:ref:`StyleBox<class_StyleBox>` used when the **Button** is disabled.
@@ -639,7 +639,7 @@ Default icon for the **Button**. Appears only if :ref:`icon<class_Button_propert
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **disabled_mirrored**
:ref:`StyleBox<class_StyleBox>` **disabled_mirrored** :ref:`🔗<class_Button_theme_style_disabled_mirrored>`
:ref:`StyleBox<class_StyleBox>` used when the **Button** is disabled (for right-to-left layouts).
@@ -651,7 +651,7 @@ Default icon for the **Button**. Appears only if :ref:`icon<class_Button_propert
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **focus**
:ref:`StyleBox<class_StyleBox>` **focus** :ref:`🔗<class_Button_theme_style_focus>`
:ref:`StyleBox<class_StyleBox>` used when the **Button** is focused. The :ref:`focus<class_Button_theme_style_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.
@@ -663,7 +663,7 @@ Default icon for the **Button**. Appears only if :ref:`icon<class_Button_propert
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **hover**
:ref:`StyleBox<class_StyleBox>` **hover** :ref:`🔗<class_Button_theme_style_hover>`
:ref:`StyleBox<class_StyleBox>` used when the **Button** is being hovered.
@@ -675,7 +675,7 @@ Default icon for the **Button**. Appears only if :ref:`icon<class_Button_propert
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **hover_mirrored**
:ref:`StyleBox<class_StyleBox>` **hover_mirrored** :ref:`🔗<class_Button_theme_style_hover_mirrored>`
:ref:`StyleBox<class_StyleBox>` used when the **Button** is being hovered (for right-to-left layouts).
@@ -687,7 +687,7 @@ Default icon for the **Button**. Appears only if :ref:`icon<class_Button_propert
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **hover_pressed**
:ref:`StyleBox<class_StyleBox>` **hover_pressed** :ref:`🔗<class_Button_theme_style_hover_pressed>`
:ref:`StyleBox<class_StyleBox>` used when the **Button** is being pressed and hovered at the same time.
@@ -699,7 +699,7 @@ Default icon for the **Button**. Appears only if :ref:`icon<class_Button_propert
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **hover_pressed_mirrored**
:ref:`StyleBox<class_StyleBox>` **hover_pressed_mirrored** :ref:`🔗<class_Button_theme_style_hover_pressed_mirrored>`
:ref:`StyleBox<class_StyleBox>` used when the **Button** is being pressed and hovered at the same time (for right-to-left layouts).
@@ -711,7 +711,7 @@ Default icon for the **Button**. Appears only if :ref:`icon<class_Button_propert
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **normal**
:ref:`StyleBox<class_StyleBox>` **normal** :ref:`🔗<class_Button_theme_style_normal>`
Default :ref:`StyleBox<class_StyleBox>` for the **Button**.
@@ -723,7 +723,7 @@ Default :ref:`StyleBox<class_StyleBox>` for the **Button**.
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **normal_mirrored**
:ref:`StyleBox<class_StyleBox>` **normal_mirrored** :ref:`🔗<class_Button_theme_style_normal_mirrored>`
Default :ref:`StyleBox<class_StyleBox>` for the **Button** (for right-to-left layouts).
@@ -735,7 +735,7 @@ Default :ref:`StyleBox<class_StyleBox>` for the **Button** (for right-to-left la
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **pressed**
:ref:`StyleBox<class_StyleBox>` **pressed** :ref:`🔗<class_Button_theme_style_pressed>`
:ref:`StyleBox<class_StyleBox>` used when the **Button** is being pressed.
@@ -747,7 +747,7 @@ Default :ref:`StyleBox<class_StyleBox>` for the **Button** (for right-to-left la
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **pressed_mirrored**
:ref:`StyleBox<class_StyleBox>` **pressed_mirrored** :ref:`🔗<class_Button_theme_style_pressed_mirrored>`
:ref:`StyleBox<class_StyleBox>` used when the **Button** is being pressed (for right-to-left layouts).