]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/spinctrl.cpp
[ 1509599 ] 'Split pickers page in widgets sample' with more icons and rebaking.
[wxWidgets.git] / src / msw / spinctrl.cpp
index 133cba42e74b5c2b3e2aeb79554e50a4d38d8172..dbc1bdd3ff8c9b95b66c475b2fb74950d35cbb85 100644 (file)
@@ -5,7 +5,7 @@
 // Modified by:
 // Created:     22.07.99
 // RCS-ID:      $Id$
-// Copyright:   (c) Vadim Zeitlin
+// Copyright:   (c) 1999-2005 Vadim Zeitlin
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // declarations
 // ============================================================================
 
-#ifdef __GNUG__
-    #pragma implementation "spinctrlbase.h"
-    #pragma implementation "spinctrl.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
     #include "wx/wx.h"
 #endif
 
-#if defined(__WIN95__)
+#if wxUSE_SPINCTRL
 
 #include "wx/spinctrl.h"
 #include "wx/msw/private.h"
+#include "wx/msw/wrapcctl.h"
+
+#if wxUSE_TOOLTIPS
+    #include "wx/tooltip.h"
+#endif // wxUSE_TOOLTIPS
 
-#include <commctrl.h>
+#include <limits.h>         // for INT_MIN
 
 // ----------------------------------------------------------------------------
 // macros
 // ----------------------------------------------------------------------------
 
