QWinMime Class

The QWinMime class maps open-standard MIME to Window Clipboard formats. More...

Header:	#include <QWinMime>
qmake:	QT += winextras
Since:	Qt 5.4

This class was introduced in Qt 5.4.

List of all members, including inherited members

Public Functions

	QWinMime()
virtual	~QWinMime()
virtual bool	canConvertFromMime(const FORMATETC &formatetc, const QMimeData *mimeData) const = 0
virtual bool	canConvertToMime(const QString &mimeType, IDataObject *pDataObj) const = 0
virtual bool	convertFromMime(const FORMATETC &formatetc, const QMimeData *mimeData, STGMEDIUM *pmedium) const = 0
virtual QVariant	convertToMime(const QString &mimeType, IDataObject *pDataObj, QVariant::Type preferredType) const = 0
virtual QVector<FORMATETC>	formatsForMime(const QString &mimeType, const QMimeData *mimeData) const = 0
virtual QString	mimeForFormat(const FORMATETC &formatetc) const = 0

Static Public Members

int	registerMimeType(const QString &mime)

Detailed Description

Qt's drag-and-drop and clipboard facilities use the MIME standard. On X11, this maps trivially to the Xdnd protocol, but on Windows although some applications use MIME types to describe clipboard formats, others use arbitrary non-standardized naming conventions, or unnamed built-in formats of Windows.

By instantiating subclasses of QWinMime that provide conversions between Windows Clipboard and MIME formats, you can convert proprietary clipboard formats to MIME formats.

Qt has predefined support for the following Windows Clipboard formats:

Windows Format	Equivalent MIME type
`CF_UNICODETEXT`	`text/plain`
`CF_TEXT`	`text/plain`
`CF_DIB`	`image/xyz`, where `xyz` is a Qt image format
`CF_HDROP`	`text/uri-list`
`CF_INETURL`	`text/uri-list`
`CF_HTML`	`text/html`

An example use of this class would be to map the Windows Metafile clipboard format (CF_METAFILEPICT) to and from the MIME type image/x-wmf. This conversion might simply be adding or removing a header, or even just passing on the data. See Drag and Drop for more information on choosing and definition MIME types.

You can check if a MIME type is convertible using canConvertFromMime() and can perform conversions with convertToMime() and convertFromMime().

Member Function Documentation

QWinMime::QWinMime()

Constructs a new conversion object, adding it to the globally accessed list of available converters.

`[virtual]` QWinMime::~QWinMime()

Destroys a conversion object, removing it from the global list of available converters.

`[pure virtual]` bool QWinMime::canConvertFromMime(const FORMATETC &formatetc, const QMimeData **mimeData*) const

Returns true if the converter can convert from the mimeData to the format specified in formatetc.