A class for buttons that increment and decrement some counter or setting. More...

#include <AH/Hardware/IncrementDecrementButtons.hpp>

Collaboration diagram for IncrementDecrementButtons:

Public Types
enum	State { Nothing = 0, Increment, Decrement, Reset }
	An enumeration of the different actions to be performed by the counter. More...

Public Member Functions
	IncrementDecrementButtons (const Button &incrementButton, const Button &decrementButton)
	Create a IncrementDecrementButtons object. More...

void	begin ()

State	update ()
	Update and return the state of the increment/decrement button. More...

State	getState () const
	Return the state of the increment/decrement button without updating it. More...

void	invert ()

Protected Member Functions
State	updateImplementation ()

Private Types
enum	{ Initial, LongPress, AfterReset }

Private Attributes
Button	incrementButton

Button	decrementButton

enum AH::IncrementDecrementButtons:: { ... }	longPressState = Initial

unsigned long	longPressRepeat

State	state = Nothing

Detailed Description

A class for buttons that increment and decrement some counter or setting.

It behaves the same way as a computer keyboard: when you press the increment (decrement) button, it increments (decrements) the counter once. If you keep on pressing it for longer than a certain threshold, it keeps on incrementing (decrementing) at a faster rate, until you release it.
If both the increment and the decrement button are pressed at once, it resets the counter.

Definition at line 25 of file IncrementDecrementButtons.hpp.

Member Enumeration Documentation

◆ State

enum State

An enumeration of the different actions to be performed by the counter.

Todo:: Add states for initial press.

Enumerator
Nothing	The counter should not be incremented.
Increment	The counter should be incremented.
Decrement	The counter should be decremented.
Reset	The counter should be reset to the initial value.