AbleButtons V0.4.0
Lightweight button library for Arduino.
 
Loading...
Searching...
No Matches
ButtonState Struct Reference

Structure for remembering the state of each button. More...

#include <Checks.h>

Public Attributes

bool isPressed
 Button is pressed. More...
 
bool isHeld
 Button is held. More...
 
bool isIdle
 Button is idle. More...
 
bool isClicked
 Button clicked (pressed+released). More...
 
bool isSingleClicked
 Button single-clicked. More...
 
bool isDoubleClicked
 Button double-clicked. More...
 
bool wasStarted
 Button received begin callback. More...
 
bool wasPressed
 Button received pressed callback. More...
 
bool wasReleased
 Button received released callback. More...
 
bool wasHeld
 Button received held callback. More...
 
bool wasIdle
 Button received idle callback. More...
 
bool wasClicked
 Button received clicked callback. More...
 
bool wasSingleClicked
 Button received single-clicked callback. More...
 
bool resetSingleClicked
 
bool wasDoubleClicked
 Button received double-clicked callback. More...
 
bool resetDoubleClicked
 

Detailed Description

Structure for remembering the state of each button.

Used to compare to the current state to track different checks.

Definition at line 13 of file Checks.h.

Member Data Documentation

◆ isClicked

bool ButtonState::isClicked

Button clicked (pressed+released).

Definition at line 18 of file Checks.h.

◆ isDoubleClicked

bool ButtonState::isDoubleClicked

Button double-clicked.

Definition at line 22 of file Checks.h.

◆ isHeld

bool ButtonState::isHeld

Button is held.

Definition at line 15 of file Checks.h.

◆ isIdle

bool ButtonState::isIdle

Button is idle.

Definition at line 16 of file Checks.h.

◆ isPressed

bool ButtonState::isPressed

Button is pressed.

Definition at line 14 of file Checks.h.

◆ isSingleClicked

bool ButtonState::isSingleClicked

Button single-clicked.

Definition at line 21 of file Checks.h.

◆ resetDoubleClicked

bool ButtonState::resetDoubleClicked

Definition at line 37 of file Checks.h.

◆ resetSingleClicked

bool ButtonState::resetSingleClicked

Definition at line 35 of file Checks.h.

◆ wasClicked

bool ButtonState::wasClicked

Button received clicked callback.

Definition at line 31 of file Checks.h.

◆ wasDoubleClicked

bool ButtonState::wasDoubleClicked

Button received double-clicked callback.

Definition at line 36 of file Checks.h.

◆ wasHeld

bool ButtonState::wasHeld

Button received held callback.

Definition at line 28 of file Checks.h.

◆ wasIdle

bool ButtonState::wasIdle

Button received idle callback.

Definition at line 29 of file Checks.h.

◆ wasPressed

bool ButtonState::wasPressed

Button received pressed callback.

Definition at line 26 of file Checks.h.

◆ wasReleased

bool ButtonState::wasReleased

Button received released callback.

Definition at line 27 of file Checks.h.

◆ wasSingleClicked

bool ButtonState::wasSingleClicked

Button received single-clicked callback.

Definition at line 34 of file Checks.h.

◆ wasStarted

bool ButtonState::wasStarted

Button received begin callback.

Definition at line 25 of file Checks.h.


The documentation for this struct was generated from the following file: