NodeSlot

A "node slot" node, which displays the node given to it. Allows safely swapping nodes in the layout by reference, even during drawing. Useful for creating tabs and menus.

Because NodeSlot does not inherit from T, it uses the single-parameter overload of simpleConstructor.

@safe

class NodeSlot : Node (

T : Node

) {

CanvasIO canvasIO;

T value;

this(T node);

typeof(this) opAssign(T value);

void clear();

void resizeImpl(Vector2 space);

void drawImpl(Rectangle outer, Rectangle inner);

bool hoveredImpl(Rectangle rect, Vector2 position);

void swapSlots(Slot other);

}

Constructors

this this(T node): Create a new node slot and optionally place a node within.

Members

Functions

clear void clear(): Remove the assigned node from the slot.
drawImpl void drawImpl(Rectangle outer, Rectangle inner): Undocumented in source. Be warned that the author may not have intended to support it.
hoveredImpl bool hoveredImpl(Rectangle rect, Vector2 position): Undocumented in source. Be warned that the author may not have intended to support it.
opAssign typeof(this) opAssign(T value): Change the node in the slot.
resizeImpl void resizeImpl(Vector2 space): Undocumented in source. Be warned that the author may not have intended to support it.
swapSlots void swapSlots(Slot other): Swap contents of the two slots.

Variables

canvasIO CanvasIO canvasIO;: Undocumented in source.
value T value;: Node placed in the slot.

Inherited Members

From Node

