]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/spinbutt.tex
os2 distribution response file
[wxWidgets.git] / docs / latex / wx / spinbutt.tex
1 \section{\class{wxSpinButton}}\label{wxspinbutton}
2
3 A wxSpinButton has two small up and down (or left and right) arrow buttons. It
4 is often used next to a text control for increment and decrementing a value.
5 Portable programs should try to use \helpref{wxSpinCtrl}{wxspinctrl} instead
6 as wxSpinButton is not implemented for all platforms (Win32 and GTK only
7 currently).
8
9 {\bf NB:} the range supported by this control (and wxSpinCtrl) depends on the
10 platform but is at least {\tt -0x8000} to {\tt 0x7fff}. Under GTK and
11 Win32 with sufficiently new version of {\tt comctrl32.dll} (at least 4.71 is
12 required, 5.80 is recommended) the full 32 bit range is supported.
13
14 \wxheading{Derived from}
15
16 \helpref{wxControl}{wxcontrol}\\
17 \helpref{wxWindow}{wxwindow}\\
18 \helpref{wxEvtHandler}{wxevthandler}\\
19 \helpref{wxObject}{wxobject}
20
21 \wxheading{See also}
22
23 \helpref{wxSpinCtrl}{wxspinctrl}
24
25 \wxheading{Include files}
26
27 <wx/spinbutt.h>
28
29 \wxheading{Window styles}
30
31 \twocolwidtha{5cm}
32 \begin{twocollist}\itemsep=0pt
33 \twocolitem{\windowstyle{wxSP\_HORIZONTAL}}{Specifies a horizontal spin button (note that this style is not supported in wxGTK).}
34 \twocolitem{\windowstyle{wxSP\_VERTICAL}}{Specifies a vertical spin button.}
35 \twocolitem{\windowstyle{wxSP\_ARROW\_KEYS}}{The user can use arrow keys.}
36 \twocolitem{\windowstyle{wxSP\_WRAP}}{The value wraps at the minimum and maximum.}
37 \end{twocollist}
38
39 See also \helpref{window styles overview}{windowstyles}.
40
41 \input spinevt.inc
42
43 \wxheading{See also}
44
45 \helpref{Event handling overview}{eventhandlingoverview}
46
47 \latexignore{\rtfignore{\wxheading{Members}}}
48
49 \membersection{wxSpinButton::wxSpinButton}\label{wxspinbuttonconstr}
50
51 \func{}{wxSpinButton}{\void}
52
53 Default constructor.
54
55 \func{}{wxSpinButton}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp
56 \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
57 \param{long}{ style = wxSP\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
58 \param{const wxString\& }{name = ``spinButton"}}
59
60 Constructor, creating and showing a spin button.
61
62 \wxheading{Parameters}
63
64 \docparam{parent}{Parent window. Must not be NULL.}
65
66 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
67
68 \docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
69
70 \docparam{size}{Window size. If the default size (-1, -1) is specified then a default size is chosen.}
71
72 \docparam{style}{Window style. See \helpref{wxSpinButton}{wxspinbutton}.}
73
74 \docparam{validator}{Window validator.}
75
76 \docparam{name}{Window name.}
77
78 \wxheading{See also}
79
80 \helpref{wxSpinButton::Create}{wxspinbuttoncreate}, \helpref{wxValidator}{wxvalidator}
81
82 \membersection{wxSpinButton::\destruct{wxSpinButton}}
83
84 \func{void}{\destruct{wxSpinButton}}{\void}
85
86 Destructor, destroys the spin button control.
87
88 \membersection{wxSpinButton::Create}\label{wxspinbuttoncreate}
89
90 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp
91 \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
92 \param{long}{ style = wxSP\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
93 \param{const wxString\& }{name = ``spinButton"}}
94
95 Scrollbar creation function called by the spin button constructor.
96 See \helpref{wxSpinButton::wxSpinButton}{wxspinbuttonconstr} for details.
97
98 \membersection{wxSpinButton::GetMax}\label{wxspinbuttongetmax}
99
100 \constfunc{int}{GetMax}{\void}
101
102 Returns the maximum permissible value.
103
104 \wxheading{See also}
105
106 \helpref{wxSpinButton::SetRange}{wxspinbuttonsetrange}
107
108 \membersection{wxSpinButton::GetMin}\label{wxspinbuttongetmin}
109
110 \constfunc{int}{GetMin}{\void}
111
112 Returns the minimum permissible value.
113
114 \wxheading{See also}
115
116 \helpref{wxSpinButton::SetRange}{wxspinbuttonsetrange}
117
118 \membersection{wxSpinButton::GetValue}\label{wxspinbuttongetvalue}
119
120 \constfunc{int}{GetValue}{\void}
121
122 Returns the current spin button value.
123
124 \wxheading{See also}
125
126 \helpref{wxSpinButton::SetValue}{wxspinbuttonsetvalue}
127
128 \membersection{wxSpinButton::SetRange}\label{wxspinbuttonsetrange}
129
130 \func{void}{SetRange}{\param{int}{ min}, \param{int}{ max}}
131
132 Sets the range of the spin button.
133
134 \wxheading{Parameters}
135
136 \docparam{min}{The minimum value for the spin button.}
137
138 \docparam{max}{The maximum value for the spin button.}
139
140 \wxheading{See also}
141
142 \helpref{wxSpinButton::GetMin}{wxspinbuttongetmin}, \helpref{wxSpinButton::GetMax}{wxspinbuttongetmax}
143
144 \membersection{wxSpinButton::SetValue}\label{wxspinbuttonsetvalue}
145
146 \func{void}{SetValue}{\param{int}{ value}}
147
148 Sets the value of the spin button.
149
150 \wxheading{Parameters}
151
152 \docparam{value}{The value for the spin button.}
153
154 \wxheading{See also}
155
156 \helpref{wxSpinButton::GetValue}{wxspinbuttongetvalue}
157