Remove some out of date comments.

[wxWidgets.git] / src / generic / spinctlg.cpp

diff --git a/src/generic/spinctlg.cpp b/src/generic/spinctlg.cpp
index 853b967500d96462293f009ce3ab774de15db7f9..e9a7a32a3720f1faed833d6bf91d4c207e78e6ae 100644 (file)
--- a/src/generic/spinctlg.cpp
+++ b/src/generic/spinctlg.cpp
@@ -6,7 +6,7 @@
 // Created:     29.01.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     29.01.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// License:     wxWindows licence
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -29,6 +29,7 @@
 #endif //WX_PRECOMP
 
 #include "wx/spinctrl.h"
 #endif //WX_PRECOMP
 
 #include "wx/spinctrl.h"

+#include "wx/tooltip.h"

 
 #if wxUSE_SPINCTRL
 
 
 #if wxUSE_SPINCTRL
 


@@ -46,8 +47,12 @@ IMPLEMENT_DYNAMIC_CLASS(wxSpinDoubleEvent, wxNotifyEvent)
 // constants
 // ----------------------------------------------------------------------------
 
 // constants
 // ----------------------------------------------------------------------------
 

-// the margin between the text control and the spin
-static const wxCoord MARGIN = 2;
+// The margin between the text control and the spin: the value here is the same
+// as the margin between the spin button and its "buddy" text control in wxMSW
+// so the generic control looks similarly to the native one there, we might
+// need to use different value for the other platforms (and maybe even
+// determine it dynamically?).
+static const wxCoord MARGIN = 1;

 
 #define SPINCTRLBUT_MAX 32000 // large to avoid wrap around trouble
 
 
 #define SPINCTRLBUT_MAX 32000 // large to avoid wrap around trouble
 


@@ -58,9 +63,9 @@ static const wxCoord MARGIN = 2;
 class wxSpinCtrlTextGeneric : public wxTextCtrl
 {
 public:
 class wxSpinCtrlTextGeneric : public wxTextCtrl
 {
 public:

-    wxSpinCtrlTextGeneric(wxSpinCtrlGenericBase *spin, const wxString& value)
-        : wxTextCtrl(spin->GetParent(), wxID_ANY, value, wxDefaultPosition,
-                     wxDefaultSize, wxTE_NOHIDESEL|wxTE_PROCESS_ENTER)
+    wxSpinCtrlTextGeneric(wxSpinCtrlGenericBase *spin, const wxString& value, long style=0)
+        : wxTextCtrl(spin->GetParent(), wxID_ANY, value, wxDefaultPosition, wxDefaultSize,
+                     style & wxALIGN_MASK)

     {
         m_spin = spin;
 
     {
         m_spin = spin;
 


@@ -77,25 +82,16 @@ public:
         m_spin = NULL;
     }
 
         m_spin = NULL;
     }
 

-    void OnTextEnter(wxCommandEvent& event)
-    {
-        if (m_spin)
-            m_spin->OnTextEnter(event);
-    }
-

     void OnChar( wxKeyEvent &event )
     {
         if (m_spin)
     void OnChar( wxKeyEvent &event )
     {
         if (m_spin)

-            m_spin->OnTextChar(event);
+            m_spin->ProcessWindowEvent(event);

     }
 
     void OnKillFocus(wxFocusEvent& event)
     {
         if (m_spin)
     }
 
     void OnKillFocus(wxFocusEvent& event)
     {
         if (m_spin)

-        {
-            m_spin->SyncSpinToText();
-            m_spin->DoSendEvent();
-        }
+            m_spin->ProcessWindowEvent(event);

 
         event.Skip();
     }
 
         event.Skip();
     }


@@ -107,8 +103,6 @@ private:
 };
 
 BEGIN_EVENT_TABLE(wxSpinCtrlTextGeneric, wxTextCtrl)
 };
 
 BEGIN_EVENT_TABLE(wxSpinCtrlTextGeneric, wxTextCtrl)

