]> git.saurik.com Git - wxWidgets.git/blob - src/generic/spinctlg.cpp
Respect wxFileName::DontFollowLink() in wxFileSystemWatcher.
[wxWidgets.git] / src / generic / spinctlg.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/spinctlg.cpp
3 // Purpose: implements wxSpinCtrl as a composite control
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 29.01.01
7 // RCS-ID: $Id$
8 // Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #ifndef WX_PRECOMP
28 #include "wx/textctrl.h"
29 #endif //WX_PRECOMP
30
31 #include "wx/spinctrl.h"
32 #include "wx/tooltip.h"
33
34 #if wxUSE_SPINCTRL
35
36 IMPLEMENT_DYNAMIC_CLASS(wxSpinDoubleEvent, wxNotifyEvent)
37
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)
41
42 #include "wx/spinbutt.h"
43
44 #if wxUSE_SPINBTN
45
46 // ----------------------------------------------------------------------------
47 // constants
48 // ----------------------------------------------------------------------------
49
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;
56
57 #define SPINCTRLBUT_MAX 32000 // large to avoid wrap around trouble
58
59 // ----------------------------------------------------------------------------
60 // wxSpinCtrlTextGeneric: text control used by spin control
61 // ----------------------------------------------------------------------------
62
63 class wxSpinCtrlTextGeneric : public wxTextCtrl
64 {
65 public:
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)
73 {
74 m_spin = spin;
75
76 // remove the default minsize, the spinctrl will have one instead
77 SetSizeHints(wxDefaultCoord, wxDefaultCoord);
78 }
79
80 virtual ~wxSpinCtrlTextGeneric()
81 {
82 // MSW sends extra kill focus event on destroy
83 if (m_spin)
84 m_spin->m_textCtrl = NULL;
85
86 m_spin = NULL;
87 }
88
89 void OnChar( wxKeyEvent &event )
90 {
91 if ( !m_spin->ProcessWindowEvent(event) )
92 event.Skip();
93 }
94
95 void OnTextEvent(wxCommandEvent& event)
96 {
97 wxCommandEvent eventCopy(event);
98 eventCopy.SetEventObject(m_spin);
99 eventCopy.SetId(m_spin->GetId());
100 m_spin->ProcessWindowEvent(eventCopy);
101 }
102
103 void OnKillFocus(wxFocusEvent& event)
104 {
105 if (m_spin)
106 m_spin->ProcessWindowEvent(event);
107
108 event.Skip();
109 }
110
111 wxSpinCtrlGenericBase *m_spin;
112
113 private:
114 DECLARE_EVENT_TABLE()
115 };
116
117 BEGIN_EVENT_TABLE(wxSpinCtrlTextGeneric, wxTextCtrl)
118 EVT_CHAR(wxSpinCtrlTextGeneric::OnChar)
119
120 // Forward the text events to wxSpinCtrl itself adjusting them slightly in
121 // the process.
122 EVT_TEXT(wxID_ANY, wxSpinCtrlTextGeneric::OnTextEvent)
123
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)
128
129 EVT_KILL_FOCUS(wxSpinCtrlTextGeneric::OnKillFocus)
130 END_EVENT_TABLE()
131
132 // ----------------------------------------------------------------------------
133 // wxSpinCtrlButtonGeneric: spin button used by spin control
134 // ----------------------------------------------------------------------------
135
136 class wxSpinCtrlButtonGeneric : public wxSpinButton
137 {
138 public:
139 wxSpinCtrlButtonGeneric(wxSpinCtrlGenericBase *spin, int style)
140 : wxSpinButton(spin->GetParent(), wxID_ANY, wxDefaultPosition,
141 wxDefaultSize, style | wxSP_VERTICAL)
142 {
143 m_spin = spin;
144
145 SetRange(-SPINCTRLBUT_MAX, SPINCTRLBUT_MAX);
146
147 // remove the default minsize, the spinctrl will have one instead
148 SetSizeHints(wxDefaultCoord, wxDefaultCoord);
149 }
150
151 void OnSpinButton(wxSpinEvent& event)
152 {
153 if (m_spin)
154 m_spin->OnSpinButton(event);
155 }
156
157 wxSpinCtrlGenericBase *m_spin;
158
159 private:
160 DECLARE_EVENT_TABLE()
161 };
162
163 BEGIN_EVENT_TABLE(wxSpinCtrlButtonGeneric, wxSpinButton)
164 EVT_SPIN_UP( wxID_ANY, wxSpinCtrlButtonGeneric::OnSpinButton)
165 EVT_SPIN_DOWN(wxID_ANY, wxSpinCtrlButtonGeneric::OnSpinButton)
166 END_EVENT_TABLE()
167
168 // ============================================================================
169 // wxSpinCtrlGenericBase
170 // ============================================================================
171
172 // ----------------------------------------------------------------------------
173 // wxSpinCtrlGenericBase creation
174 // ----------------------------------------------------------------------------
175
176 void wxSpinCtrlGenericBase::Init()
177 {
178 m_value = 0;
179 m_min = 0;
180 m_max = 100;
181 m_increment = 1;
182 m_snap_to_ticks = false;
183
184 m_spin_value = 0;
185
186 m_textCtrl = NULL;
187 m_spinButton = NULL;
188 }
189
190 bool wxSpinCtrlGenericBase::Create(wxWindow *parent,
191 wxWindowID id,
192 const wxString& value,
193 const wxPoint& pos, const wxSize& size,
194 long style,
195 double min, double max, double initial,
196 double increment,
197 const wxString& name)
198 {
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) )
205 {
206 return false;
207 }
208
209 m_value = initial;
210 m_min = min;
211 m_max = max;
212 m_increment = increment;
213
214 m_textCtrl = new wxSpinCtrlTextGeneric(this, value, style);
215 m_spinButton = new wxSpinCtrlButtonGeneric(this, style);
216 #if wxUSE_TOOLTIPS
217 m_textCtrl->SetToolTip(GetToolTipText());
218 m_spinButton->SetToolTip(GetToolTipText());
219 #endif // wxUSE_TOOLTIPS
220
221 m_spin_value = m_spinButton->GetValue();
222
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() )
228 {
229 double d;
230 if ( DoTextToValue(value, &d) )
231 {
232 m_value = d;
233 m_textCtrl->SetValue(DoValueToText(m_value));
234 }
235 }
236
237 SetInitialSize(size);
238 Move(pos);
239
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!
244 m_isEnabled = true;
245
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);
249 m_isShown = true;
250 return true;
251 }
252
253 wxSpinCtrlGenericBase::~wxSpinCtrlGenericBase()
254 {
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
258
259 if (m_textCtrl)
260 {
261 // null this since MSW sends KILL_FOCUS on deletion, see ~wxSpinCtrlTextGeneric
262 wxDynamicCast(m_textCtrl, wxSpinCtrlTextGeneric)->m_spin = NULL;
263
264 wxSpinCtrlTextGeneric *text = (wxSpinCtrlTextGeneric*)m_textCtrl;
265 m_textCtrl = NULL;
266 delete text;
267 }
268
269 wxDELETE(m_spinButton);
270 }
271
272 // ----------------------------------------------------------------------------
273 // geometry
274 // ----------------------------------------------------------------------------
275
276 wxSize wxSpinCtrlGenericBase::DoGetBestSize() const
277 {
278 wxSize sizeBtn = m_spinButton->GetBestSize(),
279 sizeText = m_textCtrl->GetBestSize();
280
281 return wxSize(sizeBtn.x + sizeText.x + MARGIN, sizeText.y);
282 }
283
284 void wxSpinCtrlGenericBase::DoMoveWindow(int x, int y, int width, int height)
285 {
286 wxControl::DoMoveWindow(x, y, width, height);
287
288 // position the subcontrols inside the client area
289 wxSize sizeBtn = m_spinButton->GetSize();
290
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);
294 }
295
296 // ----------------------------------------------------------------------------
297 // operations forwarded to the subcontrols
298 // ----------------------------------------------------------------------------
299
300 void wxSpinCtrlGenericBase::SetFocus()
301 {
302 if ( m_textCtrl )
303 m_textCtrl->SetFocus();
304 }
305
306 #ifdef __WXMSW__
307
308 void wxSpinCtrlGenericBase::DoEnable(bool enable)
309 {
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).
313 if ( !enable )
314 wxSpinCtrlBase::DoEnable(enable);
315 }
316
317 #endif // __WXMSW__
318
319 bool wxSpinCtrlGenericBase::Enable(bool enable)
320 {
321 if ( !wxSpinCtrlBase::Enable(enable) )
322 return false;
323
324 m_spinButton->Enable(enable);
325 m_textCtrl->Enable(enable);
326
327 return true;
328 }
329
330 bool wxSpinCtrlGenericBase::Show(bool show)
331 {
332 if ( !wxControl::Show(show) )
333 return false;
334
335 // under GTK Show() is called the first time before we are fully
336 // constructed
337 if ( m_spinButton )
338 {
339 m_spinButton->Show(show);
340 m_textCtrl->Show(show);
341 }
342
343 return true;
344 }
345
346 #if wxUSE_TOOLTIPS
347 void wxSpinCtrlGenericBase::DoSetToolTip(wxToolTip *tip)
348 {
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).
353 if ( m_textCtrl )
354 {
355 if ( tip )
356 m_textCtrl->SetToolTip(tip->GetTip());
357 else
358 m_textCtrl->SetToolTip(NULL);
359 }
360
361 if ( m_spinButton )
362 {
363 if( tip )
364 m_spinButton->SetToolTip(tip->GetTip());
365 else
366 m_spinButton->SetToolTip(NULL);
367 }
368
369 wxWindowBase::DoSetToolTip(tip);
370 }
371 #endif // wxUSE_TOOLTIPS
372
373 // ----------------------------------------------------------------------------
374 // Handle sub controls events
375 // ----------------------------------------------------------------------------
376
377 BEGIN_EVENT_TABLE(wxSpinCtrlGenericBase, wxSpinCtrlBase)
378 EVT_CHAR(wxSpinCtrlGenericBase::OnTextChar)
379 EVT_KILL_FOCUS(wxSpinCtrlGenericBase::OnTextLostFocus)
380 END_EVENT_TABLE()
381
382 void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent& event)
383 {
384 event.Skip();
385
386 // Sync the textctrl since the user expects that the button will modify
387 // what they see in the textctrl.
388 SyncSpinToText();
389
390 int spin_value = event.GetPosition();
391 double step = (event.GetEventType() == wxEVT_SCROLL_LINEUP) ? 1 : -1;
392
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);
396
397 double value = AdjustToFitInRange(m_value + step*m_increment);
398
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)
402 {
403 m_spin_value = spin_value;
404 return;
405 }
406
407 m_spin_value = spin_value;
408
409 if ( DoSetValue(value) )
410 DoSendEvent();
411 }
412
413 void wxSpinCtrlGenericBase::OnTextLostFocus(wxFocusEvent& event)
414 {
415 SyncSpinToText();
416 DoSendEvent();
417
418 event.Skip();
419 }
420
421 void wxSpinCtrlGenericBase::OnTextChar(wxKeyEvent& event)
422 {
423 if ( !HasFlag(wxSP_ARROW_KEYS) )
424 {
425 event.Skip();
426 return;
427 }
428
429 double value = m_value;
430 switch ( event.GetKeyCode() )
431 {
432 case WXK_UP :
433 value += m_increment;
434 break;
435
436 case WXK_DOWN :
437 value -= m_increment;
438 break;
439
440 case WXK_PAGEUP :
441 value += m_increment * 10.0;
442 break;
443
444 case WXK_PAGEDOWN :
445 value -= m_increment * 10.0;
446 break;
447
448 default:
449 event.Skip();
450 return;
451 }
452
453 value = AdjustToFitInRange(value);
454
455 SyncSpinToText();
456
457 if ( DoSetValue(value) )
458 DoSendEvent();
459 }
460
461 // ----------------------------------------------------------------------------
462 // Textctrl functions
463 // ----------------------------------------------------------------------------
464
465 bool wxSpinCtrlGenericBase::SyncSpinToText()
466 {
467 if ( !m_textCtrl || !m_textCtrl->IsModified() )
468 return false;
469
470 double textValue;
471 if ( DoTextToValue(m_textCtrl->GetValue(), &textValue) )
472 {
473 if (textValue > m_max)
474 textValue = m_max;
475 else if (textValue < m_min)
476 textValue = m_min;
477 }
478 else // text contents is not a valid number at all
479 {
480 // replace its contents with the last valid value
481 textValue = m_value;
482 }
483
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);
488 }
489
490 // ----------------------------------------------------------------------------
491 // changing value and range
492 // ----------------------------------------------------------------------------
493
494 void wxSpinCtrlGenericBase::SetValue(const wxString& text)
495 {
496 wxCHECK_RET( m_textCtrl, wxT("invalid call to wxSpinCtrl::SetValue") );
497
498 double val;
499 if ( DoTextToValue(text, &val) && InRange(val) )
500 {
501 DoSetValue(val);
502 }
503 else // not a number at all or out of range
504 {
505 m_textCtrl->SetValue(text);
506 m_textCtrl->SetSelection(0, -1);
507 m_textCtrl->SetInsertionPointEnd();
508 }
509 }
510
511 bool wxSpinCtrlGenericBase::DoSetValue(double val)
512 {
513 wxCHECK_MSG( m_textCtrl, false, wxT("invalid call to wxSpinCtrl::SetValue") );
514
515 if (!InRange(val))
516 return false;
517
518 if ( m_snap_to_ticks && (m_increment != 0) )
519 {
520 double snap_value = val / m_increment;
521
522 if (wxFinite(snap_value)) // FIXME what to do about a failure?
523 {
524 if ((snap_value - floor(snap_value)) < (ceil(snap_value) - snap_value))
525 val = floor(snap_value) * m_increment;
526 else
527 val = ceil(snap_value) * m_increment;
528 }
529 }
530
531 wxString str(DoValueToText(val));
532
533 if ((val != m_value) || (str != m_textCtrl->GetValue()))
534 {
535 if ( !DoTextToValue(str, &m_value ) ) // wysiwyg for textctrl
536 m_value = val;
537 m_textCtrl->SetValue( str );
538 m_textCtrl->SetInsertionPointEnd();
539 m_textCtrl->DiscardEdits();
540 return true;
541 }
542
543 return false;
544 }
545
546 double wxSpinCtrlGenericBase::AdjustToFitInRange(double value) const
547 {
548 if (value < m_min)
549 value = HasFlag(wxSP_WRAP) ? m_max : m_min;
550 if (value > m_max)
551 value = HasFlag(wxSP_WRAP) ? m_min : m_max;
552
553 return value;
554 }
555
556 void wxSpinCtrlGenericBase::DoSetRange(double min, double max)
557 {
558 m_min = min;
559 m_max = max;
560 }
561
562 void wxSpinCtrlGenericBase::DoSetIncrement(double inc)
563 {
564 m_increment = inc;
565 }
566
567 void wxSpinCtrlGenericBase::SetSnapToTicks(bool snap_to_ticks)
568 {
569 m_snap_to_ticks = snap_to_ticks;
570 DoSetValue(m_value);
571 }
572
573 void wxSpinCtrlGenericBase::SetSelection(long from, long to)
574 {
575 wxCHECK_RET( m_textCtrl, wxT("invalid call to wxSpinCtrl::SetSelection") );
576
577 m_textCtrl->SetSelection(from, to);
578 }
579
580 #ifndef wxHAS_NATIVE_SPINCTRL
581
582 //-----------------------------------------------------------------------------
583 // wxSpinCtrl
584 //-----------------------------------------------------------------------------
585
586 bool wxSpinCtrl::SetBase(int base)
587 {
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 )
591 return false;
592
593 if ( base == m_base )
594 return true;
595
596 // Update the current control contents to show in the new base: be careful
597 // to call DoTextToValue() before changing the base...
598 double val;
599 const bool hasValidVal = DoTextToValue(m_textCtrl->GetValue(), &val);
600
601 m_base = base;
602
603 // ... but DoValueToText() after doing it.
604 if ( hasValidVal )
605 m_textCtrl->SetValue(DoValueToText(val));
606
607 return true;
608 }
609
610 void wxSpinCtrl::DoSendEvent()
611 {
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 );
617 }
618
619 bool wxSpinCtrl::DoTextToValue(const wxString& text, double *val)
620 {
621 long lval;
622 if ( !text.ToLong(&lval, GetBase()) )
623 return false;
624
625 *val = static_cast<double>(lval);
626
627 return true;
628 }
629
630 wxString wxSpinCtrl::DoValueToText(double val)
631 {
632 switch ( GetBase() )
633 {
634 case 16:
635 return wxPrivate::wxSpinCtrlFormatAsHex(static_cast<long>(val),
636 GetMax());
637
638 default:
639 wxFAIL_MSG( wxS("Unsupported spin control base") );
640 // Fall through
641
642 case 10:
643 return wxString::Format("%ld", static_cast<long>(val));
644 }
645 }
646
647 #endif // !wxHAS_NATIVE_SPINCTRL
648
649 //-----------------------------------------------------------------------------
650 // wxSpinCtrlDouble
651 //-----------------------------------------------------------------------------
652
653 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrlDouble, wxSpinCtrlGenericBase)
654
655 void wxSpinCtrlDouble::DoSendEvent()
656 {
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 );
662 }
663
664 bool wxSpinCtrlDouble::DoTextToValue(const wxString& text, double *val)
665 {
666 return text.ToDouble(val);
667 }
668
669 wxString wxSpinCtrlDouble::DoValueToText(double val)
670 {
671 return wxString::Format(m_format, val);
672 }
673
674 void wxSpinCtrlDouble::SetDigits(unsigned digits)
675 {
676 wxCHECK_RET( digits <= 20, "too many digits for wxSpinCtrlDouble" );
677
678 if ( digits == m_digits )
679 return;
680
681 m_digits = digits;
682
683 m_format.Printf(wxT("%%0.%ulf"), digits);
684
685 DoSetValue(m_value);
686 }
687
688 #endif // wxUSE_SPINBTN
689
690 #endif // !wxPort-with-native-spinctrl
691
692 #endif // wxUSE_SPINCTRL