godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
3.6
godot-docs/classes/class_checkbutton.rst
Godot Organization 422bc4db8e classref: Sync with current 3.x branch (de2f0f1)
2024-09-10 13:19:38 +00:00

325 lines
14 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/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CheckButton.xml.
.. _class_CheckButton:
CheckButton
===========
**Inherits:** :ref:`Button<class_Button>` **<** :ref:`BaseButton<class_BaseButton>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Checkable button. See also :ref:`CheckBox<class_CheckBox>`.
.. rst-class:: classref-introduction-group
Description
-----------
CheckButton is a toggle button displayed as a check field. It's similar to :ref:`CheckBox<class_CheckBox>` in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an **immediate** effect on something. For instance, it should be used if toggling it enables/disables a setting without requiring the user to press a confirmation button.
See also :ref:`BaseButton<class_BaseButton>` which contains common properties and methods associated with this node.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-----------------------------------------+-------------+-------------------------------------------------------------------------------+
| :ref:`TextAlign<enum_Button_TextAlign>` | align | ``0`` (overrides :ref:`Button<class_Button_property_align>`) |
+-----------------------------------------+-------------+-------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | toggle_mode | ``true`` (overrides :ref:`BaseButton<class_BaseButton_property_toggle_mode>`) |
+-----------------------------------------+-------------+-------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Theme Properties
----------------
.. table::
:widths: auto
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color<class_CheckButton_theme_color_font_color>` | ``Color( 0.88, 0.88, 0.88, 1 )`` |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_CheckButton_theme_color_font_color_disabled>` | ``Color( 0.9, 0.9, 0.9, 0.2 )`` |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color_focus<class_CheckButton_theme_color_font_color_focus>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color_hover<class_CheckButton_theme_color_font_color_hover>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color_hover_pressed<class_CheckButton_theme_color_font_color_hover_pressed>` | ``Color( 1, 1, 1, 1 )`` |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_CheckButton_theme_color_font_color_pressed>` | ``Color( 1, 1, 1, 1 )`` |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`int<class_int>` | :ref:`check_vadjust<class_CheckButton_theme_constant_check_vadjust>` | ``0`` |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`int<class_int>` | :ref:`hseparation<class_CheckButton_theme_constant_hseparation>` | ``4`` |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`Font<class_Font>` | :ref:`font<class_CheckButton_theme_font_font>` | |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`off<class_CheckButton_theme_icon_off>` | |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`off_disabled<class_CheckButton_theme_icon_off_disabled>` | |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`on<class_CheckButton_theme_icon_on>` | |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`on_disabled<class_CheckButton_theme_icon_on_disabled>` | |
+---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+
| :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:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_color** = ``Color( 0.88, 0.88, 0.88, 1 )``
The **CheckButton** text's font color.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_color_font_color_disabled:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_color_disabled** = ``Color( 0.9, 0.9, 0.9, 0.2 )``
The **CheckButton** text's font color when it's disabled.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_color_font_color_focus:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_color_focus** = ``Color( 0.94, 0.94, 0.94, 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.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_color_font_color_hover:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_color_hover** = ``Color( 0.94, 0.94, 0.94, 1 )``
The **CheckButton** text's font color when it's hovered.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_color_font_color_hover_pressed:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_color_hover_pressed** = ``Color( 1, 1, 1, 1 )``
The **CheckButton** text's font color when it's hovered and pressed.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_color_font_color_pressed:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_color_pressed** = ``Color( 1, 1, 1, 1 )``
The **CheckButton** text's font color when it's pressed.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_constant_check_vadjust:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **check_vadjust** = ``0``
The vertical offset used when rendering the toggle icons (in pixels).
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_constant_hseparation:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **hseparation** = ``4``
The separation between the toggle icon and the text (in pixels).
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_font_font:
.. rst-class:: classref-themeproperty
:ref:`Font<class_Font>` **font**
The :ref:`Font<class_Font>` to use for the **CheckButton** text.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_off:
.. rst-class:: classref-themeproperty
:ref:`Texture<class_Texture>` **off**
The icon to display when the **CheckButton** is unchecked.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_off_disabled:
.. rst-class:: classref-themeproperty
:ref:`Texture<class_Texture>` **off_disabled**
The icon to display when the **CheckButton** is unchecked and disabled.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_on:
.. rst-class:: classref-themeproperty
:ref:`Texture<class_Texture>` **on**
The icon to display when the **CheckButton** is checked.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_icon_on_disabled:
.. rst-class:: classref-themeproperty
:ref:`Texture<class_Texture>` **on_disabled**
The icon to display when the **CheckButton** is checked and disabled.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_style_disabled:
.. rst-class:: classref-themeproperty
: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:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **focus**
The :ref:`StyleBox<class_StyleBox>` to display as a background when the **CheckButton** is focused.
.. rst-class:: classref-item-separator
----
.. _class_CheckButton_theme_style_hover:
.. rst-class:: classref-themeproperty
: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:
.. rst-class:: classref-themeproperty
: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:
.. 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:
.. rst-class:: classref-themeproperty
: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.)`
.. |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 View Git Blame Copy Permalink