]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/listctrl.cpp
moved assert for parent window not being a static box to common code where it should...
[wxWidgets.git] / src / msw / listctrl.cpp
index ff95a5ce0e22a72eee81fbe3493a9cc9cf302845..15356ad7d985ae2b1e1eafc3096e0f6231b954c0 100644 (file)
@@ -79,7 +79,7 @@ static void wxConvertToMSWListCol(int col, const wxListItem& item,
 
 // We have to handle both fooW and fooA notifications in several cases
 // because of broken commctl.dll and/or unicows.dll. This class is used to
-// convert LV_ITEMA and LV_ITEMW to LV_ITEM (which is either LV_ITEMA or 
+// convert LV_ITEMA and LV_ITEMW to LV_ITEM (which is either LV_ITEMA or
 // LV_ITEMW depending on wxUSE_UNICODE setting), so that it can be processed
 // by wxConvertToMSWListItem().
 class wxLV_ITEM
@@ -100,58 +100,70 @@ public:
         }
         else
             m_buf = NULL;
-    }   
+    }
 private:
     wxMB2WXbuf *m_buf;
 
-#else
+#else // !wxUSE_UNICODE
     wxLV_ITEM(LV_ITEMW &item)
     {
         m_item = new LV_ITEM((LV_ITEM&)item);
+
+        // the code below doesn't compile without wxUSE_WCHAR_T and as I don't
+        // know if it's useful to have it at all (do we ever get Unicode
+        // notifications in ANSI mode? I don't think so...) I'm not going to
+        // write alternative implementation right now
+        //
+        // but if it is indeed used, we should simply directly use
+        // ::WideCharToMultiByte() here
+#if wxUSE_WCHAR_T
         if ( (item.mask & LVIF_TEXT) && item.pszText )
         {
             m_buf = new wxWC2WXbuf(wxConvLocal.cWC2WX(item.pszText));
             m_item->pszText = (wxChar*)m_buf->data();
         }
         else
+#endif // wxUSE_WCHAR_T
             m_buf = NULL;
-    }   
+    }
     wxLV_ITEM(LV_ITEMA &item) : m_buf(NULL), m_item(&item) {}
 private:
     wxWC2WXbuf *m_buf;
-#endif
+#endif // wxUSE_UNICODE/!wxUSE_UNICODE
 
     LV_ITEM *m_item;
+
+    DECLARE_NO_COPY_CLASS(wxLV_ITEM)
 };
 
 ///////////////////////////////////////////////////////
 // Problem:
-// The MSW version had problems with SetTextColour() et 
-// al as the wxListItemAttr's were stored keyed on the 
-// item index. If a item was inserted anywhere but the end 
-// of the list the the text attributes (colour etc) for 
+// The MSW version had problems with SetTextColour() et
+// al as the wxListItemAttr's were stored keyed on the
+// item index. If a item was inserted anywhere but the end
+// of the list the the text attributes (colour etc) for
 // the following items were out of sync.
-// 
+//
 // Solution:
-// Under MSW the only way to associate data with a List 
-// item independant of its position in the list is to 
-// store a pointer to it in its lParam attribute. However 
-// user programs are already using this (via the 
+// Under MSW the only way to associate data with a List
+// item independant of its position in the list is to
+// store a pointer to it in its lParam attribute. However
+// user programs are already using this (via the
 // SetItemData() GetItemData() calls).
-// 
-// However what we can do is store a pointer to a 
-// structure which contains the attributes we want *and* 
+//
+// However what we can do is store a pointer to a
+// structure which contains the attributes we want *and*
 // a lParam for the users data, e.g.
-// 
+//
 // class wxListItemInternalData
 // {
 // public:
-//   wxListItemAttr *attr; 
+//   wxListItemAttr *attr;
 //   long lParam; // user data
 // };
-// 
-// To conserve memory, a wxListItemInternalData is 
-// only allocated for a LV_ITEM if text attributes or 
+//
+// To conserve memory, a wxListItemInternalData is
+// only allocated for a LV_ITEM if text attributes or
 // user data(lparam) are being set.
 
 
@@ -159,7 +171,7 @@ private:
 class wxListItemInternalData
 {
 public:
-   wxListItemAttr *attr; 
+   wxListItemAttr *attr;
    LPARAM lParam; // user data
 
    wxListItemInternalData() : attr(NULL), lParam(0) {}
@@ -168,12 +180,15 @@ public:
        if (attr)
            delete attr;
    };
+
+    DECLARE_NO_COPY_CLASS(wxListItemInternalData)
 };
 
 // Get the internal data structure
