BaseButton

Hereda: Control < CanvasItem < Node < Object

Heredado por: Button, LinkButton, TextureButton

Clase base abstracta para botones GUI.

Descripción

BaseButton es una clase base abstracta para botones de interfaz gráfica. No muestra nada por sí sola.

Propiedades

ActionMode

action_mode

1

ButtonGroup

button_group

BitField[MouseButtonMask]

button_mask

1

bool

button_pressed

false

bool

disabled

false

FocusMode

focus_mode

2 (overrides Control)

bool

keep_pressed_outside

false

Shortcut

shortcut

bool

shortcut_feedback

true

bool

shortcut_in_tooltip

true

bool

toggle_mode

false

Métodos

void

_pressed() virtual

void

_toggled(toggled_on: bool) virtual

DrawMode

get_draw_mode() const

bool

is_hovered() const

void

set_pressed_no_signal(pressed: bool)

Señales

button_down() 🔗

Emitida cuando el botón comienza a ser presionado.

button_up() 🔗

Emitida cuando el botón deja de ser presionado.

pressed() 🔗

Emitida cuando el botón se conmuta o se presiona. Esto está en button_down si el action_mode es ACTION_MODE_BUTTON_PRESS y en button_up en caso contrario.

Si necesitas saber el estado de pulsación del botón (y toggle_mode está activo), utiliza toggled en su lugar.

toggled(toggled_on: bool) 🔗

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 toggled_on argument.

Enumeraciones

enum DrawMode: 🔗

DrawMode DRAW_NORMAL = 0

El estado normal (es decir, no presionado, no encima del botón, no activado y activado) de los botones.

DrawMode DRAW_PRESSED = 1

El estado de los botones se presiona.

DrawMode DRAW_HOVER = 2

El estado de los botones que tienen el cursor encima.

DrawMode DRAW_DISABLED = 3

El estado de los botones está desactivado.

DrawMode DRAW_HOVER_PRESSED = 4

El estado de los botones cuyo cursor esta encima y se presiona.

enum ActionMode: 🔗

ActionMode ACTION_MODE_BUTTON_PRESS = 0

Requiere sólo una pulsación para considerar el botón pulsado.

ActionMode ACTION_MODE_BUTTON_RELEASE = 1

Requiere de una pulsación y una posterior liberación antes de considerar el botón pulsado.

Descripciones de Propiedades

ActionMode action_mode = 1 🔗

Determina cuándo se considera que se hizo clic en el botón.

ButtonGroup button_group 🔗

The ButtonGroup associated with the button. Not to be confused with node groups.

Note: The button will be configured as a radio button if a ButtonGroup is assigned to it.

BitField[MouseButtonMask] button_mask = 1 🔗

Máscara binaria para elegir a qué botones del ratón responderá este botón.

Para permitir clics izquierdo y derecho, utiliza MOUSE_BUTTON_MASK_LEFT | MOUSE_BUTTON_MASK_RIGHT.

bool button_pressed = false 🔗

  • void set_pressed(value: bool)

  • bool is_pressed()

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

Note: Changing the value of button_pressed will result in toggled to be emitted. If you want to change the pressed state without emitting that signal, use set_pressed_no_signal().

bool disabled = false 🔗

  • void set_disabled(value: bool)

  • bool is_disabled()

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

Note: If the button is disabled while held down, button_up will be emitted.

bool keep_pressed_outside = false 🔗

  • void set_keep_pressed_outside(value: bool)

  • bool is_keep_pressed_outside()

Si es true, el botón permanecee pulsado cuando el cursor se mueve fuera mientras se presiona.

Nota: Esta propiedad solo afecta la apariencia visual del botón. Se emitirán señales en el mismo momento sin tener en cuenta el valor de esta propiedad.

Shortcut shortcut 🔗

Shortcut asociado al botón.

bool shortcut_feedback = true 🔗

  • void set_shortcut_feedback(value: bool)

  • bool is_shortcut_feedback()

If true, the button will highlight for a short amount of time when its shortcut is activated. If false and toggle_mode is false, the shortcut will activate without any visual feedback.

bool shortcut_in_tooltip = true 🔗

  • void set_shortcut_in_tooltip(value: bool)

  • bool is_shortcut_in_tooltip_enabled()

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

Note: This property does nothing when the tooltip control is customized using Control._make_custom_tooltip().

bool toggle_mode = false 🔗

  • void set_toggle_mode(value: bool)

  • bool is_toggle_mode()

Si es true, el botón está en modo de conmutación. Hace que el botón cambie de estado entre presionado y no presionado cada vez que se hace clic en su área.

Descripciones de Métodos

void _pressed() virtual 🔗

Se llama cuando se presiona el botón. Si necesitas saber el estado de pulsación del botón (y toggle_mode está activo), utiliza en su lugar el _toggled().

void _toggled(toggled_on: bool) virtual 🔗

Se llama cuando se cambia el estado del botón(Activado/Desactivado) (sólo si toggle_mode está activo).

DrawMode get_draw_mode() const 🔗

Devuelve el estado visual utilizado para dibujar el botón. Esto es útil principalmente cuando implementas tu propio código de dibujo, ya sea anulando _draw() o conectando la señal de "dibujo". El estado visual del botón está definido por el enum DrawMode.

bool is_hovered() const 🔗

Devuelve true si el ratón ha entrado en el botón y no lo ha dejado todavía.

void set_pressed_no_signal(pressed: bool) 🔗

Changes the button_pressed state of the button, without emitting toggled. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if toggle_mode is true.

Note: This method doesn't unpress other buttons in button_group.