A gauge is a horizontal or vertical bar which shows a quantity (often time).
Gauge supports two working modes: determinate and indeterminate progress.
The first is the usual working mode (see set_value
and set_range) while the second can be used when
the program is doing some processing but you don’t know how much progress is
being done.
In this case, you can periodically call the Pulse
function to make the progress bar switch to indeterminate mode (graphically
it’s usually a set of blocks which move or bounce in the bar control).
Gauge supports dynamic switch between these two work modes.
There are no user commands for the gauge.
GA_HORIZONTAL |
Creates a horizontal gauge. |
GA_VERTICAL |
Creates a vertical gauge. |
GA_SMOOTH |
Creates smooth progress bar with one pixel wide update step (not supported by all platforms). |
See also window styles overview.
Gauge is read-only so generates no events.
Constructor, creating and showing a gauge.
Destructor, destroying the gauge.
Creates the gauge for two-step construction. See Gauge.new for further details.
Returns the width of the 3D bezel face.
This method is not implemented (returns $0$) for most platforms.
Returns the maximum position of the gauge.
Returns the 3D shadow margin width.
This method is not implemented (returns $0$) for most platforms.
Returns the current position of the gauge.
Returns if the gauge is vertical (has GA_VERTICAL
style) and
otherwise.
Sets the 3D bezel face width.
This method is not implemented (doesn’t do anything) for most platforms.
Sets the range (maximum value) of the gauge.
This function makes the gauge switch to determinate mode, if it’s not already.
Sets the 3D shadow width.
This method is not implemented (doesn’t do anything) for most platforms.
Sets the position of the gauge.
This function makes the gauge switch to determinate mode, if it’s not already.
Switch the gauge to indeterminate mode (if required) and makes the gauge move
a bit to indicate the user that some progress has been made.
Note that after calling this function the value returned by get_value
is undefined and thus you need to explicitely call set_value if you
want to restore the determinate mode.
[This page automatically generated from the Textile source at 2023-06-13 21:31:42 +0000]