-#if !USE_SHARED_LIBRARY
-    IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxControl)
+#if wxUSE_EXTENDED_RTTI
+WX_DEFINE_FLAGS( wxSpinCtrlStyle )
+
+wxBEGIN_FLAGS( wxSpinCtrlStyle )
+    // new style border flags, we put them first to
+    // use them for streaming out
+    wxFLAGS_MEMBER(wxBORDER_SIMPLE)
+    wxFLAGS_MEMBER(wxBORDER_SUNKEN)
+    wxFLAGS_MEMBER(wxBORDER_DOUBLE)
+    wxFLAGS_MEMBER(wxBORDER_RAISED)
+    wxFLAGS_MEMBER(wxBORDER_STATIC)
+    wxFLAGS_MEMBER(wxBORDER_NONE)
+
+    // old style border flags
+    wxFLAGS_MEMBER(wxSIMPLE_BORDER)
+    wxFLAGS_MEMBER(wxSUNKEN_BORDER)
+    wxFLAGS_MEMBER(wxDOUBLE_BORDER)
+    wxFLAGS_MEMBER(wxRAISED_BORDER)
+    wxFLAGS_MEMBER(wxSTATIC_BORDER)
+    wxFLAGS_MEMBER(wxBORDER)
+
+    // standard window styles
+    wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
+    wxFLAGS_MEMBER(wxCLIP_CHILDREN)
+    wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
+    wxFLAGS_MEMBER(wxWANTS_CHARS)
+    wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
+    wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
+    wxFLAGS_MEMBER(wxVSCROLL)
+    wxFLAGS_MEMBER(wxHSCROLL)
+
+    wxFLAGS_MEMBER(wxSP_HORIZONTAL)
+    wxFLAGS_MEMBER(wxSP_VERTICAL)
+    wxFLAGS_MEMBER(wxSP_ARROW_KEYS)
+    wxFLAGS_MEMBER(wxSP_WRAP)
+
+wxEND_FLAGS( wxSpinCtrlStyle )
+
+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_PROPERTY( Updated , wxEVT_COMMAND_SPINCTRL_UPDATED , wxCommandEvent )
+    wxEVENT_PROPERTY( TextUpdated , wxEVT_COMMAND_TEXT_UPDATED , wxCommandEvent )
+    wxEVENT_PROPERTY( TextEnter , wxEVT_COMMAND_TEXT_ENTER , wxCommandEvent )
+
+    wxPROPERTY( ValueString , wxString , SetValue , GetValue , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) ;
+    wxPROPERTY( Value , int , SetValue, GetValue, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+    wxPROPERTY( Min , int , SetMin, GetMin, 0, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
+    wxPROPERTY( Max , int , SetMax, GetMax, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+    wxPROPERTY_FLAGS( WindowStyle , wxSpinCtrlStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
+/*
+    TODO PROPERTIES
+        style wxSP_ARROW_KEYS
+*/
+wxEND_PROPERTIES_TABLE()
+
+wxBEGIN_HANDLERS_TABLE(wxSpinCtrl)
+wxEND_HANDLERS_TABLE()
+
+wxCONSTRUCTOR_6( wxSpinCtrl , wxWindow* , Parent , wxWindowID , Id , wxString , ValueString , wxPoint , Position , wxSize , Size , long , WindowStyle )
+#else
+IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxControl)
 #endif
 
+//pmg EVT_KILL_FOCUS
+BEGIN_EVENT_TABLE(wxSpinCtrl, wxSpinButton)
+    EVT_CHAR(wxSpinCtrl::OnChar)
+
+    EVT_SET_FOCUS(wxSpinCtrl::OnSetFocus)
+    EVT_KILL_FOCUS(wxSpinCtrl::OnKillFocus)
+    EVT_SPIN(wxID_ANY, wxSpinCtrl::OnSpinChange)
+END_EVENT_TABLE()
+
+#define GetBuddyHwnd()      (HWND)(m_hwndBuddy)
+
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
-// the margin between the up-down control and its buddy
-static const int MARGIN_BETWEEN = 5;
+// the margin between the up-down control and its buddy (can be arbitrary,
+// choose what you like - or may be decide during run-time depending on the
+// font size?)
+static const int MARGIN_BETWEEN = 1;
 
 // ============================================================================
 // implementation
 // ============================================================================
 
+wxArraySpins wxSpinCtrl::ms_allSpins;
+
+// ----------------------------------------------------------------------------
+// wnd proc for the buddy text ctrl
+// ----------------------------------------------------------------------------
+
+LRESULT APIENTRY _EXPORT wxBuddyTextWndProc(HWND hwnd,
+                                            UINT message,
+                                            WPARAM wParam,
+                                            LPARAM lParam)
+{
+    wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData(hwnd);
+
+    // forward some messages (the key and focus ones only so far) to
+    // the spin ctrl
+    switch ( message )
+    {
+        case WM_SETFOCUS:
+            // if the focus comes from the spin control itself, don't set it
+            // back to it -- we don't want to go into an infinite loop
+            if ( (WXHWND)wParam == spin->GetHWND() )
+                break;
+            //else: fall through
+
+        case WM_KILLFOCUS:
+        case WM_CHAR:
+        case WM_DEADCHAR:
+        case WM_KEYUP:
+        case WM_KEYDOWN:
+            spin->MSWWindowProc(message, wParam, lParam);
+
+            // The control may have been deleted at this point, so check.
+            if ( !::IsWindow(hwnd) || wxGetWindowUserData(hwnd) != spin )
+                return 0;
+            break;
+
+        case WM_GETDLGCODE:
+            // we want to get WXK_RETURN in order to generate the event for it
+            return DLGC_WANTCHARS;
+    }
+
+    return ::CallWindowProc(CASTWNDPROC spin->GetBuddyWndProc(),
+                            hwnd, message, wParam, lParam);
+}
+
+/* static */
+wxSpinCtrl *wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy)
+{
+    wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData((HWND)hwndBuddy);
+
+    int i = ms_allSpins.Index(spin);
+
+    if ( i == wxNOT_FOUND )
+        return NULL;
+
+    // sanity check
+    wxASSERT_MSG( spin->m_hwndBuddy == hwndBuddy,
+                  _T("wxSpinCtrl has incorrect buddy HWND!") );
+
+    return spin;
+}
+
+// process a WM_COMMAND generated by the buddy text control
+bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd, WXWORD WXUNUSED(id))
+{
+    switch (cmd)
+    {
+    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;
+    }
+
+    // not processed
+    return false;
+}
+
+void wxSpinCtrl::OnChar(wxKeyEvent& event)
+{
+    switch ( event.GetKeyCode() )
+    {
+        case WXK_RETURN:
+            {
+                wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
+                InitCommandEvent(event);
+                wxString val = wxGetWindowText(m_hwndBuddy);
+                event.SetString(val);
+                event.SetInt(GetValue());
+                if ( GetEventHandler()->ProcessEvent(event) )
+                    return;
+                break;
+            }
+
+        case WXK_TAB:
+            // always produce navigation event - even if we process TAB
+            // ourselves the fact that we got here means that the user code
+            // decided to skip processing of this TAB - probably to let it
+            // do its default job.
+            {
+                wxNavigationKeyEvent eventNav;
+                eventNav.SetDirection(!event.ShiftDown());
+                eventNav.SetWindowChange(event.ControlDown());
+                eventNav.SetEventObject(this);
+
+                if ( GetParent()->GetEventHandler()->ProcessEvent(eventNav) )
+                    return;
+            }
+            break;
+    }
+
+    // no, we didn't process it
+    event.Skip();
+}
+
+void wxSpinCtrl::OnKillFocus(wxFocusEvent& event)
+{
+    // ensure that the value is shown correctly
+    SetValue(GetValue()) ; 
+    event.Skip();
+}
+
+void wxSpinCtrl::OnSetFocus(wxFocusEvent& event)
+{
+    // when we get focus, give it to our buddy window as it needs it more than
+    // we do
+    ::SetFocus((HWND)m_hwndBuddy);
+
+    event.Skip();
+}
+
 // ----------------------------------------------------------------------------
 // construction
 // ----------------------------------------------------------------------------
 
 bool wxSpinCtrl::Create(wxWindow *parent,
                         wxWindowID id,
+                        const wxString& value,
                         const wxPoint& pos,
                         const wxSize& size,
                         long style,
@@ -74,12 +295,30 @@ bool wxSpinCtrl::Create(wxWindow *parent,
     // 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)
-    SetWindowStyle(style | wxSP_VERTICAL);
+    style |= wxSP_VERTICAL;
+
+    if ( (style & wxBORDER_MASK) == wxBORDER_DEFAULT )
+#ifdef __WXWINCE__
+        style |= wxBORDER_SIMPLE;
+#else
+        style |= wxBORDER_SUNKEN;
+#endif
+
+    SetWindowStyle(style);
+
+    WXDWORD exStyle = 0;
+    WXDWORD msStyle = MSWGetStyle(GetWindowStyle(), & exStyle) ;
 
     // calculate the sizes: the size given is the toal 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;
+    if ( sizeText.x <= 0 )
+    {
+        // DEFAULT_ITEM_WIDTH is the default width for the text control
+        sizeText.x = DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN + sizeBtn.x;
+    }
+
     sizeText.x -= sizeBtn.x + MARGIN_BETWEEN;
     if ( sizeText.x <= 0 )
     {
@@ -89,79 +328,280 @@ bool wxSpinCtrl::Create(wxWindow *parent,
     wxPoint posBtn(pos);
     posBtn.x += sizeText.x + MARGIN_BETWEEN;
 
+    // we must create the text control before the spin button for the purpose
+    // of the dialog navigation: if there is a static text just before the spin
+    // control, activating it by Alt-letter should give focus to the text
+    // control, not the spin and the dialog navigation code will give focus to
+    // the next control (at Windows level), not the one after it
+
+    // create the text window
+
+    m_hwndBuddy = (WXHWND)::CreateWindowEx
+                    (
+                     exStyle,                // sunken border
+                     _T("EDIT"),             // window class
+                     NULL,                   // no window title
+                     msStyle,                // style (will be shown later)
+                     pos.x, pos.y,           // position
+                     0, 0,                   // size (will be set later)
+                     GetHwndOf(parent),      // parent
+                     (HMENU)-1,              // control id
+                     wxGetInstance(),        // app instance
+                     NULL                    // unused client data
+                    );
+
+    if ( !m_hwndBuddy )
+    {
+        wxLogLastError(wxT("CreateWindow(buddy text window)"));
+
+        return false;
+    }
+
+
     // create the spin button
     if ( !wxSpinButton::Create(parent, id, posBtn, sizeBtn, style, name) )
     {
-        return FALSE;
+        return false;
     }
 
     SetRange(min, max);
     SetValue(initial);
 
-    // create the text window
+    // subclass the text ctrl to be able to intercept some events
+    wxSetWindowUserData(GetBuddyHwnd(), this);
+    m_wndProcBuddy = (WXFARPROC)wxSetWindowProc(GetBuddyHwnd(),
+                                                wxBuddyTextWndProc);
+
+    // set up fonts and colours  (This is nomally done in MSWCreateControl)
+    InheritAttributes();
+    if (!m_hasFont)
+        SetFont(GetDefaultAttributes().font);
+
+    // set the size of the text window - can do it only now, because we
+    // couldn't call DoGetBestSize() before as font wasn't set
     if ( sizeText.y <= 0 )
     {
-        // make it the same height as the button then
-        int x, y;
-        wxSpinButton::DoGetSize(&x, &y);
+        int cx, cy;
+        wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
 
-        sizeText.y = y;
+        sizeText.y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
     }
 
-    m_hwndBuddy = (WXHWND)::CreateWindowEx
-                    (
-                     WS_EX_CLIENTEDGE,                  // sunken border
-                     _T("EDIT"),                        // window class
-                     NULL,                              // no window title
-                     WS_CHILD | WS_VISIBLE | WS_BORDER, // style
-                     pos.x, pos.y,                      // position
-                     sizeText.x, sizeText.y,            // size
-                     GetHwndOf(parent),                 // parent
-                     (HMENU)-1,                         // control id
-                     wxGetInstance(),                   // app instance
-                     NULL                               // unused client data
-                    );
+    SetBestSize(size);
 
-    if ( !m_hwndBuddy )
+    (void)::ShowWindow(GetBuddyHwnd(), SW_SHOW);
+
+    // associate the text window with the spin button
+    (void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)m_hwndBuddy, 0);
+
+    if ( !value.empty() )
     {
-        wxLogLastError("CreateWindow(buddy text window)");
+        SetValue(value);
+    }
+
+    // do it after finishing with m_hwndBuddy creation to avoid generating
+    // initial wxEVT_COMMAND_TEXT_UPDATED message
+    ms_allSpins.Add(this);
+
+    return true;
+}
+
+wxSpinCtrl::~wxSpinCtrl()
+{
+    ms_allSpins.Remove(this);
 
-        return FALSE;
+    // This removes spurious memory leak reporting
+    if (ms_allSpins.GetCount() == 0)
+        ms_allSpins.Clear();
+
+    // destroy the buddy window because this pointer which wxBuddyTextWndProc
+    // uses will not soon be valid any more
+    ::DestroyWindow(GetBuddyHwnd());
+}
+
+// ----------------------------------------------------------------------------
+// wxTextCtrl-like methods
+// ----------------------------------------------------------------------------
+
+void wxSpinCtrl::SetValue(const wxString& text)
+{
+    if ( !::SetWindowText(GetBuddyHwnd(), text.c_str()) )
+    {
+        wxLogLastError(wxT("SetWindowText(buddy)"));
     }
+}
 
-    // should have the same font as the other controls
-    WXHANDLE hFont = GetParent()->GetFont().GetResourceHandle();
-    ::SendMessage((HWND)m_hwndBuddy, WM_SETFONT, (WPARAM)hFont, TRUE);
+int wxSpinCtrl::GetValue() const
+{
+    wxString val = wxGetWindowText(m_hwndBuddy);
 
-    // associate the text window with the spin button
-    (void)SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)m_hwndBuddy, 0);
+    long n;
+    if ( (wxSscanf(val, wxT("%lu"), &n) != 1) )
+        n = INT_MIN;
 
-    return TRUE;
+    if (n < m_min) n = m_min;
+    if (n > m_max) n = m_max;
+
+    return n;
+}
+
+void wxSpinCtrl::SetSelection(long from, long to)
+{
+    // if from and to are both -1, it means (in wxWidgets) that all text should
+    // be selected - translate into Windows convention
+    if ( (from == -1) && (to == -1) )
+    {
+        from = 0;
+    }
+
+    ::SendMessage(GetBuddyHwnd(), EM_SETSEL, (WPARAM)from, (LPARAM)to);
+}
+
+// ----------------------------------------------------------------------------
+// forward some methods to subcontrols
+// ----------------------------------------------------------------------------
+
+bool wxSpinCtrl::SetFont(const wxFont& font)
+{
+    if ( !wxWindowBase::SetFont(font) )
+    {
+        // nothing to do
+        return false;
+    }
+
+    WXHANDLE hFont = GetFont().GetResourceHandle();
+    (void)::SendMessage(GetBuddyHwnd(), WM_SETFONT, (WPARAM)hFont, TRUE);
+
+    return true;
+}
+
+bool wxSpinCtrl::Show(bool show)
+{
+    if ( !wxControl::Show(show) )
+    {
+        return false;
+    }
+
+    ::ShowWindow(GetBuddyHwnd(), show ? SW_SHOW : SW_HIDE);
+
+    return true;
+}
+
+bool wxSpinCtrl::Enable(bool enable)
+{
+    if ( !wxControl::Enable(enable) )
+    {
+        return false;
+    }
+
+    ::EnableWindow(GetBuddyHwnd(), enable);
+
+    return true;
+}
+
+void wxSpinCtrl::SetFocus()
+{
+    ::SetFocus(GetBuddyHwnd());
+}
+
+#if wxUSE_TOOLTIPS
+
+void wxSpinCtrl::DoSetToolTip(wxToolTip *tip)
+{
+    wxSpinButton::DoSetToolTip(tip);
+
+    if ( tip )
+        tip->Add(m_hwndBuddy);
+}
+
+#endif // wxUSE_TOOLTIPS
+
+// ----------------------------------------------------------------------------
+// event processing
+// ----------------------------------------------------------------------------
+
+void wxSpinCtrl::OnSpinChange(wxSpinEvent& eventSpin)
+{
+    wxCommandEvent event(wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
+    event.SetEventObject(this);
+    event.SetInt(eventSpin.GetPosition());
+
+    (void)GetEventHandler()->ProcessEvent(event);
+
+    if ( eventSpin.GetSkipped() )
+    {
+        event.Skip();
+    }
 }
 
 // ----------------------------------------------------------------------------
 // size calculations
 // ----------------------------------------------------------------------------
 
+wxSize wxSpinCtrl::DoGetBestSize() const
+{
+    wxSize sizeBtn = wxSpinButton::DoGetBestSize();
+    sizeBtn.x += DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN;
+
+    int y;
+    wxGetCharSize(GetHWND(), NULL, &y, GetFont());
+    y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(y);
+
+    // JACS: we should always use the height calculated
+    // from above, because otherwise we'll get a spin control
+    // that's too big. So never use the height calculated
+    // from wxSpinButton::DoGetBestSize().
+
+    // if ( sizeBtn.y < y )
+    {
+        // make the text tall enough
+        sizeBtn.y = y;
+    }
+
+    return sizeBtn;
+}
+
 void wxSpinCtrl::DoMoveWindow(int x, int y, int width, int height)
 {
-    int widthBtn = DoGetBestSize().x;
+    int widthBtn = wxSpinButton::DoGetBestSize().x;
     int widthText = width - widthBtn - MARGIN_BETWEEN;
     if ( widthText <= 0 )
     {
         wxLogDebug(_T("not enough space for wxSpinCtrl!"));
     }
 
-    if ( !::MoveWindow((HWND)m_hwndBuddy, x, y, widthText, height, TRUE) )
-    {
-        wxLogLastError("MoveWindow(buddy)");
-    }
+    // 1) The buddy window
+    DoMoveSibling(m_hwndBuddy, x, y, widthText, height);
 
+    // 2) The button window
     x += widthText + MARGIN_BETWEEN;
-    if ( !::MoveWindow(GetHwnd(), x, y, widthBtn, height, TRUE) )
-    {
-        wxLogLastError("MoveWindow");
-    }
+    wxSpinButton::DoMoveWindow(x, y, widthBtn, height);
+}
+
+// get total size of the control
+void wxSpinCtrl::DoGetSize(int *x, int *y) const
+{
+    RECT spinrect, textrect, ctrlrect;
+    GetWindowRect(GetHwnd(), &spinrect);
+    GetWindowRect(GetBuddyHwnd(), &textrect);
+    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
+    WXHWND hWnd = GetHWND();
+    wxConstCast(this, wxSpinCtrl)->m_hWnd = m_hwndBuddy;
+
+    wxSpinButton::DoGetPosition(x, y);
+
+    wxConstCast(this, wxSpinCtrl)->m_hWnd = hWnd;
 }
 
-#endif // __WIN95__
+#endif // wxUSE_SPINCTRL
+