handle correctly never/always shown scrollbars in GetClientSize()

[wxWidgets.git] / src / common / headerctrlcmn.cpp

diff --git a/src/common/headerctrlcmn.cpp b/src/common/headerctrlcmn.cpp
index 02a18b889e2141d779ab3b7ce4ac86e2a7a4705f..bc5fd71f60afc32b1da967243db4d4fd75fce4dc 100644 (file)
--- a/src/common/headerctrlcmn.cpp
+++ b/src/common/headerctrlcmn.cpp
@@ -24,19 +24,43 @@
 #endif
 
 #ifndef WX_PRECOMP
 #endif
 
 #ifndef WX_PRECOMP

+    #include "wx/menu.h"

 #endif // WX_PRECOMP
 
 #include "wx/headerctrl.h"
 #endif // WX_PRECOMP
 
 #include "wx/headerctrl.h"

+#include "wx/rearrangectrl.h"
+
+namespace
+{

 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 

-namespace
-{
-

 const unsigned int wxNO_COLUMN = static_cast<unsigned>(-1);
 
 const unsigned int wxNO_COLUMN = static_cast<unsigned>(-1);
 

+// ----------------------------------------------------------------------------
+// wxHeaderColumnsRearrangeDialog: dialog for customizing our columns
+// ----------------------------------------------------------------------------
+
+class wxHeaderColumnsRearrangeDialog : public wxRearrangeDialog
+{
+public:
+    wxHeaderColumnsRearrangeDialog(wxWindow *parent,
+                                   const wxArrayInt& order,
+                                   const wxArrayString& items)
+        : wxRearrangeDialog
+          (
+            parent,
+            _("Please select the columns to show and define their order:"),
+            _("Customize Columns"),
+            order,
+            items
+          )
+    {
+    }
+};
+

 } // anonymous namespace
 
 // ============================================================================
 } // anonymous namespace
 
 // ============================================================================


@@ -47,6 +71,7 @@ extern WXDLLIMPEXP_DATA_CORE(const char) wxHeaderCtrlNameStr[] = "wxHeaderCtrl";
 
 BEGIN_EVENT_TABLE(wxHeaderCtrlBase, wxControl)
     EVT_HEADER_SEPARATOR_DCLICK(wxID_ANY, wxHeaderCtrlBase::OnSeparatorDClick)
 
 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,
 END_EVENT_TABLE()
 
 void wxHeaderCtrlBase::ScrollWindow(int dx,


@@ -64,6 +89,16 @@ void wxHeaderCtrlBase::ScrollWindow(int dx,
     DoScrollHorz(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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxHeaderCtrlBase event handling
 // ----------------------------------------------------------------------------


@@ -73,7 +108,7 @@ void wxHeaderCtrlBase::OnSeparatorDClick(wxHeaderCtrlEvent& event)
     const unsigned col = event.GetColumn();
 
     int w = wxWindowBase::GetTextExtent(GetColumn(col).GetTitle()).x;
     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();
 
     if ( !UpdateColumnWidthToFit(col, w) )
         event.Skip();


@@ -81,6 +116,17 @@ void wxHeaderCtrlBase::OnSeparatorDClick(wxHeaderCtrlEvent& event)
         UpdateColumn(col);
 }
 
         UpdateColumn(col);
 }
 

+void wxHeaderCtrlBase::OnRClick(wxHeaderCtrlEvent& event)
+{
+    if ( !HasFlag(wxHD_ALLOW_HIDE) )
+    {
+        event.Skip();
+        return;
+    }
+
+    ShowColumnsMenu(ScreenToClient(wxGetMousePosition()));
+}
+

 // ----------------------------------------------------------------------------
 // wxHeaderCtrlBase column reordering
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxHeaderCtrlBase column reordering
 // ----------------------------------------------------------------------------


@@ -106,6 +152,16 @@ void wxHeaderCtrlBase::SetColumnsOrder(const wxArrayInt& order)
     // TODO-RTL: do we need to reverse the array?
 }
 
     // 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();
 wxArrayInt wxHeaderCtrlBase::GetColumnsOrder() const
 {
     const wxArrayInt order = DoGetColumnsOrder();


@@ -140,6 +196,167 @@ unsigned int wxHeaderCtrlBase::GetColumnPos(unsigned int idx) const
     return wxNO_COLUMN;
 }
 
     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()
+{
+    // prepare the data for showing the dialog
+    wxArrayInt order = GetColumnsOrder();
+
+    const unsigned count = GetColumnCount();
+
+    // notice that titles are always in the index order, they will be shown
+    // rearranged according to the display order in the dialog
+    wxArrayString titles;
+    titles.reserve(count);
+    for ( unsigned n = 0; n < count; n++ )
+        titles.push_back(GetColumn(n).GetTitle());
+
+    // this loop is however over positions and not indices
+    unsigned pos;
+    for ( pos = 0; pos < count; pos++ )
+    {
+        int& idx = order[pos];
+        if ( GetColumn(idx).IsHidden() )
+        {
+            // indicate that this one is hidden
+            idx = ~idx;
+        }
+    }
+
+    // do show it
+    wxHeaderColumnsRearrangeDialog dlg(this, order, titles);
+    if ( dlg.ShowModal() != wxID_OK )
+        return false;
+
+    // and apply the changes
+    order = dlg.GetOrder();
+    for ( pos = 0; pos < count; pos++ )
+    {
+        int& idx = order[pos];
+        const bool show = idx >= 0;
+        if ( !show )
+        {
+            // make all indices positive for passing them to SetColumnsOrder()
+            idx = ~idx;
+        }
+
+        if ( show != GetColumn(idx).IsShown() )
+            UpdateColumnVisibility(idx, show);
+    }
+
+    UpdateColumnsOrder(order);
+    SetColumnsOrder(order);
+
+    return true;
+}
+

 // ============================================================================
 // wxHeaderCtrlSimple implementation
 // ============================================================================
 // ============================================================================
 // wxHeaderCtrlSimple implementation
 // ============================================================================


@@ -149,7 +366,7 @@ void wxHeaderCtrlSimple::Init()
     m_sortKey = wxNO_COLUMN;
 }
 
     m_sortKey = wxNO_COLUMN;
 }
 

-wxHeaderColumnBase& wxHeaderCtrlSimple::GetColumn(unsigned int idx)
+const wxHeaderColumn& wxHeaderCtrlSimple::GetColumn(unsigned int idx) const

 {
     return m_cols[idx];
 }
 {
     return m_cols[idx];
 }


@@ -220,7 +437,6 @@ wxHeaderCtrlSimple::UpdateColumnWidthToFit(unsigned int idx, int widthTitle)
         return false;
 
     m_cols[idx].SetWidth(wxMax(widthContents, widthTitle));
         return false;
 
     m_cols[idx].SetWidth(wxMax(widthContents, widthTitle));

-    UpdateColumn(idx);

 
     return true;
 }
 
     return true;
 }


@@ -247,3 +463,5 @@ 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_BEGIN_REORDER = wxNewEventType();
 const wxEventType wxEVT_COMMAND_HEADER_END_REORDER = wxNewEventType();

+
+const wxEventType wxEVT_COMMAND_HEADER_DRAGGING_CANCELLED = wxNewEventType();