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

0 / 182 ( 0%)

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