]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/dobjsmpl.tex
Added '\' before all '_' chars that were not inside VERBATIM blocks
[wxWidgets.git] / docs / latex / wx / dobjsmpl.tex
index 3770c66ad013ff2131a298609e8b770859610c96..6e9fe1d7d6eb67c9d844af49ab62daa3f5fedd76 100644 (file)
@@ -6,12 +6,12 @@
 %% Created:     02.11.99
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
 %% Created:     02.11.99
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
-%% Licence:     wxWindows licence
+%% License:     wxWindows license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxDataObjectSimple}}\label{wxdataobjectsimple}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxDataObjectSimple}}\label{wxdataobjectsimple}
 
-This is the simplest possible implementation of 
+This is the simplest possible implementation of the 
 \helpref{wxDataObject}{wxdataobject} class. The data object of (a class derived
 from) this class only supports one format, so the number of virtual functions
 to be implemented is reduced.
 \helpref{wxDataObject}{wxdataobject} class. The data object of (a class derived
 from) this class only supports one format, so the number of virtual functions
 to be implemented is reduced.
@@ -19,6 +19,11 @@ to be implemented is reduced.
 Notice that this is still an abstract base class and cannot be used but should
 be derived from.
 
 Notice that this is still an abstract base class and cannot be used but should
 be derived from.
 
+\pythonnote{If you wish to create a derived wxDataObjectSimple class in
+wxPython you should derive the class from wxPyDataObjectSimple
+in order to get Python-aware capabilities for the various virtual
+methods.}
+
 \wxheading{Virtual functions to override}
 
 The objects supporting rendering the data must override 
 \wxheading{Virtual functions to override}
 
 The objects supporting rendering the data must override 
@@ -80,6 +85,10 @@ object supports rendering its data.
 Copy the data to the buffer, return TRUE on success. Must be implemented in the
 derived class if the object supports rendering its data.
 
 Copy the data to the buffer, return TRUE on success. Must be implemented in the
 derived class if the object supports rendering its data.
 
+\pythonnote{When implementing this method in wxPython, no additional
+parameters are required and the data should be returned from the
+method as a string.}
+
 \membersection{wxDataObjectSimple::SetData}\label{wxdataobjectsimplesetdata}
 
 \func{virtual bool}{SetData}{\param{size\_t }{len}, \param{const void }{*buf}}
 \membersection{wxDataObjectSimple::SetData}\label{wxdataobjectsimplesetdata}
 
 \func{virtual bool}{SetData}{\param{size\_t }{len}, \param{const void }{*buf}}
@@ -87,4 +96,6 @@ derived class if the object supports rendering its data.
 Copy the data from the buffer, return TRUE on success. Must be implemented in
 the derived class if the object supports setting its data.
 
 Copy the data from the buffer, return TRUE on success. Must be implemented in
 the derived class if the object supports setting its data.
 
+\pythonnote{When implementing this method in wxPython, the data comes
+as a single string parameter rather than the two shown here.}