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
Files
8d5cdb0c7a8458972b7d8edb9c8998ce4af7ef48
godot-docs/classes/class_checkbutton.rst
Rémi Verschelde 8d5cdb0c7a classref: Sync with current master branch (c09d83010)
2022-06-08 13:39:15 +02:00

344 lines
18 KiB
ReStructuredText
Raw Blame History

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CheckButton.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _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>`.
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.
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>`) |
+-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+
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_adjust<class_CheckButton_theme_constant_check_v_adjust>` | ``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:`off<class_CheckButton_theme_icon_off>` | |
+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`off_disabled<class_CheckButton_theme_icon_off_disabled>` | |
+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`off_disabled_mirrored<class_CheckButton_theme_icon_off_disabled_mirrored>` | |
+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`off_mirrored<class_CheckButton_theme_icon_off_mirrored>` | |
+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`on<class_CheckButton_theme_icon_on>` | |
+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`on_disabled<class_CheckButton_theme_icon_on_disabled>` | |
+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`on_disabled_mirrored<class_CheckButton_theme_icon_on_disabled_mirrored>` | |
+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`on_mirrored<class_CheckButton_theme_icon_on_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>` | |
+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+
Theme Property Descriptions
---------------------------
.. _class_CheckButton_theme_color_font_color:
- :ref:`Color<class_Color>` **font_color**
+-----------+-----------------------------------+
| *Default* | ``Color(0.875, 0.875, 0.875, 1)`` |
+-----------+-----------------------------------+
The ``CheckButton`` text's font color.
----
.. _class_CheckButton_theme_color_font_disabled_color:
- :ref:`Color<class_Color>` **font_disabled_color**
+-----------+-------------------------------------+
| *Default* | ``Color(0.875, 0.875, 0.875, 0.5)`` |
+-----------+-------------------------------------+
The ``CheckButton`` text's font color when it's disabled.
----
.. _class_CheckButton_theme_color_font_focus_color:
- :ref:`Color<class_Color>` **font_focus_color**
+-----------+--------------------------------+
| *Default* | ``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.
----
.. _class_CheckButton_theme_color_font_hover_color:
- :ref:`Color<class_Color>` **font_hover_color**
+-----------+--------------------------------+
| *Default* | ``Color(0.95, 0.95, 0.95, 1)`` |
+-----------+--------------------------------+
The ``CheckButton`` text's font color when it's hovered.
----
.. _class_CheckButton_theme_color_font_hover_pressed_color:
- :ref:`Color<class_Color>` **font_hover_pressed_color**
+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+
The ``CheckButton`` text's font color when it's hovered and pressed.
----
.. _class_CheckButton_theme_color_font_outline_color:
- :ref:`Color<class_Color>` **font_outline_color**
+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+
The tint of text outline of the ``CheckButton``.
----
.. _class_CheckButton_theme_color_font_pressed_color:
- :ref:`Color<class_Color>` **font_pressed_color**
+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+
The ``CheckButton`` text's font color when it's pressed.
----
.. _class_CheckButton_theme_constant_check_v_adjust:
- :ref:`int<class_int>` **check_v_adjust**
+-----------+-------+
| *Default* | ``0`` |
+-----------+-------+
The vertical offset used when rendering the toggle icons (in pixels).
----
.. _class_CheckButton_theme_constant_h_separation:
- :ref:`int<class_int>` **h_separation**
+-----------+-------+
| *Default* | ``4`` |
+-----------+-------+
The separation between the toggle icon and the text (in pixels).
----
.. _class_CheckButton_theme_constant_outline_size:
- :ref:`int<class_int>` **outline_size**
+-----------+-------+
| *Default* | ``0`` |
+-----------+-------+
The size of the text outline.
----
.. _class_CheckButton_theme_font_font:
- :ref:`Font<class_Font>` **font**
The :ref:`Font<class_Font>` to use for the ``CheckButton`` text.
----
.. _class_CheckButton_theme_font_size_font_size:
- :ref:`int<class_int>` **font_size**
Font size of the ``CheckButton``'s text.
----
.. _class_CheckButton_theme_icon_off:
- :ref:`Texture2D<class_Texture2D>` **off**
The icon to display when the ``CheckButton`` is unchecked (for left-to-right layouts).
----
.. _class_CheckButton_theme_icon_off_disabled:
- :ref:`Texture2D<class_Texture2D>` **off_disabled**
The icon to display when the ``CheckButton`` is unchecked and disabled (for left-to-right layouts).
----
.. _class_CheckButton_theme_icon_off_disabled_mirrored:
- :ref:`Texture2D<class_Texture2D>` **off_disabled_mirrored**
The icon to display when the ``CheckButton`` is unchecked and disabled (for right-to-left layouts).
----
.. _class_CheckButton_theme_icon_off_mirrored:
- :ref:`Texture2D<class_Texture2D>` **off_mirrored**
The icon to display when the ``CheckButton`` is unchecked (for right-to-left layouts).
----
.. _class_CheckButton_theme_icon_on:
- :ref:`Texture2D<class_Texture2D>` **on**
The icon to display when the ``CheckButton`` is checked (for left-to-right layouts).
----
.. _class_CheckButton_theme_icon_on_disabled:
- :ref:`Texture2D<class_Texture2D>` **on_disabled**
The icon to display when the ``CheckButton`` is checked and disabled (for left-to-right layouts).
----
.. _class_CheckButton_theme_icon_on_disabled_mirrored:
- :ref:`Texture2D<class_Texture2D>` **on_disabled_mirrored**
The icon to display when the ``CheckButton`` is checked and disabled (for right-to-left layouts).
----
.. _class_CheckButton_theme_icon_on_mirrored:
- :ref:`Texture2D<class_Texture2D>` **on_mirrored**
The icon to display when the ``CheckButton`` is checked (for right-to-left layouts).
----
.. _class_CheckButton_theme_style_disabled:
- :ref:`StyleBox<class_StyleBox>` **disabled**
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is disabled.
----
.. _class_CheckButton_theme_style_focus:
- :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.
----
.. _class_CheckButton_theme_style_hover:
- :ref:`StyleBox<class_StyleBox>` **hover**
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is hovered.
----
.. _class_CheckButton_theme_style_hover_pressed:
- :ref:`StyleBox<class_StyleBox>` **hover_pressed**
The :ref:`StyleBox<class_StyleBox>` to display as a background when the ``CheckButton`` is hovered and pressed.
----
.. _class_CheckButton_theme_style_normal:
- :ref:`StyleBox<class_StyleBox>` **normal**
The :ref:`StyleBox<class_StyleBox>` to display as a background.
----
.. _class_CheckButton_theme_style_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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
Reference in New Issue View Git Blame Copy Permalink