make sure we catch invalid control refs better

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

diff --git a/src/msw/checklst.cpp b/src/msw/checklst.cpp
index 3474192705c36011d987afaabd8a96e747a65915..cf5c5f771ead41aeaf59e526760f63eb89f24483 100644 (file)
--- a/src/msw/checklst.cpp
+++ b/src/msw/checklst.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     implementation of wxCheckListBox class
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     implementation of wxCheckListBox class
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -17,20 +17,19 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

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

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

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

-#if wxUSE_OWNER_DRAWN
+#if wxUSE_CHECKLISTBOX && wxUSE_OWNER_DRAWN
+
+#include "wx/checklst.h"

 
 #ifndef WX_PRECOMP
 
 #ifndef WX_PRECOMP

+    #include "wx/msw/wrapwin.h"

     #include "wx/object.h"
     #include "wx/colour.h"
     #include "wx/font.h"
     #include "wx/object.h"
     #include "wx/colour.h"
     #include "wx/font.h"


@@ -38,24 +37,16 @@
     #include "wx/window.h"
     #include "wx/listbox.h"
     #include "wx/dcmemory.h"
     #include "wx/window.h"
     #include "wx/listbox.h"
     #include "wx/dcmemory.h"

-

     #include "wx/settings.h"
     #include "wx/settings.h"

-

     #include "wx/log.h"
 #endif
 
 #include "wx/ownerdrw.h"
     #include "wx/log.h"
 #endif
 
 #include "wx/ownerdrw.h"

-#include "wx/checklst.h"

 
 

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

 #include <windowsx.h>
 
 #include "wx/msw/private.h"
 
 #include <windowsx.h>
 
 #include "wx/msw/private.h"
 

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

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


@@ -80,7 +71,7 @@ wxBEGIN_FLAGS( wxCheckListBoxStyle )
     wxFLAGS_MEMBER(wxBORDER_RAISED)
     wxFLAGS_MEMBER(wxBORDER_STATIC)
     wxFLAGS_MEMBER(wxBORDER_NONE)
     wxFLAGS_MEMBER(wxBORDER_RAISED)
     wxFLAGS_MEMBER(wxBORDER_STATIC)
     wxFLAGS_MEMBER(wxBORDER_NONE)

-    
+

     // old style border flags
     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
     // old style border flags
     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
     wxFLAGS_MEMBER(wxSUNKEN_BORDER)


@@ -113,14 +104,14 @@ wxEND_FLAGS( wxCheckListBoxStyle )
 IMPLEMENT_DYNAMIC_CLASS_XTI(wxCheckListBox, wxListBox,"wx/checklst.h")
 
 wxBEGIN_PROPERTIES_TABLE(wxCheckListBox)
 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 , , wxLB_OWNERDRAW /*flags*/ , wxT("Helpstring") , wxT("group")) // style
+    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()
 
 wxEND_PROPERTIES_TABLE()
 
 wxBEGIN_HANDLERS_TABLE(wxCheckListBox)
 wxEND_HANDLERS_TABLE()
 

-wxCONSTRUCTOR_4( wxCheckListBox , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size ) 
+wxCONSTRUCTOR_4( wxCheckListBox , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )

 
 #else
 IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)
 
 #else
 IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)


@@ -134,97 +125,100 @@ class wxCheckListBoxItem : public wxOwnerDrawn
 {
 friend class WXDLLEXPORT wxCheckListBox;
 public:
 {
 friend class WXDLLEXPORT wxCheckListBox;
 public:

-  // ctor
-  wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex);
+    // ctor
+    wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex);

 
 

-  // drawing functions
-  virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
+    // drawing functions
+    virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);

 
 

-  // simple accessors and operations
-  bool IsChecked() const { return m_bChecked; }
+    // simple accessors and operations
+    bool IsChecked() const { return m_bChecked; }

 
 

-  void Check(bool bCheck);
-  void Toggle() { Check(!IsChecked()); }
+    void Check(bool bCheck);
+    void Toggle() { Check(!IsChecked()); }

 
 

-  void SendEvent();
+    void SendEvent();

 
 private:
 
 private:

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

 
     DECLARE_NO_COPY_CLASS(wxCheckListBoxItem)
 
     DECLARE_NO_COPY_CLASS(wxCheckListBoxItem)

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

 };
 
 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_pParent  = pParent;
-  m_nIndex   = nIndex;
-
-  // we don't initialize m_nCheckHeight/Width vars because it's
-  // 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());
+    m_bChecked = false;
+    m_pParent  = pParent;
+    m_nIndex   = nIndex;
+
+    // we don't initialize m_nCheckHeight/Width vars because it's
+    // done in OnMeasure while they are used only in OnDraw and we
+    // know that there will always be OnMeasure before OnDraw
+
+    // 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());

 }
 
 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) ) {
-    // ## using native API for performance and precision
+    if ( !wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) )
+        return false;
+
+
+    // 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);
-
-    // we erase the 1-pixel border
-    Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
-
-    // shift check mark 1 pixel to the right (it looks better like this)
-    x++;
+    // create pens, brushes &c
+    COLORREF colBg = ::GetSysColor(COLOR_WINDOW);
+    AutoHPEN hpenBack(colBg),
+             hpenGray(RGB(0xc0, 0xc0, 0xc0));

 
 

-    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);
+    SelectInHDC selPen(hdc, (HGDIOBJ)hpenBack);
+    AutoHBRUSH hbrBack(colBg);
+    SelectInHDC selBrush(hdc, hbrBack);

 
 

-      // then draw a check mark into it
+    // erase the background: it could have been filled with the selected colour
+    Rectangle(hdc, x, y, x + nCheckWidth + 1, rc.GetBottom() + 1);

 
 

