wxHeaderCtrl is the control containing the column headings which is usually
used for display of tabular data.
- It is used as part of wxGrid and (will be used in the near future) in
- in wxDataViewCtrl and report view of wxListCtrl but can be also used
- independently. In general this class is meant to be used as part of another
- control which already stores the column information somewhere as it can't
- be used directly: instead you need to inherit from it and implement the
- GetColumn() method to provide column information. See wxHeaderCtrlSimple
- for a concrete control class which can be used directly.
+ It is used as part of wxGrid, in generic version wxDataViewCtrl and report
+ view of wxListCtrl but can be also used independently. In general this
+ class is meant to be used as part of another control which already stores
+ the column information somewhere as it can't be used directly: instead you
+ need to inherit from it and implement the GetColumn() method to provide
+ column information. See wxHeaderCtrlSimple for a concrete control class
+ which can be used directly.
In addition to labeling the columns, the control has the following
features:
This control is implemented using the native header control under MSW
systems and a generic implementation elsewhere.
- @beginStyleTable
- @style{wxHD_DRAGDROP}
- If this style is specified (it is by default), the user can reorder
- the control columns by dragging them.
- @style{wxHD_DEFAULT_STYLE}
- Symbolic name for the default control style, currently equal to @c
- wxHD_DRAGDROP.
- @endStyleTable
-
- @beginEventTable{wxHeaderCtrlEvent}
- @event{EVT_HEADER_CLICK(id, func)}
- A column heading was clicked.
- @event{EVT_HEADER_RIGHT_CLICK(id, func)}
- A column heading was right clicked.
- @event{EVT_HEADER_MIDDLE_CLICK(id, func)}
- A column heading was clicked with the middle mouse button.
-
- @event{EVT_HEADER_DCLICK(id, func)}
- A column heading was double clicked.
- @event{EVT_HEADER_RIGHT_DCLICK(id, func)}
- A column heading was right double clicked.
- @event{EVT_HEADER_MIDDLE_DCLICK(id, func)}
- A column heading was double clicked with the middle mouse button.
-
- @event{EVT_HEADER_SEPARATOR_DCLICK(id, func)}
- Separator to the right of the specified column was double clicked
- (this action is commonly used to resize the column to fit its
- contents width and the control provides UpdateColumnWidthToFit() method
- to make implementing this easier).
-
- @event{EVT_HEADER_BEGIN_RESIZE(id, func)}
- The user started to drag the separator to the right of the column
- with the specified index (this can only happen for the columns for
- which wxHeaderColumn::IsResizeable() returns true). The event can
- be vetoed to prevent the column from being resized. If it isn't,
- the resizing and end resize (or dragging cancelled) events will be
- generated later.
- @event{EVT_HEADER_RESIZING(id, func)}
- The user is dragging the column with the specified index resizing
- it and its current width is wxHeaderCtrlEvent::GetWidth(). The
- event can be vetoed to stop the dragging operation completely at
- any time.
- @event{EVT_HEADER_END_RESIZE(id, func)}
- The user stopped dragging the column by releasing the mouse. The
- column should normally be resized to the value of
- wxHeaderCtrlEvent::GetWidth().
-
- @event{EVT_HEADER_BEGIN_REORDER(id, func)}
- The user started to drag the column with the specified index (this
- can only happen for the controls with wxHD_DRAGDROP style). This
- event can be vetoed to prevent the column from being reordered,
- otherwise the end reorder message will be generated later.
- @event{EVT_HEADER_END_REORDER(id, func)}
- The user dropped the column in its new location. The event can be
- vetoed to prevent the column from being placed at the new position
- or handled to update the display of the data in the associated
- control to match the new column location (available from
- wxHeaderCtrlEvent::GetNewOrder()).
-
- @event{EVT_HEADER_DRAGGING_CANCELLED(id, func)}
- The resizing or reordering operation currently in progress was
- cancelled. This can happen if the user pressed Esc key while
- dragging the mouse or the mouse capture was lost for some other
- reason. You only need to handle this event if your application
- entered into some modal mode when resizing or reordering began, in
- which case it should handle this event in addition to the matching
- end resizing or reordering ones.
- @endEventTable
-
- @library{wxcore}
- @category{ctrl}
-
- @see wxGrid, wxListCtrl, wxDataViewCtrl
-
@section headerctrl_improvements Future Improvements
- Displaying bitmaps instead of or together with the text
- Custom drawn headers
- Filters associated with a column.
+
+
+ @beginStyleTable
+ @style{wxHD_ALLOW_REORDER}
+ If this style is specified (it is by default), the user can reorder
+ the control columns by dragging them.
+ @style{wxHD_ALLOW_HIDE}
+ If this style is specified, the control shows a popup menu allowing the
+ user to change the columns visibility on right mouse click. Notice that
+ the program can always hide or show the columns, this style only
+ affects the users capability to do it.
+ @style{wxHD_DEFAULT_STYLE}
+ Symbolic name for the default control style, currently equal to
+ @c wxHD_ALLOW_REORDER.
+ @endStyleTable
+
+ @beginEventTable{wxHeaderCtrlEvent}
+ @event{EVT_HEADER_CLICK(id, func)}
+ A column heading was clicked.
+ @event{EVT_HEADER_RIGHT_CLICK(id, func)}
+ A column heading was right clicked.
+ @event{EVT_HEADER_MIDDLE_CLICK(id, func)}
+ A column heading was clicked with the middle mouse button.
+ @event{EVT_HEADER_DCLICK(id, func)}
+ A column heading was double clicked.
+ @event{EVT_HEADER_RIGHT_DCLICK(id, func)}
+ A column heading was right double clicked.
+ @event{EVT_HEADER_MIDDLE_DCLICK(id, func)}
+ A column heading was double clicked with the middle mouse button.
+ @event{EVT_HEADER_SEPARATOR_DCLICK(id, func)}
+ Separator to the right of the specified column was double clicked
+ (this action is commonly used to resize the column to fit its
+ contents width and the control provides UpdateColumnWidthToFit() method
+ to make implementing this easier).
+ @event{EVT_HEADER_BEGIN_RESIZE(id, func)}
+ The user started to drag the separator to the right of the column
+ with the specified index (this can only happen for the columns for
+ which wxHeaderColumn::IsResizeable() returns true). The event can
+ be vetoed to prevent the column from being resized. If it isn't,
+ the resizing and end resize (or dragging cancelled) events will be
+ generated later.
+ @event{EVT_HEADER_RESIZING(id, func)}
+ The user is dragging the column with the specified index resizing
+ it and its current width is wxHeaderCtrlEvent::GetWidth().
+ The event can be vetoed to stop the dragging operation completely at
+ any time.
+ @event{EVT_HEADER_END_RESIZE(id, func)}
+ The user stopped dragging the column by releasing the mouse.
+ The column should normally be resized to the value of
+ wxHeaderCtrlEvent::GetWidth().
+ @event{EVT_HEADER_BEGIN_REORDER(id, func)}
+ The user started to drag the column with the specified index (this
+ can only happen for the controls with wxHD_ALLOW_REORDER style).
+ This event can be vetoed to prevent the column from being reordered,
+ otherwise the end reorder message will be generated later.
+ @event{EVT_HEADER_END_REORDER(id, func)}
+ The user dropped the column in its new location. The event can be
+ vetoed to prevent the column from being placed at the new position
+ or handled to update the display of the data in the associated
+ control to match the new column location (available from
+ wxHeaderCtrlEvent::GetNewOrder()).
+ @event{EVT_HEADER_DRAGGING_CANCELLED(id, func)}
+ The resizing or reordering operation currently in progress was
+ cancelled. This can happen if the user pressed Esc key while
+ dragging the mouse or the mouse capture was lost for some other
+ reason. You only need to handle this event if your application
+ entered into some modal mode when resizing or reordering began, in
+ which case it should handle this event in addition to the matching
+ end resizing or reordering ones.
+ @endEventTable
+
+ @library{wxcore}
+ @category{ctrl}
+
+ @see wxGrid, wxListCtrl, wxDataViewCtrl
*/
class wxHeaderCtrl
{
The control style, @c wxHD_DEFAULT_STYLE by default. Notice that
the default style allows the user to reorder the columns by
dragging them and you need to explicitly turn this feature off by
- using @code wxHD_DEFAULT_STYLE & ~wxHD_DRAGDROP @endcode if this is
- undesirable.
+ using @code wxHD_DEFAULT_STYLE & ~wxHD_ALLOW_REORDER @endcode if
+ this is undesirable.
@param name
The name of the control.
*/
/**
Return the array describing the columns display order.
- For the controls without wxHD_DRAGDROP style the returned array will be
- the same as was passed to SetColumnsOrder() previously or define the
- default order (with n-th element being n) if it hadn't been called. But
- for the controls with wxHD_DRAGDROP style, the columns can be also
- reordered by user.
+ For the controls without wxHD_ALLOW_REORDER style the returned array
+ will be the same as was passed to SetColumnsOrder() previously or
+ define the default order (with n-th element being n) if it hadn't been
+ called. But for the controls with wxHD_ALLOW_REORDER style, the columns
+ can be also reordered by user.
*/
wxArrayInt GetColumnsOrder() const;
*/
unsigned int GetColumnPos(unsigned int idx) const;
+ /**
+ Reset the columns order to the natural one.
+
+ After calling this function, the column with index @c idx appears at
+ position @c idx in the control.
+ */
+ void ResetColumnsOrder();
+
/**
Helper function to manipulate the array of column indices.
unsigned int idx,
unsigned int pos);
+ /**
+ Show the popup menu allowing the user to show or hide the columns.
+
+ This functions shows the popup menu containing all columns with check
+ marks for the ones which are currently shown and allows the user to
+ check or uncheck them to toggle their visibility. It is called from the
+ default EVT_HEADER_RIGHT_CLICK handler for the controls which have
+ wxHD_ALLOW_HIDE style. And if the column has wxHD_ALLOW_REORDER style
+ as well, the menu also contains an item to customize the columns shown
+ using which results in ShowCustomizeDialog() being called, please see
+ its description for more details.
+
+ If a column was toggled, UpdateColumnVisibility() virtual function is
+ called so it must be implemented for the controls with wxHD_ALLOW_HIDE
+ style or if you call this function explicitly.
+
+ @param pt
+ The position of the menu, in the header window coordinates.
+ @param title
+ The title for the menu if not empty.
+ @return
+ @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());
+
+ /**
+ 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.
+
+ This function displays a modal dialog containing the list of all
+ columns which the user can use to reorder them as well as show or hide
+ individual columns.
+
+ If the user accepts the changes done in the dialog, the virtual
+ methods UpdateColumnVisibility() and UpdateColumnsOrder() will be
+ called so they must be overridden in the derived class if this method
+ is ever called. Please notice that the user will be able to invoke it
+ interactively from the header popup menu if the control has both
+ wxHD_ALLOW_HIDE and wxHD_ALLOW_REORDER styles.
+
+ @see wxRearrangeDialog
+ */
+ bool ShowCustomizeDialog();
+
protected:
/**
Method to be implemented by the derived classes to return the
The column index, between 0 and the value last passed to
SetColumnCount().
*/
- virtual wxHeaderColumnBase& GetColumn(unsigned int idx) = 0;
+ virtual const wxHeaderColumnBase& GetColumn(unsigned int idx) const = 0;
+
+ /**
+ Method called when the column visibility is changed by the user.
+
+ This method is called from ShowColumnsMenu() or ShowCustomizeDialog()
+ when the user interactively hides or shows a column. A typical
+ implementation will simply update the internally stored column state.
+ Notice that there is no need to call UpdateColumn() from this method as
+ it is already done by wxHeaderCtrl itself.
+
+ The base class version doesn't do anything and must be overridden if
+ this method is called.
+
+ @param idx
+ The index of the column whose visibility was toggled.
+ @param show
+ The new visibility value, @true if the column is now shown or
+ @false if it is not hidden.
+ */
+ virtual void UpdateColumnVisibility(unsigned int idx, bool show);
+
+ /**
+ Method called when the columns order is changed in the customization
+ dialog.
+
+ This method is only called from ShowCustomizeDialog() when the user
+ changes the order of columns. In particular it is @em not called if a
+ single column changes place because the user dragged it to the new
+ location, the EVT_HEADER_END_REORDER event handler should be used to
+ react to this.
+
+ A typical implementation in a derived class will update the display
+ order of the columns in the associated control, if any. Notice that
+ there is no need to call SetColumnsOrder() from it as wxHeaderCtrl does
+ it itself.
+
+ The base class version doesn't do anything and must be overridden if
+ this method is called.
+
+ @param order
+ The new column order. This array uses the same convention as
+ SetColumnsOrder().
+ */
+ virtual void UpdateColumnsOrder(const wxArrayInt& order);
/**
Method which may be implemented by the derived classes to allow double
{
public:
protected:
- virtual wxHeaderColumnBase& GetColumn(unsigned int idx)
+ virtual wxHeaderColumnBase& GetColumn(unsigned int idx) const
{
return m_cols[idx];
}
Base class version simply returns @false.
- @param width
+ @param idx
+ The zero-based index of the column to update.
+ @param widthTitle
Contains minimal width needed to display the column header itself
and will usually be used as a starting point for the fitting width
calculation.
+
@return
@true to indicate that the column was resized, i.e. GetColumn() now
returns the new width value, and so must be refreshed or @false
projects / wxWidgets.git / blobdiff