Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/headerctrl.h b/interface/wx/headerctrl.h
index 7f3a5ee7564ca0c79c50281c06eec16168509205..662d20df0e709c273c8450914f8376a192250f0a 100644 (file)
--- a/interface/wx/headerctrl.h
+++ b/interface/wx/headerctrl.h
@@ -3,11 +3,26 @@
 // Purpose:     interface of wxHeaderCtrl
 // Author:      Vadim Zeitlin
 // Created:     2008-12-01
 // Purpose:     interface of wxHeaderCtrl
 // Author:      Vadim Zeitlin
 // Created:     2008-12-01

-// RCS-ID:      $Id$

 // Copyright:   (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>
 // Copyright:   (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+
+enum
+{
+    // allow column drag and drop
+    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
+    wxHD_DEFAULT_STYLE = wxHD_ALLOW_REORDER
+};
+
+
+

 /**
     @class wxHeaderCtrl
 
 /**
     @class wxHeaderCtrl
 


@@ -66,7 +81,7 @@
         @c wxHD_ALLOW_REORDER.
     @endStyleTable
 
         @c wxHD_ALLOW_REORDER.
     @endStyleTable
 

-    @beginEventTable{wxHeaderCtrlEvent}
+    @beginEventEmissionTable{wxHeaderCtrlEvent}

     @event{EVT_HEADER_CLICK(id, func)}
         A column heading was clicked.
     @event{EVT_HEADER_RIGHT_CLICK(id, func)}
     @event{EVT_HEADER_CLICK(id, func)}
         A column heading was clicked.
     @event{EVT_HEADER_RIGHT_CLICK(id, func)}


@@ -126,7 +141,7 @@
 
     @see wxGrid, wxListCtrl, wxDataViewCtrl
 */
 
     @see wxGrid, wxListCtrl, wxDataViewCtrl
 */

