]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/listctrl.cpp
Added chapter on collection and container classes to contents
[wxWidgets.git] / src / msw / listctrl.cpp
index 09a988cd15e8ef598952a6a3610043a9d7ab719d..cbe91c88783de44fcd73d29b24e29821efea4ac0 100644 (file)
     #pragma hdrstop
 #endif
 
+#ifdef __WIN95__
+
 #ifndef WX_PRECOMP
-    #include "wx/wx.h"
+    #include "wx/app.h"
+    #include "wx/intl.h"
+    #include "wx/log.h"
+    #include "wx/settings.h"
 #endif
 
-#ifdef __WIN95__
+#include "wx/textctrl.h"
+#include "wx/imaglist.h"
 
 #include "wx/listctrl.h"
-#include "wx/log.h"
 
 #include "wx/msw/private.h"
 
-#if defined(__GNUWIN32__) && !defined(wxUSE_NORLANDER_HEADERS)
+#ifdef __GNUWIN32_OLD__
     #include "wx/msw/gnuwin32/extra.h"
 #else
     #include <commctrl.h>
                 (LVHT_ONITEMICON | LVHT_ONITEMLABEL | LVHT_ONITEMSTATEICON)
 #endif
 
+#ifndef LVM_SETEXTENDEDLISTVIEWSTYLE
+    #define LVM_SETEXTENDEDLISTVIEWSTYLE (0x1000 + 54)
+#endif
+
+#ifndef LVS_EX_FULLROWSELECT
+    #define LVS_EX_FULLROWSELECT 0x00000020
+#endif
+
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
@@ -196,20 +209,18 @@ bool wxListCtrl::DoCreateControl(int x, int y, int w, int h)
 
     if ( !m_hWnd )
     {
-        wxLogError(wxT("Can't create list control window."));
+        wxLogError(_("Can't create list control window, check that comctl32.dll is installed."));
 
         return FALSE;
     }
 
     // for comctl32.dll v 4.70+ we want to have this attribute because it's
     // prettier (and also because wxGTK does it like this)
-#ifdef ListView_SetExtendedListViewStyle
-    if ( wstyle & LVS_REPORT )
+    if ( (wstyle & LVS_REPORT) && wxTheApp->GetComCtl32Version() >= 470 )
     {
-        ListView_SetExtendedListViewStyle(GetHwnd(),
-                                          LVS_EX_FULLROWSELECT);
+        ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE,
+                      0, LVS_EX_FULLROWSELECT);
     }
-#endif // ListView_SetExtendedListViewStyle
 
     SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW));
     SetForegroundColour(GetParent()->GetForegroundColour());
@@ -239,7 +250,7 @@ void wxListCtrl::UpdateStyle()
     }
 }
 
