aurore::Box

An empty box laying its children out along flexDirection.

An empty row.

Deletes the children (those a ptrLock() holds go to the deletion pool).

Called by frame() to draw the view onscreen. Views should not draw outside of their bounds (they may be clipped if they do so).

Overrides aurore::View::draw

Returns the default view to focus when focusing this view Typically the view itself or one of its children.

Returning nullptr means that the view is not focusable (and neither are its children)

By default, a view is focusable if the flag is set to true with setFocusable() and if the view is visible.

When pressing a key, the flow is :

1. starting from the currently focused view's parent, traverse the tree upwards and repeatedly call getNextFocus() on every view until we find a next view to focus or meet the end of the tree
2. if a view is found, getNextFocus() will internally call getDefaultFocus() for the selected child
3. give focus to the result, if it exists

Overrides aurore::View::getDefaultFocus

Returns the view to focus with the corresponding screen coordinates in the view or its children, or nullptr if it hasn't been found.

Research is done recursively by traversing the tree starting from this view. This view's parents are not traversed.

Overrides aurore::View::hitTest

Returns the next view to focus given the requested direction and the currently focused view (as parent user data)

Returning nullptr means that there is no next view to focus in that direction - getNextFocus will then be called on our parent if any

Overrides aurore::View::getNextFocus

Called when the view will appear on screen, before or after layout().

Can be called if the view has already appeared, so be careful.

Overrides aurore::View::willAppear

Called when the view will disappear from the screen.

Can be called if the view has already disappeared, so be careful.

Overrides aurore::View::willDisappear

Fired when the window size changes, after updating layout.

Overrides aurore::View::onWindowSizeChanged

Called on every view of the screens when the theme changes (Application::getThemeChangedEvent): the colours given by key (setThemeColor) take their new values, the state styles read their "@theme/" values again. A view that keeps other colours of its own looks them up again here, then calls the base. A Box goes on to its children.

Overrides aurore::View::onThemeChanged

Fired when focus is gained.

Overrides aurore::View::onFocusGained

Fired when focus is lost.

Overrides aurore::View::onFocusLost

Fired when focus is gained on this view's parent, or the parent of the parent...

Overrides aurore::View::onParentFocusGained

Fired when focus is lost on one of this view's parents. Works similarly to onParentFocusGained().

Overrides aurore::View::onParentFocusLost

Applies the given attribute to the view.

You can add your own attributes to by calling registerXMLAttribute() in the view constructor.

Overrides aurore::View::applyXMLAttribute

The focus about to move from from to newFocus: a box may give another view instead. Asked of every parent up the tree; returns newFocus by default.

Adds a view to this Box. Returns the position the view was added at.

Adds a view to this Box at the given position. Returns the position the view was added at.

Removes the given view from the Box. It will be freed.

Removes all views from the Box. Them will be freed.

Sets the padding of the view, aka the internal space to give between this view boundaries and its children.

Only does one layout pass instead of four when using the four methods separately.

Sets the padding of the view, aka the internal space to give between this view boundaries and its children.

Only does one layout pass instead of four when using the four methods separately.

Sets the padding of the view, aka the internal space to give between this view boundaries and its children.

Sets the padding of the view, aka the internal space to give between this view boundaries and its children.

Sets the padding of the view, aka the internal space to give between this view boundaries and its children.

Sets the padding of the view, aka the internal space to give between this view boundaries and its children.

Sets the gap between child elements inside this view. This is typically used in layouts like grids or lists.

Returns the current gap between child elements inside this view.

Sets the gap between two lines of children (wrapped rows, or the children of a column), overriding setGap() on that axis.

Sets the gap between two children along a row (or between wrapped columns), overriding setGap() on that axis.

Sets the children alignment along the Box axis.

Default is FLEX_START.

Sets the children alignment along the Box cross axis.

Default is AUTO.

Sets the direction of the box, aka place the views left to right or right to left (flips the children).

Default is INHERIT.

The axis the children are laid out along.

Sets the wrapping behavior for the children inside this view.

Returns the wrapping behavior for the children inside this view.

The children, in order. The box owns them: it deletes them with itself.

Returns the bounds used for culling children.

Registers an XML attribute to be forwarded to the given view. Works regardless of the target attribute type. Useful to expose attributes of children views in the parent box without copy pasting them individually.

The forwarded attribute value will override the value of the regular attribute if it already exists in the target view.

Registers an XML attribute to be forwarded to the given view, while changing the target attribute name. Works regardless of the target attribute type. Useful to expose attributes of children views in the parent box without copy pasting them individually, but with a different name.

The forwarded attribute value will override the value of the regular attribute if it already exists in the target view.

Fired when focus is gained on one of this view's children, or one of the children of the children...

directChild is guaranteed to be one of your children. It may not be the view that has been focused.

If focusedView == directChild, then the child of yours has been focused. Otherwise, focusedView is a child of directChild.

Fired when focus is lost on one of this view's children. Works similarly to onChildFocusGained().

Returns the view with the corresponding id in the view or its children, or nullptr if it hasn't been found.

Research is done recursively by traversing the tree starting from this view. This view's parents are not traversed.

Overrides aurore::View::getView

The child the focus goes back to when the box gets it again.

The child that takes the focus first (negative values are ignored).

See setLastFocusedView().

Whether the focus is on one of the children, at any depth.

A focusable box says the texts shown in it (getAccessibilityText).

Overrides aurore::View::getDefaultAccessibilityLabel

Inflates the Box with the given XML string.

The root element MUST be a aurore::Box, corresponding to the inflated Box itself. Its attributes will be applied to the Box.

Each child node in the root aurore::Box will be treated as a view and added as a child of the Box.

Inflates the Box with the given XML element.

The root element MUST be a aurore::Box, corresponding to the inflated Box itself. Its attributes will be applied to the Box.

Each child node in the root aurore::Box will be treated as a view and added as a child of the Box.

Inflates the Box with the given XML resource.

The root element MUST be a aurore::Box, corresponding to the inflated Box itself. Its attributes will be applied to the Box.

Each child node in the root aurore::Box will be treated as a view and added as a child of the Box.

Inflates the Box with the given XML file path.

The root element MUST be a aurore::Box, corresponding to the inflated Box itself. Its attributes will be applied to the Box.

Each child node in the root aurore::Box will be treated as a view and added as a child of the Box.

Handles a child XML element.

By default, calls createFromXMLElement() and adds the result to the children of the Box.

Overrides aurore::View::handleXMLElement