X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/71155438f0c8da22a86ce0a267b5f6103587b3f2..ecd87e5b71cdfd71b3356181ab8be1bf508942ef:/docs/latex/wx/spinctrl.tex diff --git a/docs/latex/wx/spinctrl.tex b/docs/latex/wx/spinctrl.tex index f72c25c168..fe9243cee2 100644 --- a/docs/latex/wx/spinctrl.tex +++ b/docs/latex/wx/spinctrl.tex @@ -3,7 +3,6 @@ % spinctrl.h at 11/Mar/00 00:22:05 % - \section{\class{wxSpinCtrl}}\label{wxspinctrl} wxSpinCtrl combines \helpref{wxTextCtrl}{wxtextctrl} and @@ -24,20 +23,25 @@ wxSpinCtrl combines \helpref{wxTextCtrl}{wxtextctrl} and \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxSP\_ARROW\_KEYS}}{The user can use arrow keys.} +\twocolitem{\windowstyle{wxSP\_ARROW\_KEYS}}{The user can use arrow keys to change the value.} \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: +functions that take a \helpref{wxSpinEvent}{wxspinevent} argument: \twocolwidtha{7cm} -\begin{twocollist} -\twocolitem{{\bf EVT\_SPINCTRL(id, func)}}{Generated whenever spinctrl is updated} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_SPINCTRL(id, func)}}{Generated whenever the numeric value +of the spinctrl is updated} \end{twocollist}% +You may also use the \helpref{wxSpinButton}{wxspinbutton} event macros, however +the corresponding events will not be generated under all platforms. Finally, if +the user modifies the text in the edit part of the spin control directly, the +{\tt EVT\_TEXT} is generated, like for the \helpref{wxTextCtrl}{wxtextctrl}. \wxheading{See also} @@ -45,18 +49,14 @@ functions that take a \helpref{wxScrollEvent}{wxscrollevent} argument: \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. @@ -87,14 +87,13 @@ Constructor, creating and showing a spin control. \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. +See \helpref{wxSpinCtrl::wxSpinCtrl}{wxspinctrlwxspinctrl} for details. \membersection{wxSpinCtrl::SetValue}\label{wxspinctrlsetvalue} @@ -116,6 +115,17 @@ Gets the value of the spin control. Sets range of allowable values. +\membersection{wxSpinCtrl::SetSelection}\label{wxspinctrlsetselection} + +\func{void}{SetSelection}{\param{long }{from}, \param{long }{to}} + +Select the text in the text part of the control between positions +{\it from} (inclusive) and {\it to} (exclusive). This is similar to +\helpref{wxTextCtrl::SetSelection}{wxtextctrlsetselection}. + +{\bf NB:} this is currently only implemented for Windows and generic versions +of the control. + \membersection{wxSpinCtrl::GetMin}\label{wxspinctrlgetmin} \constfunc{int}{GetMin}{\void}