-    EVT_TEXT_ENTER(wxID_ANY, wxSpinCtrlTextGeneric::OnTextEnter)
-

     EVT_CHAR(wxSpinCtrlTextGeneric::OnChar)
 
     EVT_KILL_FOCUS(wxSpinCtrlTextGeneric::OnKillFocus)
     EVT_CHAR(wxSpinCtrlTextGeneric::OnChar)
 
     EVT_KILL_FOCUS(wxSpinCtrlTextGeneric::OnKillFocus)


@@ -197,8 +191,12 @@ bool wxSpinCtrlGenericBase::Create(wxWindow *parent,
     m_max   = max;
     m_increment = increment;
 
     m_max   = max;
     m_increment = increment;
 

-    m_textCtrl   = new wxSpinCtrlTextGeneric(this, value);
+    m_textCtrl   = new wxSpinCtrlTextGeneric(this, value, style);

     m_spinButton = new wxSpinCtrlButtonGeneric(this, style);
     m_spinButton = new wxSpinCtrlButtonGeneric(this, style);

+#if wxUSE_TOOLTIPS
+    m_textCtrl->SetToolTip(GetToolTipText());
+    m_spinButton->SetToolTip(GetToolTipText());
+#endif // wxUSE_TOOLTIPS

 
     m_spin_value = m_spinButton->GetValue();
 
 
     m_spin_value = m_spinButton->GetValue();
 


@@ -248,8 +246,7 @@ wxSpinCtrlGenericBase::~wxSpinCtrlGenericBase()
         delete text;
     }
 
         delete text;
     }
 

-    delete m_spinButton;
-    m_spinButton = NULL;
+    wxDELETE(m_spinButton);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -271,7 +268,7 @@ void wxSpinCtrlGenericBase::DoMoveWindow(int x, int y, int width, int height)
     // position the subcontrols inside the client area
     wxSize sizeBtn = m_spinButton->GetSize();
 
     // position the subcontrols inside the client area
     wxSize sizeBtn = m_spinButton->GetSize();
 

-    wxCoord wText = width - sizeBtn.x;
+    wxCoord wText = width - sizeBtn.x - MARGIN;

     m_textCtrl->SetSize(x, y, wText, height);
     m_spinButton->SetSize(x + wText + MARGIN, y, wxDefaultCoord, height);
 }
     m_textCtrl->SetSize(x, y, wText, height);
     m_spinButton->SetSize(x + wText + MARGIN, y, wxDefaultCoord, height);
 }


@@ -280,11 +277,22 @@ void wxSpinCtrlGenericBase::DoMoveWindow(int x, int y, int width, int height)
 // operations forwarded to the subcontrols
 // ----------------------------------------------------------------------------
 
 // operations forwarded to the subcontrols
 // ----------------------------------------------------------------------------
 

+void wxSpinCtrlGenericBase::SetFocus()
+{
+    if ( m_textCtrl )
+        m_textCtrl->SetFocus();
+}
+

 bool wxSpinCtrlGenericBase::Enable(bool enable)
 {
 bool wxSpinCtrlGenericBase::Enable(bool enable)
 {

-    if ( !wxControl::Enable(enable) )
+    // Notice that we never enable this control itself, it must stay disabled
+    // to avoid interfering with the siblings event handling (see e.g. #12045
+    // for the kind of problems which arise otherwise).
+    if ( enable == m_isEnabled )

         return false;
 
         return false;
 

+    m_isEnabled = enable;
+

     m_spinButton->Enable(enable);
     m_textCtrl->Enable(enable);
 
     m_spinButton->Enable(enable);
     m_textCtrl->Enable(enable);
 


@@ -318,18 +326,49 @@ bool wxSpinCtrlGenericBase::Reparent(wxWindowBase *newParent)
     return true;
 }
 
     return true;
 }
 

