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 wxWindowList
wxSpinCtrlGenericBase::GetCompositeWindowParts() const
275 parts
.push_back(m_textCtrl
);
276 parts
.push_back(m_spinButton
);
280 // ----------------------------------------------------------------------------
282 // ----------------------------------------------------------------------------
284 wxSize
wxSpinCtrlGenericBase::DoGetBestSize() const
286 return DoGetSizeFromTextSize(m_textCtrl
->GetBestSize().x
, -1);
289 wxSize
wxSpinCtrlGenericBase::DoGetSizeFromTextSize(int xlen
, int ylen
) const
291 wxSize sizeBtn
= m_spinButton
->GetBestSize();
292 wxSize
totalS( m_textCtrl
->GetBestSize() );
294 wxSize
tsize(xlen
+ sizeBtn
.x
+ MARGIN
, totalS
.y
);
295 #if defined(__WXMSW__)
296 tsize
.IncBy(0.4 * totalS
.y
+ 4, 0);
297 #elif defined(__WXGTK__)
298 tsize
.IncBy(totalS
.y
+ 10, 0);
301 // Check if the user requested a non-standard height.
303 tsize
.IncBy(0, ylen
- GetCharHeight());
308 void wxSpinCtrlGenericBase::DoMoveWindow(int x
, int y
, int width
, int height
)
310 wxControl::DoMoveWindow(x
, y
, width
, height
);
312 // position the subcontrols inside the client area
313 wxSize sizeBtn
= m_spinButton
->GetSize();
315 wxCoord wText
= width
- sizeBtn
.x
- MARGIN
;
316 m_textCtrl
->SetSize(x
, y
, wText
, height
);
317 m_spinButton
->SetSize(x
+ wText
+ MARGIN
, y
, wxDefaultCoord
, height
);
320 // ----------------------------------------------------------------------------
321 // operations forwarded to the subcontrols
322 // ----------------------------------------------------------------------------
324 void wxSpinCtrlGenericBase::SetFocus()
327 m_textCtrl
->SetFocus();
332 void wxSpinCtrlGenericBase::DoEnable(bool enable
)
334 // We never enable this control itself, it must stay disabled to avoid
335 // interfering with the siblings event handling (see e.g. #12045 for the
336 // kind of problems which arise otherwise).
338 wxSpinCtrlBase::DoEnable(enable
);
343 bool wxSpinCtrlGenericBase::Enable(bool enable
)
345 if ( !wxSpinCtrlBase::Enable(enable
) )
348 m_spinButton
->Enable(enable
);
349 m_textCtrl
->Enable(enable
);
354 bool wxSpinCtrlGenericBase::Show(bool show
)
356 if ( !wxControl::Show(show
) )
359 // under GTK Show() is called the first time before we are fully
363 m_spinButton
->Show(show
);
364 m_textCtrl
->Show(show
);
371 void wxSpinCtrlGenericBase::DoSetToolTip(wxToolTip
*tip
)
373 // Notice that we must check for the subcontrols not being NULL (as they
374 // could be if we were created with the default ctor and this is called
375 // before Create() for some reason) and that we can't call SetToolTip(tip)
376 // because this would take ownership of the wxToolTip object (twice).
380 m_textCtrl
->SetToolTip(tip
->GetTip());
382 m_textCtrl
->SetToolTip(NULL
);
388 m_spinButton
->SetToolTip(tip
->GetTip());
390 m_spinButton
->SetToolTip(NULL
);
393 wxWindowBase::DoSetToolTip(tip
);
395 #endif // wxUSE_TOOLTIPS
397 // ----------------------------------------------------------------------------
398 // Handle sub controls events
399 // ----------------------------------------------------------------------------
401 BEGIN_EVENT_TABLE(wxSpinCtrlGenericBase
, wxSpinCtrlBase
)
402 EVT_CHAR(wxSpinCtrlGenericBase::OnTextChar
)
403 EVT_KILL_FOCUS(wxSpinCtrlGenericBase::OnTextLostFocus
)
406 void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent
& event
)
410 // Sync the textctrl since the user expects that the button will modify
411 // what they see in the textctrl.
414 int spin_value
= event
.GetPosition();
415 double step
= (event
.GetEventType() == wxEVT_SCROLL_LINEUP
) ? 1 : -1;
417 // Use the spinbutton's acceleration, if any, but not if wrapping around
418 if (((spin_value
>= 0) && (m_spin_value
>= 0)) || ((spin_value
<= 0) && (m_spin_value
<= 0)))
419 step
*= abs(spin_value
- m_spin_value
);
421 double value
= AdjustToFitInRange(m_value
+ step
*m_increment
);
423 // Ignore the edges when it wraps since the up/down event may be opposite
424 // They are in GTK and Mac
425 if (abs(spin_value
- m_spin_value
) > SPINCTRLBUT_MAX
)
427 m_spin_value
= spin_value
;
431 m_spin_value
= spin_value
;
433 if ( DoSetValue(value
) )
437 void wxSpinCtrlGenericBase::OnTextLostFocus(wxFocusEvent
& event
)
445 void wxSpinCtrlGenericBase::OnTextChar(wxKeyEvent
& event
)
447 if ( !HasFlag(wxSP_ARROW_KEYS
) )
453 double value
= m_value
;
454 switch ( event
.GetKeyCode() )
457 value
+= m_increment
;
461 value
-= m_increment
;
465 value
+= m_increment
* 10.0;
469 value
-= m_increment
* 10.0;
477 value
= AdjustToFitInRange(value
);
481 if ( DoSetValue(value
) )
485 // ----------------------------------------------------------------------------
486 // Textctrl functions
487 // ----------------------------------------------------------------------------
489 bool wxSpinCtrlGenericBase::SyncSpinToText()
491 if ( !m_textCtrl
|| !m_textCtrl
->IsModified() )
495 if ( DoTextToValue(m_textCtrl
->GetValue(), &textValue
) )
497 if (textValue
> m_max
)
499 else if (textValue
< m_min
)
502 else // text contents is not a valid number at all
504 // replace its contents with the last valid value
508 // we must always set the value here, even if it's equal to m_value, as
509 // otherwise we could be left with an out of range value when leaving the
510 // text control and the current value is already m_max for example
511 return DoSetValue(textValue
);
514 // ----------------------------------------------------------------------------
515 // changing value and range
516 // ----------------------------------------------------------------------------
518 void wxSpinCtrlGenericBase::SetValue(const wxString
& text
)
520 wxCHECK_RET( m_textCtrl
, wxT("invalid call to wxSpinCtrl::SetValue") );
523 if ( DoTextToValue(text
, &val
) && InRange(val
) )
527 else // not a number at all or out of range
529 m_textCtrl
->SetValue(text
);
530 m_textCtrl
->SelectAll();
534 bool wxSpinCtrlGenericBase::DoSetValue(double val
)
536 wxCHECK_MSG( m_textCtrl
, false, wxT("invalid call to wxSpinCtrl::SetValue") );
541 if ( m_snap_to_ticks
&& (m_increment
!= 0) )
543 double snap_value
= val
/ m_increment
;
545 if (wxFinite(snap_value
)) // FIXME what to do about a failure?
547 if ((snap_value
- floor(snap_value
)) < (ceil(snap_value
) - snap_value
))
548 val
= floor(snap_value
) * m_increment
;
550 val
= ceil(snap_value
) * m_increment
;
554 wxString
str(DoValueToText(val
));
556 if ((val
!= m_value
) || (str
!= m_textCtrl
->GetValue()))
558 if ( !DoTextToValue(str
, &m_value
) ) // wysiwyg for textctrl
560 m_textCtrl
->SetValue( str
);
561 m_textCtrl
->SelectAll();
562 m_textCtrl
->DiscardEdits();
569 double wxSpinCtrlGenericBase::AdjustToFitInRange(double value
) const
572 value
= HasFlag(wxSP_WRAP
) ? m_max
: m_min
;
574 value
= HasFlag(wxSP_WRAP
) ? m_min
: m_max
;
579 void wxSpinCtrlGenericBase::DoSetRange(double min
, double max
)
585 void wxSpinCtrlGenericBase::DoSetIncrement(double inc
)
590 void wxSpinCtrlGenericBase::SetSnapToTicks(bool snap_to_ticks
)
592 m_snap_to_ticks
= snap_to_ticks
;
596 void wxSpinCtrlGenericBase::SetSelection(long from
, long to
)
598 wxCHECK_RET( m_textCtrl
, wxT("invalid call to wxSpinCtrl::SetSelection") );
600 m_textCtrl
->SetSelection(from
, to
);
603 #ifndef wxHAS_NATIVE_SPINCTRL
605 //-----------------------------------------------------------------------------
607 //-----------------------------------------------------------------------------
609 bool wxSpinCtrl::SetBase(int base
)
611 // Currently we only support base 10 and 16. We could add support for base
612 // 8 quite easily but wxMSW doesn't support it natively so don't bother.
613 if ( base
!= 10 && base
!= 16 )
616 if ( base
== m_base
)
619 // Update the current control contents to show in the new base: be careful
620 // to call DoTextToValue() before changing the base...
622 const bool hasValidVal
= DoTextToValue(m_textCtrl
->GetValue(), &val
);
626 // ... but DoValueToText() after doing it.
628 m_textCtrl
->SetValue(DoValueToText(val
));
633 void wxSpinCtrl::DoSendEvent()
635 wxSpinEvent
event( wxEVT_COMMAND_SPINCTRL_UPDATED
, GetId());
636 event
.SetEventObject( this );
637 event
.SetPosition((int)(m_value
+ 0.5)); // FIXME should be SetValue
638 event
.SetString(m_textCtrl
->GetValue());
639 GetEventHandler()->ProcessEvent( event
);
642 bool wxSpinCtrl::DoTextToValue(const wxString
& text
, double *val
)
645 if ( !text
.ToLong(&lval
, GetBase()) )
648 *val
= static_cast<double>(lval
);
653 wxString
wxSpinCtrl::DoValueToText(double val
)
658 return wxPrivate::wxSpinCtrlFormatAsHex(static_cast<long>(val
),
662 wxFAIL_MSG( wxS("Unsupported spin control base") );
666 return wxString::Format("%ld", static_cast<long>(val
));
670 #endif // !wxHAS_NATIVE_SPINCTRL
672 //-----------------------------------------------------------------------------
674 //-----------------------------------------------------------------------------
676 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrlDouble
, wxSpinCtrlGenericBase
)
678 void wxSpinCtrlDouble::DoSendEvent()
680 wxSpinDoubleEvent
event( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED
, GetId());
681 event
.SetEventObject( this );
682 event
.SetValue(m_value
);
683 event
.SetString(m_textCtrl
->GetValue());
684 GetEventHandler()->ProcessEvent( event
);
687 bool wxSpinCtrlDouble::DoTextToValue(const wxString
& text
, double *val
)
689 return text
.ToDouble(val
);
692 wxString
wxSpinCtrlDouble::DoValueToText(double val
)
694 return wxString::Format(m_format
, val
);
697 void wxSpinCtrlDouble::SetDigits(unsigned digits
)
699 wxCHECK_RET( digits
<= 20, "too many digits for wxSpinCtrlDouble" );
701 if ( digits
== m_digits
)
706 m_format
.Printf(wxT("%%0.%ulf"), digits
);
711 #endif // wxUSE_SPINBTN
713 #endif // !wxPort-with-native-spinctrl
715 #endif // wxUSE_SPINCTRL