UiUiUi/api/UIWidget_8h_source.html

// SPDX-License-Identifier: BSD-2-Clause

// (C) 2022 Dirk Hillbrecht


#pragma once


#include "Arduino.h"

#include <U8g2lib.h>


#include "UIEnums.h"

#include "UISize.h"

#include "UIArea.h"

//#include "UIParent.h"


// Forward reference

class UIParent;


class UIWidget {

  public:


    UISize preferredSize(U8G2* display);


    virtual void layout(U8G2* display,UIArea* area);


    virtual UIArea* render(U8G2* display,bool force)=0;


    UIWidget *next;


    virtual void setParent(UIParent *parent);


  protected:


    UIWidget(UIWidget *next=nullptr);


    UIArea dim;


    UIParent *parent;


    void clearBox(U8G2* display,UIArea *dimm);


    void clearFull(U8G2 *display);


    void clip(U8G2 *display);


    virtual void computePreferredSize(U8G2 *display,UISize *preferredSize)=0;


    void signalNeedsRendering();


  private:


    UISize thePreferredSize;


};


// end of file

UIArea
Area consisting of left, top, right, and bottom value.
Definition: UIArea.h:20

UIParent
Simple abstraction of elements which have at least one child.
Definition: UIParent.h:14

UISize
Representation of a size, i.e.
Definition: UISize.h:9

UIWidget
Basic widget class, ancestor of all UI widgets.
Definition: UIWidget.h:36

UIWidget::dim
UIArea dim
Actual area of this widget, set in layout().
Definition: UIWidget.h:80

UIWidget::render
virtual UIArea * render(U8G2 *display, bool force)=0
Render component in the space given in layout().

UIWidget::layout
virtual void layout(U8G2 *display, UIArea *area)
Layout widget in the given rectanglar area, will be called before first call to render().
Definition: UIWidget.cpp:22

UIWidget::clip
void clip(U8G2 *display)
Set U8g2's clip window to the area of this widget, should be called from render().
Definition: UIWidget.cpp:35

UIWidget::clearBox
void clearBox(U8G2 *display, UIArea *dimm)
Clear the given area.
Definition: UIWidget.cpp:26

UIWidget::preferredSize
UISize preferredSize(U8G2 *display)
Return the preferred size of this widget, will be called before a call to layout().
Definition: UIWidget.cpp:16

UIWidget::signalNeedsRendering
void signalNeedsRendering()
Called internally: Signals to parent that this widget needs to be rendered.
Definition: UIWidget.cpp:43

UIWidget::parent
UIParent * parent
Reference to the group this widget is connected to.
Definition: UIWidget.h:83

UIWidget::UIWidget
UIWidget(UIWidget *next=nullptr)
Initialize this widget and potentially set its successor.
Definition: UIWidget.cpp:14

UIWidget::computePreferredSize
virtual void computePreferredSize(U8G2 *display, UISize *preferredSize)=0
Store preferred size of this widget into the preferredSize reference.

UIWidget::setParent
virtual void setParent(UIParent *parent)
Set the parent widget group (if it exists).
Definition: UIWidget.cpp:39

UIWidget::next
UIWidget * next
Pointer to the next widget on the same level.
Definition: UIWidget.h:65

UIWidget::clearFull
void clearFull(U8G2 *display)
Clear the full area of this widget.
Definition: UIWidget.cpp:31