extract button size calculation from button label size to a separate function to...

[wxWidgets.git] / src / msw / spinctrl.cpp

diff --git a/src/msw/spinctrl.cpp b/src/msw/spinctrl.cpp
index 39960aed328749fe6025ebc65d313b2b25e38528..20df40a30e236828bde5e9fd358ff9d04f9f4b49 100644 (file)
--- a/src/msw/spinctrl.cpp
+++ b/src/msw/spinctrl.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        msw/spinctrl.cpp
+// Name:        src/msw/spinctrl.cpp

 // Purpose:     wxSpinCtrl class implementation for Win32
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     wxSpinCtrl class implementation for Win32
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -13,11 +13,6 @@
 // declarations
 // ============================================================================
 
 // declarations
 // ============================================================================
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "spinctrlbase.h"
-    #pragma implementation "spinctrl.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------


@@ -29,15 +24,18 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

-#ifndef WX_PRECOMP
-    #include "wx/wx.h"
-#endif
-

 #if wxUSE_SPINCTRL
 
 #include "wx/spinctrl.h"
 #if wxUSE_SPINCTRL
 
 #include "wx/spinctrl.h"

+
+#ifndef WX_PRECOMP
+    #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
+    #include "wx/event.h"
+    #include "wx/textctrl.h"
+    #include "wx/wxcrtvararg.h"
+#endif
+

 #include "wx/msw/private.h"
 #include "wx/msw/private.h"

-#include "wx/msw/wrapcctl.h"

 
 #if wxUSE_TOOLTIPS
     #include "wx/tooltip.h"
 
 #if wxUSE_TOOLTIPS
     #include "wx/tooltip.h"


@@ -45,9 +43,6 @@
 
 #include <limits.h>         // for INT_MIN
 
 
 #include <limits.h>         // for INT_MIN
 

-#define USE_DEFERRED_SIZING 1
-#define USE_DEFER_BUG_WORKAROUND 0
-

 // ----------------------------------------------------------------------------
 // macros
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // macros
 // ----------------------------------------------------------------------------


@@ -93,7 +88,7 @@ wxEND_FLAGS( wxSpinCtrlStyle )
 IMPLEMENT_DYNAMIC_CLASS_XTI(wxSpinCtrl, wxControl,"wx/spinbut.h")
 
 wxBEGIN_PROPERTIES_TABLE(wxSpinCtrl)
 IMPLEMENT_DYNAMIC_CLASS_XTI(wxSpinCtrl, wxControl,"wx/spinbut.h")
 
 wxBEGIN_PROPERTIES_TABLE(wxSpinCtrl)

-    wxEVENT_RANGE_PROPERTY( Spin , wxEVT_SCROLL_TOP , wxEVT_SCROLL_ENDSCROLL , wxSpinEvent )
+    wxEVENT_RANGE_PROPERTY( Spin , wxEVT_SCROLL_TOP , wxEVT_SCROLL_CHANGED , wxSpinEvent )

     wxEVENT_PROPERTY( Updated , wxEVT_COMMAND_SPINCTRL_UPDATED , wxCommandEvent )
     wxEVENT_PROPERTY( TextUpdated , wxEVT_COMMAND_TEXT_UPDATED , wxCommandEvent )
     wxEVENT_PROPERTY( TextEnter , wxEVT_COMMAND_TEXT_ENTER , wxCommandEvent )
     wxEVENT_PROPERTY( Updated , wxEVT_COMMAND_SPINCTRL_UPDATED , wxCommandEvent )
     wxEVENT_PROPERTY( TextUpdated , wxEVT_COMMAND_TEXT_UPDATED , wxCommandEvent )
     wxEVENT_PROPERTY( TextEnter , wxEVT_COMMAND_TEXT_ENTER , wxCommandEvent )


@@ -119,10 +114,8 @@ IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxControl)
 
 BEGIN_EVENT_TABLE(wxSpinCtrl, wxSpinButton)
     EVT_CHAR(wxSpinCtrl::OnChar)
 
 BEGIN_EVENT_TABLE(wxSpinCtrl, wxSpinButton)
     EVT_CHAR(wxSpinCtrl::OnChar)

-

     EVT_SET_FOCUS(wxSpinCtrl::OnSetFocus)
     EVT_SET_FOCUS(wxSpinCtrl::OnSetFocus)

-
-    EVT_SPIN(wxID_ANY, wxSpinCtrl::OnSpinChange)
+    EVT_KILL_FOCUS(wxSpinCtrl::OnKillFocus)

 END_EVENT_TABLE()
 
 #define GetBuddyHwnd()      (HWND)(m_hwndBuddy)
 END_EVENT_TABLE()
 
 #define GetBuddyHwnd()      (HWND)(m_hwndBuddy)


