ProgressScreen Class Reference

#include <ProgressScreen.h>

Inheritance diagram for ProgressScreen:

Collaboration diagram for ProgressScreen:

Public Member Functions
	ProgressScreen ()
	Constructor for the progress screen.
void	handleUserConfirmationAction (UserConfirmationAction action) override
	Implement this method to define what to do when user confirmation actions are performed.
void	handleUserSelectionAction (UserSelectionAction action, bool throttleInverted=false) override
	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.
void	drawScreen (DisplayInterface *display) override
	Implement this method to draw the associated screen object on the specified display.
void	setActivity (const char *activity)
	Set the current activity in progress.
void	setCounter (uint8_t counter)
	Set the current attempt in progress.
Public Member Functions inherited from ScreenInterface
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
const char *	_activity
uint8_t	_counter

Constructor & Destructor Documentation

ProgressScreen()

ProgressScreen::ProgressScreen

(

)

Constructor for the progress screen.

Member Function Documentation

drawScreen()

void ProgressScreen::drawScreen ( DisplayInterface *  display )

overridevirtual

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

Parameters

display

Pointer to the display object

Implements ScreenInterface.

Here is the call graph for this function:

Here is the caller graph for this function:

handleUserConfirmationAction()

void ProgressScreen::handleUserConfirmationAction ( UserConfirmationAction  action )

overridevirtual

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

Parameters

action

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

Implements ScreenInterface.

handleUserSelectionAction()

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

overridevirtual

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

Implements ScreenInterface.

setActivity()

void ProgressScreen::setActivity

(

const char *

activity

)

Set the current activity in progress.

Parameters

activity

Activity text to display

Here is the caller graph for this function:

setCounter()

void ProgressScreen::setCounter

(

uint8_t

counter

)

Set the current attempt in progress.

Parameters

counter

Current attempt count

Here is the caller graph for this function:

Member Data Documentation

_activity

const char* ProgressScreen::_activity

private

_counter

uint8_t ProgressScreen::_counter

private

---

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

• /home/runner/work/DCCEXSimpleThrottle/DCCEXSimpleThrottle/ProgressScreen.h
• /home/runner/work/DCCEXSimpleThrottle/DCCEXSimpleThrottle/ProgressScreen.cpp