slight warnings in wxprinterdc docs about constructor confusion - see http://www...

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

diff --git a/docs/latex/wx/dataobj.tex b/docs/latex/wx/dataobj.tex
index 5a62f8532eef6079fb72e1144dce42fd26f9c145..cbb42773fedc94c184590a92d09fb1af9ba18aa9 100644 (file)
--- a/docs/latex/wx/dataobj.tex
+++ b/docs/latex/wx/dataobj.tex
@@ -5,18 +5,18 @@
 %% Modified by:
 %% Created:     18.10.99
 %% RCS-ID:      $Id$
 %% Modified by:
 %% Created:     18.10.99
 %% RCS-ID:      $Id$

-%% Copyright:   (c) wxWindows team
-%% License:     wxWindows license
+%% Copyright:   (c) wxWidgets team
+%% License:     wxWidgets license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxDataObject}}\label{wxdataobject}
 
 A wxDataObject represents data that can be copied to or from the clipboard, or
 dragged and dropped. The important thing about wxDataObject is that this is a
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxDataObject}}\label{wxdataobject}
 
 A wxDataObject represents data that can be copied to or from the clipboard, or
 dragged and dropped. The important thing about wxDataObject is that this is a

-'smart' piece of data unlike usual 'dumb' data containers such as memory
+'smart' piece of data unlike 'dumb' data containers such as memory

 buffers or files. Being 'smart' here means that the data object itself should
 know what data formats it supports and how to render itself in each of
 buffers or files. Being 'smart' here means that the data object itself should
 know what data formats it supports and how to render itself in each of

-supported formats.
+its supported formats.

 
 A supported format, incidentally, is exactly the format in which the data can
 be requested from a data object or from which the data object may be set. In
 
 A supported format, incidentally, is exactly the format in which the data can
 be requested from a data object or from which the data object may be set. In


@@ -33,22 +33,22 @@ enum Direction
 };
 \end{verbatim}
 
 };
 \end{verbatim}
 

-which allows to distinguish between them. See 
+which distinguishes between them. See 

 \helpref{wxDataFormat}{wxdataformat} documentation for more about formats.
 
 \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.
 
 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
 the simplest wxDataObject possible and only holds data in a single format (such
 as HTML or text) and \helpref{wxDataObjectComposite}{wxdataobjectcomposite} is
 which derive from wxDataObject: \helpref{wxDataObjectSimple}{wxdataobjectsimple} and 
 \helpref{wxDataObjectComposite}{wxdataobjectcomposite}. 
 \helpref{wxDataObjectSimple}{wxdataobjectsimple} is
 the simplest wxDataObject possible and only holds data in a single format (such
 as HTML or text) and \helpref{wxDataObjectComposite}{wxdataobjectcomposite} is

-the simplest way to implement wxDataObject which does support multiple formats
-because it achievs this by simply holding several wxDataObjectSimple objects.
+the simplest way to implement a wxDataObject that does support multiple formats
+because it achieves this by simply holding several wxDataObjectSimple objects.

 
 So, you have several solutions when you need a wxDataObject class (and you need
 one as soon as you want to transfer data via the clipboard or drag and drop):
 
 So, you have several solutions when you need a wxDataObject class (and you need
 one as soon as you want to transfer data via the clipboard or drag and drop):


@@ -65,7 +65,7 @@ in your program (or between different copies of it).}
 solution which allows you to support any number of formats (either
 standard or custom if you combine it with the previous solution).}
 \twocolitem{{\bf 4. Use wxDataObject directly}}{This is the solution for
 solution which allows you to support any number of formats (either
 standard or custom if you combine it with the previous solution).}
 \twocolitem{{\bf 4. Use wxDataObject directly}}{This is the solution for

-maximal flexibility and efficiency, but it is also is the most difficult to
+maximal flexibility and efficiency, but it is also the most difficult to

 implement.}
 \end{twocollist}
 
 implement.}
 \end{twocollist}
 


@@ -78,8 +78,8 @@ the clipboard and even today's computers are in trouble. For this case, you
 will have to derive from wxDataObject directly and make it enumerate its
 formats and provide the data in the requested format on demand.
 
 will have to derive from wxDataObject directly and make it enumerate its
 formats and provide the data in the requested format on demand.
 

-Note that neither the GTK data transfer mechanisms for the clipboard and
-drag and drop, nor the OLE data transfer copy any data until another application
+Note that neither the GTK+ data transfer mechanisms for clipboard and
+drag and drop, nor OLE data transfer, copy any data until another application

 actually requests the data. This is in contrast to the 'feel' offered to the
 user of a program who would normally think that the data resides in the
 clipboard after having pressed 'Copy' - in reality it is only declared to be
 actually requests the data. This is in contrast to the 'feel' offered to the
 user of a program who would normally think that the data resides in the
 clipboard after having pressed 'Copy' - in reality it is only declared to be


@@ -93,9 +93,9 @@ change.
 
 You may also derive your own data object classes from 
 \helpref{wxCustomDataObject}{wxcustomdataobject} for user-defined types. The
 
 You may also derive your own data object classes from 
 \helpref{wxCustomDataObject}{wxcustomdataobject} for user-defined types. The

-format of user-defined data is given as mime-type string literal, such as
+format of user-defined data is given as a mime-type string literal, such as

 "application/word" or "image/png". These strings are used as they are under
 "application/word" or "image/png". These strings are used as they are under

-Unix (so far only GTK) to identify a format and are translated into their
+Unix (so far only GTK+) to identify a format and are translated into their

 Windows equivalent under Win32 (using the OLE IDataObject for data exchange to
 and from the clipboard and for drag and drop). Note that the format string
 translation under Windows is not yet finished.
 Windows equivalent under Win32 (using the OLE IDataObject for data exchange to
 and from the clipboard and for drag and drop). Note that the format string
 translation under Windows is not yet finished.


@@ -104,6 +104,9 @@ translation under Windows is not yet finished.
 Derive a class from \helpref{wxPyDataObjectSimple}{wxdataobjectsimple} 
 instead.}
 
 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
 \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.
 
 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
 \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}
 
 
 \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}.
 
 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.