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


\section{\class{wxDataViewItem}}\label{wxdataviewitem}

wxDataViewItem is a small opaque class that represents an
item in a \helpref{wxDataViewCtrl}{wxdataviewctrl} in a
persistent way, i.e. indepent of the position of the
item in the control or changes to its contents. It must
hold a unique ID of type {\it void*} in its only field
and can be converted to a from it. 

If the ID is {\it NULL} the wxDataViewItem is invalid and 
\helpref{IsOk}{wxdataviewitemisok} will return {\it false}
which used in many places in the API of wxDataViewCtrl
to indicate that e.g. no item was found. An ID of NULL
is also used to indicate the invisible root. Examples
for this are
\helpref{wxDataViewModel::GetParent}{wxdataviewmodelgetparent} and
\helpref{wxDataViewModel::GetChildren}{wxdataviewmodelgetchildren}.


\wxheading{Derived from}

No base class

\wxheading{Include files}

<dataview.h>

\wxheading{Library}

\helpref{wxAdv}{librarieslist}


\membersection{wxDataViewItem::wxDataViewItem}\label{wxdataviewitemwxdataviewitem}

\func{}{wxDataViewItem}{\param{void* }{id = NULL}}

Constructor.

\func{}{wxDataViewItem}{\param{const wxDataViewItem\& }{item}}


\membersection{wxDataViewItem::GetID}\label{wxdataviewitemgetid}

\constfunc{void*}{GetID}{\void}

Returns the ID.

\membersection{wxDataViewItem::IsOk}\label{wxdataviewitemisok}

\constfunc{bool}{IsOk}{\void}

Returns true if the ID is not {\it NULL}.

\membersection{wxDataViewItem::void*}\label{wxdataviewitemvoid}

\constfunc{operator const}{void*}{\void}

Converts to {\it void*}.
Commit	Line	Data
4f76c1a2 RR	1
	2	\section{\class{wxDataViewItem}}\label{wxdataviewitem}
	3
	4	wxDataViewItem is a small opaque class that represents an
	5	item in a \helpref{wxDataViewCtrl}{wxdataviewctrl} in a
	6	persistent way, i.e. indepent of the position of the
	7	item in the control or changes to its contents. It must
	8	hold a unique ID of type {\it void*} in its only field
	9	and can be converted to a from it.
	10
	11	If the ID is {\it NULL} the wxDataViewItem is invalid and
	12	\helpref{IsOk}{wxdataviewitemisok} will return {\it false}
	13	which used in many places in the API of wxDataViewCtrl
9743a449 RR	14	to indicate that e.g. no item was found. An ID of NULL
	15	is also used to indicate the invisible root. Examples
	16	for this are
	17	\helpref{wxDataViewModel::GetParent}{wxdataviewmodelgetparent} and
	18	\helpref{wxDataViewModel::GetChildren}{wxdataviewmodelgetchildren}.
	19
4f76c1a2 RR	20
	21	\wxheading{Derived from}
	22
	23	No base class
	24
	25	\wxheading{Include files}
	26
	27	<dataview.h>
	28
9743a449	29	\wxheading{Library}
4f76c1a2	30
9743a449	31	\helpref{wxAdv}{librarieslist}
4f76c1a2 RR	32
	33
	34	\membersection{wxDataViewItem::wxDataViewItem}\label{wxdataviewitemwxdataviewitem}
	35
	36	\func{}{wxDataViewItem}{\param{void* }{id = NULL}}
	37
	38	Constructor.
	39
	40	\func{}{wxDataViewItem}{\param{const wxDataViewItem\& }{item}}
	41
	42
	43	\membersection{wxDataViewItem::GetID}\label{wxdataviewitemgetid}
	44
	45	\constfunc{void*}{GetID}{\void}
	46
	47	Returns the ID.
	48
	49	\membersection{wxDataViewItem::IsOk}\label{wxdataviewitemisok}
	50
	51	\constfunc{bool}{IsOk}{\void}
	52
	53	Returns true if the ID is not {\it NULL}.
	54
5bad300d	55	\membersection{wxDataViewItem::void*}\label{wxdataviewitemvoid}
4f76c1a2 RR	56
	57	\constfunc{operator const}{void*}{\void}
	58
	59	Converts to {\it void*}.