X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7d86a2d45c1c08cbd64ca1f619b1adeb2c390665..8a31648287be0ef976f133de2786b137f1e98340:/src/msw/spinctrl.cpp diff --git a/src/msw/spinctrl.cpp b/src/msw/spinctrl.cpp index 93eeaf4a39..6cc84eac58 100644 --- 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: @@ -13,11 +13,6 @@ // declarations // ============================================================================ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation "spinctrlbase.h" - #pragma implementation "spinctrl.h" -#endif - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- @@ -29,15 +24,19 @@ #pragma hdrstop #endif -#ifndef WX_PRECOMP - #include "wx/wx.h" -#endif - #if wxUSE_SPINCTRL #include "wx/spinctrl.h" + +#ifndef WX_PRECOMP + #include "wx/hashmap.h" + #include "wx/msw/wrapcctl.h" // include "properly" + #include "wx/event.h" + #include "wx/textctrl.h" + #include "wx/wxcrtvararg.h" +#endif + #include "wx/msw/private.h" -#include "wx/msw/wrapcctl.h" #if wxUSE_TOOLTIPS #include "wx/tooltip.h" @@ -49,77 +48,10 @@ // macros // ---------------------------------------------------------------------------- -#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 - BEGIN_EVENT_TABLE(wxSpinCtrl, wxSpinButton) EVT_CHAR(wxSpinCtrl::OnChar) - EVT_SET_FOCUS(wxSpinCtrl::OnSetFocus) - - EVT_SPIN(wxID_ANY, wxSpinCtrl::OnSpinChange) + EVT_KILL_FOCUS(wxSpinCtrl::OnKillFocus) END_EVENT_TABLE() #define GetBuddyHwnd() (HWND)(m_hwndBuddy) @@ -133,12 +65,28 @@ END_EVENT_TABLE() // font size?) static const int MARGIN_BETWEEN = 1; + +// --------------------------------------------------------------------------- +// global vars +// --------------------------------------------------------------------------- + +namespace +{ + +// Global hash used to find the spin control corresponding to the given buddy +// text control HWND. +WX_DECLARE_HASH_MAP(HWND, wxSpinCtrl *, + wxPointerHash, wxPointerEqual, + SpinForTextCtrl); + +SpinForTextCtrl gs_spinForTextCtrl; + +} // anonymous namespace + // ============================================================================ // implementation // ============================================================================ -wxArraySpins wxSpinCtrl::ms_allSpins; - // ---------------------------------------------------------------------------- // wnd proc for the buddy text ctrl // ---------------------------------------------------------------------------- @@ -148,10 +96,9 @@ LRESULT APIENTRY _EXPORT wxBuddyTextWndProc(HWND hwnd, WPARAM wParam, LPARAM lParam) { - wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData(hwnd); + wxSpinCtrl * const spin = wxSpinCtrl::GetSpinForTextCtrl(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: @@ -166,16 +113,44 @@ LRESULT APIENTRY _EXPORT wxBuddyTextWndProc(HWND hwnd, 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; +#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 + { + WXLRESULT result; + if ( spin->MSWHandleMessage(&result, message, wParam, lParam) ) + { + // Do not let the message be processed by the window proc + // of the text control if it had been already handled at wx + // level, this is consistent with what happens for normal, + // non-composite controls. + return 0; + } + + // The control may have been deleted at this point, so check. + if ( !::IsWindow(hwnd) ) + return 0; + } break; case WM_GETDLGCODE: - // we want to get WXK_RETURN in order to generate the event for it - return DLGC_WANTCHARS; + if ( spin->HasFlag(wxTE_PROCESS_ENTER) ) + { + long dlgCode = ::CallWindowProc + ( + CASTWNDPROC spin->GetBuddyWndProc(), + hwnd, + message, + wParam, + lParam + ); + dlgCode |= DLGC_WANTMESSAGE; + return dlgCode; + } + break; } return ::CallWindowProc(CASTWNDPROC spin->GetBuddyWndProc(), @@ -185,16 +160,16 @@ LRESULT APIENTRY _EXPORT wxBuddyTextWndProc(HWND hwnd, /* static */ wxSpinCtrl *wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy) { - wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData((HWND)hwndBuddy); - - int i = ms_allSpins.Index(spin); - - if ( i == wxNOT_FOUND ) + const SpinForTextCtrl::const_iterator + it = gs_spinForTextCtrl.find(hwndBuddy); + if ( it == gs_spinForTextCtrl.end() ) return NULL; + wxSpinCtrl * const spin = it->second; + // sanity check wxASSERT_MSG( spin->m_hwndBuddy == hwndBuddy, - _T("wxSpinCtrl has incorrect buddy HWND!") ); + wxT("wxSpinCtrl has incorrect buddy HWND!") ); return spin; } @@ -202,28 +177,14 @@ wxSpinCtrl *wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy) // 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 @@ -241,7 +202,7 @@ void wxSpinCtrl::OnChar(wxKeyEvent& event) wxString val = wxGetWindowText(m_hwndBuddy); event.SetString(val); event.SetInt(GetValue()); - if ( GetEventHandler()->ProcessEvent(event) ) + if ( HandleWindowEvent(event) ) return; break; } @@ -257,7 +218,7 @@ void wxSpinCtrl::OnChar(wxKeyEvent& event) eventNav.SetWindowChange(event.ControlDown()); eventNav.SetEventObject(this); - if ( GetParent()->GetEventHandler()->ProcessEvent(eventNav) ) + if ( GetParent()->HandleWindowEvent(eventNav) ) return; } break; @@ -267,6 +228,13 @@ void wxSpinCtrl::OnChar(wxKeyEvent& event) 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 @@ -276,6 +244,22 @@ void wxSpinCtrl::OnSetFocus(wxFocusEvent& event) 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 // ---------------------------------------------------------------------------- @@ -289,6 +273,13 @@ bool wxSpinCtrl::Create(wxWindow *parent, 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) @@ -306,7 +297,13 @@ bool wxSpinCtrl::Create(wxWindow *parent, WXDWORD exStyle = 0; WXDWORD msStyle = MSWGetStyle(GetWindowStyle(), & exStyle) ; - // calculate the sizes: the size given is the toal size for both controls + // propagate text alignment style to text ctrl + if ( style & wxALIGN_RIGHT ) + msStyle |= ES_RIGHT; + else if ( style & wxALIGN_CENTER ) + msStyle |= ES_CENTER; + + // 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; @@ -319,7 +316,7 @@ bool wxSpinCtrl::Create(wxWindow *parent, sizeText.x -= sizeBtn.x + MARGIN_BETWEEN; if ( sizeText.x <= 0 ) { - wxLogDebug(_T("not enough space for wxSpinCtrl!")); + wxLogDebug(wxT("not enough space for wxSpinCtrl!")); } wxPoint posBtn(pos); @@ -336,7 +333,7 @@ bool wxSpinCtrl::Create(wxWindow *parent, m_hwndBuddy = (WXHWND)::CreateWindowEx ( exStyle, // sunken border - _T("EDIT"), // window class + wxT("EDIT"), // window class NULL, // no window title msStyle, // style (will be shown later) pos.x, pos.y, // position @@ -361,11 +358,11 @@ bool wxSpinCtrl::Create(wxWindow *parent, 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); + gs_spinForTextCtrl[GetBuddyHwnd()] = this; + m_wndProcBuddy = (WXFARPROC)wxSetWindowProc(GetBuddyHwnd(), wxBuddyTextWndProc); @@ -384,36 +381,39 @@ bool wxSpinCtrl::Create(wxWindow *parent, 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); + SetValue(initial); + + // Set the range in the native control + SetRange(min, max); + 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 - // initial wxEVT_COMMAND_TEXT_UPDATED message - ms_allSpins.Add(this); return true; } wxSpinCtrl::~wxSpinCtrl() { - ms_allSpins.Remove(this); - - // 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()); + ::DestroyWindow( GetBuddyHwnd() ); + + gs_spinForTextCtrl.erase(GetBuddyHwnd()); } // ---------------------------------------------------------------------------- @@ -428,16 +428,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(wxT("%d"), val).wx_str()); + } + + m_oldValue = GetValue(); + + m_blockEvent = false; +} + 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; - 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; } @@ -454,6 +479,28 @@ void wxSpinCtrl::SetSelection(long from, long to) ::SendMessage(GetBuddyHwnd(), EM_SETSEL, (WPARAM)from, (LPARAM)to); } +// ---------------------------------------------------------------------------- +// wxSpinButton methods +// ---------------------------------------------------------------------------- + +void wxSpinCtrl::SetRange(int minVal, int maxVal) +{ + wxSpinButton::SetRange(minVal, maxVal); + + // this control is used for numeric entry so restrict the input to numeric + // keys only -- but only if we don't need to be able to enter "-" in it as + // otherwise this would become impossible + const DWORD styleOld = ::GetWindowLong(GetBuddyHwnd(), GWL_STYLE); + DWORD styleNew; + if ( minVal < 0 ) + styleNew = styleOld & ~ES_NUMBER; + else + styleNew = styleOld | ES_NUMBER; + + if ( styleNew != styleOld ) + ::SetWindowLong(GetBuddyHwnd(), GWL_STYLE, styleNew); +} + // ---------------------------------------------------------------------------- // forward some methods to subcontrols // ---------------------------------------------------------------------------- @@ -484,6 +531,53 @@ bool wxSpinCtrl::Show(bool show) 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. + + // Get the position before changing the parent as it would be offset after + // changing it. + const wxRect rect = GetRect(); + + if ( !wxWindowBase::Reparent(newParent) ) + return false; + + newParent->GetChildren().DeleteObject(this); + + // destroy the old spin button after detaching it from this wxWindow object + // (notice that m_hWnd will be reset by UnsubclassWin() so save it first) + const HWND hwndOld = GetHwnd(); + UnsubclassWin(); + if ( !::DestroyWindow(hwndOld) ) + { + wxLogLastError(wxT("DestroyWindow")); + } + + // create and initialize the new one + if ( !wxSpinButton::Create(GetParent(), GetId(), + rect.GetPosition(), rect.GetSize(), + GetWindowStyle(), GetName()) ) + return false; + + // reapply our values to wxSpinButton + wxSpinButton::SetValue(GetValue()); + SetRange(m_min, m_max); + + // also set the size again with wxSIZE_ALLOW_MINUS_ONE flag: this is + // necessary if our original position used -1 for either x or y + SetSize(rect, wxSIZE_ALLOW_MINUS_ONE); + + // 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) ) @@ -491,7 +585,7 @@ bool wxSpinCtrl::Enable(bool enable) return false; } - ::EnableWindow(GetBuddyHwnd(), enable); + MSWEnableHWND(GetBuddyHwnd(), enable); return true; } @@ -514,23 +608,51 @@ void wxSpinCtrl::DoSetToolTip(wxToolTip *tip) #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); - event.SetInt(eventSpin.GetPosition()); + event.SetInt(value); - (void)GetEventHandler()->ProcessEvent(event); + (void)HandleWindowEvent(event); + + m_oldValue = value; +} + +bool wxSpinCtrl::MSWOnScroll(int WXUNUSED(orientation), WXWORD wParam, + WXWORD pos, WXHWND control) +{ + wxCHECK_MSG( control, false, wxT("scrolling what?") ); - if ( eventSpin.GetSkipped() ) + 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 // ---------------------------------------------------------------------------- @@ -564,7 +686,7 @@ void wxSpinCtrl::DoMoveWindow(int x, int y, int width, int height) int widthText = width - widthBtn - MARGIN_BETWEEN; if ( widthText <= 0 ) { - wxLogDebug(_T("not enough space for wxSpinCtrl!")); + wxLogDebug(wxT("not enough space for wxSpinCtrl!")); } // 1) The buddy window @@ -589,6 +711,19 @@ void wxSpinCtrl::DoGetSize(int *x, int *y) const *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 @@ -601,4 +736,3 @@ void wxSpinCtrl::DoGetPosition(int *x, int *y) const } #endif // wxUSE_SPINCTRL -