Files
godot-docs/classes/class_checkbutton.rst
Rémi Verschelde 782dd64a19 classref: Use code markup for default values/overrides
Sync with godotengine/godot#35357.
Fixes #3071.
2020-01-20 12:41:39 +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 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.
Description
-----------
CheckButton is a toggle button displayed as a check field.
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:`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:`Texture<class_Texture>` | off | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | off_disabled | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | on | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`Texture<class_Texture>` | on_disabled | |
+---------------------------------+--------------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+--------------------------+------------------------------+