Files
godot-docs/classes/class_checkbox.rst
Rémi Verschelde 2b4319bc29 Sync classref with current source
Changes order of brief/long descriptions and removes category
as per godotengine/godot#35132.
2020-01-15 00:51:47 +01:00

71 lines
4.4 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CheckBox.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CheckBox:
CheckBox
========
**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>`
Binary choice user interface widget.
Description
-----------
A checkbox allows the user to make a binary choice (choosing only one of two possible options).
Properties
----------
+-----------------------------------------+-------------+-------------+
| :ref:`TextAlign<enum_Button_TextAlign>` | align | **O:** 0 |
+-----------------------------------------+-------------+-------------+
| :ref:`bool<class_bool>` | toggle_mode | **O:** true |
+-----------------------------------------+-------------+-------------+
Theme Properties
----------------
+---------------------------------+--------------------------+------------------------------+
| :ref:`int<class_int>` | check_vadjust | 0 |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | checked | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover_pressed | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`int<class_int>` | hseparation | 4 |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | radio_checked | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | radio_unchecked | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | unchecked | |
+---------------------------------+--------------------------+------------------------------+