This is an old version of the documentation. View the latest version here.
Control Surface  1.0.0
MIDI Control Surface library for Arduino
Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Attributes | List of all members
IncrementDecrementButtons Class Reference

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

#include <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...
 

Protected Member Functions

State updateImplementation ()
 

Private Types

enum  { Initial, LongPress, AfterReset }
 

Private Attributes

Button incrementButton
 
Button decrementButton
 
enum 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 22 of file IncrementDecrementButtons.hpp.

Member Enumeration Documentation

◆ 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.

Definition at line 49 of file IncrementDecrementButtons.hpp.

◆ anonymous enum

anonymous enum
private
Enumerator
Initial 
LongPress 
AfterReset 

Definition at line 84 of file IncrementDecrementButtons.hpp.

Constructor & Destructor Documentation

◆ IncrementDecrementButtons()

IncrementDecrementButtons::IncrementDecrementButtons ( const Button incrementButton,
const Button decrementButton 
)
inline

Create a IncrementDecrementButtons object.

Parameters
incrementButtonThe button to increment the counter.
The button is copied.
decrementButtonThe button to decrement the counter.
The button is copied.

Definition at line 34 of file IncrementDecrementButtons.hpp.

Member Function Documentation

◆ begin()

void IncrementDecrementButtons::begin ( )
inline
See also
Button::begin

Definition at line 39 of file IncrementDecrementButtons.hpp.

◆ update()

State IncrementDecrementButtons::update ( )
inline

Update and return the state of the increment/decrement button.

Definition at line 59 of file IncrementDecrementButtons.hpp.

◆ getState()

State IncrementDecrementButtons::getState ( ) const
inline

Return the state of the increment/decrement button without updating it.

Returns the same value as the last update call.

Definition at line 67 of file IncrementDecrementButtons.hpp.

◆ updateImplementation()

IncrementDecrementButtons::State IncrementDecrementButtons::updateImplementation ( )
protected

Definition at line 6 of file IncrementDecrementButtons.cpp.

Member Data Documentation

◆ incrementButton

Button IncrementDecrementButtons::incrementButton
private

Definition at line 81 of file IncrementDecrementButtons.hpp.

◆ decrementButton

Button IncrementDecrementButtons::decrementButton
private

Definition at line 82 of file IncrementDecrementButtons.hpp.

◆ longPressState

enum { ... } IncrementDecrementButtons::longPressState

◆ longPressRepeat

unsigned long IncrementDecrementButtons::longPressRepeat
private

Definition at line 89 of file IncrementDecrementButtons.hpp.

◆ state

State IncrementDecrementButtons::state = Nothing
private

Definition at line 90 of file IncrementDecrementButtons.hpp.


The documentation for this class was generated from the following files: