wxHeaderCtrl Class Reference

#include <wx/headerctrl.h>

Inheritance diagram for wxHeaderCtrl:

Detailed Description

wxHeaderCtrl is the control containing the column headings which is usually used for display of tabular data.

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:

• Column reordering support, either by explicitly configuring the columns order and calling SetColumnsOrder() or by dragging the columns interactively (if enabled).
• Display of the icons in the header: this is often used to display a sort or reverse sort indicator when the column header is clicked.

Notice that this control itself doesn't do anything other than displaying the column headers. In particular column reordering and sorting must still be supported by the associated control displaying the real data under the header. Also remember to call ScrollWindow() method of the control if the associated data display window has a horizontal scrollbar, otherwise the headers wouldn't align with the data when the window is scrolled.

This control is implemented using the native header control under MSW systems and a generic implementation elsewhere.

Future Improvements

Some features are supported by the native MSW control and so could be easily implemented in this version of wxHeaderCtrl but need to be implemented in the generic version as well to be really useful. Please let us know if you need or, better, plan to work on implementing, any of them:

• Displaying bitmaps instead of or together with the text
• Custom drawn headers
• Filters associated with a column.

Styles

This class supports the following styles:

• wxHD_ALLOW_REORDER:
  If this style is specified (it is by default), the user can reorder the control columns by dragging them.
• 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.
• wxHD_DEFAULT_STYLE:
  Symbolic name for the default control style, currently equal to wxHD_ALLOW_REORDER.

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxHeaderCtrlEvent& event)

Event macros for events emitted by this class:

• EVT_HEADER_CLICK(id, func):
  A column heading was clicked.
• EVT_HEADER_RIGHT_CLICK(id, func):
  A column heading was right clicked.
• EVT_HEADER_MIDDLE_CLICK(id, func):
  A column heading was clicked with the middle mouse button.
• EVT_HEADER_DCLICK(id, func):
  A column heading was double clicked.
• EVT_HEADER_RIGHT_DCLICK(id, func):
  A column heading was right double clicked.
• EVT_HEADER_MIDDLE_DCLICK(id, func):
  A column heading was double clicked with the middle mouse button.
• 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).
• 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.
• 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.
• 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().
• 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.
• 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()).
• 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.

Library:  wxCore

Category:  Controls

See Also

wxGrid, wxListCtrl, wxDataViewCtrl

Public Member Functions
	wxHeaderCtrl ()
	Default constructor not creating the underlying window.
	wxHeaderCtrl (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxHD_DEFAULT_STYLE, const wxString &name=wxHeaderCtrlNameStr)
	Constructor creating the window.
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxHD_DEFAULT_STYLE, const wxString &name=wxHeaderCtrlNameStr)
	Create the header control window.
void	SetColumnCount (unsigned int count)
	Set the number of columns in the control.
unsigned int	GetColumnCount () const
	Return the number of columns in the control.
bool	IsEmpty () const
	Return whether the control has any columns.
void	UpdateColumn (unsigned int idx)
	Update the column with the given index.
void	SetColumnsOrder (const wxArrayInt &order)
	Change the columns display order.
wxArrayInt	GetColumnsOrder () const
	Return the array describing the columns display order.
unsigned int	GetColumnAt (unsigned int pos) const
	Return the index of the column displayed at the given position.
unsigned int	GetColumnPos (unsigned int idx) const
	Get the position at which this column is currently displayed.
void	ResetColumnsOrder ()
	Reset the columns order to the natural one.
bool	ShowColumnsMenu (const wxPoint &pt, const wxString &title=wxString())
	Show the popup menu allowing the user to show or hide the columns.
void	AddColumnsItems (wxMenu &menu, int idColumnsBase=0)
	Helper function appending the checkable items corresponding to all the columns to the given menu.
bool	ShowCustomizeDialog ()
	Show the column customization dialog.
int	GetColumnTitleWidth (const wxHeaderColumn &col)
	Returns width needed for given column's title.
Public Member Functions inherited from wxControl
	wxControl (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr)
	Constructs a control.
	wxControl ()
	Default constructor to allow 2-phase creation.
bool	Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr)
virtual void	Command (wxCommandEvent &event)
	Simulates the effect of the user issuing a command to the item.
wxString	GetLabel () const
	Returns the control's label, as it was passed to SetLabel().
wxString	GetLabelText () const
	Returns the control's label without mnemonics.
wxSize	GetSizeFromTextSize (int xlen, int ylen=-1) const
	Determine the size needed by the control to leave the given area for its text.
wxSize	GetSizeFromTextSize (const wxSize &tsize) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	SetLabel (const wxString &label)
	Sets the control's label.
void	SetLabelText (const wxString &text)
	Sets the control's label to exactly the given string.
bool	SetLabelMarkup (const wxString &markup)
	Sets the controls label to a string using markup.
Public Member Functions inherited from wxWindow
	wxWindow ()
	Default constructor.
	wxWindow (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
	Constructs a window, which can be a child of a frame, dialog or any other non-control window.
virtual	~wxWindow ()
	Destructor.
bool	Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
virtual bool	AcceptsFocus () const
	This method may be overridden in the derived classes to return false to indicate that this control doesn't accept input at all (i.e. behaves like e.g. wxStaticText) and so doesn't need focus.
virtual bool	AcceptsFocusFromKeyboard () const
	This method may be overridden in the derived classes to return false to indicate that while this control can, in principle, have focus if the user clicks it with the mouse, it shouldn't be included in the TAB traversal chain when using the keyboard.
virtual bool	AcceptsFocusRecursively () const
	Overridden to indicate whether this window or one of its children accepts focus.
bool	IsFocusable () const
	Can this window itself have focus?
bool	CanAcceptFocus () const
	Can this window have focus right now?
bool	CanAcceptFocusFromKeyboard () const
	Can this window be assigned focus from keyboard right now?
virtual bool	HasFocus () const
	Returns true if the window (or in case of composite controls, its main child window) has focus.
virtual void	SetCanFocus (bool canFocus)
	This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0).
virtual void	SetFocus ()
	This sets the window to receive keyboard input.
virtual void	SetFocusFromKbd ()
	This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.
virtual void	AddChild (wxWindow *child)
	Adds a child window.
bool	DestroyChildren ()
	Destroys all children of a window.
wxWindow *	FindWindow (long id) const
	Find a child of this window, by id.
wxWindow *	FindWindow (const wxString &name) const
	Find a child of this window, by name.
wxWindowList &	GetChildren ()
	Returns a reference to the list of the window's children.
const wxWindowList &	GetChildren () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual void	RemoveChild (wxWindow *child)
	Removes a child window.
wxWindow *	GetGrandParent () const
	Returns the grandparent of a window, or NULL if there isn't one.
wxWindow *	GetNextSibling () const
	Returns the next window after this one among the parent's children or NULL if this window is the last child.
wxWindow *	GetParent () const
	Returns the parent of the window, or NULL if there is no parent.
wxWindow *	GetPrevSibling () const
	Returns the previous window before this one among the parent's children or NULL if this window is the first child.
bool	IsDescendant (wxWindowBase *win) const
	Check if the specified window is a descendant of this one.
