CheckButton

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

Description

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

Properties

Theme Properties

Theme Property Descriptions

  • Color font_color CheckButton text’s font color.
  • Color font_color_disabled CheckButton text’s font color when it’s disabled.
  • Color font_color_focus 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_color_hover CheckButton text’s font color when it’s hovered.
  • Color font_color_hover_pressed CheckButton text’s font color when it’s hovered and pressed.
  • Color font_color_pressed CheckButton text’s font color when it’s pressed.
  • int check_vadjust The vertical offset used when rendering the toggle icons (in pixels).
  • int hseparation The separation between the toggle icon and the text (in pixels).
  • Font font Font to use for the CheckButton text.
  • Texture off CheckButton is unchecked.
  • Texture off_disabled CheckButton is unchecked and disabled.
  • Texture on CheckButton is checked.
  • Texture on_disabled CheckButton is checked and disabled.
  • StyleBox disabled StyleBox to display as a background when the CheckButton is disabled.
  • StyleBox focus StyleBox to display as a background when the CheckButton is focused.
  • StyleBox hover StyleBox to display as a background when the CheckButton is hovered.
  • StyleBox hover_pressed StyleBox to display as a background when the CheckButton is hovered and pressed.
  • StyleBox normal StyleBox to display as a background.
  • StyleBox pressed StyleBox to display as a background when the CheckButton is pressed.