tcMenu
Public Member Functions | List of all members
LocalDialogButtonMenuItem Class Reference

#include <BaseDialog.h>

Inheritance diagram for LocalDialogButtonMenuItem:
RuntimeMenuItem MenuItem

Public Member Functions

 LocalDialogButtonMenuItem (RuntimeRenderingFn renderFn, menuid_t id, int btnNum, MenuItem *next)
 
int getButtonNumber ()
 
- 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
 
MenuItemgetNext () 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
 
MenuItemnext
 
const AnyMenuInfoinfo = nullptr
 
RuntimeRenderingFn renderFn = nullptr
 
MenuType menuType
 

Detailed Description

This menu type is reserved only for use within dialogs, never use this button outside of that purpose. Button numbers 0..15 are reserved and should never be used by application code. Use 15..255 in application code.

Constructor & Destructor Documentation

◆ LocalDialogButtonMenuItem()

LocalDialogButtonMenuItem::LocalDialogButtonMenuItem ( RuntimeRenderingFn  renderFn,
menuid_t  id,
int  btnNum,
MenuItem next 
)
inline

Create a extra local dialog button, never create on with a button number lower than 2 because 0 and 1 are reserved. Ideally the button numbers should follow in sequence from 2 onwards.

Parameters
renderFnnearly always set this to dialogButtonRenderFn
idthe ID, if you don't care about this, set it to nextRandomId()
btnNumthe button number
nextthe next menu item in the list

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