X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5b98eb2fa6602cc9d1f19870c063c8f5e9cbe68f..993eebf1bae0a595540cb282342e894f23fbb1ee:/src/msw/listctrl.cpp

diff --git a/src/msw/listctrl.cpp b/src/msw/listctrl.cpp
index c0a29caeac..9ea8e389a1 100644
--- a/src/msw/listctrl.cpp
+++ b/src/msw/listctrl.cpp
@@ -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,7 +100,7 @@ public:
         }
         else
             m_buf = NULL;
-    }   
+    }
 private:
     wxMB2WXbuf *m_buf;
 
@@ -115,7 +115,7 @@ private:
         }
         else
             m_buf = NULL;
-    }   
+    }
     wxLV_ITEM(LV_ITEMA &item) : m_buf(NULL), m_item(&item) {}
 private:
     wxWC2WXbuf *m_buf;
@@ -124,6 +124,59 @@ private:
     LV_ITEM *m_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 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
+// SetItemData() GetItemData() calls).
+//
+// 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;
+//   long lParam; // user data
+// };
+//
+// To conserve memory, a wxListItemInternalData is
+// only allocated for a LV_ITEM if text attributes or
+// user data(lparam) are being set.
+
+
+// class wxListItemInternalData
+class wxListItemInternalData
+{
+public:
+   wxListItemAttr *attr;
+   LPARAM lParam; // user data
+
+   wxListItemInternalData() : attr(NULL), lParam(0) {}
+   ~wxListItemInternalData()
+   {
+       if (attr)
+           delete attr;
+   };
+};
+
+// Get the internal data structure
+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);
+
+
 // ----------------------------------------------------------------------------
 // events
 // ----------------------------------------------------------------------------
@@ -178,6 +231,7 @@ void wxListCtrl::Init()
     m_baseStyle = 0;
     m_colCount = 0;
     m_textCtrl = NULL;
+    m_AnyInternalData = FALSE;
     m_hasAnyAttr = FALSE;
 }
 
@@ -303,28 +357,23 @@ void wxListCtrl::UpdateStyle()
     }
 }
 
-void wxListCtrl::FreeAllAttrs(bool dontRecreate)
+void wxListCtrl::FreeAllInternalData()
 {
-    if ( m_hasAnyAttr )
+    if (m_AnyInternalData)
     {
-        for ( wxNode *node = m_attrs.Next(); node; node = m_attrs.Next() )
-        {
-            delete (wxListItemAttr *)node->Data();
-        }
+        int n = GetItemCount();
+        int i = 0;
 
-        m_attrs.Destroy();
-        if ( !dontRecreate )
-        {
-            m_attrs.Create(wxKEY_INTEGER, 1000);        // just as def ctor
-        }
+        for (i = 0; i < n; i++)
+            wxDeleteInternalData(this, i);
 
-        m_hasAnyAttr = FALSE;
+        m_AnyInternalData = FALSE;
     }
 }
 
 wxListCtrl::~wxListCtrl()
 {
-    FreeAllAttrs(TRUE /* no need to recreate hash any more */);
+    FreeAllInternalData();
 
     if ( m_textCtrl )
     {
@@ -530,6 +579,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;
@@ -537,6 +588,16 @@ bool wxListCtrl::GetColumn(int col, wxListItem& item) const
         lvCol.cchTextMax = 512;
     }
 
+    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;
@@ -558,6 +619,13 @@ bool wxListCtrl::GetColumn(int col, wxListItem& item) const
             item.m_format = wxLIST_FORMAT_CENTRE;
     }
 
+#if _WIN32_IE >= 0x0300
+    if ( item.m_mask & wxLIST_MASK_IMAGE )
+    {
+        item.m_image = lvCol.iImage;
+    }
+#endif
+
     return success;
 }
 
@@ -664,6 +732,42 @@ bool wxListCtrl::SetItem(wxListItem& info)
     LV_ITEM item;
     wxConvertToMSWListItem(this, info, item);
 
