Fix accelerstors with down and left

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

diff --git a/src/msw/choice.cpp b/src/msw/choice.cpp
index 52cf225acc167ab7d29c19a1d771fd457f6e059a..7c15b52d83e7c665bb3a496474bb95e36816a75f 100644 (file)
--- a/src/msw/choice.cpp
+++ b/src/msw/choice.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxChoice
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin to derive from wxChoiceBase
 // Purpose:     wxChoice
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin to derive from wxChoiceBase


@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

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

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -28,7 +24,7 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

-#if wxUSE_CHOICE
+#if wxUSE_CHOICE && !(defined(__SMARTPHONE__) && defined(__WXWINCE__))

 
 #ifndef WX_PRECOMP
     #include "wx/choice.h"
 
 #ifndef WX_PRECOMP
     #include "wx/choice.h"


@@ -138,11 +134,11 @@ bool wxChoice::CreateAndInit(wxWindow *parent,
 {
     // initialize wxControl
     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 {
     // initialize wxControl
     if ( !CreateControl(parent, id, pos, size, style, validator, name) )

-        return FALSE;
+        return false;

 
     // now create the real HWND
 
     // now create the real HWND

-    if ( !MSWCreateControl(wxT("COMBOBOX"), _T(""), pos, size) )
-        return FALSE;
+    if ( !MSWCreateControl(wxT("COMBOBOX"), wxEmptyString, pos, size) )
+        return false;

 
 
     // choice/combobox normally has "white" (depends on colour scheme, of
 
 
     // choice/combobox normally has "white" (depends on colour scheme, of


@@ -158,7 +154,7 @@ bool wxChoice::CreateAndInit(wxWindow *parent,
     // and now we may finally size the control properly (if needed)
     SetBestSize(size);
 
     // and now we may finally size the control properly (if needed)
     SetBestSize(size);
 

-    return TRUE;
+    return true;

 }
 
 bool wxChoice::Create(wxWindow *parent,
 }
 
 bool wxChoice::Create(wxWindow *parent,


@@ -236,13 +232,14 @@ int wxChoice::DoAppend(const wxString& item)
             UpdateVisibleHeight();
     }
 
             UpdateVisibleHeight();
     }
 

+    InvalidateBestSize();

     return n;
 }
 
 int wxChoice::DoInsert(const wxString& item, int pos)
 {
     wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));
     return n;
 }
 
 int wxChoice::DoInsert(const wxString& item, int pos)
 {
     wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));

-    wxCHECK_MSG((pos>=0) && (pos<=GetCount()), -1, wxT("invalid index"));
+    wxCHECK_MSG(IsValidInsert(pos), -1, wxT("invalid index"));

 
     int n = (int)SendMessage(GetHwnd(), CB_INSERTSTRING, pos, (LPARAM)item.c_str());
     if ( n == CB_ERR )
 
     int n = (int)SendMessage(GetHwnd(), CB_INSERTSTRING, pos, (LPARAM)item.c_str());
     if ( n == CB_ERR )


@@ -255,12 +252,13 @@ int wxChoice::DoInsert(const wxString& item, int pos)
             UpdateVisibleHeight();
     }
 
             UpdateVisibleHeight();
     }
 

+    InvalidateBestSize();

     return n;
 }
 
 void wxChoice::Delete(int n)
 {
     return n;
 }
 
 void wxChoice::Delete(int n)
 {

-    wxCHECK_RET( n < GetCount(), wxT("invalid item index in wxChoice::Delete") );
+    wxCHECK_RET( IsValid(n), wxT("invalid item index in wxChoice::Delete") );

 
     if ( HasClientObjectData() )
     {
 
     if ( HasClientObjectData() )
     {


@@ -271,6 +269,8 @@ void wxChoice::Delete(int n)
 
     if ( !IsFrozen() )
         UpdateVisibleHeight();
 
     if ( !IsFrozen() )
         UpdateVisibleHeight();

+
+    InvalidateBestSize();

 }
 
 void wxChoice::Clear()
 }
 
 void wxChoice::Clear()


@@ -281,6 +281,8 @@ void wxChoice::Clear()
 
     if ( !IsFrozen() )
         UpdateVisibleHeight();
 
     if ( !IsFrozen() )
         UpdateVisibleHeight();

+
+    InvalidateBestSize();

 }
 
 void wxChoice::Free()
 }
 
 void wxChoice::Free()


@@ -300,6 +302,17 @@ void wxChoice::Free()
 // ----------------------------------------------------------------------------
 
 int wxChoice::GetSelection() const
 // ----------------------------------------------------------------------------
 
 int wxChoice::GetSelection() const

