ScreenInterface Class Reference

#include <ScreenInterface.h>

Inheritance diagram for ScreenInterface:

Collaboration diagram for ScreenInterface:

Public Member Functions
virtual void	handleUserConfirmationAction (UserConfirmationAction action)=0
	Implement this method to define what to do when user confirmation actions are performed.
virtual void	handleUserSelectionAction (UserSelectionAction action, bool throttleInverted=false)=0
	Implement this method to define what to do when user selection actions are performed throttleInverted enables an interface to decrease speed when moving up and vice versa, which is handy for a rotary encoder.
virtual void	drawScreen (DisplayInterface *display)=0
	Implement this method to draw the associated screen object on the specified display.
virtual	~ScreenInterface ()=default
	Destructor for the object.
ScreenInterface *	getNext ()
	Get the next screen object in the linked list.
void	setNext (ScreenInterface *screen)
	Set the next screen object in the linked list.

Private Attributes
ScreenInterface *	_next

Constructor & Destructor Documentation

~ScreenInterface()

virtual ScreenInterface::~ScreenInterface ( )

virtualdefault

Destructor for the object.

Member Function Documentation

drawScreen()

virtual void ScreenInterface::drawScreen ( DisplayInterface *  display )

pure virtual

Implement this method to draw the associated screen object on the specified display.

Parameters

display

Pointer to the display object

Implemented in ErrorScreen, MenuScreen, ProgressScreen, StartupScreen, and ThrottleScreen.

getNext()

ScreenInterface * ScreenInterface::getNext ( )

inline

Get the next screen object in the linked list.

Returns

Pointer to the screen object

handleUserConfirmationAction()

virtual void ScreenInterface::handleUserConfirmationAction ( UserConfirmationAction  action )

pure virtual

Implement this method to define what to do when user confirmation actions are performed.

Parameters

action

UserConfirmationAction::[None|SingleClick|DoubleClick|LongPress]

Implemented in ErrorScreen, MenuScreen, ProgressScreen, StartupScreen, and ThrottleScreen.

handleUserSelectionAction()

virtual void ScreenInterface::handleUserSelectionAction ( UserSelectionAction  action, bool  throttleInverted = false  )

pure virtual

Implement this method to define what to do when user selection actions are performed throttleInverted enables an interface to decrease speed when moving up and vice versa, which is handy for a rotary encoder.

Parameters

action	UserSelectionAction::[None|Up|UpFaster|UpFastest|Down|DownFaster|DownFastest]
throttleInverted	True|False

Implemented in MenuScreen, StartupScreen, ThrottleScreen, ErrorScreen, and ProgressScreen.

setNext()

void ScreenInterface::setNext ( ScreenInterface *  screen )

inline

Set the next screen object in the linked list.

Parameters

screen

Pointer to a screen object

Member Data Documentation

_next

ScreenInterface* ScreenInterface::_next

private

---

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

• /home/runner/work/DCCEXSimpleThrottle/DCCEXSimpleThrottle/ScreenInterface.h