+    // we never update the lParam if it contains our pointer
+    // to the wxListItemInternalData structure
+    item.mask &= ~LVIF_PARAM;
+
+    // check if setting attributes or lParam
+    if (info.HasAttributes() || (info.m_mask  & wxLIST_MASK_DATA))
+    {
+        // get internal item data
+        // perhaps a cache here ?
+        wxListItemInternalData *data = wxGetInternalData(this, info.m_itemId);
+
+        if (! data)
+        {
+            // need to set it
+            m_AnyInternalData = TRUE;
+            data = new wxListItemInternalData();
+            item.lParam = (LPARAM) data;
+            item.mask |= LVIF_PARAM;
+        };
+
+
+        // user data
+        if (info.m_mask  & wxLIST_MASK_DATA)
+            data->lParam = info.m_data;
+
+        // attributes
+        if (info.HasAttributes())
+        {
+            if (data->attr)
+                *data->attr = *info.GetAttributes();
+            else
+                data->attr = new wxListItemAttr(*info.GetAttributes());
+        };
+    };
+
+
     // we could be changing only the attribute in which case we don't need to
     // call ListView_SetItem() at all
     if ( item.mask )
@@ -683,13 +787,6 @@ bool wxListCtrl::SetItem(wxListItem& info)
     // check whether it has any custom attributes
     if ( info.HasAttributes() )
     {
-        wxListItemAttr *attr = (wxListItemAttr *)m_attrs.Get(item.iItem);
-
-        if ( attr == NULL )
-            m_attrs.Put(item.iItem, (wxObject *)new wxListItemAttr(*info.GetAttributes()));
-        else
-            *attr = *info.GetAttributes();
-
         m_hasAnyAttr = TRUE;
 
         // if the colour has changed, we must redraw the item
@@ -1162,21 +1259,21 @@ wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass)
 {
     wxASSERT( (textControlClass->IsKindOf(CLASSINFO(wxTextCtrl))) );
 
-    // VS: ListView_EditLabel requires that the list has focus.
+    // ListView_EditLabel requires that the list has focus.
     SetFocus();
-    HWND hWnd = (HWND) ListView_EditLabel(GetHwnd(), item);
+    WXHWND hWnd = (WXHWND) ListView_EditLabel(GetHwnd(), item);
 
     if (m_textCtrl)
     {
         m_textCtrl->SetHWND(0);
         m_textCtrl->UnsubclassWin();
         delete m_textCtrl;
-        m_textCtrl = NULL;
     }
 
     m_textCtrl = (wxTextCtrl*) textControlClass->CreateObject();
-    m_textCtrl->SetHWND((WXHWND) hWnd);
-    m_textCtrl->SubclassWin((WXHWND) hWnd);
+    m_textCtrl->SetHWND(hWnd);
+    m_textCtrl->SubclassWin(hWnd);
+    m_textCtrl->SetParent(this);
 
     return m_textCtrl;
 }
@@ -1216,14 +1313,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
@@ -1288,22 +1393,30 @@ long wxListCtrl::InsertItem(wxListItem& info)
 
     LV_ITEM item;
     wxConvertToMSWListItem(this, info, item);
+    item.mask &= ~LVIF_PARAM;
 
-    // check whether it has any custom attributes
-    if ( info.HasAttributes() )
+    // check wether we need to allocate our internal data
+    bool needInternalData = ((info.m_mask & wxLIST_MASK_DATA) || info.HasAttributes());
+    if (needInternalData)
     {
+        m_AnyInternalData = TRUE;
+        item.mask |= LVIF_PARAM;
 
-        wxListItemAttr *attr;
-        attr = (wxListItemAttr*) m_attrs.Get(item.iItem);
+        // internal stucture that manages data
+        wxListItemInternalData *data = new wxListItemInternalData();
+        item.lParam = (LPARAM) data;
 
-        if (attr == NULL)
+        if (info.m_mask & wxLIST_MASK_DATA)
+            data->lParam = info.m_data;
 
-            m_attrs.Put(item.iItem, (wxObject *)new wxListItemAttr(*info.GetAttributes()));
-
-        else *attr = *info.GetAttributes();
-
-        m_hasAnyAttr = TRUE;
+    // check whether it has any custom attributes
+    if ( info.HasAttributes() )
+    {
+            // take copy of attributes
+            data->attr = new wxListItemAttr(*info.GetAttributes());
     }
+    };
+
 
     return (long) ListView_InsertItem(GetHwnd(), & item);
 }
