A button that represents a binary choice.
[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 [b]immediate[/b] 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.
The [CheckButton] text's font color.
The [CheckButton] text's font color when it's disabled.
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.
The [CheckButton] text's font color when it's hovered and pressed.
The tint of text outline of the [CheckButton].
The [CheckButton] text's font color when it's pressed.
The vertical offset used when rendering the toggle icons (in pixels).
The separation between the toggle icon and the text (in pixels). Negative values will be treated as [code]0[/code] when used.
The size of the text outline.
[b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
The [Font] to use for the [CheckButton] text.
Font size of the [CheckButton]'s text.
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 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 [StyleBox] to display as a background when the [CheckButton] is disabled.
The [StyleBox] to display as a background when the [CheckButton] is focused. The [code]focus[/code] [StyleBox] is displayed [i]over[/i] 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.