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

%
% automatically generated by HelpGen from
% spinctrl.h at 11/Mar/00 00:22:05
%

\section{\class{wxSpinCtrl}}\label{wxspinctrl}

wxSpinCtrl combines \helpref{wxTextCtrl}{wxtextctrl} and 
\helpref{wxSpinButton}{wxspinbutton} in one control.

\wxheading{Derived from}

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

\wxheading{Include files}

<wx/spinctrl.h>

\wxheading{Window styles}

\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxSP\_ARROW\_KEYS}}{The user can use arrow keys.}
\twocolitem{\windowstyle{wxSP\_WRAP}}{The value wraps at the minimum and maximum.}
\end{twocollist}

\wxheading{Event handling}

To process input from a spin button, use one of these event handler macros to direct input to member
functions that take a \helpref{wxSpinEvent}{wxspinevent} argument:

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_SPINCTRL(id, func)}}{Generated whenever spinctrl is updated}
\end{twocollist}%

\wxheading{See also}

\helpref{Event handling overview}{eventhandlingoverview},
\helpref{wxSpinButton}{wxspinbutton},
\helpref{wxControl}{wxcontrol}

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

\membersection{wxSpinCtrl::wxSpinCtrl}\label{wxspinctrlwxspinctrl}

\func{}{wxSpinCtrl}{\void}

Default constructor.

\func{}{wxSpinCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = -1}, \param{const wxString\& }{value = wxEmptyString}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxSP\_ARROW\_KEYS}, \param{int }{min = 0}, \param{int }{max = 100}, \param{int }{initial = 0}, \param{const wxString\& }{name = \_T("wxSpinCtrl")}}

Constructor, creating and showing a spin control.

\wxheading{Parameters}

\docparam{parent}{Parent window. Must not be NULL.}

\docparam{value}{Default value.}

\docparam{id}{Window identifier. A value of -1 indicates a default value.}

\docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}

\docparam{size}{Window size. If the default size (-1, -1) is specified then a default size is chosen.}

\docparam{style}{Window style. See \helpref{wxSpinButton}{wxspinbutton}.}

\docparam{min}{Minimal value.}

\docparam{max}{Maximal value.}

\docparam{initial}{Initial value.}

\docparam{name}{Window name.}

\wxheading{See also}

\helpref{wxSpinCtrl::Create}{wxspinctrlcreate}

\membersection{wxSpinCtrl::Create}\label{wxspinctrlcreate}

\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = -1}, \param{const wxString\& }{value = wxEmptyString}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxSP\_ARROW\_KEYS}, \param{int }{min = 0}, \param{int }{max = 100}, \param{int }{initial = 0}, \param{const wxString\& }{name = \_T("wxSpinCtrl")}}

Creation function called by the spin control constructor.

See \helpref{wxSpinCtrl::wxSpinCtrl}{wxspinctrlwxspinctrl} for details.

\membersection{wxSpinCtrl::SetValue}\label{wxspinctrlsetvalue}

\func{void}{SetValue}{\param{const wxString\& }{text}}

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

Sets the value of the spin control.

\membersection{wxSpinCtrl::GetValue}\label{wxspinctrlgetvalue}

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

Gets the value of the spin control.

\membersection{wxSpinCtrl::SetRange}\label{wxspinctrlsetrange}

\func{void}{SetRange}{\param{int }{minVal}, \param{int }{maxVal}}

Sets range of allowable values.

\membersection{wxSpinCtrl::GetMin}\label{wxspinctrlgetmin}

\constfunc{int}{GetMin}{\void}

Gets minimal allowable value.

\membersection{wxSpinCtrl::GetMax}\label{wxspinctrlgetmax}

\constfunc{int}{GetMax}{\void}

Gets maximal allowable value.
Commit	Line	Data
71155438 VS	1	%
	2	% automatically generated by HelpGen from
	3	% spinctrl.h at 11/Mar/00 00:22:05
	4	%
	5
71155438 VS	6	\section{\class{wxSpinCtrl}}\label{wxspinctrl}
	7
	8	wxSpinCtrl combines \helpref{wxTextCtrl}{wxtextctrl} and
	9	\helpref{wxSpinButton}{wxspinbutton} in one control.
	10
	11	\wxheading{Derived from}
	12
	13	\helpref{wxControl}{wxcontrol}\\
	14	\helpref{wxWindow}{wxwindow}\\
	15	\helpref{wxEvtHandler}{wxevthandler}\\
	16	\helpref{wxObject}{wxobject}
	17
	18	\wxheading{Include files}
	19
	20	<wx/spinctrl.h>
	21
	22	\wxheading{Window styles}
	23
	24	\twocolwidtha{5cm}
	25	\begin{twocollist}\itemsep=0pt
	26	\twocolitem{\windowstyle{wxSP\_ARROW\_KEYS}}{The user can use arrow keys.}
	27	\twocolitem{\windowstyle{wxSP\_WRAP}}{The value wraps at the minimum and maximum.}
	28	\end{twocollist}
	29
	30	\wxheading{Event handling}
	31
	32	To process input from a spin button, use one of these event handler macros to direct input to member
