gigawidgets/ui_8hpp_source.html

#pragma once


#include "ui/blink.hpp"

#include "ui/body.hpp"

#include "ui/collection.hpp"

#include "ui/column.hpp"

#include "ui/core/display.hpp"

#include "ui/core/units.hpp"

#include "ui/image.hpp"

#include "ui/input.hpp"

#include "ui/keyboard.hpp"

#include "ui/panel.hpp"

#include "ui/row.hpp"

#include "ui/text.hpp"


#include <functional>


#ifndef UI_RENDER_FREQUENCY

// Refresh at most every 50ms

#define UI_RENDER_FREQUENCY 50

#endif


namespace ui {


typedef std::function<void()> callback_t;


void setRoot(Widget *const root);


void render(bool block = true);


#ifdef DEBUG

void showBoundingBoxes(bool enable);

#endif


Widget *getWidgetById(id_t id) noexcept;


void setTimeout(callback_t callback, time_t timeout);


} // namespace ui

blink.hpp

body.hpp

ui::Widget
The common interface for all UI objects.
Definition widget.hpp:27

collection.hpp

column.hpp

display.hpp

ui::id_t
uint32_t id_t
A (typically unique) identifier for widgets.
Definition id.hpp:13

image.hpp

input.hpp

keyboard.hpp

panel.hpp

row.hpp

text.hpp

ui::setRoot
void setRoot(Widget *const root)
Set the root widget for the UI to render.

ui::showBoundingBoxes
void showBoundingBoxes(bool enable)
Toggle whether bounding boxes are displayed for all widgets.

ui::setTimeout
void setTimeout(callback_t callback, time_t timeout)
Schedule a function to run after a delay.

ui::callback_t
std::function< void()> callback_t
A callback function that takes no arguments and returns nothing.
Definition ui.hpp:30

ui::render
void render(bool block=true)
Update all UI elements and re-render any areas that need it.

ui::getWidgetById
Widget * getWidgetById(id_t id) noexcept
Get the first widget (root or any children) that has the given ID.

units.hpp