mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
classref: Sync with current 3.x branch (995c24415)
This commit is contained in:
Yuri Sizov
@@ -16,6 +16,8 @@ Button
|
||||
|
||||
Standard themed Button.
|
||||
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -40,6 +42,8 @@ See also :ref:`BaseButton<class_BaseButton>` which contains common properties an
|
||||
|
||||
\ **Note:** Buttons do not interpret touch input and therefore don't support multitouch, since mouse emulation can only press one button at a given time. Use :ref:`TouchScreenButton<class_TouchScreenButton>` for buttons that trigger gameplay movement or actions, as :ref:`TouchScreenButton<class_TouchScreenButton>` supports multitouch.
|
||||
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
@@ -47,307 +51,477 @@ Tutorials
|
||||
|
||||
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`__
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | :ref:`align<class_Button_property_align>` | ``1`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_text<class_Button_property_clip_text>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`expand_icon<class_Button_property_expand_icon>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flat<class_Button_property_flat>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` | |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | :ref:`icon_align<class_Button_property_icon_align>` | ``0`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`text<class_Button_property_text>` | ``""`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | :ref:`align<class_Button_property_align>` | ``1`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_text<class_Button_property_clip_text>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`expand_icon<class_Button_property_expand_icon>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flat<class_Button_property_flat>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` | |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | :ref:`icon_align<class_Button_property_icon_align>` | ``0`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`text<class_Button_property_text>` | ``""`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color<class_Button_theme_color_font_color>` | ``Color( 0.88, 0.88, 0.88, 1 )`` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_Button_theme_color_font_color_disabled>` | ``Color( 0.9, 0.9, 0.9, 0.2 )`` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_focus<class_Button_theme_color_font_color_focus>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_hover<class_Button_theme_color_font_color_hover>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_Button_theme_color_font_color_pressed>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hseparation<class_Button_theme_constant_hseparation>` | ``2`` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Font<class_Font>` | :ref:`font<class_Button_theme_font_font>` | |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_Button_theme_style_disabled>` | |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_Button_theme_style_focus>` | |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_Button_theme_style_hover>` | |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_Button_theme_style_normal>` | |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_Button_theme_style_pressed>` | |
|
||||
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color<class_Button_theme_color_font_color>` | ``Color( 0.88, 0.88, 0.88, 1 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_Button_theme_color_font_color_disabled>` | ``Color( 0.9, 0.9, 0.9, 0.2 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_focus<class_Button_theme_color_font_color_focus>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_hover<class_Button_theme_color_font_color_hover>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_hover_pressed<class_Button_theme_color_font_color_hover_pressed>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_Button_theme_color_font_color_pressed>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`icon_color_disabled<class_Button_theme_color_icon_color_disabled>` | ``Color( 1, 1, 1, 0.4 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`icon_color_focus<class_Button_theme_color_icon_color_focus>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`icon_color_hover<class_Button_theme_color_icon_color_hover>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`icon_color_hover_pressed<class_Button_theme_color_icon_color_hover_pressed>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`icon_color_normal<class_Button_theme_color_icon_color_normal>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`icon_color_pressed<class_Button_theme_color_icon_color_pressed>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hseparation<class_Button_theme_constant_hseparation>` | ``2`` |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Font<class_Font>` | :ref:`font<class_Button_theme_font_font>` | |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_Button_theme_style_disabled>` | |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_Button_theme_style_focus>` | |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_Button_theme_style_hover>` | |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_Button_theme_style_normal>` | |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_Button_theme_style_pressed>` | |
|
||||
+---------------------------------+------------------------------------------------------------------------------------+----------------------------------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_Button_TextAlign:
|
||||
|
||||
.. _class_Button_constant_ALIGN_LEFT:
|
||||
|
||||
.. _class_Button_constant_ALIGN_CENTER:
|
||||
|
||||
.. _class_Button_constant_ALIGN_RIGHT:
|
||||
.. rst-class:: classref-enumeration
|
||||
|
||||
enum **TextAlign**:
|
||||
|
||||
- **ALIGN_LEFT** = **0** --- Align the text to the left.
|
||||
.. _class_Button_constant_ALIGN_LEFT:
|
||||
|
||||
- **ALIGN_CENTER** = **1** --- Align the text to the center.
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
- **ALIGN_RIGHT** = **2** --- Align the text to the right.
|
||||
:ref:`TextAlign<enum_Button_TextAlign>` **ALIGN_LEFT** = ``0``
|
||||
|
||||
Align the text to the left.
|
||||
|
||||
.. _class_Button_constant_ALIGN_CENTER:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`TextAlign<enum_Button_TextAlign>` **ALIGN_CENTER** = ``1``
|
||||
|
||||
Align the text to the center.
|
||||
|
||||
.. _class_Button_constant_ALIGN_RIGHT:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`TextAlign<enum_Button_TextAlign>` **ALIGN_RIGHT** = ``2``
|
||||
|
||||
Align the text to the right.
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Button_property_align:
|
||||
|
||||
- :ref:`TextAlign<enum_Button_TextAlign>` **align**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_text_align(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_text_align() |
|
||||
+-----------+-----------------------+
|
||||
:ref:`TextAlign<enum_Button_TextAlign>` **align** = ``1``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_text_align** **(** :ref:`TextAlign<enum_Button_TextAlign>` value **)**
|
||||
- :ref:`TextAlign<enum_Button_TextAlign>` **get_text_align** **(** **)**
|
||||
|
||||
Text alignment policy for the button's text, use one of the :ref:`TextAlign<enum_Button_TextAlign>` constants.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_property_clip_text:
|
||||
|
||||
- :ref:`bool<class_bool>` **clip_text**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_clip_text(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_clip_text() |
|
||||
+-----------+----------------------+
|
||||
:ref:`bool<class_bool>` **clip_text** = ``false``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_clip_text** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **get_clip_text** **(** **)**
|
||||
|
||||
When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_property_expand_icon:
|
||||
|
||||
- :ref:`bool<class_bool>` **expand_icon**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_expand_icon(value) |
|
||||
+-----------+------------------------+
|
||||
| *Getter* | is_expand_icon() |
|
||||
+-----------+------------------------+
|
||||
:ref:`bool<class_bool>` **expand_icon** = ``false``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_expand_icon** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_expand_icon** **(** **)**
|
||||
|
||||
When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_property_flat:
|
||||
|
||||
- :ref:`bool<class_bool>` **flat**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_flat(value) |
|
||||
+-----------+-----------------+
|
||||
| *Getter* | is_flat() |
|
||||
+-----------+-----------------+
|
||||
: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 buttons don't display decoration.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_property_icon:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **icon**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+----------+------------------------+
|
||||
| *Setter* | set_button_icon(value) |
|
||||
+----------+------------------------+
|
||||
| *Getter* | get_button_icon() |
|
||||
+----------+------------------------+
|
||||
:ref:`Texture<class_Texture>` **icon**
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_button_icon** **(** :ref:`Texture<class_Texture>` value **)**
|
||||
- :ref:`Texture<class_Texture>` **get_button_icon** **(** **)**
|
||||
|
||||
Button's icon, if text is present the icon will be placed before the text.
|
||||
|
||||
To edit margin and spacing of the icon, use ``hseparation`` theme property of ``Button`` and ``content_margin_*`` properties of the used :ref:`StyleBox<class_StyleBox>`\ es.
|
||||
To edit margin and spacing of the icon, use ``hseparation`` theme property of **Button** and ``content_margin_*`` properties of the used :ref:`StyleBox<class_StyleBox>`\ es.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_property_icon_align:
|
||||
|
||||
- :ref:`TextAlign<enum_Button_TextAlign>` **icon_align**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_icon_align(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_icon_align() |
|
||||
+-----------+-----------------------+
|
||||
:ref:`TextAlign<enum_Button_TextAlign>` **icon_align** = ``0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_icon_align** **(** :ref:`TextAlign<enum_Button_TextAlign>` value **)**
|
||||
- :ref:`TextAlign<enum_Button_TextAlign>` **get_icon_align** **(** **)**
|
||||
|
||||
Specifies if the icon should be aligned to the left, right, or center of a button. Uses the same :ref:`TextAlign<enum_Button_TextAlign>` constants as the text alignment. If centered, text will draw on top of the icon.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_property_text:
|
||||
|
||||
- :ref:`String<class_String>` **text**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | ``""`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_text(value) |
|
||||
+-----------+-----------------+
|
||||
| *Getter* | get_text() |
|
||||
+-----------+-----------------+
|
||||
:ref:`String<class_String>` **text** = ``""``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_text** **(** :ref:`String<class_String>` value **)**
|
||||
- :ref:`String<class_String>` **get_text** **(** **)**
|
||||
|
||||
The button's text that will be displayed inside the button's area.
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Theme Property Descriptions
|
||||
---------------------------
|
||||
|
||||
.. _class_Button_theme_color_font_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **font_color**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | ``Color( 0.88, 0.88, 0.88, 1 )`` |
|
||||
+-----------+----------------------------------+
|
||||
:ref:`Color<class_Color>` **font_color** = ``Color( 0.88, 0.88, 0.88, 1 )``
|
||||
|
||||
Default text :ref:`Color<class_Color>` of the ``Button``.
|
||||
Default text :ref:`Color<class_Color>` of the **Button**.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_color_font_color_disabled:
|
||||
|
||||
- :ref:`Color<class_Color>` **font_color_disabled**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
+-----------+---------------------------------+
|
||||
| *Default* | ``Color( 0.9, 0.9, 0.9, 0.2 )`` |
|
||||
+-----------+---------------------------------+
|
||||
:ref:`Color<class_Color>` **font_color_disabled** = ``Color( 0.9, 0.9, 0.9, 0.2 )``
|
||||
|
||||
Text :ref:`Color<class_Color>` used when the ``Button`` is disabled.
|
||||
Text :ref:`Color<class_Color>` used when the **Button** is disabled.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_color_font_color_focus:
|
||||
|
||||
- :ref:`Color<class_Color>` **font_color_focus**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
||||
+-----------+----------------------------------+
|
||||
:ref:`Color<class_Color>` **font_color_focus** = ``Color( 0.94, 0.94, 0.94, 1 )``
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_color_font_color_hover:
|
||||
|
||||
- :ref:`Color<class_Color>` **font_color_hover**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
||||
+-----------+----------------------------------+
|
||||
:ref:`Color<class_Color>` **font_color_hover** = ``Color( 0.94, 0.94, 0.94, 1 )``
|
||||
|
||||
Text :ref:`Color<class_Color>` used when the ``Button`` is being hovered.
|
||||
Text :ref:`Color<class_Color>` used when the **Button** is being hovered.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_color_font_color_hover_pressed:
|
||||
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`Color<class_Color>` **font_color_hover_pressed** = ``Color( 1, 1, 1, 1 )``
|
||||
|
||||
Text :ref:`Color<class_Color>` used when the **Button** is being hovered and pressed.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_color_font_color_pressed:
|
||||
|
||||
- :ref:`Color<class_Color>` **font_color_pressed**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-----------+-------------------------+
|
||||
:ref:`Color<class_Color>` **font_color_pressed** = ``Color( 1, 1, 1, 1 )``
|
||||
|
||||
Text :ref:`Color<class_Color>` used when the ``Button`` is being pressed.
|
||||
Text :ref:`Color<class_Color>` used when the **Button** is being pressed.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_color_icon_color_disabled:
|
||||
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`Color<class_Color>` **icon_color_disabled** = ``Color( 1, 1, 1, 0.4 )``
|
||||
|
||||
Icon modulate :ref:`Color<class_Color>` used when the **Button** is disabled.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_color_icon_color_focus:
|
||||
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`Color<class_Color>` **icon_color_focus** = ``Color( 1, 1, 1, 1 )``
|
||||
|
||||
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.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_color_icon_color_hover:
|
||||
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`Color<class_Color>` **icon_color_hover** = ``Color( 1, 1, 1, 1 )``
|
||||
|
||||
Icon modulate :ref:`Color<class_Color>` used when the **Button** is being hovered.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_color_icon_color_hover_pressed:
|
||||
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`Color<class_Color>` **icon_color_hover_pressed** = ``Color( 1, 1, 1, 1 )``
|
||||
|
||||
Icon modulate :ref:`Color<class_Color>` used when the **Button** is being hovered and pressed.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_color_icon_color_normal:
|
||||
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`Color<class_Color>` **icon_color_normal** = ``Color( 1, 1, 1, 1 )``
|
||||
|
||||
Default icon modulate :ref:`Color<class_Color>` of the **Button**.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_color_icon_color_pressed:
|
||||
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`Color<class_Color>` **icon_color_pressed** = ``Color( 1, 1, 1, 1 )``
|
||||
|
||||
Icon modulate :ref:`Color<class_Color>` used when the **Button** is being pressed.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_constant_hseparation:
|
||||
|
||||
- :ref:`int<class_int>` **hseparation**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``2`` |
|
||||
+-----------+-------+
|
||||
:ref:`int<class_int>` **hseparation** = ``2``
|
||||
|
||||
The horizontal space between ``Button``'s icon and text.
|
||||
The horizontal space between **Button**'s icon and text.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_font_font:
|
||||
|
||||
- :ref:`Font<class_Font>` **font**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`Font<class_Font>` of the ``Button``'s text.
|
||||
:ref:`Font<class_Font>` **font**
|
||||
|
||||
:ref:`Font<class_Font>` of the **Button**'s text.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_style_disabled:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **disabled**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`StyleBox<class_StyleBox>` used when the ``Button`` is disabled.
|
||||
:ref:`StyleBox<class_StyleBox>` **disabled**
|
||||
|
||||
:ref:`StyleBox<class_StyleBox>` used when the **Button** is disabled.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_style_focus:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **focus**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`StyleBox<class_StyleBox>` used when the ``Button`` is focused. It is displayed over the current :ref:`StyleBox<class_StyleBox>`, so using :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` will just disable the focus visual effect.
|
||||
:ref:`StyleBox<class_StyleBox>` **focus**
|
||||
|
||||
:ref:`StyleBox<class_StyleBox>` used when the **Button** is focused. It is displayed over the current :ref:`StyleBox<class_StyleBox>`, so using :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` will just disable the focus visual effect.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_style_hover:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **hover**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`StyleBox<class_StyleBox>` used when the ``Button`` is being hovered.
|
||||
:ref:`StyleBox<class_StyleBox>` **hover**
|
||||
|
||||
:ref:`StyleBox<class_StyleBox>` used when the **Button** is being hovered.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_style_normal:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **normal**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
Default :ref:`StyleBox<class_StyleBox>` for the ``Button``.
|
||||
:ref:`StyleBox<class_StyleBox>` **normal**
|
||||
|
||||
Default :ref:`StyleBox<class_StyleBox>` for the **Button**.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Button_theme_style_pressed:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **pressed**
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`StyleBox<class_StyleBox>` used when the ``Button`` is being pressed.
|
||||
:ref:`StyleBox<class_StyleBox>` **pressed**
|
||||
|
||||
:ref:`StyleBox<class_StyleBox>` used when the **Button** 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.)`
|
||||
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
||||
|
||||
Reference in New Issue
Block a user