: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/CheckButton.xml. .. _class_CheckButton: CheckButton =========== **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Checkable button. See also :ref:`CheckBox`. .. rst-class:: classref-introduction-group Description ----------- CheckButton is a toggle button displayed as a check field. It's similar to :ref:`CheckBox` in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an **immediate** effect on something. For instance, it should be used if toggling it enables/disables a setting without requiring the user to press a confirmation button. 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:`off` | | +---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Texture` | :ref:`off_disabled` | | +---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Texture` | :ref:`on` | | +---------------------------------+-----------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Texture` | :ref:`on_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_CheckButton_theme_color_font_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_color** = ``Color( 0.88, 0.88, 0.88, 1 )`` The **CheckButton** text's font color. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_color_font_color_disabled: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_disabled** = ``Color( 0.9, 0.9, 0.9, 0.2 )`` The **CheckButton** text's font color when it's disabled. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_color_font_color_focus: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_focus** = ``Color( 0.94, 0.94, 0.94, 1 )`` The **CheckButton** text's font color when it's focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_color_font_color_hover: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_hover** = ``Color( 0.94, 0.94, 0.94, 1 )`` The **CheckButton** text's font color when it's hovered. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_color_font_color_hover_pressed: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_hover_pressed** = ``Color( 1, 1, 1, 1 )`` The **CheckButton** text's font color when it's hovered and pressed. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_color_font_color_pressed: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_pressed** = ``Color( 1, 1, 1, 1 )`` The **CheckButton** text's font color when it's pressed. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_constant_check_vadjust: .. rst-class:: classref-themeproperty :ref:`int` **check_vadjust** = ``0`` The vertical offset used when rendering the toggle icons (in pixels). .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_constant_hseparation: .. rst-class:: classref-themeproperty :ref:`int` **hseparation** = ``4`` The separation between the toggle icon and the text (in pixels). .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_font_font: .. rst-class:: classref-themeproperty :ref:`Font` **font** The :ref:`Font` to use for the **CheckButton** text. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_icon_off: .. rst-class:: classref-themeproperty :ref:`Texture` **off** The icon to display when the **CheckButton** is unchecked. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_icon_off_disabled: .. rst-class:: classref-themeproperty :ref:`Texture` **off_disabled** The icon to display when the **CheckButton** is unchecked and disabled. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_icon_on: .. rst-class:: classref-themeproperty :ref:`Texture` **on** The icon to display when the **CheckButton** is checked. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_icon_on_disabled: .. rst-class:: classref-themeproperty :ref:`Texture` **on_disabled** The icon to display when the **CheckButton** is checked and disabled. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_style_disabled: .. rst-class:: classref-themeproperty :ref:`StyleBox` **disabled** The :ref:`StyleBox` to display as a background when the **CheckButton** is disabled. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_style_focus: .. rst-class:: classref-themeproperty :ref:`StyleBox` **focus** The :ref:`StyleBox` to display as a background when the **CheckButton** is focused. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_style_hover: .. rst-class:: classref-themeproperty :ref:`StyleBox` **hover** The :ref:`StyleBox` to display as a background when the **CheckButton** is hovered. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_style_hover_pressed: .. rst-class:: classref-themeproperty :ref:`StyleBox` **hover_pressed** The :ref:`StyleBox` to display as a background when the **CheckButton** is hovered and pressed. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_style_normal: .. rst-class:: classref-themeproperty :ref:`StyleBox` **normal** The :ref:`StyleBox` to display as a background. .. rst-class:: classref-item-separator ---- .. _class_CheckButton_theme_style_pressed: .. rst-class:: classref-themeproperty :ref:`StyleBox` **pressed** The :ref:`StyleBox` to display as a background when the **CheckButton** 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.)`