CheckButton

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

Checkable button. See also CheckBox.

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 instance, it should be used if toggling it enables/disables a setting without requiring the user to press a confirmation button.

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_vadjust

0

int

hseparation

4

int

outline_size

0

Font

font

int

font_size

Texture2D

off

Texture2D

off_disabled

Texture2D

off_disabled_mirrored

Texture2D

off_mirrored

Texture2D

on

Texture2D

on_disabled

Texture2D

on_disabled_mirrored

Texture2D

on_mirrored

StyleBox

disabled

StyleBox

focus

StyleBox

hover

StyleBox

hover_pressed

StyleBox

normal

StyleBox

pressed

Theme Property Descriptions

Default

Color(0.875, 0.875, 0.875, 1)

The CheckButton text's font color.


  • Color font_disabled_color

Default

Color(0.875, 0.875, 0.875, 0.5)

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


Default

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.


Default

Color(0.95, 0.95, 0.95, 1)

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


  • Color font_hover_pressed_color

Default

Color(1, 1, 1, 1)

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


  • Color font_outline_color

Default

Color(1, 1, 1, 1)

The tint of text outline of the CheckButton.


  • Color font_pressed_color

Default

Color(1, 1, 1, 1)

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


  • int check_vadjust

Default

0

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


  • int hseparation

Default

4

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


  • int outline_size

Default

0

The size of the text outline.


The Font to use for the CheckButton text.


  • int font_size

Font size of the CheckButton's text.


The icon to display when the CheckButton is unchecked (for left-to-right layouts).


The icon to display when the CheckButton is unchecked and disabled (for left-to-right layouts).


The icon to display when the CheckButton is unchecked and disabled (for right-to-left layouts).


The icon to display when the CheckButton is unchecked (for right-to-left layouts).


The icon to display when the CheckButton is checked (for left-to-right layouts).


The icon to display when the CheckButton is checked and disabled (for left-to-right layouts).


The icon to display when the CheckButton is checked and disabled (for right-to-left layouts).


The icon to display when the CheckButton is checked (for right-to-left layouts).


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


The StyleBox to display as a background when the CheckButton is focused. The focus StyleBox is displayed over the base StyleBox, so a partially transparent StyleBox should be used to ensure the base StyleBox remains visible. A StyleBox that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a StyleBoxEmpty resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.


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


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


The StyleBox to display as a background.


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