Class diagram

The class diagram shows the relationships between the classes in the LcdMenu library.

@startuml skinparam backgroundColor #FFFFFF60 ' https://www.plantuml.com/plantuml/uml/ hide empty members left to right direction class InputInterface { virtual void observe() } class DisplayInterface { #uint8_t maxCols #uint8_t maxRows #uint8_t cursorRow #uint8_t blinkerPosition +bool isEditModeEnabled +virtual void begin() +uint8_t getMaxRows() const +uint8_t getMaxCols() const +virtual void clear() +virtual void setBacklight(bool enabled) +virtual void drawItem(uint8_t row, const char* text) +virtual void drawItem(uint8_t row, const char* text, char separator, char* value) +virtual void clearCursor() +virtual void drawCursor() +virtual void moveCursor(uint8_t newCursorRow) +void setEditModeEnabled(bool enabled) +bool getEditModeEnabled() +uint8_t getCursorRow() const +virtual void clearBlinker() +virtual void drawBlinker() +virtual void resetBlinker(uint8_t blinkerPosition) +uint8_t getBlinkerPosition() const +virtual bool drawChar(char c) +virtual void clearUpIndicator() +virtual void drawUpIndicator() +virtual void clearDownIndicator() +virtual void drawDownIndicator() +virtual void restartTimer() } class LcdMenu { -bool enabled +DisplayInterface* getDisplay() +MenuScreen* getScreen() +void setScreen(MenuScreen* screen) +uint8_t getCursor() +MenuItem* getItemAt(uint8_t position) +void setCursor(uint8_t cursor) +bool process(const unsigned char c) +void reset() +void hide() +void show() +void refresh() } class MenuScreen { -uint8_t cursor -uint8_t view +void setParent(MenuScreen* parent) +MenuItem* operator[](const uint8_t position) +uint8_t getCursor() +MenuItem* getItemAt(uint8_t position) #void setCursor(DisplayInterface* display, uint8_t position) #bool process(LcdMenu* menu, const unsigned char command) #void draw(DisplayInterface* display) #bool up(DisplayInterface* display) #bool down(DisplayInterface* display) #bool back(LcdMenu* menu) #uint8_t itemsCount() } class MenuItem { #const char* text +const char* getText() +void setText(const char* text) #virtual bool process(LcdMenu* menu, const unsigned char command) #const void draw(DisplayInterface* display) #virtual void draw(DisplayInterface* display, uint8_t row) } InputInterface -r-> "1" LcdMenu : menu LcdMenu -r-> "1" DisplayInterface : display LcdMenu -d-> "1" MenuScreen : screen MenuScreen -d-> "1..*" MenuItem : items MenuScreen --> "0..1" MenuScreen : parent LcdMenu::process .. MenuScreen::process LcdMenu::getCursor .. MenuScreen::getCursor LcdMenu::setCursor .. MenuScreen::setCursor LcdMenu::getItemAt .. MenuScreen::getItemAt MenuScreen::process .. MenuItem::process MenuScreen::draw .. MenuItem::draw @enduml

@startuml skinparam backgroundColor #FFFFFF60 ' https://www.plantuml.com/plantuml/uml/ hide empty members left to right direction class MenuItem { #const char* text +const char* getText() +void setText(const char* text) #virtual bool process(LcdMenu* menu, const unsigned char command) #const void draw(DisplayInterface* display) #virtual void draw(DisplayInterface* display, uint8_t row) } class ItemBack { #bool process(LcdMenu* menu, const unsigned char command) override .. #void changeScreen(LcdMenu* menu) } class ItemSubMenu { #bool process(LcdMenu* menu, const unsigned char command) override .. #void changeScreen(LcdMenu* menu) } class ItemToggle { #bool process(LcdMenu* menu, const unsigned char command) override .. #void toggle(DisplayInterface* display) } class ItemCommand { #bool process(LcdMenu* menu, const unsigned char command) override .. #void executeCommand() } class ItemInput { #bool process(LcdMenu* menu, const unsigned char command) override .. #void up(DisplayInterface* display) #void down(DisplayInterface* display) #void enter(DisplayInterface* display) #void back(DisplayInterface* display) #void left(DisplayInterface* display) #void right(DisplayInterface* display) #void backspace(DisplayInterface* display) #void typeChar(DisplayInterface* display, const unsigned char command) #void clear(DisplayInterface* display) } class ItemInputCharset { #bool process(LcdMenu* menu, const unsigned char command) override .. #void initCharEdit() #void abortCharEdit(DisplayInterface* display) #void commitCharEdit(DisplayInterface* display) #void showNextChar(DisplayInterface* display) #void showPreviousChar(DisplayInterface* display) } class ItemList { #bool process(LcdMenu* menu, const unsigned char command) override .. #void selectPrevious(DisplayInterface* display) #void selectNext(DisplayInterface* display) } class ItemProgress { #bool process(LcdMenu* menu, const unsigned char command) override .. +void increment() +void decrement() } class EditMode as "???" { } note bottom of EditMode : Someone who holds edit mode ItemBack -u-|> MenuItem ItemSubMenu -u-|> MenuItem ItemToggle -u-|> MenuItem ItemCommand -u-|> MenuItem EditMode -u-|> MenuItem ItemList -u-|> EditMode ItemProgress -u-|> EditMode ItemInput -u-|> EditMode ItemInputCharset -u-|> ItemInput @enduml