BaseButton

    Inherited By: , LinkButton,

    Base class for different kinds of buttons.

    BaseButton is the abstract base class for buttons, so it shouldn’t be used directly (it doesn’t display anything). Other types of buttons inherit from it.

    Properties

    void_pressed ( ) virtual
    void ( bool button_pressed ) virtual
    get_draw_mode ( ) const
    is_hovered ( ) const

    Signals

    • button_down ( )

    Emitted when the button starts being held down.

    • button_up ( )

    Emitted when the button stops being held down.

    • pressed ( )

    Emitted when the button is toggled or pressed. This is on if action_mode is and on button_up otherwise.

    If you need to know the button’s pressed state (and is active), use toggled instead.

    Emitted when the button was just toggled between pressed and normal states (only if is active). The new state is contained in the button_pressed argument.

    • DRAW_NORMAL = 0 —- The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.
    • DRAW_PRESSED = 1 —- The state of buttons are pressed.
    • DRAW_HOVER = 2 —- The state of buttons are hovered.
    • DRAW_DISABLED = 3 —- The state of buttons are disabled.
    • DRAW_HOVER_PRESSED = 4 —- The state of buttons are both hovered and pressed.

    enum ActionMode:

    • ACTION_MODE_BUTTON_PRESS = 0 —- Require just a press to consider the button clicked.
    • ACTION_MODE_BUTTON_RELEASE = 1 —- Require a press and a subsequent release before considering the button clicked.

    Property Descriptions

    Default1
    Setterset_action_mode(value)
    Getterget_action_mode()

    Determines when the button is considered clicked, one of the constants.

    • int button_mask
    Default1
    Setterset_button_mask(value)
    Getterget_button_mask()

    Binary mask to choose which mouse buttons this button will respond to.

    To allow both left-click and right-click, use BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT.

    • disabled

    If true, the button is in disabled state and can’t be clicked or toggled.

    Default2
    Setterset_enabled_focus_mode(value)
    Getterget_enabled_focus_mode()

    Deprecated. This property has been deprecated due to redundancy and no longer has any effect when set. Please use Control.focus_mode instead.

    • group
    Setterset_button_group(value)
    Getterget_button_group()

    ButtonGroup associated to the button.

    • keep_pressed_outside
    Default
    Setterset_keep_pressed_outside(value)
    Getteris_keep_pressed_outside()

    If true, the button stays pressed when moving the cursor outside the button while pressing it.

    If true, the button’s state is pressed. Means the button is pressed down or toggled (if is active).

    Setterset_shortcut(value)
    Getterget_shortcut()

    associated to the button.

    • bool shortcut_in_tooltip
    Defaulttrue
    Setterset_shortcut_in_tooltip(value)
    Getteris_shortcut_in_tooltip_enabled()

    If true, the button will add information about its shortcut in the tooltip.

    • toggle_mode
    Defaultfalse
    Setterset_toggle_mode(value)
    Getteris_toggle_mode()

    If true, the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.

    • void _pressed ( ) virtual

    Called when the button is pressed. If you need to know the button’s pressed state (and toggle_mode is active), use instead.

    • void _toggled ( bool button_pressed ) virtual

    Called when the button is toggled (only if is active).

    Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to “draw” signal. The visual state of the button is defined by the enum.

    • bool is_hovered ( ) const

    Returns if the mouse has entered the button and has not left it yet.