Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
SelectorDisplay Class Reference
Display Elements

#include <Display/SelectorDisplay.hpp>

Detailed Description

A class for displaying the setting of a Selector object.

Definition at line 13 of file SelectorDisplay.hpp.

Inheritance diagram for SelectorDisplay:
Collaboration diagram for SelectorDisplay:

Enabling and disabling display elements

void enable ()
 Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.
void disable ()
 Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.
bool isEnabled () const
 Check if this display element is enabled.
static void enable (DisplayElement *element)
 Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.
static void enable (DisplayElement &element)
 Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.
template<class U, size_t N>
static void enable (U(&array)[N])
 Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.
static void disable (DisplayElement *element)
 Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.
static void disable (DisplayElement &element)
 Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.
template<class U, size_t N>
static void disable (U(&array)[N])
 Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.

Public Member Functions

 SelectorDisplay (DisplayInterface &display, SelectorBase &selector, int16_t offset, int16_t multiplier, PixelLocation loc, uint8_t size, uint16_t color)
void draw () override
 Draw this DisplayElement to the display buffer.
bool getDirty () const override
 Check if this DisplayElement has to be re-drawn.
DisplayInterface & getDisplay ()
 Get a reference to the display that this element draws to.
const DisplayInterface & getDisplay () const
 Get a const reference to the display that this element draws to.

Static Public Member Functions

static DoublyLinkedList< DisplayElement > & getAll ()
 Get the list of all DisplayElement instances.

Protected Attributes

DisplayInterface & display
DisplayElement * next

Static Protected Attributes

static DoublyLinkedList< DisplayElement > elements

Private Attributes

SelectorBase & selector
setting_t previous = NoSetting
int16_t offset
int16_t multiplier
int16_t x
int16_t y
uint8_t size
uint16_t color

Constructor & Destructor Documentation

◆ SelectorDisplay()

SelectorDisplay ( DisplayInterface & display,
SelectorBase & selector,
int16_t offset,
int16_t multiplier,
PixelLocation loc,
uint8_t size,
uint16_t color )
inline

Definition at line 15 of file SelectorDisplay.hpp.

Member Function Documentation

◆ draw()

void draw ( )
inlineoverridevirtual

Draw this DisplayElement to the display buffer.

Implements DisplayElement.

Definition at line 21 of file SelectorDisplay.hpp.

◆ getDirty()

bool getDirty ( ) const
inlineoverridevirtual

Check if this DisplayElement has to be re-drawn.

Implements DisplayElement.

Definition at line 30 of file SelectorDisplay.hpp.

◆ enable() [1/4]

void enable ( )
inlineprotectedinherited

Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.

Definition at line 35 of file DisplayElement.hpp.

◆ enable() [2/4]

void enable ( DisplayElement * element)
inlinestaticprotectedinherited

Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.

Definition at line 62 of file DisplayElement.hpp.

◆ enable() [3/4]

void enable ( DisplayElement & element)
inlinestaticprotectedinherited

Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.

Definition at line 64 of file DisplayElement.hpp.

◆ enable() [4/4]

template<class U, size_t N>
void enable ( U(&) array[N])
inlinestaticprotectedinherited

Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.

Definition at line 67 of file DisplayElement.hpp.

◆ disable() [1/4]

void disable ( )
inlineprotectedinherited

Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.

Definition at line 45 of file DisplayElement.hpp.

◆ disable() [2/4]

void disable ( DisplayElement * element)
inlinestaticprotectedinherited

Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.

Definition at line 73 of file DisplayElement.hpp.

◆ disable() [3/4]

void disable ( DisplayElement & element)
inlinestaticprotectedinherited

Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.

Definition at line 75 of file DisplayElement.hpp.

◆ disable() [4/4]

template<class U, size_t N>
void disable ( U(&) array[N])
inlinestaticprotectedinherited

Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.

Definition at line 78 of file DisplayElement.hpp.

◆ isEnabled()

bool isEnabled ( ) const
inlineprotectedinherited

Check if this display element is enabled.

Note
Assumes that the element is not added to a different linked list by the user.

Definition at line 59 of file DisplayElement.hpp.

◆ getDisplay() [1/2]

DisplayInterface & getDisplay ( )
inlineinherited

Get a reference to the display that this element draws to.

Definition at line 95 of file DisplayElement.hpp.

◆ getDisplay() [2/2]

const DisplayInterface & getDisplay ( ) const
inlineinherited

Get a const reference to the display that this element draws to.

Definition at line 97 of file DisplayElement.hpp.

◆ getAll()

DoublyLinkedList< DisplayElement > & getAll ( )
inlinestaticinherited

Get the list of all DisplayElement instances.

Definition at line 100 of file DisplayElement.hpp.

Member Data Documentation

◆ selector

SelectorBase& selector
private

Definition at line 33 of file SelectorDisplay.hpp.

◆ previous

setting_t previous = NoSetting
private

Definition at line 34 of file SelectorDisplay.hpp.

◆ offset

int16_t offset
private

Definition at line 35 of file SelectorDisplay.hpp.

◆ multiplier

int16_t multiplier
private

Definition at line 35 of file SelectorDisplay.hpp.

◆ x

int16_t x
private

Definition at line 35 of file SelectorDisplay.hpp.

◆ y

int16_t y
private

Definition at line 35 of file SelectorDisplay.hpp.

◆ size

uint8_t size
private

Definition at line 36 of file SelectorDisplay.hpp.

◆ color

uint16_t color
private

Definition at line 37 of file SelectorDisplay.hpp.

◆ display

DisplayInterface& display
protectedinherited

Definition at line 103 of file DisplayElement.hpp.

◆ elements

DoublyLinkedList< DisplayElement > elements
staticprotectedinherited

Definition at line 105 of file DisplayElement.hpp.

◆ next

DisplayElement* next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

The documentation for this class was generated from the following file:
Generated by doxygen 1.17.0