docs/latex/wx/spinctrl.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % spinctrl.h at 11/Mar/00 00:22:05
   4 %
   5
   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 to change the value.}
  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
  33 functions that take a \helpref{wxSpinEvent}{wxspinevent} argument:
  34
  35 \twocolwidtha{7cm}
  36 \begin{twocollist}\itemsep=0pt
  37 \twocolitem{{\bf EVT\_SPINCTRL(id, func)}}{Generated whenever the numeric value
  38 of the spinctrl is updated}
  39 \end{twocollist}%
  40
  41 You may also use the \helpref{wxSpinButton}{wxspinbutton} event macros, however
  42 the corresponding events will not be generated under all platforms. Finally, if
  43 the user modifies the text in the edit part of the spin control directly, the
  44 {\tt EVT\_TEXT} is generated, like for the \helpref{wxTextCtrl}{wxtextctrl}.
  45
  46 When the use enters text into the text area, the text is not
  47 validated until the control loses focus (e.g. by using the TAB
  48 key). The value is then adjusted to the range and a
  49 \helpref{wxSpinEvent}{wxspinevent} sent then if the value
  50 is different from the last value sent.
  51
  52 \wxheading{See also}
  53
  54 \helpref{Event handling overview}{eventhandlingoverview},
  55 \helpref{wxSpinButton}{wxspinbutton},
  56 \helpref{wxControl}{wxcontrol}
  57
  58 \latexignore{\rtfignore{\wxheading{Members}}}
  59
  60 \membersection{wxSpinCtrl::wxSpinCtrl}\label{wxspinctrlwxspinctrl}
  61
  62 \func{}{wxSpinCtrl}{\void}
  63
  64 Default constructor.
  65
  66 \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")}}
  67
  68 Constructor, creating and showing a spin control.
  69
  70 \wxheading{Parameters}
  71
  72 \docparam{parent}{Parent window. Must not be NULL.}
  73
  74 \docparam{value}{Default value.}
  75
  76 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
  77
  78 \docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
  79
  80 \docparam{size}{Window size. If the default size (-1, -1) is specified then a default size is chosen.}
  81
  82 \docparam{style}{Window style. See \helpref{wxSpinButton}{wxspinbutton}.}
  83
  84 \docparam{min}{Minimal value.}
  85
  86 \docparam{max}{Maximal value.}
  87
  88 \docparam{initial}{Initial value.}
  89
  90 \docparam{name}{Window name.}
  91
  92 \wxheading{See also}
  93
  94 \helpref{wxSpinCtrl::Create}{wxspinctrlcreate}
  95
  96 \membersection{wxSpinCtrl::Create}\label{wxspinctrlcreate}
  97
  98 \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")}}
  99
 100 Creation function called by the spin control constructor.
 101
 102 See \helpref{wxSpinCtrl::wxSpinCtrl}{wxspinctrlwxspinctrl} for details.
 103
 104 \membersection{wxSpinCtrl::SetValue}\label{wxspinctrlsetvalue}
 105
 106 \func{void}{SetValue}{\param{const wxString\& }{text}}
 107
 108 \func{void}{SetValue}{\param{int }{value}}
 109
 110 Sets the value of the spin control.
 111
 112 \membersection{wxSpinCtrl::GetValue}\label{wxspinctrlgetvalue}
 113
 114 \constfunc{int}{GetValue}{\void}
 115
 116 Gets the value of the spin control.
 117
 118 \membersection{wxSpinCtrl::SetRange}\label{wxspinctrlsetrange}
 119
 120 \func{void}{SetRange}{\param{int }{minVal}, \param{int }{maxVal}}
 121
 122 Sets range of allowable values.
 123
 124 \membersection{wxSpinCtrl::SetSelection}\label{wxspinctrlsetselection}
 125
 126 \func{void}{SetSelection}{\param{long }{from}, \param{long }{to}}
 127
 128 Select the text in the text part of the control between  positions
 129 {\it from} (inclusive) and {\it to} (exclusive). This is similar to
 130 \helpref{wxTextCtrl::SetSelection}{wxtextctrlsetselection}.
 131
 132 {\bf NB:} this is currently only implemented for Windows and generic versions
 133 of the control.
 134
 135 \membersection{wxSpinCtrl::GetMin}\label{wxspinctrlgetmin}
 136
 137 \constfunc{int}{GetMin}{\void}
 138
 139 Gets minimal allowable value.
 140
 141 \membersection{wxSpinCtrl::GetMax}\label{wxspinctrlgetmax}
 142
 143 \constfunc{int}{GetMax}{\void}
 144
 145 Gets maximal allowable value.
 146