virtual bool	Reparent (wxWindow *newParent)
	Reparents the window, i.e. the window will be removed from its current parent window (e.g.
virtual void	AlwaysShowScrollbars (bool hflag=true, bool vflag=true)
	Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.
virtual int	GetScrollPos (int orientation) const
	Returns the built-in scrollbar position.
virtual int	GetScrollRange (int orientation) const
	Returns the built-in scrollbar range.
virtual int	GetScrollThumb (int orientation) const
	Returns the built-in scrollbar thumb size.
bool	CanScroll (int orient) const
	Returns true if this window can have a scroll bar in this orientation.
bool	HasScrollbar (int orient) const
	Returns true if this window currently has a scroll bar for this orientation.
virtual bool	IsScrollbarAlwaysShown (int orient) const
	Return whether a scrollbar is always shown.
virtual bool	ScrollLines (int lines)
	Scrolls the window by the given number of lines down (if lines is positive) or up.
virtual bool	ScrollPages (int pages)
	Scrolls the window by the given number of pages down (if pages is positive) or up.
virtual void	ScrollWindow (int dx, int dy, const wxRect *rect=NULL)
	Physically scrolls the pixels in the window and move child windows accordingly.
bool	LineUp ()
	Same as ScrollLines (-1).
bool	LineDown ()
	Same as ScrollLines (1).
bool	PageUp ()
	Same as ScrollPages (-1).
bool	PageDown ()
	Same as ScrollPages (1).
virtual void	SetScrollPos (int orientation, int pos, bool refresh=true)
	Sets the position of one of the built-in scrollbars.
virtual void	SetScrollbar (int orientation, int position, int thumbSize, int range, bool refresh=true)
	Sets the scrollbar properties of a built-in scrollbar.
bool	BeginRepositioningChildren ()
	Prepare for changing positions of multiple child windows.
void	EndRepositioningChildren ()
	Fix child window positions after setting all of them at once.
void	CacheBestSize (const wxSize &size) const
	Sets the cached best size value.
virtual wxSize	ClientToWindowSize (const wxSize &size) const
	Converts client area size size to corresponding window size.
virtual wxSize	WindowToClientSize (const wxSize &size) const
	Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.
virtual void	Fit ()
	Sizes the window so that it fits around its subwindows.
virtual void	FitInside ()
	Similar to Fit(), but sizes the interior (virtual) size of a window.
wxSize	GetBestSize () const
	This functions returns the best acceptable minimal size for the window.
int	GetBestHeight (int width) const
	Returns the best height needed by this window if it had the given width.
int	GetBestWidth (int height) const
	Returns the best width needed by this window if it had the given height.
void	GetClientSize (int *width, int *height) const
	Returns the size of the window 'client area' in pixels.
wxSize	GetClientSize () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual wxSize	GetEffectiveMinSize () const
	Merges the window's best size into the min size and returns the result.
virtual wxSize	GetMaxClientSize () const
	Returns the maximum size of window's client area.
virtual wxSize	GetMaxSize () const
	Returns the maximum size of the window.
virtual wxSize	GetMinClientSize () const
	Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.
virtual wxSize	GetMinSize () const
	Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.
int	GetMinWidth () const
	Returns the horizontal component of window minimal size.
int	GetMinHeight () const
	Returns the vertical component of window minimal size.
int	GetMaxWidth () const
	Returns the horizontal component of window maximal size.
int	GetMaxHeight () const
	Returns the vertical component of window maximal size.
void	GetSize (int *width, int *height) const
	Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.
wxSize	GetSize () const
	See the GetSize(int*,int*) overload for more info.
wxSize	GetVirtualSize () const
	This gets the virtual size of the window in pixels.
void	GetVirtualSize (int *width, int *height) const
	Like the other GetVirtualSize() overload but uses pointers instead.
virtual wxSize	GetBestVirtualSize () const
	Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
virtual double	GetContentScaleFactor () const
	Returns the magnification of the backing store of this window, eg 2.0 for a window on a retina screen.
virtual wxSize	GetWindowBorderSize () const
	Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.
virtual bool	InformFirstDirection (int direction, int size, int availableOtherDir)
	wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known.
void	InvalidateBestSize ()
	Resets the cached best size value so it will be recalculated the next time it is needed.
void	PostSizeEvent ()
	Posts a size event to the window.
void	PostSizeEventToParent ()
	Posts a size event to the parent of this window.
virtual void	SendSizeEvent (int flags=0)
	This function sends a dummy size event to the window allowing it to re-layout its children positions.
void	SendSizeEventToParent (int flags=0)
	Safe wrapper for GetParent()->SendSizeEvent().
void	SetClientSize (int width, int height)
	This sets the size of the window client area in pixels.
void	SetClientSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	SetClientSize (const wxRect &rect)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	SetContainingSizer (wxSizer *sizer)
	This normally does not need to be called by user code.
void	SetInitialSize (const wxSize &size=wxDefaultSize)
	A smart SetSize that will fill in default size components with the window's best size values.
virtual void	SetMaxClientSize (const wxSize &size)
	Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.
virtual void	SetMaxSize (const wxSize &size)
	Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.
virtual void	SetMinClientSize (const wxSize &size)
	Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.
virtual void	SetMinSize (const wxSize &size)
	Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.
void	SetSize (int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO)
	Sets the size of the window in pixels.
void	SetSize (const wxRect &rect)
	Sets the size of the window in pixels.
void	SetSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	SetSize (int width, int height)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual void	SetSizeHints (const wxSize &minSize, const wxSize &maxSize=wxDefaultSize, const wxSize &incSize=wxDefaultSize)
	Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.
virtual void	SetSizeHints (int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	SetVirtualSize (int width, int height)
	Sets the virtual size of the window in pixels.
void	SetVirtualSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	Center (int dir=wxBOTH)
	A synonym for Centre().
void	CenterOnParent (int dir=wxBOTH)
	A synonym for CentreOnParent().
void	Centre (int direction=wxBOTH)
	Centres the window.
void	CentreOnParent (int direction=wxBOTH)
	Centres the window on its parent.
void	GetPosition (int *x, int *y) const
	This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.
wxPoint	GetPosition () const
	This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.
wxRect	GetRect () const
	Returns the position and size of the window as a wxRect object.
void	GetScreenPosition (int *x, int *y) const
	Returns the window position in screen coordinates, whether the window is a child window or a top level one.
wxPoint	GetScreenPosition () const
	Returns the window position in screen coordinates, whether the window is a child window or a top level one.
wxRect	GetScreenRect () const
	Returns the position and size of the window on the screen as a wxRect object.
virtual wxPoint	GetClientAreaOrigin () const
	Get the origin of the client area of the window relative to the window top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)
wxRect	GetClientRect () const
	Get the client rectangle in window (i.e. client) coordinates.
void	Move (int x, int y, int flags=wxSIZE_USE_EXISTING)
	Moves the window to the given position.
void	Move (const wxPoint &pt, int flags=wxSIZE_USE_EXISTING)
	Moves the window to the given position.
void	SetPosition (const wxPoint &pt)
	A synonym for Centre().
void	ClientToScreen (int *x, int *y) const
	Converts to screen coordinates from coordinates relative to this window.
wxPoint	ClientToScreen (const wxPoint &pt) const
	Converts to screen coordinates from coordinates relative to this window.
wxPoint	ConvertDialogToPixels (const wxPoint &pt) const
	Converts a point or size from dialog units to pixels.
wxSize	ConvertDialogToPixels (const wxSize &sz) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
wxPoint	ConvertPixelsToDialog (const wxPoint &pt) const
	Converts a point or size from pixels to dialog units.
wxSize	ConvertPixelsToDialog (const wxSize &sz) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	ScreenToClient (int *x, int *y) const
	Converts from screen to client window coordinates.
wxPoint	ScreenToClient (const wxPoint &pt) const
	Converts from screen to client window coordinates.
virtual void	ClearBackground ()
	Clears the window by filling it with the current background colour.
void	Freeze ()
	Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.
void	Thaw ()
	Re-enables window updating after a previous call to Freeze().
bool	IsFrozen () const
	Returns true if the window is currently frozen by a call to Freeze().
wxColour	GetBackgroundColour () const
	Returns the background colour of the window.
virtual wxBackgroundStyle	GetBackgroundStyle () const
	Returns the background style of the window.
virtual int	GetCharHeight () const
	Returns the character height for this window.
virtual int	GetCharWidth () const
	Returns the average character width for this window.
virtual wxVisualAttributes	GetDefaultAttributes () const
	Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).
wxFont	GetFont () const
	Returns the font for this window.
wxColour	GetForegroundColour () const
	Returns the foreground colour of the window.
void	GetTextExtent (const wxString &string, int *w, int *h, int *descent=NULL, int *externalLeading=NULL, const wxFont *font=NULL) const
	Gets the dimensions of the string as it would be drawn on the window with the currently selected font.
wxSize	GetTextExtent (const wxString &string) const
	Gets the dimensions of the string as it would be drawn on the window with the currently selected font.
const wxRegion &	GetUpdateRegion () const
	Returns the region specifying which parts of the window have been damaged.
wxRect	GetUpdateClientRect () const
	Get the update rectangle bounding box in client coords.
virtual bool	HasTransparentBackground ()
	Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background.
virtual void	Refresh (bool eraseBackground=true, const wxRect *rect=NULL)
	Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.
void	RefreshRect (const wxRect &rect, bool eraseBackground=true)
	Redraws the contents of the given rectangle: only the area inside it will be repainted.
virtual void	Update ()
	Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).
virtual bool	SetBackgroundColour (const wxColour &colour)
	Sets the background colour of the window.
virtual bool	SetBackgroundStyle (wxBackgroundStyle style)
	Sets the background style of the window.
virtual bool	IsTransparentBackgroundSupported (wxString *reason=NULL) const
	Checks whether using transparent background might work.
virtual bool	SetFont (const wxFont &font)
	Sets the font for this window.
virtual bool	SetForegroundColour (const wxColour &colour)
	Sets the foreground colour of the window.
void	SetOwnBackgroundColour (const wxColour &colour)
	Sets the background colour of the window but prevents it from being inherited by the children of this window.
bool	InheritsBackgroundColour () const
	Return true if this window inherits the background colour from its parent.
bool	UseBgCol () const
	Return true if a background colour has been set for this window.
void	SetOwnFont (const wxFont &font)
	Sets the font of the window but prevents it from being inherited by the children of this window.
void	SetOwnForegroundColour (const wxColour &colour)
	Sets the foreground colour of the window but prevents it from being inherited by the children of this window.
void	SetPalette (const wxPalette &pal)
virtual bool	ShouldInheritColours () const
	Return true from here to allow the colours of this window to be changed by InheritAttributes().
virtual void	SetThemeEnabled (bool enable)
	This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.
virtual bool	GetThemeEnabled () const
	Clears the window by filling it with the current background colour.
virtual bool	CanSetTransparent ()
	Returns true if the system supports transparent windows and calling SetTransparent() may succeed.
virtual bool	SetTransparent (wxByte alpha)
	Set the transparency of the window.
wxEvtHandler *	GetEventHandler () const
	Returns the event handler for this window.
bool	HandleAsNavigationKey (const wxKeyEvent &event)
	This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.
bool	HandleWindowEvent (wxEvent &event) const
	Shorthand for:
bool	ProcessWindowEvent (wxEvent &event)
	Convenient wrapper for ProcessEvent().
bool	ProcessWindowEventLocally (wxEvent &event)
	Wrapper for wxEvtHandler::ProcessEventLocally().
wxEvtHandler *	PopEventHandler (bool deleteHandler=false)
	Removes and returns the top-most event handler on the event handler stack.
void	PushEventHandler (wxEvtHandler *handler)
	Pushes this event handler onto the event stack for the window.
bool	RemoveEventHandler (wxEvtHandler *handler)
	Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.
void	SetEventHandler (wxEvtHandler *handler)
	Sets the event handler for this window.
virtual void	SetNextHandler (wxEvtHandler *handler)
	wxWindows cannot be used to form event handler chains; this function thus will assert when called.
virtual void	SetPreviousHandler (wxEvtHandler *handler)
	wxWindows cannot be used to form event handler chains; this function thus will assert when called.
long	GetExtraStyle () const
	Returns the extra style bits for the window.
virtual long	GetWindowStyleFlag () const
	Gets the window style that was passed to the constructor or Create() method.
long	GetWindowStyle () const
	See GetWindowStyleFlag() for more info.
bool	HasExtraStyle (int exFlag) const
	Returns true if the window has the given exFlag bit set in its extra styles.
bool	HasFlag (int flag) const
	Returns true if the window has the given flag bit set.
virtual void	SetExtraStyle (long exStyle)
	Sets the extra style bits for the window.
virtual void	SetWindowStyleFlag (long style)
	Sets the style of the window.
void	SetWindowStyle (long style)
	See SetWindowStyleFlag() for more info.
bool	ToggleWindowStyle (int flag)
	Turns the given flag on if it's currently turned off and vice versa.
void	MoveAfterInTabOrder (wxWindow *win)
	Moves this window in the tab navigation order after the specified win.
void	MoveBeforeInTabOrder (wxWindow *win)
	Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.
bool	Navigate (int flags=wxNavigationKeyEvent::IsForward)
	Performs a keyboard navigation action starting from this window.
bool	NavigateIn (int flags=wxNavigationKeyEvent::IsForward)
	Performs a keyboard navigation action inside this window.
virtual void	Lower ()
	Lowers the window to the bottom of the window hierarchy (Z-order).
virtual void	Raise ()
	Raises the window to the top of the window hierarchy (Z-order).
bool	Hide ()
	Equivalent to calling wxWindow::Show(false).
virtual bool	HideWithEffect (wxShowEffect effect, unsigned int timeout=0)
	This function hides a window, like Hide(), but using a special visual effect if possible.
bool	IsEnabled () const
	Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.
bool	IsExposed (int x, int y) const
	Returns true if the given point or rectangle area has been exposed since the last repaint.
bool	IsExposed (wxPoint &pt) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	IsExposed (int x, int y, int w, int h) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	IsExposed (wxRect &rect) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual bool	IsShown () const
	Returns true if the window is shown, false if it has been hidden.
virtual bool	IsShownOnScreen () const
	Returns true if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well.
bool	Disable ()
	Disables the window.
virtual bool	Enable (bool enable=true)
	Enable or disable the window for user input.
virtual bool	Show (bool show=true)
	Shows or hides the window.
virtual bool	ShowWithEffect (wxShowEffect effect, unsigned int timeout=0)
	This function shows a window, like Show(), but using a special visual effect if possible.
wxString	GetHelpText () const
	Gets the help text to be used as context-sensitive help for this window.
void	SetHelpText (const wxString &helpText)
	Sets the help text to be used as context-sensitive help for this window.
virtual wxString	GetHelpTextAtPoint (const wxPoint &point, wxHelpEvent::Origin origin) const
	Gets the help text to be used as context-sensitive help for this window.
wxToolTip *	GetToolTip () const
	Get the associated tooltip or NULL if none.
wxString	GetToolTipText () const
	Get the text of the associated tooltip or empty string if none.
void	SetToolTip (const wxString &tipString)
	Attach a tooltip to the window.
void	SetToolTip (wxToolTip *tip)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	UnsetToolTip ()
	Unset any existing tooltip.
int	GetPopupMenuSelectionFromUser (wxMenu &menu, const wxPoint &pos=wxDefaultPosition)
	This function shows a popup menu at the given position in this window and returns the selected id.
