#include <Selectors/Selector.hpp>
A Selector with an empty callback.
N | The number of possible settings. |
Definition at line 154 of file Selector.hpp.
Enabling and disabling updatables | |
void | enable () |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. | |
void | disable () |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. | |
bool | isEnabled () const |
Check if this updatable is enabled. | |
void | moveDown () |
Move down this element in the list. | |
static void | enable (UpdatableCRTP *element) |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. | |
static void | enable (UpdatableCRTP &element) |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. | |
template<class U , size_t N> | |
static void | enable (U(&array)[N]) |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. | |
static void | disable (UpdatableCRTP *element) |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. | |
static void | disable (UpdatableCRTP &element) |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. | |
template<class U , size_t N> | |
static void | disable (U(&array)[N]) |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. | |
Main initialization and updating methods | |
static void | beginAll () |
Begin all enabled instances of this class. | |
static void | updateAll () |
Update all enabled instances of this class. | |
Public Member Functions | |
Selector (Selectable< N > &selectable) | |
Constructor. | |
void | begin () override |
Initialize this updatable. | |
void | update () override |
Update this updatable. | |
void | reset () |
Reset the selection to the initial selection. | |
void | set (setting_t newSetting) |
Select the given selection. | |
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. | |
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. | |
setting_t | get () const |
Get the current selection/setting. | |
Public Attributes | |
Callback | callback |
Protected Attributes | |
setting_t | setting = 0 |
The selection of the selector. | |
Derived * | next |
Derived * | previous |
Static Protected Attributes | |
static DoublyLinkedList< Derived > | updatables |
Private Attributes | |
Selectable< N > & | selectable |
|
inline |
Constructor.
Definition at line 157 of file Selector.hpp.
|
inlineoverridevirtualinherited |
Initialize this updatable.
Implements Updatable< T >.
Reimplemented in GenericSwitchSelector< Callback >, and GenericSwitchSelector< SelectorSingleLEDCallback >.
Definition at line 72 of file Selector.hpp.
|
inlineoverridevirtualinherited |
Update this updatable.
Implements Updatable< T >.
Reimplemented in GenericSwitchSelector< Callback >, and GenericSwitchSelector< SelectorSingleLEDCallback >.
Definition at line 77 of file Selector.hpp.
Reset the selection to the initial selection.
Definition at line 80 of file Selector.hpp.
Select the given selection.
newSetting | The new setting to select [0, N-1]. |
Definition at line 93 of file Selector.hpp.
Add one to the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.
wrap | Wrap or clamp if the new setting would be out of range. |
Definition at line 109 of file Selector.hpp.
Subtract one from the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.
wrap | Wrap or clamp if the new setting would be out of range. |
Definition at line 128 of file Selector.hpp.
|
inlineinherited |
Get the current selection/setting.
Definition at line 46 of file Selector.hpp.
Begin all enabled instances of this class.
Definition at line 182 of file Updatable.hpp.
Update all enabled instances of this class.
Definition at line 186 of file Updatable.hpp.
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 96 of file Updatable.hpp.
|
inlinestaticinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 125 of file Updatable.hpp.
|
inlinestaticinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 127 of file Updatable.hpp.
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 130 of file Updatable.hpp.
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 106 of file Updatable.hpp.
|
inlinestaticinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 136 of file Updatable.hpp.
|
inlinestaticinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 138 of file Updatable.hpp.
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 141 of file Updatable.hpp.
Check if this updatable is enabled.
Definition at line 120 of file Updatable.hpp.
Move down this element in the list.
Definition at line 147 of file Updatable.hpp.
|
privateinherited |
Definition at line 141 of file Selector.hpp.
Definition at line 144 of file Selector.hpp.
|
protectedinherited |
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 52 of file Selector.hpp.
|
staticprotectedinherited |
Definition at line 152 of file Updatable.hpp.
|
protectedinherited |
Definition at line 320 of file LinkedList.hpp.
|
protectedinherited |
Definition at line 321 of file LinkedList.hpp.