use an enum to make it easier to document the values

[wxWidgets.git] / interface / dataobj.h

diff --git a/interface/dataobj.h b/interface/dataobj.h
index 2256b1f1249bc1076b7a5df71d305276707c5f9b..d162f93b4f2186871a13853c678f804980a418cd 100644 (file)
--- a/interface/dataobj.h
+++ b/interface/dataobj.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dataobj.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dataobj.h

-// Purpose:     documentation for wxCustomDataObject class
+// Purpose:     interface of wxCustomDataObject

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -30,8 +30,7 @@
     @library{wxcore}
     @category{dnd}
 
     @library{wxcore}
     @category{dnd}
 

-    @seealso
-    wxDataObject
+    @see wxDataObject

 */
 class wxCustomDataObject : public wxDataObjectSimple
 {
 */
 class wxCustomDataObject : public wxDataObjectSimple
 {


@@ -69,12 +68,12 @@ public:
     /**
         Returns a pointer to the data.
     */
     /**
         Returns a pointer to the data.
     */

-    virtual void* GetData();
+    virtual void* GetData() const;

 
     /**
         Returns the data size in bytes.
     */
 
     /**
         Returns the data size in bytes.
     */

-    virtual size_t GetSize();
+    virtual size_t GetSize() const;

 
     /**
         Set the data. The data object will make an internal copy.
 
     /**
         Set the data. The data object will make an internal copy.


@@ -91,6 +90,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxDataObjectComposite
     @wxheader{dataobj.h}
 /**
     @class wxDataObjectComposite
     @wxheader{dataobj.h}


@@ -111,8 +111,7 @@ public:
     @library{wxcore}
     @category{FIXME}
 
     @library{wxcore}
     @category{FIXME}
 

-    @seealso
-    @ref overview_wxdndoverview "Clipboard and drag and drop overview",
+    @see @ref overview_wxdndoverview "Clipboard and drag and drop overview",

     wxDataObject, wxDataObjectSimple, wxFileDataObject, wxTextDataObject, wxBitmapDataObject
 */
 class wxDataObjectComposite : public wxDataObject
     wxDataObject, wxDataObjectSimple, wxFileDataObject, wxTextDataObject, wxBitmapDataObject
 */
 class wxDataObjectComposite : public wxDataObject


@@ -135,10 +134,11 @@ public:
         the clipboard or the DnD operation.  You can use this method to find
         out what kind of data object was recieved.
     */
         the clipboard or the DnD operation.  You can use this method to find
         out what kind of data object was recieved.
     */

-    wxDataFormat GetReceivedFormat();
+    wxDataFormat GetReceivedFormat() const;

 };
 
 
 };
 
 

+

 /**
     @class wxDataObjectSimple
     @wxheader{dataobj.h}
 /**
     @class wxDataObjectSimple
     @wxheader{dataobj.h}


@@ -162,8 +162,7 @@ public:
     @library{wxcore}
     @category{FIXME}
 
     @library{wxcore}
     @category{FIXME}
 

-    @seealso
-    @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref
+    @see @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref

     overview_samplednd "DnD sample", wxFileDataObject, wxTextDataObject, wxBitmapDataObject
 */
 class wxDataObjectSimple : public wxDataObject
     overview_samplednd "DnD sample", wxFileDataObject, wxTextDataObject, wxBitmapDataObject
 */
 class wxDataObjectSimple : public wxDataObject


@@ -179,19 +178,19 @@ public:
         Copy the data to the buffer, return @true on success. Must be implemented in the
         derived class if the object supports rendering its data.
     */
         Copy the data to the buffer, return @true on success. Must be implemented in the
         derived class if the object supports rendering its data.
     */

-    virtual bool GetDataHere(void buf);
+    virtual bool GetDataHere(void buf) const;

 
     /**
         Gets the size of our data. Must be implemented in the derived class if the
         object supports rendering its data.
     */
 
     /**
         Gets the size of our data. Must be implemented in the derived class if the
         object supports rendering its data.
     */

-    virtual size_t GetDataSize();
+    virtual size_t GetDataSize() const;

 
     /**
         Returns the (one and only one) format supported by this object. It is supposed
         that the format is supported in both directions.
     */
 
     /**
         Returns the (one and only one) format supported by this object. It is supposed
         that the format is supported in both directions.
     */

-    const wxDataFormat GetFormat();
+    const wxDataFormat GetFormat() const;

 
     /**
         Copy the data from the buffer, return @true on success. Must be implemented in
 
     /**
         Copy the data from the buffer, return @true on success. Must be implemented in


@@ -208,6 +207,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxBitmapDataObject
     @wxheader{dataobj.h}
 /**
     @class wxBitmapDataObject
     @wxheader{dataobj.h}


@@ -227,8 +227,7 @@ public:
     @library{wxcore}
     @category{dnd}
 
     @library{wxcore}
     @category{dnd}
 

-    @seealso
-    @ref overview_wxdndoverview "Clipboard and drag and drop overview",
+    @see @ref overview_wxdndoverview "Clipboard and drag and drop overview",

     wxDataObject, wxDataObjectSimple, wxFileDataObject, wxTextDataObject, wxDataObject
 */
 class wxBitmapDataObject : public wxDataObjectSimple
     wxDataObject, wxDataObjectSimple, wxFileDataObject, wxTextDataObject, wxDataObject
 */
 class wxBitmapDataObject : public wxDataObjectSimple


@@ -246,7 +245,7 @@ public:
         wxWidgets' internals. Use this method to get data in bitmap form from
         the wxClipboard.
     */
         wxWidgets' internals. Use this method to get data in bitmap form from
         the wxClipboard.
     */

-    virtual wxBitmap GetBitmap();
+    virtual wxBitmap GetBitmap() const;

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


@@ -257,6 +256,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxDataFormat
     @wxheader{dataobj.h}
 /**
     @class wxDataFormat
     @wxheader{dataobj.h}


@@ -331,8 +331,7 @@ public:
     @library{wxbase}
     @category{dnd}
 
     @library{wxbase}
     @category{dnd}
 

-    @seealso
-    @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref
+    @see @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref

     overview_samplednd "DnD sample", wxDataObject
 */
 class wxDataFormat
     overview_samplednd "DnD sample", wxDataObject
 */
 class wxDataFormat


@@ -348,12 +347,12 @@ public:
         Returns the name of a custom format (this function will fail for a standard
         format).
     */
         Returns the name of a custom format (this function will fail for a standard
         format).
     */

-    wxString GetId();
+    wxString GetId() const;

 
     /**
         Returns the platform-specific number identifying the format.
     */
 
     /**
         Returns the platform-specific number identifying the format.
     */

-    NativeFormat GetType();
+    NativeFormat GetType() const;

 
     /**
         Sets the format to be the custom format identified by the given name.
 
     /**
         Sets the format to be the custom format identified by the given name.


@@ -368,15 +367,16 @@ public:
     /**
         Returns @true if the formats are different.
     */
     /**
         Returns @true if the formats are different.
     */

-    bool operator !=(const wxDataFormat& format);
+    bool operator !=(const wxDataFormat& format) const;

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

-    bool operator ==(const wxDataFormat& format);
+    bool operator ==(const wxDataFormat& format) const;

 };
 
 
 };
 
 

