Commit 06f20cdf authored by Marko Mattila's avatar Marko Mattila

[nemo-transfer-engine] Removed autogenerated docs.

parent 4e66fe4b
<?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: List of All Members for CallbackInterface</title>
<li>Modules</li>
<li>CallbackInterface</li>
<h1 class="title">List of All Members for CallbackInterface</h1>
<p>This is the complete list of members for <a href="callbackinterface.html">CallbackInterface</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="callbackinterface.html#CallbackInterface">CallbackInterface</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="callbackinterface.html#CallbackInterface-2">CallbackInterface</a></b></span> ( const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp; )</li>
<li class="fn"><span class="name"><b><a href="callbackinterface.html#dtor.CallbackInterface">~CallbackInterface</a></b></span> ()</li>
</ul>
</body>
</html>
<?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>
<?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" />
<!-- dbmanager.cpp -->
<title>Nemo TransferEngine 1.0: List of All Members for DbManager</title>
<li>Modules</li>
<li>DbManager</li>
<h1 class="title">List of All Members for DbManager</h1>
<p>This is the complete list of members for <a href="dbmanager.html">DbManager</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="dbmanager.html#dtor.DbManager">~DbManager</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#callback">callback</a></b></span> ( int ) const : QStringList</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#callbackMethods">callbackMethods</a></b></span> ( int, QString &amp;, QString &amp; ) const : bool</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#clearTransfers">clearTransfers</a></b></span> () : bool</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#createCallbackEntry">createCallbackEntry</a></b></span> ( int, const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp; ) : int</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#createMetadataEntry">createMetadataEntry</a></b></span> ( int, const QString &amp;, const QString &amp; ) : int</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#createTransferEntry">createTransferEntry</a></b></span> ( MediaItem * ) : int</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#instance">instance</a></b></span> () : DbManager *</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#mediaItem">mediaItem</a></b></span> ( int ) const : MediaItem *</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#removeTransfer">removeTransfer</a></b></span> ( int ) : bool</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#transferStatus">transferStatus</a></b></span> ( int ) const : TransferEngineData::TransferStatus</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#transferType">transferType</a></b></span> ( int ) const : TransferEngineData::TransferType</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#transfers">transfers</a></b></span> () const : QList&lt;TransferDBRecord&gt;</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#updateProgress">updateProgress</a></b></span> ( int, qreal ) : bool</li>
<li class="fn"><span class="name"><b><a href="dbmanager.html#updateTransferStatus">updateTransferStatus</a></b></span> ( int, TransferEngineData::TransferStatus ) : bool</li>
</ul>
</body>
</html>
This diff is collapsed.
<?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" />
<!-- imageoperation.cpp -->
<title>Nemo TransferEngine 1.0: List of All Members for ImageOperation</title>
<li>Modules</li>
<li>ImageOperation</li>
<h1 class="title">List of All Members for ImageOperation</h1>
<p>This is the complete list of members for <a href="imageoperation.html">ImageOperation</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="imageoperation.html#removeImageMetadata">removeImageMetadata</a></b></span> ( const QString &amp; ) : QString</li>
<li class="fn"><span class="name"><b><a href="imageoperation.html#scaleImage">scaleImage</a></b></span> ( const QString &amp;, qreal, const QString &amp; ) : QString</li>
<li class="fn"><span class="name"><b><a href="imageoperation.html#tempFilePath">tempFilePath</a></b></span> ( const QString &amp; ) : QString</li>
</ul>
</body>
</html>
<?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" />
<!-- imageoperation.cpp -->
<title>Nemo TransferEngine 1.0: ImageOperation Class Reference</title>
<li>Modules</li>
<li>ImageOperation</li>
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">ImageOperation Class Reference</h1>
<!-- $$$ImageOperation-brief -->
<p>The ImageOperation class is a helper class to manipulate images. <a href="#details">More...</a></p>
<!-- @@@ImageOperation -->
<pre class="cpp"> <span class="preprocessor">#include &lt;ImageOperation&gt;</span></pre><ul>
<li><a href="imageoperation-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="imageoperation.html#removeImageMetadata">removeImageMetadata</a></b> ( const QString &amp; <i>sourceFile</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="imageoperation.html#scaleImage">scaleImage</a></b> ( const QString &amp; <i>sourceFile</i>, qreal <i>scaleFactor</i>, const QString &amp; <i>targetFile</i> = QString() )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="imageoperation.html#tempFilePath">tempFilePath</a></b> ( const QString &amp; <i>sourceFile</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$ImageOperation-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The ImageOperation class is a helper class to manipulate images.</p>
<p>This class is meant to be used by share plugins. It can be used for:</p>
<ul>
<li>Removing image metadata</li>
<li>Scaling image</li>
<li>Create a temp files from the image paths</li>
</ul>
</div>
<!-- @@@ImageOperation -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$removeImageMetadata[overload1]$$$removeImageMetadataconstQString& -->
<h3 class="fn"><a name="removeImageMetadata"></a><span class="type">QString</span> ImageOperation::<span class="name">removeImageMetadata</span> ( const <span class="type">QString</span> &amp; <i>sourceFile</i> )<tt> [static]</tt></h3>
<p>Helper method to remove metadata from jpeg files. Only author and location related metadata will be removed. <i>sourceFile</i> is the path to the original file.</p>
<p>Returns a path to the copy of the image with metadata removed.</p>
<!-- @@@removeImageMetadata -->
<!-- $$$scaleImage[overload1]$$$scaleImageconstQString&qrealconstQString& -->
<h3 class="fn"><a name="scaleImage"></a><span class="type">QString</span> ImageOperation::<span class="name">scaleImage</span> ( const <span class="type">QString</span> &amp; <i>sourceFile</i>, <span class="type">qreal</span> <i>scaleFactor</i>, const <span class="type">QString</span> &amp; <i>targetFile</i> = QString() )<tt> [static]</tt></h3>
<p>Scale image <i>sourceFile</i> using <i>scaleFactor</i>. The scaled image is stored to the <i>targetFile</i> or if <i>targetFile</i> is not given, then a temporary file is created for saving.</p>
<p>The <i>scaleFactor</i> argument must be &gt; 0. This function returns path to the scaled image. Note that if user doesn't specify <i>targetFile</i> the scaled image is stored under temp directory. Nothing guarantees that created file will remain in that diretory forewer so the caller is reponsible of copying file for more permanent storing.</p>
<p>Returns a path to the scaled image.</p>
<p>It is also recommended that if the caller doesn't use the scaled file, which is stored to the temp directory later, the caller should remove the file.</p>
<!-- @@@scaleImage -->
<!-- $$$tempFilePath[overload1]$$$tempFilePathconstQString& -->
<h3 class="fn"><a name="tempFilePath"></a><span class="type">QString</span> ImageOperation::<span class="name">tempFilePath</span> ( const <span class="type">QString</span> &amp; <i>sourceFile</i> )<tt> [static]</tt></h3>
<p>Creates a temporary file from the <i>sourceFile</i>. This function uses sourceFile as a template to create a temp file. Temporary file will be e.g:</p>
<p>Source file: &quot;/home/nemo/Pictures/img_001.jpg&quot; Temporary file: &quot;/var/tmp/img_001_0.jpg&quot;</p>
<p>Note that it's caller's responsibility to remove created temp file.</p>
<!-- @@@tempFilePath -->
</div>
</body>
</html>
<?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" />
<!-- index.qdoc -->
<title>Nemo TransferEngine 1.0: Nemo Transfer Engine</title>
<li>Nemo Transfer Engine</li>
<p class="naviNextPrevious headerNavi">
</p><p/>
<h1 class="title">Nemo Transfer Engine</h1>
<span class="subtitle"></span>
<!-- $$$index.html-description -->
<div class="descr"> <a name="details"></a>
<p>The Nemo Transfer Engine is a daemon process which takes care of tracking sharing, sync and downloads. In addition to just tracking those operations, it provides an API to create new share plugins and different functionality related these operations.The Nemo Transfer Engine doesn't provide any UI components, but the plugin interface expects sharing UIs to be written as QML.</p>
<p>The Nemo Transfer Engine can be understood as a front end to the database which contain all the information about sharing, syncs and downloads. For syncs and downloads it acts only as storage manager so clients can use Nemo Transfer Engine client API to create and update sync and download events. For sharing, Nemo Transfer Engine provides own API and supports share plugins.</p>
<p>See <a href="transferengine.html">TransferEngine</a> <a href="dbmanager.html">DbManager</a></p>
<a name="nemo-transfer-engine-api"></a>
<h3>Nemo Transfer Engine API</h3>
<p>The API can be divided in two different parts: the share plugin API and the client API.</p>
<a name="share-plugin-api"></a>
<h4>Share Plugin API</h4>
<p>Share plugin is a Qt plugin, which must be implemented using C++ interfaces defined by Nemo Transfer Engine. The plugins must be installed to the specific location where Nemo Transfer Engine loads them. The actual share functionality implementation depends on the client e.g&#x2e; if it's HW specific like NFC or online service such as Facebook. Each plugin must implement or use the following interface:</p>
<ul>
<li><a href="transferplugininterface.html">TransferPluginInterface</a> Share plugin must implement this interface</li>
<li>MediaTransferInterface Share plugin must implement this interface</li>
<li>TransferPluginInfo Share plugin must provide information about plugin using this class</li>
<li><a href="transfermethodinfo.html">TransferMethodInfo</a> Share plugin must provide information about e.g&#x2e; accounts using this class</li>
</ul>
<a name="client-api"></a>
<h4>Client API</h4>
<p>Client API can also be divided in two sections: full features DBus API and <a href="transferengineclient.html">TransferEngineClient</a> Interface. The first one supports all the features Nemo Transfer Engine provides and makes possible to implement for example Transfer UI and client side sharing interface on top of it. The <a href="transferengineclient.html">TransferEngineClient</a> is meant to be used by clients who want to inform Nemo Transfer Engine of ongoing Sync or Downloads.</p>
<ul>
<li>DBus API - see org.nemomobile.transferengine.xml. For the client side it will generate TransferEnginInterface class which can be used directly.</li>
<li><a href="transferengineclient.html">TransferEngineClient</a> The convenience API to create Sync and Download events.</li>
</ul>
</div>
<!-- @@@index.html -->
<p class="naviNextPrevious footerNavi">
</p>
</body>
</html>
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
<?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" />
<!-- transferdbrecord.cpp -->
<title>Nemo TransferEngine 1.0: List of All Members for TransferDBRecord</title>
<li>Modules</li>
<li>TransferDBRecord</li>
<h1 class="title">List of All Members for TransferDBRecord</h1>
<p>This is the complete list of members for <a href="transferdbrecord.html">TransferDBRecord</a>, including inherited members.</p>
<table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn">enum <span class="name"><b><a href="transferdbrecord.html#TransferDBRecordField-enum">TransferDBRecordField</a></b></span></li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#TransferDBRecord">TransferDBRecord</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#TransferDBRecord-2">TransferDBRecord</a></b></span> ( const TransferDBRecord &amp; )</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#dtor.TransferDBRecord">~TransferDBRecord</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#application_icon-var">application_icon</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#cancel_supported-var">cancel_supported</a></b></span> : bool</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#display_name-var">display_name</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#mime_type-var">mime_type</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#plugin_id-var">plugin_id</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#progress-var">progress</a></b></span> : double</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#registerType">registerType</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#resource_name-var">resource_name</a></b></span> : QString</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#restart_supported-var">restart_supported</a></b></span> : bool</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#service_icon-var">service_icon</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#size-var">size</a></b></span> : qint64</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#status-var">status</a></b></span> : int</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#thumbnail_icon-var">thumbnail_icon</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#timestamp-var">timestamp</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#transfer_id-var">transfer_id</a></b></span> : int</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#transfer_type-var">transfer_type</a></b></span> : int</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#url-var">url</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#value">value</a></b></span> ( int ) const : QVariant</li>
<li class="fn"><span class="name"><b><a href="transferdbrecord.html#operator-eq">operator=</a></b></span> ( const TransferDBRecord &amp; ) : TransferDBRecord &amp;</li>
</ul>
</td></tr>
</table>
</body>
</html>
<?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" />
<!-- transferdbrecord.cpp -->
<title>Nemo TransferEngine 1.0: TransferDBRecord Class Reference</title>
<li>Modules</li>
<li>TransferDBRecord</li>
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">TransferDBRecord Class Reference</h1>
<!-- $$$TransferDBRecord-brief -->
<p>The TransferDBRecord class is a simple wrapper class for <a href="transferengine.html">TransferEngine</a> DBus message. <a href="#details">More...</a></p>
<!-- @@@TransferDBRecord -->
<pre class="cpp"> <span class="preprocessor">#include &lt;TransferDBRecord&gt;</span></pre><ul>
<li><a href="transferdbrecord-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="transferdbrecord.html#TransferDBRecordField-enum">TransferDBRecordField</a></b> { TransferID, TransferType, Progress, URL, ..., RestartSupported }</td></tr>
</table>
<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="transferdbrecord.html#TransferDBRecord">TransferDBRecord</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="transferdbrecord.html#TransferDBRecord-2">TransferDBRecord</a></b> ( const TransferDBRecord &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="transferdbrecord.html#dtor.TransferDBRecord">~TransferDBRecord</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="transferdbrecord.html#value">value</a></b> ( int <i>index</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> TransferDBRecord &amp; </td><td class="memItemRight bottomAlign"><b><a href="transferdbrecord.html#operator-eq">operator=</a></b> ( const TransferDBRecord &amp; <i>other</i> )</td></tr>
</table>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="transferdbrecord.html#registerType">registerType</a></b> ()</td></tr>
</table>
<a name="details"></a>
<!-- $$$TransferDBRecord-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The TransferDBRecord class is a simple wrapper class for <a href="transferengine.html">TransferEngine</a> DBus message.</p>
<p>This class wraps transfer method related information and is used to pass that information over the DBus to the any client who is interested in about it.</p>
<p>A single instance of TransferDBRecord contains information of a one transfer record in <a href="transferengine.html">TransferEngine</a> database. Usually clients don't need to fill any data to this class, instead they can request a list of TransferDBRecords from the <a href="transferengine.html">TransferEngine</a> and access its data via <a href="transferdbrecord.html#value">value</a>() method.</p>
</div>
<!-- @@@TransferDBRecord -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$TransferDBRecordField$$$TransferID$$$TransferType$$$Progress$$$URL$$$Status$$$PluginID$$$Timestamp$$$DisplayName$$$ResourceName$$$MimeType$$$FileSize$$$ServiceIcon$$$ApplicationIcon$$$ThumbnailIcon$$$CancelSupported$$$RestartSupported -->
<h3 class="fn"><a name="TransferDBRecordField-enum"></a>enum TransferDBRecord::<span class="name">TransferDBRecordField</span></h3>
<!-- @@@TransferDBRecordField -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$TransferDBRecord[overload1]$$$TransferDBRecord -->
<h3 class="fn"><a name="TransferDBRecord"></a>TransferDBRecord::<span class="name">TransferDBRecord</span> ()</h3>
<p>Default constructor.</p>
<!-- @@@TransferDBRecord -->
<!-- $$$TransferDBRecord$$$TransferDBRecordconstTransferDBRecord& -->
<h3 class="fn"><a name="TransferDBRecord-2"></a>TransferDBRecord::<span class="name">TransferDBRecord</span> ( const <span class="type">TransferDBRecord</span> &amp; <i>other</i> )</h3>
<p>Copy constructor. Copies the <i>other</i> instance to this.</p>
<!-- @@@TransferDBRecord -->
<!-- $$$~TransferDBRecord[overload1]$$$~TransferDBRecord -->
<h3 class="fn"><a name="dtor.TransferDBRecord"></a>TransferDBRecord::<span class="name">~TransferDBRecord</span> ()</h3>
<p>Destructor.</p>
<!-- @@@~TransferDBRecord -->
<!-- $$$registerType[overload1]$$$registerType -->
<h3 class="fn"><a name="registerType"></a><span class="type">void</span> TransferDBRecord::<span class="name">registerType</span> ()<tt> [static]</tt></h3>
<p>Register <a href="transferdbrecord.html">TransferDBRecord</a> and QList&lt;<a href="transferdbrecord.html">TransferDBRecord</a>&gt; as DBus types.</p>
<!-- @@@registerType -->
<!-- $$$value[overload1]$$$valueint -->
<h3 class="fn"><a name="value"></a><span class="type">QVariant</span> TransferDBRecord::<span class="name">value</span> ( <span class="type">int</span> <i>index</i> ) const</h3>
<p>Returns any of the <a href="transferdbrecord.html">TransferDBRecord</a> values based on the index. As an <i>index</i> it's recommended to use <a href="transferdbrecord.html#TransferDBRecordField-enum">TransferDBRecord::TransferDBRecordField</a> enum.</p>
<!-- @@@value -->
<!-- $$$operator=[overload1]$$$operator=constTransferDBRecord& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">TransferDBRecord</span> &amp; TransferDBRecord::<span class="name">operator=</span> ( const <span class="type">TransferDBRecord</span> &amp; <i>other</i> )</h3>
<p>Assign operator. <i>other</i> is the instance of other <a href="transferdbrecord.html">TransferDBRecord</a> to copy this instance.</p>
<!-- @@@operator= -->
</div>
</body>
</html>
<?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" />
<!-- transferengine.cpp -->
<title>Nemo TransferEngine 1.0: List of All Members for TransferEngine</title>
<li>Modules</li>
<li>TransferEngine</li>
<h1 class="title">List of All Members for TransferEngine</h1>
<p>This is the complete list of members for <a href="transferengine.html">TransferEngine</a>, including inherited members.</p>
<table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="transferengine.html#TransferEngine">TransferEngine</a></b></span> ( QObject * )</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#dtor.TransferEngine">~TransferEngine</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#cancelTransfer">cancelTransfer</a></b></span> ( int )</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#clearTransfers">clearTransfers</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#createDownload">createDownload</a></b></span> ( const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, qlonglong, const QStringList &amp;, const QString &amp;, const QString &amp; ) : int</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#createSync">createSync</a></b></span> ( const QString &amp;, const QString &amp;, const QString &amp;, const QStringList &amp;, const QString &amp;, const QString &amp; ) : int</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#enableNotifications">enableNotifications</a></b></span> ( bool )</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#finishTransfer">finishTransfer</a></b></span> ( int, int, const QString &amp; )</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#notificationsEnabled">notificationsEnabled</a></b></span> () : bool</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#progressChanged">progressChanged</a></b></span> ( int, double )</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="transferengine.html#restartTransfer">restartTransfer</a></b></span> ( int )</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#startTransfer">startTransfer</a></b></span> ( int )</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#statusChanged">statusChanged</a></b></span> ( int, int )</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#transferMethodListChanged">transferMethodListChanged</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#transferMethods">transferMethods</a></b></span> () : QList&lt;TransferMethodInfo&gt;</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#transfers">transfers</a></b></span> () : QList&lt;TransferDBRecord&gt;</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#transfersChanged">transfersChanged</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#updateTransferProgress">updateTransferProgress</a></b></span> ( int, double )</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#uploadMediaItem">uploadMediaItem</a></b></span> ( const QString &amp;, const QString &amp;, const QString &amp;, bool, const QVariantMap &amp; ) : int</li>
<li class="fn"><span class="name"><b><a href="transferengine.html#uploadMediaItemContent">uploadMediaItemContent</a></b></span> ( const QVariantMap &amp;, const QString &amp;, const QVariantMap &amp; ) : int</li>
</ul>
</td></tr>
</table>
</body>
</html>
This diff is collapsed.
This diff is collapsed.
<?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: List of All Members for TransferEngineClient</title>
<li>Modules</li>
<li>TransferEngineClient</li>
<h1 class="title">List of All Members for TransferEngineClient</h1>
<p>This is the complete list of members for <a href="transferengineclient.html">TransferEngineClient</a>, including inherited members.</p>
<ul>
<li class="fn">enum <span class="name"><b><a href="transferengineclient.html#Status-enum">Status</a></b></span></li>
<li class="fn"><span class="name"><b><a href="transferengineclient.html#TransferEngineClient">TransferEngineClient</a></b></span> ( QObject * )</li>
<li class="fn"><span class="name"><b><a href="transferengineclient.html#dtor.TransferEngineClient">~TransferEngineClient</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="transferengineclient.html#createDownloadEvent">createDownloadEvent</a></b></span> ( const QString &amp;, const QUrl &amp;, const QUrl &amp;, const QUrl &amp;, const QString &amp;, qlonglong, const CallbackInterface &amp; ) : int</li>
<li class="fn"><span class="name"><b><a href="transferengineclient.html#createSyncEvent">createSyncEvent</a></b></span> ( const QString &amp;, const QUrl &amp;, const QUrl &amp;, const CallbackInterface &amp; ) : int</li>
<li class="fn"><span class="name"><b><a href="transferengineclient.html#finishTransfer">finishTransfer</a></b></span> ( int, Status, const QString &amp; )</li>
<li class="fn"><span class="name"><b><a href="transferengineclient.html#startTransfer">startTransfer</a></b></span> ( int )</li>
<li class="fn"><span class="name"><b><a href="transferengineclient.html#updateTransferProgress">updateTransferProgress</a></b></span> ( int, qreal )</li>
</ul>
</body>
</html>
This diff is collapsed.
<?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" />
<!-- transfermethodinfo.cpp -->
<title>Nemo TransferEngine 1.0: List of All Members for TransferMethodInfo</title>
<li>Modules</li>
<li>TransferMethodInfo</li>
<h1 class="title">List of All Members for TransferMethodInfo</h1>
<p>This is the complete list of members for <a href="transfermethodinfo.html">TransferMethodInfo</a>, including inherited members.</p>
<ul>
<li class="fn">enum <span class="name"><b><a href="transfermethodinfo.html#TransferMethodInfoField-enum">TransferMethodInfoField</a></b></span></li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#TransferMethodInfo">TransferMethodInfo</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#TransferMethodInfo-2">TransferMethodInfo</a></b></span> ( const TransferMethodInfo &amp; )</li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#dtor.TransferMethodInfo">~TransferMethodInfo</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#accountId-var">accountId</a></b></span> : quint32</li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#capabilitities-var">capabilitities</a></b></span> : QStringList</li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#displayName-var">displayName</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#methodId-var">methodId</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#registerType">registerType</a></b></span> ()</li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#shareUIPath-var">shareUIPath</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#userName-var">userName</a></b></span> : QString</li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#value">value</a></b></span> ( int ) const : QVariant</li>
<li class="fn"><span class="name"><b><a href="transfermethodinfo.html#operator-eq">operator=</a></b></span> ( const TransferMethodInfo &amp; ) : TransferMethodInfo &amp;</li>
</ul>
</body>
</html>
<?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" />
<!-- transfermethodinfo.cpp -->
<title>Nemo TransferEngine 1.0: TransferMethodInfo Class Reference</title>
<li>Modules</li>
<li>TransferMethodInfo</li>
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">TransferMethodInfo Class Reference</h1>
<!-- $$$TransferMethodInfo-brief -->
<p>The TransferMethodInfo class encapsulate information of a single transfer method. <a href="#details">More...</a></p>
<!-- @@@TransferMethodInfo -->
<pre class="cpp"> <span class="preprocessor">#include &lt;TransferMethodInfo&gt;</span></pre><ul>
<li><a href="transfermethodinfo-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="transfermethodinfo.html#TransferMethodInfoField-enum">TransferMethodInfoField</a></b> { DisplayName, UserName, MethodId, AccountId, ShareUIPath, Capabilities }</td></tr>
</table>
<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="transfermethodinfo.html#TransferMethodInfo">TransferMethodInfo</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="transfermethodinfo.html#TransferMethodInfo-2">TransferMethodInfo</a></b> ( const TransferMethodInfo &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="transfermethodinfo.html#dtor.TransferMethodInfo">~TransferMethodInfo</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="transfermethodinfo.html#value">value</a></b> ( int <i>index</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> TransferMethodInfo &amp; </td><td class="memItemRight bottomAlign"><b><a href="transfermethodinfo.html#operator-eq">operator=</a></b> ( const TransferMethodInfo &amp; <i>other</i> )</td></tr>
</table>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="transfermethodinfo.html#registerType">registerType</a></b> ()</td></tr>
</table>
<a name="details"></a>
<!-- $$$TransferMethodInfo-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The TransferMethodInfo class encapsulate information of a single transfer method.</p>
<p>Share plugin must create a list of instances of TransferMethodInfo class to encapsulate information about the plugin for example filling information for the Bluetooth sharing plugin:</p>
<pre class="cpp"> <span class="type">QList</span><span class="operator">&lt;</span>TransferMethodInfo<span class="operator">&gt;</span> infoList;
TransferMethodInfo info;
<span class="type">QStringList</span> capabilities;
capabilities <span class="operator">&lt;</span><span class="operator">&lt;</span> QLatin1String(<span class="string">&quot;*&quot;</span>);
info<span class="operator">.</span>displayName <span class="operator">=</span> QLatin1String(<span class="string">&quot;Bluetooth&quot;</span>);
info<span class="operator">.</span>userName <span class="operator">=</span> <span class="string">&quot;&quot;</span>;
info<span class="operator">.</span>accountId <span class="operator">=</span> <span class="string">&quot;&quot;</span>;
info<span class="operator">.</span>methodId <span class="operator">=</span> QLatin1String(<span class="string">&quot;bluetooth&quot;</span>);
info<span class="operator">.</span>shareUIPath <span class="operator">=</span> SHARE_UI_PATH <span class="operator">+</span> QLatin1String(<span class="string">&quot;/BluetoothShareUI.qml&quot;</span>);
info<span class="operator">.</span>capabilitities <span class="operator">=</span> capabilities;
infoList <span class="operator">&lt;</span><span class="operator">&lt;</span> info;</pre>
</div>
<!-- @@@TransferMethodInfo -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$TransferMethodInfoField$$$DisplayName$$$UserName$$$MethodId$$$AccountId$$$ShareUIPath$$$Capabilities -->
<h3 class="fn"><a name="TransferMethodInfoField-enum"></a>enum TransferMethodInfo::<span class="name">TransferMethodInfoField</span></h3>
<!-- @@@TransferMethodInfoField -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$TransferMethodInfo[overload1]$$$TransferMethodInfo -->
<h3 class="fn"><a name="TransferMethodInfo"></a>TransferMethodInfo::<span class="name">TransferMethodInfo</span> ()</h3>
<!-- @@@TransferMethodInfo -->
<!-- $$$TransferMethodInfo$$$TransferMethodInfoconstTransferMethodInfo& -->
<h3 class="fn"><a name="TransferMethodInfo-2"></a>TransferMethodInfo::<span class="name">TransferMethodInfo</span> ( const <span class="type">TransferMethodInfo</span> &amp; <i>other</i> )</h3>
<!-- @@@TransferMethodInfo -->
<!-- $$$~TransferMethodInfo[overload1]$$$~TransferMethodInfo -->
<h3 class="fn"><a name="dtor.TransferMethodInfo"></a>TransferMethodInfo::<span class="name">~TransferMethodInfo</span> ()</h3>
<!-- @@@~TransferMethodInfo -->
<!-- $$$registerType[overload1]$$$registerType -->
<h3 class="fn"><a name="registerType"></a><span class="type">void</span> TransferMethodInfo::<span class="name">registerType</span> ()<tt> [static]</tt></h3>
<!-- @@@registerType -->
<!-- $$$value[overload1]$$$valueint -->
<h3 class="fn"><a name="value"></a><span class="type">QVariant</span> TransferMethodInfo::<span class="name">value</span> ( <span class="type">int</span> <i>index</i> ) const</h3>
<p>Returns the value using the <i>index</i>. Actually the index is enum <a href="transfermethodinfo.html#TransferMethodInfoField-enum">TransferMethodInfoField</a>.</p>
<!-- @@@value -->
<!-- $$$operator=[overload1]$$$operator=constTransferMethodInfo& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">TransferMethodInfo</span> &amp; TransferMethodInfo::<span class="name">operator=</span> ( const <span class="type">TransferMethodInfo</span> &amp; <i>other</i> )</h3>
<!-- @@@operator= -->
</div>
</body>
</html>
<?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: List of All Members for TransferPluginInterface</title>
<li>Modules</li>
<li>TransferPluginInterface</li>
<h1 class="title">List of All Members for TransferPluginInterface</h1>
<p>This is the complete list of members for <a href="transferplugininterface.html">TransferPluginInterface</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="transferplugininterface.html#enabled">enabled</a></b></span> () const : bool</li>
<li class="fn"><span class="name"><b><a href="transferplugininterface.html#infoObject">infoObject</a></b></span> () : TransferPluginInfo *</li>
<li class="fn"><span class="name"><b><a href="transferplugininterface.html#pluginId">pluginId</a></b></span> () const : QString</li>
<li class="fn"><span class="name"><b><a href="transferplugininterface.html#transferObject">transferObject</a></b></span> () : MediaTransferInterface *</li>
</ul>
</body>
</html>
<?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>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment