wx.HeaderColumn¶

Represents a column header in controls displaying tabular data such as wx.dataview.DataViewCtrl or wx.grid.Grid.

Notice that this is an abstract base class which is implemented (usually using the information stored in the associated control) by the different controls using wx.HeaderCtrl. As the control only needs to retrieve the information about the column, this class defines only the methods for accessing the various column properties but not for changing them as the setters might not be needed at all, e.g. if the column attributes can only be changed via the methods of the main associated control (this is the case for wx.grid.Grid for example). If you do want to allow changing them directly using the column itself, you should inherit from wx.SettableHeaderColumn instead of this class.

Finally, if you don’t already store the column information at all anywhere, you should use the concrete wx.HeaderColumnSimple class and wx.HeaderCtrlSimple.

Class Hierarchy¶

Inheritance diagram for class HeaderColumn:

Known Subclasses¶

wx.SettableHeaderColumn

Methods Summary¶

`GetAlignment`	Returns the current column alignment.
`GetBitmap`	This function exists only for backwards compatibility, it’s recommended to override `GetBitmapBundle` in the new code and override this one to do nothing, as it will never be called if `GetBitmapBundle` is overridden.
`GetBitmapBundle`	Returns the bitmap in the header of the column, if any.
`GetFlags`	Get the column flags.
`GetMinWidth`	Return the minimal column width.
`GetTitle`	Get the text shown in the column header.
`GetWidth`	Returns the current width of the column.
`HasFlag`	Return `True` if the specified flag is currently set for this column.
`IsHidden`	Returns `True` if the column is currently hidden.
`IsReorderable`	Returns `True` if the column can be dragged by user to change its order.
`IsResizeable`	Return `True` if the column can be resized by the user.
`IsShown`	Returns `True` if the column is currently shown.
`IsSortKey`	Returns `True` if the column is currently used for sorting.
`IsSortOrderAscending`	Returns `True`, if the sort order is ascending.
`IsSortable`	Returns `True` if the column can be clicked by user to sort the control contents by the field in this column.

Properties Summary¶

`Alignment`	See `GetAlignment`
`Bitmap`	See `GetBitmap`
`BitmapBundle`	See `GetBitmapBundle`
`Flags`	See `GetFlags`
`Hidden`	See `IsHidden`
`MinWidth`	See `GetMinWidth`
`Reorderable`	See `IsReorderable`
`Resizeable`	See `IsResizeable`
`Shown`	See `IsShown`
`SortKey`	See `IsSortKey`
`SortOrderAscending`	See `IsSortOrderAscending`
`Sortable`	See `IsSortable`
`Title`	See `GetTitle`
`Width`	See `GetWidth`

Class API¶

class wx.HeaderColumn(object)¶

Represents a column header in controls displaying tabular data such as DataViewCtrl or Grid.

Methods¶

GetAlignment(self)¶

Returns the current column alignment.

Return type:: wx.Alignment
Returns:: One of wx.ALIGN_CENTRE, wx.ALIGN_LEFT or wx.ALIGN_RIGHT.

GetBitmap(self)¶

This function exists only for backwards compatibility, it’s recommended to override GetBitmapBundle in the new code and override this one to do nothing, as it will never be called if GetBitmapBundle is overridden.

Return type:: wx.Bitmap

GetBitmapBundle(self)¶

Returns the bitmap in the header of the column, if any.

If the column has no associated bitmap, empty wx.BitmapBundle should be returned.

Override this function to return the bundle containing the bitmap to show in the column header. By default delegates to GetBitmap but should be overridden if the bitmaps are used.

Return type:: wx.BitmapBundle

Added in version 4.1/wxWidgets-3.1.6.

GetFlags(self)¶

Get the column flags.

This method retrieves all the flags at once, you can also use HasFlag to test for any individual flag or IsResizeable , IsSortable , IsReorderable and IsHidden to test for particular flags.

Return type:: int

GetMinWidth(self)¶

Return the minimal column width.

Return type:: int
Returns:: The minimal width such that the user can’t resize the column to lesser size (notice that it is still possible to set the column width to smaller value from the program code). Return 0 from here to allow resizing the column to arbitrarily small size.

GetTitle(self)¶

Get the text shown in the column header.