CheckBox

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 Properties

int	check_vadjust	0
Texture	checked
StyleBox	disabled
StyleBox	focus
Font	font
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_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 )
StyleBox	hover
StyleBox	hover_pressed
int	hseparation	4
StyleBox	normal
StyleBox	pressed
Texture	radio_checked
Texture	radio_unchecked
Texture	unchecked