Selector with two buttons (one to increment, one to decrement).
More...
#include <Selectors/IncrementDecrementSelector.hpp>
|
| IncrementDecrementSelector (Selectable< N > &selectable, const AH::IncrementDecrementButtons &buttons, Wrap wrap=Wrap::Wrap) |
|
void | begin () override |
| Initialize this updatable. More...
|
|
void | update () override |
| Update this updatable. More...
|
|
void | invert () |
|
AH::IncrementDecrementButtons::State | getButtonsState () const |
|
void | reset () |
| Reset the selection to the initial selection. More...
|
|
void | set (setting_t newSetting) |
| Select the given selection. More...
|
|
void | increment (Wrap wrap) |
| Add one to the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range. More...
|
|
void | decrement (Wrap wrap) |
| Subtract one from the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range. More...
|
|
setting_t | get () const |
| Get the current selection/setting. More...
|
|
void | enable () |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
|
|
void | disable () |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...
|
|
bool | isEnabled () |
| Check if this updatable is enabled. More...
|
|
template<setting_t N>
class IncrementDecrementSelector< N >
Selector with two buttons (one to increment, one to decrement).
Pressing two buttons simultaneously resets to the default setting.
- Template Parameters
-
- Examples
- Bank-Button-Matrix.ino, ManyAddressesPCButton.ino, MCU-OLED-SSD1306-MEGA.ino, MCU-OLED-SSD1306.ino, One-Pot-Both-PB-and-CC.ino, and Transposer.ino.
Definition at line 66 of file IncrementDecrementSelector.hpp.
◆ Parent
◆ IncrementDecrementSelector()
◆ begin()
|
inlineoverridevirtualinherited |
◆ update()
|
inlineoverridevirtualinherited |
◆ invert()
◆ getButtonsState()
◆ reset()
Reset the selection to the initial selection.
Definition at line 81 of file Selector.hpp.
◆ set()
Select the given selection.
- Parameters
-
newSetting | The new setting to select [0, N-1]. |
Definition at line 89 of file Selector.hpp.
◆ increment()
void increment |
( |
Wrap |
wrap | ) |
|
|
inlineinherited |
Add one to the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.
- Parameters
-
wrap | Wrap or clamp if the new setting would be out of range. |
Definition at line 105 of file Selector.hpp.
◆ decrement()
void decrement |
( |
Wrap |
wrap | ) |
|
|
inlineinherited |
Subtract one from the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.
- Parameters
-
wrap | Wrap or clamp if the new setting would be out of range. |
Definition at line 124 of file Selector.hpp.
◆ get()
Get the current selection/setting.
Definition at line 47 of file Selector.hpp.
◆ enable() [1/4]
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 45 of file Updatable.hpp.
◆ enable() [2/4]
◆ enable() [3/4]
◆ enable() [4/4]
static void enable |
( |
U(&) |
array[N] | ) |
|
|
inlinestaticinherited |
◆ disable() [1/4]
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 55 of file Updatable.hpp.
◆ disable() [2/4]
◆ disable() [3/4]
◆ disable() [4/4]
static void disable |
( |
U(&) |
array[N] | ) |
|
|
inlinestaticinherited |
◆ isEnabled()
Check if this updatable is enabled.
- Note
- Assumes that the updatable is not added to a different linked list by the user.
Definition at line 69 of file Updatable.hpp.
◆ beginAll()
◆ updateAll()
static void updateAll |
( |
| ) |
|
|
inlinestaticinherited |
◆ buttons
◆ wrap
◆ selectable
◆ callback
◆ setting
The selection of the selector.
It is saved in the selector as well as the selectable, because you need it in order to implement increment/decrement methods.
Definition at line 53 of file Selector.hpp.
◆ updatables
◆ next
◆ previous
The documentation for this class was generated from the following file: