Version: 3.0.4
wxDataViewColumn Class Reference

#include <wx/dataview.h>

+ Inheritance diagram for wxDataViewColumn:

Detailed Description

This class represents a column in a wxDataViewCtrl.

One wxDataViewColumn is bound to one column in the data model to which the wxDataViewCtrl has been associated.

An instance of wxDataViewRenderer is used by this class to render its data.

Library:  wxAdvanced
Category:  wxDataViewCtrl Related Classes

Public Member Functions

 wxDataViewColumn (const wxString &title, wxDataViewRenderer *renderer, unsigned int model_column, int width=wxDVC_DEFAULT_WIDTH, wxAlignment align=wxALIGN_CENTER, int flags=wxDATAVIEW_COL_RESIZABLE)
 Constructs a text column. More...
 
 wxDataViewColumn (const wxBitmap &bitmap, wxDataViewRenderer *renderer, unsigned int model_column, int width=wxDVC_DEFAULT_WIDTH, wxAlignment align=wxALIGN_CENTER, int flags=wxDATAVIEW_COL_RESIZABLE)
 Constructs a bitmap column. More...
 
unsigned int GetModelColumn () const
 Returns the index of the column of the model, which this wxDataViewColumn is displaying. More...
 
wxDataViewCtrlGetOwner () const
 Returns the owning wxDataViewCtrl. More...
 
wxDataViewRendererGetRenderer () const
 Returns the renderer of this wxDataViewColumn. More...
 
- Public Member Functions inherited from wxSettableHeaderColumn
virtual void SetTitle (const wxString &title)=0
 Set the text to display in the column header. More...
 
virtual void SetBitmap (const wxBitmap &bitmap)=0
 Set the bitmap to be displayed in the column header. More...
 
virtual void SetWidth (int width)=0
 Set the column width. More...
 
virtual void SetMinWidth (int minWidth)=0
 Set the minimal column width. More...
 
virtual void SetAlignment (wxAlignment align)=0
 Set the alignment of the column header. More...
 
virtual void SetFlags (int flags)=0
 Set the column flags. More...
 
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...
 
virtual void SetSortOrder (bool ascending)=0
 Sets this column as the sort key for the associated control. More...
 
void ToggleSortOrder ()
 Inverses the sort order. More...
 
- Public Member Functions inherited from wxHeaderColumn
virtual wxString GetTitle () const =0
 Get the text shown in the column header. More...
 
virtual wxBitmap GetBitmap () const =0
 Returns the bitmap in the header of the column, if any. More...
 
virtual int GetWidth () const =0
 Returns the current width of the column. More...
 
virtual int GetMinWidth () const =0
 Return the minimal column width. More...
 
virtual wxAlignment GetAlignment () const =0
 Returns the current column alignment. More...
 
virtual int GetFlags () const =0
 Get the column flags. More...
 
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...
 
virtual bool IsSortKey () const =0
 Returns true if the column is currently used for sorting. More...
 
virtual bool IsSortOrderAscending () const =0
 Returns true, if the sort order is ascending. More...
 

Constructor & Destructor Documentation

wxDataViewColumn::wxDataViewColumn ( const wxString title,
wxDataViewRenderer renderer,
unsigned int  model_column,
int  width = wxDVC_DEFAULT_WIDTH,
wxAlignment  align = wxALIGN_CENTER,
int  flags = wxDATAVIEW_COL_RESIZABLE 
)

Constructs a text column.

Parameters
titleThe title of the column.
rendererThe class which will render the contents of this column.
model_columnThe index of the model's column which is associated with this object.
widthThe width of the column. The wxDVC_DEFAULT_WIDTH value is the fixed default value.
alignThe alignment of the column title.
flagsOne or more flags of the wxDataViewColumnFlags enumeration.
wxDataViewColumn::wxDataViewColumn ( const wxBitmap bitmap,
wxDataViewRenderer renderer,
unsigned int  model_column,
int  width = wxDVC_DEFAULT_WIDTH,
wxAlignment  align = wxALIGN_CENTER,
int  flags = wxDATAVIEW_COL_RESIZABLE 
)

Constructs a bitmap column.

Parameters
bitmapThe bitmap of the column.
rendererThe class which will render the contents of this column.
model_columnThe index of the model's column which is associated with this object.
widthThe width of the column. The wxDVC_DEFAULT_WIDTH value is the fixed default value.
alignThe alignment of the column title.
flagsOne or more flags of the wxDataViewColumnFlags enumeration.

Member Function Documentation

unsigned int wxDataViewColumn::GetModelColumn ( ) const

Returns the index of the column of the model, which this wxDataViewColumn is displaying.

wxDataViewCtrl* wxDataViewColumn::GetOwner ( ) const

Returns the owning wxDataViewCtrl.

wxDataViewRenderer* wxDataViewColumn::GetRenderer ( ) const

Returns the renderer of this wxDataViewColumn.

See also
wxDataViewRenderer.