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