UserConfirmationInterface Class Reference

Interface class to abstract user confirmation actions from physical implementations All physical user confirmation classes must extend this This allows the use of the button on a rotary encoder, other buttons, touch screens, and other user interface methods that can trigger single click, double click, or long press type actions. More...

#include <UserConfirmationInterface.h>

Inheritance diagram for UserConfirmationInterface:

Public Member Functions
virtual void	begin ()=0
	Implement this to perform any initial startup methods or activities.
virtual UserConfirmationAction	getUserConfirmationAction ()=0
	Implement this to check for any user confirmation actions This should be called at least once per main loop iteration.
virtual	~UserConfirmationInterface ()=default
	Destructor for the object.

Detailed Description

Interface class to abstract user confirmation actions from physical implementations All physical user confirmation classes must extend this This allows the use of the button on a rotary encoder, other buttons, touch screens, and other user interface methods that can trigger single click, double click, or long press type actions.

Constructor & Destructor Documentation

~UserConfirmationInterface()

virtual UserConfirmationInterface::~UserConfirmationInterface ( )

virtualdefault

Destructor for the object.

Member Function Documentation

begin()

virtual void UserConfirmationInterface::begin ( )

pure virtual

Implement this to perform any initial startup methods or activities.

Implemented in Button.

Here is the caller graph for this function:

getUserConfirmationAction()

virtual UserConfirmationAction UserConfirmationInterface::getUserConfirmationAction ( )

pure virtual

Implement this to check for any user confirmation actions This should be called at least once per main loop iteration.

Returns

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

Implemented in Button.

Here is the caller graph for this function:

---

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

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