]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/listctrl.cpp
Updated to Scintilla 1.67
[wxWidgets.git] / src / msw / listctrl.cpp
index 5a8c4e336386fc2ce065bd466ad3c9d5dce2ca51..3516a389731d71306ac12fa0f751ef48265c119a 100644 (file)
@@ -24,7 +24,7 @@
     #pragma hdrstop
 #endif
 
-#if wxUSE_LISTCTRL && defined(__WIN95__)
+#if wxUSE_LISTCTRL
 
 #ifndef WX_PRECOMP
     #include "wx/app.h"
@@ -78,7 +78,9 @@ static void wxConvertFromMSWListItem(HWND hwndListCtrl,
                                      /* const */ LV_ITEM& lvItem);
 
 // convert our wxListItem to LV_COLUMN
-static void wxConvertToMSWListCol(int col, const wxListItem& item,
+static void wxConvertToMSWListCol(HWND hwndList,
+                                  int col,
+                                  const wxListItem& item,
                                   LV_COLUMN& lvCol);
 
 // ----------------------------------------------------------------------------
@@ -212,7 +214,7 @@ public:
 // Get the internal data structure
 static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId);
 static wxListItemInternalData *wxGetInternalData(const wxListCtrl *ctl, long itemId);
-static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId);
+static wxListItemAttr *wxGetInternalDataAttr(const wxListCtrl *ctl, long itemId);
 static void wxDeleteInternalData(wxListCtrl* ctl, long itemId);
 
 
@@ -371,7 +373,7 @@ bool wxListCtrl::Create(wxWindow *parent,
     if ( InReportView() && wxApp::GetComCtl32Version() >= 470 )
     {
         ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE,
-                      0, LVS_EX_LABELTIP | LVS_EX_FULLROWSELECT);
+                      0, LVS_EX_LABELTIP | LVS_EX_FULLROWSELECT | LVS_EX_SUBITEMIMAGES);
     }
 
     return true;
@@ -666,7 +668,7 @@ bool wxListCtrl::GetColumn(int col, wxListItem& item) const
 bool wxListCtrl::SetColumn(int col, const wxListItem& item)
 {
     LV_COLUMN lvCol;
-    wxConvertToMSWListCol(col, item, lvCol);
+    wxConvertToMSWListCol(GetHwnd(), col, item, lvCol);
 
     return ListView_SetColumn(GetHwnd(), col, &lvCol) != 0;
 }
@@ -788,12 +790,15 @@ bool wxListCtrl::SetItem(wxListItem& info)
             data->lParam = info.m_data;
 
         // attributes
-        if (info.HasAttributes())
+        if ( info.HasAttributes() )
         {
-            if (data->attr)
-                *data->attr = *info.GetAttributes();
+            const wxListItemAttr& attrNew = *info.GetAttributes();
+
+            // don't overwrite the already set attributes if we have them
+            if ( data->attr )
+                data->attr->AssignFrom(attrNew);
             else
-                data->attr = new wxListItemAttr(*info.GetAttributes());
+                data->attr = new wxListItemAttr(attrNew);
         };
     };
 
@@ -1367,11 +1372,25 @@ wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass)
 }
 
 // End label editing, optionally cancelling the edit
-bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel))
+bool wxListCtrl::EndEditLabel(bool cancel)
 {
-    wxFAIL_MSG( _T("not implemented") );
-
-    return false;
+    // m_textCtrl is not always ready, ie. in EVT_LIST_BEGIN_LABEL_EDIT
+    HWND hwnd = ListView_GetEditControl(GetHwnd());
+    bool b = (hwnd != NULL);
+    if (b)
+    {
+        if (cancel)
+            ::SetWindowText(hwnd, wxEmptyString); // dubious but better than nothing
+        if (m_textCtrl)
+        {
+            m_textCtrl->UnsubclassWin();
+            m_textCtrl->SetHWND(0);
+            delete m_textCtrl;
+            m_textCtrl = NULL;
+        }
+        ::DestroyWindow(hwnd);
+    }
+    return b;
 }
 
 // Ensures this item is visible