+{
+    // if m_lastAcceptedSelection is set, it means that the dropdown is
+    // currently shown and that we want to use the last "permanent" selection
+    // instead of whatever is under the mouse pointer currently
+    //
+    // otherwise, get the selection from the control
+    return m_lastAcceptedSelection == wxID_NONE ? GetCurrentSelection()
+                                                : m_lastAcceptedSelection;
+}
+
+int wxChoice::GetCurrentSelection() const

 {
     return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);
 }
 {
     return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);
 }


@@ -313,37 +326,57 @@ void wxChoice::SetSelection(int n)
 // string list functions
 // ----------------------------------------------------------------------------
 
 // string list functions
 // ----------------------------------------------------------------------------
 

-int wxChoice::GetCount() const
+size_t wxChoice::GetCount() const

 {
 {

-    return (int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);
+    return (size_t)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);

 }
 
 }
 

-int wxChoice::FindString(const wxString& s) const
+int wxChoice::FindString(const wxString& s, bool bCase) const

 {
 #if defined(__WATCOMC__) && defined(__WIN386__)
     // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
     // wxChoice::Do it the long way instead.
 {
 #if defined(__WATCOMC__) && defined(__WIN386__)
     // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
     // wxChoice::Do it the long way instead.

-    int count = GetCount();
-    for ( int i = 0; i < count; i++ )
+    size_t count = GetCount();
+    for ( size_t i = 0; i < count; i++ )

     {
         // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
     {
         // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too

-        if ( GetString(i).IsSameAs(s, FALSE) )
+        if ( GetString(i).IsSameAs(s, bCase) )

             return i;
     }
 
     return wxNOT_FOUND;
 #else // !Watcom
             return i;
     }
 
     return wxNOT_FOUND;
 #else // !Watcom

-    int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
-                               (WPARAM)-1, (LPARAM)s.c_str());
-
-    return pos == LB_ERR ? wxNOT_FOUND : pos;
+   //TODO:  Evidently some MSW versions (all?) don't like empty strings
+   //passed to SendMessage, so we have to do it ourselves in that case
+   if ( s.empty() )
+   {
+       size_t count = GetCount();
+       for ( size_t i = 0; i < count; i++ )
+       {
+         if ( GetString(i).empty() )
+             return i;
+       }
+
+       return wxNOT_FOUND;
+   }
+   else if (bCase)
+   {
+       // back to base class search for not native search type
+       return wxItemContainerImmutable::FindString( s, bCase );
+   }
+   else
+   {
+       int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
+                                  (WPARAM)-1, (LPARAM)s.c_str());
+
+       return pos == LB_ERR ? wxNOT_FOUND : pos;
+   }

 #endif // Watcom/!Watcom
 }
 
 void wxChoice::SetString(int n, const wxString& s)
 {
 #endif // Watcom/!Watcom
 }
 
 void wxChoice::SetString(int n, const wxString& s)
 {

-    wxCHECK_RET( n >= 0 && n < GetCount(),
-                 wxT("invalid item index in wxChoice::SetString") );
+    wxCHECK_RET( IsValid(n), wxT("invalid item index in wxChoice::SetString") );

 
     // we have to delete and add back the string as there is no way to change a
     // string in place
 
     // we have to delete and add back the string as there is no way to change a
     // string in place


@@ -367,6 +400,8 @@ void wxChoice::SetString(int n, const wxString& s)
         DoSetItemClientData(n, data);
     }
     //else: it's already NULL by default
         DoSetItemClientData(n, data);
     }
     //else: it's already NULL by default

+
+    InvalidateBestSize();

 }
 
 wxString wxChoice::GetString(int n) const
 }
 
 wxString wxChoice::GetString(int n) const


@@ -435,7 +470,7 @@ wxClientData* wxChoice::DoGetItemClientObject( int n ) const
 void wxChoice::UpdateVisibleHeight()
 {
     // be careful to not change the width here
 void wxChoice::UpdateVisibleHeight()
 {
     // be careful to not change the width here

-    DoSetSize(-1, -1, -1, GetSize().y, wxSIZE_USE_EXISTING);
+    DoSetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, GetSize().y, wxSIZE_USE_EXISTING);

 }
 
 void wxChoice::DoMoveWindow(int x, int y, int width, int height)
 }
 
 void wxChoice::DoMoveWindow(int x, int y, int width, int height)


@@ -462,7 +497,7 @@ void wxChoice::DoGetSize(int *w, int *h) const
     // total height of the control including the drop down list -- but only
     // sometimes, and normally it isn't... I have no idea about what to do with
     // this
     // total height of the control including the drop down list -- but only
     // sometimes, and normally it isn't... I have no idea about what to do with
     // this

