CheckButton

Checkable button. See also CheckBox.

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

• font_color

The text’s font color.

• Color font_color_disabled

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

• font_color_focus

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.

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

• Color font_color_hover_pressed

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

• font_color_pressed

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

• int check_vadjust

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

• hseparation

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

• Font font

The to use for the CheckButton text.

• Texture off

The icon to display when the CheckButton is unchecked.

• off_disabled

The icon to display when the CheckButton is unchecked and disabled.

The icon to display when the CheckButton is checked.

• Texture on_disabled

The icon to display when the CheckButton is checked and disabled.

• disabled

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

• focus

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

• hover

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

• hover_pressed

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

• normal

The StyleBox to display as a background.

• pressed