-static wxListItemInternalData *GetInternalData(HWND hwnd, long itemId);
-static wxListItemInternalData *GetInternalData(wxListCtrl *ctl, long itemId);
-static wxListItemAttr *GetInternalDataAttr(wxListCtrl *ctl, long itemId);
+static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId);
+static wxListItemInternalData *wxGetInternalData(wxListCtrl *ctl, long itemId);
+static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId);
+static void wxDeleteInternalData(wxListCtrl* ctl, long itemId);
 
 
 // ----------------------------------------------------------------------------
@@ -359,17 +374,15 @@ void wxListCtrl::UpdateStyle()
 void wxListCtrl::FreeAllInternalData()
 {
     if (m_AnyInternalData)
-        {
+    {
         int n = GetItemCount();
         int i = 0;
 
         for (i = 0; i < n; i++)
-        {
-            wxListItemInternalData *data = GetInternalData(this, i);
-            if (data)
-                delete data;
-        };
-    };
+            wxDeleteInternalData(this, i);
+
+        m_AnyInternalData = FALSE;
+    }
 }
 
 wxListCtrl::~wxListCtrl()
@@ -580,6 +593,8 @@ bool wxListCtrl::GetColumn(int col, wxListItem& item) const
     LV_COLUMN lvCol;
     wxZeroMemory(lvCol);
 
+    lvCol.mask = LVCF_WIDTH;
+
     if ( item.m_mask & wxLIST_MASK_TEXT )
     {
         lvCol.mask |= LVCF_TEXT;
@@ -587,7 +602,17 @@ bool wxListCtrl::GetColumn(int col, wxListItem& item) const
         lvCol.cchTextMax = 512;
     }
 
-    bool success = ListView_GetColumn(GetHwnd(), col, & lvCol) != 0;
+    if ( item.m_mask & wxLIST_MASK_FORMAT )
+    {
+        lvCol.mask |= LVCF_FMT;
+    }
+
+    if ( item.m_mask & wxLIST_MASK_IMAGE )
+    {
+        lvCol.mask |= LVCF_IMAGE;
+    }
+
+    bool success = ListView_GetColumn(GetHwnd(), col, &lvCol) != 0;
 
     //  item.m_subItem = lvCol.iSubItem;
     item.m_width = lvCol.cx;
@@ -600,14 +625,29 @@ bool wxListCtrl::GetColumn(int col, wxListItem& item) const
 
     if ( item.m_mask & wxLIST_MASK_FORMAT )
     {
-        if (lvCol.fmt == LVCFMT_LEFT)
-            item.m_format = wxLIST_FORMAT_LEFT;
-        else if (lvCol.fmt == LVCFMT_RIGHT)
-            item.m_format = wxLIST_FORMAT_RIGHT;
-        else if (lvCol.fmt == LVCFMT_CENTER)
-            item.m_format = wxLIST_FORMAT_CENTRE;
+        switch (lvCol.fmt & LVCFMT_JUSTIFYMASK) {
+            case LVCFMT_LEFT:
+                item.m_format = wxLIST_FORMAT_LEFT;
+                break;
+            case LVCFMT_RIGHT:
+                item.m_format = wxLIST_FORMAT_RIGHT;
+                break;
+            case LVCFMT_CENTER:
+                item.m_format = wxLIST_FORMAT_CENTRE;
+                break;
+            default:
+                item.m_format = -1;  // Unknown?
+                break;
+        }
     }
 
+#if _WIN32_IE >= 0x0300
+    if ( item.m_mask & wxLIST_MASK_IMAGE )
+    {
+        item.m_image = lvCol.iImage;
+    }
+#endif
+
     return success;
 }
 
@@ -723,8 +763,8 @@ bool wxListCtrl::SetItem(wxListItem& info)
     {
         // get internal item data
         // perhaps a cache here ?
-        wxListItemInternalData *data = GetInternalData(this, info.m_itemId);
-        
+        wxListItemInternalData *data = wxGetInternalData(this, info.m_itemId);
+
         if (! data)
         {
             // need to set it
@@ -884,7 +924,7 @@ wxString wxListCtrl::GetItemText(long item) const
     info.m_itemId = item;
 
     if (!GetItem(info))
-        return wxString("");
+        return wxEmptyString;
     return info.m_text;
 }
 
@@ -944,11 +984,7 @@ bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
         codeWin = LVIR_BOUNDS;
     }
 
-#ifdef __WXWINE__
-    bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin ) != 0;
-#else
     bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 0;
