Button()
Button class allowing to check the state of a button. Note: If the GUI is focused, all buttons are treated as released.
Attributes:
name
[value: string, type: str]
long_press_time
[value: time in ms for a press to be considered long, type: int]
double_press_time
[value: time between two presses to treat them as a double press, type: int]
autorepeat_delay_time
[value: time before autorepeat starts, type: int]
autorepeat_interval_time
[value: time between autorepeats, type: int]
press_time
[value: if pressed, time since the button was last pressed, otherwise 0, type: int]
is_pressed
[value: whether currently pressed, type: bool]
is_just_pressed
[value: whether became pressed this tick, type: bool]
is_just_released
[value: whether became released (not pressed) this tick, type: bool]
is_long_pressed
[value: whether currently being long pressed, type: bool]
is_just_long_pressed
[value: whether currently being pressed, and just became long pressed this tick - RECOMMENDED FOR DETECTING A LONG PRESS, type: bool]
is_just_short_released
[value: whether just released after a short press - RECOMMENDED FOR DETECTING A SHORT PRESS, type: bool]
is_just_long_released
[value: whether just released after a long press, type: bool]
is_just_double_pressed
[value: whether just became pressed shortly after a previous short press, type: bool]
is_double_pressed
[value: whether currently pressed, shortly after a previous short press (the second press can be long), type: bool]
is_just_double_released
[value: whether just released after a double press - RECOMMENDED FOR DETECTING A DOUBLE PRESS, type: bool]
is_pressed_autorepeat
[value: whether this tick should invoke an autorepeated action - RECOMMENDED FOR AUTOREPEATED ACTIONS LIKE SCROLLING, type: bool]
release()
[returns: None
]
reset_params()
[returns: None
]
print_info(print_header)
[returns: None
]
file: src/io/engine_io_buttons.c
landing