:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CheckBox.xml. .. _class_CheckBox: CheckBox ======== **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Binary choice user interface widget. See also :ref:`CheckButton`. .. rst-class:: classref-introduction-group Description ----------- A checkbox allows the user to make a binary choice (choosing only one of two possible options). It's similar to :ref:`CheckButton` in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckBox when toggling it has **no** immediate effect on something. For instance, it should be used when toggling it will only do something once a confirmation button is pressed. See also :ref:`BaseButton` which contains common properties and methods associated with this node. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------+-------------+-------------------------------------------------------------------------------+ | :ref:`TextAlign` | align | ``0`` (overrides :ref:`Button`) | +-----------------------------------------+-------------+-------------------------------------------------------------------------------+ | :ref:`bool` | toggle_mode | ``true`` (overrides :ref:`BaseButton`) | +-----------------------------------------+-------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color` | ``Color( 0.88, 0.88, 0.88, 1 )`` | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_disabled` | ``Color( 0.9, 0.9, 0.9, 0.2 )`` | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_focus` | ``Color( 0.94, 0.94, 0.94, 1 )`` | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_hover` | ``Color( 0.94, 0.94, 0.94, 1 )`` | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_hover_pressed` | ``Color( 1, 1, 1, 1 )`` | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_pressed` | ``Color( 1, 1, 1, 1 )`` | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`int` | :ref:`check_vadjust` | ``0`` | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`int` | :ref:`hseparation` | ``4`` | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Font` | :ref:`font` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Texture` | :ref:`checked` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Texture` | :ref:`checked_disabled` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Texture` | :ref:`radio_checked` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Texture` | :ref:`radio_checked_disabled` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Texture` | :ref:`radio_unchecked` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Texture` | :ref:`radio_unchecked_disabled` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Texture` | :ref:`unchecked` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Texture` | :ref:`unchecked_disabled` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`disabled` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`focus` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`hover` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`hover_pressed` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`normal` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`pressed` | | +---------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Theme Property Descriptions --------------------------- .. _class_CheckBox_theme_color_font_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_color** = ``Color( 0.88, 0.88, 0.88, 1 )`` The **CheckBox** text's font color. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_color_font_color_disabled: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_disabled** = ``Color( 0.9, 0.9, 0.9, 0.2 )`` The **CheckBox** text's font color when it's disabled. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_color_font_color_focus: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_focus** = ``Color( 0.94, 0.94, 0.94, 1 )`` The **CheckBox** text's font color when it's focused. Only replaces the normal text color of the checkbox. Disabled, hovered, and pressed states take precedence over this color. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_color_font_color_hover: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_hover** = ``Color( 0.94, 0.94, 0.94, 1 )`` The **CheckBox** text's font color when it's hovered. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_color_font_color_hover_pressed: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_hover_pressed** = ``Color( 1, 1, 1, 1 )`` The **CheckBox** text's font color when it's hovered and pressed. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_color_font_color_pressed: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_pressed** = ``Color( 1, 1, 1, 1 )`` The **CheckBox** text's font color when it's pressed. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_constant_check_vadjust: .. rst-class:: classref-themeproperty :ref:`int` **check_vadjust** = ``0`` The vertical offset used when rendering the check icons (in pixels). .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_constant_hseparation: .. rst-class:: classref-themeproperty :ref:`int` **hseparation** = ``4`` The separation between the check icon and the text (in pixels). .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_font_font: .. rst-class:: classref-themeproperty :ref:`Font` **font** The :ref:`Font` to use for the **CheckBox** text. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_checked: .. rst-class:: classref-themeproperty :ref:`Texture` **checked** The check icon to display when the **CheckBox** is checked. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_checked_disabled: .. rst-class:: classref-themeproperty :ref:`Texture` **checked_disabled** The check icon to display when the **CheckBox** is checked and disabled. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_checked: .. rst-class:: classref-themeproperty :ref:`Texture` **radio_checked** If the **CheckBox** is configured as a radio button, the icon to display when the **CheckBox** is checked. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_checked_disabled: .. rst-class:: classref-themeproperty :ref:`Texture` **radio_checked_disabled** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_unchecked: .. rst-class:: classref-themeproperty :ref:`Texture` **radio_unchecked** If the **CheckBox** is configured as a radio button, the icon to display when the **CheckBox** is unchecked. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_unchecked_disabled: .. rst-class:: classref-themeproperty :ref:`Texture` **radio_unchecked_disabled** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_unchecked: .. rst-class:: classref-themeproperty :ref:`Texture` **unchecked** The check icon to display when the **CheckBox** is unchecked. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_unchecked_disabled: .. rst-class:: classref-themeproperty :ref:`Texture` **unchecked_disabled** The check icon to display when the **CheckBox** is unchecked and disabled. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_style_disabled: .. rst-class:: classref-themeproperty :ref:`StyleBox` **disabled** The :ref:`StyleBox` to display as a background when the **CheckBox** is disabled. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_style_focus: .. rst-class:: classref-themeproperty :ref:`StyleBox` **focus** The :ref:`StyleBox` to display as a background when the **CheckBox** is focused. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_style_hover: .. rst-class:: classref-themeproperty :ref:`StyleBox` **hover** The :ref:`StyleBox` to display as a background when the **CheckBox** is hovered. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_style_hover_pressed: .. rst-class:: classref-themeproperty :ref:`StyleBox` **hover_pressed** The :ref:`StyleBox` to display as a background when the **CheckBox** is hovered and pressed. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_style_normal: .. rst-class:: classref-themeproperty :ref:`StyleBox` **normal** The :ref:`StyleBox` to display as a background. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_style_pressed: .. rst-class:: classref-themeproperty :ref:`StyleBox` **pressed** The :ref:`StyleBox` to display as a background when the **CheckBox** 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.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`