(blind) fix for keyboard cues display under XP (bug 1298512)

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

diff --git a/src/msw/checklst.cpp b/src/msw/checklst.cpp
index 2a7e01108ecfb17e593f35a32ef3cfbca1b7ca6f..80e080f5d0a3f3566b3decfa6165a86c6b1cbcce 100644 (file)
--- a/src/msw/checklst.cpp
+++ b/src/msw/checklst.cpp
@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-#pragma implementation "checklst.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_OWNER_DRAWN
+#if wxUSE_CHECKLISTBOX && wxUSE_OWNER_DRAWN

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


@@ -47,12 +43,10 @@
 #include "wx/ownerdrw.h"
 #include "wx/checklst.h"
 
 #include "wx/ownerdrw.h"
 #include "wx/checklst.h"
 

-#include <windows.h>
+#include "wx/msw/wrapwin.h"

 #include <windowsx.h>
 
 #include <windowsx.h>
 

-#if defined(__GNUWIN32_OLD__)
-    #include "wx/msw/gnuwin32/extra.h"
-#endif
+#include "wx/msw/private.h"

 
 // ----------------------------------------------------------------------------
 // private functions
 
 // ----------------------------------------------------------------------------
 // private functions


@@ -65,7 +59,64 @@
 // implementation
 // ============================================================================
 
 // implementation
 // ============================================================================
 

+
+#if wxUSE_EXTENDED_RTTI
+WX_DEFINE_FLAGS( wxCheckListBoxStyle )
+
+wxBEGIN_FLAGS( wxCheckListBoxStyle )
+    // 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(wxLB_SINGLE)
+    wxFLAGS_MEMBER(wxLB_MULTIPLE)
+    wxFLAGS_MEMBER(wxLB_EXTENDED)
+    wxFLAGS_MEMBER(wxLB_HSCROLL)
+    wxFLAGS_MEMBER(wxLB_ALWAYS_SB)
+    wxFLAGS_MEMBER(wxLB_NEEDED_SB)
+    wxFLAGS_MEMBER(wxLB_SORT)
+    wxFLAGS_MEMBER(wxLB_OWNERDRAW)
+
+wxEND_FLAGS( wxCheckListBoxStyle )
+
+IMPLEMENT_DYNAMIC_CLASS_XTI(wxCheckListBox, wxListBox,"wx/checklst.h")
+
+wxBEGIN_PROPERTIES_TABLE(wxCheckListBox)
+    wxEVENT_PROPERTY( Toggle , wxEVT_COMMAND_CHECKLISTBOX_TOGGLED , wxCommandEvent )
+    wxPROPERTY_FLAGS( WindowStyle , wxCheckListBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , wxLB_OWNERDRAW /*flags*/ , wxT("Helpstring") , wxT("group")) // style
+wxEND_PROPERTIES_TABLE()
+
+wxBEGIN_HANDLERS_TABLE(wxCheckListBox)
+wxEND_HANDLERS_TABLE()
+
+wxCONSTRUCTOR_4( wxCheckListBox , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
+
+#else

 IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)
 IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)

+#endif

 
 // ----------------------------------------------------------------------------
 // declaration and implementation of wxCheckListBoxItem class
 
 // ----------------------------------------------------------------------------
 // declaration and implementation of wxCheckListBoxItem class


@@ -90,17 +141,17 @@ public:
   void SendEvent();
 
 private:
   void SendEvent();
 
 private:

-
-    DECLARE_NO_COPY_CLASS(wxCheckListBoxItem)

   bool            m_bChecked;
   wxCheckListBox *m_pParent;
   size_t          m_nIndex;
   bool            m_bChecked;
   wxCheckListBox *m_pParent;
   size_t          m_nIndex;

+
+  DECLARE_NO_COPY_CLASS(wxCheckListBoxItem)

 };
 
 wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)
 };
 
 wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)

-                  : wxOwnerDrawn(wxEmptyString, TRUE)   // checkable
+                  : wxOwnerDrawn(wxEmptyString, true)   // checkable

 {
 {

-  m_bChecked = FALSE;
+  m_bChecked = false;

   m_pParent  = pParent;
   m_nIndex   = nIndex;
 
   m_pParent  = pParent;
   m_nIndex   = nIndex;
 


@@ -108,84 +159,67 @@ wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)
   // done in OnMeasure while they are used only in OnDraw and we
   // know that there will always be OnMeasure before OnDraw
 
   // done in OnMeasure while they are used only in OnDraw and we
   // know that there will always be OnMeasure before OnDraw
 

-  // fix appearance
-  SetMarginWidth(GetDefaultMarginWidth());
+  // fix appearance for check list boxes: they don't look quite the same as
+  // menu icons
+  SetMarginWidth(::GetSystemMetrics(SM_CXMENUCHECK) -
+                    2*wxSystemSettings::GetMetric(wxSYS_EDGE_X) + 1);
+  SetBackgroundColour(pParent->GetBackgroundColour());

 }
 
 }
 

-/*
- * JACS - I've got the owner-draw stuff partially working with WIN16,
- * with a really horrible-looking cross for wxCheckListBox instead of a
- * check - could use a bitmap check-mark instead, defined in wx.rc.
- * Also there's a refresh problem whereby it doesn't always draw the
- * check until you click to the right of it, which is OK for WIN32.
- */
-

 bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
                                     wxODAction act, wxODStatus stat)
 {
 bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
                                     wxODAction act, wxODStatus stat)
 {

-  if ( IsChecked() )
-    stat = (wxOwnerDrawn::wxODStatus)(stat | wxOwnerDrawn::wxODChecked);
+    // first draw the label
+    if ( IsChecked() )
+        stat = (wxOwnerDrawn::wxODStatus)(stat | wxOwnerDrawn::wxODChecked);
+
+    if ( !wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) )
+        return false;
+

 
 

-  if ( wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) ) {
-    // ## using native API for performance and precision
+    // now draw the check mark part

     size_t nCheckWidth  = GetDefaultMarginWidth(),
     size_t nCheckWidth  = GetDefaultMarginWidth(),

-         nCheckHeight = m_pParent->GetItemHeight();
+           nCheckHeight = m_pParent->GetItemHeight();

 
     int x = rc.GetX(),
         y = rc.GetY();
 
     HDC hdc = (HDC)dc.GetHDC();
 
 
     int x = rc.GetX(),
         y = rc.GetY();
 
     HDC hdc = (HDC)dc.GetHDC();
 

-    // create pens
-    HPEN hpenBack = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_WINDOW)),
-         hpenGray = CreatePen(PS_SOLID, 0, RGB(128, 128, 128)),
-         hpenPrev = (HPEN)SelectObject(hdc, hpenBack);
+    // create pens, brushes &c
+    COLORREF colBg = ::GetSysColor(COLOR_WINDOW);
+    AutoHPEN hpenBack(colBg),
+             hpenGray(RGB(0xc0, 0xc0, 0xc0));

 
 

-    // we erase the 1-pixel border
-    Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
+    SelectInHDC selPen(hdc, (HGDIOBJ)hpenBack);
+    AutoHBRUSH hbrBack(colBg);
+    SelectInHDC selBrush(hdc, hbrBack);
+
+    // erase the background: it could have been filled with the selected colour
+    Rectangle(hdc, x, y, x + nCheckWidth + 1, rc.GetBottom() + 1);

 
 

-    // shift check mark 1 pixel to the right (it looks better like this)
+    // shift check mark 1 pixel to the right, looks better like this

     x++;
 
     x++;
 

-    if ( IsChecked() ) {
-      // first create a monochrome bitmap in a memory DC
-      HDC hdcMem = CreateCompatibleDC(hdc);
-      HBITMAP hbmpCheck = CreateBitmap(nCheckWidth, nCheckHeight, 1, 1, 0);
-      HBITMAP hbmpOld = (HBITMAP)SelectObject(hdcMem, hbmpCheck);
-
-      // then draw a check mark into it
-#if defined(__WIN32__) && !defined(__SC__)
-      RECT rect;
-      rect.left   = 0;
-      rect.top    = 0;
-      rect.right  = nCheckWidth;
-      rect.bottom = nCheckHeight;
-
-      DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
+    if ( IsChecked() )
+    {
+        // first create a monochrome bitmap in a memory DC
+        MemoryHDC hdcMem(hdc);
+        MonoBitmap hbmpCheck(nCheckWidth, nCheckHeight);
+        SelectInHDC selBmp(hdcMem, hbmpCheck);
+
+        // then draw a check mark into it
+        RECT rect = { 0, 0, nCheckWidth, nCheckHeight };
+        ::DrawFrameControl(hdcMem, &rect,
+#ifdef __WXWINCE__
+                           DFC_BUTTON, DFCS_BUTTONCHECK

 #else
 #else

-      // In WIN16, draw a cross
-      HPEN blackPen = CreatePen(PS_SOLID, 1, RGB(0, 0, 0));
-      HPEN whiteBrush = (HPEN)GetStockObject(WHITE_BRUSH);
-      HPEN hPenOld = (HPEN)::SelectObject(hdcMem, blackPen);
-      HPEN hBrushOld = (HPEN)::SelectObject(hdcMem, whiteBrush);
-      ::SetROP2(hdcMem, R2_COPYPEN);
-      Rectangle(hdcMem, 0, 0, nCheckWidth, nCheckHeight);
-      MoveTo(hdcMem, 0, 0);
-      LineTo(hdcMem, nCheckWidth, nCheckHeight);
-      MoveTo(hdcMem, nCheckWidth, 0);
-      LineTo(hdcMem, 0, nCheckHeight);
-      ::SelectObject(hdcMem, hPenOld);
-      ::SelectObject(hdcMem, hBrushOld);
-      ::DeleteObject(blackPen);
+                           DFC_MENU, DFCS_MENUCHECK

 #endif
 #endif

+                           );

 
 

-      // finally copy it to screen DC and clean up
-      BitBlt(hdc, x, y, nCheckWidth - 1, nCheckHeight,
-             hdcMem, 0, 0, SRCCOPY);
-
-      SelectObject(hdcMem, hbmpOld);
-      DeleteObject(hbmpCheck);
-      DeleteDC(hdcMem);
+        // finally copy it to screen DC
+        ::BitBlt(hdc, x, y, nCheckWidth, nCheckHeight, hdcMem, 0, 0, SRCCOPY);

     }
 
     // now we draw the smaller rectangle
     }
 
     // now we draw the smaller rectangle


@@ -194,30 +228,12 @@ bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
     nCheckHeight -= 2;
 
     // draw hollow gray rectangle
     nCheckHeight -= 2;
 
     // draw hollow gray rectangle

-    (void)SelectObject(hdc, hpenGray);
-    HBRUSH hbrPrev  = (HBRUSH)SelectObject(hdc, GetStockObject(NULL_BRUSH));
-    Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
-
-    // clean up
-    (void)SelectObject(hdc, hpenPrev);
-    (void)SelectObject(hdc, hbrPrev);
+    (void)::SelectObject(hdc, (HGDIOBJ)hpenGray);

 
 

-    DeleteObject(hpenBack);
-    DeleteObject(hpenGray);
-
-    /*
-    dc.DrawRectangle(x, y, nCheckWidth, nCheckHeight);
-
-    if ( IsChecked() ) {
-      dc.DrawLine(x, y, x + nCheckWidth, y + nCheckHeight);
-      dc.DrawLine(x, y + nCheckHeight, x + nCheckWidth, y);
-    }
-    */
-
-    return TRUE;
-  }
+    SelectInHDC selBrush2(hdc, ::GetStockObject(NULL_BRUSH));
+    Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);

 
 

-  return FALSE;
+    return true;

 }
 
 // change the state of the item and redraw it
 }
 
 // change the state of the item and redraw it


@@ -238,26 +254,15 @@ void wxCheckListBoxItem::Check(bool check)
 
     HWND hwndListbox = (HWND)m_pParent->GetHWND();
 
 
     HWND hwndListbox = (HWND)m_pParent->GetHWND();
 

-    #ifdef __WIN32__
-        RECT rcUpdate;
+    RECT rcUpdate;

 
 

-        if ( ::SendMessage(hwndListbox, LB_GETITEMRECT,
-                           m_nIndex, (LPARAM)&rcUpdate) == LB_ERR )
-        {
-            wxLogDebug(wxT("LB_GETITEMRECT failed"));
-        }
-    #else // Win16
-        // FIXME this doesn't work if the listbox is scrolled!
-        size_t nHeight = m_pParent->GetItemHeight();
-        size_t y = m_nIndex * nHeight;
-        RECT rcUpdate ;
-        rcUpdate.left   = 0 ;
-        rcUpdate.top    = y ;
-        rcUpdate.right  = GetDefaultMarginWidth() ;
-        rcUpdate.bottom = y + nHeight ;
-    #endif  // Win32/16
-
-    InvalidateRect(hwndListbox, &rcUpdate, FALSE);
+    if ( ::SendMessage(hwndListbox, LB_GETITEMRECT,
+                       m_nIndex, (LPARAM)&rcUpdate) == LB_ERR )
+    {
+        wxLogDebug(wxT("LB_GETITEMRECT failed"));
+    }
+
+    ::InvalidateRect(hwndListbox, &rcUpdate, FALSE);

 }
 
 // send an "item checked" event
 }
 
 // send an "item checked" event


