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

#include <RuntimeMenuItem.h>

Inheritance diagram for TimeFormattedMenuItem:
EditableMultiPartMenuItem RuntimeMenuItem MenuItem

Public Member Functions

 TimeFormattedMenuItem (RuntimeRenderingFn renderFn, menuid_t id, MultiEditWireType format, MenuItem *next=nullptr)
 
 TimeFormattedMenuItem (RuntimeRenderingFn renderFn, const TimeStorage &initial, menuid_t id, MultiEditWireType format, MenuItem *next=nullptr)
 
 TimeFormattedMenuItem (const AnyMenuInfo *info, RuntimeRenderingFn renderFn, const TimeStorage &initial, MultiEditWireType format, MenuItem *next=nullptr, bool isPgm=INFO_LOCATION_PGM)
 
 TimeFormattedMenuItem (const AnyMenuInfo *info, const TimeStorage &initial, MultiEditWireType format, MenuItem *next=nullptr, bool isPgm=INFO_LOCATION_PGM)
 
TimeStorage getTime () const
 
void setTime (TimeStorage newTime)
 
void setTimeFromString (const char *time)
 
MultiEditWireType getFormat () const
 
TimeStorage * getUnderlyingData ()
 
- Public Member Functions inherited from EditableMultiPartMenuItem
 EditableMultiPartMenuItem (MenuType type, menuid_t id, int numberOfParts, RuntimeRenderingFn renderFn, MenuItem *next=nullptr)
 
 EditableMultiPartMenuItem (const AnyMenuInfo *rtInfo, bool isPgm, MenuType type, int numberOfParts, RuntimeRenderingFn renderFn, MenuItem *next=nullptr)
 
uint8_t beginMultiEdit ()
 
int changeEditBy (int amt)
 
int previousPart ()
 
int nextPart ()
 
int getCurrentRange () const
 
void stopMultiEdit ()
 
int getPartValueAsInt () const
 
bool valueChanged (int newVal)
 
- 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

A runtime menu item that represents time value, either in the 24 hour clock or in the 12 hour clock. Further, the hundreds can be configured to show as well. It is an extension of the multi part editor that supports editing times in parts, hours, then minutes and so on. Instances of this class should use the timeItemRenderFn for the base rendering.

Member Function Documentation

◆ getTime()

TimeStorage TimeFormattedMenuItem::getTime ( ) const
inline

gets the time as four separate bytes

◆ setTime()

void TimeFormattedMenuItem::setTime ( TimeStorage  newTime)
inline

sets the time

◆ setTimeFromString()

void TimeFormattedMenuItem::setTimeFromString ( const char *  time)

sets a time from a string in the form HH:MM:SS[.ss]

◆ getFormat()

MultiEditWireType TimeFormattedMenuItem::getFormat ( ) const
inline

gets the formatting currently being used.

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