]>
git.saurik.com Git - wxWidgets.git/blob - src/generic/spinctlg.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/spinctlg.cpp
3 // Purpose: implements wxSpinCtrl as a composite control
4 // Author: Vadim Zeitlin
7 // Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
8 // Licence: wxWindows licence
9 ///////////////////////////////////////////////////////////////////////////////
11 // ============================================================================
13 // ============================================================================
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
19 // For compilers that support precompilation, includes "wx.h".
20 #include "wx/wxprec.h"
27 #include "wx/textctrl.h"
30 #include "wx/spinctrl.h"
31 #include "wx/tooltip.h"
35 IMPLEMENT_DYNAMIC_CLASS(wxSpinDoubleEvent
, wxNotifyEvent
)
37 // There are port-specific versions for the wxSpinCtrl, so exclude the
38 // contents of this file in those cases
39 #if !defined(wxHAS_NATIVE_SPINCTRL) || !defined(wxHAS_NATIVE_SPINCTRLDOUBLE)
41 #include "wx/spinbutt.h"
45 // ----------------------------------------------------------------------------
47 // ----------------------------------------------------------------------------
49 // The margin between the text control and the spin: the value here is the same
50 // as the margin between the spin button and its "buddy" text control in wxMSW
51 // so the generic control looks similarly to the native one there, we might
52 // need to use different value for the other platforms (and maybe even
53 // determine it dynamically?).
54 static const wxCoord MARGIN
= 1;
56 #define SPINCTRLBUT_MAX 32000 // large to avoid wrap around trouble
58 // ----------------------------------------------------------------------------
59 // wxSpinCtrlTextGeneric: text control used by spin control
60 // ----------------------------------------------------------------------------
62 class wxSpinCtrlTextGeneric
: public wxTextCtrl
65 wxSpinCtrlTextGeneric(wxSpinCtrlGenericBase
*spin
, const wxString
& value
, long style
=0)
66 : wxTextCtrl(spin
, wxID_ANY
, value
, wxDefaultPosition
, wxDefaultSize
,
67 // This is tricky: we want to honour any alignment flags
68 // but not wxALIGN_CENTER_VERTICAL because it's the same
69 // as wxTE_PASSWORD and we definitely don't want to show
70 // asterisks in spin control.
71 style
& (wxALIGN_MASK
| wxTE_PROCESS_ENTER
) & ~wxTE_PASSWORD
)
75 // remove the default minsize, the spinctrl will have one instead
76 SetSizeHints(wxDefaultCoord
, wxDefaultCoord
);
79 virtual ~wxSpinCtrlTextGeneric()
81 // MSW sends extra kill focus event on destroy
83 m_spin
->m_textCtrl
= NULL
;
88 void OnChar( wxKeyEvent
&event
)
90 if ( !m_spin
->ProcessWindowEvent(event
) )
94 void OnTextEvent(wxCommandEvent
& event
)
96 wxCommandEvent
eventCopy(event
);
97 eventCopy
.SetEventObject(m_spin
);
98 eventCopy
.SetId(m_spin
->GetId());
99 m_spin
->ProcessWindowEvent(eventCopy
);
102 void OnKillFocus(wxFocusEvent
& event
)
105 m_spin
->ProcessWindowEvent(event
);
110 wxSpinCtrlGenericBase
*m_spin
;
113 DECLARE_EVENT_TABLE()
116 BEGIN_EVENT_TABLE(wxSpinCtrlTextGeneric
, wxTextCtrl
)
117 EVT_CHAR(wxSpinCtrlTextGeneric::OnChar
)
119 // Forward the text events to wxSpinCtrl itself adjusting them slightly in
121 EVT_TEXT(wxID_ANY
, wxSpinCtrlTextGeneric::OnTextEvent
)
123 // And we need to forward this one too as wxSpinCtrl is supposed to
124 // generate it if wxTE_PROCESS_ENTER is used with it (and if it isn't,
125 // we're never going to get EVT_TEXT_ENTER in the first place).
126 EVT_TEXT_ENTER(wxID_ANY
, wxSpinCtrlTextGeneric::OnTextEvent
)
128 EVT_KILL_FOCUS(wxSpinCtrlTextGeneric::OnKillFocus
)
131 // ----------------------------------------------------------------------------
132 // wxSpinCtrlButtonGeneric: spin button used by spin control
133 // ----------------------------------------------------------------------------
135 class wxSpinCtrlButtonGeneric
: public wxSpinButton
138 wxSpinCtrlButtonGeneric(wxSpinCtrlGenericBase
*spin
, int style
)
139 : wxSpinButton(spin
, wxID_ANY
, wxDefaultPosition
,
140 wxDefaultSize
, style
| wxSP_VERTICAL
)
144 SetRange(-SPINCTRLBUT_MAX
, SPINCTRLBUT_MAX
);
146 // remove the default minsize, the spinctrl will have one instead
147 SetSizeHints(wxDefaultCoord
, wxDefaultCoord
);
150 void OnSpinButton(wxSpinEvent
& event
)
153 m_spin
->OnSpinButton(event
);
156 wxSpinCtrlGenericBase
*m_spin
;
159 DECLARE_EVENT_TABLE()
162 BEGIN_EVENT_TABLE(wxSpinCtrlButtonGeneric
, wxSpinButton
)
163 EVT_SPIN_UP( wxID_ANY
, wxSpinCtrlButtonGeneric::OnSpinButton
)
164 EVT_SPIN_DOWN(wxID_ANY
, wxSpinCtrlButtonGeneric::OnSpinButton
)
167 // ============================================================================
168 // wxSpinCtrlGenericBase
169 // ============================================================================
171 // ----------------------------------------------------------------------------
172 // wxSpinCtrlGenericBase creation
173 // ----------------------------------------------------------------------------
175 void wxSpinCtrlGenericBase::Init()
181 m_snap_to_ticks
= false;
189 bool wxSpinCtrlGenericBase::Create(wxWindow
*parent
,
191 const wxString
& value
,
192 const wxPoint
& pos
, const wxSize
& size
,
194 double min
, double max
, double initial
,
196 const wxString
& name
)
198 // don't use borders for this control itself, it wouldn't look good with
199 // the text control borders (but we might want to use style border bits to
200 // select the text control style)
201 if ( !wxControl::Create(parent
, id
, wxDefaultPosition
, wxDefaultSize
,
202 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
,
203 wxDefaultValidator
, name
) )
211 m_increment
= increment
;
213 m_textCtrl
= new wxSpinCtrlTextGeneric(this, value
, style
);
214 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
->ChangeValue(DoValueToText(m_value
));
237 SetInitialSize(size
);
243 wxSpinCtrlGenericBase::~wxSpinCtrlGenericBase()
245 // delete the controls now, don't leave them alive even though they would
246 // still be eventually deleted by our parent - but it will be too late, the
247 // user code expects them to be gone now
251 // null this since MSW sends KILL_FOCUS on deletion, see ~wxSpinCtrlTextGeneric
252 wxDynamicCast(m_textCtrl
, wxSpinCtrlTextGeneric
)->m_spin
= NULL
;
254 wxSpinCtrlTextGeneric
*text
= (wxSpinCtrlTextGeneric
*)m_textCtrl
;
259 wxDELETE(m_spinButton
);
262 wxWindowList
wxSpinCtrlGenericBase::GetCompositeWindowParts() const
265 parts
.push_back(m_textCtrl
);
266 parts
.push_back(m_spinButton
);
270 // ----------------------------------------------------------------------------
272 // ----------------------------------------------------------------------------
274 wxSize
wxSpinCtrlGenericBase::DoGetBestSize() const
276 return DoGetSizeFromTextSize(m_textCtrl
->GetBestSize().x
, -1);
279 wxSize
wxSpinCtrlGenericBase::DoGetSizeFromTextSize(int xlen
, int ylen
) const
281 wxSize sizeBtn
= m_spinButton
->GetBestSize();
282 wxSize
totalS( m_textCtrl
->GetBestSize() );
284 wxSize
tsize(xlen
+ sizeBtn
.x
+ MARGIN
, totalS
.y
);
285 #if defined(__WXMSW__)
286 tsize
.IncBy(4*totalS
.y
/10 + 4, 0);
287 #elif defined(__WXGTK__)
288 tsize
.IncBy(totalS
.y
+ 10, 0);
291 // Check if the user requested a non-standard height.
293 tsize
.IncBy(0, ylen
- GetCharHeight());
298 void wxSpinCtrlGenericBase::DoMoveWindow(int x
, int y
, int width
, int height
)
300 wxControl::DoMoveWindow(x
, y
, width
, height
);
302 // position the subcontrols inside the client area
303 wxSize sizeBtn
= m_spinButton
->GetSize();
305 wxCoord wText
= width
- sizeBtn
.x
- MARGIN
;
306 m_textCtrl
->SetSize(0, 0, wText
, height
);
307 m_spinButton
->SetSize(0 + wText
+ MARGIN
, 0, wxDefaultCoord
, height
);
310 // ----------------------------------------------------------------------------
311 // operations forwarded to the subcontrols
312 // ----------------------------------------------------------------------------
314 void wxSpinCtrlGenericBase::SetFocus()
317 m_textCtrl
->SetFocus();
322 void wxSpinCtrlGenericBase::DoEnable(bool enable
)
324 wxSpinCtrlBase::DoEnable(enable
);
329 bool wxSpinCtrlGenericBase::Enable(bool enable
)
331 if ( !wxSpinCtrlBase::Enable(enable
) )
334 m_spinButton
->Enable(enable
);
335 m_textCtrl
->Enable(enable
);
340 bool wxSpinCtrlGenericBase::Show(bool show
)
342 if ( !wxControl::Show(show
) )
345 // under GTK Show() is called the first time before we are fully
349 m_spinButton
->Show(show
);
350 m_textCtrl
->Show(show
);
357 void wxSpinCtrlGenericBase::DoSetToolTip(wxToolTip
*tip
)
359 // Notice that we must check for the subcontrols not being NULL (as they
360 // could be if we were created with the default ctor and this is called
361 // before Create() for some reason) and that we can't call SetToolTip(tip)
362 // because this would take ownership of the wxToolTip object (twice).
366 m_textCtrl
->SetToolTip(tip
->GetTip());
368 m_textCtrl
->SetToolTip(NULL
);
374 m_spinButton
->SetToolTip(tip
->GetTip());
376 m_spinButton
->SetToolTip(NULL
);
379 wxWindowBase::DoSetToolTip(tip
);
381 #endif // wxUSE_TOOLTIPS
383 bool wxSpinCtrlGenericBase::SetBackgroundColour(const wxColour
& colour
)
385 // We need to provide this otherwise the entire composite window
386 // background and therefore the between component spaces
389 return m_textCtrl
->SetBackgroundColour(colour
);
394 // ----------------------------------------------------------------------------
395 // Handle sub controls events
396 // ----------------------------------------------------------------------------
398 BEGIN_EVENT_TABLE(wxSpinCtrlGenericBase
, wxSpinCtrlBase
)
399 EVT_CHAR(wxSpinCtrlGenericBase::OnTextChar
)
400 EVT_KILL_FOCUS(wxSpinCtrlGenericBase::OnTextLostFocus
)
403 void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent
& event
)
407 // Sync the textctrl since the user expects that the button will modify
408 // what they see in the textctrl.
409 SyncSpinToText(SendEvent_None
);
411 int spin_value
= event
.GetPosition();
412 double step
= (event
.GetEventType() == wxEVT_SCROLL_LINEUP
) ? 1 : -1;
414 // Use the spinbutton's acceleration, if any, but not if wrapping around
415 if (((spin_value
>= 0) && (m_spin_value
>= 0)) || ((spin_value
<= 0) && (m_spin_value
<= 0)))
416 step
*= abs(spin_value
- m_spin_value
);
418 double value
= AdjustToFitInRange(m_value
+ step
*m_increment
);
420 // Ignore the edges when it wraps since the up/down event may be opposite
421 // They are in GTK and Mac
422 if (abs(spin_value
- m_spin_value
) > SPINCTRLBUT_MAX
)
424 m_spin_value
= spin_value
;
428 m_spin_value
= spin_value
;
430 // Notify about the change in wxTextCtrl too.
431 if ( DoSetValue(value
, SendEvent_Text
) )
435 void wxSpinCtrlGenericBase::OnTextLostFocus(wxFocusEvent
& event
)
437 SyncSpinToText(SendEvent_Text
);
443 void wxSpinCtrlGenericBase::OnTextChar(wxKeyEvent
& event
)
445 if ( !HasFlag(wxSP_ARROW_KEYS
) )
451 double value
= m_value
;
452 switch ( event
.GetKeyCode() )
455 value
+= m_increment
;
459 value
-= m_increment
;
463 value
+= m_increment
* 10.0;
467 value
-= m_increment
* 10.0;
475 value
= AdjustToFitInRange(value
);
477 SyncSpinToText(SendEvent_None
);
479 // No need to send event, it was already generated by wxTextCtrl itself.
480 if ( DoSetValue(value
, SendEvent_None
) )
484 // ----------------------------------------------------------------------------
485 // Textctrl functions
486 // ----------------------------------------------------------------------------
488 bool wxSpinCtrlGenericBase::SyncSpinToText(SendEvent sendEvent
)
490 if ( !m_textCtrl
|| !m_textCtrl
->IsModified() )
494 if ( DoTextToValue(m_textCtrl
->GetValue(), &textValue
) )
496 if (textValue
> m_max
)
498 else if (textValue
< m_min
)
501 else // text contents is not a valid number at all
503 // replace its contents with the last valid value
507 // we must always set the value here, even if it's equal to m_value, as
508 // otherwise we could be left with an out of range value when leaving the
509 // text control and the current value is already m_max for example
510 return DoSetValue(textValue
, sendEvent
);
513 // ----------------------------------------------------------------------------
514 // changing value and range
515 // ----------------------------------------------------------------------------
517 void wxSpinCtrlGenericBase::SetValue(const wxString
& text
)
519 wxCHECK_RET( m_textCtrl
, wxT("invalid call to wxSpinCtrl::SetValue") );
522 if ( DoTextToValue(text
, &val
) && InRange(val
) )
524 DoSetValue(val
, SendEvent_None
);
526 else // not a number at all or out of range
528 m_textCtrl
->ChangeValue(text
);
529 m_textCtrl
->SelectAll();
533 bool wxSpinCtrlGenericBase::DoSetValue(double val
, SendEvent sendEvent
)
535 wxCHECK_MSG( m_textCtrl
, false, wxT("invalid call to wxSpinCtrl::SetValue") );
542 if ( m_snap_to_ticks
&& (m_increment
!= 0) )
544 double snap_value
= val
/ m_increment
;
546 if (wxFinite(snap_value
)) // FIXME what to do about a failure?
548 if ((snap_value
- floor(snap_value
)) < (ceil(snap_value
) - snap_value
))
549 val
= floor(snap_value
) * m_increment
;
551 val
= ceil(snap_value
) * m_increment
;
555 wxString
str(DoValueToText(val
));
557 if ((val
!= m_value
) || (str
!= m_textCtrl
->GetValue()))
559 if ( !DoTextToValue(str
, &m_value
) ) // wysiwyg for textctrl
565 m_textCtrl
->ChangeValue(str
);
569 m_textCtrl
->SetValue(str
);
573 m_textCtrl
->SelectAll();
574 m_textCtrl
->DiscardEdits();
581 double wxSpinCtrlGenericBase::AdjustToFitInRange(double value
) const
584 value
= HasFlag(wxSP_WRAP
) ? m_max
: m_min
;
586 value
= HasFlag(wxSP_WRAP
) ? m_min
: m_max
;
591 void wxSpinCtrlGenericBase::DoSetRange(double min
, double max
)
594 if ( m_value
< m_min
)
595 DoSetValue(m_min
, SendEvent_None
);
597 if ( m_value
> m_max
)
598 DoSetValue(m_max
, SendEvent_None
);
601 void wxSpinCtrlGenericBase::DoSetIncrement(double inc
)
606 void wxSpinCtrlGenericBase::SetSnapToTicks(bool snap_to_ticks
)
608 m_snap_to_ticks
= snap_to_ticks
;
609 DoSetValue(m_value
, SendEvent_None
);
612 void wxSpinCtrlGenericBase::SetSelection(long from
, long to
)
614 wxCHECK_RET( m_textCtrl
, wxT("invalid call to wxSpinCtrl::SetSelection") );
616 m_textCtrl
->SetSelection(from
, to
);
619 #ifndef wxHAS_NATIVE_SPINCTRL
621 //-----------------------------------------------------------------------------
623 //-----------------------------------------------------------------------------
625 bool wxSpinCtrl::SetBase(int base
)
627 // Currently we only support base 10 and 16. We could add support for base
628 // 8 quite easily but wxMSW doesn't support it natively so don't bother.
629 if ( base
!= 10 && base
!= 16 )
632 if ( base
== m_base
)
635 // Update the current control contents to show in the new base: be careful
636 // to call DoTextToValue() before changing the base...
638 const bool hasValidVal
= DoTextToValue(m_textCtrl
->GetValue(), &val
);
642 // ... but DoValueToText() after doing it.
644 m_textCtrl
->ChangeValue(DoValueToText(val
));
649 void wxSpinCtrl::DoSendEvent()
651 wxSpinEvent
event( wxEVT_SPINCTRL
, GetId());
652 event
.SetEventObject( this );
653 event
.SetPosition((int)(m_value
+ 0.5)); // FIXME should be SetValue
654 event
.SetString(m_textCtrl
->GetValue());
655 GetEventHandler()->ProcessEvent( event
);
658 bool wxSpinCtrl::DoTextToValue(const wxString
& text
, double *val
)
661 if ( !text
.ToLong(&lval
, GetBase()) )
664 *val
= static_cast<double>(lval
);
669 wxString
wxSpinCtrl::DoValueToText(double val
)
674 return wxPrivate::wxSpinCtrlFormatAsHex(static_cast<long>(val
),
678 wxFAIL_MSG( wxS("Unsupported spin control base") );
682 return wxString::Format("%ld", static_cast<long>(val
));
686 #endif // !wxHAS_NATIVE_SPINCTRL
688 //-----------------------------------------------------------------------------
690 //-----------------------------------------------------------------------------
692 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrlDouble
, wxSpinCtrlGenericBase
)
694 void wxSpinCtrlDouble::DoSendEvent()
696 wxSpinDoubleEvent
event( wxEVT_SPINCTRLDOUBLE
, GetId());
697 event
.SetEventObject( this );
698 event
.SetValue(m_value
);
699 event
.SetString(m_textCtrl
->GetValue());
700 GetEventHandler()->ProcessEvent( event
);
703 bool wxSpinCtrlDouble::DoTextToValue(const wxString
& text
, double *val
)
705 return text
.ToDouble(val
);
708 wxString
wxSpinCtrlDouble::DoValueToText(double val
)
710 return wxString::Format(m_format
, val
);
713 void wxSpinCtrlDouble::SetDigits(unsigned digits
)
715 wxCHECK_RET( digits
<= 20, "too many digits for wxSpinCtrlDouble" );
717 if ( digits
== m_digits
)
722 m_format
.Printf(wxT("%%0.%ulf"), digits
);
724 DoSetValue(m_value
, SendEvent_None
);
727 #endif // wxUSE_SPINBTN
729 #endif // !wxPort-with-native-spinctrl
731 #endif // wxUSE_SPINCTRL