-wxListCtrl::~wxListCtrl()
+void wxListCtrl::FreeAllAttrs(bool dontRecreate)
 {
     if ( m_hasAnyAttr )
     {
@@ -247,7 +258,20 @@ wxListCtrl::~wxListCtrl()
         {
             delete (wxListItemAttr *)node->Data();
         }
+
+        m_attrs.Destroy();
+        if ( !dontRecreate )
+        {
+            m_attrs.Create(wxKEY_INTEGER, 1000);        // just as def ctor
+        }
+
+        m_hasAnyAttr = FALSE;
     }
+}
+
+wxListCtrl::~wxListCtrl()
+{
+    FreeAllAttrs(TRUE /* no need to recreate hash any more */);
 
     if ( m_textCtrl )
     {
@@ -409,14 +433,28 @@ long wxListCtrl::ConvertToMSWStyle(long& oldStyle, long style) const
 // accessors
 // ----------------------------------------------------------------------------
 
-// Sets the background colour (GetBackgroundColour already implicit in
-// wxWindow class)
+// Sets the foreground, i.e. text, colour
+bool wxListCtrl::SetForegroundColour(const wxColour& col)
+{
+    if ( !wxWindow::SetForegroundColour(col) )
+        return FALSE;
+
+    ListView_SetTextColor(GetHwnd(), wxColourToRGB(col));
+
+    return TRUE;
+}
+
+// Sets the background colour
 bool wxListCtrl::SetBackgroundColour(const wxColour& col)
 {
     if ( !wxWindow::SetBackgroundColour(col) )
         return FALSE;
 
-    ListView_SetBkColor(GetHwnd(), PALETTERGB(col.Red(), col.Green(), col.Blue()));
+    // we set the same colour for both the "empty" background and the items
+    // background
+    COLORREF color = wxColourToRGB(col);
+    ListView_SetBkColor(GetHwnd(), color);
+    ListView_SetTextBkColor(GetHwnd(), color);
 
     return TRUE;
 }
@@ -527,13 +565,13 @@ bool wxListCtrl::SetColumnWidth(int col, int width)
 // visible area of the list control (list or report view)
 // or the total number of items in the list control (icon
 // or small icon view)
-int wxListCtrl::GetCountPerPage(void) const
+int wxListCtrl::GetCountPerPage() const
 {
     return ListView_GetCountPerPage(GetHwnd());
 }
 
 // Gets the edit control for editing labels.
-wxTextCtrl* wxListCtrl::GetEditControl(void) const
+wxTextCtrl* wxListCtrl::GetEditControl() const
 {
     return m_textCtrl;
 }
@@ -760,7 +798,7 @@ bool wxListCtrl::SetItemPosition(long item, const wxPoint& pos)
 }
 
 // Gets the number of items in the list control
-int wxListCtrl::GetItemCount(void) const
+int wxListCtrl::GetItemCount() const
 {
     return ListView_GetItemCount(GetHwnd());
 }
@@ -774,13 +812,13 @@ int wxListCtrl::GetItemSpacing(bool isSmall) const
 }
 
 // Gets the number of selected items in the list control
-int wxListCtrl::GetSelectedItemCount(void) const
+int wxListCtrl::GetSelectedItemCount() const
 {
     return ListView_GetSelectedCount(GetHwnd());
 }
 
 // Gets the text colour of the listview
-wxColour wxListCtrl::GetTextColour(void) const
+wxColour wxListCtrl::GetTextColour() const
 {
     COLORREF ref = ListView_GetTextColor(GetHwnd());
     wxColour col(GetRValue(ref), GetGValue(ref), GetBValue(ref));
@@ -795,7 +833,7 @@ void wxListCtrl::SetTextColour(const wxColour& col)
 
 // Gets the index of the topmost visible item when in
 // list or report view
-long wxListCtrl::GetTopItem(void) const
+long wxListCtrl::GetTopItem() const
 {
     return (long) ListView_GetTopIndex(GetHwnd());
 }
@@ -913,7 +951,7 @@ bool wxListCtrl::DeleteAllColumns()
     {
         if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
         {
-            wxLogLastError("ListView_DeleteColumn");
+            wxLogLastError(wxT("ListView_DeleteColumn"));
 
             return FALSE;
         }
@@ -1001,10 +1039,13 @@ long wxListCtrl::FindItem(long start, const wxString& str, bool partial)
 
     findInfo.flags = LVFI_STRING;
     if ( partial )
-        findInfo.flags |= LVFI_STRING;
-    findInfo.psz = WXSTRINGCAST str;
+        findInfo.flags |= LVFI_PARTIAL;
+    findInfo.psz = str;
 
-    return ListView_FindItem(GetHwnd(), (int) start, & findInfo);
+    // ListView_FindItem() excludes the first item from search and to look
+    // through all the items you need to start from -1 which is unnatural and
+    // inconsitent with the generic version - so we adjust the index
+    return ListView_FindItem(GetHwnd(), (int) start - 1, &findInfo);
 }
 
 // Find an item whose data matches this data, starting from the item after 'start'
@@ -1256,7 +1297,15 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
     wxListEvent event(wxEVT_NULL, m_windowId);
     wxEventType eventType = wxEVT_NULL;
+
     NMHDR *nmhdr = (NMHDR *)lParam;
+
+    // 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;
+
     switch ( nmhdr->code )
     {
         case LVN_BEGINRDRAG:
@@ -1269,12 +1318,9 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG;
             }
 
-            {
-                NM_LISTVIEW *hdr = (NM_LISTVIEW *)lParam;
-                event.m_itemIndex = hdr->iItem;
-                event.m_pointDrag.x = hdr->ptAction.x;
-                event.m_pointDrag.y = hdr->ptAction.y;
-            }
+            event.m_itemIndex = nmLV->iItem;
+            event.m_pointDrag.x = nmLV->ptAction.x;
+            event.m_pointDrag.y = nmLV->ptAction.y;
             break;
 
         case LVN_BEGINLABELEDIT:
@@ -1282,43 +1328,30 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
                 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
                 wxConvertFromMSWListItem(this, event.m_item, info->item, GetHwnd());
-                break;
             }