@@ -153,8 +146,7 @@ LRESULT APIENTRY _EXPORT wxBuddyTextWndProc(HWND hwnd,
 {
     wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData(hwnd);
 
 {
     wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData(hwnd);
 

-    // forward some messages (the key and focus ones only so far) to
-    // the spin ctrl
+    // forward some messages (mostly the key and focus ones) to the spin ctrl

     switch ( message )
     {
         case WM_SETFOCUS:
     switch ( message )
     {
         case WM_SETFOCUS:


@@ -169,6 +161,12 @@ LRESULT APIENTRY _EXPORT wxBuddyTextWndProc(HWND hwnd,
         case WM_DEADCHAR:
         case WM_KEYUP:
         case WM_KEYDOWN:
         case WM_DEADCHAR:
         case WM_KEYUP:
         case WM_KEYDOWN:

+#ifdef WM_HELP
+        // we need to forward WM_HELP too to ensure that the context help
+        // associated with wxSpinCtrl is shown when the text control part of it
+        // is clicked with the "?" cursor
+        case WM_HELP:
+#endif

             spin->MSWWindowProc(message, wParam, lParam);
 
             // The control may have been deleted at this point, so check.
             spin->MSWWindowProc(message, wParam, lParam);
 
             // The control may have been deleted at this point, so check.


@@ -178,7 +176,7 @@ LRESULT APIENTRY _EXPORT wxBuddyTextWndProc(HWND hwnd,
 
         case WM_GETDLGCODE:
             // we want to get WXK_RETURN in order to generate the event for it
 
         case WM_GETDLGCODE:
             // we want to get WXK_RETURN in order to generate the event for it

-            return DLGC_WANTCHARS;
+            return DLGC_WANTALLKEYS;

     }
 
     return ::CallWindowProc(CASTWNDPROC spin->GetBuddyWndProc(),
     }
 
     return ::CallWindowProc(CASTWNDPROC spin->GetBuddyWndProc(),


@@ -205,28 +203,14 @@ wxSpinCtrl *wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy)
 // process a WM_COMMAND generated by the buddy text control
 bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd, WXWORD WXUNUSED(id))
 {
 // process a WM_COMMAND generated by the buddy text control
 bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd, WXWORD WXUNUSED(id))
 {

-    switch (cmd)
+    if ( (cmd == EN_CHANGE) && (!m_blockEvent ))

     {
     {

-    case EN_CHANGE:
-        {
-            wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
-            event.SetEventObject(this);
-            wxString val = wxGetWindowText(m_hwndBuddy);
-            event.SetString(val);
-            event.SetInt(GetValue());
-            return GetEventHandler()->ProcessEvent(event);
-        }
-    case EN_SETFOCUS:
-    case EN_KILLFOCUS:
-        {
-            wxFocusEvent event(cmd == EN_KILLFOCUS ? wxEVT_KILL_FOCUS
-                    : wxEVT_SET_FOCUS,
-                    m_windowId);
-            event.SetEventObject( this );
-            return GetEventHandler()->ProcessEvent(event);
-        }
-     default:
-        break;
+        wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
+        event.SetEventObject(this);
+        wxString val = wxGetWindowText(m_hwndBuddy);
+        event.SetString(val);
+        event.SetInt(GetValue());
+        return HandleWindowEvent(event);

     }
 
     // not processed
     }
 
     // not processed


@@ -244,7 +228,7 @@ void wxSpinCtrl::OnChar(wxKeyEvent& event)
                 wxString val = wxGetWindowText(m_hwndBuddy);
                 event.SetString(val);
                 event.SetInt(GetValue());
                 wxString val = wxGetWindowText(m_hwndBuddy);
                 event.SetString(val);
                 event.SetInt(GetValue());

-                if ( GetEventHandler()->ProcessEvent(event) )
+                if ( HandleWindowEvent(event) )

                     return;
                 break;
             }
                     return;
                 break;
             }


@@ -260,7 +244,7 @@ void wxSpinCtrl::OnChar(wxKeyEvent& event)
                 eventNav.SetWindowChange(event.ControlDown());
                 eventNav.SetEventObject(this);
 
                 eventNav.SetWindowChange(event.ControlDown());
                 eventNav.SetEventObject(this);
 

-                if ( GetParent()->GetEventHandler()->ProcessEvent(eventNav) )
+                if ( GetParent()->HandleWindowEvent(eventNav) )

                     return;
             }
             break;
                     return;
             }
             break;


@@ -270,6 +254,13 @@ void wxSpinCtrl::OnChar(wxKeyEvent& event)
     event.Skip();
 }
 
     event.Skip();
 }
 

