:github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the CheckButton.xml source instead. .. The source is found in doc/classes or modules//doc_classes. .. _class_CheckButton: CheckButton =========== **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Checkable button. See also :ref:`CheckBox`. 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. Properties ---------- +-----------------------------------------+-------------+-----------------+ | :ref:`TextAlign` | align | **O:** ``0`` | +-----------------------------------------+-------------+-----------------+ | :ref:`bool` | toggle_mode | **O:** ``true`` | +-----------------------------------------+-------------+-----------------+ Theme Properties ---------------- +-----------------------------------+--------------------------+------------------------------+ | :ref:`int` | check_vadjust | 0 | +-----------------------------------+--------------------------+------------------------------+ | :ref:`StyleBox` | disabled | | +-----------------------------------+--------------------------+------------------------------+ | :ref:`StyleBox` | focus | | +-----------------------------------+--------------------------+------------------------------+ | :ref:`Font` | font | | +-----------------------------------+--------------------------+------------------------------+ | :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | +-----------------------------------+--------------------------+------------------------------+ | :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | +-----------------------------------+--------------------------+------------------------------+ | :ref:`Color` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) | +-----------------------------------+--------------------------+------------------------------+ | :ref:`Color` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) | +-----------------------------------+--------------------------+------------------------------+ | :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | +-----------------------------------+--------------------------+------------------------------+ | :ref:`StyleBox` | hover | | +-----------------------------------+--------------------------+------------------------------+ | :ref:`StyleBox` | hover_pressed | | +-----------------------------------+--------------------------+------------------------------+ | :ref:`int` | hseparation | 4 | +-----------------------------------+--------------------------+------------------------------+ | :ref:`StyleBox` | normal | | +-----------------------------------+--------------------------+------------------------------+ | :ref:`Texture2D` | off | | +-----------------------------------+--------------------------+------------------------------+ | :ref:`Texture2D` | off_disabled | | +-----------------------------------+--------------------------+------------------------------+ | :ref:`Texture2D` | on | | +-----------------------------------+--------------------------+------------------------------+ | :ref:`Texture2D` | on_disabled | | +-----------------------------------+--------------------------+------------------------------+ | :ref:`StyleBox` | pressed | | +-----------------------------------+--------------------------+------------------------------+