]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/listctrl.cpp
removed documentation for wxStartTimer() and wxGetElapsedTime() which are only kept...
[wxWidgets.git] / src / msw / listctrl.cpp
index 3524895a5f687b2b4938490a1663d7cb2e7cd093..9800a2832c4a311b9226370431547789917b1cf6 100644 (file)
@@ -2,7 +2,7 @@
 // Name:        src/msw/listctrl.cpp
 // Purpose:     wxListCtrl
 // Author:      Julian Smart
-// Modified by:
+// Modified by: Agron Selimaj
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 
 #if wxUSE_LISTCTRL
 
+#include "wx/listctrl.h"
+
 #ifndef WX_PRECOMP
+    #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
     #include "wx/app.h"
     #include "wx/intl.h"
     #include "wx/log.h"
     #include "wx/settings.h"
+    #include "wx/dcclient.h"
+    #include "wx/textctrl.h"
 #endif
 
-#include "wx/textctrl.h"
 #include "wx/imaglist.h"
-#include "wx/listctrl.h"
-#include "wx/dcclient.h"
 
 #include "wx/msw/private.h"
 
@@ -48,9 +50,6 @@
   #endif
 #endif
 
-// include <commctrl.h> "properly"
-#include "wx/msw/wrapcctl.h"
-
 // Currently gcc and watcom don't define NMLVFINDITEM, and DMC only defines
 // it by its old name NM_FINDTIEM.
 //
@@ -218,35 +217,6 @@ static wxListItemAttr *wxGetInternalDataAttr(const wxListCtrl *ctl, long itemId)
 static void wxDeleteInternalData(wxListCtrl* ctl, long itemId);
 
 
-// ----------------------------------------------------------------------------
-// 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)
-#if WXWIN_COMPATIBILITY_2_4
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO)
-#endif
-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_COL_RIGHT_CLICK)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG)
-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)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT)
-
 #if wxUSE_EXTENDED_RTTI
 WX_DEFINE_FLAGS( wxListCtrlStyle )
 
