callbackinterface.html 4.54 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
<?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" />
<!-- transferengineclient.cpp -->
  <title>Nemo TransferEngine 1.0: CallbackInterface Class Reference</title>
<li>Modules</li>
<li>CallbackInterface</li>
<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="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">CallbackInterface Class Reference</h1>
<!-- $$$CallbackInterface-brief -->
<p>The CallbackInterface class is a convenience class to wrap DBus callback infromation for <a href="transferengineclient.html">TransferEngineClient</a> API. <a href="#details">More...</a></p>
<!-- @@@CallbackInterface -->
<pre class="cpp"> <span class="preprocessor">#include &lt;CallbackInterface&gt;</span></pre><ul>
<li><a href="callbackinterface-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="callbackinterface.html#CallbackInterface">CallbackInterface</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="callbackinterface.html#CallbackInterface-2">CallbackInterface</a></b> ( const QString &amp; <i>server</i>, const QString &amp; <i>path</i>, const QString &amp; <i>interface</i>, const QString &amp; <i>cancelMethod</i>, const QString &amp; <i>restartMethod</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="callbackinterface.html#dtor.CallbackInterface">~CallbackInterface</a></b> ()</td></tr>
</table>
<a name="details"></a>
<!-- $$$CallbackInterface-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The CallbackInterface class is a convenience class to wrap DBus callback infromation for <a href="transferengineclient.html">TransferEngineClient</a> API.</p>
<p>This class should be used with <a href="transferengineclient.html">TransferEngineClient</a> API.</p>
<p>NOTE: If creating an instance of this class to the heap, the caller is responsible of freeing the allocated memory.</p>
</div>
<p><b>See also </b><a href="transferengineclient.html#createSyncEvent">TransferEngineClient::createSyncEvent</a>() and <a href="transferengineclient.html#createDownloadEvent">TransferEngineClient::createDownloadEvent</a>().</p>
<!-- @@@CallbackInterface -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$CallbackInterface[overload1]$$$CallbackInterface -->
<h3 class="fn"><a name="CallbackInterface"></a>CallbackInterface::<span class="name">CallbackInterface</span> ()</h3>
<p>Construct an empty <a href="callbackinterface.html">CallbackInterface</a>. This can be used if client doesn't want to provide callback interface to the Sync or Download events.</p>
<!-- @@@CallbackInterface -->
<!-- $$$CallbackInterface$$$CallbackInterfaceconstQString&constQString&constQString&constQString&constQString& -->
<h3 class="fn"><a name="CallbackInterface-2"></a>CallbackInterface::<span class="name">CallbackInterface</span> ( const <span class="type">QString</span> &amp; <i>server</i>, const <span class="type">QString</span> &amp; <i>path</i>, const <span class="type">QString</span> &amp; <i>interface</i>, const <span class="type">QString</span> &amp; <i>cancelMethod</i>, const <span class="type">QString</span> &amp; <i>restartMethod</i> )</h3>
<p>Construct <a href="callbackinterface.html">CallbackInterface</a> instance to provide callback information to the <a href="transferengineclient.html">TransferEngineClient</a>. Setup arguments as:</p>
<ul>
<li><i>server</i> e.g&#x2e; &quot;com.jolla.myapp&quot;</li>
<li><i>path</i> e.g&#x2e; &quot;/com/jolla/myapp&quot;</li>
<li><i>interface</i> e.g&#x2e; &quot;com.jolla.myapp&quot;</li>
<li><i>cancelMethod</i> Cancel method name e.g&#x2e; &quot;cancelSync&quot;</li>
<li><i>restartMethod</i> Restart method name e.g&#x2e; &quot;restartSync&quot;</li>
</ul>
<!-- @@@CallbackInterface -->
<!-- $$$~CallbackInterface[overload1]$$$~CallbackInterface -->
<h3 class="fn"><a name="dtor.CallbackInterface"></a>CallbackInterface::<span class="name">~CallbackInterface</span> ()</h3>
<!-- @@@~CallbackInterface -->
</div>
</body>
</html>