@@ -298,6 +303,15 @@ wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
     Create(parent, id, pos, size, nStrings, choices, style, val, name);
 }
 
     Create(parent, id, pos, size, nStrings, choices, style, val, name);
 }
 

+wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
+                               const wxPoint& pos, const wxSize& size,
+                               const wxArrayString& choices,
+                               long style, const wxValidator& val,
+                               const wxString& name)
+{
+    Create(parent, id, pos, size, choices, style, val, name);
+}
+

 bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
                             const wxPoint& pos, const wxSize& size,
                             int n, const wxString choices[],
 bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
                             const wxPoint& pos, const wxSize& size,
                             int n, const wxString choices[],


@@ -308,6 +322,16 @@ bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
                              style | wxLB_OWNERDRAW, validator, name);
 }
 
                              style | wxLB_OWNERDRAW, validator, name);
 }
 

+bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
+                            const wxPoint& pos, const wxSize& size,
+                            const wxArrayString& choices,
+                            long style,
+                            const wxValidator& validator, const wxString& name)
+{
+    return wxListBox::Create(parent, id, pos, size, choices,
+                             style | wxLB_OWNERDRAW, validator, name);
+}
+

 // misc overloaded methods
 // -----------------------
 
 // misc overloaded methods
 // -----------------------
 


@@ -332,7 +356,7 @@ bool wxCheckListBox::SetFont( const wxFont &font )
 
     wxListBox::SetFont(font);
 
 
     wxListBox::SetFont(font);
 

-    return TRUE;
+    return true;

 }
 
 // create/retrieve item
 }
 
 // create/retrieve item


@@ -358,10 +382,10 @@ bool wxCheckListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
     // add place for the check mark
     pStruct->itemWidth += wxOwnerDrawn::GetDefaultMarginWidth();
 
     // add place for the check mark
     pStruct->itemWidth += wxOwnerDrawn::GetDefaultMarginWidth();
 

-    return TRUE;
+    return true;

   }
 
   }
 

-  return FALSE;
+  return false;

 }
 
 // check items
 }
 
 // check items


@@ -369,7 +393,7 @@ bool wxCheckListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
 
 bool wxCheckListBox::IsChecked(size_t uiIndex) const
 {
 
 bool wxCheckListBox::IsChecked(size_t uiIndex) const
 {

-    wxCHECK_MSG( uiIndex < (size_t)GetCount(), FALSE, _T("bad wxCheckListBox index") );
+    wxCHECK_MSG( uiIndex < (size_t)GetCount(), false, _T("bad wxCheckListBox index") );

 
     return GetItem(uiIndex)->IsChecked();
 }
 
     return GetItem(uiIndex)->IsChecked();
 }


@@ -489,7 +513,6 @@ void wxCheckListBox::OnLeftClick(wxMouseEvent& event)
 
 int wxCheckListBox::DoHitTestItem(wxCoord x, wxCoord y) const
 {
 
 int wxCheckListBox::DoHitTestItem(wxCoord x, wxCoord y) const
 {

-  #ifdef __WIN32__

     int nItem = (int)::SendMessage
                              (
                               (HWND)GetHWND(),
     int nItem = (int)::SendMessage
                              (
                               (HWND)GetHWND(),


@@ -497,13 +520,18 @@ int wxCheckListBox::DoHitTestItem(wxCoord x, wxCoord y) const
                               0,
                               MAKELPARAM(x, y)
                              );
                               0,
                               MAKELPARAM(x, y)
                              );

-  #else // Win16
-    // FIXME this doesn't work when the listbox is scrolled!
-    int nItem = y / m_nItemHeight;
-  #endif // Win32/16

 
   return nItem >= m_noItems ? wxNOT_FOUND : nItem;
 }
 
 
   return nItem >= m_noItems ? wxNOT_FOUND : nItem;
 }
 

+
+wxSize wxCheckListBox::DoGetBestSize() const
+{
+    wxSize best = wxListBox::DoGetBestSize();
+    best.x += wxOwnerDrawn::GetDefaultMarginWidth();  // add room for the checkbox
+    CacheBestSize(best);
+    return best;
+}
+

 #endif
 
 #endif