]>
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.
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 if ( DoSetValue(value
) )
434 void wxSpinCtrlGenericBase::OnTextLostFocus(wxFocusEvent
& event
)
442 void wxSpinCtrlGenericBase::OnTextChar(wxKeyEvent
& event
)
444 if ( !HasFlag(wxSP_ARROW_KEYS
) )
450 double value
= m_value
;
451 switch ( event
.GetKeyCode() )
454 value
+= m_increment
;
458 value
-= m_increment
;
462 value
+= m_increment
* 10.0;
466 value
-= m_increment
* 10.0;
474 value
= AdjustToFitInRange(value
);
478 if ( DoSetValue(value
) )
482 // ----------------------------------------------------------------------------
483 // Textctrl functions
484 // ----------------------------------------------------------------------------
486 bool wxSpinCtrlGenericBase::SyncSpinToText()
488 if ( !m_textCtrl
|| !m_textCtrl
->IsModified() )
492 if ( DoTextToValue(m_textCtrl
->GetValue(), &textValue
) )
494 if (textValue
> m_max
)
496 else if (textValue
< m_min
)
499 else // text contents is not a valid number at all
501 // replace its contents with the last valid value
505 // we must always set the value here, even if it's equal to m_value, as
506 // otherwise we could be left with an out of range value when leaving the
507 // text control and the current value is already m_max for example
508 return DoSetValue(textValue
);
511 // ----------------------------------------------------------------------------
512 // changing value and range
513 // ----------------------------------------------------------------------------
515 void wxSpinCtrlGenericBase::SetValue(const wxString
& text
)
517 wxCHECK_RET( m_textCtrl
, wxT("invalid call to wxSpinCtrl::SetValue") );
520 if ( DoTextToValue(text
, &val
) && InRange(val
) )
524 else // not a number at all or out of range
526 m_textCtrl
->SetValue(text
);
527 m_textCtrl
->SelectAll();
531 bool wxSpinCtrlGenericBase::DoSetValue(double val
)
533 wxCHECK_MSG( m_textCtrl
, false, wxT("invalid call to wxSpinCtrl::SetValue") );
540 if ( m_snap_to_ticks
&& (m_increment
!= 0) )
542 double snap_value
= val
/ m_increment
;
544 if (wxFinite(snap_value
)) // FIXME what to do about a failure?
546 if ((snap_value
- floor(snap_value
)) < (ceil(snap_value
) - snap_value
))
547 val
= floor(snap_value
) * m_increment
;
549 val
= ceil(snap_value
) * m_increment
;
553 wxString
str(DoValueToText(val
));
555 if ((val
!= m_value
) || (str
!= m_textCtrl
->GetValue()))
557 if ( !DoTextToValue(str
, &m_value
) ) // wysiwyg for textctrl
559 m_textCtrl
->SetValue( str
);
560 m_textCtrl
->SelectAll();
561 m_textCtrl
->DiscardEdits();
568 double wxSpinCtrlGenericBase::AdjustToFitInRange(double value
) const
571 value
= HasFlag(wxSP_WRAP
) ? m_max
: m_min
;
573 value
= HasFlag(wxSP_WRAP
) ? m_min
: m_max
;
578 void wxSpinCtrlGenericBase::DoSetRange(double min
, double max
)
581 if ( m_value
< m_min
)
584 if ( m_value
> m_max
)
588 void wxSpinCtrlGenericBase::DoSetIncrement(double inc
)
593 void wxSpinCtrlGenericBase::SetSnapToTicks(bool snap_to_ticks
)
595 m_snap_to_ticks
= snap_to_ticks
;
599 void wxSpinCtrlGenericBase::SetSelection(long from
, long to
)
601 wxCHECK_RET( m_textCtrl
, wxT("invalid call to wxSpinCtrl::SetSelection") );
603 m_textCtrl
->SetSelection(from
, to
);
606 #ifndef wxHAS_NATIVE_SPINCTRL
608 //-----------------------------------------------------------------------------
610 //-----------------------------------------------------------------------------
612 bool wxSpinCtrl::SetBase(int base
)
614 // Currently we only support base 10 and 16. We could add support for base
615 // 8 quite easily but wxMSW doesn't support it natively so don't bother.
616 if ( base
!= 10 && base
!= 16 )
619 if ( base
== m_base
)
622 // Update the current control contents to show in the new base: be careful
623 // to call DoTextToValue() before changing the base...
625 const bool hasValidVal
= DoTextToValue(m_textCtrl
->GetValue(), &val
);
629 // ... but DoValueToText() after doing it.
631 m_textCtrl
->SetValue(DoValueToText(val
));
636 void wxSpinCtrl::DoSendEvent()
638 wxSpinEvent
event( wxEVT_SPINCTRL
, GetId());
639 event
.SetEventObject( this );
640 event
.SetPosition((int)(m_value
+ 0.5)); // FIXME should be SetValue
641 event
.SetString(m_textCtrl
->GetValue());
642 GetEventHandler()->ProcessEvent( event
);
645 bool wxSpinCtrl::DoTextToValue(const wxString
& text
, double *val
)
648 if ( !text
.ToLong(&lval
, GetBase()) )
651 *val
= static_cast<double>(lval
);
656 wxString
wxSpinCtrl::DoValueToText(double val
)
661 return wxPrivate::wxSpinCtrlFormatAsHex(static_cast<long>(val
),
665 wxFAIL_MSG( wxS("Unsupported spin control base") );
669 return wxString::Format("%ld", static_cast<long>(val
));
673 #endif // !wxHAS_NATIVE_SPINCTRL
675 //-----------------------------------------------------------------------------
677 //-----------------------------------------------------------------------------
679 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrlDouble
, wxSpinCtrlGenericBase
)
681 void wxSpinCtrlDouble::DoSendEvent()
683 wxSpinDoubleEvent
event( wxEVT_SPINCTRLDOUBLE
, GetId());
684 event
.SetEventObject( this );
685 event
.SetValue(m_value
);
686 event
.SetString(m_textCtrl
->GetValue());
687 GetEventHandler()->ProcessEvent( event
);
690 bool wxSpinCtrlDouble::DoTextToValue(const wxString
& text
, double *val
)
692 return text
.ToDouble(val
);
695 wxString
wxSpinCtrlDouble::DoValueToText(double val
)
697 return wxString::Format(m_format
, val
);
700 void wxSpinCtrlDouble::SetDigits(unsigned digits
)
702 wxCHECK_RET( digits
<= 20, "too many digits for wxSpinCtrlDouble" );
704 if ( digits
== m_digits
)
709 m_format
.Printf(wxT("%%0.%ulf"), digits
);
714 #endif // wxUSE_SPINBTN
716 #endif // !wxPort-with-native-spinctrl
718 #endif // wxUSE_SPINCTRL