]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/listctrl.cpp
make sure all wxDefault* and all wxNull* global instances are documented
[wxWidgets.git] / src / msw / listctrl.cpp
index 9800a2832c4a311b9226370431547789917b1cf6..0a35839f26bbf3ffc726311b27fd976cb43e984a 100644 (file)
@@ -205,7 +205,7 @@ public:
    {
        if (attr)
            delete attr;
-   };
+   }
 
     DECLARE_NO_COPY_CLASS(wxListItemInternalData)
 };
@@ -279,7 +279,7 @@ wxEND_HANDLERS_TABLE()
 wxCONSTRUCTOR_5( wxListCtrl , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle )
 
 /*
- TODO : Expose more information of a list's layout etc. via appropriate objects (à la NotebookPageInfo)
+ TODO : Expose more information of a list's layout etc. via appropriate objects (a la NotebookPageInfo)
 */
 #else
 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)
@@ -338,15 +338,34 @@ bool wxListCtrl::Create(wxWindow *parent,
     // GetTextColour will always return black
     SetTextColour(GetDefaultAttributes().colFg);
 
+    if ( InReportView() )
+        MSWSetExListStyles();
+
+    return true;
+}
+
+void wxListCtrl::MSWSetExListStyles()
+{
     // for comctl32.dll v 4.70+ we want to have some non default extended
     // styles because it's prettier (and also because wxGTK does it like this)
-    if ( InReportView() && wxApp::GetComCtl32Version() >= 470 )
-    {
-        ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE,
-                      0, LVS_EX_LABELTIP | LVS_EX_FULLROWSELECT | LVS_EX_SUBITEMIMAGES);
+    if ( wxApp::GetComCtl32Version() >= 470 )
+    {
+        ::SendMessage
+        (
+            GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE, 0,
+            // LVS_EX_LABELTIP shouldn't be used under Windows CE where it's
+            // not defined in the SDK headers
+#ifdef LVS_EX_LABELTIP
+            LVS_EX_LABELTIP |
+#endif
+            LVS_EX_FULLROWSELECT |
+            LVS_EX_SUBITEMIMAGES |
+            // normally this should be governed by a style as it's probably not
+            // always appropriate, but we don't have any free styles left and
+            // it seems better to enable it by default than disable
+            LVS_EX_HEADERDRAGDROP
+        );
     }
-
-    return true;
 }
 
 WXDWORD wxListCtrl::MSWGetStyle(long style, WXDWORD *exstyle) const
@@ -445,6 +464,11 @@ void wxListCtrl::UpdateStyle()
         if ( dwStyleOld != dwStyleNew )
         {
             ::SetWindowLong(GetHwnd(), GWL_STYLE, dwStyleNew);
+
+            // if we switched to the report view, set the extended styles for
+            // it too
+            if ( !(dwStyleOld & LVS_REPORT) && (dwStyleNew & LVS_REPORT) )
+                MSWSetExListStyles();
         }
     }
 }
@@ -663,6 +687,68 @@ bool wxListCtrl::SetColumnWidth(int col, int width)
     return ListView_SetColumnWidth(GetHwnd(), col, width) != 0;
 }
 
