1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/////////////////////////////////////////////////////////////////////////////
// Name: spinbutt.h
// Purpose: interface of wxSpinEvent, wxSpinButton
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxSpinEvent
This event class is used for the events generated by wxSpinButton and wxSpinCtrl.
@beginEventTable{wxSpinEvent}
@event{EVT_SPIN(id, func)}
Generated whenever an arrow is pressed.
@event{EVT_SPIN_UP(id, func)}
Generated when left/up arrow is pressed.
@event{EVT_SPIN_DOWN(id, func)}
Generated when right/down arrow is pressed.
@endEventTable
Note that if you handle both SPIN and UP or DOWN events, you will be notified
about each of them twice: first the UP/DOWN event will be received and then,
if it wasn't vetoed, the SPIN event will be sent.
@library{wxcore}
@category{events}
@see wxSpinButton and wxSpinCtrl
*/
class wxSpinEvent : public wxNotifyEvent
{
public:
/**
The constructor is not normally used by the user code.
*/
wxSpinEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
/**
Retrieve the current spin button or control value.
*/
int GetPosition() const;
/**
Set the value associated with the event.
*/
void SetPosition(int pos);
};
/**
@class wxSpinButton
A wxSpinButton has two small up and down (or left and right) arrow buttons.
It is often used next to a text control for incrementing and decrementing a value.
Portable programs should try to use wxSpinCtrl instead as wxSpinButton is not
implemented for all platforms but wxSpinCtrl is as it degenerates to a simple
wxTextCtrl on such platforms.
@note the range supported by this control (and wxSpinCtrl) depends on the
platform but is at least @c -0x8000 to @c 0x7fff. Under GTK and
Win32 with sufficiently new version of @c comctrl32.dll (at least 4.71
is required, 5.80 is recommended) the full 32 bit range is supported.
@beginStyleTable
@style{wxSP_HORIZONTAL}
Specifies a horizontal spin button (note that this style is not
supported in wxGTK).
@style{wxSP_VERTICAL}
Specifies a vertical spin button.
@style{wxSP_ARROW_KEYS}
The user can use arrow keys to change the value.
@style{wxSP_WRAP}
The value wraps at the minimum and maximum.
@endStyleTable
@beginEventEmissionTable{wxSpinEvent}
@event{EVT_SPIN(id, func)}
Generated whenever pressing an arrow changed the spin button value.
@event{EVT_SPIN_UP(id, func)}
Generated whenever pressing left/up arrow changed the spin button
value.
@event{EVT_SPIN_DOWN(id, func)}
Generated whenever pressing right/down arrow changed the spin
button value.
@endEventTable
Note that if you handle both SPIN and UP or DOWN events, you will be notified
about each of them twice: first the UP/DOWN event will be received and then,
if it wasn't vetoed, the SPIN event will be sent.
@library{wxcore}
@category{ctrl}
@appearance{spinbutton}
@see wxSpinCtrl
*/
class wxSpinButton : public wxControl
{
public:
/**
Default constructor.
*/
wxSpinButton();
/**
Constructor, creating and showing a spin button.
@param parent
Parent window. Must not be @NULL.
@param id
Window identifier. The value wxID_ANY indicates a default value.
@param pos
Window position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Window size.
If ::wxDefaultSize is specified then a default size is chosen.
@param style
Window style. See wxSpinButton class description.
@param name
Window name.
@see Create()
*/
wxSpinButton(wxWindow* parent, wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxSP_VERTICAL,
const wxString& name = "spinButton");
/**
Destructor, destroys the spin button control.
*/
virtual ~wxSpinButton();
/**
Scrollbar creation function called by the spin button constructor.
See wxSpinButton() for details.
*/
bool Create(wxWindow* parent, wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxSP_VERTICAL,
const wxString& name = "wxSpinButton");
/**
Get the value for increment for a spin control.
The default value is 1 but it can be changed using SetIncrement().
@since 3.1.6
*/
int GetIncrement() const;
/**
Returns the maximum permissible value.
@see SetRange()
*/
virtual int GetMax() const;
/**
Returns the minimum permissible value.
@see SetRange()
*/
virtual int GetMin() const;
/**
Returns the current spin button value.
@see SetValue()
*/
virtual int GetValue() const;
/**
Sets the increment for the control.
The increment is the number by which the value changes when the up or
down arrow is used.
The default is 1.
This function is currently implemented only in wxMSW and does nothing
under the other platforms.
@since 3.1.6
@see wxSpinCtrl::SetIncrement()
*/
void SetIncrement(int value);
/**
Sets the range of the spin button.
In portable code, @a min should be less than or equal to @a max. In
wxMSW it is possible to specify minimum greater than maximum and the
native control supports the same range as if they were reversed, but
swaps the meaning of up and down arrows, however this dubious feature
is not supported on other platforms.
@param min
The minimum value for the spin button.
@param max
The maximum value for the spin button.
@see GetMin(), GetMax()
*/
virtual void SetRange(int min, int max);
/**
Sets the value of the spin button.
@param value
The value for the spin button.
*/
virtual void SetValue(int value);
};
|
