← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/qmacmime.html

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-08-24 04:09:09 UTC
  • Revision ID: james.westby@ubuntu.com-20050824040909-xmxe9jfr4a0w5671
Tags: upstream-4.0.0
Import upstream version 4.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qmacmime.html
 
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
<!-- /tmp/qt-4.0.0-espenr-1119621036935/qt-x11-opensource-desktop-4.0.0/src/gui/kernel/qmime_mac.cpp -->
 
6
<head>
 
7
    <title>Qt 4.0: QMacMime Class Reference</title>
 
8
    <style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
 
9
a:link { color: #004faf; text-decoration: none }
 
10
a:visited { color: #672967; text-decoration: none }
 
11
td.postheader { font-family: sans-serif }
 
12
tr.address { font-family: sans-serif }
 
13
body { background: #ffffff; color: black; }</style>
 
14
</head>
 
15
<body>
 
16
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
17
<tr>
 
18
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></td>
 
19
<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="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="annotated.html"><font color="#004faf">Annotated</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
 
20
<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QMacMime Class Reference</h1>
 
21
<p>The QMacMime class maps open-standard MIME to Mac flavors. <a href="#details">More...</a></p>
 
22
<pre>#include &lt;QMacMime&gt;</pre><p>Part of the <a href="qtgui.html">QtGui</a> module.</p>
 
23
<ul>
 
24
<li><a href="qmacmime-members.html">List of all members, including inherited members</a></li>
 
25
</ul>
 
26
<a name="public-functions"></a>
 
27
<h3>Public Functions</h3>
 
28
<ul>
 
29
<li><div class="fn"/><b><a href="qmacmime.html#QMacMime">QMacMime</a></b> ( char <i>t</i> )</li>
 
30
<li><div class="fn"/>virtual <b><a href="qmacmime.html#dtor.QMacMime">~QMacMime</a></b> ()</li>
 
31
<li><div class="fn"/>virtual bool <b><a href="qmacmime.html#canConvert">canConvert</a></b> ( const QString &amp; <i>mime</i>, int <i>flav</i> ) = 0</li>
 
32
<li><div class="fn"/>virtual QList&lt;QByteArray&gt; <b><a href="qmacmime.html#convertFromMime">convertFromMime</a></b> ( const QString &amp; <i>mime</i>, QVariant <i>data</i>, int <i>flav</i> ) = 0</li>
 
33
<li><div class="fn"/>virtual QVariant <b><a href="qmacmime.html#convertToMime">convertToMime</a></b> ( const QString &amp; <i>mime</i>, QList&lt;QByteArray&gt; <i>data</i>, int <i>flav</i> ) = 0</li>
 
34
<li><div class="fn"/>virtual QString <b><a href="qmacmime.html#convertorName">convertorName</a></b> () = 0</li>
 
35
<li><div class="fn"/>virtual int <b><a href="qmacmime.html#countFlavors">countFlavors</a></b> () = 0</li>
 
36
<li><div class="fn"/>virtual int <b><a href="qmacmime.html#flavor">flavor</a></b> ( int <i>index</i> ) = 0</li>
 
37
<li><div class="fn"/>virtual int <b><a href="qmacmime.html#flavorFor">flavorFor</a></b> ( const QString &amp; <i>mime</i> ) = 0</li>
 
38
<li><div class="fn"/>virtual QString <b><a href="qmacmime.html#mimeFor">mimeFor</a></b> ( int <i>flav</i> ) = 0</li>
 
39
</ul>
 
40
<a name="static-public-members"></a>
 
41
<h3>Static Public Members</h3>
 
42
<ul>
 
43
<li><div class="fn"/>QList&lt;QMacMime *&gt; <b><a href="qmacmime.html#all">all</a></b> ( QMacMimeType <i>t</i> )</li>
 
44
<li><div class="fn"/>QMacMime * <b><a href="qmacmime.html#convertor">convertor</a></b> ( QMacMimeType <i>t</i>, const QString &amp; <i>mime</i>, int <i>flav</i> )</li>
 
45
<li><div class="fn"/>QString <b><a href="qmacmime.html#flavorToMime">flavorToMime</a></b> ( QMacMimeType <i>t</i>, int <i>flav</i> )</li>
 
46
</ul>
 
47
<a name="details"></a>
 
48
<hr />
 
49
<h2>Detailed Description</h2>
 
50
<p>The QMacMime class maps open-standard MIME to Mac flavors.</p>
 
51
<p>Qt's drag and drop support and clipboard facilities use the MIME standard. On <a href="winsystem.html#x11">X11</a>, this maps trivially to the Xdnd protocol, but on Mac although some applications use MIME types to describe clipboard formats, others use arbitrary non-standardized naming conventions, or unnamed built-in Mac formats.</p>
 
52
<p>By instantiating subclasses of QMacMime that provide conversions between Mac flavors and MIME formats, you can convert proprietary clipboard formats to MIME formats.</p>
 
53
<p>Qt has predefined support for the following Mac flavors:</p>
 
54
<ul>
 
55
<li>kScrapFlavorTypeUnicode - converted to &quot;text/plain;charset=ISO-10646-UCS-2&quot;</li>
 
56
<li>kScrapFlavorTypeText - converted to &quot;text/plain;charset=system&quot; or &quot;text/plain&quot;</li>
 
57
<li>kScrapFlavorTypePicture - converted to &quot;application/x-qt-image&quot;</li>
 
58
<li>kDragFlavorTypeHFS - converted to &quot;text/uri-list&quot;</li>
 
59
<li>typeFileURL - converted to &quot;text/uri-list&quot;</li>
 
60
</ul>
 
61
<p>You can check if a MIME type is convertible using <a href="qmacmime.html#canConvert">canConvert</a>() and can perform conversions with <a href="qmacmime.html#convertToMime">convertToMime</a>() and <a href="qmacmime.html#convertFromMime">convertFromMime</a>().</p>
 
62
<hr />
 
63
<h2>Member Function Documentation</h2>
 
64
<h3 class="fn"><a name="QMacMime"></a>QMacMime::QMacMime ( char <i>t</i> )</h3>
 
65
<p>Constructs a new conversion object of type <i>t</i>, adding it to the globally accessed list of available convertors.</p>
 
66
<h3 class="fn"><a name="dtor.QMacMime"></a>QMacMime::~QMacMime ()&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
67
<p>Destroys a conversion object, removing it from the global list of available convertors.</p>
 
68
<h3 class="fn"><a name="all"></a><a href="qlist.html">QList</a>&lt;QMacMime *&gt; QMacMime::all ( <a href="qmacmime.html#QMacMimeType-enum">QMacMimeType</a> <i>t</i> )&nbsp;&nbsp;<tt> [static]</tt></h3>
 
69
<p>Returns a list of all currently defined <a href="qmacmime.html">QMacMime</a> objects of type <i>t</i>.</p>
 
70
<h3 class="fn"><a name="canConvert"></a>bool QMacMime::canConvert ( const <a href="qstring.html">QString</a> &amp; <i>mime</i>, int <i>flav</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
71
<p>Returns true if the convertor can convert (both ways) between <i>mime</i> and <i>flav</i>; otherwise returns false.</p>
 
72
<p>All subclasses must reimplement this pure virtual function.</p>
 
73
<h3 class="fn"><a name="convertFromMime"></a><a href="qlist.html">QList</a>&lt;<a href="qbytearray.html">QByteArray</a>&gt; QMacMime::convertFromMime ( const <a href="qstring.html">QString</a> &amp; <i>mime</i>, <a href="qvariant.html">QVariant</a> <i>data</i>, int <i>flav</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
74
<p>Returns <i>data</i> converted from MIME type <i>mime</i> to Mac flavor <i>flav</i>.</p>
 
75
<p>Note that Mac flavors must all be self-terminating. The return value may contain trailing data.</p>
 
76
<p>All subclasses must reimplement this pure virtual function.</p>
 
77
<h3 class="fn"><a name="convertToMime"></a><a href="qvariant.html">QVariant</a> QMacMime::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>, int <i>flav</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
78
<p>Returns <i>data</i> converted from Mac flavor <i>flav</i> to MIME type <i>mime</i>.</p>
 
79
<p>Note that Mac flavors must all be self-terminating. The input <i>data</i> may contain trailing data.</p>
 
80
<p>All subclasses must reimplement this pure virtual function.</p>
 
81
<h3 class="fn"><a name="convertor"></a>QMacMime * QMacMime::convertor ( <a href="qmacmime.html#QMacMimeType-enum">QMacMimeType</a> <i>t</i>, const <a href="qstring.html">QString</a> &amp; <i>mime</i>, int <i>flav</i> )&nbsp;&nbsp;<tt> [static]</tt></h3>
 
82
<p>Returns the most-recently created <a href="qmacmime.html">QMacMime</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>
 
83
<h3 class="fn"><a name="convertorName"></a><a href="qstring.html">QString</a> QMacMime::convertorName ()&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
84
<p>Returns a name for the convertor.</p>
 
85
<p>All subclasses must reimplement this pure virtual function.</p>
 
86
<h3 class="fn"><a name="countFlavors"></a>int QMacMime::countFlavors ()&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
87
<p>Returns the number of Mac flavors supported by this convertor.</p>
 
88
<p>All subclasses must reimplement this pure virtual function.</p>
 
89
<h3 class="fn"><a name="flavor"></a>int QMacMime::flavor ( int <i>index</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
90
<p>Returns the Mac flavor supported by this convertor that is ordinarily at position <i>index</i>. This means that flavor(0) returns the first Mac flavor supported, and flavor(<a href="qmacmime.html#countFlavors">countFlavors</a>()-1) returns the last. If <i>index</i> is out of range the return value is undefined.</p>
 
91
<p>All subclasses must reimplement this pure virtual function.</p>
 
92
<h3 class="fn"><a name="flavorFor"></a>int QMacMime::flavorFor ( const <a href="qstring.html">QString</a> &amp; <i>mime</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
93
<p>Returns the Mac flavor used for MIME type <i>mime</i>, or 0 if this convertor does not support <i>mime</i>.</p>
 
94
<p>All subclasses must reimplement this pure virtual function.</p>
 
95
<h3 class="fn"><a name="flavorToMime"></a><a href="qstring.html">QString</a> QMacMime::flavorToMime ( <a href="qmacmime.html#QMacMimeType-enum">QMacMimeType</a> <i>t</i>, int <i>flav</i> )&nbsp;&nbsp;<tt> [static]</tt></h3>
 
96
<p>Returns a MIME type of type <i>t</i> for <i>flav</i>, or 0 if none exists.</p>
 
97
<h3 class="fn"><a name="mimeFor"></a><a href="qstring.html">QString</a> QMacMime::mimeFor ( int <i>flav</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
98
<p>Returns the MIME type used for Mac flavor <i>flav</i>, or 0 if this convertor does not support <i>flav</i>.</p>
 
99
<p>All subclasses must reimplement this pure virtual function.</p>
 
100
<p /><address><hr /><div align="center">
 
101
<table width="100%" cellspacing="0" border="0"><tr class="address">
 
102
<td width="30%">Copyright &copy; 2005 <a href="trolltech.html">Trolltech</a></td>
 
103
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
104
<td width="30%" align="right"><div align="right">Qt 4.0.0</div></td>
 
105
</tr></table></div></address></body>
 
106
</html>