documented wxSpinCtrl

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6617 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/spinctrl.tex

@@ -0,0 +1,130 @@
+%
+% 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{wxScrollEvent}{wxscrollevent} argument:
+
+\twocolwidtha{7cm}
+\begin{twocollist}
+\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.
+
+\membersection{wxSpinCtrl::wxSpinCtrl}\label{wxspinctrlwxspinctrl}
+
+\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.
+