+

 /**
     @class wxURLDataObject
     @wxheader{dataobj.h}
 /**
     @class wxURLDataObject
     @wxheader{dataobj.h}


@@ -392,8 +392,8 @@ public:
     @library{wxcore}
     @category{dnd}
 
     @library{wxcore}
     @category{dnd}
 

-    @seealso
-    @ref overview_wxdndoverview "Clipboard and drag and drop overview", wxDataObject
+    @see @ref overview_wxdndoverview "Clipboard and drag and drop overview",
+    wxDataObject

 */
 class wxURLDataObject
 {
 */
 class wxURLDataObject
 {


@@ -407,7 +407,7 @@ public:
     /**
         Returns the URL stored by this object, as a string.
     */
     /**
         Returns the URL stored by this object, as a string.
     */

-    wxString GetURL();
+    wxString GetURL() const;

 
     /**
         Sets the URL stored by this object.
 
     /**
         Sets the URL stored by this object.


@@ -416,6 +416,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxDataObject
     @wxheader{dataobj.h}
 /**
     @class wxDataObject
     @wxheader{dataobj.h}


@@ -531,7 +532,7 @@ public:
     translation under Windows is not yet finished.
 
     @b wxPython note: At this time this class is not directly usable from wxPython.
     translation under Windows is not yet finished.
 
     @b wxPython note: At this time this class is not directly usable from wxPython.

-    Derive a class from wxPyDataObjectSimple
+    Derive a class from wxPyDataObjectSimple()

     instead.
 
     @b wxPerl note: This class is not currently usable from wxPerl; you may
     instead.
 
     @b wxPerl note: This class is not currently usable from wxPerl; you may


@@ -540,8 +541,7 @@ public:
     @library{wxcore}
     @category{dnd}
 
     @library{wxcore}
     @category{dnd}
 

-    @seealso
-    @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref
+    @see @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref

     overview_samplednd "DnD sample", wxFileDataObject, wxTextDataObject, wxBitmapDataObject, wxCustomDataObject, wxDropTarget, wxDropSource, wxTextDropTarget, wxFileDropTarget
 */
 class wxDataObject
     overview_samplednd "DnD sample", wxFileDataObject, wxTextDataObject, wxBitmapDataObject, wxCustomDataObject, wxDropTarget, wxDropSource, wxTextDropTarget, wxFileDropTarget
 */
 class wxDataObject


@@ -562,30 +562,30 @@ public:
         @e formats. There is enough space for GetFormatCount(dir) formats in it.
     */
     virtual void GetAllFormats(wxDataFormat* formats,
         @e formats. There is enough space for GetFormatCount(dir) formats in it.
     */
     virtual void GetAllFormats(wxDataFormat* formats,

-                               Direction dir = Get);
+                               Direction dir = Get) const;

 
     /**
         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 in the buffer @a buf and
         return @true on success, @false on failure.
     */

-    virtual bool GetDataHere(const wxDataFormat& format, void buf);
+    virtual bool GetDataHere(const wxDataFormat& format, void buf) const;

 
     /**
         Returns the data size of the given format @e format.
     */
 
     /**
         Returns the data size of the given format @e format.
     */

-    virtual size_t GetDataSize(const wxDataFormat& format);
+    virtual size_t GetDataSize(const wxDataFormat& format) const;

 
     /**
         Returns the number of available formats for rendering or setting the data.
     */
 
     /**
         Returns the number of available formats for rendering or setting the data.
     */

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

 
     /**
         Returns the preferred format for either rendering the data (if @a dir is @c Get,
         its default value) or for setting it. Usually this will be the
         native format of the wxDataObject.
     */
 
     /**
         Returns the preferred format for either rendering the data (if @a dir is @c Get,
         its default value) or for setting it. Usually this will be the
         native format of the wxDataObject.
     */

-    virtual wxDataFormat GetPreferredFormat(Direction dir = Get);
+    virtual wxDataFormat GetPreferredFormat(Direction dir = Get) const;

 
     /**
         Set the data in the format @a format of the length @a len provided in the
 
     /**
         Set the data in the format @a format of the length @a len provided in the


@@ -597,6 +597,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxTextDataObject
     @wxheader{dataobj.h}
 /**
     @class wxTextDataObject
     @wxheader{dataobj.h}


@@ -624,8 +625,7 @@ public:
     @library{wxcore}
     @category{dnd}
 
     @library{wxcore}
     @category{dnd}
 

-    @seealso
-    @ref overview_wxdndoverview "Clipboard and drag and drop overview",
+    @see @ref overview_wxdndoverview "Clipboard and drag and drop overview",

     wxDataObject, wxDataObjectSimple, wxFileDataObject, wxBitmapDataObject
 */
 class wxTextDataObject : public wxDataObjectSimple
     wxDataObject, wxDataObjectSimple, wxFileDataObject, wxBitmapDataObject
 */
 class wxTextDataObject : public wxDataObjectSimple


@@ -643,7 +643,7 @@ public:
         wxWidgets' internals. Use this method to get data in text form from
         the wxClipboard.
     */
         wxWidgets' internals. Use this method to get data in text form from
         the wxClipboard.
     */

-    virtual wxString GetText();
+    virtual wxString GetText() const;

 
     /**
         Returns the data size. By default, returns the size of the text data
 
     /**
         Returns the data size. By default, returns the size of the text data


@@ -652,7 +652,7 @@ public:
         to return the text length plus 1 for a trailing zero, but this is not
         strictly required.
     */
         to return the text length plus 1 for a trailing zero, but this is not
         strictly required.
     */

-    virtual size_t GetTextLength();
+    virtual size_t GetTextLength() 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


@@ -664,6 +664,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxFileDataObject
     @wxheader{dataobj.h}
 /**
     @class wxFileDataObject
     @wxheader{dataobj.h}


@@ -684,8 +685,7 @@ public:
     @library{wxcore}
     @category{dnd}
 
     @library{wxcore}
     @category{dnd}
 

-    @seealso
-    wxDataObject, wxDataObjectSimple, wxTextDataObject, wxBitmapDataObject,
+    @see wxDataObject, wxDataObjectSimple, wxTextDataObject, wxBitmapDataObject,

     wxDataObject
 */
 class wxFileDataObject : public wxDataObjectSimple
     wxDataObject
 */
 class wxFileDataObject : public wxDataObjectSimple


@@ -702,7 +702,8 @@ public:
     virtual void AddFile(const wxString& file);
 
     /**
     virtual void AddFile(const wxString& file);
 
     /**

-        Returns the array of file names.
+        Returns the array() of file names.

     */
     */

-    const wxArrayString GetFilenames();
+    const wxArrayString GetFilenames() const;

 };
 };

+