Fix html documentation warnings.

[wxWidgets.git] / interface / wx / dataobj.h

diff --git a/interface/wx/dataobj.h b/interface/wx/dataobj.h
index 62f3704bd22494fb8d4e63c8a7d4e6b1afb13f38..8da5c8f237680d61757789b6c43f153ce2376c56 100644 (file)
--- a/interface/wx/dataobj.h
+++ b/interface/wx/dataobj.h
@@ -2,7 +2,6 @@
 // Name:        dataobj.h
 // Purpose:     interface of wx*DataObject
 // Author:      wxWidgets team
 // Name:        dataobj.h
 // Purpose:     interface of wx*DataObject
 // Author:      wxWidgets team

-// RCS-ID:      $Id$

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -34,9 +33,7 @@
     @itemdef{wxDF_FILENAME,
              A list of filenames.}
     @itemdef{wxDF_HTML,
     @itemdef{wxDF_FILENAME,
              A list of filenames.}
     @itemdef{wxDF_HTML,

-             An HTML string. This is only valid when passed to
-             wxSetClipboardData when compiled with Visual C++ in non-Unicode
-             mode.}
+             An HTML string. This is currently only valid on Mac and MSW.}

     @endDefList
 
     As mentioned above, these standard formats may be passed to any function
     @endDefList
 
     As mentioned above, these standard formats may be passed to any function


@@ -56,7 +53,7 @@
     necessary initialisations and so an attempt to do clipboard format
     registration at this time will usually lead to a crash!
 
     necessary initialisations and so an attempt to do clipboard format
     registration at this time will usually lead to a crash!
 

-    @library{wxbase}
+    @library{wxcore}

     @category{dnd}
 
     @see @ref overview_dnd, @ref page_samples_dnd, wxDataObject
     @category{dnd}
 
     @see @ref overview_dnd, @ref page_samples_dnd, wxDataObject


@@ -106,11 +103,21 @@ public:
     */
     void SetType(wxDataFormatId type);
 
     */
     void SetType(wxDataFormatId type);
 

+    /**
+        Returns @true if the formats are different.
+    */
+    bool operator !=(const wxDataFormat& format) const;
+

     /**
         Returns @true if the formats are different.
     */
     bool operator !=(wxDataFormatId format) const;
 
     /**
         Returns @true if the formats are different.
     */
     bool operator !=(wxDataFormatId format) const;
 

+    /**
+        Returns @true if the formats are equal.
+    */
+    bool operator ==(const wxDataFormat& format) const;
+

     /**
         Returns @true if the formats are equal.
     */
     /**
         Returns @true if the formats are equal.
     */


@@ -118,6 +125,8 @@ public:
 };
 
 
 };
 
 

+const wxDataFormat wxFormatInvalid;
+

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


@@ -260,8 +269,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 +296,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.


@@ -491,7 +503,7 @@ public:
         @since 2.9.1
     */
     wxDataObjectSimple *GetObject(const wxDataFormat& format,
         @since 2.9.1
     */
     wxDataObjectSimple *GetObject(const wxDataFormat& format,

-                                  wxDataObjectBase::Direction dir = Get) const;
+                                  wxDataObject::Direction dir = wxDataObject::Get) const;

 };
 
 
 };
 
 


@@ -704,7 +716,7 @@ public:
         Returns 1 under other platforms (e.g. wxMSW) or when building in ANSI mode
         (@c wxUSE_UNICODE==0).
     */
         Returns 1 under other platforms (e.g. wxMSW) or when building in ANSI mode
         (@c wxUSE_UNICODE==0).
     */

-    virtual size_t GetFormatCount(Direction dir = Get) const;
+    virtual size_t GetFormatCount(wxDataObject::Direction dir = wxDataObject::Get) const;

 
     /**
         Returns the preferred format supported by this object.
 
     /**
         Returns the preferred format supported by this object.


@@ -721,7 +733,7 @@ public:
         under other ports returns only one of the two, depending on the build mode.
     */
     virtual void GetAllFormats(wxDataFormat* formats,
         under other ports returns only one of the two, depending on the build mode.
     */
     virtual void GetAllFormats(wxDataFormat* formats,

-                               Direction dir = Get) const = 0;
+                               wxDataObject::Direction dir = wxDataObject::Get) const;

 
     /**
         Sets the text associated with the data object. This method is called
 
     /**
         Sets the text associated with the data object. This method is called


@@ -774,4 +786,31 @@ public:
     const wxArrayString& GetFilenames() const;
 };
 
     const wxArrayString& GetFilenames() const;
 };
 

+/**
+    @class wxHTMLDataObject

 
 

+    wxHTMLDataObject is used for working with HTML-formatted text.
+    
+    @library{wxcore}
+    @category{dnd}
+
+    @see wxDataObject, wxDataObjectSimple
+*/
+class wxHTMLDataObject : public wxDataObjectSimple
+{
+public:
+    /**
+        Constructor.
+    */
+    wxHTMLDataObject(const wxString& html = wxEmptyString);
+
+    /**
+        Returns the HTML string.
+    */
+    virtual wxString GetHTML() const;
+    
+    /**
+        Sets the HTML string.
+    */
+    virtual void SetHTML(const wxString& html);
+};