git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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