handle actions of the columns popup menu in wxHeaderCtrl itself (but the derived...

[wxWidgets.git] / include / wx / headerctrl.h

diff --git a/include/wx/headerctrl.h b/include/wx/headerctrl.h
index 322ac6134d129d275f08a8479db1bea9c32f026c..e404f166dbd48b2b19cfc4c0d4d1aed04984656a 100644 (file)
--- a/include/wx/headerctrl.h
+++ b/include/wx/headerctrl.h
@@ -30,10 +30,14 @@ class WXDLLIMPEXP_FWD_CORE wxHeaderCtrlEvent;
 enum
 {
     // allow column drag and drop
 enum
 {
     // allow column drag and drop

-    wxHD_DRAGDROP = 0x0001,
+    wxHD_ALLOW_REORDER = 0x0001,
+
+    // allow hiding (and showing back) the columns using the menu shown by
+    // right clicking the header
+    wxHD_ALLOW_HIDE = 0x0002,

 
     // style used by default when creating the control
 
     // style used by default when creating the control

-    wxHD_DEFAULT_STYLE = wxHD_DRAGDROP
+    wxHD_DEFAULT_STYLE = wxHD_ALLOW_REORDER

 };
 
 extern WXDLLIMPEXP_DATA_CORE(const char) wxHeaderCtrlNameStr[];
 };
 
 extern WXDLLIMPEXP_DATA_CORE(const char) wxHeaderCtrlNameStr[];


@@ -70,7 +74,7 @@ public:
     // set the number of columns in the control
     //
     // this also calls UpdateColumn() for all columns
     // set the number of columns in the control
     //
     // this also calls UpdateColumn() for all columns

-    void SetColumnCount(unsigned int count) { DoSetCount(count); }
+    void SetColumnCount(unsigned int count);

 
     // return the number of columns in the control as set by SetColumnCount()
     unsigned int GetColumnCount() const { return DoGetCount(); }
 
     // return the number of columns in the control as set by SetColumnCount()
     unsigned int GetColumnCount() const { return DoGetCount(); }


@@ -86,6 +90,10 @@ public:
         DoUpdate(idx);
     }
 
         DoUpdate(idx);
     }
 

+
+    // columns order
+    // -------------
+

     // set the columns order: the array defines the column index which appears
     // the given position, it must have GetColumnCount() elements and contain
     // all indices exactly once
     // set the columns order: the array defines the column index which appears
     // the given position, it must have GetColumnCount() elements and contain
     // all indices exactly once


@@ -98,6 +106,39 @@ public:
     // get the position at which this column is currently displayed
     unsigned int GetColumnPos(unsigned int idx) const;
 
     // get the position at which this column is currently displayed
     unsigned int GetColumnPos(unsigned int idx) const;
 

+    // reset the columns order to the natural one
+    void ResetColumnsOrder();
+
+    // helper function used by the generic version of this control and also
+    // wxGrid: reshuffles the array of column indices indexed by positions
+    // (i.e. using the same convention as for SetColumnsOrder()) so that the
+    // column with the given index is found at the specified position
+    static void MoveColumnInOrderArray(wxArrayInt& order,
+                                       unsigned int idx,
+                                       unsigned int pos);
+
+
+    // UI helpers
+    // ----------
+
+    // show the popup menu containing all columns with check marks for the ones
+    // which are currently shown and return true if something was done using it
+    // (in this case UpdateColumnVisibility() will have been called) or false
+    // if the menu was cancelled
+    //
+    // this is called from the default right click handler for the controls
+    // with wxHD_ALLOW_HIDE style
+    bool ShowColumnsMenu(const wxPoint& pt, const wxString& title = wxString());
+
+    // show the columns customization dialog and return true if something was
+    // changed using it (in which case UpdateColumnVisibility() and/or
+    // UpdateColumnWidth() will have been called)
+    //
+    // this is called by the control itself from ShowColumnsMenu() (which in
+    // turn is only called by the control if wxHD_ALLOW_HIDE style was
+    // specified) and if the control has wxHD_ALLOW_REORDER style as well
+    bool ShowCustomizeDialog();
+

 
     // implementation only from now on
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------


@@ -113,7 +154,7 @@ public:
 protected:
     // this method must be implemented by the derived classes to return the
     // information for the given column
 protected:
     // this method must be implemented by the derived classes to return the
     // information for the given column

-    virtual wxHeaderColumnBase& GetColumn(unsigned int idx) = 0;
+    virtual wxHeaderColumn& GetColumn(unsigned int idx) = 0;

 
     // this method is called from the default EVT_HEADER_SEPARATOR_DCLICK
     // handler to update the fitting column width of the given column, it
 
     // this method is called from the default EVT_HEADER_SEPARATOR_DCLICK
     // handler to update the fitting column width of the given column, it


@@ -124,6 +165,25 @@ protected:
         return false;
     }
 
         return false;
     }
 