@@ -1422,62 +1535,40 @@ bool wxListCtrl::ScrollList(int dx, int dy)
 
 // data is arbitrary data to be passed to the sort function.
 
-// FIXME: this is horrible and MT-unsafe and everything else but I don't have
-//        time for anything better right now (VZ)
-static long gs_sortData = 0;
-static wxListCtrl *gs_sortCtrl = NULL;
-static wxListCtrlCompare gs_sortFunction = NULL;
+// Internal structures for proxying the user compare function
+// so that we can pass it the *real* user data
 
-int wxCMPFUNC_CONV wxListCtrlCompareFn(const void *arg1, const void *arg2)
+// translate lParam data and call user func
+struct wxInternalDataSort
 {
-    int n1 = *(const int *)arg1,
-        n2 = *(const int *)arg2;
-
-    return gs_sortFunction(gs_sortCtrl->GetItemData(n1),
-                           gs_sortCtrl->GetItemData(n2),
-                           gs_sortData);
-}
+    wxListCtrlCompare user_fn;
+    long data;
+};
 
-bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data)
+int CALLBACK wxInternalDataCompareFunc(LPARAM lParam1, LPARAM lParam2,  LPARAM lParamSort)
 {
-    // sort the attributes too
-    if ( m_hasAnyAttr )
-    {
-        int n,
-            count = GetItemCount();
-        int *aItems = new int[count];
-        for ( n = 0; n < count; n++ )
-        {
-            aItems[n] = n;
-        }
-
-        gs_sortData = data;
-        gs_sortCtrl = this;
-        gs_sortFunction = fn;
+    struct wxInternalDataSort *internalData = (struct wxInternalDataSort *) lParamSort;
 
-        qsort(aItems, count, sizeof(int), wxListCtrlCompareFn);
+    wxListItemInternalData *data1 = (wxListItemInternalData *) lParam1;
+    wxListItemInternalData *data2 = (wxListItemInternalData *) lParam2;
 
-        gs_sortData = 0;
-        gs_sortCtrl = NULL;
-        gs_sortFunction = NULL;
+    long d1 = (data1 == NULL ? 0 : data1->lParam);
+    long d2 = (data2 == NULL ? 0 : data2->lParam);
 
-        wxHashTable attrsNew(wxKEY_INTEGER, 1000);
-        for ( n = 0; n < count; n++ )
-        {
-            wxObject *attr = m_attrs.Delete(aItems[n]);
-            if ( attr )
-            {
-                attrsNew.Put(n, attr);
-            }
-        }
+    return internalData->user_fn(d1, d2, internalData->data);
 
-        m_attrs.Destroy();
-        m_attrs = attrsNew;
+};
 
-        delete [] aItems;
-    }
+bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data)
+{
+    struct wxInternalDataSort internalData;
+    internalData.user_fn = fn;
+    internalData.data = data;
 
-    if ( !ListView_SortItems(GetHwnd(), (PFNLVCOMPARE)fn, data) )
+    // WPARAM cast is needed for mingw/cygwin
+    if ( !ListView_SortItems(GetHwnd(),
+                             wxInternalDataCompareFunc,
+                             (WPARAM) &internalData) )
     {
         wxLogDebug(_T("ListView_SortItems() failed"));
 
@@ -1663,7 +1754,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;
 
@@ -1675,7 +1766,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;
 
@@ -1692,19 +1783,13 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             case LVN_DELETEALLITEMS:
                 eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
                 event.m_itemIndex = -1;
-
-                FreeAllAttrs();
-
                 break;
 
             case LVN_DELETEITEM:
                 eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
                 event.m_itemIndex = nmLV->iItem;
-
-                if ( m_hasAnyAttr )
-                {
-                    delete (wxListItemAttr *)m_attrs.Delete(nmLV->iItem);
-                }
+                // delete the assoicated internal data
+                wxDeleteInternalData(this, nmLV->iItem);
                 break;
 
             case LVN_SETDISPINFO:
@@ -1995,7 +2080,7 @@ WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
 
                 wxListItemAttr *attr =
                     IsVirtual() ? OnGetItemAttr(item)
-                                : (wxListItemAttr *)m_attrs.Get(item);
+                                : wxGetInternalDataAttr(this, item);
 
                 if ( !attr )
                 {
@@ -2192,55 +2277,58 @@ void wxListCtrl::RefreshItems(long itemFrom, long itemTo)
     RefreshRect(rect);
 }
 
-// ----------------------------------------------------------------------------
-// wxListItem
-// ----------------------------------------------------------------------------
-
-// List item structure
-wxListItem::wxListItem()
+static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId)
 {
-    m_mask = 0;
-    m_itemId = 0;
-    m_col = 0;
-    m_state = 0;
-    m_stateMask = 0;
-    m_image = 0;
-    m_data = 0;
-
-    m_format = wxLIST_FORMAT_CENTRE;
-    m_width = 0;
+    LV_ITEM it;
+    it.mask = LVIF_PARAM;
+    it.iItem = itemId;
 
-    m_attr = NULL;
-}
+    bool success = ListView_GetItem(hwnd, &it) != 0;
+    if (success)
+        return (wxListItemInternalData *) it.lParam;
+    else
+        return NULL;
+};
 