NodeAlign (from fluid.structs) enum NodeAlign via public import fluid.structs : NodeAlign, Layout;: Undocumented in source.
Layout (from fluid.structs) struct Layout via public import fluid.structs : NodeAlign, Layout;: Node parameter for setting the node layout.
Align (from fluid.structs) enum NodeAlign via public import fluid.structs : Align = NodeAlign;: Undocumented in source.
Extra class Extra: Undocumented in source.
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.
tags TagList tags;: Tags assigned for this node.
breadcrumbs Breadcrumbs breadcrumbs;: Breadcrumbs assigned and applicable to this node. Loaded every resize and every 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.
isOpaque IsOpaque isOpaque;: Filter to apply to every result of inBounds, controlling how the node reacts to some events, such as mouse click or a finger touch.
isThemeExplicit bool isThemeExplicit;: True if the theme has been assigned explicitly by a direct assignment. If false, the node will instead inherit themes from the parent.
minSize auto minSize;: Minimum size of the node.
isHidden bool isHidden [@property getter]: Check if the node is hidden.
isHidden bool isHidden [@property setter]: Set the visibility
opEquals bool opEquals(Object other)
bool opEquals(Node otherNode)
theme inout(Theme) theme(): The theme defines how the node will appear to the user.
theme Theme theme(Theme value): Set the theme.
inheritTheme void inheritTheme(Theme value): Nodes automatically inherit theme from their parent, and the root node implicitly inherits the default theme. An explicitly-set theme will override any inherited themes recursively, stopping at nodes that also have themes set explicitly.
resetTheme void resetTheme(): Clear the currently assigned theme
style inout(Style) style(): Current style, used for sizing. Does not include any changes made by when clauses or callbacks.
show This show(): Show the node.
hide This hide(): Hide the node.
disable This disable(): Disable this node.
enable This enable(): Enable this node.
treeContext inout(TreeContext) treeContext(): Undocumented in source. Be warned that the author may not have intended to support it.
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.
toRemove bool toRemove(bool value)
bool toRemove(): toRemove is used to mark nodes for removal. A node marked as such should stop being drawn, and should be removed from the tree.
getMinSize Vector2 getMinSize(): Get the minimum size of this node.
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.
applyAll void applyAll(Parameters params): Apply all of the given node parameters on this node.
queueAction void queueAction(TreeAction action): Queue an action to perform within this node's branch.
startAction void startAction(TreeAction action): Perform a tree action the next time this node is drawn.
startBranchAction auto startBranchAction(BranchAction action)
auto startBranchAction(T range): Start a branch action (or multiple) to run on children of this node.
controlBranchAction auto controlBranchAction(BranchAction action): Undocumented in source.
controlBranchAction auto controlBranchAction(T range): Undocumented in source. Be warned that the author may not have intended to support it.
resizePending bool resizePending(): True if this node is pending a resize.
updateSize void updateSize(): Recalculate the window size before next draw.
draw void draw(): Draw this node as a root node.
drawChild void drawChild(Node child, Rectangle space): Draw a child node at the specified location inside of this node.
draw deprecated void draw(Rectangle space): Draw this node at the specified location from within of another (parent) node.
marginBoxForSpace Rectangle marginBoxForSpace(Rectangle space): Get the node's margin box for given available space. The margin box, nor the available space aren't typically given to a node, but this may be useful for its parent nodes.
paddingBoxForSpace Rectangle paddingBoxForSpace(Rectangle space): Get the node's padding box (outer box) for set available space.
prepareChild void prepareChild(Node child): Prepare a child for use. This is automatically called by resizeChild and only meant for advanced usage.
resizeChild Vector2 resizeChild(Node child, Vector2 space): Resize a child of this node.
resize deprecated void resize(LayoutTree* tree, Theme theme, Vector2 space): Recalculate the minimum node size and update the minSize property.
focusPreviousOrNext void focusPreviousOrNext(FluidInputAction actionType): Switch to the previous or next focused item
focusInDirection void focusInDirection(FluidInputAction action): Switch focus towards a specified direction.
use T use()
T use(T io): Connect to an I/O system
require T require()
T require(T io): Require
load void load(I io, T resource): Load a resource associated with the given I/O.
implementIO auto implementIO(): Enable I/O interfaces implemented by this node.
controlIO mixintemplate controlIO(): Undocumented in source.
controlIO auto controlIO(): Undocumented in source. Be warned that the author may not have intended to support it.
resizeImpl void resizeImpl(Vector2 space): This is the implementation of resizing to be provided by children.
drawImpl void drawImpl(Rectangle paddingBox, Rectangle contentBox): Draw this node.
hoveredImpl bool hoveredImpl(Rectangle rect, Vector2 mousePosition): Check if the node is hovered.
inBoundsImpl IsOpaque inBoundsImpl(Rectangle outer, Rectangle inner, Vector2 position)
inBounds IsOpaque inBounds(Rectangle outer, Rectangle inner, Vector2 position): Test if the specified point is the node's bounds. This is used to map screen positions to nodes, such as when determining which nodes are hovered by mouse. If the node contains the point, then it is "opaque," and if not, it is "transparent".
ImplHoveredRect alias ImplHoveredRect = implHoveredRect: Undocumented in source.
implHoveredRect deprecated mixintemplate implHoveredRect(): Undocumented in source.
focusBoxImpl Rectangle focusBoxImpl(Rectangle inner): The focus box defines the *focused* part of the node. This is relevant in nodes which may have a selectable subset, such as a dropdown box, which may be more important at present moment (selected). Scrolling actions like scrollIntoView will use the focus box to make sure the selected area is presented to the user.
focusBox alias focusBox = focusBoxImpl: Undocumented in source.
pickStyle Style pickStyle(): Get the current style.
reloadStyles void reloadStyles(): Reload style from the current theme.
toString string toString(): Undocumented in source. Be warned that the author may not have intended to support it.

Examples

import fluid;

NodeSlot!Label slot1, slot2;

// Slots can be empty, with no node inside
auto root = vspace(
    label("Hello, "),
    slot1 = nodeSlot!Label(.layout!"fill"),
    label(" and "),
    slot2 = nodeSlot!Label(.layout!"fill"),
);

// Slots can be assigned other nodes
slot1 = label("John");

slot2 = button("Jane", delegate {

    // Slot contents can be swapped with a single call
    slot1.swapSlots(slot2);

});

// Slots can be reassigned at any time
slot1 = label("Joe");

// Their values can also be removed
slot1.clear();