Document wxMetafileDataObject

This will allow language binding, including wxPython, to provide
wrappers for it.

Closes #25861.
This commit is contained in:
Vadim Zeitlin
2025-10-06 22:41:30 +02:00
parent f769029bdd
commit b6ce3f6dee
+48
View File
@@ -128,6 +128,54 @@ public:
bool SetClipboard(int width = 0, int height = 0);
};
/**
@class wxMetafileDataObject
This wxDataObject implementation provides support for exchanging metafiles
with the other applications through the clipboard or drag and drop.
@onlyfor{wxmsw}
@library{wxcore}
@see wxMetafile, wxDataObject
*/
class wxMetafileDataObject : public wxDataObjectSimple
{
public:
/**
Default constructor.
The object is initially empty, use SetMetafile() to set the data.
*/
wxMetafileDataObject();
/**
Constructor taking a metafile.
The object is initialized with a copy of the given metafile.
*/
wxMetafileDataObject(const wxMetafile& metafile);
/**
Set the metafile associated with this object.
This is useful when using the object as source of a drag and drop
operation or when putting data to the clipboard.
*/
virtual void SetMetafile(const wxMetafile& metafile);
/**
Get the metafile associated with this object.
This is useful when using the object as target of a drag and drop
operation or when getting data from the clipboard.
*/
virtual wxMetafile GetMetafile() const;
protected:
wxMetafile m_metafile;
};
// ============================================================================