]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/listctrl.cpp
Implemented input disabling for disabled windows since MicroWindows doesn't do it
[wxWidgets.git] / src / msw / listctrl.cpp
index 2c4f6642de585d112df02b0b84b49a46219a2322..191b98c91a71827c5993e10fb7cdb7399e83c96e 100644 (file)
@@ -29,7 +29,7 @@
     #pragma hdrstop
 #endif
 
-#ifdef __WIN95__
+#if wxUSE_LISTCTRL && defined(__WIN95__)
 
 #ifndef WX_PRECOMP
     #include "wx/app.h"
 
 #include "wx/textctrl.h"
 #include "wx/imaglist.h"
-
 #include "wx/listctrl.h"
+#include "wx/dcclient.h"
 
 #include "wx/msw/private.h"
 
-#ifdef __GNUWIN32_OLD__
+#if ((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
     #include "wx/msw/gnuwin32/extra.h"
 #else
     #include <commctrl.h>
@@ -72,12 +72,33 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_
 static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& tvItem, HWND getFullInfo = 0);
 
 // ----------------------------------------------------------------------------
-// macros
+// events
 // ----------------------------------------------------------------------------
 
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED)
+
 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)
 IMPLEMENT_DYNAMIC_CLASS(wxListItem, wxObject)
 
+BEGIN_EVENT_TABLE(wxListCtrl, wxControl)
+    EVT_PAINT(wxListCtrl::OnPaint)
+END_EVENT_TABLE()
+
 // ============================================================================
 // implementation
 // ============================================================================
@@ -126,6 +147,7 @@ void wxListCtrl::Init()
     m_imageListNormal = NULL;
     m_imageListSmall = NULL;
     m_imageListState = NULL;
+    m_ownsImageListNormal = m_ownsImageListSmall = m_ownsImageListState = FALSE;
     m_baseStyle = 0;
     m_colCount = 0;
     m_textCtrl = NULL;
@@ -168,6 +190,10 @@ bool wxListCtrl::Create(wxWindow *parent,
 
     DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP |
                    LVS_SHAREIMAGELISTS | LVS_SHOWSELALWAYS;
+
+    if ( m_windowStyle & wxCLIP_SIBLINGS )
+        wstyle |= WS_CLIPSIBLINGS;
+
     if ( wxStyleHasBorder(m_windowStyle) )
         wstyle |= WS_BORDER;
     m_baseStyle = wstyle;
@@ -280,6 +306,10 @@ wxListCtrl::~wxListCtrl()
         delete m_textCtrl;
         m_textCtrl = NULL;
     }
+
+    if (m_ownsImageListNormal) delete m_imageListNormal;
+    if (m_ownsImageListSmall) delete m_imageListSmall;
+    if (m_ownsImageListState) delete m_imageListState;
 }
 
 // ----------------------------------------------------------------------------
@@ -394,12 +424,6 @@ long wxListCtrl::ConvertToMSWStyle(long& oldStyle, long style) const
     if ( style & wxLC_AUTOARRANGE )
         wstyle |= LVS_AUTOARRANGE;
 
-    // Apparently, no such style (documentation wrong?)
-    /*
-       if ( style & wxLC_BUTTON )
-       wstyle |= LVS_BUTTON;
-     */
-
     if ( style & wxLC_NO_SORT_HEADER )
         wstyle |= LVS_NOSORTHEADER;
 
@@ -426,6 +450,11 @@ long wxListCtrl::ConvertToMSWStyle(long& oldStyle, long style) const
         wstyle |= LVS_SORTDESCENDING;
     }
 
+    if ( style & wxLC_VIRTUAL )
+    {
+        wstyle |= LVS_OWNERDATA;
+    }
+
     return wstyle;
 }
 
@@ -599,6 +628,9 @@ bool wxListCtrl::GetItem(wxListItem& info) const
     if (info.m_mask & wxLIST_MASK_DATA)
         lvItem.mask |= LVIF_PARAM;
 
+    if (info.m_mask & wxLIST_MASK_IMAGE)
+        lvItem.mask |= LVIF_IMAGE;
+
     if ( info.m_mask & wxLIST_MASK_STATE )
     {
         lvItem.mask |= LVIF_STATE;
@@ -629,23 +661,40 @@ bool wxListCtrl::SetItem(wxListItem& info)
     LV_ITEM item;
     wxConvertToMSWListItem(this, info, item);
 
+    item.cchTextMax = 0;
+    if ( !ListView_SetItem(GetHwnd(), &item) )
+    {
+        wxLogDebug(_T("ListView_SetItem() failed"));
+
+        return FALSE;
+    }
+
+    // we need to update the item immediately to show the new image
+    bool updateNow = (info.m_mask & wxLIST_MASK_IMAGE) != 0;
+
     // check whether it has any custom attributes
     if ( info.HasAttributes() )
     {
-        m_attrs.Put(item.iItem, (wxObject *)new wxListItemAttr(*info.GetAttributes()));
+        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
+        updateNow = TRUE;
     }
 
-    item.cchTextMax = 0;
-    bool ok = ListView_SetItem(GetHwnd(), &item) != 0;
-    if ( ok && (info.m_mask & wxLIST_MASK_IMAGE) )
+    if ( updateNow )
     {
-        // make the change visible
+        // we need this to make the change visible right now
         ListView_Update(GetHwnd(), item.iItem);
     }
 
-    return ok;
+    return TRUE;
 }
 
 long wxListCtrl::SetItem(long index, int col, const wxString& label, int imageId)
@@ -693,7 +742,7 @@ bool wxListCtrl::SetItemState(long item, long state, long stateMask)
 }
 
 // Sets the item image
-bool wxListCtrl::SetItemImage(long item, int image, int selImage)
+bool wxListCtrl::SetItemImage(long item, int image, int WXUNUSED(selImage))
 {
     wxListItem info;
 
@@ -776,7 +825,7 @@ bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
     rect.x = rect2.left;
     rect.y = rect2.top;
     rect.width = rect2.right - rect2.left;
-    rect.height = rect2.bottom - rect2.left;
+    rect.height = rect2.bottom - rect2.top;
     return success;
 }
 
@@ -897,21 +946,38 @@ void wxListCtrl::SetImageList(wxImageList *imageList, int which)
     if ( which == wxIMAGE_LIST_NORMAL )
     {
         flags = LVSIL_NORMAL;
+        if (m_ownsImageListNormal) delete m_imageListNormal;
         m_imageListNormal = imageList;
+        m_ownsImageListNormal = FALSE;
     }
     else if ( which == wxIMAGE_LIST_SMALL )
     {
         flags = LVSIL_SMALL;
+        if (m_ownsImageListSmall) delete m_imageListSmall;
         m_imageListSmall = imageList;
+        m_ownsImageListSmall = FALSE;
     }
     else if ( which == wxIMAGE_LIST_STATE )
     {
         flags = LVSIL_STATE;
+        if (m_ownsImageListState) delete m_imageListState;
         m_imageListState = imageList;
+        m_ownsImageListState = FALSE;
     }
     ListView_SetImageList(GetHwnd(), (HIMAGELIST) imageList ? imageList->GetHIMAGELIST() : 0, flags);
 }
 
+void wxListCtrl::AssignImageList(wxImageList *imageList, int which)
+{
+    SetImageList(imageList, which);
+    if ( which == wxIMAGE_LIST_NORMAL )
+        m_ownsImageListNormal = TRUE;
+    else if ( which == wxIMAGE_LIST_SMALL )
+        m_ownsImageListSmall = TRUE;
+    else if ( which == wxIMAGE_LIST_STATE )
+        m_ownsImageListState = TRUE;
+}
+
 // ----------------------------------------------------------------------------
 // Operations
 // ----------------------------------------------------------------------------
@@ -986,6 +1052,8 @@ wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass)
 {
     wxASSERT( (textControlClass->IsKindOf(CLASSINFO(wxTextCtrl))) );
 
+    // VS: ListView_EditLabel requires that the list has focus.  
+    SetFocus();
     HWND hWnd = (HWND) ListView_EditLabel(GetHwnd(), item);
 
     if (m_textCtrl)
@@ -1004,7 +1072,7 @@ wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass)
 }
 
 // End label editing, optionally cancelling the edit
-bool wxListCtrl::EndEditLabel(bool cancel)
+bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel))
 {
     wxFAIL;
 
@@ -1039,10 +1107,15 @@ 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
+    // inconsistent with the generic version - so we adjust the index
+    if (start != -1)
+        start --;
+    return ListView_FindItem(GetHwnd(), (int) start, &findInfo);
 }
 
 // Find an item whose data matches this data, starting from the item after 'start'
