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_SMOOTH Creates smooth progress bar with one pixel wide update step (not supported by all platforms).

See also window styles overview.

Event handling

wxGauge is read-only so generates no events.

See also

wxSlider, wxScrollBar



wxGauge::wxGauge



wxGauge(void)

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.

pos
Window position.

size
Window size.

style
Gauge style. See wxGauge.

name
Window name.

See also

wxGauge::Create



wxGauge::~wxGauge



~wxGauge(void)

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(void) 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(void) const

Returns the maximum position of the gauge.

Remarks

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

See also

wxGauge::SetRange



wxGauge::GetShadowWidth

int GetShadowWidth(void) 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(void) const

Returns the current position of the gauge.

See also

wxGauge::SetValue



wxGauge::IsVertical

bool IsVertical(void) const

Returns TRUEif the gauge is vertical (has wxGA_VERTICAL style) and FALSEotherwise.



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.

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.

Parameters

pos
Position for the gauge level.

See also

wxGauge::GetValue

ymasuda 平成17年11月19日