documented 2nd prototype of wxListCtrl::SetItem

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

diff --git a/docs/latex/wx/custdobj.tex b/docs/latex/wx/custdobj.tex
index d53cab7ef703828e0da4d3d2e916d0225ab9a804..2f2a71043ebc6d6f18fc22e4784f4f31b3018282 100644 (file)
--- a/docs/latex/wx/custdobj.tex
+++ b/docs/latex/wx/custdobj.tex
@@ -1,6 +1,6 @@
 \section{\class{wxCustomDataObject}}\label{wxcustomdataobject}
 
-wxCustomDataObject is a specialization of 
+wxCustomDataObject is a specialization of
 \helpref{wxDataObjectSimple}{wxdataobjectsimple} for some
 application-specific data in arbitrary (either custom or one of the standard
 ones). The only restriction is that it is supposed that this data can be
@@ -8,8 +8,8 @@ copied bitwise (i.e. with {\tt memcpy()}), so it would be a bad idea to make
 it contain a C++ object (though C struct is fine).
 
 By default, wxCustomDataObject stores the data inside in a buffer. To put the
-data into the buffer you may use either 
-\helpref{SetData}{wxcustomdataobjectsetdata} or 
+data into the buffer you may use either
+\helpref{SetData}{wxcustomdataobjectsetdata} or
 \helpref{TakeData}{wxcustomdataobjecttakedata} depending on whether you want
 the object to make a copy of data or not.
 
@@ -20,15 +20,15 @@ the virtual functions mentioned below.
 \wxheading{Virtual functions to override}
 
 This class may be used as is, but if you don't want store the data inside the
-object but provide it on demand instead, you should override 
+object but provide it on demand instead, you should override
 \helpref{GetSize}{wxcustomdataobjectgetsize},
-\helpref{GetData}{wxcustomdataobjectgetdata} and 
+\helpref{GetData}{wxcustomdataobjectgetdata} and
 \helpref{SetData}{wxcustomdataobjectsetdata} (or may be only the first two or
 only the last one if you only allow reading/writing the data)
 
 \wxheading{Derived from}
 
-\helpref{wxDataObjectSimple}{wxdataobjectsimple}
+\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
 \helpref{wxDataObject}{wxdataobject}
 
 \wxheading{Include files}
@@ -46,7 +46,7 @@ only the last one if you only allow reading/writing the data)
 \func{}{wxCustomDataObject}{\param{const wxDataFormat\& }{format = wxFormatInvalid}}
 
 The constructor accepts a {\it format} argument which specifies the (single)
-format supported by this object. If it isn't set here, 
+format supported by this object. If it isn't set here,
 \helpref{SetFormat}{wxdataobjectsimplesetformat} should be used.
 
 \membersection{wxCustomDataObject::\destruct{wxCustomDataObject}}\label{wxcustomdataobjectdtor}
@@ -69,11 +69,14 @@ The default version just uses the operator new.
 
 \membersection{wxCustomDataObject::Free}\label{wxcustomdataobjectfree}
 
+\pythonnote{This method expects a string in wxPython.  You can pass
+nearly any object by pickling it first.}
+
 \func{virtual void}{Free}{\void}
 
 This function is called when the data is freed, you may override it to anything
 you want (or may be nothing at all). The default version calls operator
-delete\[\] on the data.
+delete$[]$ on the data.
 
 \membersection{wxCustomDataObject::GetSize}\label{wxcustomdataobjectgetsize}
 
@@ -90,18 +93,15 @@ Returns a pointer to the data.
 \membersection{wxCustomDataObject::SetData}\label{wxcustomdataobjectsetdata}
 
 \func{virtual void}{SetData}{
-    \param{size\_t }{size},
-    \param{const void }{*data}
-}
+ \param{size\_t }{size}, \param{const void }{*data}}
 
 Set the data. The data object will make an internal copy.
 
 \membersection{wxCustomDataObject::TakeData}\label{wxcustomdataobjecttakedata}
 
 \func{virtual void}{TakeData}{
-    \param{size\_t }{size},
-    \param{const void }{*data}
-}
+ \param{size\_t }{size}, \param{const void }{*data}}
 
 Like \helpref{SetData}{wxcustomdataobjectsetdata}, but doesn't copy the data -
 instead the object takes ownership of the pointer.
+