+#if wxUSE_TOOLTIPS
+void wxSpinCtrlGenericBase::DoSetToolTip(wxToolTip *tip)
+{
+    // Notice that we must check for the subcontrols not being NULL (as they
+    // could be if we were created with the default ctor and this is called
+    // before Create() for some reason) and that we can't call SetToolTip(tip)
+    // because this would take ownership of the wxToolTip object (twice).
+    if ( m_textCtrl )
+    {
+        if ( tip )
+            m_textCtrl->SetToolTip(tip->GetTip());
+        else
+            m_textCtrl->SetToolTip(NULL);
+    }
+
+    if ( m_spinButton )
+    {
+        if( tip )
+            m_spinButton->SetToolTip(tip->GetTip());
+        else
+            m_spinButton->SetToolTip(NULL);
+    }
+
+    wxWindowBase::DoSetToolTip(tip);
+}
+#endif // wxUSE_TOOLTIPS
+

 // ----------------------------------------------------------------------------
 // Handle sub controls events
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // Handle sub controls events
 // ----------------------------------------------------------------------------
 

+BEGIN_EVENT_TABLE(wxSpinCtrlGenericBase, wxSpinCtrlBase)
+    EVT_CHAR(wxSpinCtrlGenericBase::OnTextChar)
+    EVT_KILL_FOCUS(wxSpinCtrlGenericBase::OnTextLostFocus)
+END_EVENT_TABLE()
+

 void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent& event)
 {
     event.Skip();
 
     // Sync the textctrl since the user expects that the button will modify
     // what they see in the textctrl.
 void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent& event)
 {
     event.Skip();
 
     // Sync the textctrl since the user expects that the button will modify
     // what they see in the textctrl.

-    if ( m_textCtrl && m_textCtrl->IsModified() )
-        SyncSpinToText();
+    SyncSpinToText();

 
     int spin_value = event.GetPosition();
     double step = (event.GetEventType() == wxEVT_SCROLL_LINEUP) ? 1 : -1;
 
     int spin_value = event.GetPosition();
     double step = (event.GetEventType() == wxEVT_SCROLL_LINEUP) ? 1 : -1;


@@ -354,10 +393,11 @@ void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent& event)
         DoSendEvent();
 }
 
         DoSendEvent();
 }
 

-void wxSpinCtrlGenericBase::OnTextEnter(wxCommandEvent& event)
+void wxSpinCtrlGenericBase::OnTextLostFocus(wxFocusEvent& event)

 {
     SyncSpinToText();
     DoSendEvent();
 {
     SyncSpinToText();
     DoSendEvent();

+

     event.Skip();
 }
 
     event.Skip();
 }
 


@@ -395,8 +435,7 @@ void wxSpinCtrlGenericBase::OnTextChar(wxKeyEvent& event)
 
     value = AdjustToFitInRange(value);
 
 
     value = AdjustToFitInRange(value);
 

-    if ( m_textCtrl && m_textCtrl->IsModified() )
-        SyncSpinToText();
+    SyncSpinToText();

 
     if ( DoSetValue(value) )
         DoSendEvent();
 
     if ( DoSetValue(value) )
         DoSendEvent();


@@ -406,10 +445,10 @@ void wxSpinCtrlGenericBase::OnTextChar(wxKeyEvent& event)
 // Textctrl functions
 // ----------------------------------------------------------------------------
 
 // Textctrl functions
 // ----------------------------------------------------------------------------
 

-void wxSpinCtrlGenericBase::SyncSpinToText()
+bool wxSpinCtrlGenericBase::SyncSpinToText()

 {
 {

-    if (!m_textCtrl)
-        return;
+    if ( !m_textCtrl || !m_textCtrl->IsModified() )
+        return false;

 
     double textValue;
     if ( m_textCtrl->GetValue().ToDouble(&textValue) )
 
     double textValue;
     if ( m_textCtrl->GetValue().ToDouble(&textValue) )


@@ -418,17 +457,17 @@ void wxSpinCtrlGenericBase::SyncSpinToText()
             textValue = m_max;
         else if (textValue < m_min)
             textValue = m_min;
             textValue = m_max;
         else if (textValue < m_min)
             textValue = m_min;

-
-        if (m_value != textValue)
-        {
-            DoSetValue(textValue);
-        }

     }
     }

-    else
+    else // text contents is not a valid number at all

     {
     {

-        // textctrl is out of sync, discard and reset
-        DoSetValue(m_value);
+        // replace its contents with the last valid value
+        textValue = m_value;

     }
     }