-void wxListItem::Clear()
+static wxListItemInternalData *wxGetInternalData(wxListCtrl *ctl, long itemId)
 {
-    m_mask = 0;
-    m_itemId = 0;
-    m_col = 0;
-    m_state = 0;
-    m_stateMask = 0;
-    m_image = 0;
-    m_data = 0;
-    m_format = wxLIST_FORMAT_CENTRE;
-    m_width = 0;
-    m_text = wxEmptyString;
+    return wxGetInternalData((HWND) ctl->GetHWND(), itemId);
+};
 
-    if (m_attr) delete m_attr;
-    m_attr = NULL;
-}
+static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId)
+{
+    wxListItemInternalData *data = wxGetInternalData(ctl, itemId);
+    if (data)
+        return data->attr;
+    else
+        return NULL;
+};
 
-void wxListItem::ClearAttributes()
+static void wxDeleteInternalData(wxListCtrl* ctl, long itemId)
 {
-    if (m_attr) delete m_attr;
-    m_attr = NULL;
+    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)
 {
-    info.m_data = lvItem.lParam;
+    wxListItemInternalData *internaldata =
+        (wxListItemInternalData *) lvItem.lParam;
+
+    if (internaldata)
+        info.m_data = internaldata->lParam;
+
     info.m_mask = 0;
     info.m_state = 0;
     info.m_stateMask = 0;
@@ -2354,7 +2442,6 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
     lvItem.iItem = (int) info.m_itemId;
 
     lvItem.iImage = info.m_image;
-    lvItem.lParam = info.m_data;
     lvItem.stateMask = 0;
     lvItem.state = 0;
     lvItem.mask = 0;
@@ -2386,8 +2473,6 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
     }
     if (info.m_mask & wxLIST_MASK_IMAGE)
         lvItem.mask |= LVIF_IMAGE;
-    if (info.m_mask & wxLIST_MASK_DATA)
-        lvItem.mask |= LVIF_PARAM;
 }
 
 static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item,
@@ -2439,5 +2524,3 @@ static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item,
 }
 
 #endif // wxUSE_LISTCTRL
-
-// vi:sts=4:sw=4:et