@@ -761,6 +731,10 @@ bool wxListCtrl::GetItem(wxListItem& info) const
 // Sets information about the item
 bool wxListCtrl::SetItem(wxListItem& info)
 {
+    const long id = info.GetId();
+    wxCHECK_MSG( id >= 0 && id < GetItemCount(), false,
+                 _T("invalid item index in SetItem") );
+
     LV_ITEM item;
     wxConvertToMSWListItem(this, info, item);
 
@@ -773,7 +747,7 @@ bool wxListCtrl::SetItem(wxListItem& info)
     {
         // get internal item data
         // perhaps a cache here ?
-        wxListItemInternalData *data = wxGetInternalData(this, info.m_itemId);
+        wxListItemInternalData *data = wxGetInternalData(this, id);
 
         if (! data)
         {
@@ -1006,6 +980,24 @@ wxRect wxListCtrl::GetViewRect() const
 
 // Gets the item rectangle
 bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
+{
+    return GetSubItemRect( item, wxLIST_GETSUBITEMRECT_WHOLEITEM, rect, code) ;
+}
+
+/*!
+ * Retrieve coordinates and size of a specified subitem of a listview control.
+ * This function only works if the listview control is in the report mode.
+ *
+ * @param item : Item number
+ * @param subItem : Subitem or column number, use -1 for the whole row including
+ *                  all columns or subitems
+ * @param rect : A pointer to an allocated wxRect object
+ * @param code : Specify the part of the subitem coordinates you need. Choices are
+ *               wxLIST_RECT_BOUNDS, wxLIST_RECT_ICON, wxLIST_RECT_LABEL
+ *
+ * @return bool  : True if successful.
+ */
+bool wxListCtrl::GetSubItemRect(long item, long subItem, wxRect& rect, int code) const
 {
     RECT rectWin;
 
@@ -1018,12 +1010,24 @@ bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
         codeWin = LVIR_LABEL;
     else
     {
-        wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
-
+        wxFAIL_MSG( _T("incorrect code in GetItemRect() / GetSubItemRect()") );
         codeWin = LVIR_BOUNDS;
     }
 
-    bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 0;
+    bool success;
+    if( subItem == wxLIST_GETSUBITEMRECT_WHOLEITEM)
+    {
+      success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 0;
+    }
+    else if( subItem >= 0)
+    {
+      success = ListView_GetSubItemRect( GetHwnd(), (int) item, (int) subItem, codeWin, &rectWin) != 0;
+    }
+    else
+    {
+      wxFAIL_MSG( _T("incorrect subItem number in GetSubItemRect()") );
+      return false;
+    }
 
     rect.x = rectWin.left;
     rect.y = rectWin.top;
@@ -1033,6 +1037,9 @@ bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
     return success;
 }
 
+
+
+
 // Gets the item position
 bool wxListCtrl::GetItemPosition(long item, wxPoint& pos) const
 {
@@ -1063,11 +1070,15 @@ wxSize wxListCtrl::GetItemSpacing() const
     return wxSize(LOWORD(spacing), HIWORD(spacing));
 }
 
+#if WXWIN_COMPATIBILITY_2_6
+
 int wxListCtrl::GetItemSpacing(bool isSmall) const
 {
     return ListView_GetItemSpacing(GetHwnd(), (BOOL) isSmall);
 }
 
+#endif // WXWIN_COMPATIBILITY_2_6
+
 void wxListCtrl::SetItemTextColour( long item, const wxColour &col )
 {
     wxListItem info;
@@ -1383,21 +1394,19 @@ bool wxListCtrl::EndEditLabel(bool cancel)
 {
     // m_textCtrl is not always ready, ie. in EVT_LIST_BEGIN_LABEL_EDIT
     HWND hwnd = ListView_GetEditControl(GetHwnd());
-    bool b = (hwnd != NULL);
-    if (b)
-    {
-        if (cancel)
-            ::SetWindowText(hwnd, wxEmptyString); // dubious but better than nothing
-        if (m_textCtrl)
-        {
-            m_textCtrl->UnsubclassWin();
-            m_textCtrl->SetHWND(0);
-            delete m_textCtrl;
-            m_textCtrl = NULL;
-        }
-        ::DestroyWindow(hwnd);
-    }
-    return b;
+    if ( !hwnd )
+        return false;
+
+    if ( cancel )
+        ::SetWindowText(hwnd, wxEmptyString); // dubious but better than nothing
+
+    // we shouldn't destroy the control ourselves according to MSDN, which
+    // proposes WM_CANCELMODE to do this, but it doesn't seem to work
+    //
+    // posting WM_CLOSE to it does seem to work without any side effects
+    ::PostMessage(hwnd, WM_CLOSE, 0, 0);
+
+    return true;
 }
 
 // Ensures this item is visible
@@ -1470,13 +1479,25 @@ long wxListCtrl::FindItem(long start, const wxPoint& pt, int direction)
 
 // Determines which item (if any) is at the specified point,
 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
-long wxListCtrl::HitTest(const wxPoint& point, int& flags)
+long
+wxListCtrl::HitTest(const wxPoint& point, int& flags, long *ptrSubItem) const
 {
     LV_HITTESTINFO hitTestInfo;
     hitTestInfo.pt.x = (int) point.x;
     hitTestInfo.pt.y = (int) point.y;
 
-    ListView_HitTest(GetHwnd(), & hitTestInfo);
+    long item;
+#ifdef LVM_SUBITEMHITTEST
+    if ( ptrSubItem && wxApp::GetComCtl32Version() >= 470 )
+    {
+        item = ListView_SubItemHitTest(GetHwnd(), &hitTestInfo);
+        *ptrSubItem = hitTestInfo.iSubItem;
+    }
+    else
+#endif // LVM_SUBITEMHITTEST
+    {
+        item = ListView_HitTest(GetHwnd(), &hitTestInfo);
+    }
 
     flags = 0;
 
@@ -1511,9 +1532,10 @@ long wxListCtrl::HitTest(const wxPoint& point, int& flags)
             flags |= wxLIST_HITTEST_ONITEMSTATEICON;
     }
 
-    return (long) hitTestInfo.iItem;
+    return item;
 }
 
+
 // Inserts an item, returning the index of the new item if successful,
 // -1 otherwise.
 long wxListCtrl::InsertItem(const wxListItem& info)
@@ -1709,6 +1731,24 @@ bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data)
 // message processing
 // ----------------------------------------------------------------------------
 
+bool wxListCtrl::MSWShouldPreProcessMessage(WXMSG* msg)
+{
+    if ( msg->message == WM_KEYDOWN )
+    {
+        if ( msg->wParam == VK_RETURN )
+        {
+            // We need VK_RETURN to generate wxEVT_COMMAND_LIST_ITEM_ACTIVATED,
+            // but only if none of the modifiers is down.  We'll let normal
+            // accelerators handle those.
+            if ( !wxIsCtrlDown() && !wxIsCtrlDown() &&
+                 !((HIWORD(msg->lParam) & KF_ALTDOWN) == KF_ALTDOWN))
+            return false;
+        }
+    }
+
+    return wxControl::MSWShouldPreProcessMessage(msg);
+}
+
 bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id)
 {
     if (cmd == EN_UPDATE)
@@ -1729,6 +1769,50 @@ bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id)
         return false;
 }
 
