UiUiUi/api/UICards_8h_source.html

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

// (C) 2022 Dirk Hillbrecht


#pragma once


#include "Arduino.h"

#include <U8g2lib.h>


// Basic helper classes and definitions

#include "UIEnums.h"

#include "UIPoint.h"

#include "UISize.h"

#include "UIArea.h"


// Simple widgets

#include "UIWidget.h"

#include "UIWidgetGroup.h"


class UICards: public UIWidgetGroup {


  public:


    UICards(UIWidget* firstChild,UIWidget* next=nullptr);


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


    void setVisibleWidget(UIWidget *visible);


    void hide();


    void showFirstWidget();


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


    void childNeedsRendering(UIWidget *child);


  protected:


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


  private:


    UIWidget *visible;


    bool forceInternally;


};


// end of file

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

UICards
Widget group which shows nothing or exactly one of its sub-widgets.
Definition: UICards.h:35

UICards::layout
void layout(U8G2 *display, UIArea *dim)
Layout the cards widget.
Definition: UICards.cpp:24

UICards::showFirstWidget
void showFirstWidget()
Shortcut: Show first widget.
Definition: UICards.cpp:45

UICards::setVisibleWidget
void setVisibleWidget(UIWidget *visible)
Set the widget to show on the area of the cards widget group.
Definition: UICards.cpp:33

UICards::computePreferredSize
void computePreferredSize(U8G2 *display, UISize *preferredSize)
Compute the preferred size as the maximum envelope of the preferred sizes of all subwidgets.
Definition: UICards.cpp:68

UICards::childNeedsRendering
void childNeedsRendering(UIWidget *child)
UICards will consider the render request from the child only if it is the currently visible child.
Definition: UICards.cpp:77

UICards::render
UIArea * render(U8G2 *display, bool force)
Render the cards widget group onto the display.
Definition: UICards.cpp:49

UICards::hide
void hide()
Shortcut: Hide all widgets, clear the UICards area on the display.
Definition: UICards.cpp:41

UICards::UICards
UICards(UIWidget *firstChild, UIWidget *next=nullptr)
Initialize the cards widget with the first widget and a potential successor on the same level.
Definition: UICards.cpp:21

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

UIWidgetGroup
Main abstraction of a group of interface widgets.
Definition: UIWidgetGroup.h:29

UIWidgetGroup::firstChild
UIWidget * firstChild
The first of the widgets grouped by this widget group.
Definition: UIWidgetGroup.h:45

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