]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/checklst.cpp
Fix assert when creating wxBitmapButton without a valid bitmap in wxMSW.
[wxWidgets.git] / src / msw / checklst.cpp
index 756293a0eda958c23c2ef1f0a9508e717460f9d2..726bccff524b4adc70ad2f7fad8328e320245582 100644 (file)
@@ -1,12 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        msw/checklst.cpp
+// Name:        src/msw/checklst.cpp
 // Purpose:     implementation of wxCheckListBox class
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     16.11.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
-#pragma implementation "checklst.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-#pragma hdrstop
+    #pragma hdrstop
 #endif
 
-#if wxUSE_OWNER_DRAWN
+#if wxUSE_CHECKLISTBOX && wxUSE_OWNER_DRAWN
+
+#include "wx/checklst.h"
 
 #ifndef WX_PRECOMP
+    #include "wx/msw/wrapcctl.h"
     #include "wx/object.h"
     #include "wx/colour.h"
     #include "wx/font.h"
     #include "wx/window.h"
     #include "wx/listbox.h"
     #include "wx/dcmemory.h"
-
     #include "wx/settings.h"
-
     #include "wx/log.h"
 #endif
 
 #include "wx/ownerdrw.h"
-#include "wx/checklst.h"
 
-#include <windows.h>
 #include <windowsx.h>
 
-#if defined(__GNUWIN32_OLD__)
-    #include "wx/msw/gnuwin32/extra.h"
-#endif
+#include "wx/renderer.h"
+#include "wx/msw/private.h"
+#include "wx/msw/dc.h"
 
 // ----------------------------------------------------------------------------
 // private functions
 // get item (converted to right type)
 #define GetItem(n)    ((wxCheckListBoxItem *)(GetItem(n)))
 
+namespace
+{
+    // space around check mark bitmap in pixels
+    static const int CHECKMARK_EXTRA_SPACE = 1;
+
+    // space betwen check bitmap and text label
+    static const int CHECKMARK_LABEL_SPACE = 2;
+
+} // anonymous namespace
+
 // ============================================================================
 // implementation
 // ============================================================================
 
-IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)
-
 // ----------------------------------------------------------------------------
 // declaration and implementation of wxCheckListBoxItem class
 // ----------------------------------------------------------------------------
 
 class wxCheckListBoxItem : public wxOwnerDrawn
 {
-friend class WXDLLEXPORT wxCheckListBox;
 public:
-  // ctor
-  wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex);
+    // ctor
+    wxCheckListBoxItem(wxCheckListBox *parent);
+
+    // drawing functions
+    virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
+
+    // simple accessors and operations
+    wxCheckListBox *GetParent() const
+        { return m_parent; }
 
-  // drawing functions
-  virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
+    int GetIndex() const
+        { return m_parent->GetItemIndex(const_cast<wxCheckListBoxItem*>(this)); }
 
-  // simple accessors and operations
-  bool IsChecked() const { return m_bChecked; }
+    wxString GetName() const
+        { return m_parent->GetString(GetIndex()); }
 
-  void Check(bool bCheck);
-  void Toggle() { Check(!IsChecked()); }
 
-  void SendEvent();
+    bool IsChecked() const
+        { return m_checked; }
+
+    void Check(bool bCheck)
+        { m_checked = bCheck; }
+
+    void Toggle()
+        { Check(!IsChecked()); }
 
 private:
+    wxCheckListBox *m_parent;
+    bool m_checked;
 
-    DECLARE_NO_COPY_CLASS(wxCheckListBoxItem)
-  bool            m_bChecked;
-  wxCheckListBox *m_pParent;
-  size_t          m_nIndex;
+    wxDECLARE_NO_COPY_CLASS(wxCheckListBoxItem);
 };
 
-wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)
-                  : wxOwnerDrawn(wxEmptyString, TRUE)   // checkable
+wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *parent)
 {
-  m_bChecked = FALSE;
-  m_pParent  = pParent;
-  m_nIndex   = nIndex;
+    m_parent = parent;
+    m_checked = false;
 
-  // 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
+    wxSize size = wxRendererNative::Get().GetCheckBoxSize(parent);
+    size.x += 2 * CHECKMARK_EXTRA_SPACE + CHECKMARK_LABEL_SPACE;
 
-  // fix appearance
-  SetMarginWidth(GetDefaultMarginWidth());
+    SetMarginWidth(size.GetWidth());
+    SetBackgroundColour(parent->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)
 {
-  if ( IsChecked() )
-    stat = (wxOwnerDrawn::wxODStatus)(stat | wxOwnerDrawn::wxODChecked);
-
-  if ( wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) ) {
-    // ## using native API for performance and precision
-    size_t nCheckWidth  = GetDefaultMarginWidth(),
-         nCheckHeight = m_pParent->GetItemHeight();
-
-    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++;
-
-    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);
-#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);
-#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);
-    }
-
-    // now we draw the smaller rectangle
-    y++;
-    nCheckWidth  -= 2;
-    nCheckHeight -= 2;
+    // first draw the label
+    if ( !wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) )
+        return false;
 
-    // draw hollow gray rectangle
-    (void)SelectObject(hdc, hpenGray);
-    HBRUSH hbrPrev  = (HBRUSH)SelectObject(hdc, GetStockObject(NULL_BRUSH));
-    Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
+    // now draw the check mark part
+    wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
+    HDC hdc = GetHdcOf(*impl);
 
-    // clean up
-    (void)SelectObject(hdc, hpenPrev);
-    (void)SelectObject(hdc, hbrPrev);
+    wxSize size = wxRendererNative::Get().GetCheckBoxSize(GetParent());
 
-    DeleteObject(hpenBack);
-    DeleteObject(hpenGray);
+    // first create bitmap in a memory DC
+    MemoryHDC hdcMem(hdc);
+    CompatibleBitmap hBmpCheck(hdc, size.GetWidth(), size.GetHeight());
 
