BaseButton

    Inherited By: , LinkButton,

    Category: Core

    Base class for different kinds of buttons.

    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.

    This signal is emitted every time the button is toggled or pressed (i.e. activated, so on if “Click on press” is active and on button_up otherwise).

    • toggled ( button_pressed )

    This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode 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

    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.

    Description

    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.

    Setterset_action_mode(value)
    Getterget_action_mode()

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

    • button_mask

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

    To allow both left-click and right-click, set this to 3, because it’s BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT.

    Setterset_disabled(value)
    Getteris_disabled()

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

    Setterset_enabled_focus_mode(value)
    Getterget_enabled_focus_mode()

    Focus access mode to use when switching between enabled/disabled (see and disabled).

    • group
    Setterset_pressed(value)
    Getteris_pressed()

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

    • shortcut
    Setterset_shortcut(value)
    Getterget_shortcut()

    ShortCut associated to the button.

    • shortcut_in_tooltip

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

    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.

    Method Descriptions

    • void _pressed ( ) virtual

    Called when the button is pressed.

    • void _toggled ( button_pressed ) virtual

    Called when the button is toggled (only if toggle_mode 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 DRAW_* enum.

    • is_hovered ( ) const