diff options
Diffstat (limited to 'doc/html/tqwindowsmime.html')
| -rw-r--r-- | doc/html/tqwindowsmime.html | 196 |
1 files changed, 196 insertions, 0 deletions
diff --git a/doc/html/tqwindowsmime.html b/doc/html/tqwindowsmime.html new file mode 100644 index 000000000..637478aa2 --- /dev/null +++ b/doc/html/tqwindowsmime.html @@ -0,0 +1,196 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/tqmime_win.cpp:52 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>TQWindowsMime Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td valign=center> + <a href="index.html"> +<font color="#004faf">Home</font></a> + | <a href="classes.html"> +<font color="#004faf">All Classes</font></a> + | <a href="mainclasses.html"> +<font color="#004faf">Main Classes</font></a> + | <a href="annotated.html"> +<font color="#004faf">Annotated</font></a> + | <a href="groups.html"> +<font color="#004faf">Grouped Classes</font></a> + | <a href="functions.html"> +<font color="#004faf">Functions</font></a> +</td> +<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQWindowsMime Class Reference</h1> + +<p>The TQWindowsMime class maps open-standard MIME to Window Clipboard formats. +<a href="#details">More...</a> +<p><tt>#include <<a href="tqmime-h.html">tqmime.h</a>></tt> +<p><a href="tqwindowsmime-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn><a href="#TQWindowsMime"><b>TQWindowsMime</b></a> ()</li> +<li class=fn>virtual <a href="#~TQWindowsMime"><b>~TQWindowsMime</b></a> ()</li> +<li class=fn>virtual const char * <a href="#convertorName"><b>convertorName</b></a> () = 0</li> +<li class=fn>virtual int <a href="#countCf"><b>countCf</b></a> () = 0</li> +<li class=fn>virtual int <a href="#cf"><b>cf</b></a> ( int index ) = 0</li> +<li class=fn>virtual bool <a href="#canConvert"><b>canConvert</b></a> ( const char * mime, int cf ) = 0</li> +<li class=fn>virtual const char * <a href="#mimeFor"><b>mimeFor</b></a> ( int cf ) = 0</li> +<li class=fn>virtual int <a href="#cfFor"><b>cfFor</b></a> ( const char * mime ) = 0</li> +<li class=fn>virtual TQByteArray <a href="#convertToMime"><b>convertToMime</b></a> ( TQByteArray data, const char * mime, int cf ) = 0</li> +<li class=fn>virtual TQByteArray <a href="#convertFromMime"><b>convertFromMime</b></a> ( TQByteArray data, const char * mime, int cf ) = 0</li> +</ul> +<h2>Static Public Members</h2> +<ul> +<li class=fn>void <a href="#initialize"><b>initialize</b></a> ()</li> +<li class=fn>TQPtrList<TQWindowsMime> <a href="#all"><b>all</b></a> ()</li> +<li class=fn>TQWindowsMime * <a href="#convertor"><b>convertor</b></a> ( const char * mime, int cf )</li> +<li class=fn>const char * <a href="#cfToMime"><b>cfToMime</b></a> ( int cf )</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The TQWindowsMime class maps open-standard MIME to Window Clipboard formats. + + + +<p> TQt'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> By instantiating subclasses of TQWindowsMime that provide conversions +between Windows Clipboard and MIME formats, you can convert +proprietary clipboard formats to MIME formats. +<p> TQt has predefined support for the following Windows Clipboard formats: +<ul> +<li> CF_UNICODETEXT - converted to "text/plain;charset=ISO-10646-UCS-2" +and supported by <a href="tqtextdrag.html">TQTextDrag</a>. +<li> CF_TEXT - converted to "text/plain;charset=system" or "text/plain" +and supported by TQTextDrag. +<li> CF_DIB - converted to "image/*", where * is +a <a href="tqimage.html#outputFormats">TQt image format</a>, +and supported by <a href="tqimagedrag.html">TQImageDrag</a>. +<li> CF_HDROP - converted to "text/uri-list", +and supported by <a href="tquridrag.html">TQUriDrag</a>. +</ul> +<p> 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 the +<a href="dnd.html">Drag-and-Drop documentation</a> for more information +on choosing and definition MIME types. +<p> You can check if a MIME type is convertible using <a href="#canConvert">canConvert</a>() and +can perform conversions with <a href="#convertToMime">convertToMime</a>() and <a href="#convertFromMime">convertFromMime</a>(). +<p>See also <a href="draganddrop.html">Drag And Drop Classes</a>, <a href="io.html">Input/Output and Networking</a>, and <a href="misc.html">Miscellaneous Classes</a>. + +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="TQWindowsMime"></a>TQWindowsMime::TQWindowsMime () +</h3> +Constructs a new conversion object, adding it to the globally accessed +list of available convertors. + +<h3 class=fn><a name="~TQWindowsMime"></a>TQWindowsMime::~TQWindowsMime ()<tt> [virtual]</tt> +</h3> +Destroys a conversion object, removing it from the global +list of available convertors. + +<h3 class=fn><a href="tqptrlist.html">TQPtrList</a><TQWindowsMime> <a name="all"></a>TQWindowsMime::all ()<tt> [static]</tt> +</h3> +Returns a list of all currently defined TQWindowsMime objects. + +<h3 class=fn>bool <a name="canConvert"></a>TQWindowsMime::canConvert ( const char * mime, int cf )<tt> [pure virtual]</tt> +</h3> + +<p> Returns TRUE if the convertor can convert (both ways) between +<em>mime</em> and <em>cf</em>; otherwise returns FALSE. +<p> All subclasses must reimplement this pure virtual function. + +<h3 class=fn>int <a name="cf"></a>TQWindowsMime::cf ( int index )<tt> [pure virtual]</tt> +</h3> + +<p> Returns the Windows Clipboard format supported by this convertor +that is ordinarily at position <em>index</em>. This means that <a href="#cf">cf</a>(0) +returns the first Windows Clipboard format supported, and +cf(countCf()-1) returns the last. If <em>index</em> is out of range the +return value is undefined. +<p> All subclasses must reimplement this pure virtual function. + +<h3 class=fn>int <a name="cfFor"></a>TQWindowsMime::cfFor ( const char * mime )<tt> [pure virtual]</tt> +</h3> + +<p> Returns the Windows Clipboard type used for MIME type <em>mime</em>, or +0 if this convertor does not support <em>mime</em>. +<p> All subclasses must reimplement this pure virtual function. + +<h3 class=fn>const char * <a name="cfToMime"></a>TQWindowsMime::cfToMime ( int cf )<tt> [static]</tt> +</h3> +Returns a MIME type for <em>cf</em>, or 0 if none exists. + +<h3 class=fn><a href="qbytearray.html">TQByteArray</a> <a name="convertFromMime"></a>TQWindowsMime::convertFromMime ( <a href="qbytearray.html">TQByteArray</a> data, const char * mime, int cf )<tt> [pure virtual]</tt> +</h3> + +<p> Returns <em>data</em> converted from MIME type <em>mime</em> +to Windows Clipboard format <em>cf</em>. +<p> Note that Windows Clipboard formats must all be self-terminating. The +return value may contain trailing data. +<p> All subclasses must reimplement this pure virtual function. + +<h3 class=fn><a href="qbytearray.html">TQByteArray</a> <a name="convertToMime"></a>TQWindowsMime::convertToMime ( <a href="qbytearray.html">TQByteArray</a> data, const char * mime, int cf )<tt> [pure virtual]</tt> +</h3> + +<p> Returns <em>data</em> converted from Windows Clipboard format <em>cf</em> +to MIME type <em>mime</em>. +<p> Note that Windows Clipboard formats must all be self-terminating. The +input <em>data</em> may contain trailing data. +<p> All subclasses must reimplement this pure virtual function. + +<h3 class=fn><a href="tqwindowsmime.html">TQWindowsMime</a> * <a name="convertor"></a>TQWindowsMime::convertor ( const char * mime, int cf )<tt> [static]</tt> +</h3> +Returns the most-recently created TQWindowsMime that can convert +between the <em>mime</em> and <em>cf</em> formats. Returns 0 if no such convertor +exists. + +<h3 class=fn>const char * <a name="convertorName"></a>TQWindowsMime::convertorName ()<tt> [pure virtual]</tt> +</h3> + +<p> Returns a name for the convertor. +<p> All subclasses must reimplement this pure virtual function. + +<h3 class=fn>int <a name="countCf"></a>TQWindowsMime::countCf ()<tt> [pure virtual]</tt> +</h3> + +<p> Returns the number of Windows Clipboard formats supported by this +convertor. +<p> All subclasses must reimplement this pure virtual function. + +<h3 class=fn>void <a name="initialize"></a>TQWindowsMime::initialize ()<tt> [static]</tt> +</h3> +This is an internal function. + +<h3 class=fn>const char * <a name="mimeFor"></a>TQWindowsMime::mimeFor ( int cf )<tt> [pure virtual]</tt> +</h3> + +<p> Returns the MIME type used for Windows Clipboard format <em>cf</em>, or +0 if this convertor does not support <em>cf</em>. +<p> All subclasses must reimplement this pure virtual function. + +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">TQt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>TQt 3.3.8</div> +</table></div></address></body> +</html> |