+// ----------------------------------------------------------------------------
+// columns order
+// ----------------------------------------------------------------------------
+
+int wxListCtrl::GetColumnOrder(int col) const
+{
+    const int numCols = GetColumnCount();
+    wxCHECK_MSG( col >= 0 && col < numCols, -1, _T("Col index out of bounds") );
+
+    wxArrayInt indexArray(numCols);
+
+    if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols, &indexArray[0]) )
+        return -1;
+
+    return indexArray[col];
+}
+
+int wxListCtrl::GetColumnIndexFromOrder(int order) const
+{
+    const int numCols = GetColumnCount();
+    wxASSERT_MSG( order >= 0 && order < numCols, _T("Col order out of bounds") );
+
+    wxArrayInt indexArray(numCols);
+
+    if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols, &indexArray[0]) )
+        return -1;
+
+    for ( int col = 0; col < numCols; col++ )
+    {
+        if ( indexArray[col] == order )
+            return col;
+    }
+
+    wxFAIL_MSG( _T("no column with with given order?") );
+
+    return -1;
+}
+
+// Gets the column order for all columns
+wxArrayInt wxListCtrl::GetColumnsOrder() const
+{
+    const int numCols = GetColumnCount();
+
+    wxArrayInt orders(numCols);
+    if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols, &orders[0]) )
+        orders.clear();
+
+    return orders;
+}
+
+// Sets the column order for all columns
+bool wxListCtrl::SetColumnsOrder(const wxArrayInt& orders)
+{
+    const int numCols = GetColumnCount();
+
+    wxCHECK_MSG( orders.size() == (size_t)numCols, false,
+                    _T("wrong number of elements in column orders array") );
+
+    return ListView_SetColumnOrderArray(GetHwnd(), numCols, &orders[0]) != 0;
+}
+
+
 // Gets the number of items that can fit vertically in the
 // visible area of the list control (list or report view)
 // or the total number of items in the list control (icon
@@ -852,14 +938,15 @@ bool wxListCtrl::SetItemState(long item, long state, long stateMask)
 
     wxConvertToMSWFlags(state, stateMask, lvItem);
 
+    const bool changingFocus = (stateMask & wxLIST_STATE_FOCUSED) &&
+                                    (state & wxLIST_STATE_FOCUSED);
+
     // for the virtual list controls we need to refresh the previously focused
     // item manually when changing focus without changing selection
     // programmatically because otherwise it keeps its focus rectangle until
     // next repaint (yet another comctl32 bug)
     long focusOld;
-    if ( IsVirtual() &&
-         (stateMask & wxLIST_STATE_FOCUSED) &&
-         (state & wxLIST_STATE_FOCUSED) )
+    if ( IsVirtual() && changingFocus )
     {
         focusOld = GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED);
     }
@@ -887,6 +974,16 @@ bool wxListCtrl::SetItemState(long item, long state, long stateMask)
         }
     }
 
+    // we expect the selection anchor, i.e. the item from which multiple
+    // selection (such as performed with e.g. Shift-arrows) starts, to be the
+    // same as the currently focused item but the native control doesn't update
+    // it when we change focus and leaves at the last item it set itself focus
+    // to, so do it explicitly
+    if ( changingFocus && !HasFlag(wxLC_SINGLE_SEL) )
+    {
+        ListView_SetSelectionMark(GetHwnd(), item);
+    }
+
     return true;
 }
 
@@ -948,7 +1045,7 @@ wxUIntPtr wxListCtrl::GetItemData(long item) const
 }
 
 // Sets the item data
-bool wxListCtrl::SetItemData(long item, long data)
+bool wxListCtrl::SetItemPtrData(long item, wxUIntPtr data)
 {
     wxListItem info;
 
@@ -1424,7 +1521,7 @@ long wxListCtrl::FindItem(long start, const wxString& str, bool partial)
     findInfo.flags = LVFI_STRING;
     if ( partial )
         findInfo.flags |= LVFI_PARTIAL;
-    findInfo.psz = str;
+    findInfo.psz = str.wx_str();
 
     // 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
@@ -1735,22 +1832,20 @@ bool wxListCtrl::MSWShouldPreProcessMessage(WXMSG* msg)
 {
     if ( msg->message == WM_KEYDOWN )
     {
-        if ( msg->wParam == VK_RETURN )
+        // Only eat VK_RETURN if not being used by the application in
+        // conjunction with modifiers
+        if ( msg->wParam == VK_RETURN && !wxIsAnyModifierDown() )
         {
-            // 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))
+            // we need VK_RETURN to generate wxEVT_COMMAND_LIST_ITEM_ACTIVATED
             return false;
         }
     }
-
     return wxControl::MSWShouldPreProcessMessage(msg);
 }
 
-bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id)
+bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id_)
 {
+    const int id = (signed short)id_;
     if (cmd == EN_UPDATE)
     {
         wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);
@@ -1772,15 +1867,12 @@ bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id)
 // 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
