TextBox.h

Go to the documentation of this file.

/******************************************************************************/
 
#ifndef TEXTBOX_HEADER
#define TEXTBOX_HEADER
 
#include "Common.h"
 
/******************************************************************************/
/***                                                                        ***/
/***                   Class Definition: DynamicText                        ***/
/***                                                                        ***/
/******************************************************************************/
class DynamicText
{
public:
    enum TextAlign
    {
        LEFT,
        CENTER,
        RIGHT
    };
 
private:
    Canvas &_DestCanvas;      // Reference to the canvas where the text box will be displayed
    Canvas _BckgCanvas;       // Canvas containing the background image upon which the text will be drawn
    Canvas _DraftCanvas;      // Canvas used to build up the text box
    TextAlign _align;         // Text alignment within the text box
    FontList::FontID _FontID; // Primary font to be used
    GrFont *_Font = nullptr;  // Primary font to be used
    uint16_t _baseline;       // Vertical position for the baseline of the text within DynamicText
 
    static constexpr bool addDebugBorder = false; // Adds a red border around the text box to help with debugging
 
public:
    const uint16_t X;      
    const uint16_t Y;      
    const uint16_t WIDTH;  
    const uint16_t HEIGHT; 

    DynamicText(Canvas &DestCanvas, uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint16_t baseline,
                FontList::FontID Font, TextAlign align = CENTER)
        : _DestCanvas{DestCanvas}, _BckgCanvas{width, height}, _DraftCanvas{width, height},
          _align{align}, _FontID{Font}, _baseline{baseline}, X{x}, Y{y}, WIDTH{width}, HEIGHT{height} {};

    DynamicText(void) = delete;

    virtual void begin(void);

    virtual inline void align(TextAlign align)
    {
        _align = align;
    };

    void update(const char *text, uint16_t textBuffSize);

    void update(int value);
 
private:
    // Verifies that _Font has been initialized. If not, the applications is
    // halted.
    void _validateFont(void);
};
 
/******************************************************************************/
/***                                                                        ***/
/***                      Class Definition: TextBox                         ***/
/***                                                                        ***/
/******************************************************************************/
class TextBox
{
public:
    static Shape_t shape; // Geometric shape configuration for the expected fonts

    static ConfigList_t config;
 
    DynamicText Value; 
    DynamicText Units; 
 
    const uint16_t X;      // UL x position of the text box within _DestCanvas
    const uint16_t Y;      // UL y position of the text box within _DestCanvas
    const uint16_t WIDTH;  // Full width of the text box and units
    const uint16_t HEIGHT; // Height of the text box within _DestCanvas

    TextBox(Canvas &DestCanvas, uint16_t x, uint16_t y,
            uint16_t textWidth, uint16_t unitsWidth, uint16_t height, uint16_t baseline,
            FontList::FontID TextFont, FontList::FontID UnitsFont)
        : Value{DestCanvas, x, y, textWidth, height, baseline, TextFont, DynamicText::TextAlign::RIGHT},
          Units{DestCanvas, x + textWidth, y, unitsWidth, height, baseline, UnitsFont, DynamicText::TextAlign::LEFT},
          X{x}, Y{y}, WIDTH{textWidth + unitsWidth}, HEIGHT{height} {};

    TextBox(Canvas &DestCanvas, const ConfigTextBox_t *config)
        : TextBox{DestCanvas, config->x, config->y, config->textWidth,
                  config->shape.unitsWidth, config->shape.height, config->shape.baseline,
                  config->TextFont, config->UnitsFont} {};

    static void initializeFonts(void);

    inline void begin(void)
    {
        Value.begin();
        Units.begin();
    }
 
    inline uint16_t width(void) const
    {
        return WIDTH;
    }
};
 
#endif