X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7f24fdbfeae21875fe73f5aa69aede354baed29b..a99acbb00a102458b8ad5ba4459712ba73d8b14d:/docs/latex/wx/dobjsmpl.tex?ds=sidebyside diff --git a/docs/latex/wx/dobjsmpl.tex b/docs/latex/wx/dobjsmpl.tex index 3770c66ad0..2d5f2bc477 100644 --- a/docs/latex/wx/dobjsmpl.tex +++ b/docs/latex/wx/dobjsmpl.tex @@ -6,12 +6,12 @@ %% Created: 02.11.99 %% RCS-ID: $Id$ %% Copyright: (c) Vadim Zeitlin -%% Licence: wxWindows licence +%% License: wxWindows license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \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. @@ -19,13 +19,21 @@ to be implemented is reduced. 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.} + +\perlnote{In wxPerl, you need to derive your data object class +from Wx::PlDataObjectSimple.} + \wxheading{Virtual functions to override} The objects supporting rendering the data must override \helpref{GetDataSize}{wxdataobjectsimplegetdatasize} and \helpref{GetDataHere}{wxdataobjectsimplegetdatahere} while the objects which may be set must override \helpref{SetData}{wxdataobjectsimplesetdata}. Of -course, the objects supporting both operations must override all threee +course, the objects supporting both operations must override all three methods. \wxheading{Derived from} @@ -80,6 +88,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. +\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}} @@ -87,4 +99,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. +\pythonnote{When implementing this method in wxPython, the data comes +as a single string parameter rather than the two shown here.}