From 4f76c1a23aa65bddf30b536cdd6b4f474328a471 Mon Sep 17 00:00:00 2001
From: Robert Roebling <robert@roebling.de>
Date: Fri, 24 Aug 2007 09:42:28 +0000
Subject: [PATCH] document wxDataViewItem

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@48355 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/classes.tex      |  1 +
 docs/latex/wx/dataviewctrl.tex |  3 ++
 docs/latex/wx/dataviewitem.tex | 54 ++++++++++++++++++++++++++++++++++
 3 files changed, 58 insertions(+)
 create mode 100644 docs/latex/wx/dataviewitem.tex

diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex
index 403e07a9ce..659fb67eec 100644
--- a/docs/latex/wx/classes.tex
+++ b/docs/latex/wx/classes.tex
@@ -86,6 +86,7 @@
 \input dataviewmodelnotifier.tex
 \input dataviewmodel.tex
 \input dataviewindexlistmodel.tex
+\input dataviewitem.tex
 \input dataviewrenderer.tex
 \input dobjcomp.tex
 \input dobjsmpl.tex
diff --git a/docs/latex/wx/dataviewctrl.tex b/docs/latex/wx/dataviewctrl.tex
index f9f99941c5..82dad71c83 100644
--- a/docs/latex/wx/dataviewctrl.tex
+++ b/docs/latex/wx/dataviewctrl.tex
@@ -4,6 +4,9 @@
 wxDataViewCtrl is a control to display data either
 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 
 get its data from the user through virtual functions or by
 setting it directly. Instead you need to write your own 
diff --git a/docs/latex/wx/dataviewitem.tex b/docs/latex/wx/dataviewitem.tex
new file mode 100644
index 0000000000..da269d4d59
--- /dev/null
+++ b/docs/latex/wx/dataviewitem.tex
@@ -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*}.
-- 
2.45.2