asw::ui::VBox Class Reference

A vertical stack with padding, for a column of rows. More...

#include <layout.h>

Inheritance diagram for asw::ui::VBox:

Collaboration diagram for asw::ui::VBox:

Public Member Functions
	VBox ()
	Default constructor.
Public Member Functions inherited from asw::ui::Stack
void	layout (Context &ctx) override
	Place the children.
Public Member Functions inherited from asw::ui::Widget
	Widget ()
	Default constructor for Widget.
virtual	~Widget ()=default
	Default virtual destructor.
	Widget (Widget &&other) noexcept
	Move constructor. The children move over and point to the new widget as their parent. The new widget gets its own id and no parent, since it is not in the old parent's children. Removed children stay with the old widget, which is where Root finds and frees them.
Widget &	operator= (Widget &&other) noexcept
	Move assignment operator. The children move over and point to this widget as their parent. This widget keeps its place in the tree: its parent, id and state. Its old children are removed as by clear_children. Removed children of the other widget stay with it.
	Widget (const Widget &)=delete
Widget &	operator= (const Widget &)=delete
WidgetId	id () const
	Get the unique identifier for this widget.
const std::vector< std::unique_ptr< Widget > > &	children () const
	Get the child widgets. Change them with add_child, remove_child and clear_children, which keep removed widgets alive until Root is done with them.
virtual void	measure (Context &ctx)
	Set this widget's own size, before its parent places it. Does nothing by default.
virtual bool	on_event (Context &ctx, const UIEvent &e)
	Handle a UI event.
virtual void	on_focus_changed (Context &ctx, bool focused)
	Called when focus state changes.
virtual void	activate (Context &ctx)
	Called when the widget is clicked, or activated with the keyboard or a controller while focused. Does nothing by default.
virtual void	draw (Context &ctx)
	Draw this widget and its children.
template<class T , class... Args>
T &	add_child (Args &&... args)
	Add a child widget.
bool	remove_child (const Widget &child)
	Remove a child widget. It leaves the tree now and is destroyed at the next Root::update, so a callback can remove any widget, even the one it runs in.
void	clear_children ()
	Remove every child widget, destroyed as for remove_child.
bool	is_hovered () const
	Whether the pointer is currently over this widget.
bool	is_pressed () const
	Whether this widget is currently being pressed.
bool	is_focused () const
	Whether this widget currently holds focus.
bool	is_captured () const
	Whether this widget was pressed and the pointer is still held, even if it has moved off the widget.
bool	is_highlighted (const Context &ctx) const
	Whether to draw the hover look: hovered, pressed, or focused while focus is shown.

Additional Inherited Members
Public Attributes inherited from asw::ui::Stack
Direction	direction = Direction::Vertical
	Direction children are placed in.
Align	align = Align::Stretch
	Where children sit across the stack.
float	gap = 8.0F
	Space between children.
float	padding = 0.0F
	Space inside the stack on every side.
Public Attributes inherited from asw::ui::Widget
bool	visible = true
	Whether the widget is visible.
bool	enabled = true
	Whether the widget is enabled.
bool	focusable = false
	Whether the widget can receive focus. Focusable widgets are also the ones the pointer can press.
Widget *	nav_up = nullptr
	Widget to focus on up, instead of the nearest one. Optional.
Widget *	nav_down = nullptr
	Widget to focus on down, instead of the nearest one. Optional.
Widget *	nav_left = nullptr
	Widget to focus on left, instead of the nearest one. Optional.
Widget *	nav_right = nullptr
	Widget to focus on right, instead of the nearest one. Optional.
bool	focus_ring = true
	Draw the theme focus ring around this widget while it has visible focus. Turn off for widgets that show focus themselves.
Widget *	parent = nullptr
	Pointer to the parent widget.
asw::Quad< float >	transform
	The transform (position and size) of the widget.
Anchor	anchor = Anchor::None
	Pin this widget to a point of its parent, e.g. BottomRight for a corner button. The parent places it on every layout, so it stays in place when the screen or its own size changes. Stack and Grid place their children themselves and ignore it.
asw::Vec2< float >	anchor_margin { 0.0F, 0.0F }
	Space between an anchored widget and the parent's edges.
Protected Member Functions inherited from asw::ui::Widget
void	place_anchored (Widget &child) const
	Place a child that has an anchor inside this widget.
Protected Attributes inherited from asw::ui::Widget
bool	_hovered = false
bool	_pressed = false
bool	_focused = false
bool	_captured = false

Detailed Description

A vertical stack with padding, for a column of rows.

Definition at line 127 of file layout.h.

Constructor & Destructor Documentation

VBox()

asw::ui::VBox::VBox ( )

inline

Default constructor.

Definition at line 131 of file layout.h.

---

The documentation for this class was generated from the following file:

• include/asw/modules/ui/layout.h