ui_core.h

Go to the documentation of this file.

 
#if !defined(UI_CORE_H)
#define UI_CORE_H
 
#include "pico/stdlib.h"
#include "framebuffer.h"
#include <vector>
#include <map>
#include <string>
 
enum class ControlEvent
{
    NOOP,
    PUSH,
    DOUBLE_PUSH, // TODO find a way to do "DOUBLE_PUSH"
    LONG_PUSH,
    RELEASED_AFTER_LONG_TIME,
    RELEASED_AFTER_SHORT_TIME,
    INCREMENT,
    DECREMENT,
    TIME_OUT // TODO find a way to do "TIME_OUT"
};
 
enum class ControlledObjectStatus
{
    IS_WAITING, // nothing to do
    HAS_FOCUS, // the widget or object manager is pointing to this model
    IS_ACTIVE // the user has selected (clicked) on this model. CtrolEvent are then passed to this model in order to be processed.
};
 
struct StructWidgetConfig
{
    size_t width{128};
    size_t height{8};
    bool with_border{true};
    bool with_label{true};
    uint8_t anchor_x{0};
    uint8_t anchor_y{0};
    const unsigned char *font{nullptr};
};
 
class UIController;
 
class UIDisplayDevice : public Framebuffer
{
private:
public:
    UIDisplayDevice(size_t width, size_t height, FramebufferFormat format = FramebufferFormat::MONO_VLSB, StructFramebufferText txt_cnf = {.font = font_8x8});
    virtual ~UIDisplayDevice();
    virtual void show() = 0;
    virtual void show(Framebuffer *frame, uint8_t anchor_x, uint8_t anchor_y) = 0;
};
 
class UIModelObject
{
private:
    bool change_flag{true};
    ControlledObjectStatus status{ControlledObjectStatus::IS_WAITING};
    UIController *current_controller{nullptr};
 
protected:
public:
    UIModelObject(/* args */);
    ~UIModelObject();
    bool has_changed();
    void set_change_flag();
    void clear_change_flag();
    void update_status(ControlledObjectStatus _new_status);
    void update_current_controller(UIController *_new_controller);
    ControlledObjectStatus get_status();
    virtual void process_control_event(ControlEvent _event) = 0;
};
 
class UIControlledIncrementalValue : public UIModelObject
{
private:
protected:
    int value;
    int max_value;
    int min_value;
    int increment;
    bool is_wrappable;
 
public:
    UIControlledIncrementalValue(int _min_value = 0, int _max_value = 10, bool _is_wrapable = false, int increment = 1);
    ~UIControlledIncrementalValue();
    virtual void increment_value();
    virtual void decrement_value();
    void set_clipped_value(int _new_value);
    int get_value();
    int get_min_value();
    int get_max_value();
};
 
class UIObjectManager : public UIControlledIncrementalValue
{
protected:
    std::vector<UIModelObject *> managed_models;
    UIModelObject *current_active_model;
    void make_managed_object_active();
    void make_manager_active();
    virtual void increment_focus();
    virtual void decrement_focus();
 
public:
    UIObjectManager(/* args */);
    ~UIObjectManager();
    void add_managed_model(UIModelObject *_new_model);
};
 
class UIController
{
protected:
    UIModelObject *current_controlled_object{nullptr};
 
public:
    UIController(/* args */);
    ~UIController();
    void update_current_controlled_object(UIModelObject *_new_controlled_object);
};
 
class UIWidget : public Framebuffer
{
private:
    UIDisplayDevice *display_screen{nullptr};
    UIModelObject * displayed_model{nullptr};
    bool widget_with_border{true};
    uint8_t widget_anchor_x;
    uint8_t widget_anchor_y;
protected:
    std::vector<UIWidget *> widgets;
    size_t widget_width{128};
    size_t widget_height{8};
    uint8_t widget_start_x;
    uint8_t widget_start_y;
    uint8_t widget_border_width;
    virtual void set_displayed_model(UIModelObject *_new_displayed_model);
    void set_display_screen(UIDisplayDevice *_new_display_device);
    void draw_border();
    virtual void draw() = 0;
 
public:
    static FramebufferColor blinking_us(uint32_t _blink_period);
    UIWidget(UIDisplayDevice *_display_screen, size_t _frame_width, size_t _frame_height,
             uint8_t _widget_anchor_x, uint8_t _widget_anchor_y, bool _widget_with_border, uint8_t _widget_border_width = 1,
             FramebufferFormat _framebuffer_format = FramebufferFormat::MONO_VLSB, StructFramebufferText _framebuffer_txt_cnf = {.font = font_8x8});
    ~UIWidget();
    void add_widget(UIWidget *_sub_widget);
    virtual void refresh();
};
 
#endif // UI_CORE_H