:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/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`. 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. Properties ---------- +-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | alignment | ``0`` (overrides :ref:`Button`) | +-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+ | :ref:`bool` | toggle_mode | ``true`` (overrides :ref:`BaseButton`) | +-------------------------------------------------------------------+-------------+-------------------------------------------------------------------------------+ Theme Properties ---------------- +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :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_adjust` | ``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` | | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ Theme Property Descriptions --------------------------- .. _class_CheckBox_theme_color_font_color: - :ref:`Color` **font_color** +-----------+-----------------------------------+ | *Default* | ``Color(0.875, 0.875, 0.875, 1)`` | +-----------+-----------------------------------+ The ``CheckBox`` text's font color. ---- .. _class_CheckBox_theme_color_font_disabled_color: - :ref:`Color` **font_disabled_color** +-----------+-------------------------------------+ | *Default* | ``Color(0.875, 0.875, 0.875, 0.5)`` | +-----------+-------------------------------------+ The ``CheckBox`` text's font color when it's disabled. ---- .. _class_CheckBox_theme_color_font_focus_color: - :ref:`Color` **font_focus_color** +-----------+--------------------------------+ | *Default* | ``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. ---- .. _class_CheckBox_theme_color_font_hover_color: - :ref:`Color` **font_hover_color** +-----------+--------------------------------+ | *Default* | ``Color(0.95, 0.95, 0.95, 1)`` | +-----------+--------------------------------+ The ``CheckBox`` text's font color when it's hovered. ---- .. _class_CheckBox_theme_color_font_hover_pressed_color: - :ref:`Color` **font_hover_pressed_color** +-----------+-----------------------+ | *Default* | ``Color(1, 1, 1, 1)`` | +-----------+-----------------------+ The ``CheckBox`` text's font color when it's hovered and pressed. ---- .. _class_CheckBox_theme_color_font_outline_color: - :ref:`Color` **font_outline_color** +-----------+-----------------------+ | *Default* | ``Color(1, 1, 1, 1)`` | +-----------+-----------------------+ The tint of text outline of the ``CheckBox``. ---- .. _class_CheckBox_theme_color_font_pressed_color: - :ref:`Color` **font_pressed_color** +-----------+-----------------------+ | *Default* | ``Color(1, 1, 1, 1)`` | +-----------+-----------------------+ The ``CheckBox`` text's font color when it's pressed. ---- .. _class_CheckBox_theme_constant_check_v_adjust: - :ref:`int` **check_v_adjust** +-----------+-------+ | *Default* | ``0`` | +-----------+-------+ The vertical offset used when rendering the check icons (in pixels). ---- .. _class_CheckBox_theme_constant_h_separation: - :ref:`int` **h_separation** +-----------+-------+ | *Default* | ``4`` | +-----------+-------+ The separation between the check icon and the text (in pixels). ---- .. _class_CheckBox_theme_constant_outline_size: - :ref:`int` **outline_size** +-----------+-------+ | *Default* | ``0`` | +-----------+-------+ The size of the text outline. ---- .. _class_CheckBox_theme_font_font: - :ref:`Font` **font** The :ref:`Font` to use for the ``CheckBox`` text. ---- .. _class_CheckBox_theme_font_size_font_size: - :ref:`int` **font_size** Font size of the ``CheckBox``'s text. ---- .. _class_CheckBox_theme_icon_checked: - :ref:`Texture2D` **checked** The check icon to display when the ``CheckBox`` is checked. ---- .. _class_CheckBox_theme_icon_checked_disabled: - :ref:`Texture2D` **checked_disabled** The check icon to display when the ``CheckBox`` is checked and is disabled. ---- .. _class_CheckBox_theme_icon_radio_checked: - :ref:`Texture2D` **radio_checked** The check icon to display when the ``CheckBox`` is configured as a radio button and is checked. ---- .. _class_CheckBox_theme_icon_radio_checked_disabled: - :ref:`Texture2D` **radio_checked_disabled** The check icon to display when the ``CheckBox`` is configured as a radio button, is disabled, and is unchecked. ---- .. _class_CheckBox_theme_icon_radio_unchecked: - :ref:`Texture2D` **radio_unchecked** The check icon to display when the ``CheckBox`` is configured as a radio button and is unchecked. ---- .. _class_CheckBox_theme_icon_radio_unchecked_disabled: - :ref:`Texture2D` **radio_unchecked_disabled** The check icon to display when the ``CheckBox`` is configured as a radio button, is disabled, and is unchecked. ---- .. _class_CheckBox_theme_icon_unchecked: - :ref:`Texture2D` **unchecked** The check icon to display when the ``CheckBox`` is unchecked. ---- .. _class_CheckBox_theme_icon_unchecked_disabled: - :ref:`Texture2D` **unchecked_disabled** The check icon to display when the ``CheckBox`` is unchecked and is disabled. ---- .. _class_CheckBox_theme_style_disabled: - :ref:`StyleBox` **disabled** The :ref:`StyleBox` to display as a background when the ``CheckBox`` is disabled. ---- .. _class_CheckBox_theme_style_focus: - :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. ---- .. _class_CheckBox_theme_style_hover: - :ref:`StyleBox` **hover** The :ref:`StyleBox` to display as a background when the ``CheckBox`` is hovered. ---- .. _class_CheckBox_theme_style_hover_pressed: - :ref:`StyleBox` **hover_pressed** The :ref:`StyleBox` to display as a background when the ``CheckBox`` is hovered and pressed. ---- .. _class_CheckBox_theme_style_normal: - :ref:`StyleBox` **normal** The :ref:`StyleBox` to display as a background. ---- .. _class_CheckBox_theme_style_pressed: - :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.)`