f6bcfd97	33	functions that take a \helpref{wxSpinEvent}{wxspinevent} argument:
71155438 VS	34
71155438 VS	35	\twocolwidtha{7cm}
c0bcc480	36	\begin{twocollist}\itemsep=0pt
71155438 VS	37	\twocolitem{{\bf EVT\_SPINCTRL(id, func)}}{Generated whenever spinctrl is updated}
	38	\end{twocollist}%
	39
71155438 VS	40	\wxheading{See also}
	41
	42	\helpref{Event handling overview}{eventhandlingoverview},
	43	\helpref{wxSpinButton}{wxspinbutton},
	44	\helpref{wxControl}{wxcontrol}
	45
71155438 VS	46	\latexignore{\rtfignore{\wxheading{Members}}}
71155438 VS	47
71155438 VS	48	\membersection{wxSpinCtrl::wxSpinCtrl}\label{wxspinctrlwxspinctrl}
	49
	50	\func{}{wxSpinCtrl}{\void}
	51
	52	Default constructor.
	53
71155438 VS	54	\func{}{wxSpinCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = -1}, \param{const wxString\& }{value = wxEmptyString}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxSP\_ARROW\_KEYS}, \param{int }{min = 0}, \param{int }{max = 100}, \param{int }{initial = 0}, \param{const wxString\& }{name = \_T("wxSpinCtrl")}}
	55
	56	Constructor, creating and showing a spin control.
	57
	58	\wxheading{Parameters}
	59
	60	\docparam{parent}{Parent window. Must not be NULL.}
	61
	62	\docparam{value}{Default value.}
	63
	64	\docparam{id}{Window identifier. A value of -1 indicates a default value.}
	65
	66	\docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
	67
	68	\docparam{size}{Window size. If the default size (-1, -1) is specified then a default size is chosen.}
	69
	70	\docparam{style}{Window style. See \helpref{wxSpinButton}{wxspinbutton}.}
	71
	72	\docparam{min}{Minimal value.}
	73
	74	\docparam{max}{Maximal value.}
	75
	76	\docparam{initial}{Initial value.}
	77
	78	\docparam{name}{Window name.}
	79
	80	\wxheading{See also}
	81
	82	\helpref{wxSpinCtrl::Create}{wxspinctrlcreate}
	83
71155438 VS	84	\membersection{wxSpinCtrl::Create}\label{wxspinctrlcreate}
	85
	86	\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = -1}, \param{const wxString\& }{value = wxEmptyString}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxSP\_ARROW\_KEYS}, \param{int }{min = 0}, \param{int }{max = 100}, \param{int }{initial = 0}, \param{const wxString\& }{name = \_T("wxSpinCtrl")}}
	87
	88	Creation function called by the spin control constructor.
71155438	89
c0bcc480	90	See \helpref{wxSpinCtrl::wxSpinCtrl}{wxspinctrlwxspinctrl} for details.
71155438 VS	91
	92	\membersection{wxSpinCtrl::SetValue}\label{wxspinctrlsetvalue}
	93
	94	\func{void}{SetValue}{\param{const wxString\& }{text}}
	95
	96	\func{void}{SetValue}{\param{int }{value}}
	97
	98	Sets the value of the spin control.
	99
	100	\membersection{wxSpinCtrl::GetValue}\label{wxspinctrlgetvalue}
	101
	102	\constfunc{int}{GetValue}{\void}
	103
	104	Gets the value of the spin control.
	105
	106	\membersection{wxSpinCtrl::SetRange}\label{wxspinctrlsetrange}
	107
	108	\func{void}{SetRange}{\param{int }{minVal}, \param{int }{maxVal}}
	109
	110	Sets range of allowable values.
	111
	112	\membersection{wxSpinCtrl::GetMin}\label{wxspinctrlgetmin}
	113
	114	\constfunc{int}{GetMin}{\void}
	115
	116	Gets minimal allowable value.
	117
	118	\membersection{wxSpinCtrl::GetMax}\label{wxspinctrlgetmax}
	119
	120	\constfunc{int}{GetMax}{\void}
	121
	122	Gets maximal allowable value.
	123