int	GetPopupMenuSelectionFromUser (wxMenu &menu, int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	PopupMenu (wxMenu *menu, const wxPoint &pos=wxDefaultPosition)
	Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.
bool	PopupMenu (wxMenu *menu, int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual wxValidator *	GetValidator ()
	Validator functions.
virtual void	SetValidator (const wxValidator &validator)
	Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type.
virtual bool	TransferDataFromWindow ()
	Transfers values from child controls to data areas specified by their validators.
virtual bool	TransferDataToWindow ()
	Transfers values to child controls from data areas specified by their validators.
virtual bool	Validate ()
	Validates the current values of the child controls using their validators.
wxWindowID	GetId () const
	Returns the identifier of the window.
virtual wxLayoutDirection	GetLayoutDirection () const
	Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.
virtual wxCoord	AdjustForLayoutDirection (wxCoord x, wxCoord width, wxCoord widthTotal) const
	Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.
virtual wxString	GetName () const
	Returns the window's name.
wxWindowVariant	GetWindowVariant () const
	Returns the value previously passed to SetWindowVariant().
void	SetId (wxWindowID winid)
	Sets the identifier of the window.
virtual void	SetLayoutDirection (wxLayoutDirection dir)
	Sets the layout direction for this window.
virtual void	SetName (const wxString &name)
	Sets the window's name.
void	SetWindowVariant (wxWindowVariant variant)
	Chooses a different variant of the window display to use.
wxAcceleratorTable *	GetAcceleratorTable ()
	Gets the accelerator table for this window.
wxAccessible *	GetAccessible ()
	Returns the accessible object for this window, if any.
virtual void	SetAcceleratorTable (const wxAcceleratorTable &accel)
	Sets the accelerator table for this window.
void	SetAccessible (wxAccessible *accessible)
	Sets the accessible for this window.
bool	Close (bool force=false)
	This function simply generates a wxCloseEvent whose handler usually tries to close the window.
virtual bool	Destroy ()
	Destroys the window safely.
bool	IsBeingDeleted () const
	Returns true if this window is in process of being destroyed.
virtual wxDropTarget *	GetDropTarget () const
	Returns the associated drop target, which may be NULL.
virtual void	SetDropTarget (wxDropTarget *target)
	Associates a drop target with this window.
virtual void	DragAcceptFiles (bool accept)
	Enables or disables eligibility for drop file events (OnDropFiles).
wxSizer *	GetContainingSizer () const
	Returns the sizer of which this window is a member, if any, otherwise NULL.
wxSizer *	GetSizer () const
	Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.
void	SetSizer (wxSizer *sizer, bool deleteOld=true)
	Sets the window to have the given layout sizer.
void	SetSizerAndFit (wxSizer *sizer, bool deleteOld=true)
	This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial window size to the size needed to accommodate all sizer elements and sets the size hints which, if this window is a top level one, prevent the user from resizing it to be less than this minimal size.
wxLayoutConstraints *	GetConstraints () const
	Returns a pointer to the window's layout constraints, or NULL if there are none.
void	SetConstraints (wxLayoutConstraints *constraints)
	Sets the window to have the given layout constraints.
virtual bool	Layout ()
	Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window.
void	SetAutoLayout (bool autoLayout)
	Determines whether the Layout() function will be called automatically when the window is resized.
bool	GetAutoLayout () const
	Returns the sizer of which this window is a member, if any, otherwise NULL.
void	CaptureMouse ()
	Directs all mouse input to this window.
wxCaret *	GetCaret () const
	Returns the caret() associated with the window.
const wxCursor &	GetCursor () const
	Return the cursor associated with this window.
virtual bool	HasCapture () const
	Returns true if this window has the current mouse capture.
void	ReleaseMouse ()
	Releases mouse input captured with CaptureMouse().
void	SetCaret (wxCaret *caret)
	Sets the caret() associated with the window.
virtual bool	SetCursor (const wxCursor &cursor)
	Sets the window's cursor.
virtual void	WarpPointer (int x, int y)
	Moves the pointer to the given position on the window.
wxHitTest	HitTest (wxCoord x, wxCoord y) const
	Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.
wxHitTest	HitTest (const wxPoint &pt) const
	Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.
wxBorder	GetBorder (long flags) const
	Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.
wxBorder	GetBorder () const
	Get border for the flags of this window.
virtual void	DoUpdateWindowUI (wxUpdateUIEvent &event)
	Does the window-specific updating after processing the update event.
virtual WXWidget	GetHandle () const
	Returns the platform-specific handle of the physical window.
virtual bool	HasMultiplePages () const
	This method should be overridden to return true if this window has multiple pages.
virtual void	InheritAttributes ()
	This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.
virtual void	InitDialog ()
	Sends an wxEVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.
virtual bool	IsDoubleBuffered () const
	Returns true if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later.
void	SetDoubleBuffered (bool on)
	Turn on or off double buffering of the window if the system supports it.
virtual bool	IsRetained () const
	Returns true if the window is retained, false otherwise.
bool	IsThisEnabled () const
	Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.
virtual bool	IsTopLevel () const
	Returns true if the given window is a top-level one.
virtual void	OnInternalIdle ()
	This virtual function is normally only used internally, but sometimes an application may need it to implement functionality that should not be disabled by an application defining an OnIdle handler in a derived class.
virtual bool	SendIdleEvents (wxIdleEvent &event)
	Send idle event to window and all subwindows.
virtual bool	RegisterHotKey (int hotkeyId, int modifiers, int virtualKeyCode)
	Registers a system wide hotkey.
virtual bool	UnregisterHotKey (int hotkeyId)
	Unregisters a system wide hotkey.
virtual void	UpdateWindowUI (long flags=wxUPDATE_UI_NONE)
	This function sends one or more wxUpdateUIEvent to the window.
Public Member Functions inherited from wxEvtHandler
	wxEvtHandler ()
	Constructor.
virtual	~wxEvtHandler ()
	Destructor.
template<typename T , typename T1 , ... >
void	CallAfter (void(T::*method)(T1,...), T1 x1,...)
	Asynchronously call the given method.
template<typename T >
void	CallAfter (const T &functor)
	Asynchronously call the given functor.
bool	ProcessEventLocally (wxEvent &event)
	Try to process the event in this handler and all those chained to it.
bool	SafelyProcessEvent (wxEvent &event)
	Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.
void	ProcessPendingEvents ()
	Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.
void	DeletePendingEvents ()
	Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().
virtual bool	SearchEventTable (wxEventTable &table, wxEvent &event)
	Searches the event table, executing an event handler function if an appropriate one is found.
void	Connect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	Connects the given function dynamically with the event handler, id and event type.
void	Connect (int id, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
void	Connect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
bool	Disconnect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	Disconnects the given function dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed.
bool	Disconnect (int id=wxID_ANY, wxEventType eventType=wxEVT_NULL, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
bool	Disconnect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
template<typename EventTag , typename Functor >
void	Bind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	Binds the given function, functor or method dynamically with the event.
template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
void	Bind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info.
template<typename EventTag , typename Functor >
bool	Unbind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	Unbinds the given function, functor or method dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed.
template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
bool	Unbind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info.
void *	GetClientData () const
	Returns user-supplied client data.
wxClientData *	GetClientObject () const
	Returns a pointer to the user-supplied client data object.
void	SetClientData (void *data)
	Sets user-supplied client data.
void	SetClientObject (wxClientData *data)
	Set the client data object.
bool	GetEvtHandlerEnabled () const
	Returns true if the event handler is enabled, false otherwise.
wxEvtHandler *	GetNextHandler () const
	Returns the pointer to the next handler in the chain.
wxEvtHandler *	GetPreviousHandler () const
	Returns the pointer to the previous handler in the chain.
void	SetEvtHandlerEnabled (bool enabled)
	Enables or disables the event handler.
void	Unlink ()
	Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).
bool	IsUnlinked () const
	Returns true if the next and the previous handler pointers of this event handler instance are NULL.
Public Member Functions inherited from wxObject
	wxObject ()
	Default ctor; initializes to NULL the internal reference data.
	wxObject (const wxObject &other)
	Copy ctor.
virtual	~wxObject ()
	Destructor.
virtual wxClassInfo *	GetClassInfo () const
	This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
wxObjectRefData *	GetRefData () const
	Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
bool	IsKindOf (const wxClassInfo *info) const
	Determines whether this class is a subclass of (or the same class as) the given class.
bool	IsSameAs (const wxObject &obj) const
	Returns true if this object has the same data pointer as obj.
void	Ref (const wxObject &clone)
	Makes this object refer to the data in clone.
void	SetRefData (wxObjectRefData *data)
	Sets the wxObject::m_refData pointer.
void	UnRef ()
	Decrements the reference count in the associated data, and if it is zero, deletes the data.
void	UnShare ()
	This is the same of AllocExclusive() but this method is public.
void	operator delete (void *buf)
	The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined.
void *	operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
	The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined.

Static Public Member Functions
static void	MoveColumnInOrderArray (wxArrayInt &order, unsigned int idx, unsigned int pos)
	Helper function to manipulate the array of column indices.
Static Public Member Functions inherited from wxControl
static wxString	GetLabelText (const wxString &label)
	Returns the given label string without mnemonics ("&" characters).
static wxString	RemoveMnemonics (const wxString &str)
	Returns the given str string without mnemonics ("&" characters).
static wxString	EscapeMnemonics (const wxString &text)
	Escapes the special mnemonics characters ("&") in the given string.
static wxString	Ellipsize (const wxString &label, const wxDC &dc, wxEllipsizeMode mode, int maxWidth, int flags=wxELLIPSIZE_FLAGS_DEFAULT)
	Replaces parts of the label string with ellipsis, if needed, so that it fits into maxWidth pixels if possible.
Static Public Member Functions inherited from wxWindow
static wxVisualAttributes	GetClassDefaultAttributes (wxWindowVariant variant=wxWINDOW_VARIANT_NORMAL)
	Returns the default font and colours which are used by the control.
static wxWindow *	FindFocus ()
	Finds the window or control which currently has the keyboard focus.
static wxWindow *	FindWindowById (long id, const wxWindow *parent=0)
	Find the first window with the given id.
static wxWindow *	FindWindowByLabel (const wxString &label, const wxWindow *parent=0)
	Find a window by its label.
static wxWindow *	FindWindowByName (const wxString &name, const wxWindow *parent=0)
	Find a window by its name (as given in a window constructor or Create() function call).
static wxWindow *	GetCapture ()
	Returns the currently captured window.
static wxWindowID	NewControlId (int count=1)
	Create a new ID or range of IDs that are not currently in use.
static void	UnreserveControlId (wxWindowID id, int count=1)
	Unreserve an ID or range of IDs that was reserved by NewControlId().
Static Public Member Functions inherited from wxEvtHandler
static void	AddFilter (wxEventFilter *filter)
	Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.
static void	RemoveFilter (wxEventFilter *filter)
	Remove a filter previously installed with AddFilter().

Protected Member Functions
virtual const wxHeaderColumn &	GetColumn (unsigned int idx) const =0
	Method to be implemented by the derived classes to return the information for the given column.
virtual void	UpdateColumnVisibility (unsigned int idx, bool show)
	Method called when the column visibility is changed by the user.
virtual void	UpdateColumnsOrder (const wxArrayInt &order)
	Method called when the columns order is changed in the customization dialog.
virtual bool	UpdateColumnWidthToFit (unsigned int idx, int widthTitle)
	Method which may be implemented by the derived classes to allow double clicking the column separator to resize the column to fit its contents.
virtual void	OnColumnCountChanging (unsigned int count)
	Can be overridden in the derived class to update internal data structures when the number of the columns in the control changes.

Additional Inherited Members
Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted data.

Constructor & Destructor Documentation

wxHeaderCtrl::wxHeaderCtrl

(

)

Default constructor not creating the underlying window.

You must use Create() after creating the object using this constructor.

wxHeaderCtrl::wxHeaderCtrl	(	wxWindow *	parent,
		wxWindowID	winid = wxID_ANY,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxHD_DEFAULT_STYLE,
		const wxString &	name = wxHeaderCtrlNameStr
	)

Constructor creating the window.

Please see Create() for the parameters documentation.

Member Function Documentation

void wxHeaderCtrl::AddColumnsItems	(	wxMenu &	menu,
		int	idColumnsBase = 0
	)

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 idColumnsBase to the menu and checks the items corresponding to the currently visible columns.

Example of use:

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 ...

Parameters

menu	The menu to append the items to. It may be currently empty or not.
idColumnsBase	The id for the menu item corresponding to the first column, the other ones are consecutive starting from it. It should be positive.

bool wxHeaderCtrl::Create	(	wxWindow *	parent,
		wxWindowID	winid = wxID_ANY,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxHD_DEFAULT_STYLE,
		const wxString &	name = wxHeaderCtrlNameStr
	)

Create the header control window.

Parameters

parent	The parent window. The header control should be typically positioned along the top edge of this window.
winid	Id of the control or wxID_ANY if you don't care.
pos	The initial position of the control.
size	The initial size of the control (usually not very useful as this control will typically be resized to have the same width as the associated data display control).
style	The control style, 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 wxHD_DEFAULT_STYLE & ~wxHD_ALLOW_REORDER if this is undesirable.
name	The name of the control.

virtual const wxHeaderColumn& wxHeaderCtrl::GetColumn ( unsigned int  idx ) const

protectedpure virtual

Method to be implemented by the derived classes to return the information for the given column.

Parameters

idx	The column index, between 0 and the value last passed to SetColumnCount().

unsigned int wxHeaderCtrl::GetColumnAt

(

unsigned int

pos

)

const

Return the index of the column displayed at the given position.

Parameters

pos	The display position, e.g. 0 for the left-most column, 1 for the next one and so on until GetColumnCount() - 1.

See Also

GetColumnPos()

unsigned int wxHeaderCtrl::GetColumnCount

(

)

const

Return the number of columns in the control.

Returns

Number of columns as previously set by SetColumnCount().

See Also

IsEmpty()

unsigned int wxHeaderCtrl::GetColumnPos

(

unsigned int

idx

)

const

Get the position at which this column is currently displayed.

Notice that a valid position is returned even for the hidden columns currently.

Parameters

idx	The column index, must be less than GetColumnCount().

See Also

GetColumnAt()

wxArrayInt wxHeaderCtrl::GetColumnsOrder

(

)

const

Return the array describing the columns display order.

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.

int wxHeaderCtrl::GetColumnTitleWidth

(

const wxHeaderColumn &

col

)

Returns width needed for given column's title.

Since

2.9.4

bool wxHeaderCtrl::IsEmpty

(

)

const

Return whether the control has any columns.

See Also

GetColumnCount()

static void wxHeaderCtrl::MoveColumnInOrderArray ( wxArrayInt &  order, unsigned int  idx, unsigned int  pos  )

static

Helper function to manipulate the array of column indices.

This function 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.

Parameters

order	Array containing the indices of columns in order of their positions.
idx	The index of the column to move.
pos	The new position for the column idx.

virtual void wxHeaderCtrl::OnColumnCountChanging ( unsigned int  count )

protectedvirtual

Can be overridden in the derived class to update internal data structures when the number of the columns in the control changes.

This method is called by SetColumnCount() before effectively changing the number of columns.

The base class version does nothing but it is good practice to still call it from the overridden version in the derived class.

void wxHeaderCtrl::ResetColumnsOrder

(

)

Reset the columns order to the natural one.

After calling this function, the column with index idx appears at position idx in the control.

void wxHeaderCtrl::SetColumnCount

(

unsigned int

count

)

Set the number of columns in the control.

The control will use GetColumn() to get information about all the new columns and refresh itself, i.e. this method also has the same effect as calling UpdateColumn() for all columns but it should only be used if the number of columns really changed.

void wxHeaderCtrl::SetColumnsOrder

(

const wxArrayInt &

order

)

Change the columns display order.

The display order defines the order in which the columns appear on the screen and does not affect the interpretation of indices by all the other class methods.

The order array specifies the column indices corresponding to the display positions.

Parameters

order

A permutation of all column indices, i.e. an array of size GetColumnsOrder() containing all column indices exactly once. The n-th element of this array defines the index of the column shown at the n-th position from left (for the default left-to-right writing direction).

See Also

wxListCtrl::SetColumnsOrder()

bool wxHeaderCtrl::ShowColumnsMenu	(	const wxPoint &	pt,
		const wxString &	title = wxString()
	)

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.

Parameters

pt	The position of the menu, in the header window coordinates.
title	The title for the menu if not empty.

Returns

true if a column was shown or hidden or false if nothing was done, e.g. because the menu was cancelled.

bool wxHeaderCtrl::ShowCustomizeDialog

(

)

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 Also

wxRearrangeDialog

void wxHeaderCtrl::UpdateColumn

(

unsigned int

idx

)

Update the column with the given index.

When the value returned by GetColumn() changes, this method must be called to notify the control about the change and update the visual display to match the new column data.

Parameters

idx	The column index, must be less than GetColumnCount().

virtual void wxHeaderCtrl::UpdateColumnsOrder ( const wxArrayInt &  order )

protectedvirtual

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 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.

Parameters

order

The new column order. This array uses the same convention as SetColumnsOrder().

virtual void wxHeaderCtrl::UpdateColumnVisibility ( unsigned int  idx, bool  show  )

protectedvirtual

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.

Parameters

idx	The index of the column whose visibility was toggled.
show	The new visibility value, true if the column is now shown or false if it is not hidden.

virtual bool wxHeaderCtrl::UpdateColumnWidthToFit ( unsigned int  idx, int  widthTitle  )

protectedvirtual

Method which may be implemented by the derived classes to allow double clicking the column separator to resize the column to fit its contents.

When a separator is double clicked, the default handler of EVT_HEADER_SEPARATOR_DCLICK event calls this function and refreshes the column if it returns true so to implement the resizing of the column to fit its width on header double click you need to implement this method using logic similar to this example:

class MyHeaderColumn : public wxHeaderColumn
{
public:
    ...

    void SetWidth(int width) { m_width = width; }
    virtual int GetWidth() const { return m_width; }

private:
    int m_width;
};

class MyHeaderCtrl : public wxHeaderCtrl
{
public:
protected:
    virtual wxHeaderColumn& GetColumn(unsigned int idx) const
    {
        return m_cols[idx];
    }

    virtual bool UpdateColumnWidthToFit(unsigned int idx, int widthTitle)
    {
        int widthContents = ... compute minimal width for column idx ...
        m_cols[idx].SetWidth(wxMax(widthContents, widthTitle));
        return true;
    }

    wxVector<MyHeaderColumn> m_cols;
};

Base class version simply returns false.

Parameters

idx	The zero-based index of the column to update.
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.

Returns

true to indicate that the column was resized, i.e. GetColumn() now returns the new width value, and so must be refreshed or false meaning that the control didn't reach to the separator double click.