CheckBox

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

Description

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

Properties

Theme Properties

Theme Property Descriptions

  • Color font_color CheckBox text’s font color.
  • Color font_color_disabled CheckBox text’s font color when it’s disabled.
  • Color font_color_focus 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 CheckBox text’s font color when it’s hovered.
  • Color font_color_hover_pressed CheckBox text’s font color when it’s hovered and pressed.
  • Color font_color_pressed CheckBox text’s font color when it’s pressed.
  • int check_vadjust The vertical offset used when rendering the check icons (in pixels).
  • int hseparation The separation between the check icon and the text (in pixels).
  • Font font Font to use for the CheckBox text.
  • Texture checked CheckBox is checked.
  • Texture checked_disabled CheckBox is checked and disabled.
  • Texture radio_checked CheckBox is configured as a radio button, the icon to display when the CheckBox is checked.

- Texture radio_checked_disabled

  • Texture radio_unchecked CheckBox is configured as a radio button, the icon to display when the CheckBox is unchecked.

- Texture radio_unchecked_disabled

  • Texture unchecked CheckBox is unchecked.
  • Texture unchecked_disabled CheckBox is unchecked and disabled.
  • StyleBox disabled StyleBox to display as a background when the CheckBox is disabled.
  • StyleBox focus StyleBox to display as a background when the CheckBox is focused.
  • StyleBox hover StyleBox to display as a background when the CheckBox is hovered.
  • StyleBox hover_pressed StyleBox to display as a background when the CheckBox is hovered and pressed.
  • StyleBox normal StyleBox to display as a background.
  • StyleBox pressed StyleBox to display as a background when the CheckBox is pressed.