CheckBox

Binary choice user interface widget. See also CheckButton.

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 which contains common properties and methods associated with this node.

Color		`Color( 0.88, 0.88, 0.88, 1 )`
Color		`Color( 0.9, 0.9, 0.9, 0.2 )`
Color		`Color( 0.94, 0.94, 0.94, 1 )`
Color		`Color( 0.94, 0.94, 0.94, 1 )`
Color		`Color( 1, 1, 1, 1 )`
Color		`Color( 1, 1, 1, 1 )`
int		`0`
int
Font
Texture
Texture
Texture
Texture
Texture
Texture
Texture
Texture
StyleBox
StyleBox
StyleBox
StyleBox
StyleBox
StyleBox

font_color

Default

Color( 0.88, 0.88, 0.88, 1 )

Color font_color_disabled

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

font_color_focus

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.

Color font_color_hover

Default

Color( 0.94, 0.94, 0.94, 1 )

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

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

font_color_pressed

Default

Color( 1, 1, 1, 1 )

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

int check_vadjust

Default

0

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

hseparation

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

Font font

The to use for the text.

Texture checked

The check icon to display when the CheckBox is checked.

checked_disabled

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

Texture radio_checked

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

radio_checked_disabled

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

Texture radio_unchecked_disabled

unchecked

The check icon to display when the CheckBox is unchecked.

Texture unchecked_disabled

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

disabled

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

focus

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

hover

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

hover_pressed

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

normal

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