wxWidgets: wxHeaderColumnSimple Class Reference

| Version: 3.0.5

Public Member Functions | List of all members
wxHeaderColumnSimple Class Reference
Class List by Category » Controls

`#include </home/Hamish/wxwidgets/wxWidgets3.0-3.0.5.1-1.src/wxWidgets3.0-3.0.5.1-1.i686/src/wxWidgets-3.0.5.1/interface/wx/headercol.h>`

Inheritance diagram for wxHeaderColumnSimple:
[legend]

## Detailed Description

Simple container for the information about the column.

This is a concrete class implementing all wxSettableHeaderColumn class methods in a trivial way, i.e. by just storing the information in the object itself. It is used by and with wxHeaderCtrlSimple, e.g.

wxHeaderCtrlSimple * header = new wxHeaderCtrlSimple(...);
wxHeaderColumnSimple col("Title");
col.SetWidth(100);
col.SetSortable(100);
header->AppendColumn(col);

##

Library: wxCore

<>< =''>:</>&;&;< =''>\ </></>

## Public Member Functions
| wxHeaderColumnSimple (const wxString &title, int width=wxCOL_WIDTH_DEFAULT, wxAlignment align=wxALIGN_NOT, int flags=wxCOL_DEFAULT_FLAGS)
| Constructor for a column header. More...
| wxHeaderColumnSimple (const wxBitmap &bitmap, int width=wxCOL_WIDTH_DEFAULT, wxAlignment align=wxALIGN_CENTER, int flags=wxCOL_DEFAULT_FLAGS)
virtual void | SetTitle (const wxString &title)
| Trivial implementations of the base class pure virtual functions. More...
virtual wxString | GetTitle () const
| Get the text shown in the column header. More...
virtual void | SetBitmap (const wxBitmap &bitmap)
| Set the bitmap to be displayed in the column header. More...
virtual wxBitmap | GetBitmap () const
| Returns the bitmap in the header of the column, if any. More...
virtual void | SetWidth (int width)
| Set the column width. More...
virtual int | GetWidth () const
| Returns the current width of the column. More...
virtual void | SetMinWidth (int minWidth)
| Set the minimal column width. More...
virtual int | GetMinWidth () const
| Return the minimal column width. More...
virtual void | SetAlignment (wxAlignment align)
| Set the alignment of the column header. More...
virtual wxAlignment | GetAlignment () const
| Returns the current column alignment. More...
virtual void | SetFlags (int flags)
| Set the column flags. More...
virtual int | GetFlags () const
| Get the column flags. More...
virtual bool | IsSortKey () const
| Returns true if the column is currently used for sorting. More...
virtual void | SetSortOrder (bool ascending)
| Sets this column as the sort key for the associated control. More...
virtual bool | IsSortOrderAscending () const
| Returns true, if the sort order is ascending. More...
Public Member Functions inherited from wxSettableHeaderColumn
void | ChangeFlag (int flag, bool set)
| Set or clear the given flag. More...
void | SetFlag (int flag)
| Set the specified flag for the column. More...
void | ClearFlag (int flag)
| Clear the specified flag for the column. More...
void | ToggleFlag (int flag)
| Toggle the specified flag for the column. More...
virtual void | SetResizeable (bool resizable)
| Call this to enable or disable interactive resizing of the column by the user. More...
virtual void | SetSortable (bool sortable)
| Allow clicking the column to sort the control contents by the field in this column. More...
virtual void | SetReorderable (bool reorderable)
| Allow changing the column order by dragging it. More...
virtual void | SetHidden (bool hidden)
| Hide or show the column. More...
void | UnsetAsSortKey ()
| Don't use this column for sorting. More...
void | ToggleSortOrder ()
| Inverses the sort order. More...
Public Member Functions inherited from wxHeaderColumn
bool | HasFlag (int flag) const
| Return true if the specified flag is currently set for this column. More...
virtual bool | IsResizeable () const
| Return true if the column can be resized by the user. More...
virtual bool | IsSortable () const
| Returns true if the column can be clicked by user to sort the control contents by the field in this column. More...
virtual bool | IsReorderable () const
| Returns true if the column can be dragged by user to change its order. More...
virtual bool | IsHidden () const
| Returns true if the column is currently hidden. More...
bool | IsShown () const
| Returns true if the column is currently shown. More...

## Constructor & Destructor Documentation

## ◆ wxHeaderColumnSimple() [1/2]

wxHeaderColumnSimple::wxHeaderColumnSimple | ( | const wxString & | title,
|  | int | width = `wxCOL_WIDTH_DEFAULT`,
|  | wxAlignment | align = `wxALIGN_NOT`,
|  | int | flags = `wxCOL_DEFAULT_FLAGS`
| ) |  |

Constructor for a column header.

The first constructor creates a header showing the given text title while the second one creates one showing the specified bitmap image.

## ◆ wxHeaderColumnSimple() [2/2]

wxHeaderColumnSimple::wxHeaderColumnSimple | ( | const wxBitmap & | bitmap,
|  | int | width = `wxCOL_WIDTH_DEFAULT`,
|  | wxAlignment | align = `wxALIGN_CENTER`,
|  | int | flags = `wxCOL_DEFAULT_FLAGS`
| ) |  |

## Member Function Documentation

## ◆ GetAlignment()

virtual wxAlignment wxHeaderColumnSimple::GetAlignment | ( |  | ) | const
| virtual

Returns the current column alignment.

