~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qmacpasteboardmime.html

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
ImportĀ upstreamĀ versionĀ 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html
 
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<!-- qmime_mac.cpp -->
 
6
<head>
 
7
  <title>Qt 4.6: QMacPasteboardMime Class Reference</title>
 
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
 
9
</head>
 
10
<body>
 
11
<a name="//apple_ref/cpp/cl//QMacPasteboardMime" />
 
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
13
<tr>
 
14
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
 
15
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>
 
16
</tr></table><h1 class="title">QMacPasteboardMime Class Reference<br /><span class="small-subtitle">[<a href="qtgui.html">QtGui</a> module]</span>
 
17
</h1>
 
18
<p>The QMacPasteboardMime class converts between a MIME type and a <a href="http://developer.apple.com/macosx/uniformtypeidentifiers.html">Uniform Type Identifier (UTI)</a> format. <a href="#details">More...</a></p>
 
19
<pre> #include &lt;QMacPasteboardMime&gt;</pre><p>This class was introduced in Qt 4.2.</p>
 
20
<ul>
 
21
<li><a href="qmacpasteboardmime-members.html">List of all members, including inherited members</a></li>
 
22
</ul>
 
23
<hr />
 
24
<a name="public-functions"></a>
 
25
<h2>Public Functions</h2>
 
26
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
27
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#QMacPasteboardMime">QMacPasteboardMime</a></b> ( char <i>t</i> )</td></tr>
 
28
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#dtor.QMacPasteboardMime">~QMacPasteboardMime</a></b> ()</td></tr>
 
29
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#canConvert">canConvert</a></b> ( const QString &amp; <i>mime</i>, QString <i>flav</i> ) = 0</td></tr>
 
30
<tr><td class="memItemLeft" align="right" valign="top">virtual QList&lt;QByteArray&gt; </td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#convertFromMime">convertFromMime</a></b> ( const QString &amp; <i>mime</i>, QVariant <i>data</i>, QString <i>flav</i> ) = 0</td></tr>
 
31
<tr><td class="memItemLeft" align="right" valign="top">virtual QVariant </td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#convertToMime">convertToMime</a></b> ( const QString &amp; <i>mime</i>, QList&lt;QByteArray&gt; <i>data</i>, QString <i>flav</i> ) = 0</td></tr>
 
32
<tr><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#convertorName">convertorName</a></b> () = 0</td></tr>
 
33
<tr><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#flavorFor">flavorFor</a></b> ( const QString &amp; <i>mime</i> ) = 0</td></tr>
 
34
<tr><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#mimeFor">mimeFor</a></b> ( QString <i>flav</i> ) = 0</td></tr>
 
35
</table>
 
36
<hr />
 
37
<a name="static-public-members"></a>
 
38
<h2>Static Public Members</h2>
 
39
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
40
<tr><td class="memItemLeft" align="right" valign="top">QList&lt;QMacPasteboardMime *&gt; </td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#all">all</a></b> ( uchar <i>t</i> )</td></tr>
 
41
<tr><td class="memItemLeft" align="right" valign="top">QMacPasteboardMime * </td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#convertor">convertor</a></b> ( uchar <i>t</i>, const QString &amp; <i>mime</i>, QString <i>flav</i> )</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#flavorToMime">flavorToMime</a></b> ( uchar <i>t</i>, QString <i>flav</i> )</td></tr>
 
43
</table>
 
44
<hr />
 
45
<a name="related-non-members"></a>
 
46
<h2>Related Non-Members</h2>
 
47
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
48
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmacpasteboardmime.html#qRegisterDraggedTypes">qRegisterDraggedTypes</a></b> ( const QStringList &amp; <i>types</i> )</td></tr>
 
49
</table>
 
50
<a name="details"></a>
 
51
<hr />
 
52
<h2>Detailed Description</h2>
 
53
<p>The QMacPasteboardMime class converts between a MIME type and a <a href="http://developer.apple.com/macosx/uniformtypeidentifiers.html">Uniform Type Identifier (UTI)</a> format.</p>
 
54
<p>Qt's drag and drop and clipboard facilities use the MIME standard. On X11, this maps trivially to the Xdnd protocol. On Mac, although some applications use MIME to describe clipboard contents, it is more common to use Apple's UTI format.</p>
 
55
<p>QMacPasteboardMime's role is to bridge the gap between MIME and UTI; By subclasses this class, one can extend Qt's drag and drop and clipboard handling to convert to and from unsupported, or proprietary, UTI formats.</p>
 
56
<p>A subclass of QMacPasteboardMime will automatically be registered, and active, upon instantiation.</p>
 
