1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxSpinCtrl
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
12 wxSpinCtrl combines wxTextCtrl and wxSpinButton in one control.
15 @style{wxSP_ARROW_KEYS}
16 The user can use arrow keys to change the value.
18 The value wraps at the minimum and maximum.
19 @style{wxTE_PROCESS_ENTER}
20 Indicates that the control should generate @c wxEVT_COMMAND_TEXT_ENTER
21 events. Using this style will prevent the user from using the Enter key
22 for dialog navigation (e.g. activating the default button in the
25 Same as wxTE_LEFT for wxTextCtrl: the text is left aligned.
26 @style{wxALIGN_CENTRE_HORIZONTAL}
27 Same as wxTE_CENTRE for wxTextCtrl: the text is centered.
29 Same as wxTE_RIGHT for wxTextCtrl: the text is right aligned (this is
34 @beginEventEmissionTable{wxSpinEvent}
35 @event{EVT_SPINCTRL(id, func)}
36 Process a wxEVT_COMMAND_SPINCTRL_UPDATED event, which is generated
37 whenever the numeric value of the spin control is updated.
40 You may also use the wxSpinButton event macros, however the corresponding events
41 will not be generated under all platforms. Finally, if the user modifies the
42 text in the edit part of the spin control directly, the EVT_TEXT is generated,
43 like for the wxTextCtrl. When the use enters text into the text area, the text
44 is not validated until the control loses focus (e.g. by using the TAB key).
45 The value is then adjusted to the range and a wxSpinEvent sent then if the value
46 is different from the last value sent.
50 @appearance{spinctrl.png}
52 @see wxSpinButton, wxSpinCtrlDouble, wxControl
54 class wxSpinCtrl
: public wxControl
63 Constructor, creating and showing a spin control.
65 If @a value is non-empty, it will be shown in the text entry part of
66 the control and if it has numeric value, the initial numeric value of
67 the control, as returned by GetValue() will also be determined by it
68 instead of by @a initial. Hence, it only makes sense to specify @a
69 initial if @a value is an empty string or is not convertible to a
70 number, otherwise @a initial is simply ignored and the number specified
74 Parent window. Must not be @NULL.
76 Default value (as text).
78 Window identifier. The value wxID_ANY indicates a default value.
81 If ::wxDefaultPosition is specified then a default position is chosen.
84 If ::wxDefaultSize is specified then a default size is chosen.
86 Window style. See wxSpinButton.
98 wxSpinCtrl(wxWindow
* parent
, wxWindowID id
= wxID_ANY
,
99 const wxString
& value
= wxEmptyString
,
100 const wxPoint
& pos
= wxDefaultPosition
,
101 const wxSize
& size
= wxDefaultSize
,
102 long style
= wxSP_ARROW_KEYS
,
103 int min
= 0, int max
= 100,
104 int initial
= 0, const wxString
& name
= "wxSpinCtrl");
107 Creation function called by the spin control constructor.
108 See wxSpinCtrl() for details.
110 bool Create(wxWindow
* parent
, wxWindowID id
= wxID_ANY
,
111 const wxString
& value
= wxEmptyString
,
112 const wxPoint
& pos
= wxDefaultPosition
,
113 const wxSize
& size
= wxDefaultSize
,
114 long style
= wxSP_ARROW_KEYS
, int min
= 0, int max
= 100,
115 int initial
= 0, const wxString
& name
= "wxSpinCtrl");
118 Gets maximal allowable value.
123 Gets minimal allowable value.
128 Gets the value of the spin control.
130 int GetValue() const;
133 Sets range of allowable values.
135 Notice that calling this method may change the value of the control if
136 it's not inside the new valid range, e.g. it will become @a minVal if
137 it is less than it now. However no @c wxEVT_COMMAND_SPINCTRL_UPDATED
138 event is generated, even if it the value does change.
140 void SetRange(int minVal
, int maxVal
);
143 Select the text in the text part of the control between positions
144 @a from (inclusive) and @a to (exclusive).
145 This is similar to wxTextCtrl::SetSelection().
147 @note this is currently only implemented for Windows and generic versions
150 virtual void SetSelection(long from
, long to
);
153 Sets the value of the spin control. Use the variant using int instead.
155 virtual void SetValue(const wxString
& text
);
158 Sets the value of the spin control.
160 void SetValue(int value
);
164 @class wxSpinCtrlDouble
166 wxSpinCtrlDouble combines wxTextCtrl and wxSpinButton in one control and
167 displays a real number. (wxSpinCtrl displays an integer.)
170 @style{wxSP_ARROW_KEYS}
171 The user can use arrow keys to change the value.
173 The value wraps at the minimum and maximum.
176 @beginEventEmissionTable{wxSpinDoubleEvent}
177 @event{EVT_SPINCTRLDOUBLE(id, func)}
178 Generated whenever the numeric value of the spin control is changed,
179 that is, when the up/down spin button is clicked, when ENTER is pressed,
180 or the control loses focus and the new value is different from the last.
181 See wxSpinDoubleEvent.
186 @appearance{spinctrldouble.png}
188 @see wxSpinButton, wxSpinCtrl, wxControl
190 class wxSpinCtrlDouble
: public wxControl
199 Constructor, creating and showing a spin control.
202 Parent window. Must not be @NULL.
204 Default value (as text).
206 Window identifier. The value wxID_ANY indicates a default value.
209 If ::wxDefaultPosition is specified then a default position is chosen.
212 If ::wxDefaultSize is specified then a default size is chosen.
214 Window style. See wxSpinButton.
228 wxSpinCtrlDouble(wxWindow
* parent
, wxWindowID id
= -1,
229 const wxString
& value
= wxEmptyString
,
230 const wxPoint
& pos
= wxDefaultPosition
,
231 const wxSize
& size
= wxDefaultSize
,
232 long style
= wxSP_ARROW_KEYS
,
233 double min
= 0, double max
= 100,
234 double initial
= 0, double inc
= 1,
235 const wxString
& name
= wxT("wxSpinCtrlDouble"));
238 Creation function called by the spin control constructor.
239 See wxSpinCtrlDouble() for details.
241 bool Create(wxWindow
* parent
, wxWindowID id
= wxID_ANY
,
242 const wxString
& value
= wxEmptyString
,
243 const wxPoint
& pos
= wxDefaultPosition
,
244 const wxSize
& size
= wxDefaultSize
,
245 long style
= wxSP_ARROW_KEYS
, double min
= 0, double max
= 100,
246 double initial
= 0, double inc
= 1,
247 const wxString
& name
= "wxSpinCtrlDouble");
250 Gets the number of digits in the display.
252 unsigned int GetDigits() const;
255 Gets the increment value.
257 double GetIncrement() const;
260 Gets maximal allowable value.
262 double GetMax() const;
265 Gets minimal allowable value.
267 double GetMin() const;
270 Gets the value of the spin control.
272 double GetValue() const;
275 Sets the number of digits in the display.
277 void SetDigits(unsigned int digits
);
280 Sets the increment value.
282 void SetIncrement(double inc
);
285 Sets range of allowable values.
287 void SetRange(double minVal
, double maxVal
);
290 Sets the value of the spin control. Use the variant using double instead.
292 virtual void SetValue(const wxString
& text
);
295 Sets the value of the spin control.
297 void SetValue(double value
);
301 @class wxSpinDoubleEvent
303 This event class is used for the events generated by wxSpinCtrlDouble.
305 @beginEventTable{wxSpinDoubleEvent}
306 @event{EVT_SPINCTRLDOUBLE(id, func)}
307 Generated whenever the numeric value of the spin control is changed,
308 that is, when the up/down spin button is clicked, when ENTER is pressed,
309 or the control loses focus and the new value is different from the last.
310 See wxSpinDoubleEvent.
316 @see wxSpinCtrlDouble
318 class wxSpinDoubleEvent
: public wxNotifyEvent
322 The constructor. Not normally used by the user code.
324 wxSpinDoubleEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0,
328 The copy constructor.
330 wxSpinDoubleEvent(const wxSpinDoubleEvent
& event
);
333 Returns the value associated with this spin control event.
335 double GetValue() const;
338 Set the value associated with the event.
339 (Not normally used by user code.)
341 void SetValue(double value
);
344 wxEventType wxEVT_COMMAND_SPINCTRL_UPDATED
;
345 wxEventType wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED
;