-class wxHeaderCtrl
+class wxHeaderCtrl : public wxControl

 {
 public:
     /**
 {
 public:
     /**


@@ -325,7 +340,36 @@ public:
             @true if a column was shown or hidden or @false if nothing was
             done, e.g. because the menu was cancelled.
      */
             @true if a column was shown or hidden or @false if nothing was
             done, e.g. because the menu was cancelled.
      */

-    int ShowColumnsMenu(const wxPoint& pt, const wxString& title = wxString());
+    bool ShowColumnsMenu(const wxPoint& pt, const wxString& title = wxString());
+
+    /**
+        Helper function appending the checkable items corresponding to all the
+        columns to the given menu.
+
+        This function is used by ShowColumnsMenu() but can also be used if you
+        show your own custom columns menu and still want all the columns shown
+        in it. It appends menu items with column labels as their text and
+        consecutive ids starting from @a idColumnsBase to the menu and checks
+        the items corresponding to the currently visible columns.
+
+        Example of use:
+        @code
+            wxMenu menu;
+            menu.Append(100, "Some custom command");
+            menu.AppendSeparator();
+            AddColumnsItems(menu, 200);
+            const int rc = GetPopupMenuSelectionFromUser(menu, pt);
+            if ( rc >= 200 )
+                ... toggle visibility of the column rc-200 ...
+        @endcode
+
+        @param menu
+            The menu to append the items to. It may be currently empty or not.
+        @param idColumnsBase
+            The id for the menu item corresponding to the first column, the
+            other ones are consecutive starting from it. It should be positive.
+     */
+    void AddColumnsItems(wxMenu& menu, int idColumnsBase = 0);

 
     /**
         Show the column customization dialog.
 
     /**
         Show the column customization dialog.


@@ -345,6 +389,13 @@ public:
      */
     bool ShowCustomizeDialog();
 
      */
     bool ShowCustomizeDialog();
 

+    /**
+        Returns width needed for given column's title.
+
+        @since 2.9.4
+     */
+    int GetColumnTitleWidth(const wxHeaderColumn& col);
+

 protected:
     /**
         Method to be implemented by the derived classes to return the
 protected:
     /**
         Method to be implemented by the derived classes to return the


@@ -354,7 +405,7 @@ protected:
             The column index, between 0 and the value last passed to
             SetColumnCount().
      */
             The column index, between 0 and the value last passed to
             SetColumnCount().
      */

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

 
     /**
         Method called when the column visibility is changed by the user.
 
     /**
         Method called when the column visibility is changed by the user.


@@ -410,7 +461,7 @@ protected:
         to fit its width on header double click you need to implement this
         method using logic similar to this example:
         @code
         to fit its width on header double click you need to implement this
         method using logic similar to this example:
         @code

-            class MyHeaderCtrl : public wxHeaderColumnBase
+            class MyHeaderColumn : public wxHeaderColumn

             {
             public:
                 ...
             {
             public:
                 ...


@@ -426,7 +477,7 @@ protected:
             {
             public:
             protected:
             {
             public:
             protected:

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

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


@@ -525,14 +576,14 @@ public:
 
         @see AppendColumn()
      */
 
         @see AppendColumn()
      */

-    void InsertColumn(const wxHeaderColumn& col, unsigned int idx);
+    void InsertColumn(const wxHeaderColumnSimple& col, unsigned int idx);

 
     /**
         Append the column to the end of the control.
 
         @see InsertColumn()
      */
 
     /**
         Append the column to the end of the control.
 
         @see InsertColumn()
      */

-    void AppendColumn(const wxHeaderColumn& col);
+    void AppendColumn(const wxHeaderColumnSimple& col);

 
     /**
         Delete the column at the given position.
 
     /**
         Delete the column at the given position.


@@ -578,22 +629,20 @@ public:
 
         @param idx
             The column to set the sort indicator for.
 
         @param idx
             The column to set the sort indicator for.

+            If @c -1 is given, then the currently shown sort indicator
+            will be removed.

         @param sortOrder
             If @true or @false show the sort indicator corresponding to
         @param sortOrder
             If @true or @false show the sort indicator corresponding to

-            ascending or descending sort order respectively, if @c -1 remove
-            the currently shown sort indicator.
+            ascending or descending sort order respectively.

      */
      */

-    virtual void ShowSortIndicator(unsigned int idx, int sortOrder);
+    void ShowSortIndicator(unsigned int idx, bool sortOrder = true);

 
     /**
 
     /**

-        Remove the sort indicator from the given column.
-
-        This is the same as calling ShowSortIndicator() with @c -1 argument.
+        Remove the sort indicator from the column being used as sort key.

 
 

-        @param idx
-            The column to remove sort indicator for.
+        @see ShowSortIndicator

      */
      */

-    void RemoveSortIndicator(unsigned int idx);
+    void RemoveSortIndicator();

 
 protected:
     /**
 
 protected:
     /**


@@ -618,34 +667,56 @@ protected:
     Event class representing the events generated by wxHeaderCtrl.
 
     @library{wxcore}
     Event class representing the events generated by wxHeaderCtrl.
 
     @library{wxcore}

-    @category{ctrl}
+    @category{events}

 
     @see wxHeaderCtrl
 */
 class wxHeaderCtrlEvent : public wxNotifyEvent
 {
 public:
 
     @see wxHeaderCtrl
 */
 class wxHeaderCtrlEvent : public wxNotifyEvent
 {
 public:

+    wxHeaderCtrlEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
+    wxHeaderCtrlEvent(const wxHeaderCtrlEvent& event);
+

     /**
         Return the index of the column affected by this event.
 
         This method can be called for all header control events.
      */
     int GetColumn() const;
     /**
         Return the index of the column affected by this event.
 
         This method can be called for all header control events.
      */
     int GetColumn() const;

-
+    void SetColumn(int col);
+    

     /**
         Return the current width of the column.
 
         This method can only be called for the dragging events.
      */
     int GetWidth() const;
     /**
         Return the current width of the column.
 
         This method can only be called for the dragging events.
      */
     int GetWidth() const;

-
+    void SetWidth(int width);
+    

     /**
         Return the new order of the column.
 
     /**
         Return the new order of the column.
 

-        This method can only be called for end reorder event for which it
+        This method can only be called for a reorder event for which it

         indicates the tentative new position for the column GetColumn()
         selected by the user. If the event is not vetoed, this will become the
         new column position in wxHeaderCtrl::GetColumnsOrder().
      */
     unsigned int GetNewOrder() const;
         indicates the tentative new position for the column GetColumn()
         selected by the user. If the event is not vetoed, this will become the
         new column position in wxHeaderCtrl::GetColumnsOrder().
      */
     unsigned int GetNewOrder() const;

+    void SetNewOrder(unsigned int order);

 };
 };

+
+
+
+wxEventType wxEVT_HEADER_CLICK;
+wxEventType wxEVT_HEADER_RIGHT_CLICK;
+wxEventType wxEVT_HEADER_MIDDLE_CLICK;
+wxEventType wxEVT_HEADER_DCLICK;
+wxEventType wxEVT_HEADER_RIGHT_DCLICK;
+wxEventType wxEVT_HEADER_MIDDLE_DCLICK;
+wxEventType wxEVT_HEADER_SEPARATOR_DCLICK;
+wxEventType wxEVT_HEADER_BEGIN_RESIZE;
+wxEventType wxEVT_HEADER_RESIZING;
+wxEventType wxEVT_HEADER_END_RESIZE;
+wxEventType wxEVT_HEADER_BEGIN_REORDER;
+wxEventType wxEVT_HEADER_END_REORDER;
+wxEventType wxEVT_HEADER_DRAGGING_CANCELLED;