/////////////////////////////////////////////////////////////////////////////
// Name: dataobj.h
-// Purpose: documentation for wxCustomDataObject class
+// Purpose: interface of wxCustomDataObject
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxcore}
@category{dnd}
- @seealso
- wxDataObject
+ @see wxDataObject
*/
class wxCustomDataObject : public wxDataObjectSimple
{
/**
Returns a pointer to the data.
*/
- virtual void* GetData();
+ virtual void* GetData() const;
/**
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.
};
+
/**
@class wxDataObjectComposite
@wxheader{dataobj.h}
@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
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}
@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
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.
*/
- 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.
*/
- const wxDataFormat GetFormat();
+ const wxDataFormat GetFormat() const;
/**
Copy the data from the buffer, return @true on success. Must be implemented in
};
+
/**
@class wxBitmapDataObject
@wxheader{dataobj.h}
@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
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
};
+
/**
@class wxDataFormat
@wxheader{dataobj.h}
@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
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.
*/
- NativeFormat GetType();
+ NativeFormat GetType() const;
/**
Sets the format to be the custom format identified by the given name.
/**
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.
*/
- bool operator ==(const wxDataFormat& format);
+ bool operator ==(const wxDataFormat& format) const;
};
+
/**
@class wxURLDataObject
@wxheader{dataobj.h}
@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
{
/**
Returns the URL stored by this object, as a string.
*/
- wxString GetURL();
+ wxString GetURL() const;
/**
Sets the URL stored by this object.
};
+
/**
@class wxDataObject
@wxheader{dataobj.h}
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
@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
@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.
*/
- 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.
*/
- 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.
*/
- 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.
*/
- 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
};
+
/**
@class wxTextDataObject
@wxheader{dataobj.h}
@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
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
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
};
+
/**
@class wxFileDataObject
@wxheader{dataobj.h}
@library{wxcore}
@category{dnd}
- @seealso
- wxDataObject, wxDataObjectSimple, wxTextDataObject, wxBitmapDataObject,
+ @see wxDataObject, wxDataObjectSimple, wxTextDataObject, wxBitmapDataObject,
wxDataObject
*/
class wxFileDataObject : public wxDataObjectSimple
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;
};
+
projects / wxWidgets.git / blobdiff