+    // this method is called from ShowColumnsMenu() and must be overridden to
+    // update the internal column visibility (there is no need to call
+    // UpdateColumn() from here, this will be done internally)
+    virtual void UpdateColumnVisibility(unsigned int WXUNUSED(idx),
+                                        bool WXUNUSED(show))
+    {
+        wxFAIL_MSG( "must be overridden if called" );
+    }
+
+    // this method can be overridden in the derived classes to do something
+    // (e.g. update/resize some internal data structures) before the number of
+    // columns in the control changes
+    virtual void OnColumnCountChanging(unsigned int WXUNUSED(count)) { }
+
+
+    // helper function for the derived classes: update the array of column
+    // indices after the number of columns changed
+    void DoResizeColumnIndices(wxArrayInt& colIndices, unsigned int count);
+

 private:
     // methods implementing our public API and defined in platform-specific
     // implementations
 private:
     // methods implementing our public API and defined in platform-specific
     // implementations


@@ -141,6 +201,7 @@ private:
 
     // event handlers
     void OnSeparatorDClick(wxHeaderCtrlEvent& event);
 
     // event handlers
     void OnSeparatorDClick(wxHeaderCtrlEvent& event);

+    void OnRClick(wxHeaderCtrlEvent& event);

 
     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };


@@ -241,7 +302,7 @@ public:
 
 protected:
     // implement/override base class methods
 
 protected:
     // implement/override base class methods

-    virtual wxHeaderColumnBase& GetColumn(unsigned int idx);
+    virtual wxHeaderColumn& GetColumn(unsigned int idx);

     virtual bool UpdateColumnWidthToFit(unsigned int idx, int widthTitle);
 
     // and define another one to be overridden in the derived classes: it
     virtual bool UpdateColumnWidthToFit(unsigned int idx, int widthTitle);
 
     // and define another one to be overridden in the derived classes: it


@@ -288,8 +349,7 @@ public:
         : wxNotifyEvent(commandType, winid),
           m_col(-1),
           m_width(0),
         : wxNotifyEvent(commandType, winid),
           m_col(-1),
           m_width(0),

-          m_order(static_cast<unsigned int>(-1)),
-          m_cancelled(false)
+          m_order(static_cast<unsigned int>(-1))

     {
     }
 
     {
     }
 


@@ -297,8 +357,7 @@ public:
         : wxNotifyEvent(event),
           m_col(event.m_col),
           m_width(event.m_width),
         : wxNotifyEvent(event),
           m_col(event.m_col),
           m_width(event.m_width),

-          m_order(event.m_order),
-          m_cancelled(event.m_cancelled)
+          m_order(event.m_order)

     {
     }
 
     {
     }
 


@@ -314,10 +373,6 @@ public:
     unsigned int GetNewOrder() const { return m_order; }
     void SetNewOrder(unsigned int order) { m_order = order; }
 
     unsigned int GetNewOrder() const { return m_order; }
     void SetNewOrder(unsigned int order) { m_order = order; }
 

-    // was the drag operation cancelled or did it complete successfully?
-    bool IsCancelled() const { return m_cancelled; }
-    void SetCancelled() { m_cancelled = true; }
-

     virtual wxEvent *Clone() const { return new wxHeaderCtrlEvent(*this); }
 
 protected:
     virtual wxEvent *Clone() const { return new wxHeaderCtrlEvent(*this); }
 
 protected:


@@ -330,9 +385,6 @@ protected:
     // the new column position for end reorder event
     unsigned int m_order;
 
     // the new column position for end reorder event
     unsigned int m_order;
 

-    // was the drag operation cancelled?
-    bool m_cancelled;
-

 private:
     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHeaderCtrlEvent)
 };
 private:
     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHeaderCtrlEvent)
 };


@@ -355,6 +407,8 @@ extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_END_RESIZE;
 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_BEGIN_REORDER;
 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_END_REORDER;
 
 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_BEGIN_REORDER;
 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_END_REORDER;
 

+extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_DRAGGING_CANCELLED;
+

 typedef void (wxEvtHandler::*wxHeaderCtrlEventFunction)(wxHeaderCtrlEvent&);
 
 #define wxHeaderCtrlEventHandler(func) \
 typedef void (wxEvtHandler::*wxHeaderCtrlEventFunction)(wxHeaderCtrlEvent&);
 
 #define wxHeaderCtrlEventHandler(func) \


@@ -381,4 +435,6 @@ typedef void (wxEvtHandler::*wxHeaderCtrlEventFunction)(wxHeaderCtrlEvent&);
 #define EVT_HEADER_BEGIN_REORDER(id, fn) wx__DECLARE_HEADER_EVT(BEGIN_REORDER, id, fn)
 #define EVT_HEADER_END_REORDER(id, fn) wx__DECLARE_HEADER_EVT(END_REORDER, id, fn)
 
 #define EVT_HEADER_BEGIN_REORDER(id, fn) wx__DECLARE_HEADER_EVT(BEGIN_REORDER, id, fn)
 #define EVT_HEADER_END_REORDER(id, fn) wx__DECLARE_HEADER_EVT(END_REORDER, id, fn)
 

+#define EVT_HEADER_DRAGGING_CANCELLED(id, fn) wx__DECLARE_HEADER_EVT(DRAGGING_CANCELLED, id, fn)
+

 #endif // _WX_HEADERCTRL_H_
 #endif // _WX_HEADERCTRL_H_