1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/generic/spinctlg.h
3 // Purpose: generic wxSpinCtrl class
4 // Author: Vadim Zeitlin
8 // Copyright: (c) Vadim Zeitlin
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_GENERIC_SPINCTRL_H_
13 #define _WX_GENERIC_SPINCTRL_H_
15 // ----------------------------------------------------------------------------
16 // wxSpinCtrl is a combination of wxSpinButton and wxTextCtrl, so if
17 // wxSpinButton is available, this is what we do - but if it isn't, we still
18 // define wxSpinCtrl class which then has the same appearance as wxTextCtrl but
19 // the different interface. This allows to write programs using wxSpinCtrl
20 // without tons of #ifdefs.
21 // ----------------------------------------------------------------------------
25 class WXDLLIMPEXP_FWD_CORE wxSpinButton
;
26 class WXDLLIMPEXP_FWD_CORE wxTextCtrl
;
28 class wxSpinCtrlTextGeneric
; // wxTextCtrl used for the wxSpinCtrlGenericBase
30 // The !wxUSE_SPINBTN version's GetValue() function conflicts with the
31 // wxTextCtrl's GetValue() and so you have to input a dummy int value.
32 #define wxSPINCTRL_GETVALUE_FIX
34 // ----------------------------------------------------------------------------
35 // wxSpinCtrlGeneric is a combination of wxTextCtrl and wxSpinButton
37 // This class manages a double valued generic spinctrl through the DoGet/SetXXX
38 // functions that are made public as Get/SetXXX functions for int or double
39 // for the wxSpinCtrl and wxSpinCtrlDouble classes respectively to avoid
40 // function ambiguity.
41 // ----------------------------------------------------------------------------
43 class WXDLLIMPEXP_CORE wxSpinCtrlGenericBase
: public wxSpinCtrlBase
46 wxSpinCtrlGenericBase() { Init(); }
48 bool Create(wxWindow
*parent
,
49 wxWindowID id
= wxID_ANY
,
50 const wxString
& value
= wxEmptyString
,
51 const wxPoint
& pos
= wxDefaultPosition
,
52 const wxSize
& size
= wxDefaultSize
,
53 long style
= wxSP_ARROW_KEYS
| wxALIGN_RIGHT
,
54 double min
= 0, double max
= 100, double initial
= 0,
56 const wxString
& name
= wxT("wxSpinCtrl"));
58 virtual ~wxSpinCtrlGenericBase();
64 // T GetIncrement() const
65 virtual bool GetSnapToTicks() const { return m_snap_to_ticks
; }
66 // unsigned GetDigits() const - wxSpinCtrlDouble only
69 virtual void SetValue(const wxString
& text
);
70 // void SetValue(T val)
71 // void SetRange(T minVal, T maxVal)
72 // void SetIncrement(T inc)
73 virtual void SetSnapToTicks(bool snap_to_ticks
);
74 // void SetDigits(unsigned digits) - wxSpinCtrlDouble only
76 // Select text in the textctrl
77 void SetSelection(long from
, long to
);
79 // implementation from now on
81 // forward these functions to all subcontrols
82 virtual bool Enable(bool enable
= true);
83 virtual bool Show(bool show
= true);
84 virtual bool Reparent(wxWindowBase
*newParent
);
86 // get the subcontrols
87 wxTextCtrl
*GetText() const { return m_textCtrl
; }
88 wxSpinButton
*GetSpinButton() const { return m_spinButton
; }
90 // forwarded events from children windows
91 void OnSpinButton(wxSpinEvent
& event
);
92 void OnTextEnter(wxCommandEvent
& event
);
93 void OnTextChar(wxKeyEvent
& event
);
95 friend class wxSpinCtrlTextGeneric
;
98 // override the base class virtuals involved into geometry calculations
99 virtual wxSize
DoGetBestSize() const;
100 virtual void DoMoveWindow(int x
, int y
, int width
, int height
);
102 // generic double valued functions
103 double DoGetValue() const { return m_value
; }
104 bool DoSetValue(double val
);
105 void DoSetRange(double min_val
, double max_val
);
106 void DoSetIncrement(double inc
);
108 // update our value to reflect the text control contents (if it has been
109 // modified by user, do nothing otherwise)
111 // can also change the text control if its value is invalid
113 // return true if our value has changed
114 bool SyncSpinToText();
116 // Send the correct event type
117 virtual void DoSendEvent() = 0;
119 // check if the value is in range
120 bool InRange(double n
) const { return (n
>= m_min
) && (n
<= m_max
); }
122 // ensure that the value is in range wrapping it round if necessary
123 double AdjustToFitInRange(double value
) const;
130 bool m_snap_to_ticks
;
136 wxTextCtrl
*m_textCtrl
;
137 wxSpinButton
*m_spinButton
;
140 // common part of all ctors
144 #else // !wxUSE_SPINBTN
146 #define wxSPINCTRL_GETVALUE_FIX int = 1
148 // ----------------------------------------------------------------------------
149 // wxSpinCtrl is just a text control
150 // ----------------------------------------------------------------------------
152 #include "wx/textctrl.h"
154 class WXDLLIMPEXP_CORE wxSpinCtrlGenericBase
: public wxTextCtrl
157 wxSpinCtrlGenericBase() : m_value(0), m_min(0), m_max(100),
158 m_increment(1), m_snap_to_ticks(false),
159 m_format(wxT("%g")) { }
161 bool Create(wxWindow
*parent
,
162 wxWindowID id
= wxID_ANY
,
163 const wxString
& value
= wxEmptyString
,
164 const wxPoint
& pos
= wxDefaultPosition
,
165 const wxSize
& size
= wxDefaultSize
,
166 long style
= wxSP_ARROW_KEYS
| wxALIGN_RIGHT
,
167 double min
= 0, double max
= 100, double initial
= 0,
169 const wxString
& name
= wxT("wxSpinCtrl"))
176 bool ok
= wxTextCtrl::Create(parent
, id
, value
, pos
, size
, style
,
177 wxDefaultValidator
, name
);
184 // T GetValue() const
187 // T GetIncrement() const
188 virtual bool GetSnapToTicks() const { return m_snap_to_ticks
; }
189 // unsigned GetDigits() const - wxSpinCtrlDouble only
192 virtual void SetValue(const wxString
& text
) { wxTextCtrl::SetValue(text
); }
193 // void SetValue(T val)
194 // void SetRange(T minVal, T maxVal)
195 // void SetIncrement(T inc)
196 virtual void SetSnapToTicks(bool snap_to_ticks
)
197 { m_snap_to_ticks
= snap_to_ticks
; }
198 // void SetDigits(unsigned digits) - wxSpinCtrlDouble only
200 // Select text in the textctrl
201 //void SetSelection(long from, long to);
204 // generic double valued
205 double DoGetValue() const
208 if ( (wxSscanf(wxTextCtrl::GetValue(), wxT("%lf"), &n
) != 1) )
214 bool DoSetValue(double val
)
216 wxTextCtrl::SetValue(wxString::Format(m_format
.c_str(), val
));
219 void DoSetRange(double min_val
, double max_val
)
224 void DoSetIncrement(double inc
) { m_increment
= inc
; } // Note: unused
230 bool m_snap_to_ticks
;
234 #endif // wxUSE_SPINBTN/!wxUSE_SPINBTN
236 #if !defined(wxHAS_NATIVE_SPINCTRL)
238 //-----------------------------------------------------------------------------
240 //-----------------------------------------------------------------------------
242 class WXDLLIMPEXP_CORE wxSpinCtrl
: public wxSpinCtrlGenericBase
246 wxSpinCtrl(wxWindow
*parent
,
247 wxWindowID id
= wxID_ANY
,
248 const wxString
& value
= wxEmptyString
,
249 const wxPoint
& pos
= wxDefaultPosition
,
250 const wxSize
& size
= wxDefaultSize
,
251 long style
= wxSP_ARROW_KEYS
| wxALIGN_RIGHT
,
252 int min
= 0, int max
= 100, int initial
= 0,
253 const wxString
& name
= wxT("wxSpinCtrl"))
255 Create(parent
, id
, value
, pos
, size
, style
, min
, max
, initial
, name
);
258 bool Create(wxWindow
*parent
,
259 wxWindowID id
= wxID_ANY
,
260 const wxString
& value
= wxEmptyString
,
261 const wxPoint
& pos
= wxDefaultPosition
,
262 const wxSize
& size
= wxDefaultSize
,
263 long style
= wxSP_ARROW_KEYS
| wxALIGN_RIGHT
,
264 int min
= 0, int max
= 100, int initial
= 0,
265 const wxString
& name
= wxT("wxSpinCtrl"))
267 return wxSpinCtrlGenericBase::Create(parent
, id
, value
, pos
, size
,
268 style
, min
, max
, initial
, 1, name
);
272 int GetValue(wxSPINCTRL_GETVALUE_FIX
) const { return int(DoGetValue()); }
273 int GetMin() const { return int(m_min
); }
274 int GetMax() const { return int(m_max
); }
275 int GetIncrement() const { return int(m_increment
); }
278 void SetValue(const wxString
& value
)
279 { wxSpinCtrlGenericBase::SetValue(value
); }
280 void SetValue( int value
) { DoSetValue(value
); }
281 void SetRange( int minVal
, int maxVal
) { DoSetRange(minVal
, maxVal
); }
282 void SetIncrement(int inc
) { DoSetIncrement(inc
); }
285 virtual void DoSendEvent();
287 DECLARE_DYNAMIC_CLASS(wxSpinCtrl
)
290 #endif // wxHAS_NATIVE_SPINCTRL
292 //-----------------------------------------------------------------------------
294 //-----------------------------------------------------------------------------
296 class WXDLLIMPEXP_CORE wxSpinCtrlDouble
: public wxSpinCtrlGenericBase
299 wxSpinCtrlDouble() : m_digits(0) { }
300 wxSpinCtrlDouble(wxWindow
*parent
,
301 wxWindowID id
= wxID_ANY
,
302 const wxString
& value
= wxEmptyString
,
303 const wxPoint
& pos
= wxDefaultPosition
,
304 const wxSize
& size
= wxDefaultSize
,
305 long style
= wxSP_ARROW_KEYS
| wxALIGN_RIGHT
,
306 double min
= 0, double max
= 100, double initial
= 0,
308 const wxString
& name
= wxT("wxSpinCtrlDouble"))
311 Create(parent
, id
, value
, pos
, size
, style
,
312 min
, max
, initial
, inc
, name
);
315 bool Create(wxWindow
*parent
,
316 wxWindowID id
= wxID_ANY
,
317 const wxString
& value
= wxEmptyString
,
318 const wxPoint
& pos
= wxDefaultPosition
,
319 const wxSize
& size
= wxDefaultSize
,
320 long style
= wxSP_ARROW_KEYS
| wxALIGN_RIGHT
,
321 double min
= 0, double max
= 100, double initial
= 0,
323 const wxString
& name
= wxT("wxSpinCtrlDouble"))
325 return wxSpinCtrlGenericBase::Create(parent
, id
, value
, pos
, size
,
326 style
, min
, max
, initial
,
331 double GetValue(wxSPINCTRL_GETVALUE_FIX
) const { return DoGetValue(); }
332 double GetMin() const { return m_min
; }
333 double GetMax() const { return m_max
; }
334 double GetIncrement() const { return m_increment
; }
335 unsigned GetDigits() const { return m_digits
; }
338 void SetValue(const wxString
& value
)
339 { wxSpinCtrlGenericBase::SetValue(value
); }
340 void SetValue(double value
) { DoSetValue(value
); }
341 void SetRange(double minVal
, double maxVal
) { DoSetRange(minVal
, maxVal
); }
342 void SetIncrement(double inc
) { DoSetIncrement(inc
); }
343 void SetDigits(unsigned digits
);
346 virtual void DoSendEvent();
350 DECLARE_DYNAMIC_CLASS(wxSpinCtrlDouble
)
353 #endif // _WX_GENERIC_SPINCTRL_H_