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