transferplugininterface.html 4.2 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 64 65 66
<?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" />
<!-- mediaplugininterface.qdoc -->
  <title>Nemo TransferEngine 1.0: TransferPluginInterface Class Reference</title>
<li>Modules</li>
<li>TransferPluginInterface</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">TransferPluginInterface Class Reference</h1>
<!-- $$$TransferPluginInterface-brief -->
<p>The TransferPluginInterface class defines an abstract interface for each <a href="transferengine.html">TransferEngine</a> share plugins to implement. <a href="#details">More...</a></p>
<!-- @@@TransferPluginInterface -->
<pre class="cpp"> <span class="preprocessor">#include &lt;TransferPluginInterface&gt;</span></pre><ul>
<li><a href="transferplugininterface-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"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="transferplugininterface.html#enabled">enabled</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual TransferPluginInfo * </td><td class="memItemRight bottomAlign"><b><a href="transferplugininterface.html#infoObject">infoObject</a></b> () = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="transferplugininterface.html#pluginId">pluginId</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual MediaTransferInterface * </td><td class="memItemRight bottomAlign"><b><a href="transferplugininterface.html#transferObject">transferObject</a></b> () = 0</td></tr>
</table>
<a name="details"></a>
<!-- $$$TransferPluginInterface-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The TransferPluginInterface class defines an abstract interface for each <a href="transferengine.html">TransferEngine</a> share plugins to implement.</p>
<p><a href="transferengine.html">TransferEngine</a> supports C++ share plugins. Each share plugin must implement couple of well defined interfaces:</p>
<ul>
<li>TransferPluginInterface Provides interfaces to access required objects to start sharing.</li>
<li>MediaTransferInterface Implements the actual sharing functionality</li>
<li>TransferPluginInfo Provides information about plugin status such as is it ready.</li>
</ul>
<p>TransferPluginInterface provides information to the <a href="transferengine.html">TransferEngine</a> via this interface.</p>
</div>
<!-- @@@TransferPluginInterface -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$enabled[overload1]$$$enabled -->
<h3 class="fn"><a name="enabled"></a><span class="type">bool</span> TransferPluginInterface::<span class="name">enabled</span> () const<tt> [pure virtual]</tt></h3>
<p>Return true or false depending if the plugin is enabled or not</p>
<!-- @@@enabled -->
<!-- $$$infoObject[overload1]$$$infoObject -->
<h3 class="fn"><a name="infoObject"></a><span class="type">TransferPluginInfo</span> * TransferPluginInterface::<span class="name">infoObject</span> ()<tt> [pure virtual]</tt></h3>
<p>Return TransferPluginInfo object</p>
<!-- @@@infoObject -->
<!-- $$$pluginId[overload1]$$$pluginId -->
<h3 class="fn"><a name="pluginId"></a><span class="type">QString</span> TransferPluginInterface::<span class="name">pluginId</span> () const<tt> [pure virtual]</tt></h3>
<p>Return a plugin id e.g&#x2e; Facebook, Twitter, etc.</p>
<!-- @@@pluginId -->
<!-- $$$transferObject[overload1]$$$transferObject -->
<h3 class="fn"><a name="transferObject"></a><span class="type">MediaTransferInterface</span> * TransferPluginInterface::<span class="name">transferObject</span> ()<tt> [pure virtual]</tt></h3>
<p>Return MediaTransferInterface object</p>
<!-- @@@transferObject -->
</div>
</body>
</html>