Detailed Description

This wxDataObject implementation provides support for exchanging metafiles with the other applications through the clipboard or drag and drop.

Availability: only available for the wxMSW port.

Library: wxCore

See also: wxMetafile, wxDataObject

Public Member Functions
	wxMetafileDataObject ()
	Default constructor.

	wxMetafileDataObject (const wxMetafile &metafile)
	Constructor taking a metafile.

virtual void	SetMetafile (const wxMetafile &metafile)
	Set the metafile associated with this object.

virtual wxMetafile	GetMetafile () const
	Get the metafile associated with this object.

Public Member Functions inherited from wxDataObjectSimple
	wxDataObjectSimple (const wxDataFormat &format=wxFormatInvalid)
	Constructor accepts the supported format (none by default) which may also be set later with SetFormat().

virtual bool	GetDataHere (void *buf) const
	Copy the data to the buffer, return true on success.

virtual size_t	GetDataSize () const
	Gets the size of our data.

const wxDataFormat &	GetFormat () const
	Returns the (one and only one) format supported by this object.

virtual bool	SetData (size_t len, const void *buf)
	Copy the data from the buffer, return true on success.

void	SetFormat (const wxDataFormat &format)
	Sets the supported format.

Public Member Functions inherited from wxDataObject
	wxDataObject ()
	Constructor.

virtual	~wxDataObject ()
	Destructor.

virtual void	GetAllFormats (wxDataFormat *formats, Direction dir=Get) const =0
	Copies all formats supported in the given direction dir to the array pointed to by formats.

virtual bool	GetDataHere (const wxDataFormat &format, void *buf) const =0
	The method will write the data of the format format to the buffer buf.

virtual size_t	GetDataSize (const wxDataFormat &format) const =0
	Returns the data size of the given format format.

virtual size_t	GetFormatCount (Direction dir=Get) const =0
	Returns the number of available formats for rendering or setting the data.

virtual wxDataFormat	GetPreferredFormat (Direction dir=Get) const =0
	Returns the preferred format for either rendering the data (if dir is `Get`, its default value) or for setting it.

virtual bool	SetData (const wxDataFormat &format, size_t len, const void *buf)
	Set the data in the format format of the length len provided in the buffer buf.

bool	IsSupported (const wxDataFormat &format, Direction dir=Get) const
	Returns true if this format is supported.

Protected Attributes
wxMetafile	m_metafile

Additional Inherited Members
Public Types inherited from wxDataObject
enum	Direction { Get = 0x01 , Set = 0x02 , Both = 0x03 }

Constructor & Destructor Documentation

◆ wxMetafileDataObject() [1/2]

wxMetafileDataObject::wxMetafileDataObject ( )

Default constructor.

The object is initially empty, use SetMetafile() to set the data.

◆ wxMetafileDataObject() [2/2]

wxMetafileDataObject::wxMetafileDataObject ( const wxMetafile & metafile )

Constructor taking a metafile.

The object is initialized with a copy of the given metafile.

Member Function Documentation

◆ GetMetafile()

virtual wxMetafile wxMetafileDataObject::GetMetafile ( ) const

virtual

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.

◆ SetMetafile()

virtual void wxMetafileDataObject::SetMetafile ( const wxMetafile & metafile )

virtual

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.

Member Data Documentation

◆ m_metafile

wxMetafile wxMetafileDataObject::m_metafile

protected