-
Notifications
You must be signed in to change notification settings - Fork 0
class_basebutton
####Inherits: Control ####Category: Core
Provides a base class for different kinds of buttons.
- void _pressed ( ) virtual
- void _toggled ( bool pressed ) virtual
- void set_pressed ( bool pressed )
- bool is_pressed ( ) const
- bool is_hovered ( ) const
- void set_toggle_mode ( bool enabled )
- bool is_toggle_mode ( ) const
- void set_disabled ( bool disabled )
- bool is_disabled ( ) const
- void set_click_on_press ( bool enable )
- bool get_click_on_press ( ) const
- int get_draw_mode ( ) const
- released ( )
- toggled ( bool pressed )
- pressed ( )
- DRAW_NORMAL = 0
- DRAW_PRESSED = 1
- DRAW_HOVER = 2
- DRAW_DISABLED = 3
BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesnt display anything). Other types of buttons inherit from it.
- void set_pressed ( bool pressed )
Set the button to pressed state (only if toggle_mode is active).
- bool is_pressed ( ) const
Return when the button is pressed (only if toggle_mode is active).
- void set_toggle_mode ( bool enabled )
Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked.
- bool is_toggle_mode ( ) const
Return the toggle_mode property (see set_toggle_mode).
- void set_disabled ( bool disabled )
Set the button into disabled state. When a button is disabled, it can"apos;t be clicked or toggled.
- bool is_disabled ( ) const
Return wether the button is in disabled state (see set_disabled).
- void set_click_on_press ( bool enable )
Set the button click_on_press mode. This mode generates click events when a mousebutton or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button).
- bool get_click_on_press ( ) const
Return the state of the click_on_press property (see set_click_on_press).
- int get_draw_mode ( ) const
Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overiding draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW* enum.