document wxDataViewItem

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@48355 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling
2007-08-24 09:42:28 +00:00
parent f5f688eddd
commit 4f76c1a23a
3 changed files with 58 additions and 0 deletions

View File

@@ -86,6 +86,7 @@
\input dataviewmodelnotifier.tex \input dataviewmodelnotifier.tex
\input dataviewmodel.tex \input dataviewmodel.tex
\input dataviewindexlistmodel.tex \input dataviewindexlistmodel.tex
\input dataviewitem.tex
\input dataviewrenderer.tex \input dataviewrenderer.tex
\input dobjcomp.tex \input dobjcomp.tex
\input dobjsmpl.tex \input dobjsmpl.tex

View File

@@ -4,6 +4,9 @@
wxDataViewCtrl is a control to display data either wxDataViewCtrl is a control to display data either
in a tree like fashion or in a tabular form or both. in a tree like fashion or in a tabular form or both.
A \helpref{wxDataViewItem}{wxdataviewitem} is used
to represent a (visible) item in the control.
Unlike \helpref{wxListCtrl}{wxlistctrl} wxDataViewCtrl doesn't Unlike \helpref{wxListCtrl}{wxlistctrl} wxDataViewCtrl doesn't
get its data from the user through virtual functions or by get its data from the user through virtual functions or by
setting it directly. Instead you need to write your own setting it directly. Instead you need to write your own

View File

@@ -0,0 +1,54 @@
\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*}.