Contents Up Previous Next

wxGauge

A gauge is a horizontal or vertical bar which shows a quantity (often time). There are no user commands for the gauge.

Derived from

wxControl
wxWindow
wxEvtHandler
wxObject

Include files

<wx/gauge.h>

Window styles

wxGA_HORIZONTAL Creates a horizontal gauge.
wxGA_VERTICAL Creates a vertical gauge.
wxGA_PROGRESSBAR Under Windows 95, creates a horizontal progress bar.
wxGA_SMOOTH Under Windows 95, creates smooth progress bar with one pixel wide update step.

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::SetBezelFace
wxGauge::SetRange
wxGauge::SetShadowWidth
wxGauge::SetValue


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

id

range

pos

size

style

name

Remarks

Under Windows 95, there are two different styles of gauge: normal gauge, and progress bar (when the wxGA_PROGRESSBAR style is used). A progress bar is always horizontal.

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

Windows only, not for wxGA_PROGRESSBAR.

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

Windows only, not for wxGA_PROGRESSBAR.

See also

wxGauge::SetShadowWidth


wxGauge::GetValue

int GetValue() const

Returns the current position of the gauge.

See also

wxGauge::SetValue


wxGauge::SetBezelFace

void SetBezelFace(int width)

Sets the 3D bezel face width.

Remarks

Windows only, not for wxGA_PROGRESSBAR.

See also

wxGauge::GetBezelFace


wxGauge::SetRange

void SetRange(int range)

Sets the range (maximum value) of the gauge.

See also

wxGauge::GetRange


wxGauge::SetShadowWidth

void SetShadowWidth(int width)

Sets the 3D shadow width.

Remarks

Windows only, not for wxGA_PROGRESSBAR.


wxGauge::SetValue

void SetValue(int pos)

Sets the position of the gauge.

Parameters

pos

See also

wxGauge::GetValue