[wxWidgets.git] / docs / latex / wx / gauge.tex

\section{\class{wxGauge}}\label{wxgauge}

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

\wxheading{Derived from}

\helpref{wxControl}{wxcontrol}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxEvtHandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Window styles}

\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxGA\_HORIZONTAL}}{Creates a horizontal gauge.}
\twocolitem{\windowstyle{wxGA\_VERTICAL}}{Creates a vertical gauge.}
\twocolitem{\windowstyle{wxGA\_PROGRESSBAR}}{Under Windows 95, creates a horizontal progress bar.}
\end{twocollist}

See also \helpref{window styles overview}{windowstyles}.

\wxheading{See also}

\helpref{wxSlider}{wxslider}, \helpref{wxScrollBar}{wxscrollbar}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxGauge::wxGauge}\label{wxgaugeconstr}

\func{}{wxGauge}{\void}

Default constructor.

\func{}{wxGauge}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}

Constructor, creating and showing a gauge.

\wxheading{Parameters}

\docparam{parent}{Window parent.}

\docparam{id}{Window identifier.}

\docparam{range}{Integer range (maximum value) of the gauge.}

\docparam{pos}{Window position.}

\docparam{size}{Window size.}

\docparam{style}{Gauge style. See \helpref{wxGauge}{wxgauge}.}

\docparam{name}{Window name.}

\wxheading{Remarks}

Under Windows 95, there are two different styles of gauge: normal gauge, and progress bar (when
the {\bf wxGA\_PROGRESSBAR} style is used). A progress bar is always horizontal.

\wxheading{See also}

\helpref{wxGauge::Create}{wxgaugecreate}

\membersection{wxGauge::\destruct{wxGauge}}

\func{}{\destruct{wxGauge}}{\void}

Destructor, destroying the gauge.

\membersection{wxGauge::Create}\label{wxgaugecreate}

\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}

Creates the gauge for two-step construction. See \helpref{wxGauge::wxGauge}{wxgaugeconstr}\rtfsp
for further details.

\membersection{wxGauge::GetBezelFace}\label{wxgaugegetbezelface}

\constfunc{int}{GetBezelFace}{\void}

Returns the width of the 3D bezel face.

\wxheading{Remarks}

Windows only, not for {\bf wxGA\_PROGRESSBAR}.

\wxheading{See also}

\helpref{wxGauge::SetBezelFace}{wxgaugesetbezelface}

\membersection{wxGauge::GetRange}\label{wxgaugegetrange}

\constfunc{int}{GetRange}{\void}

Returns the maximum position of the gauge.

\wxheading{See also}

\helpref{wxGauge::SetRange}{wxgaugesetrange}

\membersection{wxGauge::GetShadowWidth}\label{wxgaugegetshadowwidth}

\constfunc{int}{GetShadowWidth}{\void}

Returns the 3D shadow margin width.

\wxheading{Remarks}

Windows only, not for {\bf wxGA\_PROGRESSBAR}.

\wxheading{See also}

\helpref{wxGauge::SetShadowWidth}{wxgaugesetshadowwidth}

\membersection{wxGauge::GetValue}\label{wxgaugegetvalue}

\constfunc{int}{GetValue}{\void}

Returns the current position of the gauge.

\wxheading{See also}

\helpref{wxGauge::SetValue}{wxgaugesetvalue}

\membersection{wxGauge::SetBezelFace}\label{wxgaugesetbezelface}

\func{void}{SetBezelFace}{\param{int }{width}}

Sets the 3D bezel face width.

\wxheading{Remarks}

Windows only, not for {\bf wxGA\_PROGRESSBAR}.

\wxheading{See also}

\helpref{wxGauge::GetBezelFace}{wxgaugegetbezelface}

\membersection{wxGauge::SetRange}\label{wxgaugesetrange}

\func{void}{SetRange}{\param{int }{range}}

Sets the range (maximum value) of the gauge.

\wxheading{See also}

\helpref{wxGauge::GetRange}{wxgaugegetrange}

\membersection{wxGauge::SetShadowWidth}\label{wxgaugesetshadowwidth}

\func{void}{SetShadowWidth}{\param{int }{width}}

Sets the 3D shadow width.

\wxheading{Remarks}

Windows only, not for {\bf wxGA\_PROGRESSBAR}.

\membersection{wxGauge::SetValue}\label{wxgaugesetvalue}

\func{void}{SetValue}{\param{int }{pos}}

Sets the position of the gauge.

\wxheading{Parameters}

\docparam{pos}{Position for the gauge level.}

\wxheading{See also}

\helpref{wxGauge::GetValue}{wxgaugegetvalue}
Commit	Line	Data
a660d684 KB	1	\section{\class{wxGauge}}\label{wxgauge}
	2
	3	A gauge is a horizontal or vertical bar which shows a quantity (often time).
	4	There are no user commands for the gauge.
	5
	6	\wxheading{Derived from}
	7
	8	\helpref{wxControl}{wxcontrol}\\
	9	\helpref{wxWindow}{wxwindow}\\
	10	\helpref{wxEvtHandler}{wxEvtHandler}\\
	11	\helpref{wxObject}{wxobject}
	12
	13	\wxheading{Window styles}
	14
	15	\twocolwidtha{5cm}
	16	\begin{twocollist}\itemsep=0pt
	17	\twocolitem{\windowstyle{wxGA\_HORIZONTAL}}{Creates a horizontal gauge.}
	18	\twocolitem{\windowstyle{wxGA\_VERTICAL}}{Creates a vertical gauge.}
	19	\twocolitem{\windowstyle{wxGA\_PROGRESSBAR}}{Under Windows 95, creates a horizontal progress bar.}
	20	\end{twocollist}
	21
	22	See also \helpref{window styles overview}{windowstyles}.
	23
	24	\wxheading{See also}
	25
	26	\helpref{wxSlider}{wxslider}, \helpref{wxScrollBar}{wxscrollbar}
	27
	28	\latexignore{\rtfignore{\wxheading{Members}}}
	29
	30	\membersection{wxGauge::wxGauge}\label{wxgaugeconstr}
	31
	32	\func{}{wxGauge}{\void}
	33
	34	Default constructor.
	35
