CharacterDisplayRenderer

class CharacterDisplayRenderer : public MenuRenderer
#include <CharacterDisplayRenderer.h>

A renderer for character-based displays, extending the MenuRenderer class.

This class provides functionality to render menus on character-based displays. It supports custom icons for cursor and edit cursor, as well as up and down arrows for navigation indicators.

The CharacterDisplayRenderer class is designed to work with displays that implement the CharacterDisplayInterface. It provides methods to draw menu items, cursors, and navigation indicators. The class also handles text truncation and cursor movement.

Note

The class uses dynamic memory allocation for the upArrow and downArrow icons.

Public Functions

CharacterDisplayRenderer(CharacterDisplayInterface *display, const uint8_t maxCols, const uint8_t maxRows, const uint8_t cursorIcon = 0x7E, const uint8_t editCursorIcon = 0x7F, uint8_t *upArrow = new uint8_t[8]{0x04, 0x0E, 0x1F, 0x04, 0x04, 0x04, 0x04, 0x04}, uint8_t *downArrow = new uint8_t[8]{0x04, 0x04, 0x04, 0x04, 0x04, 0x1F, 0x0E, 0x04})

Constructor for CharacterDisplayRenderer. Initializes the renderer with the display, maximum columns, and maximum rows. Also sets the up and down arrow icons, cursor icons, and edit cursor icons.

Note

slots 0 and 1 are reserved for up and down arrow icons. The available custom characters slots are 2 to 7.

Parameters:

  • display – A pointer to the CharacterDisplayInterface object.

  • maxCols – The maximum number of columns on the display.

  • maxRows – The maximum number of rows on the display.

  • cursorIcon – A byte representing the cursor icon, default is →, if 0, cursor will not be displayed

  • editCursorIcon – A byte representing the edit cursor icon, default is ←, if 0, edit cursor will not be displayed

  • upArrow – A pointer to an array of bytes representing the up arrow icon, default is ↑, if null, up arrow will not be displayed

  • downArrow – A pointer to an array of bytes representing the down arrow icon, default is ↓, if null, down arrow will not be displayed

virtual void begin() override

Initializes the renderer and creates custom characters on the display.

virtual void drawItem(const char *text, const char *value, bool paddWithBlanks) override

Draws a menu item on the character display.

This function overrides the base class implementation to draw a menu item on the character display. It handles appending a cursor to the text, truncating the text if it’s too long, padding the text with spaces, appending an indicator to the text, and finally drawing the text on the display.

Parameters:

  • text – The text of the menu item to be drawn.

  • value – The value of the menu item to be drawn.

  • paddWithBlanks – A flag indicating whether to pad the text with spaces.

virtual void draw(uint8_t byte) override

Function to draw a byte on the display.

Parameters:

byte – The byte to be drawn.

virtual void drawBlinker() override

Function to draw the blinker on the display.

virtual void clearBlinker() override

Function to clear the blinker from the display.

virtual void moveCursor(uint8_t cursorCol, uint8_t cursorRow) override

Moves the cursor to a specified position.

Parameters:

  • cursorCol – Column position to move the cursor to.

  • cursorRow – Row position to move the cursor to.

Protected Functions

virtual uint8_t getEffectiveCols() const override

Calculates the available horizontal space for displaying content.

This function computes the number of columns available for displaying content on the display. It takes into account the presence of up and down arrows, which occupy one column if either is present.

Returns:

The number of columns available for displaying content.

inline void drawText(const char *text, uint8_t &col, uint8_t viewShift)

Draws text on the display.

This function draws text on the display, handling text truncation and shifting. It takes into account the viewShift parameter to shift the text by a specified number of columns.

Parameters:

  • text – The text to be drawn on the display.

  • col – The column position to start drawing the text. This parameter will be updated to the new column position after drawing the text.

  • viewShift – The number of columns to shift the text by.

Protected Attributes

uint8_t *upArrow
uint8_t *downArrow
const uint8_t cursorIcon
const uint8_t editCursorIcon
const uint8_t availableColumns