Space

This is a space, a basic container for other nodes.

Nodes are laid in a column (vframe) or in a row (hframe).

Space only acts as a container and doesn't implement styles and doesn't take focus. It's very useful as a helper for building layout, while Frame remains to provide styling.

@safe

class Space : Node , FluidContainer {

mixin DefineStyles ;

Children children;

bool horizontal;

alias directionHorizontal = horizontal;

this(BasicNodeParam!index params, Node[] nodes);

this(NodeParams params, Node[] nodes);

this();

void opOpAssign(T nodes);

Rectangle shallowScrollTo(Node , Vector2 , Rectangle , Rectangle childBox);

void resizeImpl(Vector2 available);

void drawImpl(Rectangle , Rectangle area);

auto filterChildren();

void drawChildren(void delegate(Node) @(safe) painter);

bool hoveredImpl(Rectangle , Vector2 );

inout(Style) pickStyle();

}

Constructors

this deprecated this(BasicNodeParam!index params, Node[] nodes): Undocumented in source.
this this(NodeParams params, Node[] nodes): Undocumented in source.
this this(): Undocumented in source.

Members

Aliases

directionHorizontal alias directionHorizontal = horizontal: Undocumented in source.

Functions

drawChildren deprecated void drawChildren(void delegate(Node) @(safe) painter): Iterate over every child and perform the painting function. Will automatically remove nodes queued for removal.
drawImpl void drawImpl(Rectangle , Rectangle area): Undocumented in source. Be warned that the author may not have intended to support it.
filterChildren auto filterChildren(): List children in the space, removing all nodes queued for deletion beforehand.
hoveredImpl bool hoveredImpl(Rectangle , Vector2 ): Undocumented in source. Be warned that the author may not have intended to support it.
opOpAssign void opOpAssign(T nodes): Add children.
pickStyle inout(Style) pickStyle(): Undocumented in source. Be warned that the author may not have intended to support it.
resizeImpl void resizeImpl(Vector2 available): Undocumented in source. Be warned that the author may not have intended to support it.
shallowScrollTo Rectangle shallowScrollTo(Node , Vector2 , Rectangle , Rectangle childBox): Undocumented in source. Be warned that the author may not have intended to support it.

Mixins

__anonymous mixin DefineStyles: Undocumented in source.

Variables

children Children children;: Children of this frame.
horizontal bool horizontal;: Defines in what directions children of this frame should be placed.

Inherited Members

From Node

NodeAlign (from fluid.structs) enum NodeAlign via public import fluid.structs : NodeAlign, NodeParams, Layout;: Undocumented in source.
NodeParams (from fluid.structs) struct NodeParams via public import fluid.structs : NodeAlign, NodeParams, Layout;: Node core constructor parameters, to be passed from node to node.
Layout (from fluid.structs) struct Layout via public import fluid.structs : NodeAlign, NodeParams, Layout;: Represents a node's layout
Align (from fluid.structs) enum NodeAlign via public import fluid.structs : Align = NodeAlign, Params = NodeParams;: Undocumented in source.
Params (from fluid.structs) struct NodeParams via public import fluid.structs : Align = NodeAlign, Params = NodeParams;: Node core constructor parameters, to be passed from node to node.
__anonymous mixin DefineStyles!("style", q{ Style.init }): This node defines a single style, style, which also works as a default style for all other nodes. However, rather than for that, the purpose of this style is to define the convention of style being the node's default, idle style.
tree LayoutTree* tree;: Tree data for the node. Note: requires at least one draw before this will work.
layout Layout layout;: Layout for this node.
toRemove bool toRemove;: If true, this node will be removed from the tree on the next draw.
ignoreMouse bool ignoreMouse;: If true, mouse focus will be disabled for this node, so mouse signals will "go through" to its parents, as if the node wasn't there. The node will still detect hover like normal.
minSize auto minSize;: Minimum size of the node.
theme inout(Theme) theme [@property getter]: Get the current theme.
theme Theme theme [@property setter]: Set the theme.
isHidden bool isHidden [@property getter]: Check if the node is hidden.
isHidden bool isHidden [@property setter]: Set the visibility
opEquals bool opEquals(Node otherNode): Undocumented in source. Be warned that the author may not have intended to support it.
show This show(): Show the node.
hide This hide(): Hide the node.
disable This disable(): Disable this node.
enable This enable(): Enable this node.
backend inout(FluidBackend) backend(): Undocumented in source. Be warned that the author may not have intended to support it.
backend FluidBackend backend(FluidBackend backend): Undocumented in source. Be warned that the author may not have intended to support it.
io alias io = backend: Undocumented in source.
toggleShow void toggleShow(): Toggle the node's visibility.
remove void remove(): Remove this node from the tree before the next draw.
isHovered bool isHovered [@property getter]: Check if this node is hovered.
isDisabled inout(bool) isDisabled(): Check if this node is disabled.
isDisabledInherited bool isDisabledInherited(): Checks if the node is disabled, either by self, or by any of its ancestors. Updated when drawn.
queueAction void queueAction(TreeAction action): Queue an action to perform within this node's branch.
updateSize void updateSize(): Recalculate the window size before next draw.
draw void draw(): Draw this node as a root node.
_focusPrevNext void _focusPrevNext(FluidInputAction actionType): Switch to the previous or next focused item
_focusDirection void _focusDirection(FluidInputAction action): Switch focus towards a specified direction.
draw void draw(Rectangle space): Draw this node at the specified location from within of another (parent) node.
resize void resize(LayoutTree* tree, Theme theme, Vector2 space): Recalculate the minimum node size and update the minSize property.
resizeImpl void resizeImpl(Vector2 space): Ditto
drawImpl void drawImpl(Rectangle paddingBox, Rectangle contentBox): Draw this node.
hoveredImpl bool hoveredImpl(Rectangle rect, Vector2 mousePosition): Check if the node is hovered.
ImplHoveredRect alias ImplHoveredRect = implHoveredRect: Undocumented in source.
implHoveredRect mixintemplate implHoveredRect(): Undocumented in source.
pickStyle inout(Style) pickStyle(): Get the current style.
toString string toString(): Undocumented in source. Be warned that the author may not have intended to support it.

From FluidContainer

shallowScrollTo Rectangle shallowScrollTo(Node child, Vector2 viewport, Rectangle parentBox, Rectangle childBox): Scroll towards the given children node. This should change the parent's properties (without affecting the child) so that the child enters the viewport, or becomes as close to it as possible.
focusChild void focusChild(): Set focus on the first available focusable node in this tree.
asNode inout(Node) asNode(): Undocumented in source. Be warned that the author may not have intended to support it.

Examples

import fluid;

// A vspace will align all its content in a column
vspace(
    label("First entry"),
    label("Second entry"),
    label("Third entry"),
);

// hspace will lay out the nodes in a row
hspace(
    label("One, "),
    label("Two, "),
    label("Three!"),
);

// Combine them to quickly build layouts!
vspace(
    label("Are you sure you want to proceed?"),
    hspace(
        button("Yes", delegate { }),
        button("Cancel", delegate { }),
    ),
);