wxWidgets/docs/latex/wx/dataviewitem.tex
Robert Roebling 5bad300d22 correct label name
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@48382 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2007-08-25 19:12:26 +00:00

55 lines
1.3 KiB
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*}.