TextBox.h

Go to the documentation of this file.

/*******************************************************************************
 * @file TextBox.h
 *
 * @brief Defines TextBox and TextBox which are used to display dynamic
 *      text within a canvas
 *
 * @details This file contains a number of of type definitions that are used by
 * TextBox and TextBox constructors. The intent here is to greatly
 * simplify the use of TextBox by providing users with a collection of
 * pre-set configurations to choose from.
 ******************************************************************************/
 
#ifndef TEXTBOX_HEADER
#define TEXTBOX_HEADER
 
#include <Arduino.h>
#include "Canvas.h"
#include "GrFont.h"
#include "TextBox_Definitions.h"
 
/******************************************************************************/
/***                                                                        ***/
/***                   Class Definition: DynamicText                            ***/
/***                                                                        ***/
/******************************************************************************
 * @brief Defines a simple text box for displaying dynamic text onto a Canvas
 *
 * @details Before attempting to use this class, the caller must do two things.
 * First the caller must fully initialize the font object provided to the
 * DynamicText constructor. This means instantiating the GrFont object followed
 * by a call to the GrFont::begin(), which loads and colorizes the fonts. Second,
 * the caller must call the DynamicText::begin() method after object instantiation.
 *
 * @code {.cpp}
 * // Create Font
 * #include "fonts/Monofonto-Regular-180.h"
 * auto font = WorkSans_SemiBold_180();
 * font.begin(Red);
 *
 * //Create and use DynamicText
 * auto myDynamicText = DynamicText(myCanvas, x0, y0, width, height, baseline, font);
 * myDynamicText.begin();
 * myDynamicText.update(value);
 * @endcode
 ******************************************************************************/
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
    GrFont *_Font = nullptr; // Primary font to be used
    uint16_t _baseline;      // Vertical position for the baseline of the text within DynamicText
 
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,
                GrFont *Font, TextAlign align = CENTER)
        : _DestCanvas{DestCanvas}, _BckgCanvas{width, height}, _DraftCanvas{width, height},
          _align{align}, _Font{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);
 
    static void initializeFonts(void);
 
private:
    // Verifies that _Font has been initilized. If not, the applications is
    // halted.
    void _validateFont(void);
};
 
/******************************************************************************/
/***                                                                        ***/
/***                 Class Definition: TextBox                         ***/
/***                                                                        ***/
/******************************************************************************
 * @brief Composite object containing a "Value" and "Units" Text Box
 *
 * @details Before attempting to use this class, the caller must do two things.
 * First the caller must fully initialize the fonts used by this class. This is
 * accomplished by making a call to TextBox::initializeFonts(). Second,
 * the caller must call the TextBox::begin() method after object instantiation.
 *
 * @code {.cpp}
 * TextBox::initializeFonts();
 * auto myTextBox = TextBox(myCanvas, TextBox::config.main.kettleTemp);
 * myTextBox.begin();
 * myTextBox.Units.update("F", 2);
 * myTextBox.Value.update(value);
 * @endcode
 ******************************************************************************/
class TextBox
{
 
    static Font_List_t font;  // List of fonts used by TextBox
    static ShapeList_t shape; // Geometric shape configuration for the expected fonts
 
public:
    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,
            GrFont *TextFont, GrFont *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();
    }
};
 
#endif