+// utility used by wxListCtrl::MSWOnNotify and by wxDataViewHeaderWindowMSW::MSWOnNotify
+int WXDLLIMPEXP_CORE wxMSWGetColumnClicked(NMHDR *nmhdr, POINT *ptClick)
+{
+    wxASSERT(nmhdr && ptClick);
+
+    // find the column clicked: we have to search for it
+    // ourselves as the notification message doesn't provide
+    // this info
+
+    // where did the click occur?
+#if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
+    if (nmhdr->code == GN_CONTEXTMENU)
+    {
+        *ptClick = ((NMRGINFO*)nmhdr)->ptAction;
+    }
+    else
+#endif //__WXWINCE__
+    if ( !::GetCursorPos(ptClick) )
+    {
+        wxLogLastError(_T("GetCursorPos"));
+    }
+
+    if ( !::ScreenToClient(nmhdr->hwndFrom, ptClick) )
+    {
+        wxLogLastError(_T("ScreenToClient(header)"));
+    }
+
+    int colCount = Header_GetItemCount(nmhdr->hwndFrom);
+
+    RECT rect;
+    for ( int col = 0; col < colCount; col++ )
+    {
+        if ( Header_GetItemRect(nmhdr->hwndFrom, col, &rect) )
+        {
+            if ( ::PtInRect(&rect, *ptClick) )
+            {
+                return col;
+            }
+        }
+    }
+
+    return wxNOT_FOUND;
+}
+
 bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 {
 
@@ -1796,47 +1880,12 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 #endif //__WXWINCE__
             case NM_RCLICK:
                 {
-                    eventType = wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
-                    event.m_col = -1;
-
-                    // find the column clicked: we have to search for it
-                    // ourselves as the notification message doesn't provide
-                    // this info
-
-                    // where did the click occur?
                     POINT ptClick;
-#if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
-                  if(nmhdr->code == GN_CONTEXTMENU) {
-                      ptClick = ((NMRGINFO*)nmhdr)->ptAction;
-                  } else
-#endif //__WXWINCE__
-                    if ( !::GetCursorPos(&ptClick) )
-                    {
-                        wxLogLastError(_T("GetCursorPos"));
-                    }
-
-                    if ( !::ScreenToClient(GetHwnd(), &ptClick) )
-                    {
-                        wxLogLastError(_T("ScreenToClient(listctrl header)"));
-                    }
 
+                    eventType = wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
+                    event.m_col = wxMSWGetColumnClicked(nmhdr, &ptClick);
                     event.m_pointDrag.x = ptClick.x;
                     event.m_pointDrag.y = ptClick.y;
-
-                    int colCount = Header_GetItemCount(hwndHdr);
-
-                    RECT rect;
-                    for ( int col = 0; col < colCount; col++ )
-                    {
-                        if ( Header_GetItemRect(hwndHdr, col, &rect) )
-                        {
-                            if ( ::PtInRect(&rect, ptClick) )
-                            {
-                                event.m_col = col;
-                                break;
-                            }
-                        }
-                    }
                 }
                 break;
 
@@ -1846,7 +1895,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 // parameters
                 //
                 // I have no idea what is the real cause of the bug (which is,
-                // just to make things interesting, is impossible to reproduce
+                // just to make things interesting, impossible to reproduce
                 // reliably) but ignoring all these messages does fix it and
                 // doesn't seem to have any negative consequences
                 return true;
@@ -1857,7 +1906,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
     }
     else
 #endif // defined(HDN_BEGINTRACKA)
-        if ( nmhdr->hwndFrom == GetHwnd() )
+    if ( nmhdr->hwndFrom == GetHwnd() )
     {
         // almost all messages use NM_LISTVIEW
         NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr;
@@ -1989,16 +2038,6 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 wxDeleteInternalData(this, iItem);
                 break;
 
-#if WXWIN_COMPATIBILITY_2_4
-            case LVN_SETDISPINFO:
-                {
-                    eventType = wxEVT_COMMAND_LIST_SET_INFO;
-                    LV_DISPINFO *info = (LV_DISPINFO *)lParam;
-                    wxConvertFromMSWListItem(GetHwnd(), event.m_item, info->item);
-                }
-                break;
-#endif
-
             case LVN_INSERTITEM:
                 eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
                 event.m_itemIndex = iItem;
@@ -2280,10 +2319,13 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                     }
 #endif // NM_CUSTOMDRAW
 
-                    // 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!") );
+                    // even though we never use LVM_SETCALLBACKMASK, we still
+                    // can get messages with LVIF_STATE in lvi.mask under Vista
+                    if ( lvi.mask & LVIF_STATE )
+                    {
+                        // we don't have anything to return from here...
+                        lvi.stateMask = 0;
+                    }
 
                     return true;
                 }
@@ -2998,7 +3040,7 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
         else
         {
             // pszText is not const, hence the cast
-            lvItem.pszText = (wxChar *)info.m_text.c_str();
+            lvItem.pszText = (wxChar *)info.m_text.wx_str();
             if ( lvItem.pszText )
                 lvItem.cchTextMax = info.m_text.length();
             else
@@ -3019,7 +3061,7 @@ static void wxConvertToMSWListCol(HWND hwndList,
     if ( item.m_mask & wxLIST_MASK_TEXT )
     {
         lvCol.mask |= LVCF_TEXT;
-        lvCol.pszText = (wxChar *)item.m_text.c_str(); // cast is safe
+        lvCol.pszText = (wxChar *)item.m_text.wx_str(); // cast is safe
     }
 
     if ( item.m_mask & wxLIST_MASK_FORMAT )
@@ -3049,7 +3091,7 @@ static void wxConvertToMSWListCol(HWND hwndList,
 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
     if ( item.m_mask & wxLIST_MASK_IMAGE )
     {
-        if ( wxTheApp->GetComCtl32Version() >= 470 )
+        if ( wxApp::GetComCtl32Version() >= 470 )
         {
             lvCol.mask |= LVCF_IMAGE;