+
+    // we must always set the value here, even if it's equal to m_value, as
+    // otherwise we could be left with an out of range value when leaving the
+    // text control and the current value is already m_max for example
+    return DoSetValue(textValue);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -437,7 +476,7 @@ void wxSpinCtrlGenericBase::SyncSpinToText()
 
 void wxSpinCtrlGenericBase::SetValue(const wxString& text)
 {
 
 void wxSpinCtrlGenericBase::SetValue(const wxString& text)
 {

-    wxCHECK_RET( m_textCtrl, _T("invalid call to wxSpinCtrl::SetValue") );
+    wxCHECK_RET( m_textCtrl, wxT("invalid call to wxSpinCtrl::SetValue") );

 
     double val;
     if ( text.ToDouble(&val) && InRange(val) )
 
     double val;
     if ( text.ToDouble(&val) && InRange(val) )


@@ -448,12 +487,13 @@ void wxSpinCtrlGenericBase::SetValue(const wxString& text)
     {
         m_textCtrl->SetValue(text);
         m_textCtrl->SetSelection(0, -1);
     {
         m_textCtrl->SetValue(text);
         m_textCtrl->SetSelection(0, -1);

+        m_textCtrl->SetInsertionPointEnd();

     }
 }
 
 bool wxSpinCtrlGenericBase::DoSetValue(double val)
 {
     }
 }
 
 bool wxSpinCtrlGenericBase::DoSetValue(double val)
 {

-    wxCHECK_MSG( m_textCtrl, false, _T("invalid call to wxSpinCtrl::SetValue") );
+    wxCHECK_MSG( m_textCtrl, false, wxT("invalid call to wxSpinCtrl::SetValue") );

 
     if (!InRange(val))
         return false;
 
     if (!InRange(val))
         return false;


@@ -478,6 +518,7 @@ bool wxSpinCtrlGenericBase::DoSetValue(double val)
         m_value = val;
         str.ToDouble( &m_value );    // wysiwyg for textctrl
         m_textCtrl->SetValue( str );
         m_value = val;
         str.ToDouble( &m_value );    // wysiwyg for textctrl
         m_textCtrl->SetValue( str );

+        m_textCtrl->SetInsertionPointEnd();

         m_textCtrl->DiscardEdits();
         return true;
     }
         m_textCtrl->DiscardEdits();
         return true;
     }


@@ -514,7 +555,7 @@ void wxSpinCtrlGenericBase::SetSnapToTicks(bool snap_to_ticks)
 
 void wxSpinCtrlGenericBase::SetSelection(long from, long to)
 {
 
 void wxSpinCtrlGenericBase::SetSelection(long from, long to)
 {

-    wxCHECK_RET( m_textCtrl, _T("invalid call to wxSpinCtrl::SetSelection") );
+    wxCHECK_RET( m_textCtrl, wxT("invalid call to wxSpinCtrl::SetSelection") );

 
     m_textCtrl->SetSelection(from, to);
 }
 
     m_textCtrl->SetSelection(from, to);
 }


@@ -525,8 +566,6 @@ void wxSpinCtrlGenericBase::SetSelection(long from, long to)
 // wxSpinCtrl
 //-----------------------------------------------------------------------------
 
 // wxSpinCtrl
 //-----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxSpinCtrlGenericBase)
-

 void wxSpinCtrl::DoSendEvent()
 {
     wxSpinEvent event( wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
 void wxSpinCtrl::DoSendEvent()
 {
     wxSpinEvent event( wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());


@@ -557,6 +596,11 @@ void wxSpinCtrlDouble::SetDigits(unsigned digits)
 {
     wxCHECK_RET( digits <= 20, "too many digits for wxSpinCtrlDouble" );
 
 {
     wxCHECK_RET( digits <= 20, "too many digits for wxSpinCtrlDouble" );
 

+    if ( digits == m_digits )
+        return;
+
+    m_digits = digits;
+

     m_format.Printf(wxT("%%0.%ulf"), digits);
 
     DoSetValue(m_value);
     m_format.Printf(wxT("%%0.%ulf"), digits);
 
     DoSetValue(m_value);