DCC-EX Simple Throttle
Simple throttle for a DCC-EX CommandStation
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
ErrorScreen Class Reference

#include <ErrorScreen.h>

Inheritance diagram for ErrorScreen:
Inheritance graph
[legend]
Collaboration diagram for ErrorScreen:
Collaboration graph
[legend]

Public Member Functions

 ErrorScreen ()
 Constructor for the error 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 setErrorMessage (const char *errorMessage)
 Set the error message to be displayed.
 
- Public Member Functions inherited from ScreenInterface
virtual ~ScreenInterface ()=default
 Destructor for the object.
 
ScreenInterfacegetNext ()
 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 * _errorMessage
 

Constructor & Destructor Documentation

◆ ErrorScreen()

ErrorScreen::ErrorScreen ( )

Constructor for the error screen.

Member Function Documentation

◆ drawScreen()

void ErrorScreen::drawScreen ( DisplayInterface display)
overridevirtual

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

Parameters
displayPointer to the display object

Implements ScreenInterface.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleUserConfirmationAction()

void ErrorScreen::handleUserConfirmationAction ( UserConfirmationAction  action)
overridevirtual

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

Parameters
actionUserConfirmationAction::[None|SingleClick|DoubleClick|LongPress]

Implements ScreenInterface.

◆ handleUserSelectionAction()

void ErrorScreen::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
actionUserSelectionAction::[None|Up|UpFaster|UpFastest|Down|DownFaster|DownFastest]
throttleInvertedTrue|False

Implements ScreenInterface.

◆ setErrorMessage()

void ErrorScreen::setErrorMessage ( const char *  errorMessage)

Set the error message to be displayed.

Parameters
errorMessageError message
Here is the caller graph for this function:

Member Data Documentation

◆ _errorMessage

const char* ErrorScreen::_errorMessage
private

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