Control Surface master
MIDI Control Surface library for Arduino
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
TimeDisplayDisplay Class Reference

#include <Display/MCU/TimeDisplayDisplay.hpp>

Detailed Description

Examples
MCU-OLED-SSD1306-x2.ino, and MCU-OLED-SSD1306.ino.

Definition at line 11 of file TimeDisplayDisplay.hpp.

+ Inheritance diagram for TimeDisplayDisplay:
+ Collaboration diagram for TimeDisplayDisplay:

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. More...
 
void disable ()
 Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display. More...
 
bool isEnabled () const
 Check if this display element is enabled. More...
 
static void enable (DisplayElement *element)
 Enable this display element: insert it into the linked list of instances, so it gets drawn to the display. More...
 
static void enable (DisplayElement &element)
 Enable this display element: insert it into the linked list of instances, so it gets drawn to the display. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 

Public Member Functions

 TimeDisplayDisplay (DisplayInterface &display, TimeDisplay &timedisplay, PixelLocation loc, uint8_t size, uint16_t color)
 
void draw () override
 Draw this DisplayElement to the display buffer. More...
 
bool getDirty () const override
 Check if this DisplayElement has to be re-drawn. More...
 
int16_t getX () const
 
int16_t getY () const
 
uint8_t getSize () const
 
uint16_t getColor () const
 
void setX (int16_t x)
 
void setY (int16_t y)
 
void setSize (uint8_t size)
 
void setColor (uint16_t color)
 
DisplayInterfacegetDisplay ()
 Get a reference to the display that this element draws to. More...
 
const DisplayInterfacegetDisplay () const
 Get a const reference to the display that this element draws to. More...
 

Static Public Member Functions

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

Protected Attributes

DisplayInterfacedisplay
 
DisplayElementnext
 
DisplayElementprevious
 

Static Protected Attributes

static DoublyLinkedList< DisplayElementelements
 

Private Attributes

TimeDisplaytimedisplay
 
int16_t x
 
int16_t y
 
uint8_t size
 
uint16_t color
 

Constructor & Destructor Documentation

◆ TimeDisplayDisplay()

TimeDisplayDisplay ( DisplayInterface display,
TimeDisplay timedisplay,
PixelLocation  loc,
uint8_t  size,
uint16_t  color 
)
inline

Definition at line 13 of file TimeDisplayDisplay.hpp.

Member Function Documentation

◆ draw()

void draw ( )
inlineoverridevirtual

Draw this DisplayElement to the display buffer.

Implements DisplayElement.

Definition at line 18 of file TimeDisplayDisplay.hpp.

◆ getDirty()

bool getDirty ( ) const
inlineoverridevirtual

Check if this DisplayElement has to be re-drawn.

Implements DisplayElement.

Definition at line 35 of file TimeDisplayDisplay.hpp.

◆ getX()

int16_t getX ( ) const
inline

Definition at line 37 of file TimeDisplayDisplay.hpp.

◆ getY()

int16_t getY ( ) const
inline

Definition at line 38 of file TimeDisplayDisplay.hpp.

◆ getSize()

uint8_t getSize ( ) const
inline

Definition at line 39 of file TimeDisplayDisplay.hpp.

◆ getColor()

uint16_t getColor ( ) const
inline

Definition at line 40 of file TimeDisplayDisplay.hpp.

◆ setX()

void setX ( int16_t  x)
inline

Definition at line 42 of file TimeDisplayDisplay.hpp.

◆ setY()

void setY ( int16_t  y)
inline

Definition at line 43 of file TimeDisplayDisplay.hpp.

◆ setSize()

void setSize ( uint8_t  size)
inline

Definition at line 44 of file TimeDisplayDisplay.hpp.

◆ setColor()

void setColor ( uint16_t  color)
inline

Definition at line 45 of file TimeDisplayDisplay.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 33 of file DisplayElement.hpp.

◆ enable() [2/4]

static 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]

static 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]

static 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 43 of file DisplayElement.hpp.

◆ disable() [2/4]

static 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]

static 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]

static 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 57 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()

static DoublyLinkedList< DisplayElement > & getAll ( )
inlinestaticinherited

Get the list of all DisplayElement instances.

Definition at line 100 of file DisplayElement.hpp.

Member Data Documentation

◆ timedisplay

TimeDisplay& timedisplay
private

Definition at line 48 of file TimeDisplayDisplay.hpp.

◆ x

int16_t x
private

Definition at line 49 of file TimeDisplayDisplay.hpp.

◆ y

int16_t y
private

Definition at line 49 of file TimeDisplayDisplay.hpp.

◆ size

uint8_t size
private

Definition at line 50 of file TimeDisplayDisplay.hpp.

◆ color

uint16_t color
private

Definition at line 51 of file TimeDisplayDisplay.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 324 of file LinkedList.hpp.

◆ previous

DisplayElement * previous
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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