[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 etc.

\wxheading{Derived from}

No base class

\wxheading{Include files}

<dataview.h>

\wxheading{Data structures}

\latexignore{\rtfignore{\wxheading{Members}}}


\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
	14	to indicate that e.g. no item was found etc.
	15
	16	\wxheading{Derived from}
	17
	18	No base class
	19
	20	\wxheading{Include files}
	21
	22	<dataview.h>
	23
	24	\wxheading{Data structures}
	25
	26	\latexignore{\rtfignore{\wxheading{Members}}}
	27
	28
	29	\membersection{wxDataViewItem::wxDataViewItem}\label{wxdataviewitemwxdataviewitem}
	30
	31	\func{}{wxDataViewItem}{\param{void* }{id = NULL}}
	32
	33	Constructor.
	34
	35	\func{}{wxDataViewItem}{\param{const wxDataViewItem\& }{item}}
	36
	37
	38	\membersection{wxDataViewItem::GetID}\label{wxdataviewitemgetid}
	39
	40	\constfunc{void*}{GetID}{\void}
	41
	42	Returns the ID.
	43
	44	\membersection{wxDataViewItem::IsOk}\label{wxdataviewitemisok}
	45
	46	\constfunc{bool}{IsOk}{\void}
	47
	48	Returns true if the ID is not {\it NULL}.
	49
	50	\membersection{wxDataViewItem::void}\label{wxdataviewitemvoid}
	51
	52	\constfunc{operator const}{void*}{\void}
	53
	54	Converts to {\it void*}.