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 // License:     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
  33 #if wxUSE_SPINCTRL
  34
  35 IMPLEMENT_DYNAMIC_CLASS(wxSpinDoubleEvent, wxNotifyEvent)
  36
  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)
  40
  41 #include "wx/spinbutt.h"
  42
  43 #if wxUSE_SPINBTN
  44
  45 // ----------------------------------------------------------------------------
  46 // constants
  47 // ----------------------------------------------------------------------------
  48
  49 // the margin between the text control and the spin
  50 static const wxCoord MARGIN = 2;
  51
  52 #define SPINCTRLBUT_MAX 32000 // large to avoid wrap around trouble
  53
  54 // ----------------------------------------------------------------------------
  55 // wxSpinCtrlTextGeneric: text control used by spin control
  56 // ----------------------------------------------------------------------------
  57
  58 class wxSpinCtrlTextGeneric : public wxTextCtrl
  59 {
  60 public:
  61     wxSpinCtrlTextGeneric(wxSpinCtrlGenericBase *spin, const wxString& value, long style=0)
  62         : wxTextCtrl(spin->GetParent(), wxID_ANY, value, wxDefaultPosition, wxDefaultSize,
  63                      ( style & wxALIGN_MASK ) | wxTE_NOHIDESEL | wxTE_PROCESS_ENTER)
  64     {
  65         m_spin = spin;
  66
  67         // remove the default minsize, the spinctrl will have one instead
  68         SetSizeHints(wxDefaultCoord, wxDefaultCoord);
  69     }
  70
  71     virtual ~wxSpinCtrlTextGeneric()
  72     {
  73         // MSW sends extra kill focus event on destroy
  74         if (m_spin)
  75             m_spin->m_textCtrl = NULL;
  76
  77         m_spin = NULL;
  78     }
  79
  80     void OnTextEnter(wxCommandEvent& event)
  81     {
  82         if (m_spin)
  83             m_spin->OnTextEnter(event);
  84     }
  85
  86     void OnChar( wxKeyEvent &event )
  87     {
  88         if (m_spin)
  89             m_spin->OnTextChar(event);
  90     }
  91
  92     void OnKillFocus(wxFocusEvent& event)
  93     {
  94         if (m_spin)
  95         {
  96             if ( m_spin->SyncSpinToText() )
  97                 m_spin->DoSendEvent();
  98         }
  99
 100         event.Skip();
 101     }
 102
 103     wxSpinCtrlGenericBase *m_spin;
 104
 105 private:
 106     DECLARE_EVENT_TABLE()
 107 };
 108
 109 BEGIN_EVENT_TABLE(wxSpinCtrlTextGeneric, wxTextCtrl)
 110     EVT_TEXT_ENTER(wxID_ANY, wxSpinCtrlTextGeneric::OnTextEnter)
 111
 112     EVT_CHAR(wxSpinCtrlTextGeneric::OnChar)
 113
 114     EVT_KILL_FOCUS(wxSpinCtrlTextGeneric::OnKillFocus)
 115 END_EVENT_TABLE()
 116
 117 // ----------------------------------------------------------------------------
 118 // wxSpinCtrlButtonGeneric: spin button used by spin control
 119 // ----------------------------------------------------------------------------
 120
 121 class wxSpinCtrlButtonGeneric : public wxSpinButton
 122 {
 123 public:
 124     wxSpinCtrlButtonGeneric(wxSpinCtrlGenericBase *spin, int style)
 125         : wxSpinButton(spin->GetParent(), wxID_ANY, wxDefaultPosition,
 126                        wxDefaultSize, style | wxSP_VERTICAL)
 127     {
 128         m_spin = spin;
 129
 130         SetRange(-SPINCTRLBUT_MAX, SPINCTRLBUT_MAX);
 131
 132         // remove the default minsize, the spinctrl will have one instead
 133         SetSizeHints(wxDefaultCoord, wxDefaultCoord);
 134     }
 135
 136     void OnSpinButton(wxSpinEvent& event)
 137     {
 138         if (m_spin)
 139             m_spin->OnSpinButton(event);
 140     }
 141
 142     wxSpinCtrlGenericBase *m_spin;
 143
 144 private:
 145     DECLARE_EVENT_TABLE()
 146 };
 147
 148 BEGIN_EVENT_TABLE(wxSpinCtrlButtonGeneric, wxSpinButton)
 149     EVT_SPIN_UP(  wxID_ANY, wxSpinCtrlButtonGeneric::OnSpinButton)
 150     EVT_SPIN_DOWN(wxID_ANY, wxSpinCtrlButtonGeneric::OnSpinButton)
 151 END_EVENT_TABLE()
 152
 153 // ============================================================================
 154 // wxSpinCtrlGenericBase
 155 // ============================================================================
 156
 157 // ----------------------------------------------------------------------------
 158 // wxSpinCtrlGenericBase creation
 159 // ----------------------------------------------------------------------------
 160
 161 void wxSpinCtrlGenericBase::Init()
 162 {
 163     m_value         = 0;
 164     m_min           = 0;
 165     m_max           = 100;
 166     m_increment     = 1;
 167     m_snap_to_ticks = false;
 168     m_format        = wxS("%g");
 169
 170     m_spin_value    = 0;
 171
 172     m_textCtrl = NULL;
 173     m_spinButton  = NULL;
 174 }
 175
 176 bool wxSpinCtrlGenericBase::Create(wxWindow *parent,
 177                                    wxWindowID id,
 178                                    const wxString& value,
 179                                    const wxPoint& pos, const wxSize& size,
 180                                    long style,
 181                                    double min, double max, double initial,
 182                                    double increment,
 183                                    const wxString& name)
 184 {
 185     // don't use borders for this control itself, it wouldn't look good with
 186     // the text control borders (but we might want to use style border bits to
 187     // select the text control style)
 188     if ( !wxControl::Create(parent, id, wxDefaultPosition, wxDefaultSize,
 189                             (style & ~wxBORDER_MASK) | wxBORDER_NONE,
 190                             wxDefaultValidator, name) )
 191     {
 192         return false;
 193     }
 194
 195     m_value = initial;
 196     m_min   = min;
 197     m_max   = max;
 198     m_increment = increment;
 199
 200     m_textCtrl   = new wxSpinCtrlTextGeneric(this, value, style);
 201     m_spinButton = new wxSpinCtrlButtonGeneric(this, style);
 202
 203     m_spin_value = m_spinButton->GetValue();
 204
 205     // the string value overrides the numeric one (for backwards compatibility
 206     // reasons and also because it is simpler to satisfy the string value which
 207     // comes much sooner in the list of arguments and leave the initial
 208     // parameter unspecified)
 209     if ( !value.empty() )
 210     {
 211         double d;
 212         if ( value.ToDouble(&d) )
 213         {
 214             m_value = d;
 215             m_textCtrl->SetValue(wxString::Format(m_format, m_value));
 216         }
 217     }
 218
 219     SetInitialSize(size);
 220     Move(pos);
 221
 222     // have to disable this window to avoid interfering it with message
 223     // processing to the text and the button... but pretend it is enabled to
 224     // make IsEnabled() return true
 225     wxControl::Enable(false); // don't use non virtual Disable() here!
 226     m_isEnabled = true;
 227
 228     // we don't even need to show this window itself - and not doing it avoids
 229     // that it overwrites the text control
 230     wxControl::Show(false);
 231     m_isShown = true;
 232     return true;
 233 }
 234
 235 wxSpinCtrlGenericBase::~wxSpinCtrlGenericBase()
 236 {
 237     // delete the controls now, don't leave them alive even though they would
 238     // still be eventually deleted by our parent - but it will be too late, the
 239     // user code expects them to be gone now
 240
 241     if (m_textCtrl)
 242     {
 243         // null this since MSW sends KILL_FOCUS on deletion, see ~wxSpinCtrlTextGeneric
 244         wxDynamicCast(m_textCtrl, wxSpinCtrlTextGeneric)->m_spin = NULL;
 245
 246         wxSpinCtrlTextGeneric *text = (wxSpinCtrlTextGeneric*)m_textCtrl;
 247         m_textCtrl = NULL;
 248         delete text;
 249     }
 250
 251     wxDELETE(m_spinButton);
 252 }
 253
 254 // ----------------------------------------------------------------------------
 255 // geometry
 256 // ----------------------------------------------------------------------------
 257
 258 wxSize wxSpinCtrlGenericBase::DoGetBestSize() const
 259 {
 260     wxSize sizeBtn  = m_spinButton->GetBestSize(),
 261            sizeText = m_textCtrl->GetBestSize();
 262
 263     return wxSize(sizeBtn.x + sizeText.x + MARGIN, sizeText.y);
 264 }
 265
 266 void wxSpinCtrlGenericBase::DoMoveWindow(int x, int y, int width, int height)
 267 {
 268     wxControl::DoMoveWindow(x, y, width, height);
 269
 270     // position the subcontrols inside the client area
 271     wxSize sizeBtn = m_spinButton->GetSize();
 272
 273     wxCoord wText = width - sizeBtn.x;
 274     m_textCtrl->SetSize(x, y, wText, height);
 275     m_spinButton->SetSize(x + wText + MARGIN, y, wxDefaultCoord, height);
 276 }
 277
 278 // ----------------------------------------------------------------------------
 279 // operations forwarded to the subcontrols
 280 // ----------------------------------------------------------------------------
 281
 282 bool wxSpinCtrlGenericBase::Enable(bool enable)
 283 {
 284     // Notice that we never enable this control itself, it must stay disabled
 285     // to avoid interfering with the siblings event handling (see e.g. #12045
 286     // for the kind of problems which arise otherwise).
 287     if ( enable == m_isEnabled )
 288         return false;
 289
 290     m_isEnabled = enable;
 291
 292     m_spinButton->Enable(enable);
 293     m_textCtrl->Enable(enable);
 294
 295     return true;
 296 }
 297
 298 bool wxSpinCtrlGenericBase::Show(bool show)
 299 {
 300     if ( !wxControl::Show(show) )
 301         return false;
 302
 303     // under GTK Show() is called the first time before we are fully
 304     // constructed
 305     if ( m_spinButton )
 306     {
 307         m_spinButton->Show(show);
 308         m_textCtrl->Show(show);
 309     }
 310
 311     return true;
 312 }
 313
 314 bool wxSpinCtrlGenericBase::Reparent(wxWindowBase *newParent)
 315 {
 316     if ( m_spinButton )
 317     {
 318         m_spinButton->Reparent(newParent);
 319         m_textCtrl->Reparent(newParent);
 320     }
 321
 322     return true;
 323 }
 324
 325 // ----------------------------------------------------------------------------
 326 // Handle sub controls events
 327 // ----------------------------------------------------------------------------
 328
 329 void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent& event)
 330 {
 331     event.Skip();
 332
 333     // Sync the textctrl since the user expects that the button will modify
 334     // what they see in the textctrl.
 335     SyncSpinToText();
 336
 337     int spin_value = event.GetPosition();
 338     double step = (event.GetEventType() == wxEVT_SCROLL_LINEUP) ? 1 : -1;
 339
 340     // Use the spinbutton's acceleration, if any, but not if wrapping around
 341     if (((spin_value >= 0) && (m_spin_value >= 0)) || ((spin_value <= 0) && (m_spin_value <= 0)))
 342         step *= abs(spin_value - m_spin_value);
 343
 344     double value = AdjustToFitInRange(m_value + step*m_increment);
 345
 346     // Ignore the edges when it wraps since the up/down event may be opposite
 347     // They are in GTK and Mac
 348     if (abs(spin_value - m_spin_value) > SPINCTRLBUT_MAX)
 349     {
 350         m_spin_value = spin_value;
 351         return;
 352     }
 353
 354     m_spin_value = spin_value;
 355
 356     if ( DoSetValue(value) )
 357         DoSendEvent();
 358 }
 359
 360 void wxSpinCtrlGenericBase::OnTextEnter(wxCommandEvent& event)
 361 {
 362     SyncSpinToText();
 363     DoSendEvent();
 364     event.Skip();
 365 }
 366
 367 void wxSpinCtrlGenericBase::OnTextChar(wxKeyEvent& event)
 368 {
 369     if ( !HasFlag(wxSP_ARROW_KEYS) )
 370     {
 371         event.Skip();
 372         return;
 373     }
 374
 375     double value = m_value;
 376     switch ( event.GetKeyCode() )
 377     {
 378         case WXK_UP :
 379             value += m_increment;
 380             break;
 381
 382         case WXK_DOWN :
 383             value -= m_increment;
 384             break;
 385
 386         case WXK_PAGEUP :
 387             value += m_increment * 10.0;
 388             break;
 389
 390         case WXK_PAGEDOWN :
 391             value -= m_increment * 10.0;
 392             break;
 393
 394         default:
 395             event.Skip();
 396             return;
 397     }
 398
 399     value = AdjustToFitInRange(value);
 400
 401     SyncSpinToText();
 402
 403     if ( DoSetValue(value) )
 404         DoSendEvent();
 405 }
 406
 407 // ----------------------------------------------------------------------------
 408 // Textctrl functions
 409 // ----------------------------------------------------------------------------
 410
 411 bool wxSpinCtrlGenericBase::SyncSpinToText()
 412 {
 413     if ( !m_textCtrl || !m_textCtrl->IsModified() )
 414         return false;
 415
 416     double textValue;
 417     if ( m_textCtrl->GetValue().ToDouble(&textValue) )
 418     {
 419         if (textValue > m_max)
 420             textValue = m_max;
 421         else if (textValue < m_min)
 422             textValue = m_min;
 423     }
 424     else // text contents is not a valid number at all
 425     {
 426         // replace its contents with the last valid value
 427         textValue = m_value;
 428     }
 429
 430     // we must always set the value here, even if it's equal to m_value, as
 431     // otherwise we could be left with an out of range value when leaving the
 432     // text control and the current value is already m_max for example
 433     return DoSetValue(textValue);
 434 }
 435
 436 // ----------------------------------------------------------------------------
 437 // changing value and range
 438 // ----------------------------------------------------------------------------
 439
 440 void wxSpinCtrlGenericBase::SetValue(const wxString& text)
 441 {
 442     wxCHECK_RET( m_textCtrl, wxT("invalid call to wxSpinCtrl::SetValue") );
 443
 444     double val;
 445     if ( text.ToDouble(&val) && InRange(val) )
 446     {
 447         DoSetValue(val);
 448     }
 449     else // not a number at all or out of range
 450     {
 451         m_textCtrl->SetValue(text);
 452         m_textCtrl->SetSelection(0, -1);
 453         m_textCtrl->SetInsertionPointEnd();
 454     }
 455 }
 456
 457 bool wxSpinCtrlGenericBase::DoSetValue(double val)
 458 {
 459     wxCHECK_MSG( m_textCtrl, false, wxT("invalid call to wxSpinCtrl::SetValue") );
 460
 461     if (!InRange(val))
 462         return false;
 463
 464     if ( m_snap_to_ticks && (m_increment != 0) )
 465     {
 466         double snap_value = val / m_increment;
 467
 468         if (wxFinite(snap_value)) // FIXME what to do about a failure?
 469         {
 470             if ((snap_value - floor(snap_value)) < (ceil(snap_value) - snap_value))
 471                 val = floor(snap_value) * m_increment;
 472             else
 473                 val = ceil(snap_value) * m_increment;
 474         }
 475     }
 476
 477     wxString str(wxString::Format(m_format.c_str(), val));
 478
 479     if ((val != m_value) || (str != m_textCtrl->GetValue()))
 480     {
 481         m_value = val;
 482         str.ToDouble( &m_value );    // wysiwyg for textctrl
 483         m_textCtrl->SetValue( str );
 484         m_textCtrl->SetInsertionPointEnd();
 485         m_textCtrl->DiscardEdits();
 486         return true;
 487     }
 488
 489     return false;
 490 }
 491
 492 double wxSpinCtrlGenericBase::AdjustToFitInRange(double value) const
 493 {
 494     if (value < m_min)
 495         value = HasFlag(wxSP_WRAP) ? m_max : m_min;
 496     if (value > m_max)
 497         value = HasFlag(wxSP_WRAP) ? m_min : m_max;
 498
 499     return value;
 500 }
 501
 502 void wxSpinCtrlGenericBase::DoSetRange(double min, double max)
 503 {
 504     m_min = min;
 505     m_max = max;
 506 }
 507
 508 void wxSpinCtrlGenericBase::DoSetIncrement(double inc)
 509 {
 510     m_increment = inc;
 511 }
 512
 513 void wxSpinCtrlGenericBase::SetSnapToTicks(bool snap_to_ticks)
 514 {
 515     m_snap_to_ticks = snap_to_ticks;
 516     DoSetValue(m_value);
 517 }
 518
 519 void wxSpinCtrlGenericBase::SetSelection(long from, long to)
 520 {
 521     wxCHECK_RET( m_textCtrl, wxT("invalid call to wxSpinCtrl::SetSelection") );
 522
 523     m_textCtrl->SetSelection(from, to);
 524 }
 525
 526 #ifndef wxHAS_NATIVE_SPINCTRL
 527
 528 //-----------------------------------------------------------------------------
 529 // wxSpinCtrl
 530 //-----------------------------------------------------------------------------
 531
 532 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxSpinCtrlGenericBase)
 533
 534 void wxSpinCtrl::DoSendEvent()
 535 {
 536     wxSpinEvent event( wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
 537     event.SetEventObject( this );
 538     event.SetPosition((int)(m_value + 0.5)); // FIXME should be SetValue
 539     event.SetString(m_textCtrl->GetValue());
 540     GetEventHandler()->ProcessEvent( event );
 541 }
 542
 543 #endif // !wxHAS_NATIVE_SPINCTRL
 544
 545 //-----------------------------------------------------------------------------
 546 // wxSpinCtrlDouble
 547 //-----------------------------------------------------------------------------
 548
 549 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrlDouble, wxSpinCtrlGenericBase)
 550
 551 void wxSpinCtrlDouble::DoSendEvent()
 552 {
 553     wxSpinDoubleEvent event( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, GetId());
 554     event.SetEventObject( this );
 555     event.SetValue(m_value);
 556     event.SetString(m_textCtrl->GetValue());
 557     GetEventHandler()->ProcessEvent( event );
 558 }
 559
 560 void wxSpinCtrlDouble::SetDigits(unsigned digits)
 561 {
 562     wxCHECK_RET( digits <= 20, "too many digits for wxSpinCtrlDouble" );
 563
 564     m_format.Printf(wxT("%%0.%ulf"), digits);
 565
 566     DoSetValue(m_value);
 567 }
 568
 569 #endif // wxUSE_SPINBTN
 570
 571 #endif // !wxPort-with-native-spinctrl
 572
 573 #endif // wxUSE_SPINCTRL