CheckBox

Inherits: Button < BaseButton < Control < CanvasItem < Node < Object

Binary choice user interface widget. See also CheckButton.

Description

A checkbox allows the user to make a binary choice (choosing only one of 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 instance, it should 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.

Properties

TextAlign

align

0 (parent override)

bool

toggle_mode

true (parent override)

Theme Property Descriptions

  • int check_vadjust

Default

0

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


The check icon to display when the CheckBox is checked.


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


The StyleBox to display as a background when the CheckBox is disabled.


The StyleBox to display as a background when the CheckBox is focused.


The Font to use for the CheckBox text.


Default

Color( 0.88, 0.88, 0.88, 1 )

The CheckBox text's font color.


  • Color font_color_disabled

Default

Color( 0.9, 0.9, 0.9, 0.2 )

The CheckBox text's font color when it's disabled.


Default

Color( 0.94, 0.94, 0.94, 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.


Default

Color( 0.94, 0.94, 0.94, 1 )

The CheckBox text's font color when it's hovered.


  • Color font_color_hover_pressed

Default

Color( 1, 1, 1, 1 )

The CheckBox text's font color when it's hovered and pressed.


  • Color font_color_pressed

Default

Color( 1, 1, 1, 1 )

The CheckBox text's font color when it's pressed.


The StyleBox to display as a background when the CheckBox is hovered.


The StyleBox to display as a background when the CheckBox is hovered and pressed.


  • int hseparation

Default

4

The separation between the check icon and the text (in pixels).


The StyleBox to display as a background.


The StyleBox to display as a background when the CheckBox is pressed.


If the CheckBox is configured as a radio button, the icon to display when the CheckBox is checked.



If the CheckBox is configured as a radio button, the icon to display when the CheckBox is unchecked.



The check icon to display when the CheckBox is unchecked.


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