CheckButton¶
Inherits: Button < BaseButton < Control < CanvasItem < Node < Object
A button that represents a binary choice.
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 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.
Properties¶
alignment |
|
|
toggle_mode |
|
Theme Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Theme Property Descriptions¶
Color font_color = Color(0.875, 0.875, 0.875, 1)
The CheckButton text's font color.
Color font_disabled_color = Color(0.875, 0.875, 0.875, 0.5)
The CheckButton text's font color when it's disabled.
Color font_focus_color = 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.
Color font_hover_color = Color(0.95, 0.95, 0.95, 1)
The CheckButton text's font color when it's hovered.
Color font_hover_pressed_color = Color(1, 1, 1, 1)
The CheckButton text's font color when it's hovered and pressed.
Color font_outline_color = Color(1, 1, 1, 1)
The tint of text outline of the CheckButton.