]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/dataobj.h
Revert wxFlexGridSizer constr. change
[wxWidgets.git] / interface / wx / dataobj.h
index 7ef7587d87481fe1051df71b1230de032d63be20..e26168c08b77c17065e7373257663925fcec3f0a 100644 (file)
@@ -67,12 +67,20 @@ public:
     /**
         Constructs a data format object for one of the standard data formats or
         an empty data object (use SetType() or SetId() later in this case).
+
+        @beginWxPerlOnly
+        In wxPerl use Wx::Bitmap->newNative(format).
+        @endWxPerlOnly
     */
     wxDataFormat(wxDataFormatId format = wxDF_INVALID);
 
     /**
         Constructs a data format object for a custom format identified by its
         name @a format.
+
+        @beginWxPerlOnly
+        In wxPerl use Wx::Bitmap->newUser(format).
+        @endWxPerlOnly
     */
     wxDataFormat(const wxString& format);
 
@@ -245,6 +253,13 @@ public:
         Copies all formats supported in the given direction @a dir to the array 
         pointed to by @a formats. 
         There must be enough space for GetFormatCount(dir) formats in it.
+
+        @beginWxPerlOnly
+        In wxPerl this method only takes the @a dir parameter.  In scalar
+        context it returns the first format in the list, in list
+        context it returns a list containing all the supported
+        formats.
+        @endWxPerlOnly
     */
     virtual void GetAllFormats(wxDataFormat* formats,
                                Direction dir = Get) const = 0;
@@ -277,7 +292,14 @@ public:
         Set the data in the format @a format of the length @a len provided in
         the buffer @a buf.
 
-        @return @true on success, @false on failure.
+        @param format
+            The format for which to set the data.
+        @param len
+            The size of data in bytes.
+        @param buf
+            Non-@NULL pointer to the data.
+        @return
+            @true on success, @false on failure.
     */
     virtual bool SetData(const wxDataFormat& format, size_t len, const void* buf);