]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/dataobj.tex
wxXXChoiceDialog documentation fixes
[wxWidgets.git] / docs / latex / wx / dataobj.tex
index f38c7c16b67df73b05d07186a1478a6839f179a7..631c52dc36e06d9b5969917d6e8991f9c95f2059 100644 (file)
@@ -5,8 +5,8 @@
 %% Modified by:
 %% Created:     18.10.99
 %% RCS-ID:      $Id$
-%% Copyright:   (c) wxWindows team
-%% Licence:     wxWindows licence
+%% Copyright:   (c) wxWidgets team
+%% License:     wxWidgets license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxDataObject}}\label{wxdataobject}
@@ -36,12 +36,12 @@ enum Direction
 which allows to distinguish between them. See 
 \helpref{wxDataFormat}{wxdataformat} documentation for more about formats.
 
-Not surprizingly, being 'smart' comes at a price of added complexity. This is
+Not surprisingly, being 'smart' comes at a price of added complexity. This is
 reasonable for the situations when you really need to support multiple formats,
 but may be annoying if you only want to do something simple like cut and paste
 text.
 
-To provide a solution for both cases, wxWindows has two predefined classes
+To provide a solution for both cases, wxWidgets has two predefined classes
 which derive from wxDataObject: \helpref{wxDataObjectSimple}{wxdataobjectsimple} and 
 \helpref{wxDataObjectComposite}{wxdataobjectcomposite}. 
 \helpref{wxDataObjectSimple}{wxdataobjectsimple} is
@@ -104,6 +104,9 @@ translation under Windows is not yet finished.
 Derive a class from \helpref{wxPyDataObjectSimple}{wxdataobjectsimple} 
 instead.}
 
+\perlnote{This class is not currently usable from wxPerl; you may
+use \helpref{Wx::PlDataObjectSimple}{wxdataobjectsimple} instead.}
+
 \wxheading{Virtual functions to override}
 
 Each class derived directly from wxDataObject must override and implement all
@@ -155,12 +158,16 @@ Destructor.
 Copy all supported formats in the given direction to the array pointed to by 
 {\it formats}. There is enough space for GetFormatCount(dir) formats in it.
 
+\perlnote{In wxPerl this method only takes the {\tt dir} parameter. 
+In scalar context it returns the first format,
+in list context it returns a list containing all the supported formats.}
+
 \membersection{wxDataObject::GetDataHere}\label{wxdataobjectgetdatahere}
 
 \constfunc{virtual bool}{GetDataHere}{\param{const wxDataFormat\&}{ format}, \param{void }{*buf} }
 
 The method will write the data of the format {\it format} in the buffer {\it
-buf} and return TRUE on success, FALSE on failure.
+buf} and return true on success, false on failure.
 
 \membersection{wxDataObject::GetDataSize}\label{wxdataobjectgetdatasize}
 
@@ -189,5 +196,5 @@ native format of the wxDataObject.
 Set the data in the format {\it format} of the length {\it len} provided in the
 buffer {\it buf}.
 
-Returns TRUE on success, FALSE on failure.
+Returns true on success, false on failure.