-    wxControl::DoGetSize(w, h);    
+    wxControl::DoGetSize(w, h);

 }
 
 void wxChoice::DoSetSize(int x, int y,
 }
 
 void wxChoice::DoSetSize(int x, int y,


@@ -474,7 +509,7 @@ void wxChoice::DoSetSize(int x, int y,
     // the height which we must pass to Windows should be the total height of
     // the control including the drop down list while the height given to us
     // is, of course, just the height of the permanently visible part of it
     // the height which we must pass to Windows should be the total height of
     // the control including the drop down list while the height given to us
     // is, of course, just the height of the permanently visible part of it

-    if ( height != -1 )
+    if ( height != wxDefaultCoord )

     {
         // don't make the drop down list too tall, arbitrarily limit it to 40
         // items max and also don't leave it empty
     {
         // don't make the drop down list too tall, arbitrarily limit it to 40
         // items max and also don't leave it empty


@@ -488,6 +523,23 @@ void wxChoice::DoSetSize(int x, int y,
         const int hItem = SendMessage(GetHwnd(), CB_GETITEMHEIGHT, 0, 0);
         height += hItem*(nItems + 1);
     }
         const int hItem = SendMessage(GetHwnd(), CB_GETITEMHEIGHT, 0, 0);
         height += hItem*(nItems + 1);
     }

+    else
+    {
+        // We cannot pass wxDefaultCoord as height to wxControl. wxControl uses
+        // wxGetWindowRect() to determine the current height of the combobox,
+        // and then again sets the combobox's height to that value. Unfortunately,
+        // wxGetWindowRect doesn't include the dropdown list's height (at least
+        // on Win2K), so this would result in a combobox with dropdown height of
+        // 1 pixel. We have to determine the default height ourselves and call
+        // wxControl with that value instead.
+        int w, h;
+        RECT r;
+        DoGetSize(&w, &h);
+        if (::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT, 0, (LPARAM) &r) != 0)
+        {
+            height = h + r.bottom - r.top;
+        }
+    }

 
     wxControl::DoSetSize(x, y, width, height, sizeFlags);
 
 
     wxControl::DoSetSize(x, y, width, height, sizeFlags);
 


@@ -499,7 +551,7 @@ void wxChoice::DoSetSize(int x, int y,
     // if the height specified for the visible part of the control is
     // different from the current one, we need to change it separately
     // as it is not affected by normal WM_SETSIZE
     // if the height specified for the visible part of the control is
     // different from the current one, we need to change it separately
     // as it is not affected by normal WM_SETSIZE

-    if ( height != -1 )
+    if ( height != wxDefaultCoord )

     {
         const int delta = heightOrig - GetSize().y;
         if ( delta )
     {
         const int delta = heightOrig - GetSize().y;
         if ( delta )


@@ -534,23 +586,45 @@ wxSize wxChoice::DoGetBestSize() const
     // the combobox should be slightly larger than the widest string
     wChoice += 5*GetCharWidth();
 
     // the combobox should be slightly larger than the widest string
     wChoice += 5*GetCharWidth();
 

-    return wxSize(wChoice, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
+    wxSize best(wChoice, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
+    CacheBestSize(best);
+    return best;

 }
 
 WXLRESULT wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 {
 }
 
 WXLRESULT wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 {

-    if ( nMsg == WM_LBUTTONUP )
+    switch ( nMsg )

     {
     {

-        int x = (int)LOWORD(lParam);
-        int y = (int)HIWORD(lParam);
-
-        // Ok, this is truly weird, but if a panel with a wxChoice loses the
-        // focus, then you get a *fake* WM_LBUTTONUP message with x = 65535 and
-        // y = 65535. Filter out this nonsense.
-        //
-        // VZ: I'd like to know how to reproduce this please...
-        if ( x == 65535 && y == 65535 )
-            return 0;
+        case WM_LBUTTONUP:
+            {
+                int x = (int)LOWORD(lParam);
+                int y = (int)HIWORD(lParam);
+
+                // Ok, this is truly weird, but if a panel with a wxChoice
+                // loses the focus, then you get a *fake* WM_LBUTTONUP message
+                // with x = 65535 and y = 65535. Filter out this nonsense.
+                //
+                // VZ: I'd like to know how to reproduce this please...
+                if ( x == 65535 && y == 65535 )
+                    return 0;
+            }
+            break;
+
+            // we have to handle both: one for the normal case and the other
+            // for readonly
+        case WM_CTLCOLOREDIT:
+        case WM_CTLCOLORLISTBOX:
+        case WM_CTLCOLORSTATIC:
+            {
+                WXHDC hdc;
+                WXHWND hwnd;
+                UnpackCtlColor(wParam, lParam, &hdc, &hwnd);
+
+                WXHBRUSH hbr = MSWControlColor((WXHDC)hdc, hwnd);
+                if ( hbr )
+                    return (WXLRESULT)hbr;
+                //else: fall through to default window proc
+            }

     }
 
     return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
     }
 
     return wxWindow::MSWWindowProc(nMsg, wParam, lParam);


@@ -558,47 +632,100 @@ WXLRESULT wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 
 bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 {
 
 bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 {

-    if ( param != CBN_SELCHANGE)
-    {
-        // "selection changed" is the only event we're after
-        return FALSE;
-    }
-
-    int n = GetSelection();
-    if (n > -1)
+    /*
+        The native control provides a great variety in the events it sends in
+        the different selection scenarios (undoubtedly for greater amusement of
+        the programmers using it). For the reference, here are the cases when
+        the final selection is accepted (things are quite interesting when it
+        is cancelled too):
+
+        A. Selecting with just the arrows without opening the dropdown:
+            1. CBN_SELENDOK
+            2. CBN_SELCHANGE
+
+        B. Opening dropdown with F4 and selecting with arrows:
+            1. CBN_DROPDOWN
+            2. many CBN_SELCHANGE while changing selection in the list
+            3. CBN_SELENDOK
+            4. CBN_CLOSEUP
+
+        C. Selecting with the mouse:
+            1. CBN_DROPDOWN
+            -- no intermediate CBN_SELCHANGEs --
+            2. CBN_SELENDOK
+            3. CBN_CLOSEUP
+            4. CBN_SELCHANGE
+
+        Admire the different order of messages in all of those cases, it must
+        surely have taken a lot of effort to Microsoft developers to achieve
+        such originality.
+     */
+    switch ( param )

     {
     {

-        wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
-        event.SetInt(n);
-        event.SetEventObject(this);
-        event.SetString(GetStringSelection());
-        if ( HasClientObjectData() )
-            event.SetClientObject( GetClientObject(n) );
-        else if ( HasClientUntypedData() )
-            event.SetClientData( GetClientData(n) );
-        ProcessCommand(event);
+        case CBN_DROPDOWN:
+            // we use this value both because we don't want to track selection
+            // using CB_GETCURSEL while the dropdown is opened and because we
+            // need to reset the selection back to it if it's eventually
+            // cancelled by user
+            m_lastAcceptedSelection = GetCurrentSelection();
+            break;
+
+        case CBN_CLOSEUP:
+            // if the selection was accepted by the user, it should have been
+            // reset to wxID_NONE by CBN_SELENDOK, otherwise the selection was
+            // cancelled and we must restore the old one
+            if ( m_lastAcceptedSelection != wxID_NONE )
+            {
+                SetSelection(m_lastAcceptedSelection);
+                m_lastAcceptedSelection = wxID_NONE;
+            }
+            break;
+
+        case CBN_SELENDOK:
+            // reset it to prevent CBN_CLOSEUP from undoing the selection (it's
+            // ok to reset it now as GetCurrentSelection() will now return the
+            // same thing anyhow)
+            m_lastAcceptedSelection = wxID_NONE;
+
+            {
+                const int n = GetSelection();
+
+                wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
+                event.SetInt(n);
+                event.SetEventObject(this);
+
+                if ( n > -1 )
+                {
+                    event.SetString(GetStringSelection());
+                    if ( HasClientObjectData() )
+                        event.SetClientObject( GetClientObject(n) );
+                    else if ( HasClientUntypedData() )
+                        event.SetClientData( GetClientData(n) );
+                }
+
+                ProcessCommand(event);
+            }
+            break;
+
+        // don't handle CBN_SELENDCANCEL: just leave m_lastAcceptedSelection
+        // valid and the selection will be undone in CBN_CLOSEUP above
+
+        // don't handle CBN_SELCHANGE neither, we don't want to generate events
+        // while the dropdown is opened -- but do add it if we ever need this
+
+        default:
+            return false;

     }
 
     }
 

-    return TRUE;
+    return true;

 }
 
 }
 

-WXHBRUSH wxChoice::OnCtlColor(WXHDC pDC, WXHWND WXUNUSED(pWnd), WXUINT WXUNUSED(nCtlColor),
-                               WXUINT WXUNUSED(message),
-                               WXWPARAM WXUNUSED(wParam),
-                               WXLPARAM WXUNUSED(lParam)
-     )
+WXHBRUSH wxChoice::MSWControlColor(WXHDC hDC, WXHWND hWnd)

 {
 {

-    HDC hdc = (HDC)pDC;
-    wxColour colBack = GetBackgroundColour();
-
-    if (!IsEnabled())
-        colBack = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE);
-
-    ::SetBkColor(hdc, wxColourToRGB(colBack));
-    ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
-
-    wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);
+    if ( !IsEnabled() )
+        return MSWControlColorDisabled(hDC);

 
 

-    return (WXHBRUSH)brush->GetResourceHandle();
+    return wxChoiceBase::MSWControlColor(hDC, hWnd);

 }
 
 }
 

-#endif // wxUSE_CHOICE
+#endif // wxUSE_CHOICE && !(__SMARTPHONE__ && __WXWINCE__)