ProgressBar

Progress bar node for communicating the program is actively working on something, and needs time to process. The progress bar draws a styleable ProgressBarFill node inside, spanning a fraction of its content, usually starting from left. Text is drawn over the node to display current progress.

The progress bar will use text height for its own height, but it needs extra horizontal space to be functional. To make sure it displays, ensure its horizontal alignment is always set to "fill" — this is the default, if the layout is not changed.

Styling

The progressBar component is split into two nodes, ProgressBar and ProgressBarFill. When styling, the former defines the background, greyed out part of the node, and the latter defines the foreground, the fill that appears as progress is accumulated. Usually, the background for ProgressBar will have low saturation or be grayed out, and ProgressBarFill will be colorful.

Text currently uses the ProgressBar color, but it's possible it will blend the colors of both sides in the future.

Theme(
    rule!ProgressBar(
        backgroundColor = color("#eee"),
        textColor = color("#000"),
    ),
    rule!ProgressBarFill(
        backgroundColor = color("#17b117"),
    )
)

Text format

ProgressBar does not currently offer the possibility to change text format, but it can be accomplished by subclassing and overriding the buildText method, like so:

class MyProgressBar : ProgressBar {

    override string buildText() const {

        return format!"%s/%s"(value, maxValue);

    }

}

Importantly, should buildText return an empty string, the progress bar will disappear, since its size depends on the text itself. If text is not desired, one can set textColor to a transparent value like color("#0000"). Alternatively resizeImpl can also be overrided to change the sizing behavior.

@safe

class ProgressBar : Node {

ProgressBarFill fill;

this(int value, int maxValue);

this(int maxValue);

void resizeImpl(Vector2 space);

void drawImpl(Rectangle paddingBox, Rectangle contentBox);

string buildText();

}

Constructors

this this(int value, int maxValue)
this(int maxValue): Set the value and maxValue of the progressBar.

Members

Functions

buildText string buildText(): Get text that displays on top of the progress bar.
drawImpl void drawImpl(Rectangle paddingBox, Rectangle contentBox): Undocumented in source. Be warned that the author may not have intended to support it.
resizeImpl void resizeImpl(Vector2 space): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

canvasIO CanvasIO canvasIO;: Undocumented in source.
fill ProgressBarFill fill;: Node used as the filling for this progress bar.
maxValue int maxValue;: value, along with maxValue indicate the current progress, defined as the fraction of value over maxValue. If 0, the progress bar is empty. If equal to maxValue, the progress bar is full.
text Text text;: Text used by the node.
value int value;: value, along with maxValue indicate the current progress, defined as the fraction of value over maxValue. If 0, the progress bar is empty. If equal to maxValue, the progress bar is full.

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

const steps = 24;

// Create a progress bar.
auto bar = progressBar(steps);

// Keep the user updated on the progress.
foreach (i; 0 .. steps) {

    bar.value = i;
    bar.updateSize();

}