-#endif
 
     rect.x = rectWin.left;
     rect.y = rectWin.top;
@@ -1243,20 +1279,33 @@ wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass)
 
     // ListView_EditLabel requires that the list has focus.
     SetFocus();
+
     WXHWND hWnd = (WXHWND) ListView_EditLabel(GetHwnd(), item);
+    if ( !hWnd )
+    {
+        // failed to start editing
+        return NULL;
+    }
 
-    if (m_textCtrl)
+    // [re]create the text control wrapping the HWND we got
+    if ( m_textCtrl )
     {
         m_textCtrl->SetHWND(0);
         m_textCtrl->UnsubclassWin();
         delete m_textCtrl;
     }
 
-    m_textCtrl = (wxTextCtrl*) textControlClass->CreateObject();
+    m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject();
     m_textCtrl->SetHWND(hWnd);
     m_textCtrl->SubclassWin(hWnd);
     m_textCtrl->SetParent(this);
 
+    // we must disallow TABbing away from the control while the edit contol is
+    // shown because this leaves it in some strange state (just try removing
+    // this line and then pressing TAB while editing an item in  listctrl
+    // inside a panel)
+    m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle() | wxTE_PROCESS_TAB);
+
     return m_textCtrl;
 }
 
@@ -1295,14 +1344,22 @@ long wxListCtrl::FindItem(long start, const wxString& str, bool partial)
 
 // Find an item whose data matches this data, starting from the item after 'start'
 // or the beginning if 'start' is -1.
+// NOTE : Lindsay Mathieson - 14-July-2002
+//        No longer use ListView_FindItem as the data attribute is now stored
+//        in a wxListItemInternalData structure refernced by the actual lParam
 long wxListCtrl::FindItem(long start, long data)
 {
-    LV_FINDINFO findInfo;
+    long  idx = start + 1;
+    long count = GetItemCount();
 
-    findInfo.flags = LVFI_PARAM;
-    findInfo.lParam = data;
+    while (idx < count)
+    {
+        if (GetItemData(idx) == data)
+            return idx;
+        idx++;
+    };
 
-    return ListView_FindItem(GetHwnd(), (int) start, & findInfo);
+    return -1;
 }
 
 // Find an item nearest this position in the specified direction, starting from
@@ -1487,14 +1544,18 @@ long wxListCtrl::InsertColumn(long col,
     return InsertColumn(col, item);
 }
 
-// Scrolls the list control. If in icon, small icon or report view mode,
-// x specifies the number of pixels to scroll. If in list view mode, x
-// specifies the number of columns to scroll.
-// If in icon, small icon or list view mode, y specifies the number of pixels
-// to scroll. If in report view mode, y specifies the number of lines to scroll.
+// scroll the control by the given number of pixels (exception: in list view,
+// dx is interpreted as number of columns)
 bool wxListCtrl::ScrollList(int dx, int dy)
 {
-    return (ListView_Scroll(GetHwnd(), dx, dy) != 0);
+    if ( !ListView_Scroll(GetHwnd(), dx, dy) )
+    {
+        wxLogDebug(_T("ListView_Scroll(%d, %d) failed"), dx, dy);
+
+        return FALSE;
+    }
+
+    return TRUE;
 }
 
 // Sort items.
@@ -1614,6 +1675,11 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             // work around is to simply catch both versions and hope that it
             // works (why should this message exist in ANSI and Unicode is
             // beyond me as it doesn't deal with strings at all...)
+            //
+            // note that fr HDN_TRACK another possibility could be to use
+            // HDN_ITEMCHANGING but it is sent even after HDN_ENDTRACK and when
+            // something other than the item width changes so we'd have to
+            // filter out the unwanted events then
             case HDN_BEGINTRACKA:
             case HDN_BEGINTRACKW:
                 eventType = wxEVT_COMMAND_LIST_COL_BEGIN_DRAG;
@@ -1629,6 +1695,8 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             case HDN_ENDTRACKW:
                 if ( eventType == wxEVT_NULL )
                     eventType = wxEVT_COMMAND_LIST_COL_END_DRAG;
+
+                event.m_item.m_width = nmHDR->pitem->cxy;
                 event.m_col = nmHDR->iItem;
                 break;
 
@@ -1673,6 +1741,22 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 }
                 break;
 
