]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/checklst.cpp
Check for invalid items in generic wxDataViewCtrl::GetSelections().
[wxWidgets.git] / src / msw / checklst.cpp
index 35c0f3ced928acd80e238c6a27f19d6c05c9b603..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/bitmap.h"
+    #include "wx/window.h"
+    #include "wx/listbox.h"
+    #include "wx/dcmemory.h"
+    #include "wx/settings.h"
+    #include "wx/log.h"
+#endif
 
-#include "wx/object.h"
-#include "wx/colour.h"
-#include "wx/font.h"
-#include "wx/bitmap.h"
-#include "wx/window.h"
-#include "wx/listbox.h"
 #include "wx/ownerdrw.h"
-#include "wx/settings.h"
-#include "wx/dcmemory.h"
-#include "wx/msw/checklst.h"
 
-#include <windows.h>
 #include <windowsx.h>
 
+#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
 // ============================================================================
 
-#if !USE_SHARED_LIBRARY
-  IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)
-#endif
-
 // ----------------------------------------------------------------------------
 // declaration and implementation of wxCheckListBoxItem class
 // ----------------------------------------------------------------------------
 
 class wxCheckListBoxItem : public wxOwnerDrawn
 {
-friend class wxCheckListBox;
 public:
-  // ctor
-  wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex);
-
-  // drawing functions
-  virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
+    // ctor
+    wxCheckListBoxItem(wxCheckListBox *parent);
 
-  // simple accessors
-  bool IsChecked() const  { return m_bChecked;        }
-  void Check(bool bCheck);
-  void Toggle() { Check(!IsChecked()); }
+    // drawing functions
+    virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
 
-private:
-  bool            m_bChecked;
-  wxCheckListBox *m_pParent;
-  size_t            m_nIndex;
-};
-
-wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)
-                  : wxOwnerDrawn("", 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
-  SetFont(wxSystemSettings::GetSystemFont(wxSYS_ANSI_VAR_FONT));
-  SetMarginWidth(GetDefaultMarginWidth());
-}
-
-/*
- * 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);
+    // simple accessors and operations
+    wxCheckListBox *GetParent() const
+        { return m_parent; }
 
-  if ( wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) ) {
-    // ## using native API for performance and precision
-    size_t nCheckWidth  = GetDefaultMarginWidth(),
-         nCheckHeight = m_pParent->GetItemHeight();
+    int GetIndex() const
+        { return m_parent->GetItemIndex(const_cast<wxCheckListBoxItem*>(this)); }
 
-    int x = rc.GetX(),
-        y = rc.GetY();
+    wxString GetName() const
+        { return m_parent->GetString(GetIndex()); }
 
-    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);
+    bool IsChecked() const
+        { return m_checked; }
 
-    // we erase the 1-pixel border
-    Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
+    void Check(bool bCheck)
+        { m_checked = bCheck; }
 
-    // shift check mark 1 pixel to the right (it looks better like this)
-    x++;
+    void Toggle()
+        { Check(!IsChecked()); }
 
-    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
-      RECT rect = { 0, 0, nCheckWidth, nCheckHeight };
-
-#ifdef __WIN32__
-#ifndef __SC__
-      DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
-#endif
-#else
-      // In WIN16, draw a cross
-      HPEN blackPen = CreatePen(PS_SOLID, 1, RGB(0, 0, 0));
-      HPEN whiteBrush = GetStockObject(WHITE_BRUSH);
-      HPEN hPenOld = ::SelectObject(hdcMem, blackPen);
-      HPEN hBrushOld = ::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
+private:
+    wxCheckListBox *m_parent;
+    bool m_checked;
 
-      // finally copy it to screen DC and clean up
-      BitBlt(hdc, x, y, nCheckWidth - 1, nCheckHeight,
-             hdcMem, 0, 0, SRCCOPY);
+    wxDECLARE_NO_COPY_CLASS(wxCheckListBoxItem);
+};
 
-      SelectObject(hdcMem, hbmpOld);
-      DeleteObject(hbmpCheck);
-      DeleteDC(hdcMem);
-    }
+wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *parent)
+{
+    m_parent = parent;
+    m_checked = false;
 
-    // now we draw the smaller rectangle
-    y++;
-    nCheckWidth  -= 2;
-    nCheckHeight -= 2;
+    wxSize size = wxRendererNative::Get().GetCheckBoxSize(parent);
+    size.x += 2 * CHECKMARK_EXTRA_SPACE + CHECKMARK_LABEL_SPACE;
 
-    // draw hollow gray rectangle
-    (void)SelectObject(hdc, hpenGray);
-    HBRUSH hbrPrev  = (HBRUSH)SelectObject(hdc, GetStockObject(NULL_BRUSH));
-    Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
+    SetMarginWidth(size.GetWidth());
+    SetBackgroundColour(parent->GetBackgroundColour());
+}
 
-    // clean up
-    (void)SelectObject(hdc, hpenPrev);
-    (void)SelectObject(hdc, hbrPrev);
+bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
+                                    wxODAction act, wxODStatus stat)
+{
+    // first draw the label
+    if ( !wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) )
+        return false;
 
-    DeleteObject(hpenBack);
-    DeleteObject(hpenGray);
+    // now draw the check mark part
+    wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
+    HDC hdc = GetHdcOf(*impl);
 
-    /*
-    dc.DrawRectangle(x, y, nCheckWidth, nCheckHeight);
+    wxSize size = wxRendererNative::Get().GetCheckBoxSize(GetParent());
 
-    if ( IsChecked() ) {
-      dc.DrawLine(x, y, x + nCheckWidth, y + nCheckHeight);
-      dc.DrawLine(x, y + nCheckHeight, x + nCheckWidth, y);
-    }
-    */
+    // first create bitmap in a memory DC
+    MemoryHDC hdcMem(hdc);
+    CompatibleBitmap hBmpCheck(hdc, size.GetWidth(), size.GetHeight());
 
