Node

Represents a Fluid node.

@safe abstract

class Node {

enum NodeAlign via public import fluid.structs : NodeAlign, Layout;;

struct Layout via public import fluid.structs : NodeAlign, Layout;;

enum NodeAlign via public import fluid.structs : Align = NodeAlign;;

LayoutTree* tree;

Layout layout;

TagList tags;

Breadcrumbs breadcrumbs;

bool toRemove;

bool ignoreMouse;

bool isThemeExplicit;

bool isHidden [@property getter];

bool isHidden [@property setter];

inout(Theme) theme();

Theme theme(Theme value);

void inheritTheme(Theme value);

void resetTheme();

inout(Style) style();

bool opEquals(Object other);

bool opEquals(Node otherNode);

This disable();

This enable();

inout(FluidBackend) backend();

FluidBackend backend(FluidBackend backend);

alias io = backend;

void toggleShow();

void remove();

Vector2 getMinSize();

bool isHovered [@property getter];

inout(bool) isDisabled();

bool isDisabledInherited();

void queueAction(TreeAction action);

bool resizePending();

void updateSize();

void focusPreviousOrNext(FluidInputAction actionType);

void focusInDirection(FluidInputAction action);

void draw(Rectangle space);

void resize(LayoutTree* tree, Theme theme, Vector2 space);

void resizeImpl(Vector2 space);

void drawImpl(Rectangle paddingBox, Rectangle contentBox);

bool hoveredImpl(Rectangle rect, Vector2 mousePosition);

alias ImplHoveredRect = implHoveredRect;

mixintemplate implHoveredRect();

Rectangle focusBoxImpl(Rectangle inner);

Style pickStyle();

void reloadStyles();

string toString();

}

Constructors

this this(): Construct a new node.

Members

Aliases

ImplHoveredRect alias ImplHoveredRect = implHoveredRect: Undocumented in source.
io alias io = backend: Undocumented in source.

Classes

Extra class Extra: Undocumented in source.

Enums

Align (from fluid.structs) enum NodeAlign via public import fluid.structs : Align = NodeAlign;: Undocumented in source.
NodeAlign (from fluid.structs) enum NodeAlign via public import fluid.structs : NodeAlign, Layout;: Undocumented in source.

Functions

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.
disable This disable(): Disable this node.
draw void draw(): Draw this node as a root node.
draw void draw(Rectangle space): Draw this node at the specified location from within of another (parent) node.
drawImpl void drawImpl(Rectangle paddingBox, Rectangle contentBox): Draw this node.
enable This enable(): Enable this node.
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.
focusInDirection void focusInDirection(FluidInputAction action): Switch focus towards a specified direction.
focusPreviousOrNext void focusPreviousOrNext(FluidInputAction actionType): Switch to the previous or next focused item
getMinSize Vector2 getMinSize(): Get the minimum size of this node.
hide This hide(): Hide the node.
hoveredImpl bool hoveredImpl(Rectangle rect, Vector2 mousePosition): Check if the node is hovered.
inheritTheme void inheritTheme(Theme value): Nodes automatically inherit theme from their parent, and the root node implictly inherits the default theme. An explicitly-set theme will override any inherited themes recursively, stopping at nodes that also have themes set explicitly.
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.
opEquals bool opEquals(Object other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(Node otherNode): Undocumented in source. Be warned that the author may not have intended to support it.
pickStyle Style pickStyle(): Get the current style.
queueAction void queueAction(TreeAction action): Queue an action to perform within this node's branch.
reloadStyles void reloadStyles(): Reload style from the current theme.
remove void remove(): Remove this node from the tree before the next draw.
resetTheme void resetTheme(): Clear the currently assigned theme
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
resizePending bool resizePending(): True if this node is pending a resize.
show This show(): Show the node.
style inout(Style) style(): Current style, used for sizing. Does not include any changes made by when clauses or callbacks.
theme inout(Theme) theme(): Get the current theme.
theme Theme theme(Theme value): Set the theme.
toString string toString(): Undocumented in source. Be warned that the author may not have intended to support it.
toggleShow void toggleShow(): Toggle the node's visibility.
updateSize void updateSize(): Recalculate the window size before next draw.

Mixin templates

implHoveredRect deprecated mixintemplate implHoveredRect(): Undocumented in source.

Properties

isHidden bool isHidden [@property getter]: Check if the node is hidden.
isHidden bool isHidden [@property setter]: Set the visibility
isHovered bool isHovered [@property getter]: Check if this node is hovered.

Structs

Layout (from fluid.structs) struct Layout via public import fluid.structs : NodeAlign, Layout;: Node parameter for setting the node layout.

Variables

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.
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.
layout Layout layout;: Layout for this node.
minSize auto minSize;: Minimum size of the node.
tags TagList tags;: Tags assigned for this node.
toRemove bool toRemove;: If true, this node will be removed from the tree on the next draw.
tree LayoutTree* tree;: Tree data for the node. Note: requires at least one draw before this will work.

Meta

Source

See Implementation

fluid node aliases

RunCallback

classes

Node

functions