git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	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. 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
	20
	21	\wxheading{Derived from}
	22
	23	No base class
	24
	25	\wxheading{Include files}
	26
	27	<dataview.h>
	28
	29	\wxheading{Library}
	30
	31	\helpref{wxAdv}{librarieslist}
	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
	55	\membersection{wxDataViewItem::void*}\label{wxdataviewitemvoid}
	56
	57	\constfunc{operator const}{void*}{\void}
	58
	59	Converts to {\it void*}.