RSeries astromech firmware
CommandScreen Class Referenceabstract

#include <menus/CommandScreen.h>

+ Inheritance diagram for CommandScreen:
+ Collaboration diagram for CommandScreen:

Public Member Functions

 CommandScreen (CommandScreenHandler &handler, ScreenID id, SerialCommand *cmds=nullptr, uint8_t siz=0)
 
ScreenID ID () const
 
uint8_t getSelected () const
 
virtual void init ()
 
virtual void exit ()
 
virtual void handleSelection (uint8_t selection)
 
virtual void render ()=0
 
virtual bool handleEvent ()
 
virtual bool isActive ()
 
virtual bool isStatus ()
 
void switchToScreen (ScreenID id)
 
void pushScreen (ScreenID id)
 
void popScreen ()
 
void restoreScreen ()
 
unsigned getKeyRepeatRate () const
 
void setKeyRepeatRate (unsigned ms)
 
virtual void buttonUpPressed (bool repeat=false)
 
virtual void buttonLeftPressed (bool repeat=false)
 
virtual void buttonDownPressed (bool repeat=false)
 
virtual void buttonRightPressed (bool repeat=false)
 
virtual void buttonInPressed (bool repeat=false)
 
virtual void buttonUpReleased ()
 
virtual void buttonLeftReleased ()
 
virtual void buttonDownReleased ()
 
virtual void buttonRightReleased ()
 
virtual void buttonInReleased ()
 
virtual void buttonDial (long newValue, long oldValue=0)
 

Protected Member Functions

void clearSelection ()
 
bool hasMenu ()
 

Static Protected Member Functions

static void toggleMaskBit (uint8_t &mask, uint8_t bit)
 
static void toggleMaskBit (uint16_t &mask, uint16_t bit)
 

Protected Attributes

ScreenID fID
 
CommandMenu fMenu
 
uint8_t fLastTag
 
unsigned fKeyRepeatRateMS = 0
 

Constructor & Destructor Documentation

◆ CommandScreen()

CommandScreen::CommandScreen ( CommandScreenHandler handler,
ScreenID  id,
SerialCommand cmds = nullptr,
uint8_t  siz = 0 
)
inline

Member Function Documentation

◆ buttonDial()

virtual void CommandScreen::buttonDial ( long  newValue,
long  oldValue = 0 
)
inlinevirtual

◆ buttonDownPressed()

virtual void CommandScreen::buttonDownPressed ( bool  repeat = false)
inlinevirtual

◆ buttonDownReleased()

virtual void CommandScreen::buttonDownReleased ( )
inlinevirtual

◆ buttonInPressed()

virtual void CommandScreen::buttonInPressed ( bool  repeat = false)
inlinevirtual

◆ buttonInReleased()

virtual void CommandScreen::buttonInReleased ( )
inlinevirtual

◆ buttonLeftPressed()

virtual void CommandScreen::buttonLeftPressed ( bool  repeat = false)
inlinevirtual

◆ buttonLeftReleased()

virtual void CommandScreen::buttonLeftReleased ( )
inlinevirtual

Reimplemented in MenuScreen.

◆ buttonRightPressed()

virtual void CommandScreen::buttonRightPressed ( bool  repeat = false)
inlinevirtual

◆ buttonRightReleased()

virtual void CommandScreen::buttonRightReleased ( )
inlinevirtual

Reimplemented in MenuScreen.

◆ buttonUpPressed()

virtual void CommandScreen::buttonUpPressed ( bool  repeat = false)
inlinevirtual

◆ buttonUpReleased()

virtual void CommandScreen::buttonUpReleased ( )
inlinevirtual

◆ clearSelection()

void CommandScreen::clearSelection ( )
inlineprotected

◆ exit()

virtual void CommandScreen::exit ( )
inlinevirtual

◆ getKeyRepeatRate()

unsigned CommandScreen::getKeyRepeatRate ( ) const
inline

◆ getSelected()

uint8_t CommandScreen::getSelected ( ) const
inline

◆ handleEvent()

virtual bool CommandScreen::handleEvent ( )
inlinevirtual

◆ handleSelection()

virtual void CommandScreen::handleSelection ( uint8_t  selection)
inlinevirtual

◆ hasMenu()

bool CommandScreen::hasMenu ( )
inlineprotected

◆ ID()

ScreenID CommandScreen::ID ( ) const
inline

◆ init()

virtual void CommandScreen::init ( )
inlinevirtual

◆ isActive()

virtual bool CommandScreen::isActive ( )
inlinevirtual

◆ isStatus()

virtual bool CommandScreen::isStatus ( )
inlinevirtual

◆ popScreen()

void CommandScreen::popScreen ( )
inline

◆ pushScreen()

void CommandScreen::pushScreen ( ScreenID  id)
inline

◆ render()

virtual void CommandScreen::render ( )
pure virtual

◆ restoreScreen()

void CommandScreen::restoreScreen ( )
inline

◆ setKeyRepeatRate()

void CommandScreen::setKeyRepeatRate ( unsigned  ms)
inline

◆ switchToScreen()

void CommandScreen::switchToScreen ( ScreenID  id)
inline

◆ toggleMaskBit() [1/2]

static void CommandScreen::toggleMaskBit ( uint16_t &  mask,
uint16_t  bit 
)
inlinestaticprotected

◆ toggleMaskBit() [2/2]

static void CommandScreen::toggleMaskBit ( uint8_t &  mask,
uint8_t  bit 
)
inlinestaticprotected

Member Data Documentation

◆ fID

ScreenID CommandScreen::fID
protected

◆ fKeyRepeatRateMS

unsigned CommandScreen::fKeyRepeatRateMS = 0
protected

◆ fLastTag

uint8_t CommandScreen::fLastTag
protected

◆ fMenu

CommandMenu CommandScreen::fMenu
protected

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