-    return TRUE;
-  }
+    // then draw a check mark into it
+    {
+        SelectInHDC selBmp(hdcMem, hBmpCheck);
 
-  return FALSE;
-}
+        int flags = wxCONTROL_FLAT;
+        if ( IsChecked() )
+            flags |= wxCONTROL_CHECKED;
 
-// change the state of the item and redraw it
-void wxCheckListBoxItem::Check(bool check)
-{
-    m_bChecked = check;
+        wxDCTemp dcMem(hdcMem);
+        wxRendererNative::Get().DrawCheckBox(GetParent(), dcMem, wxRect(size), flags);
+    } // select hBmpCheck out of hdcMem
 
-    // index may be chanegd because new items were added/deleted
-    if ( m_pParent->GetItemIndex(this) != (int)m_nIndex )
-    {
-        // update it
-        int index = m_pParent->GetItemIndex(this);
+    // finally draw bitmap to screen
 
-        wxASSERT_MSG( index != wxNOT_FOUND, "what does this item do here?" );
+    // position of check mark bitmap
+    int x = rc.GetX() + CHECKMARK_EXTRA_SPACE;
+    int y = rc.GetY() + (rc.GetHeight() - size.GetHeight()) / 2;
 
-        m_nIndex = (size_t)index;
-    }
+    UINT uState = stat & wxOwnerDrawn::wxODSelected ? wxDSB_SELECTED : wxDSB_NORMAL;
+    wxDrawStateBitmap(hdc, hBmpCheck, x, y, uState);
 
-    size_t nHeight = m_pParent->GetItemHeight();
-    size_t y = m_nIndex * nHeight;
-    RECT rcUpdate = { 0, y, GetDefaultMarginWidth(), y + nHeight};
-    InvalidateRect((HWND)m_pParent->GetHWND(), &rcUpdate, FALSE);
-    
-    wxCommandEvent event(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, m_pParent->GetId());
-    event.SetInt(m_nIndex);
-    event.SetEventObject(m_pParent);
-    m_pParent->ProcessCommand(event);
+    return true;
 }
 
 // ----------------------------------------------------------------------------
@@ -240,7 +170,7 @@ void wxCheckListBoxItem::Check(bool check)
 // define event table
 // ------------------
 BEGIN_EVENT_TABLE(wxCheckListBox, wxListBox)
-  EVT_CHAR(wxCheckListBox::OnChar)
+  EVT_KEY_DOWN(wxCheckListBox::OnKeyDown)
   EVT_LEFT_DOWN(wxCheckListBox::OnLeftClick)
 END_EVENT_TABLE()
 
@@ -248,7 +178,7 @@ END_EVENT_TABLE()
 // ----------------
 
 // def ctor: use Create() to really create the control
-wxCheckListBox::wxCheckListBox() : wxListBox()
+wxCheckListBox::wxCheckListBox()
 {
 }
 
@@ -258,112 +188,248 @@ wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
                                int nStrings, const wxString choices[],
                                long style, const wxValidator& val,
                                const wxString& name)
-              : wxListBox()
 {
-    Create(parent, id, pos, size, nStrings, choices,
-           style | wxLB_OWNERDRAW, val, name);
+    Create(parent, id, pos, size, nStrings, choices, style, val, name);
 }
 
