:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/CheckBox.xml. .. _class_CheckBox: CheckBox ======== **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` A button that represents a binary choice. .. rst-class:: classref-introduction-group Description ----------- **CheckBox** allows the user to choose one of only 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 example, it could 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. When :ref:`BaseButton.button_group` specifies a :ref:`ButtonGroup`, **CheckBox** changes its appearance to that of a radio button and uses the various ``radio_*`` theme properties. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | alignment | ``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.875, 0.875, 0.875, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.875, 0.875, 0.875, 0.5)`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`check_v_offset` | ``0`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`h_separation` | ``4`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Font` | :ref:`font` | | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`font_size` | | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`checked` | | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`checked_disabled` | | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`radio_checked` | | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`radio_checked_disabled` | | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`radio_unchecked` | | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`radio_unchecked_disabled` | | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :ref:`unchecked` | | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Texture2D` | :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.875, 0.875, 0.875, 1)`` The **CheckBox** text's font color. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_color_font_disabled_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_disabled_color** = ``Color(0.875, 0.875, 0.875, 0.5)`` The **CheckBox** text's font color when it's disabled. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_color_font_focus_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_focus_color** = ``Color(0.95, 0.95, 0.95, 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_hover_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_hover_color** = ``Color(0.95, 0.95, 0.95, 1)`` The **CheckBox** text's font color when it's hovered. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_color_font_hover_pressed_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_hover_pressed_color** = ``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_outline_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_outline_color** = ``Color(1, 1, 1, 1)`` The tint of text outline of the **CheckBox**. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_color_font_pressed_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_pressed_color** = ``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_v_offset: .. rst-class:: classref-themeproperty :ref:`int` **check_v_offset** = ``0`` The vertical offset used when rendering the check icons (in pixels). .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_constant_h_separation: .. rst-class:: classref-themeproperty :ref:`int` **h_separation** = ``4`` The separation between the check icon and the text (in pixels). Negative values will be treated as ``0`` when used. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_constant_outline_size: .. rst-class:: classref-themeproperty :ref:`int` **outline_size** = ``0`` The size of the text outline. \ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field` enabled, its :ref:`FontFile.msdf_pixel_range` must be set to at least *twice* the value of :ref:`outline_size` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. .. 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_font_size_font_size: .. rst-class:: classref-themeproperty :ref:`int` **font_size** Font size of the **CheckBox**'s text. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_checked: .. rst-class:: classref-themeproperty :ref:`Texture2D` **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:`Texture2D` **checked_disabled** The check icon to display when the **CheckBox** is checked and is disabled. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_checked: .. rst-class:: classref-themeproperty :ref:`Texture2D` **radio_checked** The check icon to display when the **CheckBox** is configured as a radio button and is checked. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_checked_disabled: .. rst-class:: classref-themeproperty :ref:`Texture2D` **radio_checked_disabled** The check icon to display when the **CheckBox** is configured as a radio button, is disabled, and is unchecked. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_unchecked: .. rst-class:: classref-themeproperty :ref:`Texture2D` **radio_unchecked** The check icon to display when the **CheckBox** is configured as a radio button and is unchecked. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_radio_unchecked_disabled: .. rst-class:: classref-themeproperty :ref:`Texture2D` **radio_unchecked_disabled** The check icon to display when the **CheckBox** is configured as a radio button, is disabled, and is unchecked. .. rst-class:: classref-item-separator ---- .. _class_CheckBox_theme_icon_unchecked: .. rst-class:: classref-themeproperty :ref:`Texture2D` **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:`Texture2D` **unchecked_disabled** The check icon to display when the **CheckBox** is unchecked and is 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. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. .. 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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`