wxJavaScript

back to gui 

wxGauge

^{generated from ../src/mod_gui/control/gauge.cpp}

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

Constants

Style

Name	Description
HORIZONTAL
VERTICAL
PROGRESSBAR
SMOOTH

Constructor

wxGauge

wxGauge()
 

wxGauge(Parent, 
        Id, 
        Range, 
        Position = wxDefaultPosition, 
        Size = wxDefaultSize, 
        Style = wxGauge.HORIZONTAL, 
        Validator = null)
 

Name	Type	Default	Description
Parent	wxWindow		The parent of wxGauge.
Id	Integer		An window identifier. Use -1 when you don't need it.
Range	Integer		The maximum value of the gauge
Position	wxPoint	wxDefaultPosition	The position of the Gauge control on the given parent.
Size	wxSize	wxDefaultSize	The size of the Gauge control.
Style	Integer	wxGauge.HORIZONTAL	The wxGauge style.
Validator	wxValidator	null

Constructs a new wxGauge object.

Properties

Name	Type	Description
bezelFace	Integer	Get/Set the width of the 3D bezel face. Windows only
range	Integer	Get/Set the maximum position of the gauge.
shadowWidth	Integer	Get/Set the 3D shadow margin width. Windows only
value	Integer	Get/Set the current value of the gauge.
vertical	Boolean	Returns true if the gauge is vertical (has wxGauge.VERTICAL style) and false otherwise.

Methods

create

create(Parent, 
       Id, 
       Range, 
       Position = wxDefaultPosition, 
       Size = wxDefaultSize, 
       Style = wxGauge.HORIZONTAL, 
       Validator = null) : Boolean
 

Name	Type	Default	Description
Parent	wxWindow		The parent of wxGauge.
Id	Integer		An window identifier. Use -1 when you don't need it.
Range	Integer		The maximum value of the gauge
Position	wxPoint	wxDefaultPosition	The position of the Gauge control on the given parent.
Size	wxSize	wxDefaultSize	The size of the Gauge control.
Style	Integer	wxGauge.HORIZONTAL	The wxGauge style.
Validator	wxValidator	null

Creates a wxGauge

pulse

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 property is undefined and thus you need to explicitely set value if you want to restore the determinate mode.