57
<p>Qt has predefined support for the following UTIs:</p>
 
58
<ul>
 
59
<li>public.utf8-plain-text - converts to &quot;text/plain&quot;</li>
 
60
<li>public.utf16-plain-text - converts to &quot;text/plain&quot;</li>
 
61
<li>public.html - converts to &quot;text/html&quot;</li>
 
62
<li>public.url - converts to &quot;text/uri-list&quot;</li>
 
63
<li>public.file-url - converts to &quot;text/uri-list&quot;</li>
 
64
<li>public.tiff - converts to &quot;application/x-qt-image&quot;</li>
 
65
<li>com.apple.traditional-mac-plain-text - converts to &quot;text/plain&quot;</li>
 
66
<li>com.apple.pict - converts to &quot;application/x-qt-image&quot;</li>
 
67
</ul>
 
68
<p>When working with MIME data, Qt will interate through all instances of QMacPasteboardMime to find an instance that can convert to, or from, a specific MIME type. It will do this by calling <a href="qmacpasteboardmime.html#canConvert">canConvert</a>() on each instance, starting with (and choosing) the last created instance first. The actual conversions will be done by using <a href="qmacpasteboardmime.html#convertToMime">convertToMime</a>() and <a href="qmacpasteboardmime.html#convertFromMime">convertFromMime</a>().</p>
 
69
<p><b>Note:</b> The API uses the term &quot;flavor&quot; in some cases. This is for backwards compatibility reasons, and should now be understood as UTIs.</p>
 
70
<hr />
 
71
<h2>Member Function Documentation</h2>
 
72
<a name="//apple_ref/cpp/instm/QMacPasteboardMime/QMacPasteboardMime" />
 
73
<h3 class="fn"><a name="QMacPasteboardMime"></a>QMacPasteboardMime::QMacPasteboardMime ( char <i>t</i> )</h3>
 
74
<p>Constructs a new conversion object of type <i>t</i>, adding it to the globally accessed list of available convertors.</p>
 
75
<a name="//apple_ref/cpp/instm/QMacPasteboardMime/~QMacPasteboardMime" />
 
76
<h3 class="fn"><a name="dtor.QMacPasteboardMime"></a>QMacPasteboardMime::~QMacPasteboardMime ()&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
77
<p>Destroys a conversion object, removing it from the global list of available convertors.</p>
 
78
<a name="//apple_ref/cpp/clm/QMacPasteboardMime/all" />
 
79
<h3 class="fn"><a name="all"></a><a href="qlist.html">QList</a>&lt;QMacPasteboardMime *&gt; QMacPasteboardMime::all ( <a href="qtglobal.html#uchar-typedef">uchar</a> <i>t</i> )&nbsp;&nbsp;<tt> [static]</tt></h3>
 
80
<p>Returns a list of all currently defined <a href="qmacpasteboardmime.html">QMacPasteboardMime</a> objects of type <i>t</i>.</p>
 
81
<a name="//apple_ref/cpp/instm/QMacPasteboardMime/canConvert" />
 
