Public Member Functions | List of all members
Rgb32MenuItem Class Reference

#include <ScrollChoiceMenuItem.h>

Inheritance diagram for Rgb32MenuItem:
EditableMultiPartMenuItem RuntimeMenuItem MenuItem

Public Member Functions

 Rgb32MenuItem (uint16_t id, RuntimeRenderingFn renderFn, bool includeAlpha, MenuItem *next=nullptr)
RgbColor32getUnderlying ()
RgbColor32 getColorData ()
void setColorData (const RgbColor32 &other)
bool isAlphaInUse () const
- Public Member Functions inherited from EditableMultiPartMenuItem
 EditableMultiPartMenuItem (MenuType type, menuid_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, menuid_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
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 RuntimeMenuItem
menuid_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

A Menu item that can display and edit RGB values that are 32 bits wide, that is 8 bit per element and an optional alpha channel. This is based on editable runtime menu item.

Constructor & Destructor Documentation

◆ Rgb32MenuItem()

Rgb32MenuItem::Rgb32MenuItem ( uint16_t  id,
RuntimeRenderingFn  renderFn,
bool  includeAlpha,
MenuItem next = nullptr 

Creates a color data menu item that can be edited, optionally including an alpha channel

idthe id of the item
renderFnthe rendering function to use - see default in the class definition
includeAlphatrue to include alpha channel, otherwise false.
nextoptional pointer to the next menu item

Member Function Documentation

◆ getUnderlying()

RgbColor32* Rgb32MenuItem::getUnderlying ( )
the underlying color data that can be directly modified.

◆ getColorData()

RgbColor32 Rgb32MenuItem::getColorData ( )
a copy of the underlying color data

◆ setColorData()

void Rgb32MenuItem::setColorData ( const RgbColor32 other)

copy the color data provided as the latest

otherthe new color data

◆ isAlphaInUse()

bool Rgb32MenuItem::isAlphaInUse ( ) const
true if the alpha channel is in use for this menuitem, otherwise false.

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