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

Menu to allow for extra actions to be performed For future use, not actually enabled yet. More...

#include <SelectActionMenu.h>

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

Public Member Functions

 SelectActionMenu (const char *name, EventManager *eventManager)
 Constructor for each menu.
 
void handleUserConfirmationAction (UserConfirmationAction action) override
 Implement this method to respond to user confirmation actions.
 
- Public Member Functions inherited from BaseMenu
void handleUserSelectionAction (UserSelectionAction action)
 Method to respond to user selection actions.
 
void displayMenu (DisplayInterface *displayInterface)
 Method to display the menu on screen.
 
void setMenuName (const char *name)
 Set the name of this menu.
 
const char * getMenuName ()
 Get the name of this menu.
 
void addItem (BaseMenuItem *menuItem)
 Add a menu item to this menu.
 
BaseMenuItemgetFirstMenuItem ()
 Get the first menu item associated with this menu.
 
BaseMenuItemgetMenuItemAtIndex (uint8_t index)
 Get the menu item at the specified index.
 
uint8_t getMenuItemCount ()
 Get the number of menu items associated with this menu.
 
uint8_t getSelectedItemIndex ()
 Get the index of the currently selected menu item.
 
bool getSelectionChanged ()
 Check if the user selection has changed.
 
void setEventManager (EventManager *eventManager)
 Set the application's event manager instance.
 
EventManagergetEventManager ()
 Get the application's event manager instance.
 

Private Member Functions

void _selectAction (uint8_t actionIndex)
 Publish the Event chosen by the select action.
 

Detailed Description

Menu to allow for extra actions to be performed For future use, not actually enabled yet.

Constructor & Destructor Documentation

◆ SelectActionMenu()

SelectActionMenu::SelectActionMenu ( const char *  name,
EventManager eventManager 
)

Constructor for each menu.

Parameters
namePointer to the char array containing the name of the menu
eventManagerPointer to the event manager for the application
Here is the call graph for this function:

Member Function Documentation

◆ _selectAction()

void SelectActionMenu::_selectAction ( uint8_t  actionIndex)
private

Publish the Event chosen by the select action.

Parameters
actionIndexIndex of the action containing the Event
Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleUserConfirmationAction()

void SelectActionMenu::handleUserConfirmationAction ( UserConfirmationAction  action)
overridevirtual

Implement this method to respond to user confirmation actions.

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

Implements BaseMenu.

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

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