Fix broken and missing DataView interface items for Phoenix

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

diff --git a/src/generic/spinctlg.cpp b/src/generic/spinctlg.cpp
index 21e2d60d974c5daf4bdb19e916a8243469c094ff..64d00b43ffa7e05542077dae0d069d2998d18ef5 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,13 @@ 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,
+                     // This is tricky: we want to honour any alignment flags
+                     // but not wxALIGN_CENTER_VERTICAL because it's the same
+                     // as wxTE_PASSWORD and we definitely don't want to show
+                     // asterisks in spin control.
+                     style & (wxALIGN_MASK | wxTE_PROCESS_ENTER) & ~wxTE_PASSWORD)

     {
         m_spin = spin;
 
     {
         m_spin = spin;
 


@@ -77,25 +86,24 @@ public:
         m_spin = NULL;
     }
 
         m_spin = NULL;
     }
 

-    void OnTextEnter(wxCommandEvent& event)
+    void OnChar( wxKeyEvent &event )

     {
     {

-        if (m_spin)
-            m_spin->OnTextEnter(event);
+        if ( !m_spin->ProcessWindowEvent(event) )
+            event.Skip();

     }
 
     }
 

-    void OnChar( wxKeyEvent &event )
+    void OnTextEvent(wxCommandEvent& event)

     {
     {

-        if (m_spin)
-            m_spin->OnTextChar(event);
+        wxCommandEvent eventCopy(event);
+        eventCopy.SetEventObject(m_spin);
+        eventCopy.SetId(m_spin->GetId());
+        m_spin->ProcessWindowEvent(eventCopy);

     }
 
     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,10 +115,17 @@ private:
 };
 
 BEGIN_EVENT_TABLE(wxSpinCtrlTextGeneric, wxTextCtrl)
 };
 
 BEGIN_EVENT_TABLE(wxSpinCtrlTextGeneric, wxTextCtrl)

-    EVT_TEXT_ENTER(wxID_ANY, wxSpinCtrlTextGeneric::OnTextEnter)
-

     EVT_CHAR(wxSpinCtrlTextGeneric::OnChar)
 
     EVT_CHAR(wxSpinCtrlTextGeneric::OnChar)
 

+    // Forward the text events to wxSpinCtrl itself adjusting them slightly in
+    // the process.
+    EVT_TEXT(wxID_ANY, wxSpinCtrlTextGeneric::OnTextEvent)
+
+    // And we need to forward this one too as wxSpinCtrl is supposed to
+    // generate it if wxTE_PROCESS_ENTER is used with it (and if it isn't,
+    // we're never going to get EVT_TEXT_ENTER in the first place).
+    EVT_TEXT_ENTER(wxID_ANY, wxSpinCtrlTextGeneric::OnTextEvent)
+

     EVT_KILL_FOCUS(wxSpinCtrlTextGeneric::OnKillFocus)
 END_EVENT_TABLE()
 
     EVT_KILL_FOCUS(wxSpinCtrlTextGeneric::OnKillFocus)
 END_EVENT_TABLE()
 


@@ -165,7 +180,6 @@ void wxSpinCtrlGenericBase::Init()
     m_max           = 100;
     m_increment     = 1;
     m_snap_to_ticks = false;
     m_max           = 100;
     m_increment     = 1;
     m_snap_to_ticks = false;

-    m_format        = wxS("%g");

 
     m_spin_value    = 0;
 
 
     m_spin_value    = 0;
 


@@ -197,8 +211,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();
 


@@ -209,10 +227,10 @@ bool wxSpinCtrlGenericBase::Create(wxWindow *parent,
     if ( !value.empty() )
     {
         double d;
     if ( !value.empty() )
     {
         double d;

-        if ( value.ToDouble(&d) )
+        if ( DoTextToValue(value, &d) )

         {
             m_value = d;
         {
             m_value = d;

-            m_textCtrl->SetValue(wxString::Format(m_format, m_value));
+            m_textCtrl->SetValue(DoValueToText(m_value));

         }
     }
 
         }
     }
 


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

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

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


@@ -271,7 +288,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,9 +297,28 @@ 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();
+}
+
+#ifdef __WXMSW__
+
+void wxSpinCtrlGenericBase::DoEnable(bool enable)
+{
+    // 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 )
+        wxSpinCtrlBase::DoEnable(enable);
+}
+
+#endif // __WXMSW__
+

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