-    /*
-    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;
-  }
-
-  return FALSE;
-}
-
-// change the state of the item and redraw it
-void wxCheckListBoxItem::Check(bool check)
-{
-    m_bChecked = check;
-
-    // index may be changed because new items were added/deleted
-    if ( m_pParent->GetItemIndex(this) != (int)m_nIndex )
+    // then draw a check mark into it
     {
-        // update it
-        int index = m_pParent->GetItemIndex(this);
+        SelectInHDC selBmp(hdcMem, hBmpCheck);
 
-        wxASSERT_MSG( index != wxNOT_FOUND, wxT("what does this item do here?") );
+        int flags = wxCONTROL_FLAT;
+        if ( IsChecked() )
+            flags |= wxCONTROL_CHECKED;
 
-        m_nIndex = (size_t)index;
-    }
+        wxDCTemp dcMem(hdcMem);
+        wxRendererNative::Get().DrawCheckBox(GetParent(), dcMem, wxRect(size), flags);
+    } // select hBmpCheck out of hdcMem
 
-    HWND hwndListbox = (HWND)m_pParent->GetHWND();
+    // finally draw bitmap to screen
 
-    #ifdef __WIN32__
-        RECT rcUpdate;
+    // position of check mark bitmap
+    int x = rc.GetX() + CHECKMARK_EXTRA_SPACE;
+    int y = rc.GetY() + (rc.GetHeight() - size.GetHeight()) / 2;
 
-        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);
-}
+    UINT uState = stat & wxOwnerDrawn::wxODSelected ? wxDSB_SELECTED : wxDSB_NORMAL;
+    wxDrawStateBitmap(hdc, hBmpCheck, x, y, uState);
 
-// send an "item checked" event
-void wxCheckListBoxItem::SendEvent()
-{
-    wxCommandEvent event(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, m_pParent->GetId());
-    event.SetInt(m_nIndex);
-    event.SetEventObject(m_pParent);
-    m_pParent->ProcessCommand(event);
+    return true;
 }
 
 // ----------------------------------------------------------------------------
@@ -298,6 +192,15 @@ wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
     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[],
@@ -308,77 +211,74 @@ bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
                              style | wxLB_OWNERDRAW, validator, name);
 }
 
-// misc overloaded methods
-// -----------------------
-
-void wxCheckListBox::Delete(int N)
-{
-    wxCHECK_RET( N >= 0 && N < m_noItems,
-                 wxT("invalid index in wxListBox::Delete") );
-
-    wxListBox::Delete(N);
-
-    // free memory
-    delete m_aItems[N];
-
-    m_aItems.RemoveAt(N);
-}
-
-bool wxCheckListBox::SetFont( const wxFont &font )
+bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
+                            const wxPoint& pos, const wxSize& size,
+                            const wxArrayString& choices,
+                            long style,
+                            const wxValidator& validator, const wxString& name)
 {
-    size_t i;
-    for ( i = 0; i < m_aItems.GetCount(); i++ )
-        m_aItems[i]->SetFont(font);
-
-    wxListBox::SetFont(font);
-
-    return TRUE;
+    return wxListBox::Create(parent, id, pos, size, choices,
+                             style | wxLB_OWNERDRAW, validator, name);
 }
 
 // create/retrieve item
 // --------------------
 
 // create a check list box item
-wxOwnerDrawn *wxCheckListBox::CreateLboxItem(size_t nIndex)
+wxOwnerDrawn *wxCheckListBox::CreateLboxItem(size_t WXUNUSED(n))
 {
-  wxCheckListBoxItem *pItem = new wxCheckListBoxItem(this, nIndex);
-  return pItem;
+    wxCheckListBoxItem *pItem = new wxCheckListBoxItem(this);
+    return pItem;
 }
 
 // return item size
 // ----------------
 bool wxCheckListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
 {
-  if ( wxListBox::MSWOnMeasure(item) ) {
-    MEASUREITEMSTRUCT *pStruct = (MEASUREITEMSTRUCT *)item;
+    if ( wxListBox::MSWOnMeasure(item) )
+    {
+        MEASUREITEMSTRUCT *pStruct = (MEASUREITEMSTRUCT *)item;
 
-    // save item height
-    m_nItemHeight = pStruct->itemHeight;
+        wxSize size = wxRendererNative::Get().GetCheckBoxSize(this);
+        size.x += 2 * CHECKMARK_EXTRA_SPACE;
+        size.y += 2 * CHECKMARK_EXTRA_SPACE;
 
-    // add place for the check mark
-    pStruct->itemWidth += wxOwnerDrawn::GetDefaultMarginWidth();
+        // add place for the check mark
+        pStruct->itemWidth += size.GetWidth();
 
-    return TRUE;
-  }
+        if ( pStruct->itemHeight < static_cast<unsigned int>(size.GetHeight()) )
+            pStruct->itemHeight = size.GetHeight();
 
-  return FALSE;
-}
+        return true;
+    }
+
+    return false;
+  }
 
 // 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, wxT("bad wxCheckListBox index") );
 
     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), wxT("bad wxCheckListBox index") );
 
     GetItem(uiIndex)->Check(bCheck);
+    RefreshItem(uiIndex);
+}
+
+void wxCheckListBox::Toggle(unsigned int uiIndex)
+{
+    wxCHECK_RET( IsValid(uiIndex), wxT("bad wxCheckListBox index") );
+
+    GetItem(uiIndex)->Toggle();
+    RefreshItem(uiIndex);
 }
 
 // process events
@@ -389,33 +289,33 @@ void wxCheckListBox::OnKeyDown(wxKeyEvent& event)
     // what do we do?
     enum
     {
-        None,
-        Toggle,
-        Set,
-        Clear
+        NONE,
+        TOGGLE,
+        SET,
+        CLEAR
     } oper;
 
     switch ( event.GetKeyCode() )
     {
         case WXK_SPACE:
-            oper = Toggle;
+            oper = TOGGLE;
             break;
 
         case WXK_NUMPAD_ADD:
         case '+':
-            oper = Set;
+            oper = SET;
             break;
 
         case WXK_NUMPAD_SUBTRACT:
         case '-':
-            oper = Clear;
+            oper = CLEAR;
             break;
 
         default:
-            oper = None;
+            oper = NONE;
     }
 
-    if ( oper != None )
+    if ( oper != NONE )
     {
         wxArrayInt selections;
         int count = 0;
@@ -435,31 +335,26 @@ void wxCheckListBox::OnKeyDown(wxKeyEvent& event)
 
         for ( int i = 0; i < count; i++ )
         {
-            wxCheckListBoxItem *item = GetItem(selections[i]);
-            if ( !item )
-            {
-                wxFAIL_MSG( _T("no wxCheckListBoxItem?") );
-                continue;
-            }
+            int nItem = selections[i];
 
             switch ( oper )
             {
-                case Toggle:
-                    item->Toggle();
+                case TOGGLE:
+                    Toggle(nItem);
                     break;
 
-                case Set:
-                case Clear:
-                    item->Check( oper == Set );
+                case SET:
+                case CLEAR:
+                    Check(nItem, oper == SET);
                     break;
 
                 default:
-                    wxFAIL_MSG( _T("what should this key do?") );
+                    wxFAIL_MSG( wxT("what should this key do?") );
             }
 
             // we should send an event as this has been done by the user and
             // not by the program
-            item->SendEvent();
+            SendEvent(nItem);
         }
     }
     else // nothing to do
@@ -470,40 +365,71 @@ void wxCheckListBox::OnKeyDown(wxKeyEvent& event)
 
 void wxCheckListBox::OnLeftClick(wxMouseEvent& event)
 {
-  // clicking on the item selects it, clicking on the checkmark toggles
-  if ( event.GetX() <= wxOwnerDrawn::GetDefaultMarginWidth() ) {
+    // clicking on the item selects it, clicking on the checkmark toggles
+
     int nItem = HitTest(event.GetX(), event.GetY());
 
-    if ( nItem != wxNOT_FOUND ) {
-      wxCheckListBoxItem *item = GetItem(nItem);
-      item->Toggle();
-      item->SendEvent();
+    if ( nItem != wxNOT_FOUND )
+    {
+        wxRect rect;
+        GetItemRect(nItem, rect);
+
+        // convert item rect to check mark rect
+        wxSize size = wxRendererNative::Get().GetCheckBoxSize(this);
+        rect.x += CHECKMARK_EXTRA_SPACE;
+        rect.y += (rect.GetHeight() - size.GetHeight()) / 2;
+        rect.SetSize(size);
+
+        if ( rect.Contains(event.GetX(), event.GetY()) )
+        {
+            // people expect to get "kill focus" event for the currently
+            // focused control before getting events from the other controls
+            // and, equally importantly, they may prevent the focus change from
+            // taking place at all (e.g. because the old control contents is
+            // invalid and needs to be corrected) in which case we shouldn't
+            // generate this event at all
+            SetFocus();
+            if ( FindFocus() == this )
+            {
+                Toggle(nItem);
+                SendEvent(nItem);
+
+                // scroll one item down if the item is the last one
+                // and isn't visible at all
+                int h;
+                GetClientSize(NULL, &h);
+                if ( rect.GetBottom() > h )
+                    ScrollLines(1);
+            }
+        }
+        else
+        {
+            // implement default behaviour: clicking on the item selects it
+            event.Skip();
+        }
+    }
+    else
+    {
+        // implement default behaviour on click outside of client zone
+        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
+wxSize wxCheckListBox::DoGetBestClientSize() const
 {
-  #ifdef __WIN32__
-    int nItem = (int)::SendMessage
-                             (
-                              (HWND)GetHWND(),
-                              LB_ITEMFROMPOINT,
-                              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;
-}
+    wxSize best = wxListBox::DoGetBestClientSize();
 
-#endif
+    // add room for the checkbox
+    wxSize size = wxRendererNative::Get().GetCheckBoxSize(const_cast<wxCheckListBox*>(this));
+    size.x += 2 * CHECKMARK_EXTRA_SPACE;
+    size.y += 2 * CHECKMARK_EXTRA_SPACE;
+
+    best.x += size.GetWidth();
+    if ( best.y < size.GetHeight() )
+        best.y = size.GetHeight();
+
+    CacheBestSize(best);
+    return best;
+}
 
+#endif // wxUSE_CHECKLISTBOX