Doc updates.

[wxWidgets.git] / docs / latex / wx / prvdatob.tex

diff --git a/docs/latex/wx/prvdatob.tex b/docs/latex/wx/prvdatob.tex
index 43892a08f0aabec7af0d4825a551aea1d3868a01..9b4542f50ec0b847f6d669adc3becbcf1f97686b 100644 (file)
--- a/docs/latex/wx/prvdatob.tex
+++ b/docs/latex/wx/prvdatob.tex
@@ -1,54 +1,79 @@
-automatically generated by HelpGen from privatedataobject.tex at 13/Jan/99 12:50:12
 \section{\class{wxPrivateDataObject}}\label{wxprivatedataobject}
 
-
- ----------------------------------------------------------------------------
- wxPrivateDataObject is a specialization of wxDataObject for app specific data
- ----------------------------------------------------------------------------
+wxPrivateDataObject is a specialization of wxDataObject for application-specific or standard
+format data. The format of the data contained in an instance of this class must be identified
+with a string literal corresponding to the mime-type of the data. Typically this would be
+"image/png" or "text/html" or "application/word".
 
 \wxheading{Derived from}
 
 \helpref{wxDataObject}{wxdataobject}
 
-\wxheading{Data structures}
+\wxheading{Include files}
+
+<wx/dataobj.h>
+
+\wxheading{See also}
+
+\helpref{wxDataObject}{wxdataobject}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxPrivateDataObject::wxPrivateDataObject}\label{wxprivatedataobjectwxprivatedataobject}
 
-\constfunc{virtual }{wxPrivateDataObject}{\void}
+\func{}{wxPrivateDataObject}{\void}
 
 \membersection{wxPrivateDataObject::\destruct{wxPrivateDataObject}}\label{wxprivatedataobjectdtor}
 
-\constfunc{virtual }{\destruct{wxPrivateDataObject}}{\void}
-
-\membersection{wxPrivateDataObject::GetFormat}\label{wxprivatedataobjectgetformat}
-
-\constfunc{virtual wxDataFormat}{GetFormat}{\void}
+\func{}{\destruct{wxPrivateDataObject}}{\void}
 
 \membersection{wxPrivateDataObject::SetId}\label{wxprivatedataobjectsetid}
 
-\constfunc{virtual void}{SetId}{\param{const wxString\& }{id}}
+\func{virtual void}{SetId}{\param{const wxString\& }{id}}
 
- the string ID identifies the format of clipboard or DnD data. a word
- processor would e.g. add a wxTextDataObject and a wxPrivateDataObject
- to the clipboard - the latter with the Id "WXWORD\_FORMAT".
+The string ID identifies the format of clipboard or DnD data. A word
+processor would e.g. add a wxTextDataObject and a wxPrivateDataObject
+to the clipboard - the latter with the Id "application/word".
 
 \membersection{wxPrivateDataObject::GetId}\label{wxprivatedataobjectgetid}
 
 \constfunc{virtual wxString}{GetId}{\void}
 
+Returns the ID of the clipboard or DnD data format.
+
 \membersection{wxPrivateDataObject::SetData}\label{wxprivatedataobjectsetdata}
 
-\constfunc{virtual void}{SetData}{\param{const char }{*data}, \param{size\_t }{size}}
+\func{virtual void}{SetData}{\param{const char }{*data}, \param{size\_t }{size}}
 
- will make internal copy
+Set the data. The data object will make an internal copy.
 
-\membersection{wxPrivateDataObject::GetDataSize}\label{wxprivatedataobjectgetdatasize}
+\membersection{wxPrivateDataObject::GetSize}\label{wxprivatedataobjectgetsize}
 
 \constfunc{virtual size\_t}{GetDataSize}{\void}
 
+Returns the data size.
+
 \membersection{wxPrivateDataObject::GetData}\label{wxprivatedataobjectgetdata}
 
-\constfunc{virtual char*}{GetData}{\void}
+\func{virtual char*}{GetData}{\void}
+
+Returns a pointer to the data.
+
+\membersection{wxPrivateDataObject::WriteData}\label{wxprivatedataobjectwritedata}
+
+\constfunc{virtual void}{WriteData}{\param{void}{*dest} }
+
+Write the data owned by this class to {\it dest}. By default, this
+calls \helpref{WriteData}{wxprivatedataobjectwritedata2} with data 
+set using \helpref{SetData}{wxprivatedataobjectsetdata}.
+This can be overridden to provide data on-demand; in this case
+\helpref{WriteData(data,dest)}{wxprivatedataobjectwritedata2} (see below) must be called from
+within the overriding WriteData() method.
+
+\membersection{wxPrivateDataObject::WriteData}\label{wxprivatedataobjectwritedata2}
+
+\constfunc{void}{WriteData}{\param{const char* }{data}, \param{void}{*dest} }
+
+Writes the data {\it data} to {\it dest}. This method must be called
+from \helpref{WriteData}{wxprivatedataobjectwritedata}.