-    if ( !wxControl::Enable(enable) )
+    if ( !wxSpinCtrlBase::Enable(enable) )

         return false;
 
     m_spinButton->Enable(enable);
         return false;
 
     m_spinButton->Enable(enable);


@@ -307,29 +343,49 @@ bool wxSpinCtrlGenericBase::Show(bool show)
     return true;
 }
 
     return true;
 }
 

-bool wxSpinCtrlGenericBase::Reparent(wxWindowBase *newParent)
+#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 ( m_spinButton )
     {

-        m_spinButton->Reparent(newParent);
-        m_textCtrl->Reparent(newParent);
+        if( tip )
+            m_spinButton->SetToolTip(tip->GetTip());
+        else
+            m_spinButton->SetToolTip(NULL);

     }
 
     }
 

-    return true;
+    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;


@@ -338,13 +394,7 @@ void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent& event)
     if (((spin_value >= 0) && (m_spin_value >= 0)) || ((spin_value <= 0) && (m_spin_value <= 0)))
         step *= abs(spin_value - m_spin_value);
 
     if (((spin_value >= 0) && (m_spin_value >= 0)) || ((spin_value <= 0) && (m_spin_value <= 0)))
         step *= abs(spin_value - m_spin_value);
 

-    double value = m_value + step*m_increment;
-
-    // Check for over/underflow wrapping around if necessary
-    if (value < m_min)
-        value = HasFlag(wxSP_WRAP) ? m_max : m_min;
-    if (value > m_max)
-        value = HasFlag(wxSP_WRAP) ? m_min : m_max;
+    double value = AdjustToFitInRange(m_value + step*m_increment);

 
     // Ignore the edges when it wraps since the up/down event may be opposite
     // They are in GTK and Mac
 
     // Ignore the edges when it wraps since the up/down event may be opposite
     // They are in GTK and Mac


@@ -356,14 +406,15 @@ void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent& event)
 
     m_spin_value = spin_value;
 
 
     m_spin_value = spin_value;
 

-    if (InRange(value) && DoSetValue(value))
+    if ( DoSetValue(value) )

         DoSendEvent();
 }
 
         DoSendEvent();
 }
 

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

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

+

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


@@ -399,8 +450,9 @@ void wxSpinCtrlGenericBase::OnTextChar(wxKeyEvent& event)
             return;
     }
 
             return;
     }
 

-    if ( m_textCtrl && m_textCtrl->IsModified() )
-        SyncSpinToText();
+    value = AdjustToFitInRange(value);
+
+    SyncSpinToText();

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


@@ -410,29 +462,29 @@ 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;
 
     double textValue;

-    if ( m_textCtrl->GetValue().ToDouble(&textValue) )
+    if ( DoTextToValue(m_textCtrl->GetValue(), &textValue) )

     {
         if (textValue > m_max)
             textValue = m_max;
         else if (textValue < m_min)
             textValue = m_min;
     {
         if (textValue > m_max)
             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);

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


@@ -441,10 +493,10 @@ 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;
 
     double val;

-    if ( text.ToDouble(&val) && InRange(val) )
+    if ( DoTextToValue(text, &val) && InRange(val) )

     {
         DoSetValue(val);
     }
     {
         DoSetValue(val);
     }


@@ -452,12 +504,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;


@@ -475,13 +528,14 @@ bool wxSpinCtrlGenericBase::DoSetValue(double val)
         }
     }
 
         }
     }
 

