UiUiUi/api/UIEnvelope_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 "UIPoint.h"

#include "UISize.h"

#include "UIArea.h"

#include "UIWidget.h"

#include "UIParent.h"


class UIEnvelope : public UIWidget, public UIParent {

  public:


    UIEnvelope(UIExpansion expansion,UIAlignment alignment,UISize borderSize=UISize(),UIWidget* content=nullptr,UIWidget* next=nullptr);


    UIEnvelope(UIExpansion expansion,UIAlignment alignment,UIWidget* content,UIWidget* next=nullptr);


    void layout(U8G2 *display,UIArea *dim);


    UIArea* render(U8G2 *display,bool force);


    void childNeedsRendering(UIWidget *child);


  protected:


    void computePreferredSize(U8G2 *display,UISize *preferredSize);


  private:


    UIExpansion expansion;


    UIAlignment alignment;


    UISize borderSize;


    UIWidget* content;


};


// end of file

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

UIEnvelope
Envelope widget which contains exactly one other widget and changes its representation.
Definition: UIEnvelope.h:27

UIEnvelope::render
UIArea * render(U8G2 *display, bool force)
Render the envelope - which also renders the content if it exists.
Definition: UIEnvelope.cpp:46

UIEnvelope::computePreferredSize
void computePreferredSize(U8G2 *display, UISize *preferredSize)
Compute the preferred size which is determined by the content by may be changed by the envelope.
Definition: UIEnvelope.cpp:57

UIEnvelope::childNeedsRendering
void childNeedsRendering(UIWidget *child)
Called by the child of this envelope to indicate that it wants to be rendered.
Definition: UIEnvelope.cpp:42

UIEnvelope::UIEnvelope
UIEnvelope(UIExpansion expansion, UIAlignment alignment, UISize borderSize=UISize(), UIWidget *content=nullptr, UIWidget *next=nullptr)
Create an envelope widget.
Definition: UIEnvelope.cpp:17

UIEnvelope::layout
void layout(U8G2 *display, UIArea *dim)
Layout the envelope.
Definition: UIEnvelope.cpp:26

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::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::next
UIWidget * next
Pointer to the next widget on the same level.
Definition: UIWidget.h:65