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 Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
DisplayElement Class Referenceabstract

An interface for elements that draw to a display. More...

#include <DisplayElement.hpp>

Inheritance diagram for DisplayElement:
Collaboration diagram for DisplayElement:

Public Member Functions

virtual ~DisplayElement ()
 
virtual void draw ()=0
 Draw this DisplayElement to the display buffer. More...
 
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 Member Functions

 DisplayElement (DisplayInterface &display)
 Create a new DisplayElement. More...
 

Protected Attributes

DisplayInterfacedisplay
 
DisplayElementnext
 
DisplayElementprevious
 

Static Protected Attributes

static DoublyLinkedList< DisplayElementelements
 

Detailed Description

An interface for elements that draw to a display.

Definition at line 11 of file DisplayElement.hpp.

Constructor & Destructor Documentation

◆ DisplayElement()

DisplayElement::DisplayElement ( DisplayInterface display)
inlineprotected

Create a new DisplayElement.

Parameters
displayThe display that this display element draws to.

Definition at line 19 of file DisplayElement.hpp.

◆ ~DisplayElement()

virtual DisplayElement::~DisplayElement ( )
inlinevirtual

Definition at line 30 of file DisplayElement.hpp.

Member Function Documentation

◆ draw()

virtual void DisplayElement::draw ( )
pure virtual

◆ getDisplay() [1/2]

DisplayInterface& DisplayElement::getDisplay ( )
inline

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

Definition at line 36 of file DisplayElement.hpp.

◆ getDisplay() [2/2]

const DisplayInterface& DisplayElement::getDisplay ( ) const
inline

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

Definition at line 38 of file DisplayElement.hpp.

◆ getAll()

static DoublyLinkedList<DisplayElement>& DisplayElement::getAll ( )
inlinestatic

Get the list of all DisplayElement instances.

Definition at line 41 of file DisplayElement.hpp.

Member Data Documentation

◆ display

DisplayInterface& DisplayElement::display
protected

Definition at line 44 of file DisplayElement.hpp.

◆ elements

DoublyLinkedList< DisplayElement > DisplayElement::elements
staticprotected

Definition at line 46 of file DisplayElement.hpp.

◆ next

DisplayElement * DoublyLinkable< DisplayElement >::next
protectedinherited

Definition at line 301 of file LinkedList.hpp.

◆ previous

DisplayElement * DoublyLinkable< DisplayElement >::previous
protectedinherited

Definition at line 302 of file LinkedList.hpp.


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