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

#include <MenuItems.h>

Inheritance diagram for ActionMenuItem:
MenuItem

Public Member Functions

 ActionMenuItem (const AnyMenuInfo *info, MenuItem *next, bool infoInProgmem=INFO_LOCATION_PGM)
 
- 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)
 
bool isChanged () const
 
bool isSendRemoteNeeded (uint8_t remoteNo) const
 
void setSendRemoteNeededAll ()
 
void clearSendRemoteNeededAll ()
 
void setSendRemoteNeeded (uint8_t remoteNo, bool needed)
 
void setActive (bool active)
 
bool isActive () const
 
void setEditing (bool active)
 
bool isEditing () const
 
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 *next)
 
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 MenuItem
uint16_t flags
 
MenuItemnext
 
union {
const AnyMenuInfoinfo
 
RuntimeRenderingFn renderFn
 
}; 
 
MenuType menuType
 

Detailed Description

ActionMenuItem is for situations where you want an action to take place when the item is selected. This will call the callback function when the OK button is pressed, or remotely triggered by sending a suitable trigger command through the API.

Constructor & Destructor Documentation

◆ ActionMenuItem()

ActionMenuItem::ActionMenuItem ( const AnyMenuInfo info,
MenuItem next,
bool  infoInProgmem = INFO_LOCATION_PGM 
)
inline

Create an instance of the class

Parameters
infoa AnyMenuInfo structure
nextthe next menu in the chain if there is one, or NULL.

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