wx.Gauge

Inheritance diagram for wx.Gauge:

Description

A gauge is a horizontal or vertical bar which shows a quantity (often time).

wx.Gauge 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).

wx.Gauge supports dynamic switch between these two work modes.

There are no user commands for the gauge.

See also

wx.Slider, wx.ScrollBar

Derived From

• wx.Control
• wx.Window
• wx.EvtHandler
• wx.Object

Window Styles

Window Style	Description
wx.GA_HORIZONTAL	Creates a horizontal gauge.
wx.GA_VERTICAL	Creates a vertical gauge.
wx.GA_SMOOTH	Creates smooth progress bar with one pixel wide update step (not supported by all platforms).

Control Appearance

wxMSW

wxMAC

wxGTK

Methods Summary

• __init__
• GetBezelFace
• GetRange
• GetShadowWidth
• GetValue
• IsVertical
• Pulse
• SetBezelFace
• SetRange
• SetShadowWidth
• SetValue

Properties Summary

• BezelFace
• Range
• ShadowWidth
• Value

Class API

Methods

__init__(parent, id=-1, range=100, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.GA_HORIZONTAL, validator=wx.DefaultValidator, name=wx.GaugeNameStr)

Default constructor.

Parameters:

• parent (wx.Window)
• id (int)
• range (int)
• pos (wx.Point)
• size (wx.Size)
• style (long)
• validator (wx.Validator)
• name (string)

Returns:

wx.Gauge

---

GetBezelFace()

Returns the width of the 3D bezel face.

Returns:

int

Note

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

See also

SetBezelFace

---

GetRange()

Returns the maximum position of the gauge.

Returns:

int

---

GetShadowWidth()

Returns the 3D shadow margin width.

Returns:

int

Note

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

See also

SetShadowWidth

---

GetValue()

Returns the current position of the gauge.

Returns:

int

See also

SetValue

---

IsVertical()

Returns True if the gauge is vertical (has wx.GA_VERTICAL style) and False otherwise.

Returns:

bool

---

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

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.

---

SetBezelFace(width)

Sets the 3D bezel face width.

Parameters:

• width (int)

Note

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

See also

GetBezelFace

---

SetRange(range)

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

Parameters:

• range (int)

See also

GetRange

---

SetShadowWidth(width)

Sets the 3D shadow width.

Parameters:

• width (int)

Note

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

---

SetValue(pos)

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

Parameters:

• pos (int): Position for the gauge level.

See also

GetValue

---

Properties

BezelFace

See GetBezelFace and SetBezelFace

Range

See GetRange and SetRange

ShadowWidth

See GetShadowWidth and SetShadowWidth

Value

See GetValue and SetValue