@@ -1566,7 +1585,7 @@ long wxListCtrl::InsertItem(long index, const wxString& label, int imageIndex)
 long wxListCtrl::InsertColumn(long col, const wxListItem& item)
 {
     LV_COLUMN lvCol;
-    wxConvertToMSWListCol(col, item, lvCol);
+    wxConvertToMSWListCol(GetHwnd(), col, item, lvCol);
 
     if ( !(lvCol.mask & LVCF_WIDTH) )
     {
@@ -2136,7 +2155,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             case NM_CUSTOMDRAW:
                 *result = OnCustomDraw(lParam);
 
-                return true;
+                return *result != CDRF_DODEFAULT;
 #endif // _WIN32_IE >= 0x300
 
             case LVN_ODCACHEHINT:
@@ -2250,7 +2269,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 #ifdef NM_CUSTOMDRAW
                     if ( lvi.mask & LVIF_IMAGE )
                     {
-                        lvi.iImage = OnGetItemImage(item);
+                        lvi.iImage = OnGetItemColumnImage(item, lvi.iSubItem);
                     }
 #endif // NM_CUSTOMDRAW
 
@@ -2327,13 +2346,238 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
     return processed;
 }
 
+// ----------------------------------------------------------------------------
+// custom draw stuff
+// ----------------------------------------------------------------------------
+
 // see comment at the end of wxListCtrl::GetColumn()
 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
 
+static RECT GetCustomDrawnItemRect(const NMCUSTOMDRAW& nmcd)
+{
+    RECT rc;
+    ListView_GetItemRect(nmcd.hdr.hwndFrom, nmcd.dwItemSpec, &rc, LVIR_BOUNDS);
+
+    RECT rcIcon;
+    ListView_GetItemRect(nmcd.hdr.hwndFrom, nmcd.dwItemSpec, &rcIcon, LVIR_ICON);
+
+    // exclude the icon part, neither the selection background nor focus rect
+    // should cover it
+    rc.left = rcIcon.right;
+
+    return rc;
+}
+
+static void HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
+{
+    NMCUSTOMDRAW& nmcd = pLVCD->nmcd;
+
+    HDC hdc = nmcd.hdc;
+    HWND hwndList = nmcd.hdr.hwndFrom;
+    const DWORD item = nmcd.dwItemSpec;
+
+
+    // the font must be valid, otherwise we wouldn't be painting the item at all
+    SelectInHDC selFont(hdc, hfont);
+
+    // get the rectangle to paint
+    RECT rc;
+    ListView_GetSubItemRect(hwndList, item, pLVCD->iSubItem, LVIR_BOUNDS, &rc);
+    if ( !pLVCD->iSubItem )
+    {
+        // broken ListView_GetSubItemRect() returns the entire item rect for
+        // 0th subitem while we really need just the part for this column
+        RECT rc2;
+        ListView_GetSubItemRect(hwndList, item, 1, LVIR_BOUNDS, &rc2);
+
+        rc.right = rc2.left;
+        rc.left += 4;
+    }
+    else // not first subitem
+    {
+        rc.left += 6;
+    }
+
+    // get the image and text to draw
+    wxChar text[512];
+    LV_ITEM it;
+    wxZeroMemory(it);
+    it.mask = LVIF_TEXT | LVIF_IMAGE;
+    it.iItem = item;
+    it.iSubItem = pLVCD->iSubItem;
+    it.pszText = text;
+    it.cchTextMax = WXSIZEOF(text);
+    ListView_GetItem(hwndList, &it);
+
+    HIMAGELIST himl = ListView_GetImageList(hwndList, LVSIL_SMALL);
+    if ( himl && ImageList_GetImageCount(himl) )
+    {
+        if ( it.iImage != -1 )
+        {
+            ImageList_Draw(himl, it.iImage, hdc, rc.left, rc.top,
+                           nmcd.uItemState & CDIS_SELECTED ? ILD_SELECTED
+                                                           : ILD_TRANSPARENT);
+        }
+
+        // notice that even if this item doesn't have any image, the list
+        // control still leaves space for the image in the first column if the
+        // image list is not empty (presumably so that items with and without
+        // images align?)
+        if ( it.iImage != -1 || it.iSubItem == 0 )
+        {
+            int wImage, hImage;
+            ImageList_GetIconSize(himl, &wImage, &hImage);
+
+            rc.left += wImage + 2;
+        }
+    }
+
+    ::SetBkMode(hdc, TRANSPARENT);
+
+    // TODO: support for centred/right aligned columns
+    ::DrawText(hdc, text, -1, &rc,
+#ifndef __WXWINCE__
+               DT_WORD_ELLIPSIS |
+#endif // __WXWINCE__
+               DT_NOPREFIX | DT_SINGLELINE | DT_VCENTER);
+}
+
+static void HandleItemPostpaint(NMCUSTOMDRAW nmcd)
+{
+    if ( nmcd.uItemState & CDIS_FOCUS )
+    {
+        RECT rc = GetCustomDrawnItemRect(nmcd);
+
+        // don't use the provided HDC, it's in some strange state by now
+        ::DrawFocusRect(WindowHDC(nmcd.hdr.hwndFrom), &rc);
+    }
+}
+
+// pLVCD->clrText and clrTextBk should contain the colours to use
+static void HandleItemPaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
+{
+    NMCUSTOMDRAW& nmcd = pLVCD->nmcd; // just a shortcut
+
+    const HWND hwndList = nmcd.hdr.hwndFrom;
+    const int item = nmcd.dwItemSpec;
+
+    // unfortunately we can't trust CDIS_SELECTED, it is often set even when
+    // the item is not at all selected for some reason (comctl32 6), but we
+    // also can't always trust ListView_GetItem() as it could return the old
+    // item status if we're called just after the (de)selection, so remember
+    // the last item to gain selection and also check for it here
+    for ( int i = -1;; )
+    {
+        i = ListView_GetNextItem(hwndList, i, LVNI_SELECTED);
+        if ( i == -1 )
+        {
+            nmcd.uItemState &= ~CDIS_SELECTED;
+            break;
+        }
+
+        if ( i == item )
+        {
+            nmcd.uItemState |= CDIS_SELECTED;
+            break;
+        }
+    }
+
+    // same thing for CDIS_FOCUS (except simpler as there is only one of them)
+    if ( ::GetFocus() == hwndList &&
+            ListView_GetNextItem(hwndList, -1, LVNI_FOCUSED) == item )
+    {
+        nmcd.uItemState |= CDIS_FOCUS;
+    }
+    else
+    {
+        nmcd.uItemState &= ~CDIS_FOCUS;
+    }
+
+    if ( nmcd.uItemState & CDIS_SELECTED )
+    {
+        int syscolFg, syscolBg;
+        if ( ::GetFocus() == hwndList )
+        {
+            syscolFg = COLOR_HIGHLIGHTTEXT;
+            syscolBg = COLOR_HIGHLIGHT;
+        }
+        else // selected but unfocused
+        {
+            syscolFg = COLOR_WINDOWTEXT;
+            syscolBg = COLOR_BTNFACE;
+
+            // don't grey out the icon in this case neither
+            nmcd.uItemState &= ~CDIS_SELECTED;
+        }
+
+        pLVCD->clrText = ::GetSysColor(syscolFg);
+        pLVCD->clrTextBk = ::GetSysColor(syscolBg);
+    }
+    //else: not selected, use normal colours from pLVCD
+
+    HDC hdc = nmcd.hdc;
+    RECT rc = GetCustomDrawnItemRect(nmcd);
+
+    ::SetTextColor(hdc, pLVCD->clrText);
+    ::FillRect(hdc, &rc, AutoHBRUSH(pLVCD->clrTextBk));
+
+    // we could use CDRF_NOTIFYSUBITEMDRAW here but it results in weird repaint
+    // problems so just draw everything except the focus rect from here instead
+    const int colCount = Header_GetItemCount(ListView_GetHeader(hwndList));
+    for ( int col = 0; col < colCount; col++ )
+    {
+        pLVCD->iSubItem = col;
+        HandleSubItemPrepaint(pLVCD, hfont);
+    }
+
+    HandleItemPostpaint(nmcd);
+}
+
+static WXLPARAM HandleItemPrepaint(wxListCtrl *listctrl,
+                                   LPNMLVCUSTOMDRAW pLVCD,
+                                   wxListItemAttr *attr)
+{
+    if ( !attr )
+    {
+        // nothing to do for this item
+        return CDRF_DODEFAULT;
+    }
+
+
+    // set the colours to use for text drawing
+    pLVCD->clrText = attr->HasTextColour()
+                     ? wxColourToRGB(attr->GetTextColour())
+                     : wxColourToRGB(listctrl->GetTextColour());
+    pLVCD->clrTextBk = attr->HasBackgroundColour()
+                       ? wxColourToRGB(attr->GetBackgroundColour())
+                       : wxColourToRGB(listctrl->GetBackgroundColour());
+
+    // select the font if non default one is specified
+    if ( attr->HasFont() )
+    {
+        wxFont font = attr->GetFont();
+        if ( font.GetEncoding() != wxFONTENCODING_SYSTEM )
+        {
+            // the standard control ignores the font encoding/charset, at least
+            // with recent comctl32.dll versions (5 and 6, it uses to work with
+            // 4.something) so we have to draw the item entirely ourselves in
+            // this case
+            HandleItemPaint(pLVCD, GetHfontOf(font));
+            return CDRF_SKIPDEFAULT;
+        }
+
+        ::SelectObject(pLVCD->nmcd.hdc, GetHfontOf(font));
+
+        return CDRF_NEWFONT;
+    }
+
+    return CDRF_DODEFAULT;
+}
+
 WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
 {
-    LPNMLVCUSTOMDRAW lplvcd = (LPNMLVCUSTOMDRAW)lParam;
-    NMCUSTOMDRAW& nmcd = lplvcd->nmcd;
+    LPNMLVCUSTOMDRAW pLVCD = (LPNMLVCUSTOMDRAW)lParam;
+    NMCUSTOMDRAW& nmcd = pLVCD->nmcd;
     switch ( nmcd.dwDrawStage )
     {
         case CDDS_PREPAINT:
@@ -2342,78 +2586,22 @@ WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
             //
             // for virtual controls, always suppose that we have attributes as
             // there is no way to check for this
-            return IsVirtual() || m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW
-                                               : CDRF_DODEFAULT;
+            if ( IsVirtual() || m_hasAnyAttr )
+                return CDRF_NOTIFYITEMDRAW;
+            break;
 
         case CDDS_ITEMPREPAINT:
-            {
-                size_t item = (size_t)nmcd.dwItemSpec;
-                if ( item >= (size_t)GetItemCount() )
-                {
-                    // we get this message with item == 0 for an empty control,
-                    // we must ignore it as calling OnGetItemAttr() would be
-                    // wrong
-                    return CDRF_DODEFAULT;
-                }
-
-                wxListItemAttr *attr =
-                    IsVirtual() ? OnGetItemAttr(item)
-                                : wxGetInternalDataAttr(this, item);
+            const int item = nmcd.dwItemSpec;
 
-                if ( !attr )
-                {
-                    // nothing to do for this item
-                    return CDRF_DODEFAULT;
-                }
-
-                HFONT hFont;
-                wxColour colText, colBack;
-                if ( attr->HasFont() )
-                {
-                    wxFont font = attr->GetFont();
-                    hFont = (HFONT)font.GetResourceHandle();
-                }
-                else
-                {
-                    hFont = 0;
-                }
-
-                if ( attr->HasTextColour() )
-                {
-                    colText = attr->GetTextColour();
-                }
-                else
-                {
-                    colText = GetTextColour();
-                }
-
-                if ( attr->HasBackgroundColour() )
-                {
-                    colBack = attr->GetBackgroundColour();
-                }
-                else
-                {
-                    colBack = GetBackgroundColour();
-                }
-
-                lplvcd->clrText = wxColourToRGB(colText);
-                lplvcd->clrTextBk = wxColourToRGB(colBack);
-
-                // note that if we wanted to set colours for
-                // individual columns (subitems), we would have
-                // returned CDRF_NOTIFYSUBITEMREDRAW from here
-                if ( hFont )
-                {
-                    ::SelectObject(nmcd.hdc, hFont);
-
-                    return CDRF_NEWFONT;
-                }
-            }
-            // fall through to return CDRF_DODEFAULT
+            // we get this message with item == 0 for an empty control, we
+            // must ignore it as calling OnGetItemAttr() would be wrong
+            if ( item < 0 || item >= GetItemCount() )
+                break;
 
-        default:
-            return CDRF_DODEFAULT;
+            return HandleItemPrepaint(this, pLVCD, DoGetItemAttr(item));
     }
+
+    return CDRF_DODEFAULT;
 }
 
 #endif // NM_CUSTOMDRAW supported
@@ -2421,6 +2609,15 @@ WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
 // Necessary for drawing hrules and vrules, if specified
 void wxListCtrl::OnPaint(wxPaintEvent& event)
 {
+    bool drawHRules = HasFlag(wxLC_HRULES);
+    bool drawVRules = HasFlag(wxLC_VRULES);
+
+    if (!InReportView() || !drawHRules && !drawVRules)
+    {
+        event.Skip();
+        return;
+    }
+
     wxPaintDC dc(this);
 
     wxControl::OnPaint(event);
@@ -2428,12 +2625,6 @@ void wxListCtrl::OnPaint(wxPaintEvent& event)
     // Reset the device origin since it may have been set
     dc.SetDeviceOrigin(0, 0);
 
-    bool drawHRules = HasFlag(wxLC_HRULES);
-    bool drawVRules = HasFlag(wxLC_VRULES);
-
-    if (!InReportView() || !drawHRules && !drawVRules)
-        return;
-
     wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID);
     dc.SetPen(pen);
     dc.SetBrush(* wxTRANSPARENT_BRUSH);
@@ -2472,13 +2663,23 @@ void wxListCtrl::OnPaint(wxPaintEvent& event)
 
         if (GetItemRect(i, itemRect))
         {
-            int col;
+            // this is a fix for bug 673394: erase the pixels which we would
+            // otherwise leave on the screen
+            static const int gap = 2;
+            dc.SetPen(*wxTRANSPARENT_PEN);
+            dc.SetBrush(wxBrush(GetBackgroundColour()));
+            dc.DrawRectangle(0, firstItemRect.GetY() - gap,
+                             clientSize.GetWidth(), gap);
+
+            dc.SetPen(pen);
+            dc.SetBrush(*wxTRANSPARENT_BRUSH);
             int x = itemRect.GetX();
-            for (col = 0; col < GetColumnCount(); col++)
+            for (int col = 0; col < GetColumnCount(); col++)
             {
                 int colWidth = GetColumnWidth(col);
                 x += colWidth ;
-                dc.DrawLine(x-1, firstItemRect.GetY() - 2, x-1, itemRect.GetBottom());
+                dc.DrawLine(x-1, firstItemRect.GetY() - gap,
+                            x-1, itemRect.GetBottom());
             }
         }
     }
