Inheritance #

CheckBox #

is_instantiable, Node, core, not_builtin_classes

A button that represents a binary choice.

CheckBox allows the user to choose one of only two possible options. It's similar to 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 BaseButton which contains common properties and methods associated with this node.

When BaseButton.button_group specifies a ButtonGroup, CheckBox changes its appearance to that of a radio button and uses the various radio_* theme properties.

Members #

var alignment: int = 0#

var toggle_mode: bool = true#

Methods #

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

Theme Items #

self["theme_override_constants/check_v_offset"] = 0 as int#

The vertical offset used when rendering the check icons (in pixels).

self["theme_override_icons/checked"] = icon as Texture2D#

The check icon to display when the CheckBox is checked.

self["theme_override_icons/checked_disabled"] = icon as Texture2D#

The check icon to display when the CheckBox is checked and is disabled.

self["theme_override_icons/radio_checked"] = icon as Texture2D#

The check icon to display when the CheckBox is configured as a radio button and is checked.

self["theme_override_icons/radio_checked_disabled"] = icon as Texture2D#

The check icon to display when the CheckBox is configured as a radio button, is disabled, and is unchecked.

self["theme_override_icons/radio_unchecked"] = icon as Texture2D#

The check icon to display when the CheckBox is configured as a radio button and is unchecked.

self["theme_override_icons/radio_unchecked_disabled"] = icon as Texture2D#

The check icon to display when the CheckBox is configured as a radio button, is disabled, and is unchecked.

self["theme_override_icons/unchecked"] = icon as Texture2D#

The check icon to display when the CheckBox is unchecked.

self["theme_override_icons/unchecked_disabled"] = icon as Texture2D#

The check icon to display when the CheckBox is unchecked and is disabled.

Tutorials #