eaaa6a06 JS	36	\func{}{wxGauge}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
	37	\param{int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
	38	\param{long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}
a660d684 KB	39
	40	Constructor, creating and showing a gauge.
	41
	42	\wxheading{Parameters}
	43
	44	\docparam{parent}{Window parent.}
	45
	46	\docparam{id}{Window identifier.}
	47
	48	\docparam{range}{Integer range (maximum value) of the gauge.}
	49
	50	\docparam{pos}{Window position.}
	51
	52	\docparam{size}{Window size.}
	53
	54	\docparam{style}{Gauge style. See \helpref{wxGauge}{wxgauge}.}
	55
	56	\docparam{name}{Window name.}
	57
	58	\wxheading{Remarks}
	59
	60	Under Windows 95, there are two different styles of gauge: normal gauge, and progress bar (when
	61	the {\bf wxGA\_PROGRESSBAR} style is used). A progress bar is always horizontal.
	62
	63	\wxheading{See also}
	64
	65	\helpref{wxGauge::Create}{wxgaugecreate}
	66
	67	\membersection{wxGauge::\destruct{wxGauge}}
	68
	69	\func{}{\destruct{wxGauge}}{\void}
	70
	71	Destructor, destroying the gauge.
	72
	73	\membersection{wxGauge::Create}\label{wxgaugecreate}
	74
eaaa6a06 JS	75	\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
	76	\param{int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
	77	\param{long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}
a660d684 KB	78
	79	Creates the gauge for two-step construction. See \helpref{wxGauge::wxGauge}{wxgaugeconstr}\rtfsp
	80	for further details.
	81
	82	\membersection{wxGauge::GetBezelFace}\label{wxgaugegetbezelface}
	83
	84	\constfunc{int}{GetBezelFace}{\void}
	85
	86	Returns the width of the 3D bezel face.
	87
	88	\wxheading{Remarks}
	89
	90	Windows only, not for {\bf wxGA\_PROGRESSBAR}.
	91
	92	\wxheading{See also}
	93
	94	\helpref{wxGauge::SetBezelFace}{wxgaugesetbezelface}
	95
	96	\membersection{wxGauge::GetRange}\label{wxgaugegetrange}
	97
	98	\constfunc{int}{GetRange}{\void}
	99
	100	Returns the maximum position of the gauge.
	101
	102	\wxheading{See also}
	103
	104	\helpref{wxGauge::SetRange}{wxgaugesetrange}
	105
	106	\membersection{wxGauge::GetShadowWidth}\label{wxgaugegetshadowwidth}
	107
	108	\constfunc{int}{GetShadowWidth}{\void}
	109
	110	Returns the 3D shadow margin width.
	111
	112	\wxheading{Remarks}
	113
	114	Windows only, not for {\bf wxGA\_PROGRESSBAR}.
	115
	116	\wxheading{See also}
	117
	118	\helpref{wxGauge::SetShadowWidth}{wxgaugesetshadowwidth}
	119
	120	\membersection{wxGauge::GetValue}\label{wxgaugegetvalue}
	121
	122	\constfunc{int}{GetValue}{\void}
	123
	124	Returns the current position of the gauge.
	125
	126	\wxheading{See also}
	127
	128	\helpref{wxGauge::SetValue}{wxgaugesetvalue}
	129
	130	\membersection{wxGauge::SetBezelFace}\label{wxgaugesetbezelface}
	131
eaaa6a06	132	\func{void}{SetBezelFace}{\param{int }{width}}
a660d684 KB	133
	134	Sets the 3D bezel face width.
	135
	136	\wxheading{Remarks}
	137
	138	Windows only, not for {\bf wxGA\_PROGRESSBAR}.
	139
	140	\wxheading{See also}
	141
	142	\helpref{wxGauge::GetBezelFace}{wxgaugegetbezelface}
	143
	144	\membersection{wxGauge::SetRange}\label{wxgaugesetrange}
	145
eaaa6a06	146	\func{void}{SetRange}{\param{int }{range}}
a660d684 KB	147
	148	Sets the range (maximum value) of the gauge.
	149
	150	\wxheading{See also}
	151
	152	\helpref{wxGauge::GetRange}{wxgaugegetrange}
	153
	154	\membersection{wxGauge::SetShadowWidth}\label{wxgaugesetshadowwidth}
	155
eaaa6a06	156	\func{void}{SetShadowWidth}{\param{int }{width}}
a660d684 KB	157
	158	Sets the 3D shadow width.
	159
	160	\wxheading{Remarks}
	161
	162	Windows only, not for {\bf wxGA\_PROGRESSBAR}.
	163
	164	\membersection{wxGauge::SetValue}\label{wxgaugesetvalue}
	165
eaaa6a06	166	\func{void}{SetValue}{\param{int }{pos}}
a660d684 KB	167
	168	Sets the position of the gauge.
	169
	170	\wxheading{Parameters}
	171
	172	\docparam{pos}{Position for the gauge level.}
	173
	174	\wxheading{See also}
	175
	176	\helpref{wxGauge::GetValue}{wxgaugegetvalue}
	177
	178