]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/listctrl.cpp
don't log erroneous error messages when writing an empty string to a wxTE_RICH2 control
[wxWidgets.git] / src / msw / listctrl.cpp
index ecc6895b54129de0f76fac81722ccf5b1dd732f1..270dd47eab359f8669123dac6226b5bc32235005 100644 (file)
@@ -104,24 +104,36 @@ public:
 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)
 };
 
 ///////////////////////////////////////////////////////
@@ -168,6 +180,8 @@ public:
        if (attr)
            delete attr;
    };
+
+    DECLARE_NO_COPY_CLASS(wxListItemInternalData)
 };
 
 // Get the internal data structure
@@ -230,6 +244,8 @@ void wxListCtrl::Init()
     m_ownsImageListNormal = m_ownsImageListSmall = m_ownsImageListState = FALSE;
     m_baseStyle = 0;
     m_colCount = 0;
+    m_count = 0;
+    m_ignoreChangeMessages = FALSE;
     m_textCtrl = NULL;
     m_AnyInternalData = FALSE;
     m_hasAnyAttr = FALSE;
@@ -364,8 +380,10 @@ void wxListCtrl::FreeAllInternalData()
         int n = GetItemCount();
         int i = 0;
 
+        m_ignoreChangeMessages = TRUE;
         for (i = 0; i < n; i++)
             wxDeleteInternalData(this, i);
+        m_ignoreChangeMessages = FALSE;
 
         m_AnyInternalData = FALSE;
     }
@@ -579,6 +597,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;
@@ -586,7 +606,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;
@@ -599,13 +629,28 @@ 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;
 }
@@ -883,7 +928,7 @@ wxString wxListCtrl::GetItemText(long item) const
     info.m_itemId = item;
 
     if (!GetItem(info))
-        return wxString("");
+        return wxEmptyString;
     return info.m_text;
 }
 
@@ -943,11 +988,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;
@@ -977,7 +1018,7 @@ bool wxListCtrl::SetItemPosition(long item, const wxPoint& pos)
 // Gets the number of items in the list control
 int wxListCtrl::GetItemCount() const
 {
-    return ListView_GetItemCount(GetHwnd());
+    return m_count;
 }
 
 // Retrieves the spacing between icons in pixels.
@@ -1167,6 +1208,10 @@ bool wxListCtrl::DeleteItem(long item)
         return FALSE;
     }
 
+    m_count -= 1;
+    wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
+                  wxT("m_count should match ListView_GetItemCount"));
+
     // the virtual list control doesn't refresh itself correctly, help it
     if ( IsVirtual() )
     {
@@ -1195,6 +1240,7 @@ bool wxListCtrl::DeleteItem(long item)
 // Deletes all items
 bool wxListCtrl::DeleteAllItems()
 {
+    FreeAllInternalData();
     return ListView_DeleteAllItems(GetHwnd()) != 0;
 }
 
@@ -1242,20 +1288,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;
 }
 
@@ -1294,14 +1353,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
@@ -1390,8 +1457,12 @@ long wxListCtrl::InsertItem(wxListItem& info)
     }
     };
 
+    long rv = ListView_InsertItem(GetHwnd(), & item);
+    m_count += 1;
+    wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
+                  wxT("m_count should match ListView_GetItemCount"));
 
-    return (long) ListView_InsertItem(GetHwnd(), & item);
+    return rv;
 }
 
 long wxListCtrl::InsertItem(long index, const wxString& label)
@@ -1486,14 +1557,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.
@@ -1579,6 +1654,7 @@ bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id)
 
 bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 {
+
     // prepare the event
     // -----------------
 
@@ -1613,6 +1689,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;
@@ -1628,6 +1709,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;
 
@@ -1672,6 +1755,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);
         }
@@ -1683,8 +1782,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;
+
+
+        // FreeAllInternalData will cause LVN_ITEMCHANG* messages, which can be
+        // ignored for efficiency.  It is done here because the internal data is in the
+        // process of being deleted so we don't want to try and access it below.
+        if ( m_ignoreChangeMessages &&
+             ( (nmLV->hdr.code == LVN_ITEMCHANGED) || (nmLV->hdr.code == LVN_ITEMCHANGING)))
+        {
+            return TRUE;
+        }
+
+
+        // If we have a valid item then check if there is a data value
+        // associated with it and put it in the event.
+        if ( iItem >= 0 && iItem < GetItemCount() )
+        {
+            wxListItemInternalData *internaldata =
+                wxGetInternalData(GetHwnd(), iItem);
+
+            if ( internaldata )
+                event.m_item.m_data = internaldata->lParam;
+        }
+
 
         switch ( nmhdr->code )
         {
@@ -1698,7 +1819,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;
@@ -1754,15 +1875,21 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 break;
 
             case LVN_DELETEALLITEMS:
+                m_count = 0;
                 eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
                 event.m_itemIndex = -1;
                 break;
 
             case LVN_DELETEITEM:
+                if (m_count == 0)
+                    // this should be prevented by the post-processing code below,
+                    // but "just in case"
+                    return FALSE;
+
                 eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
-                event.m_itemIndex = nmLV->iItem;
+                event.m_itemIndex = iItem;
                 // delete the assoicated internal data
-                wxDeleteInternalData(this, nmLV->iItem);
+                wxDeleteInternalData(this, iItem);
                 break;
 
             case LVN_SETDISPINFO:
@@ -1775,25 +1902,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) )
@@ -1810,7 +1945,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
@@ -1878,16 +2013,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:
@@ -1994,12 +2129,10 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
     event.SetEventType(eventType);
 
-    if ( !GetEventHandler()->ProcessEvent(event) )
-        return FALSE;
+    bool processed = GetEventHandler()->ProcessEvent(event);
 
     // post processing
     // ---------------
-
     switch ( nmhdr->code )
     {
         case LVN_DELETEALLITEMS:
@@ -2007,7 +2140,6 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             // notifications - this makes deleting all items from a list ctrl
             // much faster
             *result = TRUE;
-
             return TRUE;
 
         case LVN_ENDLABELEDITA:
@@ -2015,12 +2147,24 @@ 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;
     }
 
-    *result = !event.IsAllowed();
+    if ( processed )
+        *result = !event.IsAllowed();
 
-    return TRUE;
+    return processed;
 }
 
 #if defined(_WIN32_IE) && _WIN32_IE >= 0x300
@@ -2176,7 +2320,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());
             }
         }
     }
@@ -2220,6 +2364,9 @@ void wxListCtrl::SetItemCount(long count)
     {
         wxLogLastError(_T("ListView_SetItemCount"));
     }
+    m_count = count;
+    wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
+                  wxT("m_count should match ListView_GetItemCount"));
 }
 
 void wxListCtrl::RefreshItem(long item)