MainMenu Class Reference

Main menu for the SoloController application. More...

#include <Menu.h>

Inheritance diagram for MainMenu:

Public Member Functions
void	begin (void) override
	Initializes the MainMenu object. Should be called before first use.
void	update (void) override
	Updates the values and graphics displayed in the menu.
void	show (void) override
	Shows the menu in the TFT.
Public Member Functions inherited from SoloMenu
uint16_t	x (void) const
	Upper-left x-coordinate for menu.
uint16_t	y (void) const
	Upper-left y-coordinate for menu.
uint16_t	width (void) const
	Width of the menu.
uint16_t	height (void) const
	Height of the menu.
void	loadConfig (void)
	Loads configuration data from EEPROM, placing it into RAM.
virtual void	checkButtons (void)
	Check to see if one of the menu's buttons has been pressed.
virtual void	releaseButton (void)
	Releases the currently pressed button.

Static Public Member Functions
static MainMenu &	getInstance (void)
	Returns reference to the ErrMsg object.
static bool	hasScreenBeenTouched (void)
	Determines if the TFT screen has been touched.

Additional Inherited Members
Protected Member Functions inherited from SoloMenu
	SoloMenu (void)
	Creates a full size menu.
	SoloMenu (uint16_t x0, uint16_t y0, uint16_t width, uint16_t height)
	Creates a menu of the specified size and location.
	~SoloMenu (void)=default
	Default Destructor.
int8_t	_pressButtonIfTouched (void)
	Protected method checks to see if one of the buttons has been "touched." If so, this method "presses" the button.
void	_register (Button **buttonPtrArray, uint8_t nButtons)
	Registers an array of buttons with this class.

Detailed Description

Main menu for the SoloController application.

This menu provides the primary user interface for the SoloController application. Note that the callback functions used by MainMenu are contained within the CB:::MAIN namespace. This object uses significant DRAM resources. So, it has been implemented as a Singleton object.

Member Function Documentation

begin()

void MainMenu::begin ( void )

overridevirtual

Initializes the MainMenu object. Should be called before first use.

Parameters

None.

Reimplemented from SoloMenu.

getInstance()

static MainMenu & MainMenu::getInstance ( void )

inlinestatic

Returns reference to the ErrMsg object.

Returns

Reference to the ErrMsg object

show()

void MainMenu::show ( void )

inlineoverridevirtual

Shows the menu in the TFT.

Parameters

None.

Implements SoloMenu.

update()

void MainMenu::update ( void )

overridevirtual

Updates the values and graphics displayed in the menu.

Parameters

None.

Reimplemented from SoloMenu.

---

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

• C:/Users/david/Documents/PlatformIO/Solo_Controller/Solo_Controller_Repo/src/Menu.h
• C:/Users/david/Documents/PlatformIO/Solo_Controller/Solo_Controller_Repo/src/Menu.cpp