tcgfx::RuntimeTitleMenuItem Class Reference

#include <RuntimeTitleMenuItem.h>

Inheritance diagram for tcgfx::RuntimeTitleMenuItem:

Public Member Functions
	RuntimeTitleMenuItem (uint16_t id, MenuItem *next)
void	setTitleHeaderPgm (const char *header)
void	setTitleOverridePgm (const char *overrideTitle)
void	clearTitleOverride ()
const char *	getTitleHeaderPgm () const
void	setCallback (MenuCallbackFn titleCb)
MenuCallbackFn	getCallback () const
Public Member Functions inherited from RuntimeMenuItem
	RuntimeMenuItem (MenuType menuType, menuid_t id, RuntimeRenderingFn renderFn, uint8_t itemPosition, uint8_t numberOfRows, MenuItem *next=nullptr)
	RuntimeMenuItem (const AnyMenuInfo *rtInfo, bool isPgm, MenuType menuType, RuntimeRenderingFn renderFn, uint8_t itemPosition, uint8_t numberOfRows, MenuItem *next=nullptr)
void	copyValue (char *buffer, int bufferSize) const
void	runCallback () const
int	getRuntimeId () const
int	getRuntimeEeprom () const
uint8_t	getNumberOfParts () const
void	copyRuntimeName (char *buffer, int bufferSize) const
uint8_t	getNumberOfRows () const
uint8_t	getItemPosition () const
void	setNumberOfRows (uint8_t rows)
Public Member Functions inherited from MenuItem
uint8_t	copyNameToBuffer (char *sz, int size) const
uint8_t	copyNameToBuffer (char *sz, int offset, int size) const
menuid_t	getId () const
uint16_t	getMaximumValue () const
uint16_t	getEepromPosition () const
MenuType	getMenuType () const
void	triggerCallback () const
bool	isInfoProgMem () const
void	setChanged (bool changed)
void	setChanged (int num, bool changed)
bool	isChanged (int num=0) const
bool	isSendRemoteNeeded (uint8_t remoteNo) const
void	setSendRemoteNeededAll ()
void	clearSendRemoteNeededAll ()
void	setSendRemoteNeeded (uint8_t remoteNo, bool needed)
void	setReadOnly (bool active)
bool	isReadOnly () const
void	setLocalOnly (bool localOnly)
bool	isLocalOnly () const
void	setSecured (bool secured)
bool	isSecured () const
void	setVisible (bool visible)
bool	isVisible () const
MenuItem *	getNext () const
void	setNext (MenuItem *pNext)
void	changeOccurred (bool silent)

Additional Inherited Members
Protected Member Functions inherited from MenuItem
	MenuItem (MenuType menuType, const AnyMenuInfo *menuInfo, MenuItem *next, bool infoProgMem)
Protected Attributes inherited from RuntimeMenuItem
menuid_t	id
uint8_t	itemPosition
uint8_t	noOfParts
Protected Attributes inherited from MenuItem
uint16_t	flags
MenuItem *	next
const AnyMenuInfo *	info = nullptr
RuntimeRenderingFn	renderFn = nullptr
MenuType	menuType

Detailed Description

This menu item extension class handles the title row, for the root menu. It stores a header in program memory and a possible callback function for when it is actioned. This menu item also allows the header text to be overridden too.

Constructor & Destructor Documentation

RuntimeTitleMenuItem()

tcgfx::RuntimeTitleMenuItem::RuntimeTitleMenuItem ( uint16_t id, MenuItem * next )

inline

There should only be one instance of this class, it is constructed globally by the library, you can access this instance as

Parameters

id
next

Member Function Documentation

setTitleHeaderPgm()

void tcgfx::RuntimeTitleMenuItem::setTitleHeaderPgm ( const char * header )

inline

This should only be called by the menu library, to override what's displayed on the title you use the setTitleOverridePgm instead.

Parameters

header

the new header text

setTitleOverridePgm()

void tcgfx::RuntimeTitleMenuItem::setTitleOverridePgm ( const char * overrideTitle )

inline

In order to override the title with user specific text that overrides the regular title set use this method.

Parameters

overrideTitle

the text to override

clearTitleOverride()

void tcgfx::RuntimeTitleMenuItem::clearTitleOverride ( )

inline

Call this to clear an override that was previously set, so that the regular header text is displayed instead.

---

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

• src/graphics/RuntimeTitleMenuItem.h