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

**Category:** Core

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

Binary choice user interface widget.

Theme Properties
----------------

+---------------------------------+--------------------------+
| :ref:`int<class_int>`           | check_vadjust            |
+---------------------------------+--------------------------+
| :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               |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>`       | font_color_disabled      |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>`       | font_color_hover         |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>`       | font_color_hover_pressed |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>`       | font_color_pressed       |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover                    |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover_pressed            |
+---------------------------------+--------------------------+
| :ref:`int<class_int>`           | hseparation              |
+---------------------------------+--------------------------+
| :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                |
+---------------------------------+--------------------------+

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

A checkbox allows the user to make a binary choice (choosing only one of two possible options), for example Answer 'yes' or 'no'.