@@ -1115,13 +1188,23 @@ long wxListCtrl::HitTest(const wxPoint& point, int& flags)
 // -1 otherwise.
 long wxListCtrl::InsertItem(wxListItem& info)
 {
+    wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") );
+
     LV_ITEM item;
     wxConvertToMSWListItem(this, info, item);
 
     // check whether it has any custom attributes
     if ( info.HasAttributes() )
     {
-        m_attrs.Put(item.iItem, (wxObject *)new wxListItemAttr(*info.GetAttributes()));
+
+        wxListItemAttr *attr;
+        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;
     }
@@ -1370,24 +1453,6 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             }
             break;
 
-        case LVN_GETDISPINFO:
-                // this provokes stack overflow: indeed, wxConvertFromMSWListItem()
-                // sends us WM_NOTIFY! As it doesn't do anything for now, just leave
-                // it out.
-#if 0
-            {
-                // TODO: some text buffering here, I think
-                // TODO: API for getting Windows to retrieve values
-                // on demand.
-                eventType = wxEVT_COMMAND_LIST_GET_INFO;
-                LV_DISPINFO *info = (LV_DISPINFO *)lParam;
-                wxConvertFromMSWListItem(this, event.m_item, info->item, GetHwnd());
-                break;
-            }
-#endif // 0
-                return FALSE;
-
-
         case LVN_INSERTITEM:
             eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
             event.m_itemIndex = nmLV->iItem;
@@ -1422,10 +1487,13 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                                          wxLIST_NEXT_ALL,
                                          wxLIST_STATE_SELECTED);
 
-                // <Enter> or <Space> activate the selected item if any
-                if ( lItem != -1 && (wVKey == VK_RETURN || wVKey == VK_SPACE) )
+                // <Enter> or <Space> activate the selected item if any (but
+                // not with Shift and/or Ctrl as then they have a predefined
+                // meaning for the list view)
+                if ( lItem != -1 &&
+                     (wVKey == VK_RETURN || wVKey == VK_SPACE) &&
+                     !(wxIsShiftDown() || wxIsCtrlDown()) )
                 {
-                    // TODO this behaviour probably should be optional
                     eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
                     event.m_itemIndex = lItem;
                 }
@@ -1492,6 +1560,8 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                     {
                         eventType = wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
                         event.m_itemIndex = lvhti.iItem;
+                        event.m_pointDrag.x = lvhti.pt.x;
+                        event.m_pointDrag.y = lvhti.pt.y;
                     }
                 }
             }
@@ -1595,9 +1665,37 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                         return TRUE;
                 }
             }
-            break;
+//            break; // can never be reached
 #endif // _WIN32_IE >= 0x300
 
+        case LVN_GETDISPINFO:
+            if ( IsVirtual() )
+            {
+                LV_DISPINFO *info = (LV_DISPINFO *)lParam;
+
+                LV_ITEM& lvi = info->item;
+                long item = lvi.iItem;
+
+                if ( lvi.mask & LVIF_TEXT )
+                {
+                    wxString text = OnGetItemText(item, lvi.iSubItem);
+                    wxStrncpy(lvi.pszText, text, lvi.cchTextMax);
+                }
+
+                if ( lvi.mask & LVIF_IMAGE )
+                {
+                    lvi.iImage = OnGetItemImage(item);
+                }
+
+                // a little dose of healthy paranoia: as we never use
+                // LVM_SETCALLBACKMASK we're not supposed to get these ones
+                wxASSERT_MSG( !(lvi.mask & LVIF_STATE),
+                              _T("we don't support state callbacks yet!") );
+
+                return TRUE;
+            }
+            // fall through
+
         default:
             return wxControl::MSWOnNotify(idCtrl, lParam, result);
     }
@@ -1624,20 +1722,6 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
             return TRUE;
 
-        case LVN_GETDISPINFO:
-            {
-                LV_DISPINFO *info = (LV_DISPINFO *)lParam;
-                if ( info->item.mask & LVIF_TEXT )
-                {
-                    if ( !event.m_item.m_text.IsNull() )
-                    {
-                        info->item.pszText = AddPool(event.m_item.m_text);
-                        info->item.cchTextMax = wxStrlen(info->item.pszText) + 1;
-                    }
-                }
-                //    wxConvertToMSWListItem(this, event.m_item, info->item);
-                break;
-            }
         case LVN_ENDLABELEDIT:
             {
                 *result = event.IsAllowed();
@@ -1650,17 +1734,100 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
     return TRUE;
 }
 
