godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

352
classes/class_checkbutton.rst
View File

@@ -14,6 +14,8 @@ CheckButton
Checkable button. See also :ref:`CheckBox<class_CheckBox>`.
.. rst-class:: classref-introduction-group
Description
-----------
@@ -21,320 +23,398 @@ CheckButton is a toggle button displayed as a check field. It's similar to :ref:
See also :ref:`BaseButton<class_BaseButton>` which contains common properties and methods associated with this node.
.. rst-class:: classref-reftable-group
Properties
----------
+-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+
| :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` | alignment | ``0`` (overrides :ref:`Button<class_Button_property_alignment>`) |
+-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | toggle_mode | ``true`` (overrides :ref:`BaseButton<class_BaseButton_property_toggle_mode>`) |
+-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+
.. table::
:widths: auto
+-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+
| :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` | alignment | ``0`` (overrides :ref:`Button<class_Button_property_alignment>`) |
+-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | toggle_mode | ``true`` (overrides :ref:`BaseButton<class_BaseButton_property_toggle_mode>`) |
+-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Theme Properties
----------------
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color<class_CheckButton_theme_color_font_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_disabled_color<class_CheckButton_theme_color_font_disabled_color>` | ``Color(0.875, 0.875, 0.875, 0.5)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_focus_color<class_CheckButton_theme_color_font_focus_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_hover_color<class_CheckButton_theme_color_font_hover_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_hover_pressed_color<class_CheckButton_theme_color_font_hover_pressed_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_outline_color<class_CheckButton_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_pressed_color<class_CheckButton_theme_color_font_pressed_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`check_v_offset<class_CheckButton_theme_constant_check_v_offset>` | ``0`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`h_separation<class_CheckButton_theme_constant_h_separation>` | ``4`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`outline_size<class_CheckButton_theme_constant_outline_size>` | ``0`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Font<class_Font>` | :ref:`font<class_CheckButton_theme_font_font>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`font_size<class_CheckButton_theme_font_size_font_size>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`checked<class_CheckButton_theme_icon_checked>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`checked_disabled<class_CheckButton_theme_icon_checked_disabled>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`checked_disabled_mirrored<class_CheckButton_theme_icon_checked_disabled_mirrored>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`checked_mirrored<class_CheckButton_theme_icon_checked_mirrored>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked<class_CheckButton_theme_icon_unchecked>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked_disabled<class_CheckButton_theme_icon_unchecked_disabled>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked_disabled_mirrored<class_CheckButton_theme_icon_unchecked_disabled_mirrored>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked_mirrored<class_CheckButton_theme_icon_unchecked_mirrored>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_CheckButton_theme_style_disabled>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_CheckButton_theme_style_focus>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_CheckButton_theme_style_hover>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover_pressed<class_CheckButton_theme_style_hover_pressed>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_CheckButton_theme_style_normal>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_CheckButton_theme_style_pressed>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
.. table::
:widths: auto
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color<class_CheckButton_theme_color_font_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_disabled_color<class_CheckButton_theme_color_font_disabled_color>` | ``Color(0.875, 0.875, 0.875, 0.5)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_focus_color<class_CheckButton_theme_color_font_focus_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_hover_color<class_CheckButton_theme_color_font_hover_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_hover_pressed_color<class_CheckButton_theme_color_font_hover_pressed_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_outline_color<class_CheckButton_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_pressed_color<class_CheckButton_theme_color_font_pressed_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`check_v_offset<class_CheckButton_theme_constant_check_v_offset>` | ``0`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`h_separation<class_CheckButton_theme_constant_h_separation>` | ``4`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`outline_size<class_CheckButton_theme_constant_outline_size>` | ``0`` |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Font<class_Font>` | :ref:`font<class_CheckButton_theme_font_font>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`int<class_int>` | :ref:`font_size<class_CheckButton_theme_font_size_font_size>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`checked<class_CheckButton_theme_icon_checked>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`checked_disabled<class_CheckButton_theme_icon_checked_disabled>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`checked_disabled_mirrored<class_CheckButton_theme_icon_checked_disabled_mirrored>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`checked_mirrored<class_CheckButton_theme_icon_checked_mirrored>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked<class_CheckButton_theme_icon_unchecked>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked_disabled<class_CheckButton_theme_icon_unchecked_disabled>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked_disabled_mirrored<class_CheckButton_theme_icon_unchecked_disabled_mirrored>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`unchecked_mirrored<class_CheckButton_theme_icon_unchecked_mirrored>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_CheckButton_theme_style_disabled>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_CheckButton_theme_style_focus>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_CheckButton_theme_style_hover>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover_pressed<class_CheckButton_theme_style_hover_pressed>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_CheckButton_theme_style_normal>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_CheckButton_theme_style_pressed>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Theme Property Descriptions
---------------------------
.. _class_CheckButton_theme_color_font_color:
- :ref:`Color<class_Color>` **font_color**
.. rst-class:: classref-themeproperty
+-----------+-----------------------------------+
| *Default* | ``Color(0.875, 0.875, 0.875, 1)`` |
+-----------+-----------------------------------+
:ref:`Color<class_Color>` **font_color** = ``Color(0.875, 0.875, 0.875, 1)``
The ``CheckButton`` text's font color.
The **CheckButton** text's font color.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_color_font_disabled_color:
- :ref:`Color<class_Color>` **font_disabled_color**
.. rst-class:: classref-themeproperty
+-----------+-------------------------------------+
| *Default* | ``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)``
The ``CheckButton`` text's font color when it's disabled.
The **CheckButton** text's font color when it's disabled.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_color_font_focus_color:
- :ref:`Color<class_Color>` **font_focus_color**
.. rst-class:: classref-themeproperty
+-----------+--------------------------------+
| *Default* | ``Color(0.95, 0.95, 0.95, 1)`` |
+-----------+--------------------------------+
:ref:`Color<class_Color>` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 1)``
The ``CheckButton`` text's font color when it's focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
The **CheckButton** text's font color when it's 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_CheckButton_theme_color_font_hover_color:
- :ref:`Color<class_Color>` **font_hover_color**
.. rst-class:: classref-themeproperty
+-----------+--------------------------------+
| *Default* | ``Color(0.95, 0.95, 0.95, 1)`` |
+-----------+--------------------------------+
:ref:`Color<class_Color>` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)``
The ``CheckButton`` text's font color when it's hovered.
The **CheckButton** text's font color when it's hovered.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_color_font_hover_pressed_color:
- :ref:`Color<class_Color>` **font_hover_pressed_color**
.. rst-class:: classref-themeproperty
+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+
:ref:`Color<class_Color>` **font_hover_pressed_color** = ``Color(1, 1, 1, 1)``
The ``CheckButton`` text's font color when it's hovered and pressed.
The **CheckButton** text's font color when it's hovered and pressed.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_color_font_outline_color:
- :ref:`Color<class_Color>` **font_outline_color**
.. rst-class:: classref-themeproperty
+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+
:ref:`Color<class_Color>` **font_outline_color** = ``Color(1, 1, 1, 1)``
The tint of text outline of the ``CheckButton``.
The tint of text outline of the **CheckButton**.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_color_font_pressed_color:
- :ref:`Color<class_Color>` **font_pressed_color**
.. rst-class:: classref-themeproperty
+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+
:ref:`Color<class_Color>` **font_pressed_color** = ``Color(1, 1, 1, 1)``
The ``CheckButton`` text's font color when it's pressed.
The **CheckButton** text's font color when it's pressed.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_constant_check_v_offset:
- :ref:`int<class_int>` **check_v_offset**
.. rst-class:: classref-themeproperty
+-----------+-------+
| *Default* | ``0`` |
+-----------+-------+
:ref:`int<class_int>` **check_v_offset** = ``0``
The vertical offset used when rendering the toggle icons (in pixels).
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_constant_h_separation:
- :ref:`int<class_int>` **h_separation**
.. rst-class:: classref-themeproperty
+-----------+-------+
| *Default* | ``4`` |
+-----------+-------+
:ref:`int<class_int>` **h_separation** = ``4``
The separation between the toggle icon and the text (in pixels). Negative values will be treated as ``0`` when used.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_constant_outline_size:
- :ref:`int<class_int>` **outline_size**
.. rst-class:: classref-themeproperty
+-----------+-------+
| *Default* | ``0`` |
+-----------+-------+
:ref:`int<class_int>` **outline_size** = ``0``
The size of the text outline.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_font_font:
- :ref:`Font<class_Font>` **font**
.. rst-class:: classref-themeproperty
The :ref:`Font<class_Font>` to use for the ``CheckButton`` text.
:ref:`Font<class_Font>` **font**
The :ref:`Font<class_Font>` to use for the **CheckButton** text.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_font_size_font_size:
- :ref:`int<class_int>` **font_size**
.. rst-class:: classref-themeproperty
Font size of the ``CheckButton``'s text.
:ref:`int<class_int>` **font_size**
Font size of the **CheckButton**'s text.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_checked:
- :ref:`Texture2D<class_Texture2D>` **checked**
.. rst-class:: classref-themeproperty
The icon to display when the ``CheckButton`` is checked (for left-to-right layouts).
:ref:`Texture2D<class_Texture2D>` **checked**
The icon to display when the **CheckButton** is checked (for left-to-right layouts).
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_checked_disabled:
- :ref:`Texture2D<class_Texture2D>` **checked_disabled**
.. rst-class:: classref-themeproperty
The icon to display when the ``CheckButton`` is checked and disabled (for left-to-right layouts).
:ref:`Texture2D<class_Texture2D>` **checked_disabled**
The icon to display when the **CheckButton** is checked and disabled (for left-to-right layouts).
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_checked_disabled_mirrored:
- :ref:`Texture2D<class_Texture2D>` **checked_disabled_mirrored**
.. rst-class:: classref-themeproperty
The icon to display when the ``CheckButton`` is checked and disabled (for right-to-left layouts).
:ref:`Texture2D<class_Texture2D>` **checked_disabled_mirrored**
The icon to display when the **CheckButton** is checked and disabled (for right-to-left layouts).
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_checked_mirrored:
- :ref:`Texture2D<class_Texture2D>` **checked_mirrored**
.. rst-class:: classref-themeproperty
The icon to display when the ``CheckButton`` is checked (for right-to-left layouts).
:ref:`Texture2D<class_Texture2D>` **checked_mirrored**
The icon to display when the **CheckButton** is checked (for right-to-left layouts).
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_unchecked:
- :ref:`Texture2D<class_Texture2D>` **unchecked**
.. rst-class:: classref-themeproperty
The icon to display when the ``CheckButton`` is unchecked (for left-to-right layouts).
:ref:`Texture2D<class_Texture2D>` **unchecked**
The icon to display when the **CheckButton** is unchecked (for left-to-right layouts).
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_unchecked_disabled:
- :ref:`Texture2D<class_Texture2D>` **unchecked_disabled**
.. rst-class:: classref-themeproperty
The icon to display when the ``CheckButton`` is unchecked and disabled (for left-to-right layouts).
:ref:`Texture2D<class_Texture2D>` **unchecked_disabled**
The icon to display when the **CheckButton** is unchecked and disabled (for left-to-right layouts).
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_unchecked_disabled_mirrored:
- :ref:`Texture2D<class_Texture2D>` **unchecked_disabled_mirrored**
.. rst-class:: classref-themeproperty
The icon to display when the ``CheckButton`` is unchecked and disabled (for right-to-left layouts).
:ref:`Texture2D<class_Texture2D>` **unchecked_disabled_mirrored**
The icon to display when the **CheckButton** is unchecked and disabled (for right-to-left layouts).
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_unchecked_mirrored:
- :ref:`Texture2D<class_Texture2D>` **unchecked_mirrored**
.. rst-class:: classref-themeproperty
The icon to display when the ``CheckButton`` is unchecked (for right-to-left layouts).
:ref:`Texture2D<class_Texture2D>` **unchecked_mirrored**
The icon to display when the **CheckButton** is unchecked (for right-to-left layouts).
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_style_disabled:
- :ref:`StyleBox<class_StyleBox>` **disabled**
.. rst-class:: classref-themeproperty
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is disabled.
:ref:`StyleBox<class_StyleBox>` **disabled**
The :ref:`StyleBox<class_StyleBox>` to display as a background when the **CheckButton** is disabled.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_style_focus:
- :ref:`StyleBox<class_StyleBox>` **focus**
.. rst-class:: classref-themeproperty
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` 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.
:ref:`StyleBox<class_StyleBox>` **focus**
The :ref:`StyleBox<class_StyleBox>` to display as a background when the **CheckButton** 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_CheckButton_theme_style_hover:
- :ref:`StyleBox<class_StyleBox>` **hover**
.. rst-class:: classref-themeproperty
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is hovered.
:ref:`StyleBox<class_StyleBox>` **hover**
The :ref:`StyleBox<class_StyleBox>` to display as a background when the **CheckButton** is hovered.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_style_hover_pressed:
- :ref:`StyleBox<class_StyleBox>` **hover_pressed**
.. rst-class:: classref-themeproperty
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is hovered and pressed.
:ref:`StyleBox<class_StyleBox>` **hover_pressed**
The :ref:`StyleBox<class_StyleBox>` to display as a background when the **CheckButton** is hovered and pressed.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_style_normal:
- :ref:`StyleBox<class_StyleBox>` **normal**
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **normal**
The :ref:`StyleBox<class_StyleBox>` to display as a background.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_style_pressed:
- :ref:`StyleBox<class_StyleBox>` **pressed**
.. rst-class:: classref-themeproperty
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is pressed.
:ref:`StyleBox<class_StyleBox>` **pressed**
The :ref:`StyleBox<class_StyleBox>` to display as a background when the **CheckButton** is 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.)`