]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/headerctrlcmn.cpp
same as r57054 in 2.8
[wxWidgets.git] / src / common / headerctrlcmn.cpp
index fa9766ab815e2b9a370c82b70b4b6b2136638a92..fe43fe19cd8cb0600210f37e0c21392e80503547 100644 (file)
@@ -24,6 +24,7 @@
 #endif
 
 #ifndef WX_PRECOMP
+    #include "wx/menu.h"
 #endif // WX_PRECOMP
 
 #include "wx/headerctrl.h"
@@ -47,6 +48,7 @@ extern WXDLLIMPEXP_DATA_CORE(const char) wxHeaderCtrlNameStr[] = "wxHeaderCtrl";
 
 BEGIN_EVENT_TABLE(wxHeaderCtrlBase, wxControl)
     EVT_HEADER_SEPARATOR_DCLICK(wxID_ANY, wxHeaderCtrlBase::OnSeparatorDClick)
+    EVT_HEADER_RIGHT_CLICK(wxID_ANY, wxHeaderCtrlBase::OnRClick)
 END_EVENT_TABLE()
 
 void wxHeaderCtrlBase::ScrollWindow(int dx,
@@ -64,12 +66,26 @@ void wxHeaderCtrlBase::ScrollWindow(int dx,
     DoScrollHorz(dx);
 }
 
+void wxHeaderCtrlBase::SetColumnCount(unsigned int count)
+{
+    if ( count != GetColumnCount() )
+        OnColumnCountChanging(count);
+
+    // still call DoSetCount() even if the count didn't really change in order
+    // to update all the columns
+    DoSetCount(count);
+}
+
+// ----------------------------------------------------------------------------
+// wxHeaderCtrlBase event handling
+// ----------------------------------------------------------------------------
+
 void wxHeaderCtrlBase::OnSeparatorDClick(wxHeaderCtrlEvent& event)
 {
     const unsigned col = event.GetColumn();
 
     int w = wxWindowBase::GetTextExtent(GetColumn(col).GetTitle()).x;
-    w += 2*GetCharWidth(); // add some arbitrary margins around text
+    w += 4*GetCharWidth(); // add some arbitrary margins around text
 
     if ( !UpdateColumnWidthToFit(col, w) )
         event.Skip();
@@ -77,6 +93,200 @@ void wxHeaderCtrlBase::OnSeparatorDClick(wxHeaderCtrlEvent& event)
         UpdateColumn(col);
 }
 
+void wxHeaderCtrlBase::OnRClick(wxHeaderCtrlEvent& event)
+{
+    if ( !HasFlag(wxHD_ALLOW_HIDE) )
+    {
+        event.Skip();
+        return;
+    }
+
+    ShowColumnsMenu(ScreenToClient(wxGetMousePosition()));
+}
+
+// ----------------------------------------------------------------------------
+// wxHeaderCtrlBase column reordering
+// ----------------------------------------------------------------------------
+
+void wxHeaderCtrlBase::SetColumnsOrder(const wxArrayInt& order)
+{
+    const unsigned count = GetColumnCount();
+    wxCHECK_RET( order.size() == count, "wrong number of columns" );
+
+    // check the array validity
+    wxArrayInt seen(count, 0);
+    for ( unsigned n = 0; n < count; n++ )
+    {
+        const unsigned idx = order[n];
+        wxCHECK_RET( idx < count, "invalid column index" );
+        wxCHECK_RET( !seen[idx], "duplicate column index" );
+
+        seen[idx] = 1;
+    }
+
+    DoSetColumnsOrder(order);
+
+    // TODO-RTL: do we need to reverse the array?
+}
+
+void wxHeaderCtrlBase::ResetColumnsOrder()
+{
+    const unsigned count = GetColumnCount();
+    wxArrayInt order(count);
+    for ( unsigned n = 0; n < count; n++ )
+        order[n] = n;
+
+    DoSetColumnsOrder(order);
+}
+
+wxArrayInt wxHeaderCtrlBase::GetColumnsOrder() const
+{
+    const wxArrayInt order = DoGetColumnsOrder();
+
+    wxASSERT_MSG( order.size() == GetColumnCount(), "invalid order array" );
+
+    return order;
+}
+
+unsigned int wxHeaderCtrlBase::GetColumnAt(unsigned int pos) const
+{
+    wxCHECK_MSG( pos < GetColumnCount(), wxNO_COLUMN, "invalid position" );
+
+    return GetColumnsOrder()[pos];
+}
+
+unsigned int wxHeaderCtrlBase::GetColumnPos(unsigned int idx) const
+{
+    const unsigned count = GetColumnCount();
+
+    wxCHECK_MSG( idx < count, wxNO_COLUMN, "invalid index" );
+
+    const wxArrayInt order = GetColumnsOrder();
+    for ( unsigned n = 0; n < count; n++ )
+    {
+        if ( (unsigned)order[n] == idx )
+            return n;
+    }
+
+    wxFAIL_MSG( "column unexpectedly not displayed at all" );
+
+    return wxNO_COLUMN;
+}
+
+/* static */
+void wxHeaderCtrlBase::MoveColumnInOrderArray(wxArrayInt& order,
+                                              unsigned int idx,
+                                              unsigned int pos)
+{
+    const unsigned count = order.size();
+
+    wxArrayInt orderNew;
+    orderNew.reserve(count);
+    for ( unsigned n = 0; ; n++ )
+    {
+        // NB: order of checks is important for this to work when the new
+        //     column position is the same as the old one
+
+        // insert the column at its new position
+        if ( orderNew.size() == pos )
+            orderNew.push_back(idx);
+
+        if ( n == count )
+            break;
+
+        // delete the column from its old position
+        const unsigned idxOld = order[n];
+        if ( idxOld == idx )
+            continue;
+
+        orderNew.push_back(idxOld);
+    }
+
+    order.swap(orderNew);
+}
+
+void
+wxHeaderCtrlBase::DoResizeColumnIndices(wxArrayInt& colIndices, unsigned int count)
+{
+    // update the column indices array if necessary
+    const unsigned countOld = colIndices.size();
+    if ( count > countOld )
+    {
+        // all new columns have default positions equal to their indices
+        for ( unsigned n = countOld; n < count; n++ )
+            colIndices.push_back(n);
+    }
+    else if ( count < countOld )
+    {
+        // filter out all the positions which are invalid now while keeping the
+        // order of the remaining ones
+        wxArrayInt colIndicesNew;
+        colIndicesNew.reserve(count);
+        for ( unsigned n = 0; n < countOld; n++ )
+        {
+            const unsigned idx = colIndices[n];
+            if ( idx < count )
+                colIndicesNew.push_back(idx);
+        }
+
+        colIndices.swap(colIndicesNew);
+    }
+    //else: count didn't really change, nothing to do
+
+    wxASSERT_MSG( colIndices.size() == count, "logic error" );
+}
+
+// ----------------------------------------------------------------------------
+// wxHeaderCtrl extra UI
+// ----------------------------------------------------------------------------
+
+bool wxHeaderCtrlBase::ShowColumnsMenu(const wxPoint& pt, const wxString& title)
+{
+    // construct the menu with the entries for all columns
+    wxMenu menu;
+    if ( !title.empty() )
+        menu.SetTitle(title);
+
+    const unsigned count = GetColumnCount();
+    for ( unsigned n = 0; n < count; n++ )
+    {
+        const wxHeaderColumn& col = GetColumn(n);
+        menu.AppendCheckItem(n, col.GetTitle());
+        if ( col.IsShown() )
+            menu.Check(n, true);
+    }
+
+    // ... and an extra one to show the customization dialog if the user is
+    // allowed to reorder the columns too
+    if ( HasFlag(wxHD_ALLOW_REORDER) )
+    {
+        menu.AppendSeparator();
+        menu.Append(count, _("&Customize..."));
+    }
+
+    // do show the menu and get the user selection
+    const int rc = GetPopupMenuSelectionFromUser(menu, pt);
+    if ( rc == wxID_NONE )
+        return false;
+
+    if ( static_cast<unsigned>(rc) == count )
+    {
+        return ShowCustomizeDialog();
+    }
+    else // a column selected from the menu
+    {
+        UpdateColumnVisibility(rc, !GetColumn(rc).IsShown());
+    }
+
+    return true;
+}
+
+bool wxHeaderCtrlBase::ShowCustomizeDialog()
+{
+    // TODO
+    return false;
+}
+
 // ============================================================================
 // wxHeaderCtrlSimple implementation
 // ============================================================================
@@ -86,7 +296,7 @@ void wxHeaderCtrlSimple::Init()
     m_sortKey = wxNO_COLUMN;
 }
 
-wxHeaderColumnBase& wxHeaderCtrlSimple::GetColumn(unsigned int idx)
+wxHeaderColumn& wxHeaderCtrlSimple::GetColumn(unsigned int idx)
 {
     return m_cols[idx];
 }
@@ -149,6 +359,18 @@ void wxHeaderCtrlSimple::RemoveSortIndicator()
     }
 }
 
+bool
+wxHeaderCtrlSimple::UpdateColumnWidthToFit(unsigned int idx, int widthTitle)
+{
+    const int widthContents = GetBestFittingWidth(idx);
+    if ( widthContents == -1 )
+        return false;
+
+    m_cols[idx].SetWidth(wxMax(widthContents, widthTitle));
+
+    return true;
+}
+
 // ============================================================================
 // wxHeaderCtrlEvent implementation
 // ============================================================================
@@ -164,3 +386,12 @@ const wxEventType wxEVT_COMMAND_HEADER_RIGHT_DCLICK = wxNewEventType();
 const wxEventType wxEVT_COMMAND_HEADER_MIDDLE_DCLICK = wxNewEventType();
 
 const wxEventType wxEVT_COMMAND_HEADER_SEPARATOR_DCLICK = wxNewEventType();
+
+const wxEventType wxEVT_COMMAND_HEADER_BEGIN_RESIZE = wxNewEventType();
+const wxEventType wxEVT_COMMAND_HEADER_RESIZING = wxNewEventType();
+const wxEventType wxEVT_COMMAND_HEADER_END_RESIZE = wxNewEventType();
+
+const wxEventType wxEVT_COMMAND_HEADER_BEGIN_REORDER = wxNewEventType();
+const wxEventType wxEVT_COMMAND_HEADER_END_REORDER = wxNewEventType();
+
+const wxEventType wxEVT_COMMAND_HEADER_DRAGGING_CANCELLED = wxNewEventType();