+            case HDN_GETDISPINFOW:
+                {
+                    LPNMHDDISPINFOW info = (LPNMHDDISPINFOW) lParam;
+                    // This is a fix for a strange bug under XP.
+                    // Normally, info->iItem is a valid index, but
+                    // sometimes this is a silly (large) number
+                    // and when we return FALSE via wxControl::MSWOnNotify
+                    // to indicate that it hasn't yet been processed,
+                    // there's a GPF in Windows.
+                    // By returning TRUE here, we avoid further processing
+                    // of this strange message.
+                    if (info->iItem > GetColumnCount())
+                        return TRUE;
+                }
+                // fall through
+
             default:
                 return wxControl::MSWOnNotify(idCtrl, lParam, result);
         }
@@ -1684,8 +1768,30 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
         // almost all messages use NM_LISTVIEW
         NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr;
 
-        // this is true for almost all events
-        event.m_item.m_data = nmLV->lParam;
+        const int iItem = nmLV->iItem;
+
+        // set the data event field for all messages for which the system gives
+        // us a valid NM_LISTVIEW::lParam
+        switch ( nmLV->hdr.code )
+        {
+            case LVN_BEGINDRAG:
+            case LVN_BEGINRDRAG:
+            case LVN_COLUMNCLICK:
+            case LVN_ITEMCHANGED:
+            case LVN_ITEMCHANGING:
+                if ( iItem != -1 )
+                {
+                    wxListItemInternalData *internaldata =
+                        (wxListItemInternalData *) nmLV->lParam;
+
+                    if ( internaldata )
+                        event.m_item.m_data = internaldata->lParam;
+                }
+
+            default:
+                // fall through
+                ;
+        }
 
         switch ( nmhdr->code )
         {
@@ -1699,7 +1805,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                     eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG;
                 }
 
-                event.m_itemIndex = nmLV->iItem;
+                event.m_itemIndex = iItem;
                 event.m_pointDrag.x = nmLV->ptAction.x;
                 event.m_pointDrag.y = nmLV->ptAction.y;
                 break;
@@ -1728,7 +1834,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                     eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
                     wxLV_ITEM item(((LV_DISPINFOA *)lParam)->item);
                     wxConvertFromMSWListItem(NULL, event.m_item, item);