-    wxString str(wxString::Format(m_format.c_str(), val));
+    wxString str(DoValueToText(val));

 
     if ((val != m_value) || (str != m_textCtrl->GetValue()))
     {
 
     if ((val != m_value) || (str != m_textCtrl->GetValue()))
     {

-        m_value = val;
-        str.ToDouble( &m_value );    // wysiwyg for textctrl
+        if ( !DoTextToValue(str, &m_value ) )    // wysiwyg for textctrl
+            m_value = val;

         m_textCtrl->SetValue( str );
         m_textCtrl->SetValue( str );

+        m_textCtrl->SetInsertionPointEnd();

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


@@ -489,6 +543,16 @@ bool wxSpinCtrlGenericBase::DoSetValue(double val)
     return false;
 }
 
     return false;
 }
 

+double wxSpinCtrlGenericBase::AdjustToFitInRange(double value) const
+{
+    if (value < m_min)
+        value = HasFlag(wxSP_WRAP) ? m_max : m_min;
+    if (value > m_max)
+        value = HasFlag(wxSP_WRAP) ? m_min : m_max;
+
+    return value;
+}
+

 void wxSpinCtrlGenericBase::DoSetRange(double min, double max)
 {
     m_min = min;
 void wxSpinCtrlGenericBase::DoSetRange(double min, double max)
 {
     m_min = min;


@@ -508,7 +572,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);
 }


@@ -519,7 +583,29 @@ void wxSpinCtrlGenericBase::SetSelection(long from, long to)
 // wxSpinCtrl
 //-----------------------------------------------------------------------------
 
 // wxSpinCtrl
 //-----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxSpinCtrlGenericBase)
+bool wxSpinCtrl::SetBase(int base)
+{
+    // Currently we only support base 10 and 16. We could add support for base
+    // 8 quite easily but wxMSW doesn't support it natively so don't bother.
+    if ( base != 10 && base != 16 )
+        return false;
+
+    if ( base == m_base )
+        return true;
+
+    // Update the current control contents to show in the new base: be careful
+    // to call DoTextToValue() before changing the base...
+    double val;
+    const bool hasValidVal = DoTextToValue(m_textCtrl->GetValue(), &val);
+
+    m_base = base;
+
+    // ... but DoValueToText() after doing it.
+    if ( hasValidVal )
+        m_textCtrl->SetValue(DoValueToText(val));
+
+    return true;
+}

 
 void wxSpinCtrl::DoSendEvent()
 {
 
 void wxSpinCtrl::DoSendEvent()
 {


@@ -530,6 +616,34 @@ void wxSpinCtrl::DoSendEvent()
     GetEventHandler()->ProcessEvent( event );
 }
 
     GetEventHandler()->ProcessEvent( event );
 }
 

+bool wxSpinCtrl::DoTextToValue(const wxString& text, double *val)
+{
+    long lval;
+    if ( !text.ToLong(&lval, GetBase()) )
+        return false;
+
+    *val = static_cast<double>(lval);
+
+    return true;
+}
+
+wxString wxSpinCtrl::DoValueToText(double val)
+{
+    switch ( GetBase() )
+    {
+        case 16:
+            return wxPrivate::wxSpinCtrlFormatAsHex(static_cast<long>(val),
+                                                    GetMax());
+
+        default:
+            wxFAIL_MSG( wxS("Unsupported spin control base") );
+            // Fall through
+
+        case 10:
+            return wxString::Format("%ld", static_cast<long>(val));
+    }
+}
+

 #endif // !wxHAS_NATIVE_SPINCTRL
 
 //-----------------------------------------------------------------------------
 #endif // !wxHAS_NATIVE_SPINCTRL
 
 //-----------------------------------------------------------------------------


@@ -547,10 +661,25 @@ void wxSpinCtrlDouble::DoSendEvent()
     GetEventHandler()->ProcessEvent( event );
 }
 
     GetEventHandler()->ProcessEvent( event );
 }
 

+bool wxSpinCtrlDouble::DoTextToValue(const wxString& text, double *val)
+{
+    return text.ToDouble(val);
+}
+
+wxString wxSpinCtrlDouble::DoValueToText(double val)
+{
+    return wxString::Format(m_format, val);
+}
+

 void wxSpinCtrlDouble::SetDigits(unsigned digits)
 {
     wxCHECK_RET( digits <= 20, "too many digits for wxSpinCtrlDouble" );
 
 void wxSpinCtrlDouble::SetDigits(unsigned digits)
 {
     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);