+void wxSpinCtrl::OnKillFocus(wxFocusEvent& event)
+{
+    // ensure that a correct value is shown by the control
+    NormalizeValue();
+    event.Skip();
+}
+

 void wxSpinCtrl::OnSetFocus(wxFocusEvent& event)
 {
     // when we get focus, give it to our buddy window as it needs it more than
 void wxSpinCtrl::OnSetFocus(wxFocusEvent& event)
 {
     // when we get focus, give it to our buddy window as it needs it more than


@@ -279,6 +270,22 @@ void wxSpinCtrl::OnSetFocus(wxFocusEvent& event)
     event.Skip();
 }
 
     event.Skip();
 }
 

+void wxSpinCtrl::NormalizeValue()
+{
+    const int value = GetValue();
+    const bool changed = value != m_oldValue;
+
+    // notice that we have to call SetValue() even if the value didn't change
+    // because otherwise we could be left with empty buddy control when value
+    // is 0, see comment in SetValue()
+    SetValue(value);
+
+    if ( changed )
+    {
+        SendSpinUpdate(value);
+    }
+}
+

 // ----------------------------------------------------------------------------
 // construction
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // construction
 // ----------------------------------------------------------------------------


@@ -292,6 +299,13 @@ bool wxSpinCtrl::Create(wxWindow *parent,
                         int min, int max, int initial,
                         const wxString& name)
 {
                         int min, int max, int initial,
                         const wxString& name)
 {

+    m_blockEvent = false;
+
+    // this should be in ctor/init function but I don't want to add one to 2.8
+    // to avoid problems with default ctor which can be inlined in the user
+    // code and so might not get this fix without recompilation
+    m_oldValue = INT_MIN;
+

     // before using DoGetBestSize(), have to set style to let the base class
     // know whether this is a horizontal or vertical control (we're always
     // vertical)
     // before using DoGetBestSize(), have to set style to let the base class
     // know whether this is a horizontal or vertical control (we're always
     // vertical)


@@ -309,7 +323,12 @@ bool wxSpinCtrl::Create(wxWindow *parent,
     WXDWORD exStyle = 0;
     WXDWORD msStyle = MSWGetStyle(GetWindowStyle(), & exStyle) ;
 
     WXDWORD exStyle = 0;
     WXDWORD msStyle = MSWGetStyle(GetWindowStyle(), & exStyle) ;
 

-    // calculate the sizes: the size given is the toal size for both controls
+    // this control is used for numeric entry so normally using these flags by
+    // default shouldn't be a problem, if it is we can always add a style such
+    // as wxSP_NON_NUMERIC later
+    msStyle |= ES_RIGHT | ES_NUMBER;
+
+    // calculate the sizes: the size given is the total size for both controls

     // and we need to fit them both in the given width (height is the same)
     wxSize sizeText(size), sizeBtn(size);
     sizeBtn.x = wxSpinButton::DoGetBestSize().x;
     // and we need to fit them both in the given width (height is the same)
     wxSize sizeText(size), sizeBtn(size);
     sizeBtn.x = wxSpinButton::DoGetBestSize().x;


@@ -364,8 +383,7 @@ bool wxSpinCtrl::Create(wxWindow *parent,
         return false;
     }
 
         return false;
     }
 

-    SetRange(min, max);
-    SetValue(initial);
+    wxSpinButtonBase::SetRange(min, max);

 
     // subclass the text ctrl to be able to intercept some events
     wxSetWindowUserData(GetBuddyHwnd(), this);
 
     // subclass the text ctrl to be able to intercept some events
     wxSetWindowUserData(GetBuddyHwnd(), this);


@@ -387,16 +405,27 @@ bool wxSpinCtrl::Create(wxWindow *parent,
         sizeText.y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
     }
 
         sizeText.y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
     }
 

-    SetBestSize(size);
+    SetInitialSize(size);

 
     (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW);
 
     // associate the text window with the spin button
     (void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)m_hwndBuddy, 0);
 
 
     (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW);
 
     // associate the text window with the spin button
     (void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)m_hwndBuddy, 0);
 

+    SetValue(initial);
+
+    // Set the range in the native control
+    SetRange(min, max);
+

     if ( !value.empty() )
     {
         SetValue(value);
     if ( !value.empty() )
     {
         SetValue(value);

+        m_oldValue = (int) wxAtol(value);
+    }
+    else
+    {
+        SetValue(wxString::Format(wxT("%d"), initial));
+        m_oldValue = initial;

     }
 
     // do it after finishing with m_hwndBuddy creation to avoid generating
     }
 
     // do it after finishing with m_hwndBuddy creation to avoid generating