+            break;
 
         case LVN_COLUMNCLICK:
-            {
-                eventType = wxEVT_COMMAND_LIST_COL_CLICK;
-                NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam;
-                event.m_itemIndex = -1;
-                event.m_col = hdr->iSubItem;
-                break;
-            }
+            eventType = wxEVT_COMMAND_LIST_COL_CLICK;
+            event.m_itemIndex = -1;
+            event.m_col = nmLV->iSubItem;
+            break;
 
         case LVN_DELETEALLITEMS:
-            // what's the sense of generating a wxWin event for this when
-            // it's absolutely not portable?
-#if 0
             eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
             event.m_itemIndex = -1;
-#endif // 0
 
-            // return TRUE to suppress all additional LVN_DELETEITEM
-            // notifications - this makes deleting all items from a list ctrl
-            // much faster
-            *result = TRUE;
+            FreeAllAttrs();
 
-            return TRUE;
+            break;
 
         case LVN_DELETEITEM:
-            {
-                eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
-                NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam;
-                event.m_itemIndex = hdr->iItem;
+            eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
+            event.m_itemIndex = nmLV->iItem;
 
-                if ( m_hasAnyAttr )
-                {
-                    delete (wxListItemAttr *)m_attrs.Delete(hdr->iItem);
-                }
+            if ( m_hasAnyAttr )
+            {
+                delete (wxListItemAttr *)m_attrs.Delete(nmLV->iItem);
             }
             break;
 
@@ -1359,33 +1392,28 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
 
         case LVN_INSERTITEM:
-            {
-                eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
-                NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam;
-                event.m_itemIndex = hdr->iItem;
-                break;
-            }
+            eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
+            event.m_itemIndex = nmLV->iItem;
+            break;
 
         case LVN_ITEMCHANGED:
+            // This needs to be sent to wxListCtrl as a rather more concrete
+            // event. For now, just detect a selection or deselection.
+            if ( (nmLV->uNewState & LVIS_SELECTED) && !(nmLV->uOldState & LVIS_SELECTED) )
             {
-                // This needs to be sent to wxListCtrl as a rather more
-                // concrete event. For now, just detect a selection
-                // or deselection.
-                NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam;
-                if ( (hdr->uNewState & LVIS_SELECTED) && !(hdr->uOldState & LVIS_SELECTED) )
-                {
-                    eventType = wxEVT_COMMAND_LIST_ITEM_SELECTED;
-                    event.m_itemIndex = hdr->iItem;
-                }
-                else if ( !(hdr->uNewState & LVIS_SELECTED) && (hdr->uOldState & LVIS_SELECTED) )
-                {
-                    eventType = wxEVT_COMMAND_LIST_ITEM_DESELECTED;
-                    event.m_itemIndex = hdr->iItem;
-                }
-                else
-                    return FALSE;
-                break;
+                eventType = wxEVT_COMMAND_LIST_ITEM_SELECTED;
+                event.m_itemIndex = nmLV->iItem;
+            }
+            else if ( !(nmLV->uNewState & LVIS_SELECTED) && (nmLV->uOldState & LVIS_SELECTED) )
+            {
+                eventType = wxEVT_COMMAND_LIST_ITEM_DESELECTED;
+                event.m_itemIndex = nmLV->iItem;
+            }
+            else
+            {
+                return FALSE;
             }
+            break;
 
         case LVN_KEYDOWN:
             {
@@ -1409,8 +1437,15 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                     eventType = wxEVT_COMMAND_LIST_KEY_DOWN;
                     event.m_code = wxCharCodeMSWToWX(wVKey);
                 }
-                break;
+
+                if ( lItem != -1 )
+                {
+                    // fill the other fields too
+                    event.m_item.m_text = GetItemText(lItem);
+                    event.m_item.m_data = GetItemData(lItem);
+                }
             }