@@ -2516,7 +2717,15 @@ int wxListCtrl::OnGetItemImage(long WXUNUSED(item)) const
 {
     wxCHECK_MSG(!GetImageList(wxIMAGE_LIST_SMALL),
                 -1,
-                wxT("List control has an image list, OnGetItemImage should be overridden."));
+                wxT("List control has an image list, OnGetItemImage or OnGetItemColumnImage should be overridden."));
+    return -1;
+}
+
+int wxListCtrl::OnGetItemColumnImage(long item, long column) const
+{
+    if (!column)
+        return OnGetItemImage(item);
+
     return -1;
 }
 
@@ -2529,6 +2738,12 @@ wxListItemAttr *wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item)) cons
     return NULL;
 }
 
+wxListItemAttr *wxListCtrl::DoGetItemAttr(long item) const
+{
+    return IsVirtual() ? OnGetItemAttr(item)
+                       : wxGetInternalDataAttr(this, item);
+}
+
 void wxListCtrl::SetItemCount(long count)
 {
     wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
@@ -2593,7 +2808,8 @@ wxListItemInternalData *wxGetInternalData(const wxListCtrl *ctl, long itemId)
     return wxGetInternalData(GetHwndOf(ctl), itemId);
 }
 
-static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId)
+static
+wxListItemAttr *wxGetInternalDataAttr(const wxListCtrl *ctl, long itemId)
 {
     wxListItemInternalData *data = wxGetInternalData(ctl, itemId);
 
@@ -2775,7 +2991,9 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
         lvItem.mask |= LVIF_IMAGE;
 }
 