-                    if ( ((LV_ITEM)item).pszText == NULL || 
+                    if ( ((LV_ITEM)item).pszText == NULL ||
                          ((LV_ITEM)item).iItem == -1 )
                         return FALSE;
 
@@ -1740,7 +1846,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                     eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
                     wxLV_ITEM item(((LV_DISPINFOW *)lParam)->item);
                     wxConvertFromMSWListItem(NULL, event.m_item, item);
-                    if ( ((LV_ITEM)item).pszText == NULL || 
+                    if ( ((LV_ITEM)item).pszText == NULL ||
                          ((LV_ITEM)item).iItem == -1 )
                         return FALSE;
 
@@ -1761,15 +1867,9 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
             case LVN_DELETEITEM:
                 eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
-                event.m_itemIndex = nmLV->iItem;
-
+                event.m_itemIndex = iItem;
                 // delete the assoicated internal data
-                {
-                    wxListItemInternalData *data = 
-                        GetInternalData(this, nmLV->iItem);
-                    if (data)
-                        delete data;
-                };
+                wxDeleteInternalData(this, iItem);
                 break;
 
             case LVN_SETDISPINFO:
@@ -1782,25 +1882,33 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
             case LVN_INSERTITEM:
                 eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
-                event.m_itemIndex = nmLV->iItem;
+                event.m_itemIndex = iItem;
                 break;
 
             case LVN_ITEMCHANGED:
                 // we translate this catch all message into more interesting
                 // (and more easy to process) wxWindows events
 
-                // first of all, we deal with the state change events only
-                if ( nmLV->uChanged & LVIF_STATE )
+                // first of all, we deal with the state change events only and
+                // only for valid items (item == -1 for the virtual list
+                // control)
+                if ( nmLV->uChanged & LVIF_STATE && iItem != -1 )
                 {
                     // temp vars for readability
                     const UINT stOld = nmLV->uOldState;
                     const UINT stNew = nmLV->uNewState;
 
+                    event.m_item.SetId(iItem);
+                    event.m_item.SetMask(wxLIST_MASK_TEXT |
+                                         wxLIST_MASK_IMAGE |
+                                         wxLIST_MASK_DATA);
+                    GetItem(event.m_item);
+
                     // has the focus changed?
                     if ( !(stOld & LVIS_FOCUSED) && (stNew & LVIS_FOCUSED) )
                     {
                         eventType = wxEVT_COMMAND_LIST_ITEM_FOCUSED;
-                        event.m_itemIndex = nmLV->iItem;
+                        event.m_itemIndex = iItem;
                     }
 
                     if ( (stNew & LVIS_SELECTED) != (stOld & LVIS_SELECTED) )
@@ -1817,7 +1925,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                         {
                             // then need to set m_itemIndex as it wasn't done
                             // above
-                            event.m_itemIndex = nmLV->iItem;
+                            event.m_itemIndex = iItem;
                         }
 
                         eventType = stNew & LVIS_SELECTED
@@ -1885,16 +1993,16 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
                 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
                 // if it happened on an item (and not on empty place)
-                if ( nmLV->iItem == -1 )
+                if ( iItem == -1 )
                 {
                     // not on item
                     return FALSE;
                 }
 
                 eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
-                event.m_itemIndex = nmLV->iItem;
-                event.m_item.m_text = GetItemText(nmLV->iItem);
-                event.m_item.m_data = GetItemData(nmLV->iItem);
+                event.m_itemIndex = iItem;
+                event.m_item.m_text = GetItemText(iItem);
+                event.m_item.m_data = GetItemData(iItem);
                 break;
 
             case NM_RCLICK:
@@ -2022,6 +2130,17 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             // logic here is inversed compared to all the other messages
             *result = event.IsAllowed();
 
+            // don't keep a stale wxTextCtrl around
+            if ( m_textCtrl )
+            {
+                // EDIT control will be deleted by the list control itself so
+                // prevent us from deleting it as well
+                m_textCtrl->SetHWND(0);
+                m_textCtrl->UnsubclassWin();
+                delete m_textCtrl;
+                m_textCtrl = NULL;
+            }
+
             return TRUE;
     }
 
@@ -2060,7 +2179,7 @@ WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
 
                 wxListItemAttr *attr =
                     IsVirtual() ? OnGetItemAttr(item)
-                                : GetInternalDataAttr(this, item);
+                                : wxGetInternalDataAttr(this, item);
 
                 if ( !attr )
                 {
@@ -2183,7 +2302,7 @@ void wxListCtrl::OnPaint(wxPaintEvent& event)
             {
                 int colWidth = GetColumnWidth(col);
                 x += colWidth ;
-                dc.DrawLine(x, firstItemRect.GetY() - 2, x, itemRect.GetBottom());
+                dc.DrawLine(x-1, firstItemRect.GetY() - 2, x-1, itemRect.GetBottom());
             }
         }
     }
@@ -2257,7 +2376,7 @@ void wxListCtrl::RefreshItems(long itemFrom, long itemTo)
     RefreshRect(rect);
 }
 
-static wxListItemInternalData *GetInternalData(HWND hwnd, long itemId)
+static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId)
 {
     LV_ITEM it;
     it.mask = LVIF_PARAM;
@@ -2270,26 +2389,40 @@ static wxListItemInternalData *GetInternalData(HWND hwnd, long itemId)
         return NULL;
 };
 
-static wxListItemInternalData *GetInternalData(wxListCtrl *ctl, long itemId)
+static wxListItemInternalData *wxGetInternalData(wxListCtrl *ctl, long itemId)
 {
-    return GetInternalData((HWND) ctl->GetHWND(), itemId);
+    return wxGetInternalData((HWND) ctl->GetHWND(), itemId);
 };
 
-static wxListItemAttr *GetInternalDataAttr(wxListCtrl *ctl, long itemId)
+static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId)
 {
-    wxListItemInternalData *data = GetInternalData(ctl, itemId);
+    wxListItemInternalData *data = wxGetInternalData(ctl, itemId);
     if (data)
         return data->attr;
     else
         return NULL;
 };
 
+static void wxDeleteInternalData(wxListCtrl* ctl, long itemId)
+{
+    wxListItemInternalData *data = wxGetInternalData(ctl, itemId);
+    if (data)
+    {
+        delete data;
+        LV_ITEM item;
+        memset(&item, 0, sizeof(item));
+        item.iItem = itemId;
+        item.mask = LVIF_PARAM;
+        item.lParam = (LPARAM) 0;
+        ListView_SetItem((HWND)ctl->GetHWND(), &item);
+    }
+}
 
 static void wxConvertFromMSWListItem(HWND hwndListCtrl,
                                      wxListItem& info,
                                      LV_ITEM& lvItem)
 {
-    wxListItemInternalData *internaldata = 
+    wxListItemInternalData *internaldata =
         (wxListItemInternalData *) lvItem.lParam;
 
     if (internaldata)