-void wxCheckListBox::Delete(int N)
+wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
+                               const wxPoint& pos, const wxSize& size,
+                               const wxArrayString& choices,
+                               long style, const wxValidator& val,
+                               const wxString& name)
 {
-    wxCHECK_RET( N >= 0 && N < m_noItems,
-                 "invalid index in wxListBox::Delete" );
-
-    wxListBox::Delete(N);
-
-    // free memory
-    delete m_aItems[N];
-
-    m_aItems.Remove(N);
+    Create(parent, id, pos, size, choices, style, val, name);
 }
 
-void wxCheckListBox::InsertItems(int nItems, const wxString items[], int pos)
+bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
+                            const wxPoint& pos, const wxSize& size,
+                            int n, const wxString choices[],
+                            long style,
+                            const wxValidator& validator, const wxString& name)
 {
-    wxCHECK_RET( pos >= 0 && pos <= m_noItems,
-                 "invalid index in wxCheckListBox::InsertItems" );
-
-    wxListBox::InsertItems(nItems, items, pos);
+    return wxListBox::Create(parent, id, pos, size, n, choices,
+                             style | wxLB_OWNERDRAW, validator, name);
+}
 
-    int i;
-    for ( i = 0; i < nItems; i++ ) {
-        wxOwnerDrawn *pNewItem = CreateItem((size_t)(pos + i));
-        pNewItem->SetName(items[i]);
-        m_aItems.Insert(pNewItem, (size_t)(pos + i));
-        ListBox_SetItemData((HWND)GetHWND(), i + pos, pNewItem);
-    }
+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);
 }
 
 // create/retrieve item
 // --------------------
 
 // create a check list box item
-wxOwnerDrawn *wxCheckListBox::CreateItem(size_t nIndex)
+wxOwnerDrawn *wxCheckListBox::CreateLboxItem(size_t WXUNUSED(n))
 {
-  wxCheckListBoxItem *pItem = new wxCheckListBoxItem(this, nIndex);
-  if ( m_windowFont.Ok() )
-    pItem->SetFont(m_windowFont);
-
-  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
 {
-  return GetItem(uiIndex)->IsChecked();
+    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)
 {
-  GetItem(uiIndex)->Check(bCheck);
+    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
 // --------------
 
-void wxCheckListBox::OnChar(wxKeyEvent& event)
+void wxCheckListBox::OnKeyDown(wxKeyEvent& event)
 {
-  if ( event.KeyCode() == WXK_SPACE )
-    GetItem(GetSelection())->Toggle();
-  else
-    wxListBox::OnChar(event);
+    // what do we do?
+    enum
+    {
+        NONE,
+        TOGGLE,
+        SET,
+        CLEAR
+    } oper;
+
+    switch ( event.GetKeyCode() )
+    {
+        case WXK_SPACE:
+            oper = TOGGLE;
+            break;
+
+        case WXK_NUMPAD_ADD:
+        case '+':
+            oper = SET;
+            break;
+
+        case WXK_NUMPAD_SUBTRACT:
+        case '-':
+            oper = CLEAR;
+            break;
+
+        default:
+            oper = NONE;
+    }
+
+    if ( oper != NONE )
+    {
+        wxArrayInt selections;
+        int count = 0;
+        if ( HasMultipleSelection() )
+        {
+            count = GetSelections(selections);
+        }
+        else
+        {
+            int sel = GetSelection();
+            if (sel != -1)
+            {
+                count = 1;
+                selections.Add(sel);
+            }
+        }
+
+        for ( int i = 0; i < count; i++ )
+        {
+            int nItem = selections[i];
+
+            switch ( oper )
+            {
+                case TOGGLE:
+                    Toggle(nItem);
+                    break;
+
+                case SET:
+                case CLEAR:
+                    Check(nItem, oper == SET);
+                    break;
+
+                default:
+                    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
+            SendEvent(nItem);
+        }
+    }
+    else // nothing to do
+    {
+        event.Skip();
+    }
 }
 
 void wxCheckListBox::OnLeftClick(wxMouseEvent& event)
 {
-  // clicking on the item selects it, clicking on the checkmark toggles
-  if ( event.GetX() <= wxOwnerDrawn::GetDefaultMarginWidth() ) {
-    // FIXME better use LB_ITEMFROMPOINT perhaps?
-    size_t nItem = ((size_t)event.GetY()) / m_nItemHeight;
-    if ( nItem < (size_t)m_noItems )
-      GetItem(nItem)->Toggle();
-    //else: it's not an error, just click outside of client zone
-  }
-  else {
-    // implement default behaviour: clicking on the item selects it
-    event.Skip();
-  }
+    // clicking on the item selects it, clicking on the checkmark toggles
+
+    int nItem = HitTest(event.GetX(), event.GetY());
+
+    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();
+    }
 }
 
-#endif
+wxSize wxCheckListBox::DoGetBestClientSize() const
+{
+    wxSize best = wxListBox::DoGetBestClientSize();
+
+    // 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