]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/headerctrl.cpp
Fix wxGrid editors background painting.
[wxWidgets.git] / src / msw / headerctrl.cpp
index 2e2f75482b788bbcb07cd800fefdfa695ac09f77..6e543752abf7a26c7fe4641689df37564d8af232 100644 (file)
     #pragma hdrstop
 #endif
 
+#if wxUSE_HEADERCTRL
+
 #ifndef WX_PRECOMP
+    #include "wx/app.h"
     #include "wx/log.h"
 #endif // WX_PRECOMP
 
 #include "wx/msw/wrapcctl.h"
 #include "wx/msw/private.h"
 
+#ifndef HDM_SETBITMAPMARGIN
+    #define HDM_SETBITMAPMARGIN 0x1234
+#endif
+
+#ifndef Header_SetBitmapMargin
+    #define Header_SetBitmapMargin(hwnd, margin) \
+            ::SendMessage((hwnd), HDM_SETBITMAPMARGIN, (WPARAM)(margin), 0)
+#endif
+
 // from src/msw/listctrl.cpp
 extern int WXDLLIMPEXP_CORE wxMSWGetColumnClicked(NMHDR *nmhdr, POINT *ptClick);
 
@@ -49,7 +61,9 @@ extern int WXDLLIMPEXP_CORE wxMSWGetColumnClicked(NMHDR *nmhdr, POINT *ptClick);
 
 void wxHeaderCtrl::Init()
 {
+    m_numColumns = 0;
     m_imageList = NULL;
+    m_scrollOffset = 0;
 }
 
 bool wxHeaderCtrl::Create(wxWindow *parent,
@@ -66,9 +80,19 @@ bool wxHeaderCtrl::Create(wxWindow *parent,
     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
         return false;
 
-    if ( !MSWCreateControl(WC_HEADER, _T(""), pos, size) )
+    if ( !MSWCreateControl(WC_HEADER, wxT(""), pos, size) )
         return false;
 
+    // special hack for margins when using comctl32.dll v6 or later: the
+    // default margin is too big and results in label truncation when the
+    // column width is just about right to show it together with the sort
+    // indicator, so reduce it to a smaller value (in principle we could even
+    // use 0 here but this starts to look ugly)
+    if ( wxApp::GetComCtl32Version() >= 600 )
+    {
+        Header_SetBitmapMargin(GetHwnd(), ::GetSystemMetrics(SM_CXEDGE));
+    }
+
     return true;
 }
 
@@ -76,13 +100,15 @@ WXDWORD wxHeaderCtrl::MSWGetStyle(long style, WXDWORD *exstyle) const
 {
     WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
 
-    if ( style & wxHD_DRAGDROP )
+    if ( style & wxHD_ALLOW_REORDER )
         msStyle |= HDS_DRAGDROP;
 
     // the control looks nicer with these styles and there doesn't seem to be
     // any reason to not use them so we always do (as for HDS_HORZ it is 0
     // anyhow but include it for clarity)
-    msStyle |= HDS_HORZ | HDS_BUTTONS | HDS_FLAT | HDS_FULLDRAG | HDS_HOTTRACK;
+    // NOTE: don't use however HDS_FLAT because it makes the control look
+    //       non-native when running WinXP in classic mode
+    msStyle |= HDS_HORZ | HDS_BUTTONS | HDS_FULLDRAG | HDS_HOTTRACK;
 
     return msStyle;
 }
@@ -96,6 +122,14 @@ wxHeaderCtrl::~wxHeaderCtrl()
 // wxHeaderCtrl scrolling
 // ----------------------------------------------------------------------------
 
+void wxHeaderCtrl::DoSetSize(int x, int y,
+                             int w, int h,
+                             int sizeFlags)
+{
+    wxHeaderCtrlBase::DoSetSize(x + m_scrollOffset, y, w - m_scrollOffset, h,
+                                sizeFlags);
+}
+
 void wxHeaderCtrl::DoScrollHorz(int dx)
 {
     // as the native control doesn't support offsetting its contents, we use a
@@ -104,7 +138,11 @@ void wxHeaderCtrl::DoScrollHorz(int dx)
     // itself: to be precise, offset it by the scroll increment to the left and
     // increment its width to still extend to the right boundary to compensate
     // for it (notice that dx is negative when scrolling to the right)
-    SetSize(GetPosition().x + dx, -1, GetSize().x - dx, -1, wxSIZE_USE_EXISTING);
+    m_scrollOffset += dx;
+
+    wxHeaderCtrlBase::DoSetSize(GetPosition().x + dx, -1,
+                                GetSize().x - dx, -1,
+                                wxSIZE_USE_EXISTING);
 }
 
 // ----------------------------------------------------------------------------
@@ -118,7 +156,7 @@ wxSize wxHeaderCtrl::DoGetBestSize() const
     HDLAYOUT layout = { &rc, &wpos };
     if ( !Header_Layout(GetHwnd(), &layout) )
     {
-        wxLogLastError(_T("Header_Layout"));
+        wxLogLastError(wxT("Header_Layout"));
         return wxControl::DoGetBestSize();
     }
 
@@ -131,7 +169,21 @@ wxSize wxHeaderCtrl::DoGetBestSize() const
 
 unsigned int wxHeaderCtrl::DoGetCount() const
 {
-    return Header_GetItemCount(GetHwnd());
+    // we can't use Header_GetItemCount() here because it doesn't take the
+    // hidden columns into account and we can't find the hidden columns after
+    // the last shown one in MSWFromNativeIdx() without knowing where to stop
+    // so we have to store the columns count internally
+    return m_numColumns;
+}
+
+int wxHeaderCtrl::GetShownColumnsCount() const
+{
+    const int numItems = Header_GetItemCount(GetHwnd());
+
+    wxASSERT_MSG( numItems >= 0 && (unsigned)numItems <= m_numColumns,
+                  "unexpected number of items in the native control" );
+
+    return numItems;
 }
 
 void wxHeaderCtrl::DoSetCount(unsigned int count)
@@ -139,19 +191,34 @@ void wxHeaderCtrl::DoSetCount(unsigned int count)
     unsigned n;
 
     // first delete all old columns
-    const unsigned countOld = DoGetCount();
+    const unsigned countOld = GetShownColumnsCount();
     for ( n = 0; n < countOld; n++ )
     {
         if ( !Header_DeleteItem(GetHwnd(), 0) )
         {
-            wxLogLastError(_T("Header_DeleteItem"));
+            wxLogLastError(wxT("Header_DeleteItem"));
         }
     }
 
+    // update the column indices order array before changing m_numColumns
+    DoResizeColumnIndices(m_colIndices, count);
+
     // and add the new ones
+    m_numColumns = count;
+    m_isHidden.resize(m_numColumns);
     for ( n = 0; n < count; n++ )
     {
-        DoInsertItem(n, -1 /* default order, i.e. append */);
+        const wxHeaderColumn& col = GetColumn(n);
+        if ( col.IsShown() )
+        {
+            m_isHidden[n] = false;
+
+            DoInsertItem(col, n);
+        }
+        else // hidden initially
+        {
+            m_isHidden[n] = true;
+        }
     }
 }
 
@@ -163,23 +230,45 @@ void wxHeaderCtrl::DoUpdate(unsigned int idx)
     // more complicated as we'd have to reset the old values as well as setting
     // the new ones -- so instead just recreate the column
 
-    // we need to preserve the old position ourselves as the column doesn't
-    // store it (TODO: should it?)
-    const unsigned int pos = GetColumnPos(idx);
-    Header_DeleteItem(GetHwnd(), idx);
-    DoInsertItem(idx, pos);
+    const wxHeaderColumn& col = GetColumn(idx);
+    if ( col.IsHidden() )
+    {
+        // column is hidden now
+        if ( !m_isHidden[idx] )
+        {
+            // but it wasn't hidden before, so remove it
+            Header_DeleteItem(GetHwnd(), MSWToNativeIdx(idx));
+
+            m_isHidden[idx] = true;
+        }
+        //else: nothing to do, updating hidden column doesn't have any effect
+    }
+    else // column is shown now
+    {
+        if ( m_isHidden[idx] )
+        {
+            m_isHidden[idx] = false;
+        }
+        else // and it was shown before as well
+        {
+            // we need to remove the old column
+            Header_DeleteItem(GetHwnd(), MSWToNativeIdx(idx));
+        }
+
+        DoInsertItem(col, idx);
+    }
 }
 
-void wxHeaderCtrl::DoInsertItem(unsigned int idx, int order)
+void wxHeaderCtrl::DoInsertItem(const wxHeaderColumn& col, unsigned int idx)
 {
-    const wxHeaderColumnBase& col = GetColumn(idx);
+    wxASSERT_MSG( !col.IsHidden(), "should only be called for shown columns" );
 
     wxHDITEM hdi;
 
     // notice that we need to store the string we use the pointer to until we
     // pass it to the control
     hdi.mask |= HDI_TEXT;
-    wxWxCharBuffer buf = col.GetTitle().wx_str();
+    wxWxCharBuffer buf = col.GetTitle().t_str();
     hdi.pszText = buf.data();
     hdi.cchTextMax = wxStrlen(buf);
 
@@ -196,6 +285,7 @@ void wxHeaderCtrl::DoInsertItem(unsigned int idx, int order)
             if ( !m_imageList )
             {
                 m_imageList = new wxImageList(bmpWidth, bmpHeight);
+                (void) // suppress mingw32 warning about unused computed value
                 Header_SetImageList(GetHwnd(), GetHimagelistOf(m_imageList));
             }
             else // already have an image list
@@ -220,7 +310,7 @@ void wxHeaderCtrl::DoInsertItem(unsigned int idx, int order)
 
     if ( col.GetAlignment() != wxALIGN_NOT )
     {
-        hdi.mask |= HDI_FORMAT;
+        hdi.mask |= HDI_FORMAT | HDF_LEFT;
         switch ( col.GetAlignment() )
         {
             case wxALIGN_LEFT:
@@ -247,44 +337,133 @@ void wxHeaderCtrl::DoInsertItem(unsigned int idx, int order)
         hdi.fmt |= col.IsSortOrderAscending() ? HDF_SORTUP : HDF_SORTDOWN;
     }
 
-    if ( col.GetWidth() != wxCOL_WIDTH_DEFAULT || col.IsHidden() )
+    if ( col.GetWidth() != wxCOL_WIDTH_DEFAULT )
     {
         hdi.mask |= HDI_WIDTH;
-        hdi.cxy = col.IsHidden() ? 0 : col.GetWidth();
+        hdi.cxy = col.GetWidth();
     }
 
-    if ( order != -1 )
-    {
-        hdi.mask |= HDI_ORDER;
-        hdi.iOrder = order;
-    }
+    hdi.mask |= HDI_ORDER;
+    hdi.iOrder = MSWToNativeOrder(m_colIndices.Index(idx));
 
-    if ( ::SendMessage(GetHwnd(), HDM_INSERTITEM, idx, (LPARAM)&hdi) == -1 )
+    if ( ::SendMessage(GetHwnd(), HDM_INSERTITEM,
+                       MSWToNativeIdx(idx), (LPARAM)&hdi) == -1 )
     {
-        wxLogLastError(_T("Header_InsertItem()"));
+        wxLogLastError(wxT("Header_InsertItem()"));
     }
 }
 
 void wxHeaderCtrl::DoSetColumnsOrder(const wxArrayInt& order)
 {
-    if ( !Header_SetOrderArray(GetHwnd(), order.size(), &order[0]) )
+    wxArrayInt orderShown;
+    orderShown.reserve(m_numColumns);
+
+    for ( unsigned n = 0; n < m_numColumns; n++ )
     {
-        wxLogLastError(_T("Header_GetOrderArray"));
+        const int idx = order[n];
+        if ( GetColumn(idx).IsShown() )
+            orderShown.push_back(MSWToNativeIdx(idx));
     }
+
+    if ( !Header_SetOrderArray(GetHwnd(), orderShown.size(), &orderShown[0]) )
+    {
+        wxLogLastError(wxT("Header_GetOrderArray"));
+    }
+
+    m_colIndices = order;
 }
 
 wxArrayInt wxHeaderCtrl::DoGetColumnsOrder() const
 {
-    const unsigned count = GetColumnCount();
-    wxArrayInt order(count);
-    if ( !Header_GetOrderArray(GetHwnd(), count, &order[0]) )
+    // we don't use Header_GetOrderArray() here because it doesn't return
+    // information about the hidden columns, instead we just save the columns
+    // order array in DoSetColumnsOrder() and update it when they're reordered
+    return m_colIndices;
+}
+
+// ----------------------------------------------------------------------------
+// wxHeaderCtrl indexes and positions translation
+// ----------------------------------------------------------------------------
+
+int wxHeaderCtrl::MSWToNativeIdx(int idx)
+{
+    // don't check for GetColumn(idx).IsShown() as it could have just became
+    // false and we may be called from DoUpdate() to delete the old column
+    wxASSERT_MSG( !m_isHidden[idx],
+                  "column must be visible to have an "
+                  "index in the native control" );
+
+    int item = idx;
+    for ( int i = 0; i < idx; i++ )
+    {
+        if ( GetColumn(i).IsHidden() )
+            item--; // one less column the native control knows about
+    }
+
+    wxASSERT_MSG( item >= 0 && item <= GetShownColumnsCount(), "logic error" );
+
+    return item;
+}
+
+int wxHeaderCtrl::MSWFromNativeIdx(int item)
+{
+    wxASSERT_MSG( item >= 0 && item < GetShownColumnsCount(),
+                  "column index out of range" );
+
+    // reverse the above function
+
+    unsigned idx = item;
+    for ( unsigned n = 0; n < m_numColumns; n++ )
+    {
+        if ( n > idx )
+            break;
+
+        if ( GetColumn(n).IsHidden() )
+            idx++;
+    }
+
+    wxASSERT_MSG( MSWToNativeIdx(idx) == item, "logic error" );
+
+    return idx;
+}
+
+int wxHeaderCtrl::MSWToNativeOrder(int pos)
+{
+    wxASSERT_MSG( pos >= 0 && static_cast<unsigned>(pos) < m_numColumns,
+                  "column position out of range" );
+
+    int order = pos;
+    for ( int n = 0; n < pos; n++ )
     {
-        wxLogLastError(_T("Header_GetOrderArray"));
+        if ( GetColumn(m_colIndices[n]).IsHidden() )
+            order--;
     }
 
+    wxASSERT_MSG( order >= 0 && order <= GetShownColumnsCount(), "logic error" );
+
     return order;
 }
 
+int wxHeaderCtrl::MSWFromNativeOrder(int order)
+{
+    wxASSERT_MSG( order >= 0 && order < GetShownColumnsCount(),
+                  "native column position out of range" );
+
+    unsigned pos = order;
+    for ( unsigned n = 0; n < m_numColumns; n++ )
+    {
+        if ( n > pos )
+            break;
+
+        if ( GetColumn(m_colIndices[n]).IsHidden() )
+            pos++;
+    }
+
+    wxASSERT_MSG( MSWToNativeOrder(pos) == order, "logic error" );
+
+    return pos;
+}
+
 // ----------------------------------------------------------------------------
 // wxHeaderCtrl events
 // ----------------------------------------------------------------------------
@@ -322,12 +501,22 @@ bool wxHeaderCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
     NMHEADER * const nmhdr = (NMHEADER *)lParam;
 
     wxEventType evtType = wxEVT_NULL;
-    int idx = nmhdr->iItem;
     int width = 0;
     int order = -1;
-    bool cancelled = false;
     bool veto = false;
     const UINT code = nmhdr->hdr.code;
+
+    // we don't have the index for all events, e.g. not for NM_RELEASEDCAPTURE
+    // so only access for header control events (and yes, the direction of
+    // comparisons with FIRST/LAST is correct even if it seems inverted)
+    int idx = code <= HDN_FIRST && code > HDN_LAST ? nmhdr->iItem : -1;
+    if ( idx != -1 )
+    {
+        // we also get bogus HDN_BEGINDRAG with -1 index so don't call
+        // MSWFromNativeIdx() unconditionally for nmhdr->iItem
+        idx = MSWFromNativeIdx(idx);
+    }
+
     switch ( code )
     {
         // click events
@@ -347,7 +536,15 @@ bool wxHeaderCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
                 POINT pt;
                 idx = wxMSWGetColumnClicked(&nmhdr->hdr, &pt);
                 if ( idx != wxNOT_FOUND )
-                    evtType = GetClickEventType(code == NM_RDBLCLK, 1);
+                {
+                    idx = MSWFromNativeIdx(idx);
+
+                    // due to a bug in mingw32 headers NM_RDBLCLK is signed
+                    // there so we need a cast to avoid warnings about signed/
+                    // unsigned comparison
+                    evtType = GetClickEventType(
+                                code == static_cast<UINT>(NM_RDBLCLK), 1);
+                }
                 //else: ignore clicks outside any column
             }
             break;
@@ -364,7 +561,7 @@ bool wxHeaderCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
         // ASCII and Unicode versions of this message
         case HDN_BEGINTRACKA:
         case HDN_BEGINTRACKW:
-            // non-resizeable columns can't be resized no matter what, don't
+            // non-resizable columns can't be resized no matter what, don't
             // even generate any events for them
             if ( !GetColumn(idx).IsResizeable() )
             {
@@ -375,12 +572,6 @@ bool wxHeaderCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             evtType = wxEVT_COMMAND_HEADER_BEGIN_RESIZE;
             // fall through
 
-        case HDN_TRACKA:
-        case HDN_TRACKW:
-            if ( evtType == wxEVT_NULL )
-                evtType = wxEVT_COMMAND_HEADER_RESIZING;
-            // fall through
-
         case HDN_ENDTRACKA:
         case HDN_ENDTRACKW:
             width = nmhdr->pitem->cxy;
@@ -400,8 +591,20 @@ bool wxHeaderCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             if ( nmhdr->pitem && (nmhdr->pitem->mask & HDI_WIDTH) )
             {
                 // prevent the column from being shrunk beneath its min width
-                if ( nmhdr->pitem->cxy < GetColumn(idx).GetMinWidth() )
+                width = nmhdr->pitem->cxy;
+                if ( width < GetColumn(idx).GetMinWidth() )
+                {
+                    // don't generate any events and prevent the change from
+                    // happening
                     veto = true;
+                }
+                else // width is acceptable
+                {
+                    // generate the resizing event from here as we don't seem
+                    // to be getting HDN_TRACK events at all, at least with
+                    // comctl32.dll v6
+                    evtType = wxEVT_COMMAND_HEADER_RESIZING;
+                }
             }
             break;
 
@@ -411,7 +614,7 @@ bool wxHeaderCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 
         case HDN_BEGINDRAG:
             // Windows sometimes sends us events with invalid column indices
-            if ( idx == -1 )
+            if ( nmhdr->iItem == -1 )
                 break;
 
             // column must have the appropriate flag to be draggable
@@ -425,14 +628,21 @@ bool wxHeaderCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
             break;
 
         case HDN_ENDDRAG:
-            evtType = wxEVT_COMMAND_HEADER_END_REORDER;
-
             wxASSERT_MSG( nmhdr->pitem->mask & HDI_ORDER, "should have order" );
             order = nmhdr->pitem->iOrder;
+
+            // we also get messages with invalid order when column reordering
+            // is cancelled (e.g. by pressing Esc)
+            if ( order == -1 )
+                break;
+
+            order = MSWFromNativeOrder(order);
+
+            evtType = wxEVT_COMMAND_HEADER_END_REORDER;
             break;
 
         case NM_RELEASEDCAPTURE:
-            cancelled = true;
+            evtType = wxEVT_COMMAND_HEADER_DRAGGING_CANCELLED;
             break;
     }
 
@@ -446,17 +656,25 @@ bool wxHeaderCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
         event.SetWidth(width);
         if ( order != -1 )
             event.SetNewOrder(order);
-        if ( cancelled )
-            event.SetCancelled();
 
-        if ( GetEventHandler()->ProcessEvent(event) )
-        {
-            if ( event.IsAllowed() )
-                return true;
+        const bool processed = GetEventHandler()->ProcessEvent(event);
 
-            // we need to veto the default handling of this message, don't
-            // return to execute the code in the "if veto" branch below
+        if ( processed && !event.IsAllowed() )
             veto = true;
+
+        if ( !veto )
+        {
+            // special post-processing for HDN_ENDDRAG: we need to update the
+            // internal column indices array if this is allowed to go ahead as
+            // the native control is going to reorder its columns now
+            if ( evtType == wxEVT_COMMAND_HEADER_END_REORDER )
+                MoveColumnInOrderArray(m_colIndices, idx, order);
+
+            if ( processed )
+            {
+                // skip default processing below
+                return true;
+            }
         }
     }
 
@@ -474,3 +692,5 @@ bool wxHeaderCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 }
 
 #endif // wxHAS_GENERIC_HEADERCTRL
+
+#endif // wxUSE_HEADERCTRL