<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qmime_win.cpp -->
<title>Qt 4.8: QWindowsMime Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QWindowsMime</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QWindowsMime Class Reference</h1>
<!-- $$$QWindowsMime-brief -->
<p>The QWindowsMime class maps open-standard MIME to Window Clipboard formats. <a href="#details">More...</a></p>
<!-- @@@QWindowsMime -->
<pre class="cpp"> <span class="preprocessor">#include <QWindowsMime></span></pre><ul>
<li><a href="qwindowsmime-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwindowsmime.html#QWindowsMime">QWindowsMime</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qwindowsmime.html#dtor.QWindowsMime">~QWindowsMime</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qwindowsmime.html#canConvertFromMime">canConvertFromMime</a></b> ( const FORMATETC & <i>formatetc</i>, const QMimeData * <i>mimeData</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qwindowsmime.html#canConvertToMime">canConvertToMime</a></b> ( const QString & <i>mimeType</i>, IDataObject * <i>pDataObj</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qwindowsmime.html#convertFromMime">convertFromMime</a></b> ( const FORMATETC & <i>formatetc</i>, const QMimeData * <i>mimeData</i>, STGMEDIUM * <i>pmedium</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qwindowsmime.html#convertToMime">convertToMime</a></b> ( const QString & <i>mimeType</i>, IDataObject * <i>pDataObj</i>, QVariant::Type <i>preferredType</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVector<FORMATETC> </td><td class="memItemRight bottomAlign"><b><a href="qwindowsmime.html#formatsForMime">formatsForMime</a></b> ( const QString & <i>mimeType</i>, const QMimeData * <i>mimeData</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qwindowsmime.html#mimeForFormat">mimeForFormat</a></b> ( const FORMATETC & <i>formatetc</i> ) const = 0</td></tr>
</table>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qwindowsmime.html#registerMimeType">registerMimeType</a></b> ( const QString & <i>mime</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QWindowsMime-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QWindowsMime class maps open-standard MIME to Window Clipboard formats.</p>
<p>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.</p>
<p>By instantiating subclasses of QWindowsMime that provide conversions between Windows Clipboard and MIME formats, you can convert proprietary clipboard formats to MIME formats.</p>
<p>Qt has predefined support for the following Windows Clipboard formats:</p>
<table class="generic">
<thead><tr class="qt-style"><th >Windows Format</th><th >Equivalent MIME type</th></tr></thead>
<tr valign="top" class="odd"><td ><tt>CF_UNICODETEXT</tt></td><td ><tt>text/plain</tt></td></tr>
<tr valign="top" class="even"><td ><tt>CF_TEXT</tt></td><td ><tt>text/plain</tt></td></tr>
<tr valign="top" class="odd"><td ><tt>CF_DIB</tt></td><td ><tt>image/xyz</tt>, where <tt>xyz</tt> is a <a href="qimagewriter.html#supportedImageFormats">Qt image format</a></td></tr>
<tr valign="top" class="even"><td ><tt>CF_HDROP</tt></td><td ><tt>text/uri-list</tt></td></tr>
<tr valign="top" class="odd"><td ><tt>CF_INETURL</tt></td><td ><tt>text/uri-list</tt></td></tr>
<tr valign="top" class="even"><td ><tt>CF_HTML</tt></td><td ><tt>text/html</tt></td></tr>
</table>
<p>An example use of this class would be to map the Windows Metafile clipboard format (<tt>CF_METAFILEPICT</tt>) to and from the MIME type <tt>image/x-wmf</tt>. This conversion might simply be adding or removing a header, or even just passing on the data. See <a href="dnd.html">Drag and Drop</a> for more information on choosing and definition MIME types.</p>
<p>You can check if a MIME type is convertible using <a href="qwindowsmime.html#canConvertFromMime">canConvertFromMime</a>() and can perform conversions with <a href="qwindowsmime.html#convertToMime">convertToMime</a>() and <a href="qwindowsmime.html#convertFromMime">convertFromMime</a>().</p>
</div>
<!-- @@@QWindowsMime -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QWindowsMime[overload1]$$$QWindowsMime -->
<h3 class="fn"><a name="QWindowsMime"></a>QWindowsMime::<span class="name">QWindowsMime</span> ()</h3>
<p>Constructs a new conversion object, adding it to the globally accessed list of available converters.</p>
<!-- @@@QWindowsMime -->
<!-- $$$~QWindowsMime[overload1]$$$~QWindowsMime -->
<h3 class="fn"><a name="dtor.QWindowsMime"></a>QWindowsMime::<span class="name">~QWindowsMime</span> ()<tt> [virtual]</tt></h3>
<p>Destroys a conversion object, removing it from the global list of available converters.</p>
<!-- @@@~QWindowsMime -->
<!-- $$$canConvertFromMime[overload1]$$$canConvertFromMimeconstFORMATETC&constQMimeData* -->
<h3 class="fn"><a name="canConvertFromMime"></a><span class="type">bool</span> QWindowsMime::<span class="name">canConvertFromMime</span> ( const <span class="type">FORMATETC</span> & <i>formatetc</i>, const <span class="type"><a href="qmimedata.html">QMimeData</a></span> * <i>mimeData</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns true if the converter can convert from the <i>mimeData</i> to the format specified in <i>formatetc</i>.</p>
<p>All subclasses must reimplement this pure virtual function.</p>
<!-- @@@canConvertFromMime -->
<!-- $$$canConvertToMime[overload1]$$$canConvertToMimeconstQString&IDataObject* -->
<h3 class="fn"><a name="canConvertToMime"></a><span class="type">bool</span> QWindowsMime::<span class="name">canConvertToMime</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>mimeType</i>, <span class="type">IDataObject</span> * <i>pDataObj</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns true if the converter can convert to the <i>mimeType</i> from the available formats in <i>pDataObj</i>.</p>
<p>All subclasses must reimplement this pure virtual function.</p>
<!-- @@@canConvertToMime -->
<!-- $$$convertFromMime[overload1]$$$convertFromMimeconstFORMATETC&constQMimeData*STGMEDIUM* -->
<h3 class="fn"><a name="convertFromMime"></a><span class="type">bool</span> QWindowsMime::<span class="name">convertFromMime</span> ( const <span class="type">FORMATETC</span> & <i>formatetc</i>, const <span class="type"><a href="qmimedata.html">QMimeData</a></span> * <i>mimeData</i>, <span class="type">STGMEDIUM</span> * <i>pmedium</i> ) const<tt> [pure virtual]</tt></h3>
<p>Convert the <i>mimeData</i> to the format specified in <i>formatetc</i>. The converted data should then be placed in <i>pmedium</i> structure.</p>
<p>Return true if the conversion was successful.</p>
<p>All subclasses must reimplement this pure virtual function.</p>
<!-- @@@convertFromMime -->
<!-- $$$convertToMime[overload1]$$$convertToMimeconstQString&IDataObject*QVariant::Type -->
<h3 class="fn"><a name="convertToMime"></a><span class="type"><a href="qvariant.html">QVariant</a></span> QWindowsMime::<span class="name">convertToMime</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>mimeType</i>, <span class="type">IDataObject</span> * <i>pDataObj</i>, <span class="type"><a href="qvariant.html#Type-enum">QVariant::Type</a></span> <i>preferredType</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns a <a href="qvariant.html">QVariant</a> containing the converted data for <i>mimeType</i> from <i>pDataObj</i>. If possible the <a href="qvariant.html">QVariant</a> should be of the <i>preferredType</i> to avoid needless conversions.</p>
<p>All subclasses must reimplement this pure virtual function.</p>
<!-- @@@convertToMime -->
<!-- $$$formatsForMime[overload1]$$$formatsForMimeconstQString&constQMimeData* -->
<h3 class="fn"><a name="formatsForMime"></a><span class="type"><a href="qvector.html">QVector</a></span><<span class="type">FORMATETC</span>> QWindowsMime::<span class="name">formatsForMime</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>mimeType</i>, const <span class="type"><a href="qmimedata.html">QMimeData</a></span> * <i>mimeData</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns a <a href="qvector.html">QVector</a> of FORMATETC structures representing the different windows clipboard formats that can be provided for the <i>mimeType</i> from the <i>mimeData</i>.</p>
<p>All subclasses must reimplement this pure virtual function.</p>
<!-- @@@formatsForMime -->
<!-- $$$mimeForFormat[overload1]$$$mimeForFormatconstFORMATETC& -->
<h3 class="fn"><a name="mimeForFormat"></a><span class="type"><a href="qstring.html">QString</a></span> QWindowsMime::<span class="name">mimeForFormat</span> ( const <span class="type">FORMATETC</span> & <i>formatetc</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns the mime type that will be created form the format specified in <i>formatetc</i>, or an empty string if this converter does not support <i>formatetc</i>.</p>
<p>All subclasses must reimplement this pure virtual function.</p>
<!-- @@@mimeForFormat -->
<!-- $$$registerMimeType[overload1]$$$registerMimeTypeconstQString& -->
<h3 class="fn"><a name="registerMimeType"></a><span class="type">int</span> QWindowsMime::<span class="name">registerMimeType</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>mime</i> )<tt> [static]</tt></h3>
<p>Registers the MIME type <i>mime</i>, and returns an ID number identifying the format on Windows.</p>
<!-- @@@registerMimeType -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
