: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>`

**Category:** Core

Brief Description
-----------------

Checkable button.

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                  |                              |
+---------------------------------+--------------------------+------------------------------+

Description
-----------

CheckButton is a toggle button displayed as a check field.