-static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item,
+static void wxConvertToMSWListCol(HWND hwndList,
+                                  int col,
+                                  const wxListItem& item,
                                   LV_COLUMN& lvCol)
 {
     wxZeroMemory(lvCol);
@@ -2815,9 +3033,9 @@ static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item,
     {
         if ( wxTheApp->GetComCtl32Version() >= 470 )
         {
-            lvCol.mask |= LVCF_IMAGE | LVCF_FMT;
+            lvCol.mask |= LVCF_IMAGE;
 
-            // we use LVCFMT_BITMAP_ON_RIGHT because themages on the right
+            // we use LVCFMT_BITMAP_ON_RIGHT because the images on the right
             // seem to be generally nicer than on the left and the generic
             // version only draws them on the right (we don't have a flag to
             // specify the image location anyhow)
@@ -2825,7 +3043,24 @@ static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item,
             // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
             // make any difference in my tests -- but maybe we should?
             if ( item.m_image != -1 )
+            {
+                // as we're going to overwrite the format field, get its
+                // current value first -- unless we want to overwrite it anyhow
+                if ( !(lvCol.mask & LVCF_FMT) )
+                {
+                    LV_COLUMN lvColOld;
+                    wxZeroMemory(lvColOld);
+                    lvColOld.mask = LVCF_FMT;
+                    if ( ListView_GetColumn(hwndList, col, &lvColOld) )
+                    {
+                        lvCol.fmt = lvColOld.fmt;
+                    }
+
+                    lvCol.mask |= LVCF_FMT;
+                }
+
                 lvCol.fmt |= LVCFMT_BITMAP_ON_RIGHT | LVCFMT_IMAGE;
+            }
 
             lvCol.iImage = item.m_image;
         }