[wxWidgets.git] / docs / latex / wx / dataviewcolumn.tex


\section{\class{wxDataViewColumn}}\label{wxdataviewcolumn}


This class represents a column in a \helpref{wxDataViewCtrl}{wxdataviewctrl}.
One wxDataViewColumn is bound to one column in the data model,
to which the wxDataViewCtrl has been associated. 

An instance of \helpref{wxDataViewRenderer}{wxdataviewrenderer} is used by
this class to render its data.

\wxheading{Constants}

These flags define behavi

{\small
\begin{verbatim}
enum wxDataViewColumnFlags
{
    wxDATAVIEW_COL_RESIZABLE  = 1,    // the user can resize the column
    wxDATAVIEW_COL_SORTABLE   = 2,    // same as SetSortable()
    wxDATAVIEW_COL_HIDDEN     = 4     // column is hidden
};
\end{verbatim}
}

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/dataview.h>

\wxheading{Library}

\helpref{wxAdv}{librarieslist}


\membersection{wxDataViewColumn::wxDataViewColumn}\label{wxdataviewcolumnwxdataviewcolumn}

\func{}{wxDataViewColumn}{\param{const wxString\& }{title}, \param{wxDataViewRenderer* }{renderer}, \param{unsigned int }{model\_column}, \param{int }{width = 80}, \param{int }{flags = wxDATAVIEW\_COL\_RESIZABLE}}


\func{}{wxDataViewColumn}{\param{const wxBitmap\& }{bitmap}, \param{wxDataViewRenderer* }{renderer}, \param{unsigned int }{model\_column}, \param{int }{width = 80}, \param{int }{flags = wxDATAVIEW\_COL\_RESIZABLE}}

Constructors.


\membersection{wxDataViewColumn::\destruct{wxDataViewColumn}}\label{wxdataviewcolumndtor}

\func{}{\destruct{wxDataViewColumn}}{\void}

Destructor.

\membersection{wxDataViewColumn::GetBitmap}\label{wxdataviewcolumngetbitmap}

\func{const wxBitmap\&}{GetBitmap}{\void}

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

\membersection{wxDataViewColumn::GetModelColumn}\label{wxdataviewcolumngetmodelcolumn}

\func{unsigned int}{GetModelColumn}{\void}

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

\membersection{wxDataViewColumn::GetOwner}\label{wxdataviewcolumngetowner}

\func{wxDataViewCtrl*}{GetOwner}{\void}

Returns the owning \helpref{wxDataViewCtrl}{wxdataviewctrl}.

\membersection{wxDataViewColumn::GetRenderer}\label{wxdataviewcolumngetrenderer}

\func{wxDataViewRenderer*}{GetRenderer}{\void}

Returns the renderer of this wxDataViewColumn.

See also \helpref{wxDataViewRenderer}{wxdataviewrenderer}.

\membersection{wxDataViewColumn::GetSortable}\label{wxdataviewcolumngetsortable}

\func{bool}{GetSortable}{\void}

Returns true if the column is sortable.

See \helpref{SetSortable}{wxdataviewcolumnsetsortable}

\membersection{wxDataViewColumn::GetWidth}\label{wxdataviewcolumngetwidth}

\func{int}{GetWidth}{\void}

Returns the width of the column.

\membersection{wxDataViewColumn::IsSortOrderAscending}\label{wxdataviewcolumnissortorderascending}

\func{bool}{IsSortOrderAscending}{\void}

Returns true, if the sort order is ascending.

See also \helpref{SetSortOrder}{wxdataviewcolumnsetsortorder}

\membersection{wxDataViewColumn::SetAlignment}\label{wxdataviewcolumnsetalignment}

\func{void}{SetAlignment}{\param{wxAlignment }{align}}

Set the alignment of the column header.

\membersection{wxDataViewColumn::SetBitmap}\label{wxdataviewcolumnsetbitmap}

\func{void}{SetBitmap}{\param{const wxBitmap\& }{bitmap}}

Set the bitmap of the column header.

\membersection{wxDataViewColumn::SetSortOrder}\label{wxdataviewcolumnsetsortorder}

\func{void}{SetSortOrder}{\param{bool }{ascending}}

Indicate the sort order if the implementation of the
wxDataViewCtrl supports it, most commonly by showing
a little arrow. Use this in conjunction with 
\helpref{wxDataViewSortedListModel::SetAscending}{wxdataviewsortedlistmodelsetascending}
to sort the actual data.

\membersection{wxDataViewColumn::SetSortable}\label{wxdataviewcolumnsetsortable}

\func{void}{SetSortable}{\param{bool }{sortable}}

Indicate that the column is sortable. This is only to provide a
visual hint in the column (such as a sort order indicator). It
will not actually sort the data. Use a 
\helpref{wxDataViewSortedListModel}{wxdataviewsortedlistmodel}
to so the sorting.

\membersection{wxDataViewColumn::SetTitle}\label{wxdataviewcolumnsettitle}

\func{void}{SetTitle}{\param{const wxString\& }{title}}

