CheckButton¶
Inherits: Button < BaseButton < Control < CanvasItem < Node < Object
Checkable button. See also CheckBox.
Description¶
CheckButton is a toggle button displayed as a check field. It’s similar to CheckBox in functionality, but it has a different apperance. 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.
Theme Properties¶
| int | check_vadjust | 0 |
| StyleBox | disabled | |
| StyleBox | focus | |
| Font | font | |
| Color | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
| Color | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
| Color | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
| Color | font_color_hover_pressed | Color( 1, 1, 1, 1 ) |
| Color | font_color_pressed | Color( 1, 1, 1, 1 ) |
| StyleBox | hover | |
| StyleBox | hover_pressed | |
| int | hseparation | 4 |
| StyleBox | normal | |
| Texture | off | |
| Texture | off_disabled | |
| Texture | on | |
| Texture | on_disabled | |
| StyleBox | pressed |