+    // 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)
+    if ( nmhdr->code == GN_CONTEXTMENU )
     {
         *ptClick = ((NMRGINFO*)nmhdr)->ptAction;
     }
@@ -1791,19 +1883,27 @@ int WXDLLIMPEXP_CORE wxMSWGetColumnClicked(NMHDR *nmhdr, POINT *ptClick)
         wxLogLastError(_T("GetCursorPos"));
     }
 
-    if ( !::ScreenToClient(nmhdr->hwndFrom, ptClick) )
+    // we need to use listctrl coordinates for the event point so this is what
+    // we return in ptClick, but for comparison with Header_GetItemRect()
+    // result below we need to use header window coordinates
+    POINT ptClickHeader = *ptClick;
+    if ( !::ScreenToClient(nmhdr->hwndFrom, &ptClickHeader) )
     {
-        wxLogLastError(_T("ScreenToClient(header)"));
+        wxLogLastError(_T("ScreenToClient(listctrl header)"));
     }
 
-    int colCount = Header_GetItemCount(nmhdr->hwndFrom);
+    if ( !::ScreenToClient(::GetParent(nmhdr->hwndFrom), ptClick) )
+    {
+        wxLogLastError(_T("ScreenToClient(listctrl)"));
+    }
 
-    RECT rect;
+    const int colCount = Header_GetItemCount(nmhdr->hwndFrom);
     for ( int col = 0; col < colCount; col++ )
     {
+        RECT rect;
         if ( Header_GetItemRect(nmhdr->hwndFrom, col, &rect) )
         {
-            if ( ::PtInRect(&rect, *ptClick) )
+            if ( ::PtInRect(&rect, ptClickHeader) )
             {
                 return col;
             }
@@ -2077,7 +2177,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                             // focus event from here and the selection one
                             // below
                             event.SetEventType(eventType);
-                            (void)GetEventHandler()->ProcessEvent(event);
+                            (void)HandleWindowEvent(event);
                         }
                         else // no focus event to send
                         {
@@ -2349,7 +2449,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
     event.SetEventType(eventType);
 
-    bool processed = GetEventHandler()->ProcessEvent(event);
+    bool processed = HandleWindowEvent(event);
 
     // post processing
     // ---------------
@@ -2417,22 +2517,23 @@ static RECT GetCustomDrawnItemRect(const NMCUSTOMDRAW& nmcd)
     return rc;
 }
 
-static void HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
+static
+bool HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont, int colCount)
 {
     NMCUSTOMDRAW& nmcd = pLVCD->nmcd;
 
     HDC hdc = nmcd.hdc;
     HWND hwndList = nmcd.hdr.hwndFrom;
+    const int col = pLVCD->iSubItem;
     const DWORD item = nmcd.dwItemSpec;
 
-
     // the font must be valid, otherwise we wouldn't be painting the item at all
     SelectInHDC selFont(hdc, hfont);
 
     // get the rectangle to paint
     RECT rc;
-    ListView_GetSubItemRect(hwndList, item, pLVCD->iSubItem, LVIR_BOUNDS, &rc);
-    if ( !pLVCD->iSubItem )
+    ListView_GetSubItemRect(hwndList, item, col, LVIR_BOUNDS, &rc);
+    if ( !col && colCount > 1 )
     {
         // broken ListView_GetSubItemRect() returns the entire item rect for
         // 0th subitem while we really need just the part for this column
@@ -2453,7 +2554,7 @@ static void HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
     wxZeroMemory(it);
     it.mask = LVIF_TEXT | LVIF_IMAGE;
     it.iItem = item;
-    it.iSubItem = pLVCD->iSubItem;
+    it.iSubItem = col;
     it.pszText = text;
     it.cchTextMax = WXSIZEOF(text);
     ListView_GetItem(hwndList, &it);
@@ -2483,12 +2584,38 @@ static void HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
 
     ::SetBkMode(hdc, TRANSPARENT);
 
-    // TODO: support for centred/right aligned columns
-    ::DrawText(hdc, text, -1, &rc,
+    UINT fmt = DT_SINGLELINE |
 #ifndef __WXWINCE__
                DT_WORD_ELLIPSIS |
 #endif // __WXWINCE__
-               DT_NOPREFIX | DT_SINGLELINE | DT_VCENTER);
+               DT_NOPREFIX |
+               DT_VCENTER;
+
+    LV_COLUMN lvCol;
+    wxZeroMemory(lvCol);
+    lvCol.mask = LVCF_FMT;
+    if ( ListView_GetColumn(hwndList, col, &lvCol) )
+    {
+        switch ( lvCol.fmt & LVCFMT_JUSTIFYMASK )
+        {
+            case LVCFMT_LEFT:
+                fmt |= DT_LEFT;
+                break;
+
+            case LVCFMT_CENTER:
+                fmt |= DT_CENTER;
+                break;
+
+            case LVCFMT_RIGHT:
+                fmt |= DT_RIGHT;
+                break;
+        }
+    }
+    //else: failed to get alignment, assume it's DT_LEFT (default)
+
+    DrawText(hdc, text, -1, &rc, fmt);
+
+    return true;
 }
 
 static void HandleItemPostpaint(NMCUSTOMDRAW nmcd)
@@ -2576,7 +2703,7 @@ static void HandleItemPaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
     for ( int col = 0; col < colCount; col++ )
     {
         pLVCD->iSubItem = col;
-        HandleSubItemPrepaint(pLVCD, hfont);
+        HandleSubItemPrepaint(pLVCD, hfont, colCount);
     }
 
     HandleItemPostpaint(nmcd);
@@ -2674,7 +2801,7 @@ void wxListCtrl::OnPaint(wxPaintEvent& event)
     // Reset the device origin since it may have been set
     dc.SetDeviceOrigin(0, 0);
 
-    wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID);
+    wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT));
     dc.SetPen(pen);
     dc.SetBrush(* wxTRANSPARENT_BRUSH);
 
