ProgressBar

A progress bar widget shows the status of a long-running operation. They can operate in two modes: determinate mode shows the amount completed relative to the total amount of work to be done, and indeterminate mode provides an animated display to let the user know that something is happening.

Constructors

this
this(UiElement parent, string orientation)

Construct the widget.

this
this(string orientation)

Construct the widget.

Members

Functions

getPhase
string getPhase()

The widget periodically increments the value of this option whenever the value is greater than 0 and, in determinate mode, less than the maximum. This option may be used by the current theme to provide additional animation effects.

setMaxValue
auto setMaxValue(double maximum)

Set the maximum value of the progress bar.

setMode
auto setMode(string mode)

Set the mode of the progress bar.

start
auto start(int milliseconds)

Begin autoincrement mode: schedules a recurring timer event that calls step every interval.

step
auto step(int increment)

Increments the progress bar by an amount.

stop
auto stop()

Stop autoincrement mode: cancels any recurring timer event initiated by the start method.

Mixins

__anonymous
mixin Length

Mixin common commands.

__anonymous
mixin Value!(this._valueVariable, double)
Undocumented in source.

Mixed In Members

From mixin Length

setLength
auto setLength(int length)

Set the length of the widget.

Inherited Members

From Widget

setState
auto setState(string[] state)

Set the widget's state.

getState
string[] getState()

Get the widget's state.

inState
bool inState(string[] state)

Test if a widget is in a particular state.

removeState
auto removeState(string[] state)

Remove the widget's state.

resetState
auto resetState()

Reset the widget's state to default.

setStyle
auto setStyle(string style)

Set the widget's style.

getStyle
string getStyle()

Get the widget's style.

setKeyboardFocus
auto setKeyboardFocus(string focus)

Set if the widget can recieve focus during keyboard traversal.

getKeyboardFocus
string getKeyboardFocus()

Get if the widget can recieve focus during keyboard traversal.

pack
auto pack(int outerPadding, int innerPadding, string side, string fill, string anchor, bool expand)

Geometry method for loosely placing this widget inside its parent using a web browser model. Widgets flow around each other in the available space.

grid
auto grid(int column, int row, int outerPadding, int innerPadding, int columnSpan, int rowSpan, string sticky)

Geometry method for placing this widget inside its parent using an imaginary grid. Somewhat more direct and intuitive than pack. Choose grid for tabular layouts, and when there's no good reason to choose something else.

place
auto place(int xPos, int yPos, int width, int height, string anchor, string borderMode)

Geometry method for placing this widget inside its parent using absolute positioning.

place
auto place(double relativeXPos, double relativeYPos, double relativeWidth, double relativeHeight, string anchor, string borderMode)

Geometry method for placing this widget inside its parent using relative positioning. In this case the position and size is specified as a floating-point number between 0.0 and 1.0 relative to the height of the parent. 0.5 means the widget will be half as high as the parent and 1.0 means the widget will have the same height as the parent, and so on.

Examples

auto progressBar = new ProgressBar()
	.setMaxValue(100)
	.setValue(10)
	.pack();

Common Commands

These are injected common commands that can also be used with this widget.

Length
Value

Additional Events

Additional events that can also be bound to using the bind method.

<<PrevWindow>>, <Alt-Key>, <Key-F10>, <Key-Tab>,

See Also

Meta