diff options
| author | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
|---|---|---|
| committer | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
| commit | 93adc6aec9ba4671884d9692308b239d3064e553 (patch) | |
| tree | a5906e560045c841577473a9118ef06a39950a73 /doc/html/classQXmppTransferJob.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppTransferJob.html')
| -rw-r--r-- | doc/html/classQXmppTransferJob.html | 520 |
1 files changed, 520 insertions, 0 deletions
diff --git a/doc/html/classQXmppTransferJob.html b/doc/html/classQXmppTransferJob.html new file mode 100644 index 00000000..0905faa1 --- /dev/null +++ b/doc/html/classQXmppTransferJob.html @@ -0,0 +1,520 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<title>QXmpp: QXmppTransferJob Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javaScript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css"/> +</head> +<body onload='searchBox.OnSelectItem(0);'> +<!-- Generated by Doxygen 1.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>QXmppTransferJob Class Reference</h1><!-- doxytag: class="QXmppTransferJob" --> +<p>The <a class="el" href="classQXmppTransferJob.html" title="The QXmppTransferJob class represents a single file transfer job.">QXmppTransferJob</a> class represents a single file transfer job. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppTransferManager_8h_source.html">QXmppTransferManager.h</a>></code></p> + +<p><a href="classQXmppTransferJob-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a9c95a89a01357588f699e7d80c3de0b6">Direction</a> { <a class="el" href="classQXmppTransferJob.html#a9c95a89a01357588f699e7d80c3de0b6ae86106ecdfa723ac1933d75963c824ae">IncomingDirection</a>, +<a class="el" href="classQXmppTransferJob.html#a9c95a89a01357588f699e7d80c3de0b6adbfcc81360e31c1ded162fa244132bb7">OutgoingDirection</a> + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum is used to describe the direction of a transfer job. </p> + <a href="classQXmppTransferJob.html#a9c95a89a01357588f699e7d80c3de0b6">More...</a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bd">Error</a> { <br/> + <a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bdad8a530831e3758a4fd70dbfa5c49dc46">NoError</a> = 0, +<a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bda0e4b5001e71380ad5f06f68cec3a08d8">AbortError</a>, +<a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bda652b0ea2df649472711951da6f837c8d">FileAccessError</a>, +<a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bdabd868969ddaa105da2320ae0e2049967">FileCorruptError</a>, +<br/> + <a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bdaa807924ebe3990ef06e567113ded0c4d">ProtocolError</a> +<br/> + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum is used to describe the type of error encountered by a transfer job. </p> + <a href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bd">More...</a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a962582d3049909305277e54e2095c71b">Method</a> { <a class="el" href="classQXmppTransferJob.html#a962582d3049909305277e54e2095c71ba6f69806ddd747d2d09d26f6642ac21e6">NoMethod</a> = 0, +<a class="el" href="classQXmppTransferJob.html#a962582d3049909305277e54e2095c71bafce3f78618d8963f0ab9f1057408da0d">InBandMethod</a> = 1, +<a class="el" href="classQXmppTransferJob.html#a962582d3049909305277e54e2095c71ba81571d8573b2003f6f3a66fcda644815">SocksMethod</a> = 2, +<a class="el" href="classQXmppTransferJob.html#a962582d3049909305277e54e2095c71ba3a44df5bc47241f7bdc3ba4ca5018032">AnyMethod</a> = 3 + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum is used to describe a transfer method. </p> + <a href="classQXmppTransferJob.html#a962582d3049909305277e54e2095c71b">More...</a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#aab5bb06ca0d2c4f1fac33b7012d1c14f">State</a> { <a class="el" href="classQXmppTransferJob.html#aab5bb06ca0d2c4f1fac33b7012d1c14fa0f5f5eec8a95f2faf27186dfd502f581">OfferState</a> = 0, +<a class="el" href="classQXmppTransferJob.html#aab5bb06ca0d2c4f1fac33b7012d1c14faab96ac5cd1310e66c6048512f0846d66">StartState</a> = 1, +<a class="el" href="classQXmppTransferJob.html#aab5bb06ca0d2c4f1fac33b7012d1c14fabbaf0dcfacf7fcca8d8ba4eacd1e2d03">TransferState</a> = 2, +<a class="el" href="classQXmppTransferJob.html#aab5bb06ca0d2c4f1fac33b7012d1c14fa4ce8417fcf9feae6a2ec2a141b4c72e5">FinishedState</a> = 3 + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum is used to describe the state of a transfer job. </p> + <a href="classQXmppTransferJob.html#aab5bb06ca0d2c4f1fac33b7012d1c14f">More...</a><br/></td></tr> +<tr><td colspan="2"><h2>Signals</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a84198613e944168769b20357cfe2f626">error</a> (<a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bd">QXmppTransferJob::Error</a> error)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a602987d2e805440c93ef5b625a422856">finished</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a571b9a67cf4ad6d573c58a3039bb0433"></a><!-- doxytag: member="QXmppTransferJob::progress" ref="a571b9a67cf4ad6d573c58a3039bb0433" args="(qint64 done, qint64 total)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a571b9a67cf4ad6d573c58a3039bb0433">progress</a> (qint64 done, qint64 total)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is emitted to indicate the progress of this transfer job. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a040ea186f586a3a9ffbc6e52b3cd3917"></a><!-- doxytag: member="QXmppTransferJob::stateChanged" ref="a040ea186f586a3a9ffbc6e52b3cd3917" args="(QXmppTransferJob::State state)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a040ea186f586a3a9ffbc6e52b3cd3917">stateChanged</a> (<a class="el" href="classQXmppTransferJob.html#aab5bb06ca0d2c4f1fac33b7012d1c14f">QXmppTransferJob::State</a> state)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is emitted when the transfer job changes state. <br/></td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a22d997eaa5f3f906ef4d9e311a0e3939">abort</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#aeb89d694c0f604dd7c955ceeb5e4347d">accept</a> (QIODevice *output)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a2cd054687cc5878dcdc80ed6e458e59e">data</a> (int role) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a463bc0c38cc1fdec2c3f3807bf845d29">setData</a> (int role, const QVariant &value)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppTransferJob.html#a9c95a89a01357588f699e7d80c3de0b6">QXmppTransferJob::Direction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a62ca997c2e9d41553b99154db8f02389">direction</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bd">QXmppTransferJob::Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a12fb2a7201244f6f506894f24b31f518">error</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a46f1fb23a193d7330d9f53be25b2b8d4">jid</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppTransferJob.html#a962582d3049909305277e54e2095c71b">QXmppTransferJob::Method</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a88e73af9b8ec8521fb8de7d478b9d77c">method</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a02a1bfd07e06be44c23a2d1c559faba7">sid</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppTransferJob.html#aab5bb06ca0d2c4f1fac33b7012d1c14f">QXmppTransferJob::State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#acca845d25e138b43856e1234a979f56a">state</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QXmppTransferFileInfo </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#a51057804e28ce62138de1798c8583637">fileInfo</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abcb24751458bdbe83a4e9f133adc8e13"></a><!-- doxytag: member="QXmppTransferJob::fileDate" ref="abcb24751458bdbe83a4e9f133adc8e13" args="() const " --> +QDateTime </td><td class="memItemRight" valign="bottom"><b>fileDate</b> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b8fb3c9d3f1ee09813bf314026b2ea7"></a><!-- doxytag: member="QXmppTransferJob::fileHash" ref="a7b8fb3c9d3f1ee09813bf314026b2ea7" args="() const " --> +QByteArray </td><td class="memItemRight" valign="bottom"><b>fileHash</b> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1e28a86d10f4238438c8853c3f5879b"></a><!-- doxytag: member="QXmppTransferJob::fileName" ref="ac1e28a86d10f4238438c8853c3f5879b" args="() const " --> +QString </td><td class="memItemRight" valign="bottom"><b>fileName</b> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1b3a58af1c020e6f2f0fec014fa507c"></a><!-- doxytag: member="QXmppTransferJob::fileSize" ref="aa1b3a58af1c020e6f2f0fec014fa507c" args="() const " --> +qint64 </td><td class="memItemRight" valign="bottom"><b>fileSize</b> () const </td></tr> +<tr><td colspan="2"><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa361312d2e40d004ff65fbe880ac6cfc"></a><!-- doxytag: member="QXmppTransferJob::QXmppTransferManager" ref="aa361312d2e40d004ff65fbe880ac6cfc" args="" --> +class </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferJob.html#aa361312d2e40d004ff65fbe880ac6cfc">QXmppTransferManager</a></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppTransferJob.html" title="The QXmppTransferJob class represents a single file transfer job.">QXmppTransferJob</a> class represents a single file transfer job. </p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQXmppTransferManager.html" title="The QXmppTransferManager class provides support for sending and receiving files.">QXmppTransferManager</a> </dd></dl> +<hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="a9c95a89a01357588f699e7d80c3de0b6"></a><!-- doxytag: member="QXmppTransferJob::Direction" ref="a9c95a89a01357588f699e7d80c3de0b6" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppTransferJob.html#a9c95a89a01357588f699e7d80c3de0b6">QXmppTransferJob::Direction</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>This enum is used to describe the direction of a transfer job. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a9c95a89a01357588f699e7d80c3de0b6ae86106ecdfa723ac1933d75963c824ae"></a><!-- doxytag: member="IncomingDirection" ref="a9c95a89a01357588f699e7d80c3de0b6ae86106ecdfa723ac1933d75963c824ae" args="" -->IncomingDirection</em> </td><td> +<p>The file is being received. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a9c95a89a01357588f699e7d80c3de0b6adbfcc81360e31c1ded162fa244132bb7"></a><!-- doxytag: member="OutgoingDirection" ref="a9c95a89a01357588f699e7d80c3de0b6adbfcc81360e31c1ded162fa244132bb7" args="" -->OutgoingDirection</em> </td><td> +<p>The file is being sent. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<a class="anchor" id="abacb5103efd8148e13b9c616113366bd"></a><!-- doxytag: member="QXmppTransferJob::Error" ref="abacb5103efd8148e13b9c616113366bd" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bd">QXmppTransferJob::Error</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>This enum is used to describe the type of error encountered by a transfer job. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="abacb5103efd8148e13b9c616113366bdad8a530831e3758a4fd70dbfa5c49dc46"></a><!-- doxytag: member="NoError" ref="abacb5103efd8148e13b9c616113366bdad8a530831e3758a4fd70dbfa5c49dc46" args="" -->NoError</em> </td><td> +<p>No error occurred. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="abacb5103efd8148e13b9c616113366bda0e4b5001e71380ad5f06f68cec3a08d8"></a><!-- doxytag: member="AbortError" ref="abacb5103efd8148e13b9c616113366bda0e4b5001e71380ad5f06f68cec3a08d8" args="" -->AbortError</em> </td><td> +<p>The file transfer was aborted. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="abacb5103efd8148e13b9c616113366bda652b0ea2df649472711951da6f837c8d"></a><!-- doxytag: member="FileAccessError" ref="abacb5103efd8148e13b9c616113366bda652b0ea2df649472711951da6f837c8d" args="" -->FileAccessError</em> </td><td> +<p>An error was encountered trying to access a local file. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="abacb5103efd8148e13b9c616113366bdabd868969ddaa105da2320ae0e2049967"></a><!-- doxytag: member="FileCorruptError" ref="abacb5103efd8148e13b9c616113366bdabd868969ddaa105da2320ae0e2049967" args="" -->FileCorruptError</em> </td><td> +<p>The file is corrupt: the file size or hash do not match. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="abacb5103efd8148e13b9c616113366bdaa807924ebe3990ef06e567113ded0c4d"></a><!-- doxytag: member="ProtocolError" ref="abacb5103efd8148e13b9c616113366bdaa807924ebe3990ef06e567113ded0c4d" args="" -->ProtocolError</em> </td><td> +<p>An error was encountered in the file transfer protocol. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<a class="anchor" id="a962582d3049909305277e54e2095c71b"></a><!-- doxytag: member="QXmppTransferJob::Method" ref="a962582d3049909305277e54e2095c71b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppTransferJob.html#a962582d3049909305277e54e2095c71b">QXmppTransferJob::Method</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>This enum is used to describe a transfer method. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a962582d3049909305277e54e2095c71ba6f69806ddd747d2d09d26f6642ac21e6"></a><!-- doxytag: member="NoMethod" ref="a962582d3049909305277e54e2095c71ba6f69806ddd747d2d09d26f6642ac21e6" args="" -->NoMethod</em> </td><td> +<p>No transfer method. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a962582d3049909305277e54e2095c71bafce3f78618d8963f0ab9f1057408da0d"></a><!-- doxytag: member="InBandMethod" ref="a962582d3049909305277e54e2095c71bafce3f78618d8963f0ab9f1057408da0d" args="" -->InBandMethod</em> </td><td> +<p>XEP-0047: In-Band Bytestreams. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a962582d3049909305277e54e2095c71ba81571d8573b2003f6f3a66fcda644815"></a><!-- doxytag: member="SocksMethod" ref="a962582d3049909305277e54e2095c71ba81571d8573b2003f6f3a66fcda644815" args="" -->SocksMethod</em> </td><td> +<p>XEP-0065: SOCKS5 Bytestreams. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a962582d3049909305277e54e2095c71ba3a44df5bc47241f7bdc3ba4ca5018032"></a><!-- doxytag: member="AnyMethod" ref="a962582d3049909305277e54e2095c71ba3a44df5bc47241f7bdc3ba4ca5018032" args="" -->AnyMethod</em> </td><td> +<p>Any supported transfer method. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<a class="anchor" id="aab5bb06ca0d2c4f1fac33b7012d1c14f"></a><!-- doxytag: member="QXmppTransferJob::State" ref="aab5bb06ca0d2c4f1fac33b7012d1c14f" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppTransferJob.html#aab5bb06ca0d2c4f1fac33b7012d1c14f">QXmppTransferJob::State</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>This enum is used to describe the state of a transfer job. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="aab5bb06ca0d2c4f1fac33b7012d1c14fa0f5f5eec8a95f2faf27186dfd502f581"></a><!-- doxytag: member="OfferState" ref="aab5bb06ca0d2c4f1fac33b7012d1c14fa0f5f5eec8a95f2faf27186dfd502f581" args="" -->OfferState</em> </td><td> +<p>The transfer is being offered to the remote party. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="aab5bb06ca0d2c4f1fac33b7012d1c14faab96ac5cd1310e66c6048512f0846d66"></a><!-- doxytag: member="StartState" ref="aab5bb06ca0d2c4f1fac33b7012d1c14faab96ac5cd1310e66c6048512f0846d66" args="" -->StartState</em> </td><td> +<p>The transfer is being connected. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="aab5bb06ca0d2c4f1fac33b7012d1c14fabbaf0dcfacf7fcca8d8ba4eacd1e2d03"></a><!-- doxytag: member="TransferState" ref="aab5bb06ca0d2c4f1fac33b7012d1c14fabbaf0dcfacf7fcca8d8ba4eacd1e2d03" args="" -->TransferState</em> </td><td> +<p>The transfer is ongoing. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="aab5bb06ca0d2c4f1fac33b7012d1c14fa4ce8417fcf9feae6a2ec2a141b4c72e5"></a><!-- doxytag: member="FinishedState" ref="aab5bb06ca0d2c4f1fac33b7012d1c14fa4ce8417fcf9feae6a2ec2a141b4c72e5" args="" -->FinishedState</em> </td><td> +<p>The transfer is finished. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a22d997eaa5f3f906ef4d9e311a0e3939"></a><!-- doxytag: member="QXmppTransferJob::abort" ref="a22d997eaa5f3f906ef4d9e311a0e3939" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppTransferJob::abort </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Call this method if you wish to abort on ongoing transfer job. </p> + +</div> +</div> +<a class="anchor" id="aeb89d694c0f604dd7c955ceeb5e4347d"></a><!-- doxytag: member="QXmppTransferJob::accept" ref="aeb89d694c0f604dd7c955ceeb5e4347d" args="(QIODevice *output)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppTransferJob::accept </td> + <td>(</td> + <td class="paramtype">QIODevice * </td> + <td class="paramname"> <em>iodevice</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Call this method if you wish to accept an incoming transfer job. </p> + +</div> +</div> +<a class="anchor" id="a2cd054687cc5878dcdc80ed6e458e59e"></a><!-- doxytag: member="QXmppTransferJob::data" ref="a2cd054687cc5878dcdc80ed6e458e59e" args="(int role) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QVariant QXmppTransferJob::data </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>role</em></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the job's data for a given role.</p> +<p>You can associate arbitrary data with the role using <a class="el" href="classQXmppTransferJob.html#a463bc0c38cc1fdec2c3f3807bf845d29">setData()</a>. </p> + +</div> +</div> +<a class="anchor" id="a62ca997c2e9d41553b99154db8f02389"></a><!-- doxytag: member="QXmppTransferJob::direction" ref="a62ca997c2e9d41553b99154db8f02389" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppTransferJob.html#a9c95a89a01357588f699e7d80c3de0b6">QXmppTransferJob::Direction</a> QXmppTransferJob::direction </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the job's transfer direction. </p> + +</div> +</div> +<a class="anchor" id="a84198613e944168769b20357cfe2f626"></a><!-- doxytag: member="QXmppTransferJob::error" ref="a84198613e944168769b20357cfe2f626" args="(QXmppTransferJob::Error error)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppTransferJob::error </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bd">QXmppTransferJob::Error</a> </td> + <td class="paramname"> <em>error</em></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when an error is encountered while processing the transfer job. </p> + +</div> +</div> +<a class="anchor" id="a12fb2a7201244f6f506894f24b31f518"></a><!-- doxytag: member="QXmppTransferJob::error" ref="a12fb2a7201244f6f506894f24b31f518" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bd">QXmppTransferJob::Error</a> QXmppTransferJob::error </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the last error that was encountered. </p> + +</div> +</div> +<a class="anchor" id="a51057804e28ce62138de1798c8583637"></a><!-- doxytag: member="QXmppTransferJob::fileInfo" ref="a51057804e28ce62138de1798c8583637" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QXmppTransferFileInfo QXmppTransferJob::fileInfo </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns meta-data about the file being transfered. </p> + +</div> +</div> +<a class="anchor" id="a602987d2e805440c93ef5b625a422856"></a><!-- doxytag: member="QXmppTransferJob::finished" ref="a602987d2e805440c93ef5b625a422856" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppTransferJob::finished </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when the transfer job is finished.</p> +<p>You can determine if the job completed successfully by testing whether <a class="el" href="classQXmppTransferJob.html#a12fb2a7201244f6f506894f24b31f518">error()</a> returns <a class="el" href="classQXmppTransferJob.html#abacb5103efd8148e13b9c616113366bdad8a530831e3758a4fd70dbfa5c49dc46" title="No error occurred.">QXmppTransferJob::NoError</a>.</p> +<p>Note: Do not delete the job in the slot connected to this signal, instead use deleteLater(). </p> + +</div> +</div> +<a class="anchor" id="a46f1fb23a193d7330d9f53be25b2b8d4"></a><!-- doxytag: member="QXmppTransferJob::jid" ref="a46f1fb23a193d7330d9f53be25b2b8d4" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppTransferJob::jid </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the remote party's JID. </p> + +</div> +</div> +<a class="anchor" id="a88e73af9b8ec8521fb8de7d478b9d77c"></a><!-- doxytag: member="QXmppTransferJob::method" ref="a88e73af9b8ec8521fb8de7d478b9d77c" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppTransferJob.html#a962582d3049909305277e54e2095c71b">QXmppTransferJob::Method</a> QXmppTransferJob::method </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the job's transfer method. </p> + +</div> +</div> +<a class="anchor" id="a463bc0c38cc1fdec2c3f3807bf845d29"></a><!-- doxytag: member="QXmppTransferJob::setData" ref="a463bc0c38cc1fdec2c3f3807bf845d29" args="(int role, const QVariant &value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppTransferJob::setData </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>role</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QVariant & </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the data for a given role to the given value.</p> +<p>You can set any data you want for use in your application, this data will not be used internally by <a class="el" href="classQXmppTransferManager.html" title="The QXmppTransferManager class provides support for sending and receiving files.">QXmppTransferManager</a>. </p> + +</div> +</div> +<a class="anchor" id="a02a1bfd07e06be44c23a2d1c559faba7"></a><!-- doxytag: member="QXmppTransferJob::sid" ref="a02a1bfd07e06be44c23a2d1c559faba7" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppTransferJob::sid </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the job's session identifier. </p> + +</div> +</div> +<a class="anchor" id="acca845d25e138b43856e1234a979f56a"></a><!-- doxytag: member="QXmppTransferJob::state" ref="acca845d25e138b43856e1234a979f56a" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppTransferJob.html#aab5bb06ca0d2c4f1fac33b7012d1c14f">QXmppTransferJob::State</a> QXmppTransferJob::state </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the job's state. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppTransferManager_8h_source.html">QXmppTransferManager.h</a></li> +<li>QXmppTransferManager.cpp</li> +</ul> +</div> +<!--- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 22 00:44:24 2010 for QXmpp by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |