Update all controls using in-place editors to handle Escape/Return correctly.

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

diff --git a/src/common/headerctrlcmn.cpp b/src/common/headerctrlcmn.cpp
index 1d8f2670d340418689effc3d233f84a5a4e33411..be858a6848d6c98cc82cc782f1171a97579537b0 100644 (file)
--- a/src/common/headerctrlcmn.cpp
+++ b/src/common/headerctrlcmn.cpp
@@ -23,20 +23,49 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_HEADERCTRL
+

 #ifndef WX_PRECOMP
     #include "wx/menu.h"
 #endif // WX_PRECOMP
 
 #include "wx/headerctrl.h"
 #ifndef WX_PRECOMP
     #include "wx/menu.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);
+
+// ----------------------------------------------------------------------------
+// wxHeaderColumnsRearrangeDialog: dialog for customizing our columns
+// ----------------------------------------------------------------------------
+
+#if wxUSE_REARRANGECTRL
+
+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
+          )
+    {
+    }
+};

 
 

-const unsigned int wxNO_COLUMN = static_cast<unsigned>(-1);
+#endif // wxUSE_REARRANGECTRL

 
 } // anonymous namespace
 
 
 } // anonymous namespace
 


@@ -48,6 +77,9 @@ 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)

+#if wxUSE_MENUS
+    EVT_HEADER_RIGHT_CLICK(wxID_ANY, wxHeaderCtrlBase::OnRClick)
+#endif // wxUSE_MENUS

 END_EVENT_TABLE()
 
 void wxHeaderCtrlBase::ScrollWindow(int dx,
 END_EVENT_TABLE()
 
 void wxHeaderCtrlBase::ScrollWindow(int dx,


@@ -67,11 +99,11 @@ void wxHeaderCtrlBase::ScrollWindow(int dx,
 
 void wxHeaderCtrlBase::SetColumnCount(unsigned int count)
 {
 
 void wxHeaderCtrlBase::SetColumnCount(unsigned int count)
 {

-    if ( count == GetColumnCount() )
-        return;
-
-    OnColumnCountChanging(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);
 }
 
     DoSetCount(count);
 }
 


@@ -82,8 +114,15 @@ void wxHeaderCtrlBase::SetColumnCount(unsigned int count)
 void wxHeaderCtrlBase::OnSeparatorDClick(wxHeaderCtrlEvent& event)
 {
     const unsigned col = event.GetColumn();
 void wxHeaderCtrlBase::OnSeparatorDClick(wxHeaderCtrlEvent& event)
 {
     const unsigned col = event.GetColumn();

+    const wxHeaderColumn& column = GetColumn(col);

 
 

-    int w = wxWindowBase::GetTextExtent(GetColumn(col).GetTitle()).x;
+    if ( !column.IsResizeable() )
+    {
+        event.Skip();
+        return;
+    }
+
+    int w = wxWindowBase::GetTextExtent(column.GetTitle()).x;

     w += 4*GetCharWidth(); // add some arbitrary margins around text
 
     if ( !UpdateColumnWidthToFit(col, w) )
     w += 4*GetCharWidth(); // add some arbitrary margins around text
 
     if ( !UpdateColumnWidthToFit(col, w) )


@@ -92,6 +131,21 @@ void wxHeaderCtrlBase::OnSeparatorDClick(wxHeaderCtrlEvent& event)
         UpdateColumn(col);
 }
 
         UpdateColumn(col);
 }
 

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

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


@@ -219,10 +273,7 @@ wxHeaderCtrlBase::DoResizeColumnIndices(wxArrayInt& colIndices, unsigned int cou
 
         colIndices.swap(colIndicesNew);
     }
 
         colIndices.swap(colIndicesNew);
     }

-    else // count didn't really change, we shouldn't even be called
-    {
-        wxFAIL_MSG( "useless call to DoResizeColumnIndices()" );
-    }
+    //else: count didn't really change, nothing to do

 
     wxASSERT_MSG( colIndices.size() == count, "logic error" );
 }
 
     wxASSERT_MSG( colIndices.size() == count, "logic error" );
 }


@@ -231,23 +282,112 @@ wxHeaderCtrlBase::DoResizeColumnIndices(wxArrayInt& colIndices, unsigned int cou
 // wxHeaderCtrl extra UI
 // ----------------------------------------------------------------------------
 
 // wxHeaderCtrl extra UI
 // ----------------------------------------------------------------------------
 

-int wxHeaderCtrlBase::ShowColumnsMenu(const wxString& title)
+#if wxUSE_MENUS
+
+void wxHeaderCtrlBase::AddColumnsItems(wxMenu& menu, int idColumnsBase)

 {
 {

+    const unsigned count = GetColumnCount();
+    for ( unsigned n = 0; n < count; n++ )
+    {
+        const wxHeaderColumn& col = GetColumn(n);
+        menu.AppendCheckItem(idColumnsBase + n, col.GetTitle());
+        if ( col.IsShown() )
+            menu.Check(n, true);
+    }
+}
+
+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);
 
     wxMenu menu;
     if ( !title.empty() )
         menu.SetTitle(title);
 

+    AddColumnsItems(menu);
+
+    // ... and an extra one to show the customization dialog if the user is
+    // allowed to reorder the columns too
+    const unsigned count = GetColumnCount();
+    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;
+}
+
+#endif // wxUSE_MENUS
+
+bool wxHeaderCtrlBase::ShowCustomizeDialog()
+{
+#if wxUSE_REARRANGECTRL
+    // prepare the data for showing the dialog
+    wxArrayInt order = GetColumnsOrder();
+

     const unsigned count = GetColumnCount();
     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++ )
     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++ )

     {
     {

-        const wxHeaderColumn& col = GetColumn(n);
-        menu.AppendCheckItem(n, col.GetTitle());
-        if ( col.IsShown() )
-            menu.Check(n, true);
+        int& idx = order[pos];
+        if ( GetColumn(idx).IsHidden() )
+        {
+            // indicate that this one is hidden
+            idx = ~idx;
+        }

     }
 
     }
 

-    return GetPopupMenuSelectionFromUser(menu,
-                                         ScreenToClient(wxGetMousePosition()));
+    // do show it
+    wxHeaderColumnsRearrangeDialog dlg(this, order, titles);
+    if ( dlg.ShowModal() == wxID_OK )
+    {
+        // 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;
+    }
+#endif // wxUSE_REARRANGECTRL
+
+    return false;

 }
 
 // ============================================================================
 }
 
 // ============================================================================


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

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

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


@@ -303,7 +443,7 @@ void wxHeaderCtrlSimple::DoShowSortIndicator(unsigned int idx, bool ascending)
 {
     RemoveSortIndicator();
 
 {
     RemoveSortIndicator();
 

-    m_cols[idx].SetAsSortKey(ascending);
+    m_cols[idx].SetSortOrder(ascending);

     m_sortKey = idx;
 
     UpdateColumn(idx);
     m_sortKey = idx;
 
     UpdateColumn(idx);


@@ -340,21 +480,23 @@ wxHeaderCtrlSimple::UpdateColumnWidthToFit(unsigned int idx, int widthTitle)
 
 IMPLEMENT_DYNAMIC_CLASS(wxHeaderCtrlEvent, wxNotifyEvent)
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxHeaderCtrlEvent, wxNotifyEvent)
 

-const wxEventType wxEVT_COMMAND_HEADER_CLICK = wxNewEventType();
-const wxEventType wxEVT_COMMAND_HEADER_RIGHT_CLICK = wxNewEventType();
-const wxEventType wxEVT_COMMAND_HEADER_MIDDLE_CLICK = wxNewEventType();
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_CLICK, wxHeaderCtrlEvent);
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_RIGHT_CLICK, wxHeaderCtrlEvent);
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_MIDDLE_CLICK, wxHeaderCtrlEvent);
+
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_DCLICK, wxHeaderCtrlEvent);
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_RIGHT_DCLICK, wxHeaderCtrlEvent);
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_MIDDLE_DCLICK, wxHeaderCtrlEvent);

 
 

-const wxEventType wxEVT_COMMAND_HEADER_DCLICK = wxNewEventType();
-const wxEventType wxEVT_COMMAND_HEADER_RIGHT_DCLICK = wxNewEventType();
-const wxEventType wxEVT_COMMAND_HEADER_MIDDLE_DCLICK = wxNewEventType();
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_SEPARATOR_DCLICK, wxHeaderCtrlEvent);

 
 

-const wxEventType wxEVT_COMMAND_HEADER_SEPARATOR_DCLICK = wxNewEventType();
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_BEGIN_RESIZE, wxHeaderCtrlEvent);
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_RESIZING, wxHeaderCtrlEvent);
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_END_RESIZE, wxHeaderCtrlEvent);

 
 

-const wxEventType wxEVT_COMMAND_HEADER_BEGIN_RESIZE = wxNewEventType();
-const wxEventType wxEVT_COMMAND_HEADER_RESIZING = wxNewEventType();
-const wxEventType wxEVT_COMMAND_HEADER_END_RESIZE = wxNewEventType();
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_BEGIN_REORDER, wxHeaderCtrlEvent);
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_END_REORDER, wxHeaderCtrlEvent);

 
 

-const wxEventType wxEVT_COMMAND_HEADER_BEGIN_REORDER = wxNewEventType();
-const wxEventType wxEVT_COMMAND_HEADER_END_REORDER = wxNewEventType();
+wxDEFINE_EVENT( wxEVT_COMMAND_HEADER_DRAGGING_CANCELLED, wxHeaderCtrlEvent);

 
 

-const wxEventType wxEVT_COMMAND_HEADER_DRAGGING_CANCELLED = wxNewEventType();
+#endif // wxUSE_HEADERCTRL