82
<h3 class="fn"><a name="canConvert"></a>bool QMacPasteboardMime::canConvert ( const <a href="qstring.html">QString</a> &amp; <i>mime</i>, <a href="qstring.html">QString</a> <i>flav</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
83
<p>Returns true if the convertor can convert (both ways) between <i>mime</i> and <i>flav</i>; otherwise returns false.</p>
 
84
<p>All subclasses must reimplement this pure virtual function.</p>
 
85
<a name="//apple_ref/cpp/instm/QMacPasteboardMime/convertFromMime" />
 
86
<h3 class="fn"><a name="convertFromMime"></a><a href="qlist.html">QList</a>&lt;<a href="qbytearray.html">QByteArray</a>&gt; QMacPasteboardMime::convertFromMime ( const <a href="qstring.html">QString</a> &amp; <i>mime</i>, <a href="qvariant.html">QVariant</a> <i>data</i>, <a href="qstring.html">QString</a> <i>flav</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
87
<p>Returns <i>data</i> converted from MIME type <i>mime</i> to Mac UTI <i>flav</i>.</p>
 
88
<p>Note that Mac flavors must all be self-terminating. The return value may contain trailing data.</p>
 
89
<p>All subclasses must reimplement this pure virtual function.</p>
 
90
<a name="//apple_ref/cpp/instm/QMacPasteboardMime/convertToMime" />
 
91
<h3 class="fn"><a name="convertToMime"></a><a href="qvariant.html">QVariant</a> QMacPasteboardMime::convertToMime ( const <a href="qstring.html">QString</a> &amp; <i>mime</i>, <a href="qlist.html">QList</a>&lt;<a href="qbytearray.html">QByteArray</a>&gt; <i>data</i>, <a href="qstring.html">QString</a> <i>flav</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
92
<p>Returns <i>data</i> converted from Mac UTI <i>flav</i> to MIME type <i>mime</i>.</p>
 
93
<p>Note that Mac flavors must all be self-terminating. The input <i>data</i> may contain trailing data.</p>
 
94
<p>All subclasses must reimplement this pure virtual function.</p>
 
95
<a name="//apple_ref/cpp/clm/QMacPasteboardMime/convertor" />
 
96
<h3 class="fn"><a name="convertor"></a>QMacPasteboardMime * QMacPasteboardMime::convertor ( <a href="qtglobal.html#uchar-typedef">uchar</a> <i>t</i>, const <a href="qstring.html">QString</a> &amp; <i>mime</i>, <a href="qstring.html">QString</a> <i>flav</i> )&nbsp;&nbsp;<tt> [static]</tt></h3>
 
97
<p>Returns the most-recently created <a href="qmacpasteboardmime.html">QMacPasteboardMime</a> of type <i>t</i> that can convert between the <i>mime</i> and <i>flav</i> formats. Returns 0 if no such convertor exists.</p>
 
98
<a name="//apple_ref/cpp/instm/QMacPasteboardMime/convertorName" />
 
99
<h3 class="fn"><a name="convertorName"></a><a href="qstring.html">QString</a> QMacPasteboardMime::convertorName ()&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
100
<p>Returns a name for the convertor.</p>
 
101
<p>All subclasses must reimplement this pure virtual function.</p>
 
102
<a name="//apple_ref/cpp/instm/QMacPasteboardMime/flavorFor" />
 
103
<h3 class="fn"><a name="flavorFor"></a><a href="qstring.html">QString</a> QMacPasteboardMime::flavorFor ( const <a href="qstring.html">QString</a> &amp; <i>mime</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
104
<p>Returns the Mac UTI used for MIME type <i>mime</i>, or 0 if this convertor does not support <i>mime</i>.</p>
 
105
<p>All subclasses must reimplement this pure virtual function.</p>
 
106
<a name="//apple_ref/cpp/clm/QMacPasteboardMime/flavorToMime" />
 
107
<h3 class="fn"><a name="flavorToMime"></a><a href="qstring.html">QString</a> QMacPasteboardMime::flavorToMime ( <a href="qtglobal.html#uchar-typedef">uchar</a> <i>t</i>, <a href="qstring.html">QString</a> <i>flav</i> )&nbsp;&nbsp;<tt> [static]</tt></h3>
 
108
<p>Returns a MIME type of type <i>t</i> for <i>flav</i>, or 0 if none exists.</p>
 
109
<a name="//apple_ref/cpp/instm/QMacPasteboardMime/mimeFor" />
 
110
<h3 class="fn"><a name="mimeFor"></a><a href="qstring.html">QString</a> QMacPasteboardMime::mimeFor ( <a href="qstring.html">QString</a> <i>flav</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
111
<p>Returns the MIME UTI used for Mac flavor <i>flav</i>, or 0 if this convertor does not support <i>flav</i>.</p>
 
112
<p>All subclasses must reimplement this pure virtual function.</p>
 
113
<hr />
 
114
<h2>Related Non-Members</h2>
 
115
<a name="//apple_ref/cpp/func//qRegisterDraggedTypes" />
 
116
<h3 class="fn"><a name="qRegisterDraggedTypes"></a>void qRegisterDraggedTypes ( const <a href="qstringlist.html">QStringList</a> &amp; <i>types</i> )</h3>
 
117
<p>Registers the given <i>types</i> as custom pasteboard types.</p>
 
118
<p>This function should be called to enable the Drag and Drop events for custom pasteboard types on Cocoa implementations. This is required in addition to a <a href="qmacpasteboardmime.html">QMacPasteboardMime</a> subclass implementation. By default drag and drop is enabled for all standard pasteboard types.</p>
 
119
<p>See also <a href="qmacpasteboardmime.html">QMacPasteboardMime</a>.</p>
 
120
<p /><address><hr /><div align="center">
 
121
<table width="100%" cellspacing="0" border="0"><tr class="address">
 
122
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
123
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
124
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
125
<script type="text/javascript" src="http://www.google.com/jsapi"></script><script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script><script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script><script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script></tr></table></div></address></body>
 
126
</html>