1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/spinctlg.cpp
3 // Purpose: implements wxSpinCtrl as a composite control
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
28 #include "wx/textctrl.h"
31 #include "wx/spinctrl.h"
32 #include "wx/tooltip.h"
36 IMPLEMENT_DYNAMIC_CLASS(wxSpinDoubleEvent
, wxNotifyEvent
)
38 // There are port-specific versions for the wxSpinCtrl, so exclude the
39 // contents of this file in those cases
40 #if !defined(wxHAS_NATIVE_SPINCTRL) || !defined(wxHAS_NATIVE_SPINCTRLDOUBLE)
42 #include "wx/spinbutt.h"
46 // ----------------------------------------------------------------------------
48 // ----------------------------------------------------------------------------
50 // The margin between the text control and the spin: the value here is the same
51 // as the margin between the spin button and its "buddy" text control in wxMSW
52 // so the generic control looks similarly to the native one there, we might
53 // need to use different value for the other platforms (and maybe even
54 // determine it dynamically?).
55 static const wxCoord MARGIN
= 1;
57 #define SPINCTRLBUT_MAX 32000 // large to avoid wrap around trouble
59 // ----------------------------------------------------------------------------
60 // wxSpinCtrlTextGeneric: text control used by spin control
61 // ----------------------------------------------------------------------------
63 class wxSpinCtrlTextGeneric
: public wxTextCtrl
66 wxSpinCtrlTextGeneric(wxSpinCtrlGenericBase
*spin
, const wxString
& value
, long style
=0)
67 : wxTextCtrl(spin
->GetParent(), wxID_ANY
, value
, wxDefaultPosition
, wxDefaultSize
,
68 // This is tricky: we want to honour any alignment flags
69 // but not wxALIGN_CENTER_VERTICAL because it's the same
70 // as wxTE_PASSWORD and we definitely don't want to show
71 // asterisks in spin control.
72 style
& (wxALIGN_MASK
| wxTE_PROCESS_ENTER
) & ~wxTE_PASSWORD
)
76 // remove the default minsize, the spinctrl will have one instead
77 SetSizeHints(wxDefaultCoord
, wxDefaultCoord
);
80 virtual ~wxSpinCtrlTextGeneric()
82 // MSW sends extra kill focus event on destroy
84 m_spin
->m_textCtrl
= NULL
;
89 void OnChar( wxKeyEvent
&event
)
91 if ( !m_spin
->ProcessWindowEvent(event
) )
95 void OnTextEvent(wxCommandEvent
& event
)
97 wxCommandEvent
eventCopy(event
);
98 eventCopy
.SetEventObject(m_spin
);
99 eventCopy
.SetId(m_spin
->GetId());
100 m_spin
->ProcessWindowEvent(eventCopy
);
103 void OnKillFocus(wxFocusEvent
& event
)
106 m_spin
->ProcessWindowEvent(event
);
111 wxSpinCtrlGenericBase
*m_spin
;
114 DECLARE_EVENT_TABLE()
117 BEGIN_EVENT_TABLE(wxSpinCtrlTextGeneric
, wxTextCtrl
)
118 EVT_CHAR(wxSpinCtrlTextGeneric::OnChar
)
120 // Forward the text events to wxSpinCtrl itself adjusting them slightly in
122 EVT_TEXT(wxID_ANY
, wxSpinCtrlTextGeneric::OnTextEvent
)
124 // And we need to forward this one too as wxSpinCtrl is supposed to
125 // generate it if wxTE_PROCESS_ENTER is used with it (and if it isn't,
126 // we're never going to get EVT_TEXT_ENTER in the first place).
127 EVT_TEXT_ENTER(wxID_ANY
, wxSpinCtrlTextGeneric::OnTextEvent
)
129 EVT_KILL_FOCUS(wxSpinCtrlTextGeneric::OnKillFocus
)
132 // ----------------------------------------------------------------------------
133 // wxSpinCtrlButtonGeneric: spin button used by spin control
134 // ----------------------------------------------------------------------------
136 class wxSpinCtrlButtonGeneric
: public wxSpinButton
139 wxSpinCtrlButtonGeneric(wxSpinCtrlGenericBase
*spin
, int style
)
140 : wxSpinButton(spin
->GetParent(), wxID_ANY
, wxDefaultPosition
,
141 wxDefaultSize
, style
| wxSP_VERTICAL
)
145 SetRange(-SPINCTRLBUT_MAX
, SPINCTRLBUT_MAX
);
147 // remove the default minsize, the spinctrl will have one instead
148 SetSizeHints(wxDefaultCoord
, wxDefaultCoord
);
151 void OnSpinButton(wxSpinEvent
& event
)
154 m_spin
->OnSpinButton(event
);
157 wxSpinCtrlGenericBase
*m_spin
;
160 DECLARE_EVENT_TABLE()
163 BEGIN_EVENT_TABLE(wxSpinCtrlButtonGeneric
, wxSpinButton
)
164 EVT_SPIN_UP( wxID_ANY
, wxSpinCtrlButtonGeneric::OnSpinButton
)
165 EVT_SPIN_DOWN(wxID_ANY
, wxSpinCtrlButtonGeneric::OnSpinButton
)
168 // ============================================================================
169 // wxSpinCtrlGenericBase
170 // ============================================================================
172 // ----------------------------------------------------------------------------
173 // wxSpinCtrlGenericBase creation
174 // ----------------------------------------------------------------------------
176 void wxSpinCtrlGenericBase::Init()
182 m_snap_to_ticks
= false;
190 bool wxSpinCtrlGenericBase::Create(wxWindow
*parent
,
192 const wxString
& value
,
193 const wxPoint
& pos
, const wxSize
& size
,
195 double min
, double max
, double initial
,
197 const wxString
& name
)
199 // don't use borders for this control itself, it wouldn't look good with
200 // the text control borders (but we might want to use style border bits to
201 // select the text control style)
202 if ( !wxControl::Create(parent
, id
, wxDefaultPosition
, wxDefaultSize
,
203 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
,
204 wxDefaultValidator
, name
) )
212 m_increment
= increment
;
214 m_textCtrl
= new wxSpinCtrlTextGeneric(this, value
, style
);
215 m_spinButton
= new wxSpinCtrlButtonGeneric(this, style
);
217 m_textCtrl
->SetToolTip(GetToolTipText());
218 m_spinButton
->SetToolTip(GetToolTipText());
219 #endif // wxUSE_TOOLTIPS
221 m_spin_value
= m_spinButton
->GetValue();
223 // the string value overrides the numeric one (for backwards compatibility
224 // reasons and also because it is simpler to satisfy the string value which
225 // comes much sooner in the list of arguments and leave the initial
226 // parameter unspecified)
227 if ( !value
.empty() )
230 if ( DoTextToValue(value
, &d
) )
233 m_textCtrl
->SetValue(DoValueToText(m_value
));
237 SetInitialSize(size
);
240 // have to disable this window to avoid interfering it with message
241 // processing to the text and the button... but pretend it is enabled to
242 // make IsEnabled() return true
243 wxControl::Enable(false); // don't use non virtual Disable() here!
246 // we don't even need to show this window itself - and not doing it avoids
247 // that it overwrites the text control
248 wxControl::Show(false);
253 wxSpinCtrlGenericBase::~wxSpinCtrlGenericBase()
255 // delete the controls now, don't leave them alive even though they would
256 // still be eventually deleted by our parent - but it will be too late, the
257 // user code expects them to be gone now
261 // null this since MSW sends KILL_FOCUS on deletion, see ~wxSpinCtrlTextGeneric
262 wxDynamicCast(m_textCtrl
, wxSpinCtrlTextGeneric
)->m_spin
= NULL
;
264 wxSpinCtrlTextGeneric
*text
= (wxSpinCtrlTextGeneric
*)m_textCtrl
;
269 wxDELETE(m_spinButton
);
272 // ----------------------------------------------------------------------------
274 // ----------------------------------------------------------------------------
276 wxSize
wxSpinCtrlGenericBase::DoGetBestSize() const
278 wxSize sizeBtn
= m_spinButton
->GetBestSize(),
279 sizeText
= m_textCtrl
->GetBestSize();
281 return wxSize(sizeBtn
.x
+ sizeText
.x
+ MARGIN
, sizeText
.y
);
284 void wxSpinCtrlGenericBase::DoMoveWindow(int x
, int y
, int width
, int height
)
286 wxControl::DoMoveWindow(x
, y
, width
, height
);
288 // position the subcontrols inside the client area
289 wxSize sizeBtn
= m_spinButton
->GetSize();
291 wxCoord wText
= width
- sizeBtn
.x
- MARGIN
;
292 m_textCtrl
->SetSize(x
, y
, wText
, height
);
293 m_spinButton
->SetSize(x
+ wText
+ MARGIN
, y
, wxDefaultCoord
, height
);
296 // ----------------------------------------------------------------------------
297 // operations forwarded to the subcontrols
298 // ----------------------------------------------------------------------------
300 void wxSpinCtrlGenericBase::SetFocus()
303 m_textCtrl
->SetFocus();
308 void wxSpinCtrlGenericBase::DoEnable(bool enable
)
310 // We never enable this control itself, it must stay disabled to avoid
311 // interfering with the siblings event handling (see e.g. #12045 for the
312 // kind of problems which arise otherwise).
314 wxSpinCtrlBase::DoEnable(enable
);
319 bool wxSpinCtrlGenericBase::Enable(bool enable
)
321 if ( !wxSpinCtrlBase::Enable(enable
) )
324 m_spinButton
->Enable(enable
);
325 m_textCtrl
->Enable(enable
);
330 bool wxSpinCtrlGenericBase::Show(bool show
)
332 if ( !wxControl::Show(show
) )
335 // under GTK Show() is called the first time before we are fully
339 m_spinButton
->Show(show
);
340 m_textCtrl
->Show(show
);
347 void wxSpinCtrlGenericBase::DoSetToolTip(wxToolTip
*tip
)
349 // Notice that we must check for the subcontrols not being NULL (as they
350 // could be if we were created with the default ctor and this is called
351 // before Create() for some reason) and that we can't call SetToolTip(tip)
352 // because this would take ownership of the wxToolTip object (twice).
356 m_textCtrl
->SetToolTip(tip
->GetTip());
358 m_textCtrl
->SetToolTip(NULL
);
364 m_spinButton
->SetToolTip(tip
->GetTip());
366 m_spinButton
->SetToolTip(NULL
);
369 wxWindowBase::DoSetToolTip(tip
);
371 #endif // wxUSE_TOOLTIPS
373 // ----------------------------------------------------------------------------
374 // Handle sub controls events
375 // ----------------------------------------------------------------------------
377 BEGIN_EVENT_TABLE(wxSpinCtrlGenericBase
, wxSpinCtrlBase
)
378 EVT_CHAR(wxSpinCtrlGenericBase::OnTextChar
)
379 EVT_KILL_FOCUS(wxSpinCtrlGenericBase::OnTextLostFocus
)
382 void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent
& event
)
386 // Sync the textctrl since the user expects that the button will modify
387 // what they see in the textctrl.
390 int spin_value
= event
.GetPosition();
391 double step
= (event
.GetEventType() == wxEVT_SCROLL_LINEUP
) ? 1 : -1;
393 // Use the spinbutton's acceleration, if any, but not if wrapping around
394 if (((spin_value
>= 0) && (m_spin_value
>= 0)) || ((spin_value
<= 0) && (m_spin_value
<= 0)))
395 step
*= abs(spin_value
- m_spin_value
);
397 double value
= AdjustToFitInRange(m_value
+ step
*m_increment
);
399 // Ignore the edges when it wraps since the up/down event may be opposite
400 // They are in GTK and Mac
401 if (abs(spin_value
- m_spin_value
) > SPINCTRLBUT_MAX
)
403 m_spin_value
= spin_value
;
407 m_spin_value
= spin_value
;
409 if ( DoSetValue(value
) )
413 void wxSpinCtrlGenericBase::OnTextLostFocus(wxFocusEvent
& event
)
421 void wxSpinCtrlGenericBase::OnTextChar(wxKeyEvent
& event
)
423 if ( !HasFlag(wxSP_ARROW_KEYS
) )
429 double value
= m_value
;
430 switch ( event
.GetKeyCode() )
433 value
+= m_increment
;
437 value
-= m_increment
;
441 value
+= m_increment
* 10.0;
445 value
-= m_increment
* 10.0;
453 value
= AdjustToFitInRange(value
);
457 if ( DoSetValue(value
) )
461 // ----------------------------------------------------------------------------
462 // Textctrl functions
463 // ----------------------------------------------------------------------------
465 bool wxSpinCtrlGenericBase::SyncSpinToText()
467 if ( !m_textCtrl
|| !m_textCtrl
->IsModified() )
471 if ( DoTextToValue(m_textCtrl
->GetValue(), &textValue
) )
473 if (textValue
> m_max
)
475 else if (textValue
< m_min
)
478 else // text contents is not a valid number at all
480 // replace its contents with the last valid value
484 // we must always set the value here, even if it's equal to m_value, as
485 // otherwise we could be left with an out of range value when leaving the
486 // text control and the current value is already m_max for example
487 return DoSetValue(textValue
);
490 // ----------------------------------------------------------------------------
491 // changing value and range
492 // ----------------------------------------------------------------------------
494 void wxSpinCtrlGenericBase::SetValue(const wxString
& text
)
496 wxCHECK_RET( m_textCtrl
, wxT("invalid call to wxSpinCtrl::SetValue") );
499 if ( DoTextToValue(text
, &val
) && InRange(val
) )
503 else // not a number at all or out of range
505 m_textCtrl
->SetValue(text
);
506 m_textCtrl
->SetSelection(0, -1);
507 m_textCtrl
->SetInsertionPointEnd();
511 bool wxSpinCtrlGenericBase::DoSetValue(double val
)
513 wxCHECK_MSG( m_textCtrl
, false, wxT("invalid call to wxSpinCtrl::SetValue") );
518 if ( m_snap_to_ticks
&& (m_increment
!= 0) )
520 double snap_value
= val
/ m_increment
;
522 if (wxFinite(snap_value
)) // FIXME what to do about a failure?
524 if ((snap_value
- floor(snap_value
)) < (ceil(snap_value
) - snap_value
))
525 val
= floor(snap_value
) * m_increment
;
527 val
= ceil(snap_value
) * m_increment
;
531 wxString
str(DoValueToText(val
));
533 if ((val
!= m_value
) || (str
!= m_textCtrl
->GetValue()))
535 if ( !DoTextToValue(str
, &m_value
) ) // wysiwyg for textctrl
537 m_textCtrl
->SetValue( str
);
538 m_textCtrl
->SetInsertionPointEnd();
539 m_textCtrl
->DiscardEdits();
546 double wxSpinCtrlGenericBase::AdjustToFitInRange(double value
) const
549 value
= HasFlag(wxSP_WRAP
) ? m_max
: m_min
;
551 value
= HasFlag(wxSP_WRAP
) ? m_min
: m_max
;
556 void wxSpinCtrlGenericBase::DoSetRange(double min
, double max
)
562 void wxSpinCtrlGenericBase::DoSetIncrement(double inc
)
567 void wxSpinCtrlGenericBase::SetSnapToTicks(bool snap_to_ticks
)
569 m_snap_to_ticks
= snap_to_ticks
;
573 void wxSpinCtrlGenericBase::SetSelection(long from
, long to
)
575 wxCHECK_RET( m_textCtrl
, wxT("invalid call to wxSpinCtrl::SetSelection") );
577 m_textCtrl
->SetSelection(from
, to
);
580 #ifndef wxHAS_NATIVE_SPINCTRL
582 //-----------------------------------------------------------------------------
584 //-----------------------------------------------------------------------------
586 bool wxSpinCtrl::SetBase(int base
)
588 // Currently we only support base 10 and 16. We could add support for base
589 // 8 quite easily but wxMSW doesn't support it natively so don't bother.
590 if ( base
!= 10 && base
!= 16 )
593 if ( base
== m_base
)
596 // Update the current control contents to show in the new base: be careful
597 // to call DoTextToValue() before changing the base...
599 const bool hasValidVal
= DoTextToValue(m_textCtrl
->GetValue(), &val
);
603 // ... but DoValueToText() after doing it.
605 m_textCtrl
->SetValue(DoValueToText(val
));
610 void wxSpinCtrl::DoSendEvent()
612 wxSpinEvent
event( wxEVT_COMMAND_SPINCTRL_UPDATED
, GetId());
613 event
.SetEventObject( this );
614 event
.SetPosition((int)(m_value
+ 0.5)); // FIXME should be SetValue
615 event
.SetString(m_textCtrl
->GetValue());
616 GetEventHandler()->ProcessEvent( event
);
619 bool wxSpinCtrl::DoTextToValue(const wxString
& text
, double *val
)
622 if ( !text
.ToLong(&lval
, GetBase()) )
625 *val
= static_cast<double>(lval
);
630 wxString
wxSpinCtrl::DoValueToText(double val
)
635 return wxPrivate::wxSpinCtrlFormatAsHex(static_cast<long>(val
),
639 wxFAIL_MSG( wxS("Unsupported spin control base") );
643 return wxString::Format("%ld", static_cast<long>(val
));
647 #endif // !wxHAS_NATIVE_SPINCTRL
649 //-----------------------------------------------------------------------------
651 //-----------------------------------------------------------------------------
653 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrlDouble
, wxSpinCtrlGenericBase
)
655 void wxSpinCtrlDouble::DoSendEvent()
657 wxSpinDoubleEvent
event( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED
, GetId());
658 event
.SetEventObject( this );
659 event
.SetValue(m_value
);
660 event
.SetString(m_textCtrl
->GetValue());
661 GetEventHandler()->ProcessEvent( event
);
664 bool wxSpinCtrlDouble::DoTextToValue(const wxString
& text
, double *val
)
666 return text
.ToDouble(val
);
669 wxString
wxSpinCtrlDouble::DoValueToText(double val
)
671 return wxString::Format(m_format
, val
);
674 void wxSpinCtrlDouble::SetDigits(unsigned digits
)
676 wxCHECK_RET( digits
<= 20, "too many digits for wxSpinCtrlDouble" );
678 if ( digits
== m_digits
)
683 m_format
.Printf(wxT("%%0.%ulf"), digits
);
688 #endif // wxUSE_SPINBTN
690 #endif // !wxPort-with-native-spinctrl
692 #endif // wxUSE_SPINCTRL