wGauge

A gauge is a horizontal or vertical bar which shows a quantity. wGauge supports two working modes: determinate and indeterminate progress.

Appearance:
Superclass:wControl
Styles:
StylesDescription
wGaHorizontalCreates a horizontal gauge.
wGaVerticalCreates a vertical gauge.
wGaSmoothCreates smooth progress bar with one pixel wide update step.
wGaProgressReflect the value of gauge in the taskbar button under Windows 7 and later.

Consts

wGaHorizontal = 0
wGaVertical = 0x00000004
wGaSmooth = 0x00000001
wGaProgress = 1152921504606846976

Procs

proc setRange(self: wGauge; range: int) {...}{.validate, property, inline, raises: [], tags: [].}
Sets the range (maximum value) of the gauge.
proc getRange(self: wGauge): int {...}{.validate, property, inline, raises: [], tags: [].}
Returns the maximum position of the gauge.
proc setValue(self: wGauge; value: int) {...}{.validate, property, raises: [], tags: [].}
Sets the position of the gauge. Use a value >= maximum to clear the taskbar progress.
proc getValue(self: wGauge): int {...}{.validate, property, inline, raises: [], tags: [].}
Returns the current position of the gauge
proc pulse(self: wGauge) {...}{.validate, inline, raises: [], tags: [].}
Switch the gauge to indeterminate mode.
proc pause(self: wGauge) {...}{.validate, inline, raises: [], tags: [].}
Pause the taskbar progress.
proc error(self: wGauge) {...}{.validate, inline, raises: [], tags: [].}
Stop the taskbar progress and indicate an error.
proc isVertical(self: wGauge): bool {...}{.validate, inline, raises: [], tags: [].}
Returns true if the gauge is vertical and false otherwise.
proc final(self: wGauge) {...}{.raises: [], tags: [].}
Default finalizer for wGauge.
proc init(self: wGauge; parent: wWindow; id = wDefaultID; range = 100; value = 0;
         pos = wDefaultPoint; size = wDefaultSize; style: wStyle = wGaHorizontal) {...}{.
    validate, raises: [], tags: [].}
Initializer.
proc Gauge(parent: wWindow; id = wDefaultID; range = 100; value = 0; pos = wDefaultPoint;
          size = wDefaultSize; style: wStyle = wGaHorizontal): wGauge {...}{.inline,
    discardable, raises: [], tags: [].}
Constructor, creating and showing a gauge.

Methods

method getDefaultSize(self: wGauge): wSize {...}{.property, raises: [], tags: [].}
Returns the default size for the control.
method getBestSize(self: wGauge): wSize {...}{.property, inline, raises: [], tags: [].}
Returns the best acceptable minimal size for the control.