wxGauge

Table of Contents
wxGauge
wxWidgets Documentation for wxGauge
A gauge is a horizontal or vertical bar which shows a quantity (often time).

wxGauge 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).

wxGauge supports dynamic switch between these two work modes.

Creation Parameters
Functions/Procedures
Supertopics

wxGauge

Table of Contents

[func]
get_bezel_face ( atom gauge )

Category: wxGauge

Returns the width of the 3D bezel face.

Remarks

This method is not implemented (returns 0) for most platforms.

wxGauge

Table of Contents

[func]
get_range ( atom gauge )

Category: wxGauge

Returns the maximum position of the gauge.

wxGauge

Table of Contents

[func]
get_shadow_width ( atom gauge )

Category: wxGauge

Returns the 3D shadow margin width.

Remarks

This method is not implemented (returns 0) for most platforms.

wxGauge

Table of Contents

[func]
get_value ( atom gauge )

Category: wxGauge

Returns the current position of the gauge.

wxGauge

Table of Contents

[func]
is_gauge_vertical ( atom gauge )

Category: wxGauge

Returns true if the gauge is vertical (has wxGA_VERTICAL style) and false otherwise.

wxGauge

Table of Contents

[proc]
pulse ( atom gauge )

Category: wxGauge

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 GetValue is undefined and thus you need to explicitely call SetValue if you want to restore the determinate mode.

wxGauge

Table of Contents

[proc]
set_bezel_face ( atom gauge, atom width )

Category: wxGauge

Sets the 3D bezel face width.

Remarks

This method is not implemented (doesn't do anything) for most platforms.

wxGauge

Table of Contents

[proc]
set_range ( atom gauge, atom range )

Category: wxGauge

Sets the range (maximum value) of the gauge.

This function makes the gauge switch to determinate mode, if it's not already.

wxGauge

Table of Contents

[proc]
set_shadow_width ( atom gauge, atom width )

Category: wxGauge

Sets the 3D shadow width.

Remarks

This method is not implemented (doesn't do anything) for most platforms.

wxGauge

Table of Contents

[proc]
set_value ( atom gauge, atom pos )

Category: wxGauge

Sets the position of the gauge. This function makes the gauge switch to determinate mode, if it's not already.

Parameters

  • ipos

    Position for the gauge level.