@@ -431,16 +460,41 @@ void wxSpinCtrl::SetValue(const wxString& text)
     }
 }
 
     }
 }
 

+void  wxSpinCtrl::SetValue(int val)
+{
+    m_blockEvent = true;
+    
+    wxSpinButton::SetValue(val);
+
+    // normally setting the value of the spin button is enough as it updates
+    // its buddy control automatically ...
+    if ( wxGetWindowText(m_hwndBuddy).empty() )
+    {
+        // ... but sometimes it doesn't, notably when the value is 0 and the
+        // text control is currently empty, the spin button seems to be happy
+        // to leave it like this, while we really want to always show the
+        // current value in the control, so do it manually
+        ::SetWindowText(GetBuddyHwnd(),
+                        wxString::Format(_T("%d"), val).wx_str());
+    }
+
+    m_oldValue = GetValue();
+    
+    m_blockEvent = false;
+}
+

 int wxSpinCtrl::GetValue() const
 {
     wxString val = wxGetWindowText(m_hwndBuddy);
 
     long n;
 int wxSpinCtrl::GetValue() const
 {
     wxString val = wxGetWindowText(m_hwndBuddy);
 
     long n;

-    if ( (wxSscanf(val, wxT("%lu"), &n) != 1) )
+    if ( (wxSscanf(val, wxT("%ld"), &n) != 1) )

         n = INT_MIN;
 
         n = INT_MIN;
 

-    if (n < m_min) n = m_min;
-    if (n > m_max) n = m_max;
+    if ( n < m_min )
+        n = m_min;
+    if ( n > m_max )
+        n = m_max;

 
     return n;
 }
 
     return n;
 }


@@ -454,7 +508,7 @@ void wxSpinCtrl::SetSelection(long from, long to)
         from = 0;
     }
 
         from = 0;
     }
 

-    ::SendMessage((HWND)m_hwndBuddy, EM_SETSEL, (WPARAM)from, (LPARAM)to);
+    ::SendMessage(GetBuddyHwnd(), EM_SETSEL, (WPARAM)from, (LPARAM)to);

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


@@ -487,6 +541,46 @@ bool wxSpinCtrl::Show(bool show)
     return true;
 }
 
     return true;
 }
 