-wxChar *wxListCtrl::AddPool(const wxString& str)
+// Necessary for drawing hrules and vrules, if specified
+void wxListCtrl::OnPaint(wxPaintEvent& event)
 {
-    // Remove the first element if 3 strings exist
-    if ( m_stringPool.Number() == 3 )
+    wxPaintDC dc(this);
+
+    wxControl::OnPaint(event);
+
+    // Reset the device origin since it may have been set
+    dc.SetDeviceOrigin(0, 0);
+
+    bool drawHRules = ((GetWindowStyle() & wxLC_HRULES) != 0);
+    bool drawVRules = ((GetWindowStyle() & wxLC_VRULES) != 0);
+
+    if (!drawHRules && !drawVRules)
+        return;
+    if ((GetWindowStyle() & wxLC_REPORT) == 0)
+        return;
+
+    wxPen pen(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID);
+    dc.SetPen(pen);
+    dc.SetBrush(* wxTRANSPARENT_BRUSH);
+
+    wxSize clientSize = GetClientSize();
+    wxRect itemRect;
+    int cy=0;
+
+    int itemCount = GetItemCount();
+    int i;
+    for (i = 0; i < itemCount; i++)
     {
-        wxNode *node = m_stringPool.First();
-        delete[] (char *)node->Data();
-        delete node;
+        if (GetItemRect(i, itemRect))
+        {
+            cy = itemRect.GetTop();
+            if (i != 0) // Don't draw the first one
+            {
+                dc.DrawLine(0, cy, clientSize.x, cy);
+            }
+            // Draw last line
+            if (i == (GetItemCount() - 1))
+            {
+                cy = itemRect.GetBottom();
+                dc.DrawLine(0, cy, clientSize.x, cy);
+            }
+        }
+    }
+    i = (GetItemCount() - 1);
+    if (drawVRules && (i > -1))
+    {
+        wxRect firstItemRect;
+        GetItemRect(0, firstItemRect);
+
+        if (GetItemRect(i, itemRect))
+        {
+            int col;
+            int x = itemRect.GetX();
+            for (col = 0; col < GetColumnCount(); col++)
+            {
+                int colWidth = GetColumnWidth(col);
+                x += colWidth ;
+                dc.DrawLine(x, firstItemRect.GetY() - 2, x, itemRect.GetBottom());
+            }
+        }
+    }
+}
+
+// ----------------------------------------------------------------------------
+// virtual list controls
+// ----------------------------------------------------------------------------
+
+wxString wxListCtrl::OnGetItemText(long item, long col) const
+{
+    // this is a pure virtual function, in fact - which is not really pure
+    // because the controls which are not virtual don't need to implement it
+    wxFAIL_MSG( _T("not supposed to be called") );
+
+    return wxEmptyString;
+}
+
+int wxListCtrl::OnGetItemImage(long item) const
+{
+    // same as above
+    wxFAIL_MSG( _T("not supposed to be called") );
+
+    return -1;
+}
+
+void wxListCtrl::SetItemCount(long count)
+{
+    wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
+
+    if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT, (WPARAM)count, 0) )
+    {
+        wxLogLastError(_T("ListView_SetItemCount"));
     }
-    wxNode *node = m_stringPool.Add(WXSTRINGCAST str);
-    return (wxChar *)node->Data();
 }
 
 // ----------------------------------------------------------------------------
@@ -1707,7 +1874,7 @@ void wxListItem::ClearAttributes()
     m_attr = NULL;
 }
 
-static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& lvItem, HWND getFullInfo)
+static void wxConvertFromMSWListItem(const wxListCtrl *WXUNUSED(ctrl), wxListItem& info, LV_ITEM& lvItem, HWND getFullInfo)
 {
     info.m_data = lvItem.lParam;
     info.m_mask = 0;
@@ -1838,7 +2005,8 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_
         }
         else
         {
-            lvItem.pszText = WXSTRINGCAST info.m_text;
+            // pszText is not const, hence the cast
+            lvItem.pszText = (wxChar *)info.m_text.c_str();
             if ( lvItem.pszText )
                 lvItem.cchTextMax = info.m_text.Length();
             else
@@ -1867,5 +2035,4 @@ wxListEvent::wxListEvent(wxEventType commandType, int id)
     m_cancelled = FALSE;
 }
 
-#endif // __WIN95__
-
+#endif // wxUSE_LISTCTRL