Added ability to switch off more components of the size page UI
[wxWidgets.git] / src / generic / spinctlg.cpp
0 / 713 (  0%)
CommitLineData
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
36IMPLEMENT_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?).
55static 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
63class wxSpinCtrlTextGeneric : public wxTextCtrl
64{
65public:
66 wxSpinCtrlTextGeneric(wxSpinCtrlGenericBase *spin, const wxString& value, long style=0)
67 : wxTextCtrl(spin, 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
113private:
114 DECLARE_EVENT_TABLE()
115};
116
117BEGIN_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)
130END_EVENT_TABLE()
131
132// ----------------------------------------------------------------------------
133// wxSpinCtrlButtonGeneric: spin button used by spin control
134// ----------------------------------------------------------------------------
135
136class wxSpinCtrlButtonGeneric : public wxSpinButton
137{
138public:
139 wxSpinCtrlButtonGeneric(wxSpinCtrlGenericBase *spin, int style)
140 : wxSpinButton(spin, 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
159private:
160 DECLARE_EVENT_TABLE()
161};
162
163BEGIN_EVENT_TABLE(wxSpinCtrlButtonGeneric, wxSpinButton)
164 EVT_SPIN_UP( wxID_ANY, wxSpinCtrlButtonGeneric::OnSpinButton)
165 EVT_SPIN_DOWN(wxID_ANY, wxSpinCtrlButtonGeneric::OnSpinButton)
166END_EVENT_TABLE()
167
168// ============================================================================
169// wxSpinCtrlGenericBase
170// ============================================================================
171
172// ----------------------------------------------------------------------------
173// wxSpinCtrlGenericBase creation
174// ----------------------------------------------------------------------------
175
176void 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
190bool 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
217#if wxUSE_TOOLTIPS
218 m_textCtrl->SetToolTip(GetToolTipText());
219 m_spinButton->SetToolTip(GetToolTipText());
220#endif // wxUSE_TOOLTIPS
221
222 m_spin_value = m_spinButton->GetValue();
223
224 // the string value overrides the numeric one (for backwards compatibility
225 // reasons and also because it is simpler to satisfy the string value which
226 // comes much sooner in the list of arguments and leave the initial
227 // parameter unspecified)
228 if ( !value.empty() )
229 {
230 double d;
231 if ( DoTextToValue(value, &d) )
232 {
233 m_value = d;
234 m_textCtrl->SetValue(DoValueToText(m_value));
235 }
236 }
237
238 SetInitialSize(size);
239 Move(pos);
240
241 return true;
242}
243
244wxSpinCtrlGenericBase::~wxSpinCtrlGenericBase()
245{
246 // delete the controls now, don't leave them alive even though they would
247 // still be eventually deleted by our parent - but it will be too late, the
248 // user code expects them to be gone now
249
250 if (m_textCtrl)
251 {
252 // null this since MSW sends KILL_FOCUS on deletion, see ~wxSpinCtrlTextGeneric
253 wxDynamicCast(m_textCtrl, wxSpinCtrlTextGeneric)->m_spin = NULL;
254
255 wxSpinCtrlTextGeneric *text = (wxSpinCtrlTextGeneric*)m_textCtrl;
256 m_textCtrl = NULL;
257 delete text;
258 }
259
260 wxDELETE(m_spinButton);
261}
262
263wxWindowList wxSpinCtrlGenericBase::GetCompositeWindowParts() const
264{
265 wxWindowList parts;
266 parts.push_back(m_textCtrl);
267 parts.push_back(m_spinButton);
268 return parts;
269}
270
271// ----------------------------------------------------------------------------
272// geometry
273// ----------------------------------------------------------------------------
274
275wxSize wxSpinCtrlGenericBase::DoGetBestSize() const
276{
277 return DoGetSizeFromTextSize(m_textCtrl->GetBestSize().x, -1);
278}
279
280wxSize wxSpinCtrlGenericBase::DoGetSizeFromTextSize(int xlen, int ylen) const
281{
282 wxSize sizeBtn = m_spinButton->GetBestSize();
283 wxSize totalS( m_textCtrl->GetBestSize() );
284
285 wxSize tsize(xlen + sizeBtn.x + MARGIN, totalS.y);
286#if defined(__WXMSW__)
287 tsize.IncBy(0.4 * totalS.y + 4, 0);
288#elif defined(__WXGTK__)
289 tsize.IncBy(totalS.y + 10, 0);
290#endif // MSW GTK
291
292 // Check if the user requested a non-standard height.
293 if ( ylen > 0 )
294 tsize.IncBy(0, ylen - GetCharHeight());
295
296 return tsize;
297}
298
299void wxSpinCtrlGenericBase::DoMoveWindow(int x, int y, int width, int height)
300{
301 wxControl::DoMoveWindow(x, y, width, height);
302
303 // position the subcontrols inside the client area
304 wxSize sizeBtn = m_spinButton->GetSize();
305
306 wxCoord wText = width - sizeBtn.x - MARGIN;
307 m_textCtrl->SetSize(0, 0, wText, height);
308 m_spinButton->SetSize(0 + wText + MARGIN, 0, wxDefaultCoord, height);
309}
310
311// ----------------------------------------------------------------------------
312// operations forwarded to the subcontrols
313// ----------------------------------------------------------------------------
314
315void wxSpinCtrlGenericBase::SetFocus()
316{
317 if ( m_textCtrl )
318 m_textCtrl->SetFocus();
319}
320
321#ifdef __WXMSW__
322
323void wxSpinCtrlGenericBase::DoEnable(bool enable)
324{
325 wxSpinCtrlBase::DoEnable(enable);
326}
327
328#endif // __WXMSW__
329
330bool wxSpinCtrlGenericBase::Enable(bool enable)
331{
332 if ( !wxSpinCtrlBase::Enable(enable) )
333 return false;
334
335 m_spinButton->Enable(enable);
336 m_textCtrl->Enable(enable);
337
338 return true;
339}
340
341bool wxSpinCtrlGenericBase::Show(bool show)
342{
343 if ( !wxControl::Show(show) )
344 return false;
345
346 // under GTK Show() is called the first time before we are fully
347 // constructed
348 if ( m_spinButton )
349 {
350 m_spinButton->Show(show);
351 m_textCtrl->Show(show);
352 }
353
354 return true;
355}
356
357#if wxUSE_TOOLTIPS
358void wxSpinCtrlGenericBase::DoSetToolTip(wxToolTip *tip)
359{
360 // Notice that we must check for the subcontrols not being NULL (as they
361 // could be if we were created with the default ctor and this is called
362 // before Create() for some reason) and that we can't call SetToolTip(tip)
363 // because this would take ownership of the wxToolTip object (twice).
364 if ( m_textCtrl )
365 {
366 if ( tip )
367 m_textCtrl->SetToolTip(tip->GetTip());
368 else
369 m_textCtrl->SetToolTip(NULL);
370 }
371
372 if ( m_spinButton )
373 {
374 if( tip )
375 m_spinButton->SetToolTip(tip->GetTip());
376 else
377 m_spinButton->SetToolTip(NULL);
378 }
379
380 wxWindowBase::DoSetToolTip(tip);
381}
382#endif // wxUSE_TOOLTIPS
383
384bool wxSpinCtrlGenericBase::SetBackgroundColour(const wxColour& colour)
385{
386 // We need to provide this otherwise the entire composite window
387 // background and therefore the between component spaces
388 // will be changed.
389 if ( m_textCtrl )
390 return m_textCtrl->SetBackgroundColour(colour);
391
392 return true;
393}
394
395// ----------------------------------------------------------------------------
396// Handle sub controls events
397// ----------------------------------------------------------------------------
398
399BEGIN_EVENT_TABLE(wxSpinCtrlGenericBase, wxSpinCtrlBase)
400 EVT_CHAR(wxSpinCtrlGenericBase::OnTextChar)
401 EVT_KILL_FOCUS(wxSpinCtrlGenericBase::OnTextLostFocus)
402END_EVENT_TABLE()
403
404void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent& event)
405{
406 event.Skip();
407
408 // Sync the textctrl since the user expects that the button will modify
409 // what they see in the textctrl.
410 SyncSpinToText();
411
412 int spin_value = event.GetPosition();
413 double step = (event.GetEventType() == wxEVT_SCROLL_LINEUP) ? 1 : -1;
414
415 // Use the spinbutton's acceleration, if any, but not if wrapping around
416 if (((spin_value >= 0) && (m_spin_value >= 0)) || ((spin_value <= 0) && (m_spin_value <= 0)))
417 step *= abs(spin_value - m_spin_value);
418
419 double value = AdjustToFitInRange(m_value + step*m_increment);
420
421 // Ignore the edges when it wraps since the up/down event may be opposite
422 // They are in GTK and Mac
423 if (abs(spin_value - m_spin_value) > SPINCTRLBUT_MAX)
424 {
425 m_spin_value = spin_value;
426 return;
427 }
428
429 m_spin_value = spin_value;
430
431 if ( DoSetValue(value) )
432 DoSendEvent();
433}
434
435void wxSpinCtrlGenericBase::OnTextLostFocus(wxFocusEvent& event)
436{
437 SyncSpinToText();
438 DoSendEvent();
439
440 event.Skip();
441}
442
443void wxSpinCtrlGenericBase::OnTextChar(wxKeyEvent& event)
444{
445 if ( !HasFlag(wxSP_ARROW_KEYS) )
446 {
447 event.Skip();
448 return;
449 }
450
451 double value = m_value;
452 switch ( event.GetKeyCode() )
453 {
454 case WXK_UP :
455 value += m_increment;
456 break;
457
458 case WXK_DOWN :
459 value -= m_increment;
460 break;
461
462 case WXK_PAGEUP :
463 value += m_increment * 10.0;
464 break;
465
466 case WXK_PAGEDOWN :
467 value -= m_increment * 10.0;
468 break;
469
470 default:
471 event.Skip();
472 return;
473 }
474
475 value = AdjustToFitInRange(value);
476
477 SyncSpinToText();
478
479 if ( DoSetValue(value) )
480 DoSendEvent();
481}
482
483// ----------------------------------------------------------------------------
484// Textctrl functions
485// ----------------------------------------------------------------------------
486
487bool wxSpinCtrlGenericBase::SyncSpinToText()
488{
489 if ( !m_textCtrl || !m_textCtrl->IsModified() )
490 return false;
491
492 double textValue;
493 if ( DoTextToValue(m_textCtrl->GetValue(), &textValue) )
494 {
495 if (textValue > m_max)
496 textValue = m_max;
497 else if (textValue < m_min)
498 textValue = m_min;
499 }
500 else // text contents is not a valid number at all
501 {
502 // replace its contents with the last valid value
503 textValue = m_value;
504 }
505
506 // we must always set the value here, even if it's equal to m_value, as
507 // otherwise we could be left with an out of range value when leaving the
508 // text control and the current value is already m_max for example
509 return DoSetValue(textValue);
510}
511
512// ----------------------------------------------------------------------------
513// changing value and range
514// ----------------------------------------------------------------------------
515
516void wxSpinCtrlGenericBase::SetValue(const wxString& text)
517{
518 wxCHECK_RET( m_textCtrl, wxT("invalid call to wxSpinCtrl::SetValue") );
519
520 double val;
521 if ( DoTextToValue(text, &val) && InRange(val) )
522 {
523 DoSetValue(val);
524 }
525 else // not a number at all or out of range
526 {
527 m_textCtrl->SetValue(text);
528 m_textCtrl->SelectAll();
529 }
530}
531
532bool wxSpinCtrlGenericBase::DoSetValue(double val)
533{
534 wxCHECK_MSG( m_textCtrl, false, wxT("invalid call to wxSpinCtrl::SetValue") );
535
536 if (!InRange(val))
537 return false;
538
539 if ( m_snap_to_ticks && (m_increment != 0) )
540 {
541 double snap_value = val / m_increment;
542
543 if (wxFinite(snap_value)) // FIXME what to do about a failure?
544 {
545 if ((snap_value - floor(snap_value)) < (ceil(snap_value) - snap_value))
546 val = floor(snap_value) * m_increment;
547 else
548 val = ceil(snap_value) * m_increment;
549 }
550 }
551
552 wxString str(DoValueToText(val));
553
554 if ((val != m_value) || (str != m_textCtrl->GetValue()))
555 {
556 if ( !DoTextToValue(str, &m_value ) ) // wysiwyg for textctrl
557 m_value = val;
558 m_textCtrl->SetValue( str );
559 m_textCtrl->SelectAll();
560 m_textCtrl->DiscardEdits();
561 return true;
562 }
563
564 return false;
565}
566
567double wxSpinCtrlGenericBase::AdjustToFitInRange(double value) const
568{
569 if (value < m_min)
570 value = HasFlag(wxSP_WRAP) ? m_max : m_min;
571 if (value > m_max)
572 value = HasFlag(wxSP_WRAP) ? m_min : m_max;
573
574 return value;
575}
576
577void wxSpinCtrlGenericBase::DoSetRange(double min, double max)
578{
579 m_min = min;
580 m_max = max;
581}
582
583void wxSpinCtrlGenericBase::DoSetIncrement(double inc)
584{
585 m_increment = inc;
586}
587
588void wxSpinCtrlGenericBase::SetSnapToTicks(bool snap_to_ticks)
589{
590 m_snap_to_ticks = snap_to_ticks;
591 DoSetValue(m_value);
592}
593
594void wxSpinCtrlGenericBase::SetSelection(long from, long to)
595{
596 wxCHECK_RET( m_textCtrl, wxT("invalid call to wxSpinCtrl::SetSelection") );
597
598 m_textCtrl->SetSelection(from, to);
599}
600
601#ifndef wxHAS_NATIVE_SPINCTRL
602
603//-----------------------------------------------------------------------------
604// wxSpinCtrl
605//-----------------------------------------------------------------------------
606
607bool wxSpinCtrl::SetBase(int base)
608{
609 // Currently we only support base 10 and 16. We could add support for base
610 // 8 quite easily but wxMSW doesn't support it natively so don't bother.
611 if ( base != 10 && base != 16 )
612 return false;
613
614 if ( base == m_base )
615 return true;
616
617 // Update the current control contents to show in the new base: be careful
618 // to call DoTextToValue() before changing the base...
619 double val;
620 const bool hasValidVal = DoTextToValue(m_textCtrl->GetValue(), &val);
621
622 m_base = base;
623
624 // ... but DoValueToText() after doing it.
625 if ( hasValidVal )
626 m_textCtrl->SetValue(DoValueToText(val));
627
628 return true;
629}
630
631void wxSpinCtrl::DoSendEvent()
632{
633 wxSpinEvent event( wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
634 event.SetEventObject( this );
635 event.SetPosition((int)(m_value + 0.5)); // FIXME should be SetValue
636 event.SetString(m_textCtrl->GetValue());
637 GetEventHandler()->ProcessEvent( event );
638}
639
640bool wxSpinCtrl::DoTextToValue(const wxString& text, double *val)
641{
642 long lval;
643 if ( !text.ToLong(&lval, GetBase()) )
644 return false;
645
646 *val = static_cast<double>(lval);
647
648 return true;
649}
650
651wxString wxSpinCtrl::DoValueToText(double val)
652{
653 switch ( GetBase() )
654 {
655 case 16:
656 return wxPrivate::wxSpinCtrlFormatAsHex(static_cast<long>(val),
657 GetMax());
658
659 default:
660 wxFAIL_MSG( wxS("Unsupported spin control base") );
661 // Fall through
662
663 case 10:
664 return wxString::Format("%ld", static_cast<long>(val));
665 }
666}
667
668#endif // !wxHAS_NATIVE_SPINCTRL
669
670//-----------------------------------------------------------------------------
671// wxSpinCtrlDouble
672//-----------------------------------------------------------------------------
673
674IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrlDouble, wxSpinCtrlGenericBase)
675
676void wxSpinCtrlDouble::DoSendEvent()
677{
678 wxSpinDoubleEvent event( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, GetId());
679 event.SetEventObject( this );
680 event.SetValue(m_value);
681 event.SetString(m_textCtrl->GetValue());
682 GetEventHandler()->ProcessEvent( event );
683}
684
685bool wxSpinCtrlDouble::DoTextToValue(const wxString& text, double *val)
686{
687 return text.ToDouble(val);
688}
689
690wxString wxSpinCtrlDouble::DoValueToText(double val)
691{
692 return wxString::Format(m_format, val);
693}
694
695void wxSpinCtrlDouble::SetDigits(unsigned digits)
696{
697 wxCHECK_RET( digits <= 20, "too many digits for wxSpinCtrlDouble" );
698
699 if ( digits == m_digits )
700 return;
701
702 m_digits = digits;
703
704 m_format.Printf(wxT("%%0.%ulf"), digits);
705
706 DoSetValue(m_value);
707}
708
709#endif // wxUSE_SPINBTN
710
711#endif // !wxPort-with-native-spinctrl
712
713#endif // wxUSE_SPINCTRL