+            break;
 
         case NM_DBLCLK:
             // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
@@ -1422,46 +1457,47 @@ 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 )
             {
-                NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam;
-                if ( hdr->iItem == -1 )
-                {
-                    // not on item
-                    return FALSE;
-                }
-
-                eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
-                event.m_itemIndex = hdr->iItem;
+                // 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);
             break;
 
         case NM_RCLICK:
-        /* TECH NOTE: NM_RCLICK isn't really good enough here. We want to
-           subclass and check for the actual WM_RBUTTONDOWN message, because
-           NM_RCLICK waits for the WM_RBUTTONUP message as well before firing off.
-           We want to have notify events for both down -and- up. */
-        {
-            // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(), don't do
-            // anything else
-            if ( wxControl::MSWOnNotify(idCtrl, lParam, result) ) {
-                return TRUE;
-            }
+            /* TECH NOTE: NM_RCLICK isn't really good enough here. We want to
+               subclass and check for the actual WM_RBUTTONDOWN message,
+               because NM_RCLICK waits for the WM_RBUTTONUP message as well
+               before firing off. We want to have notify events for both down
+               -and- up. */
+            {
+                // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
+                // don't do anything else
+                if ( wxControl::MSWOnNotify(idCtrl, lParam, result) )
+                {
+                    return TRUE;
+                }
 
-            // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
-            LV_HITTESTINFO lvhti;
-            wxZeroMemory(lvhti);
+                // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
+                LV_HITTESTINFO lvhti;
+                wxZeroMemory(lvhti);
 
-            ::GetCursorPos(&(lvhti.pt));
-            ::ScreenToClient(GetHwnd(),&(lvhti.pt));
-            if ( ListView_HitTest(GetHwnd(),&lvhti) != -1 )
-            {
-                if ( lvhti.flags & LVHT_ONITEM )
+                ::GetCursorPos(&(lvhti.pt));
+                ::ScreenToClient(GetHwnd(),&(lvhti.pt));
+                if ( ListView_HitTest(GetHwnd(),&lvhti) != -1 )
                 {
-                    eventType = wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
-                    event.m_itemIndex = lvhti.iItem;
+                    if ( lvhti.flags & LVHT_ONITEM )
+                    {
+                        eventType = wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
+                        event.m_itemIndex = lvhti.iItem;
+                    }
                 }
             }
-        }
             break;
 
 #if 0
@@ -1581,8 +1617,16 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
     // post processing
     // ---------------
 
-    switch ( (int)nmhdr->code )
+    switch ( nmhdr->code )
     {
+        case LVN_DELETEALLITEMS:
+            // always return TRUE to suppress all additional LVN_DELETEITEM
+            // notifications - this makes deleting all items from a list ctrl
+            // much faster
+            *result = TRUE;
+
+            return TRUE;
+
         case LVN_GETDISPINFO:
             {
                 LV_DISPINFO *info = (LV_DISPINFO *)lParam;
@@ -1602,8 +1646,6 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 *result = event.IsAllowed();
                 return TRUE;
             }
-        default:
-            break;
     }
 
     *result = !event.IsAllowed();