@@ -2722,14 +2849,24 @@ void wxListCtrl::OnPaint(wxPaintEvent& event)
 
             dc.SetPen(pen);
             dc.SetBrush(*wxTRANSPARENT_BRUSH);
+
+            int numCols = GetColumnCount();
+            int* indexArray = new int[numCols];
+            if ( !ListView_GetColumnOrderArray( GetHwnd(), numCols, indexArray) )
+            {
+                wxFAIL_MSG( _T("invalid column index array in OnPaint()") );
+            }
+
             int x = itemRect.GetX();
-            for (int col = 0; col < GetColumnCount(); col++)
+            for (int col = 0; col < numCols; col++)
             {
-                int colWidth = GetColumnWidth(col);
+                int colWidth = GetColumnWidth(indexArray[col]);
                 x += colWidth ;
                 dc.DrawLine(x-1, firstItemRect.GetY() - gap,
                             x-1, itemRect.GetBottom());
             }
+
+            delete indexArray;
         }
     }
 }
@@ -2820,30 +2957,12 @@ void wxListCtrl::SetItemCount(long count)
 
 void wxListCtrl::RefreshItem(long item)
 {
-    // strangely enough, ListView_Update() results in much more flicker here
-    // than a dumb Refresh() -- why?
-#if 0
-    if ( !ListView_Update(GetHwnd(), item) )
-    {
-        wxLogLastError(_T("ListView_Update"));
-    }
-#else // 1
-    wxRect rect;
-    GetItemRect(item, rect);
-    RefreshRect(rect);
-#endif // 0/1
+    RefreshItems(item, item);
 }
 
 void wxListCtrl::RefreshItems(long itemFrom, long itemTo)
 {
-    wxRect rect1, rect2;
-    GetItemRect(itemFrom, rect1);
-    GetItemRect(itemTo, rect2);
-
-    wxRect rect = rect1;
-    rect.height = rect2.GetBottom() - rect1.GetTop();
-
-    RefreshRect(rect);
+    ListView_RedrawItems(GetHwnd(), itemFrom, itemTo);
 }
 
 // ----------------------------------------------------------------------------