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 SetValue and SetRange) 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.

There are no user commands for the gauge.

Derived from

wxControl
wxWindow
wxEvtHandler
wxObject

Include files

<wx/gauge.h>

Window styles

See also window styles overview.

Event handling

wxGauge is read-only so generates no events.

See also

wxSlider, wxScrollBar

Members

wxGauge::wxGauge
wxGauge::~wxGauge
wxGauge::Create
wxGauge::GetBezelFace
wxGauge::GetRange
wxGauge::GetShadowWidth
wxGauge::GetValue
wxGauge::IsVertical
wxGauge::SetBezelFace
wxGauge::SetRange
wxGauge::SetShadowWidth
wxGauge::SetValue
wxGauge::Pulse

wxGauge::wxGauge

wxGauge()

Default constructor.

wxGauge(wxWindow* parent, wxWindowID id, int range, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxGA_HORIZONTAL, const wxValidator& validator = wxDefaultValidator, const wxString& name = "gauge")

Constructor, creating and showing a gauge.

Parameters

parent

Window parent.

id

Window identifier.

range

Integer range (maximum value) of the gauge. It is ignored when the gauge is used in indeterminate mode.

pos

Window position.

size

Window size.

style

Gauge style. See wxGauge.

name

Window name.

See also

wxGauge::Create

wxGauge::~wxGauge

~wxGauge()

Destructor, destroying the gauge.

wxGauge::Create

bool Create(wxWindow* parent, wxWindowID id, int range, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxGA_HORIZONTAL, const wxValidator& validator = wxDefaultValidator, const wxString& name = "gauge")

Creates the gauge for two-step construction. See wxGauge::wxGauge for further details.

wxGauge::GetBezelFace

int GetBezelFace() const

Returns the width of the 3D bezel face.

Remarks

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

See also

wxGauge::SetBezelFace

wxGauge::GetRange

int GetRange() const

Returns the maximum position of the gauge.

See also

wxGauge::SetRange

wxGauge::GetShadowWidth

int GetShadowWidth() const

Returns the 3D shadow margin width.

Remarks

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

See also

wxGauge::SetShadowWidth

wxGauge::GetValue

int GetValue() const

Returns the current position of the gauge.

See also

wxGauge::SetValue

wxGauge::IsVertical

bool IsVertical() const

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

wxGauge::SetBezelFace

void SetBezelFace(int width)

Sets the 3D bezel face width.

Remarks

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

See also

wxGauge::GetBezelFace

wxGauge::SetRange

void SetRange(int range)

Sets the range (maximum value) of the gauge. This function makes the gauge switch to determinate mode, if it's not already.

See also

wxGauge::GetRange

wxGauge::SetShadowWidth

void SetShadowWidth(int width)

Sets the 3D shadow width.

Remarks

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

wxGauge::SetValue

void SetValue(int pos)

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

Parameters

pos

Position for the gauge level.

See also

wxGauge::GetValue

wxGauge::Pulse

void Pulse()

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.