+bool wxSpinCtrl::Reparent(wxWindowBase *newParent)
+{
+    // Reparenting both the updown control and its buddy does not seem to work:
+    // they continue to be connected somehow, but visually there is no feedback
+    // on the buddy edit control. To avoid this problem, we reparent the buddy
+    // window normally, but we recreate the updown control and reassign its
+    // buddy.
+
+    if ( !wxWindowBase::Reparent(newParent) )
+        return false;
+
+    newParent->GetChildren().DeleteObject(this);
+
+    // preserve the old values
+    const wxSize size = GetSize();
+    int value = GetValue();
+    const wxRect btnRect = wxRectFromRECT(wxGetWindowRect(GetHwnd()));
+
+    // destroy the old spin button
+    UnsubclassWin();
+    if ( !::DestroyWindow(GetHwnd()) )
+        wxLogLastError(wxT("DestroyWindow"));
+
+    // create and initialize the new one
+    if ( !wxSpinButton::Create(GetParent(), GetId(),
+                               btnRect.GetPosition(), btnRect.GetSize(),
+                               GetWindowStyle(), GetName()) )
+        return false;
+
+    SetValue(value);
+    SetRange(m_min, m_max);
+    SetInitialSize(size);
+
+    // associate it with the buddy control again
+    ::SetParent(GetBuddyHwnd(), GetHwndOf(GetParent()));
+    (void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)GetBuddyHwnd(), 0);
+
+    return true;
+}
+

 bool wxSpinCtrl::Enable(bool enable)
 {
     if ( !wxControl::Enable(enable) )
 bool wxSpinCtrl::Enable(bool enable)
 {
     if ( !wxControl::Enable(enable) )


@@ -517,23 +611,51 @@ void wxSpinCtrl::DoSetToolTip(wxToolTip *tip)
 #endif // wxUSE_TOOLTIPS
 
 // ----------------------------------------------------------------------------
 #endif // wxUSE_TOOLTIPS
 
 // ----------------------------------------------------------------------------

-// event processing
+// events processing and generation

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-void wxSpinCtrl::OnSpinChange(wxSpinEvent& eventSpin)
+void wxSpinCtrl::SendSpinUpdate(int value)

 {
     wxCommandEvent event(wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
     event.SetEventObject(this);
 {
     wxCommandEvent event(wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
     event.SetEventObject(this);

-    event.SetInt(eventSpin.GetPosition());
+    event.SetInt(value);

 
 

-    (void)GetEventHandler()->ProcessEvent(event);
+    (void)HandleWindowEvent(event);

 
 

-    if ( eventSpin.GetSkipped() )
+    m_oldValue = value;
+}
+
+bool wxSpinCtrl::MSWOnScroll(int WXUNUSED(orientation), WXWORD wParam,
+                               WXWORD pos, WXHWND control)
+{
+    wxCHECK_MSG( control, false, wxT("scrolling what?") );
+
+    if ( wParam != SB_THUMBPOSITION )

     {
     {

-        event.Skip();
+        // probable SB_ENDSCROLL - we don't react to it
+        return false;

     }
     }

+
+    int new_value = (short) pos;
+    if (m_oldValue != new_value)
+       SendSpinUpdate( new_value );
+
+    return TRUE;
+}
+
+bool wxSpinCtrl::MSWOnNotify(int WXUNUSED(idCtrl), WXLPARAM lParam, WXLPARAM *result)
+{
+    NM_UPDOWN *lpnmud = (NM_UPDOWN *)lParam;
+
+    if (lpnmud->hdr.hwndFrom != GetHwnd()) // make sure it is the right control
+        return false;
+
+    *result = 0;  // never reject UP and DOWN events
+
+    return TRUE;

 }
 
 }
 

+

 // ----------------------------------------------------------------------------
 // size calculations
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // size calculations
 // ----------------------------------------------------------------------------


@@ -570,32 +692,12 @@ void wxSpinCtrl::DoMoveWindow(int x, int y, int width, int height)
         wxLogDebug(_T("not enough space for wxSpinCtrl!"));
     }
 
         wxLogDebug(_T("not enough space for wxSpinCtrl!"));
     }
 

-    // if our parent had prepared a defer window handle for us, use it (unless
-    // we are a top level window)
-    wxWindowMSW *parent = GetParent();
-
-#if USE_DEFERRED_SIZING
-    HDWP hdwp = parent && !IsTopLevel() ? (HDWP)parent->m_hDWP : NULL;
-#else
-    HDWP hdwp = 0;
-#endif
-

     // 1) The buddy window
     // 1) The buddy window

-    wxMoveWindowDeferred(hdwp, this, GetBuddyHwnd(),
-                     x, y, widthText, height);
+    DoMoveSibling(m_hwndBuddy, x, y, widthText, height);

 
     // 2) The button window
     x += widthText + MARGIN_BETWEEN;
 
     // 2) The button window
     x += widthText + MARGIN_BETWEEN;

-    wxMoveWindowDeferred(hdwp, this, GetHwnd(),
-                     x, y, widthBtn, height);
-
-#if USE_DEFERRED_SIZING
-    if (parent)
-    {
-        // hdwp must be updated as it may have been changed
-        parent->m_hDWP = (WXHANDLE)hdwp;
-    }
-#endif
+    wxSpinButton::DoMoveWindow(x, y, widthBtn, height);

 }
 
 // get total size of the control
 }
 
 // get total size of the control


@@ -612,6 +714,19 @@ void wxSpinCtrl::DoGetSize(int *x, int *y) const
         *y = ctrlrect.bottom - ctrlrect.top;
 }
 
         *y = ctrlrect.bottom - ctrlrect.top;
 }
 

+void wxSpinCtrl::DoGetClientSize(int *x, int *y) const
+{
+    RECT spinrect = wxGetClientRect(GetHwnd());
+    RECT textrect = wxGetClientRect(GetBuddyHwnd());
+    RECT ctrlrect;
+    UnionRect(&ctrlrect,&textrect, &spinrect);
+
+    if ( x )
+        *x = ctrlrect.right - ctrlrect.left;
+    if ( y )
+        *y = ctrlrect.bottom - ctrlrect.top;
+}
+

 void wxSpinCtrl::DoGetPosition(int *x, int *y) const
 {
     // hack: pretend that our HWND is the text control just for a moment
 void wxSpinCtrl::DoGetPosition(int *x, int *y) const
 {
     // hack: pretend that our HWND is the text control just for a moment


@@ -624,4 +739,3 @@ void wxSpinCtrl::DoGetPosition(int *x, int *y) const
 }
 
 #endif // wxUSE_SPINCTRL
 }
 
 #endif // wxUSE_SPINCTRL

-