handle NULL BSTRs as empty ones per Microsoft convention

[wxWidgets.git] / src / msw / listctrl.cpp

diff --git a/src/msw/listctrl.cpp b/src/msw/listctrl.cpp
index 9cd988f15dacbe5c789ac554c74b9bbfab62277a..281d6c9efb1c9978a4288b62642d5fd74a544be2 100644 (file)
--- a/src/msw/listctrl.cpp
+++ b/src/msw/listctrl.cpp
@@ -205,7 +205,7 @@ public:
    {
        if (attr)
            delete attr;
    {
        if (attr)
            delete attr;

-   };
+   }

 
     DECLARE_NO_COPY_CLASS(wxListItemInternalData)
 };
 
     DECLARE_NO_COPY_CLASS(wxListItemInternalData)
 };


@@ -342,8 +342,17 @@ bool wxListCtrl::Create(wxWindow *parent,
     // styles because it's prettier (and also because wxGTK does it like this)
     if ( InReportView() && wxApp::GetComCtl32Version() >= 470 )
     {
     // 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);
+        ::SendMessage
+        (
+            GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE, 0,
+            LVS_EX_LABELTIP |
+            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;
     }
 
     return true;


@@ -663,6 +672,68 @@ bool wxListCtrl::SetColumnWidth(int col, int width)
     return ListView_SetColumnWidth(GetHwnd(), col, width) != 0;
 }
 
     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
 // 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


@@ -948,7 +1019,7 @@ wxUIntPtr wxListCtrl::GetItemData(long item) const
 }
 
 // Sets the item data
 }
 
 // Sets the item data

-bool wxListCtrl::SetItemData(long item, long data)
+bool wxListCtrl::SetItemPtrData(long item, wxUIntPtr data)

 {
     wxListItem info;
 
 {
     wxListItem info;
 


@@ -1424,7 +1495,7 @@ long wxListCtrl::FindItem(long start, const wxString& str, bool partial)
     findInfo.flags = LVFI_STRING;
     if ( partial )
         findInfo.flags |= LVFI_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
 
     // 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 +1806,20 @@ bool wxListCtrl::MSWShouldPreProcessMessage(WXMSG* msg)
 {
     if ( msg->message == WM_KEYDOWN )
     {
 {
     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 false;
         }
     }

-

     return wxControl::MSWShouldPreProcessMessage(msg);
 }
 
     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);
     if (cmd == EN_UPDATE)
     {
         wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id);


@@ -2417,22 +2486,23 @@ static RECT GetCustomDrawnItemRect(const NMCUSTOMDRAW& nmcd)
     return rc;
 }
 
     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;
 {
     NMCUSTOMDRAW& nmcd = pLVCD->nmcd;
 
     HDC hdc = nmcd.hdc;
     HWND hwndList = nmcd.hdr.hwndFrom;

+    const int col = pLVCD->iSubItem;

     const DWORD item = nmcd.dwItemSpec;
 
     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;
     // 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
     {
         // broken ListView_GetSubItemRect() returns the entire item rect for
         // 0th subitem while we really need just the part for this column


@@ -2453,7 +2523,7 @@ static void HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
     wxZeroMemory(it);
     it.mask = LVIF_TEXT | LVIF_IMAGE;
     it.iItem = item;
     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);
     it.pszText = text;
     it.cchTextMax = WXSIZEOF(text);
     ListView_GetItem(hwndList, &it);


@@ -2483,12 +2553,38 @@ static void HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
 
     ::SetBkMode(hdc, TRANSPARENT);
 
 
     ::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__
 #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)
 }
 
 static void HandleItemPostpaint(NMCUSTOMDRAW nmcd)


@@ -2576,7 +2672,7 @@ static void HandleItemPaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
     for ( int col = 0; col < colCount; col++ )
     {
         pLVCD->iSubItem = col;
     for ( int col = 0; col < colCount; col++ )
     {
         pLVCD->iSubItem = col;

-        HandleSubItemPrepaint(pLVCD, hfont);
+        HandleSubItemPrepaint(pLVCD, hfont, colCount);

     }
 
     HandleItemPostpaint(nmcd);
     }
 
     HandleItemPostpaint(nmcd);


@@ -2722,14 +2818,22 @@ void wxListCtrl::OnPaint(wxPaintEvent& event)
 
             dc.SetPen(pen);
             dc.SetBrush(*wxTRANSPARENT_BRUSH);
 
             dc.SetPen(pen);
             dc.SetBrush(*wxTRANSPARENT_BRUSH);

+
+            int numCols = GetColumnCount();
+            int* indexArray = new int[numCols];
+            BOOL rv = ListView_GetColumnOrderArray( GetHwnd(), numCols, indexArray );
+            wxASSERT_MSG( rv == TRUE, _T("invalid column index array in OnPaint()") );
+

             int x = itemRect.GetX();
             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());
             }
                 x += colWidth ;
                 dc.DrawLine(x-1, firstItemRect.GetY() - gap,
                             x-1, itemRect.GetBottom());
             }

+
+            delete indexArray;

         }
     }
 }
         }
     }
 }


@@ -2820,30 +2924,12 @@ void wxListCtrl::SetItemCount(long count)
 
 void wxListCtrl::RefreshItem(long item)
 {
 
 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)
 {
 }
 
 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);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -3040,7 +3126,7 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl,
         else
         {
             // pszText is not const, hence the cast
         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
             if ( lvItem.pszText )
                 lvItem.cchTextMax = info.m_text.length();
             else


@@ -3061,7 +3147,7 @@ static void wxConvertToMSWListCol(HWND hwndList,
     if ( item.m_mask & wxLIST_MASK_TEXT )
     {
         lvCol.mask |= LVCF_TEXT;
     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 )
     }
 
     if ( item.m_mask & wxLIST_MASK_FORMAT )