Add wxFormatInvalid, and tweak the docs for wxDataObject::GetDataHere and SetData

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71401 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/dataobj.h b/interface/wx/dataobj.h
index 62f3704bd22494fb8d4e63c8a7d4e6b1afb13f38..ea43966b03adfdef58102631a592503f6a3e3337 100644 (file)
--- a/interface/wx/dataobj.h
+++ b/interface/wx/dataobj.h
@@ -118,6 +118,8 @@ public:
 };
 
 
 };
 
 

+const wxDataFormat wxFormatInvalid;
+

 
 /**
     @class wxDataObject
 
 /**
     @class wxDataObject


@@ -260,8 +262,10 @@ public:
                                Direction dir = Get) const = 0;
 
     /**
                                Direction dir = Get) const = 0;
 
     /**

-        The method will write the data of the format @a format in the buffer
-        @a buf and return @true on success, @false on failure.
+        The method will write the data of the format @a format to the buffer
+        @a buf.  In other words, copy the data from this object in the given
+        format to the supplied buffer. Returns @true on success, @false on
+        failure.

     */
     virtual bool GetDataHere(const wxDataFormat& format, void* buf) const = 0;
 
     */
     virtual bool GetDataHere(const wxDataFormat& format, void* buf) const = 0;
 


@@ -285,7 +289,8 @@ public:
 
     /**
         Set the data in the format @a format of the length @a len provided in
 
     /**
         Set the data in the format @a format of the length @a len provided in

-        the buffer @a buf.
+        the buffer @a buf.  In other words, copy length bytes of data from the
+        buffer to this data object.

 
         @param format
             The format for which to set the data.
 
         @param format
             The format for which to set the data.