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 (overrides Button)

bool

toggle_mode

true (overrides BaseButton)

Theme Properties

Color

font_color

Color( 0.88, 0.88, 0.88, 1 )

Color

font_color_disabled

Color( 0.9, 0.9, 0.9, 0.2 )

Color

font_color_focus

Color( 0.94, 0.94, 0.94, 1 )

Color

font_color_hover

Color( 0.94, 0.94, 0.94, 1 )

Color

font_color_hover_pressed

Color( 1, 1, 1, 1 )

Color

font_color_pressed

Color( 1, 1, 1, 1 )

int

check_vadjust

0

int

hseparation

4

Font

font

Texture

checked

Texture

checked_disabled

Texture

radio_checked

Texture

radio_checked_disabled

Texture

radio_unchecked

Texture

radio_unchecked_disabled

Texture

unchecked

Texture

unchecked_disabled

StyleBox

disabled

StyleBox

focus

StyleBox

hover

StyleBox

hover_pressed

StyleBox

normal

StyleBox

pressed


Theme Property Descriptions

Color font_color = Color( 0.88, 0.88, 0.88, 1 )

The CheckBox text's font color.


Color font_color_disabled = Color( 0.9, 0.9, 0.9, 0.2 )

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


Color font_color_focus = 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 = Color( 0.94, 0.94, 0.94, 1 )

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


Color font_color_hover_pressed = Color( 1, 1, 1, 1 )

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


Color font_color_pressed = Color( 1, 1, 1, 1 )

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


int check_vadjust = 0

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


int hseparation = 4

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


Font font

The Font to use for the CheckBox text.


Texture checked

The check icon to display when the CheckBox is checked.


Texture 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.


Texture radio_checked_disabled

There is currently no description for this theme property. Please help us by contributing one!


Texture radio_unchecked

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


Texture radio_unchecked_disabled

There is currently no description for this theme property. Please help us by contributing one!


Texture 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.


StyleBox disabled

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


StyleBox focus

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


StyleBox hover

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


StyleBox hover_pressed

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


StyleBox normal

The StyleBox to display as a background.


StyleBox pressed

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