Set the title of the column header to {\it title}.
Commit	Line	Data
b6b9d556 RR	1
	2	\section{\class{wxDataViewColumn}}\label{wxdataviewcolumn}
	3
	4
	5	This class represents a column in a \helpref{wxDataViewCtrl}{wxdataviewctrl}.
	6	One wxDataViewColumn is bound to one column in the data model,
	7	to which the wxDataViewCtrl has been associated.
	8
	9	An instance of \helpref{wxDataViewRenderer}{wxdataviewrenderer} is used by
	10	this class to render its data.
	11
	12	\wxheading{Constants}
	13
	14	These flags define behavi
	15
	16	{\small
	17	\begin{verbatim}
	18	enum wxDataViewColumnFlags
	19	{
	20	wxDATAVIEW_COL_RESIZABLE = 1, // the user can resize the column
	21	wxDATAVIEW_COL_SORTABLE = 2, // same as SetSortable()
	22	wxDATAVIEW_COL_HIDDEN = 4 // column is hidden
	23	};
	24	\end{verbatim}
	25	}
	26
	27	\wxheading{Derived from}
	28
	29	\helpref{wxObject}{wxobject}
	30
	31	\wxheading{Include files}
	32
	33	<wx/dataview.h>
	34
a7af285d VZ	35	\wxheading{Library}
	36
	37	\helpref{wxAdv}{librarieslist}
	38
b6b9d556 RR	39
	40	\membersection{wxDataViewColumn::wxDataViewColumn}\label{wxdataviewcolumnwxdataviewcolumn}
	41
	42	\func{}{wxDataViewColumn}{\param{const wxString\& }{title}, \param{wxDataViewRenderer* }{renderer}, \param{unsigned int }{model\_column}, \param{int }{width = 80}, \param{int }{flags = wxDATAVIEW\_COL\_RESIZABLE}}
	43
	44
	45	\func{}{wxDataViewColumn}{\param{const wxBitmap\& }{bitmap}, \param{wxDataViewRenderer* }{renderer}, \param{unsigned int }{model\_column}, \param{int }{width = 80}, \param{int }{flags = wxDATAVIEW\_COL\_RESIZABLE}}
	46
	47	Constructors.
	48
	49
	50	\membersection{wxDataViewColumn::\destruct{wxDataViewColumn}}\label{wxdataviewcolumndtor}
	51
	52	\func{}{\destruct{wxDataViewColumn}}{\void}
	53
	54	Destructor.
	55
	56	\membersection{wxDataViewColumn::GetBitmap}\label{wxdataviewcolumngetbitmap}
	57
	58	\func{const wxBitmap\&}{GetBitmap}{\void}
	59
	60	Returns the bitmap in the header of the column, if any.
	61
	62	\membersection{wxDataViewColumn::GetModelColumn}\label{wxdataviewcolumngetmodelcolumn}
	63
	64	\func{unsigned int}{GetModelColumn}{\void}
	65
	66	Returns the index of the column of the model, which this
	67	wxDataViewColumn is displaying.
	68
	69	\membersection{wxDataViewColumn::GetOwner}\label{wxdataviewcolumngetowner}
	70
	71	\func{wxDataViewCtrl*}{GetOwner}{\void}
	72
	73	Returns the owning \helpref{wxDataViewCtrl}{wxdataviewctrl}.
	74
	75	\membersection{wxDataViewColumn::GetRenderer}\label{wxdataviewcolumngetrenderer}
	76
	77	\func{wxDataViewRenderer*}{GetRenderer}{\void}
	78
	79	Returns the renderer of this wxDataViewColumn.
	80
	81	See also \helpref{wxDataViewRenderer}{wxdataviewrenderer}.
	82
	83	\membersection{wxDataViewColumn::GetSortable}\label{wxdataviewcolumngetsortable}
	84
	85	\func{bool}{GetSortable}{\void}
	86
	87	Returns true if the column is sortable.
	88
	89	See \helpref{SetSortable}{wxdataviewcolumnsetsortable}
	90
	91	\membersection{wxDataViewColumn::GetWidth}\label{wxdataviewcolumngetwidth}
	92
	93	\func{int}{GetWidth}{\void}
	94
	95	Returns the width of the column.
	96
	97	\membersection{wxDataViewColumn::IsSortOrderAscending}\label{wxdataviewcolumnissortorderascending}
	98
	99	\func{bool}{IsSortOrderAscending}{\void}
	100
	101	Returns true, if the sort order is ascending.
	102
103	See also \helpref{SetSortOrder}{wxdataviewcolumnsetsortorder}
104
105	\membersection{wxDataViewColumn::SetAlignment}\label{wxdataviewcolumnsetalignment}
106
107	\func{void}{SetAlignment}{\param{wxAlignment }{align}}
108
109	Set the alignment of the column header.
110
111	\membersection{wxDataViewColumn::SetBitmap}\label{wxdataviewcolumnsetbitmap}
112
113	\func{void}{SetBitmap}{\param{const wxBitmap\& }{bitmap}}
114
115	Set the bitmap of the column header.
116
117	\membersection{wxDataViewColumn::SetSortOrder}\label{wxdataviewcolumnsetsortorder}
118
119	\func{void}{SetSortOrder}{\param{bool }{ascending}}
120
121	Indicate the sort order if the implementation of the
122	wxDataViewCtrl supports it, most commonly by showing
123	a little arrow. Use this in conjunction with
124	\helpref{wxDataViewSortedListModel::SetAscending}{wxdataviewsortedlistmodelsetascending}
125	to sort the actual data.
126
127	\membersection{wxDataViewColumn::SetSortable}\label{wxdataviewcolumnsetsortable}
128
129	\func{void}{SetSortable}{\param{bool }{sortable}}
130
131	Indicate that the column is sortable. This is only to provide a
132	visual hint in the column (such as a sort order indicator). It
133	will not actually sort the data. Use a
134	\helpref{wxDataViewSortedListModel}{wxdataviewsortedlistmodel}
135	to so the sorting.
136
137	\membersection{wxDataViewColumn::SetTitle}\label{wxdataviewcolumnsettitle}
138
139	\func{void}{SetTitle}{\param{const wxString\& }{title}}
140
141	Set the title of the column header to {\it title}.
142