Returns
  One of wxALIGN_CENTRE, wxALIGN_LEFT or wxALIGN_RIGHT.

Implements wxHeaderColumn.

## ◆ GetBitmap()

virtual wxBitmap wxHeaderColumnSimple::GetBitmap | ( |  | ) | const
| virtual

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

If the column has no associated bitmap, wxNullBitmap should be returned.

Implements wxHeaderColumn.

## ◆ GetFlags()

virtual int wxHeaderColumnSimple::GetFlags | ( |  | ) | const
| virtual

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.

Implements wxHeaderColumn.

## ◆ GetMinWidth()

virtual int wxHeaderColumnSimple::GetMinWidth | ( |  | ) | const
| virtual

Return the minimal column width.

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.

Implements wxHeaderColumn.

## ◆ GetTitle()

virtual wxString wxHeaderColumnSimple::GetTitle | ( |  | ) | const
| virtual

Get the text shown in the column header.

Implements wxHeaderColumn.

## ◆ GetWidth()

virtual int wxHeaderColumnSimple::GetWidth | ( |  | ) | const
| virtual

Returns the current width of the column.

Returns
  Width of the column in pixels, never wxCOL_WIDTH_DEFAULT or wxCOL_WIDTH_AUTOSIZE.

Implements wxHeaderColumn.

## ◆ IsSortKey()

virtual bool wxHeaderColumnSimple::IsSortKey | ( |  | ) | const
| virtual

Returns true if the column is currently used for sorting.

Implements wxHeaderColumn.

## ◆ IsSortOrderAscending()

virtual bool wxHeaderColumnSimple::IsSortOrderAscending | ( |  | ) | const
| virtual

Returns true, if the sort order is ascending.

Notice that it only makes sense to call this function if the column is used for sorting at all, i.e. if IsSortKey() returns true.

Implements wxHeaderColumn.

## ◆ SetAlignment()

virtual void wxHeaderColumnSimple::SetAlignment | ( | wxAlignment | align | ) |
| virtual

Set the alignment of the column header.

Parameters

  align | The text alignment in horizontal direction only or wxALIGN_NOT to use the default alignment, The possible values here are wxALIGN_CENTRE, wxALIGN_LEFT or wxALIGN_RIGHT with wxALIGN_CENTRE_HORIZONTAL being also supported as synonym for wxALIGN_CENTRE for consistency (but notice that GetAlignment() never returns it).

Implements wxSettableHeaderColumn.

## ◆ SetBitmap()

virtual void wxHeaderColumnSimple::SetBitmap | ( | const wxBitmap & | bitmap | ) |
| virtual

Set the bitmap to be displayed in the column header.

Notice that the bitmaps displayed in different columns of the same control must all be of the same size.

Implements wxSettableHeaderColumn.

## ◆ SetFlags()

virtual void wxHeaderColumnSimple::SetFlags | ( | int | flags | ) |
| virtual

Set the column flags.

This method allows setting all flags at once, see also generic ChangeFlag(), SetFlag(), ClearFlag() and ToggleFlag() methods below as well as specific SetResizeable(), SetSortable(), SetReorderable() and SetHidden() ones.

Parameters

  flags | Combination of wxCOL_RESIZABLE, wxCOL_SORTABLE, wxCOL_REORDERABLE and wxCOL_HIDDEN bit flags.

Implements wxSettableHeaderColumn.

## ◆ SetMinWidth()

virtual void wxHeaderColumnSimple::SetMinWidth | ( | int | minWidth | ) |
| virtual

Set the minimal column width.

This method can be used with resizable columns (i.e. those for which wxCOL_RESIZABLE flag is set in GetFlags() or, alternatively, IsResizeable() returns true) to prevent the user from making them narrower than the given width.

Parameters

  minWidth | The minimal column width in pixels, may be 0 to remove any previously set restrictions.

Implements wxSettableHeaderColumn.

## ◆ SetSortOrder()

virtual void wxHeaderColumnSimple::SetSortOrder | ( | bool | ascending | ) |
| virtual

Sets this column as the sort key for the associated control.

This function indicates that this column is currently used for sorting the control and also sets the sorting direction. Notice that actual sorting is only done in the control associated with the header, this function doesn't do any sorting on its own.

Don't confuse this function with SetSortable() which should be used to indicate that the column may be used for sorting while this one is used to indicate that it currently is used for sorting. Of course, SetSortOrder() can be only called for sortable columns.

Parameters

  ascending | If true, sort in ascending order, otherwise in descending order.

Implements wxSettableHeaderColumn.

## ◆ SetTitle()

virtual void wxHeaderColumnSimple::SetTitle | ( | const wxString & | title | ) |
| virtual

Trivial implementations of the base class pure virtual functions.

Implements wxSettableHeaderColumn.

## ◆ SetWidth()

virtual void wxHeaderColumnSimple::SetWidth | ( | int | width | ) |
| virtual

Set the column width.

Parameters

  width | The column width in pixels or the special wxCOL_WIDTH_DEFAULT (meaning to use default width) or wxCOL_WIDTH_AUTOSIZE (size to fit the content) value.

Implements wxSettableHeaderColumn.

wxHeaderColumnSimple
Simple container for the information about the column.
Definition: headercol.h:398
wxHeaderCtrlSimple::AppendColumn
void AppendColumn(const wxHeaderColumnSimple &col)
Append the column to the end of the control.
wxHeaderCtrlSimple
wxHeaderCtrlSimple is a concrete header control which can be used directly, without inheriting from i...
Definition: headerctrl.h:544