Public Member Functions | Friends | List of all members
TextMenuItem Class Reference

#include <RuntimeMenuItem.h>

Inheritance diagram for TextMenuItem:
EditableMultiPartMenuItem RuntimeMenuItem MenuItem

Public Member Functions

 TextMenuItem (RuntimeRenderingFn customRenderFn, uint16_t id, int size, MenuItem *next=nullptr)
void setPasswordField (bool pwd)
bool isPasswordField () const
uint8_t textLength () const
void setTextValue (const char *text, bool silent=false)
const char * getTextValue () const
void cleanUpArray ()
- Public Member Functions inherited from EditableMultiPartMenuItem
 EditableMultiPartMenuItem (MenuType type, uint16_t id, 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, uint16_t id, 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
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
uint16_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)


int textItemRenderFn (RuntimeMenuItem *item, uint8_t row, RenderFnMode mode, char *buffer, int bufferSize)

Additional Inherited Members

- Protected Member Functions inherited from MenuItem
 MenuItem (MenuType menuType, const AnyMenuInfo *menuInfo, MenuItem *next, bool infoProgMem)
- Protected Attributes inherited from RuntimeMenuItem
uint16_t id
uint8_t itemPosition
uint8_t noOfParts
- Protected Attributes inherited from MenuItem
uint16_t flags
union {
const AnyMenuInfoinfo
RuntimeRenderingFn renderFn
MenuType menuType

Detailed Description

An item that can represent a text value that is held in RAM, and therefore change at runtime. We now manually configure the settings for this menu item in the constructor. This variant gets the name from program memory

Member Function Documentation

◆ textLength()

uint8_t TextMenuItem::textLength ( ) const

get the max length of the text storage

◆ setTextValue()

void TextMenuItem::setTextValue ( const char *  text,
bool  silent = false 

Copies the text into the internal buffer.

textthe text to be copied.

◆ getTextValue()

const char* TextMenuItem::getTextValue ( ) const

returns the text value in the internal buffer

◆ cleanUpArray()

void TextMenuItem::cleanUpArray ( )

Called after the array has been changed to ensure that it is in a good state for editing. IE zero's extended to the end.

Friends And Related Function Documentation

◆ textItemRenderFn

int textItemRenderFn ( RuntimeMenuItem item,
uint8_t  row,
RenderFnMode  mode,
char *  buffer,
int  bufferSize 

This is the standard renderering function used for editable text items, for use with TextMenuItem

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