.TH wxGauge 3erl "wx 2.2.2.1" "wxWidgets team." "Erlang Module Definition"
.SH NAME
wxGauge \- Functions for wxGauge class
.SH DESCRIPTION
.LP
A gauge is a horizontal or vertical bar which shows a quantity (often time)\&.
.LP
\fIwxGauge\fR\& supports two working modes: determinate and indeterminate progress\&.
.LP
The first is the usual working mode (see \fIsetValue/2\fR\& and \fIsetRange/2\fR\&) 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 \fIpulse/1\fR\& 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)\&.
.LP
\fIwxGauge\fR\& supports dynamic switch between these two work modes\&.
.LP
There are no user commands for the gauge\&.
.LP
Styles
.LP
This class supports the following styles:
.LP
See: \fIwxSlider\fR\&, \fIwxScrollBar\fR\& 
.LP
This class is derived (and can use functions) from: \fIwxControl\fR\& \fIwxWindow\fR\& \fIwxEvtHandler\fR\&
.LP
wxWidgets docs: wxGauge
.SH DATA TYPES
.nf

\fBwxGauge()\fR\& = wx:wx_object()
.br
.fi
.SH EXPORTS
.LP
.nf

.B
new() -> wxGauge()
.br
.fi
.br
.RS
.LP
Default constructor\&.
.RE

.LP
.nf

.B
new(Parent, Id, Range) -> wxGauge()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
Parent = wxWindow:wxWindow()
.br
Id = Range = integer()
.br
.RE
.RE
.LP
.nf

.B
new(Parent, Id, Range, Options :: [Option]) -> wxGauge()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
Parent = wxWindow:wxWindow()
.br
Id = Range = integer()
.br
Option = 
.br
    {pos, {X :: integer(), Y :: integer()}} |
.br
    {size, {W :: integer(), H :: integer()}} |
.br
    {style, integer()} |
.br
    {validator, wx:wx_object()}
.br
.RE
.RE
.RS
.LP
Constructor, creating and showing a gauge\&.
.LP
See: \fIcreate/5\fR\& 
.RE

.LP
.nf

.B
destroy(This :: wxGauge()) -> ok
.br
.fi
.br
.RS
.LP
Destructor, destroying the gauge\&.
.RE

.LP
.nf

.B
create(This, Parent, Id, Range) -> boolean()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxGauge()
.br
Parent = wxWindow:wxWindow()
.br
Id = Range = integer()
.br
.RE
.RE
.LP
.nf

.B
create(This, Parent, Id, Range, Options :: [Option]) -> boolean()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxGauge()
.br
Parent = wxWindow:wxWindow()
.br
Id = Range = integer()
.br
Option = 
.br
    {pos, {X :: integer(), Y :: integer()}} |
.br
    {size, {W :: integer(), H :: integer()}} |
.br
    {style, integer()} |
.br
    {validator, wx:wx_object()}
.br
.RE
.RE
.RS
.LP
Creates the gauge for two-step construction\&.
.LP
See \fInew/4\fR\& for further details\&.
.RE

.LP
.nf

.B
getRange(This) -> integer()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxGauge()
.br
.RE
.RE
.RS
.LP
Returns the maximum position of the gauge\&.
.LP
See: \fIsetRange/2\fR\& 
.RE

.LP
.nf

.B
getValue(This) -> integer()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxGauge()
.br
.RE
.RE
.RS
.LP
Returns the current position of the gauge\&.
.LP
See: \fIsetValue/2\fR\& 
.RE

.LP
.nf

.B
isVertical(This) -> boolean()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxGauge()
.br
.RE
.RE
.RS
.LP
Returns true if the gauge is vertical (has \fIwxGA_VERTICAL\fR\& style) and false otherwise\&.
.RE

.LP
.nf

.B
setRange(This, Range) -> ok
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxGauge()
.br
Range = integer()
.br
.RE
.RE
.RS
.LP
Sets the range (maximum value) of the gauge\&.
.LP
This function makes the gauge switch to determinate mode, if it\&'s not already\&.
.LP
When the gauge is in indeterminate mode, under wxMSW the gauge repeatedly goes from zero to \fIrange\fR\& and back; under other ports when in indeterminate mode, the \fIrange\fR\& setting is ignored\&.
.LP
See: \fIgetRange/1\fR\& 
.RE

.LP
.nf

.B
setValue(This, Pos) -> ok
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxGauge()
.br
Pos = integer()
.br
.RE
.RE
.RS
.LP
Sets the position of the gauge\&.
.LP
The \fIpos\fR\& must be between 0 and the gauge range as returned by \fIgetRange/1\fR\&, inclusive\&.
.LP
This function makes the gauge switch to determinate mode, if it was in indeterminate mode before\&.
.LP
See: \fIgetValue/1\fR\& 
.RE

.LP
.nf

.B
pulse(This) -> ok
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxGauge()
.br
.RE
.RE
.RS
.LP
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\&.
.LP
Note: After calling this function the value returned by \fIgetValue/1\fR\& is undefined and thus you need to explicitly call \fIsetValue/2\fR\& if you want to restore the determinate mode\&.
.RE