-      RECT rect;
-      rect.left   = 0;
-      rect.top    = 0;
-      rect.right  = nCheckWidth;
-      rect.bottom = nCheckHeight;
+    // shift check mark 1 pixel to the right, looks better like this
+    x++;

 
 

+    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__
 #ifdef __WXWINCE__

-      DrawFrameControl(hdcMem, &rect, DFC_BUTTON, DFCS_BUTTONCHECK);
+                           DFC_BUTTON, DFCS_BUTTONCHECK

 #else
 #else

-      DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
+                           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


@@ -233,30 +227,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);
-
-    DeleteObject(hpenBack);
-    DeleteObject(hpenGray);
+    (void)::SelectObject(hdc, (HGDIOBJ)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


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

-        RECT rcUpdate;
+    RECT rcUpdate;

 
 

-        if ( ::SendMessage(hwndListbox, LB_GETITEMRECT,
-                           m_nIndex, (LPARAM)&rcUpdate) == LB_ERR )
-        {
-            wxLogDebug(wxT("LB_GETITEMRECT failed"));
-        }
+    if ( ::SendMessage(hwndListbox, LB_GETITEMRECT,
+                       m_nIndex, (LPARAM)&rcUpdate) == LB_ERR )
+    {
+        wxLogDebug(wxT("LB_GETITEMRECT failed"));
+    }

 
 

-    InvalidateRect(hwndListbox, &rcUpdate, FALSE);
+    ::InvalidateRect(hwndListbox, &rcUpdate, FALSE);

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


@@ -358,28 +334,28 @@ bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
 // misc overloaded methods
 // -----------------------
 
 // misc overloaded methods
 // -----------------------
 

-void wxCheckListBox::Delete(int N)
+void wxCheckListBox::Delete(unsigned int n)

 {
 {

-    wxCHECK_RET( N >= 0 && N < m_noItems,
+    wxCHECK_RET( IsValid(n),

                  wxT("invalid index in wxListBox::Delete") );
 
                  wxT("invalid index in wxListBox::Delete") );
 

-    wxListBox::Delete(N);
+    wxListBox::Delete(n);

 
     // free memory
 
     // free memory

-    delete m_aItems[N];
+    delete m_aItems[n];

 
 

-    m_aItems.RemoveAt(N);
+    m_aItems.RemoveAt(n);

 }
 
 bool wxCheckListBox::SetFont( const wxFont &font )
 {
 }
 
 bool wxCheckListBox::SetFont( const wxFont &font )
 {

-    size_t i;
+    unsigned int i;

     for ( i = 0; i < m_aItems.GetCount(); i++ )
         m_aItems[i]->SetFont(font);
 
     wxListBox::SetFont(font);
 
     for ( i = 0; i < m_aItems.GetCount(); i++ )
         m_aItems[i]->SetFont(font);
 
     wxListBox::SetFont(font);
 

-    return TRUE;
+    return true;

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


@@ -405,25 +381,25 @@ 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
 // -----------
 

-bool wxCheckListBox::IsChecked(size_t uiIndex) const
+bool wxCheckListBox::IsChecked(unsigned int uiIndex) const

 {
 {

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

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

-void wxCheckListBox::Check(size_t uiIndex, bool bCheck)
+void wxCheckListBox::Check(unsigned int uiIndex, bool bCheck)

 {
 {

-    wxCHECK_RET( uiIndex < (size_t)GetCount(), _T("bad wxCheckListBox index") );
+    wxCHECK_RET( IsValid(uiIndex), _T("bad wxCheckListBox index") );

 
     GetItem(uiIndex)->Check(bCheck);
 }
 
     GetItem(uiIndex)->Check(bCheck);
 }


@@ -517,21 +493,24 @@ void wxCheckListBox::OnKeyDown(wxKeyEvent& event)
 
 void wxCheckListBox::OnLeftClick(wxMouseEvent& event)
 {
 
 void wxCheckListBox::OnLeftClick(wxMouseEvent& event)
 {

-  // clicking on the item selects it, clicking on the checkmark toggles
-  if ( event.GetX() <= wxOwnerDrawn::GetDefaultMarginWidth() ) {
-    int nItem = HitTest(event.GetX(), event.GetY());
-
-    if ( nItem != wxNOT_FOUND ) {
-      wxCheckListBoxItem *item = GetItem(nItem);
-      item->Toggle();
-      item->SendEvent();
+    // clicking on the item selects it, clicking on the checkmark toggles
+    if ( event.GetX() <= wxOwnerDrawn::GetDefaultMarginWidth() )
+    {
+        int nItem = HitTest(event.GetX(), event.GetY());
+
+        if ( nItem != wxNOT_FOUND )
+        {
+            wxCheckListBoxItem *item = GetItem(nItem);
+            item->Toggle();
+            item->SendEvent();
+        }
+        //else: it's not an error, just click outside of client zone
+    }
+    else
+    {
+        // implement default behaviour: clicking on the item selects it
+        event.Skip();

     }
     }

-    //else: it's not an error, just click outside of client zone
-  }
-  else {
-    // implement default behaviour: clicking on the item selects it
-    event.Skip();
-  }

 }
 
 int wxCheckListBox::DoHitTestItem(wxCoord x, wxCoord y) const
 }
 
 int wxCheckListBox::DoHitTestItem(wxCoord x, wxCoord y) const


@@ -544,8 +523,16 @@ int wxCheckListBox::DoHitTestItem(wxCoord x, wxCoord y) const
                               MAKELPARAM(x, y)
                              );
 
                               MAKELPARAM(x, y)
                              );
 

-  return nItem >= m_noItems ? wxNOT_FOUND : nItem;
+    return nItem >= (int)m_noItems ? wxNOT_FOUND : nItem;

 }
 
 }
 

-#endif

 
 

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