CheckButton¶

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

A button that represents a binary choice.

Description¶

CheckButton is a toggle button displayed as a check field. It's similar to CheckBox in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an immediate effect on something. For example, it can be used when pressing it shows or hides advanced settings, without asking the user to confirm this action.

See also BaseButton which contains common properties and methods associated with this node.

Properties¶

HorizontalAlignment	alignment	`0` (overrides Button)
bool	toggle_mode	`true` (overrides BaseButton)

Theme Properties¶

Color	font_color	`Color(0.875, 0.875, 0.875, 1)`
Color	font_disabled_color	`Color(0.875, 0.875, 0.875, 0.5)`
Color	font_focus_color	`Color(0.95, 0.95, 0.95, 1)`
Color	font_hover_color	`Color(0.95, 0.95, 0.95, 1)`
Color	font_hover_pressed_color	`Color(1, 1, 1, 1)`
Color	font_outline_color	`Color(1, 1, 1, 1)`
Color	font_pressed_color	`Color(1, 1, 1, 1)`
int	check_v_offset	`0`
int	h_separation	`4`
int	outline_size	`0`
Font	font
int	font_size
Texture2D	checked
Texture2D	checked_disabled
Texture2D	checked_disabled_mirrored
Texture2D	checked_mirrored
Texture2D	unchecked
Texture2D	unchecked_disabled
Texture2D	unchecked_disabled_mirrored
Texture2D	unchecked_mirrored
StyleBox	disabled
StyleBox	focus
StyleBox	hover
StyleBox	hover_pressed
StyleBox	normal
StyleBox	pressed

Theme Property Descriptions¶

Color font_color = Color(0.875, 0.875, 0.875, 1)

The CheckButton text's font color.

Color font_disabled_color = Color(0.875, 0.875, 0.875, 0.5)

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

Color font_focus_color = Color(0.95, 0.95, 0.95, 1)

The CheckButton text's font color when it's focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.

Color font_hover_color = Color(0.95, 0.95, 0.95, 1)

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

Color font_hover_pressed_color = Color(1, 1, 1, 1)

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

Color font_outline_color = Color(1, 1, 1, 1)

The tint of text outline of the CheckButton.