diff options
Diffstat (limited to 'libcontextsubscriber/doc/html/class_context_subscriber_1_1_context_kit_plugin.html')
| -rw-r--r-- | libcontextsubscriber/doc/html/class_context_subscriber_1_1_context_kit_plugin.html | 768 |
1 files changed, 768 insertions, 0 deletions
diff --git a/libcontextsubscriber/doc/html/class_context_subscriber_1_1_context_kit_plugin.html b/libcontextsubscriber/doc/html/class_context_subscriber_1_1_context_kit_plugin.html new file mode 100644 index 00000000..cd21f7ac --- /dev/null +++ b/libcontextsubscriber/doc/html/class_context_subscriber_1_1_context_kit_plugin.html @@ -0,0 +1,768 @@ +<!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>libcontextsubscriber: ContextSubscriber::ContextKitPlugin Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<!-- Generated by Doxygen 1.6.1 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</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> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</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 class="navpath"><a class="el" href="namespace_context_subscriber.html">ContextSubscriber</a>::<a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html">ContextKitPlugin</a> + </div> +</div> +<div class="contents"> +<h1>ContextSubscriber::ContextKitPlugin Class Reference</h1><!-- doxytag: class="ContextSubscriber::ContextKitPlugin" --><!-- doxytag: inherits="ContextSubscriber::IProviderPlugin" --> +<p>Implementation of the ContextKit D-Bus protocol. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="contextkitplugin_8h_source.html">contextkitplugin.h</a>></code></p> + +<p><a href="class_context_subscriber_1_1_context_kit_plugin-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<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="class_context_subscriber_1_1_context_kit_plugin.html#acb1ad4d2dafa9c137acff2a84916686f">ready</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when the GetSubscriber call returns successfully. <a href="#acb1ad4d2dafa9c137acff2a84916686f"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a659b0f0fcb7a740975fadc55c670bbf7">failed</a> (QString error)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when the GetSubscriber call fails or provider not on D-Bus at all. <a href="#a659b0f0fcb7a740975fadc55c670bbf7"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a4a3fcd522bbb2cc67c5821bcf15ed3d4">subscribeFinished</a> (QString key)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when Subscribe call succeeds on D-Bus. <a href="#a4a3fcd522bbb2cc67c5821bcf15ed3d4"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a803a4bf54f2017025bc314fc14702513">subscribeFailed</a> (QString failedKey, QString error)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when Subscribe call fails on D-Bus. <a href="#a803a4bf54f2017025bc314fc14702513"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a5603631c4a9e7f6a4cbe05af6dfe5c48">valueChanged</a> (QString key, QVariant value)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when ValueChanged signal comes on D-Bus. <a href="#a5603631c4a9e7f6a4cbe05af6dfe5c48"></a><br/></td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#ab3728dd869ea64e058f4f7c35a4bb067">ContextKitPlugin</a> (const QDBusConnection bus, const QString &<a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a80103689b09397c9a399987df806af1c">busName</a>)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates subscriber and manager interface, tries to get a subscriber instance from the manager and starts listening for provider appearing and disappearing on D-Bus. <a href="#ab3728dd869ea64e058f4f7c35a4bb067"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#aa45ae69058525f998ed5eb0c275cac75">subscribe</a> (QSet< QString > keys)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Forwards the subscribe request to the wire. <a href="#aa45ae69058525f998ed5eb0c275cac75"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a4936904e1483e3f06c86e10d65a39e50">unsubscribe</a> (QSet< QString > keys)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Forwards the unsubscribe request to the wire. <a href="#a4936904e1483e3f06c86e10d65a39e50"></a><br/></td></tr> +<tr><td colspan="2"><h2>Private Slots</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a87a7194ff406805a3b0d38f47d0a0aff">onNewValueChanged</a> (QList< QVariant > value, quint64 timestamp, QDBusMessage message)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a119181d213c126458f065a0b10e7e281">onDBusValuesChanged</a> (QMap< QString, QVariant > values)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Forwards value changes from the wire to the upper layer (<a class="el" href="class_context_subscriber_1_1_provider.html" title="Connects to a group of properties via the help of a plugin.">Provider</a>). <a href="#a119181d213c126458f065a0b10e7e281"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a9391a2ed305e25493a611c25ed9aa7a2">onDBusGetSubscriberFinished</a> (QDBusObjectPath objectPath)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts using the fresh subscriber interface when it is returned by the manager in response to the GetSubscriber call. <a href="#a9391a2ed305e25493a611c25ed9aa7a2"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a192e933ca4f023f84de709e84fbe47e7">onDBusGetSubscriberFailed</a> (QDBusError err)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a83385b7cf39ae293e6e06705f952f9a1">onDBusSubscribeFinished</a> (QList< QString > keys)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Signals the <a class="el" href="class_context_subscriber_1_1_provider.html" title="Connects to a group of properties via the help of a plugin.">Provider</a> that the subscribe is finished. <a href="#a83385b7cf39ae293e6e06705f952f9a1"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#aca1f1f90efb47950385d5814dadc573d">onDBusSubscribeFailed</a> (QList< QString > keys, QString error)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Signals the <a class="el" href="class_context_subscriber_1_1_provider.html" title="Connects to a group of properties via the help of a plugin.">Provider</a> that the subscribe is failed. <a href="#aca1f1f90efb47950385d5814dadc573d"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#aef61e0a51dad4988fe264474cb2bdd7d">onProviderAppeared</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a new subscriber interface from manager when the provider appears. <a href="#aef61e0a51dad4988fe264474cb2bdd7d"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a0ebafac80dca92564323f78a1fbfa6b7">onProviderDisappeared</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete our subscriber interface when the provider goes away. <a href="#a0ebafac80dca92564323f78a1fbfa6b7"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a325ac3f7f3a87587218ee90fb6dd36be">newSubscribe</a> (const QString &key)</td></tr> +<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#ad5959b9c2e4976ad24025492bfd9109c">reset</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QMap< QString, QVariant > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a1f2999785a6f653a95a946bcc09d05ba">mergeNullsWithMap</a> (QMap< QString, QVariant > &map, QStringList nulls) const </td></tr> +<tr><td colspan="2"><h2>Static Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a59577eace322abd960442ad4e86f381b">keyToPath</a> (QString key)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts a key name to a protocol level object path. <a href="#a59577eace322abd960442ad4e86f381b"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a3bf2af611eaccdca68e577c01b2a7607">pathToKey</a> (QString key)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Inverse of <code>keyToPath</code>. <a href="#a3bf2af611eaccdca68e577c01b2a7607"></a><br/></td></tr> +<tr><td colspan="2"><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_context_subscriber_1_1_d_bus_name_listener.html">DBusNameListener</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a0e34a8c4b3dafd66d2a094cf2ee22424">providerListener</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Listens to provider's (dis)appearance over DBus. <a href="#a0e34a8c4b3dafd66d2a094cf2ee22424"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html">SubscriberInterface</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#ac5cf234581bce7834ff86d57b5bcb331">subscriberInterface</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The D-Bus interface for the Subscriber object. <a href="#ac5cf234581bce7834ff86d57b5bcb331"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QDBusAbstractInterface * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#afde8f2ee5e10b6625f3b023d6ad3523b">managerInterface</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The D-Bus interface for the Manager object. <a href="#afde8f2ee5e10b6625f3b023d6ad3523b"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QDBusConnection * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a0be51b23a1acd297bb9155d611d37270">connection</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The connection to DBus. <a href="#a0be51b23a1acd297bb9155d611d37270"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a80103689b09397c9a399987df806af1c">busName</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The D-Bus service name of the ContextKit provider connected to. <a href="#a80103689b09397c9a399987df806af1c"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#aae19463cfcd2a2925420e9befaa42783">newProtocol</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The provider on D-Bus speaks the new protocol only. <a href="#aae19463cfcd2a2925420e9befaa42783"></a><br/></td></tr> +<tr><td colspan="2"><h2>Static Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static const QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a73f07ee2c97993ecefe0b0787cc33523">managerIName</a> = "org.freedesktop.ContextKit.Manager"</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">org.freedesktop.ContextKit.Manager <a href="#a73f07ee2c97993ecefe0b0787cc33523"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static const QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#ac65d96beebc2af0eda5b79462c531836">subscriberIName</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">org.freedesktop.ContextKit.Subscriber <a href="#ac65d96beebc2af0eda5b79462c531836"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static const QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#ad8141ab741a7d60ba3d1e067f0bb290e">managerPath</a> = "/org/freedesktop/ContextKit/Manager"</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">/org/freedesktop/ContextKit/Manager <a href="#ad8141ab741a7d60ba3d1e067f0bb290e"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static const QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a0ec50bd2ac114b96bb7a2b203aa1273a">propertyIName</a> = "org.maemo.contextkit.Property"</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">org.maemo.contextkit.Property <a href="#a0ec50bd2ac114b96bb7a2b203aa1273a"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static const QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#ab46c98a850ad26f29b8256ace7317ea5">corePrefix</a> = "/org/maemo/contextkit/"</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">/org/maemo/contextkit/ <a href="#ab46c98a850ad26f29b8256ace7317ea5"></a><br/></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>Implementation of the ContextKit D-Bus protocol. </p> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="ab3728dd869ea64e058f4f7c35a4bb067"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::ContextKitPlugin" ref="ab3728dd869ea64e058f4f7c35a4bb067" args="(const QDBusConnection bus, const QString &busName)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ContextSubscriber::ContextKitPlugin::ContextKitPlugin </td> + <td>(</td> + <td class="paramtype">const QDBusConnection </td> + <td class="paramname"> <em>bus</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>busName</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Creates subscriber and manager interface, tries to get a subscriber instance from the manager and starts listening for provider appearing and disappearing on D-Bus. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a659b0f0fcb7a740975fadc55c670bbf7"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::failed" ref="a659b0f0fcb7a740975fadc55c670bbf7" args="(QString error)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::failed </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>error</em></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Emitted when the GetSubscriber call fails or provider not on D-Bus at all. </p> + +<p>Reimplemented from <a class="el" href="class_context_subscriber_1_1_i_provider_plugin.html#a2b38e3432ffbe7006ffcbe696e4331dd">ContextSubscriber::IProviderPlugin</a>.</p> + +</div> +</div> +<a class="anchor" id="a59577eace322abd960442ad4e86f381b"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::keyToPath" ref="a59577eace322abd960442ad4e86f381b" args="(QString key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString ContextSubscriber::ContextKitPlugin::keyToPath </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em></td> + <td> ) </td> + <td><code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Converts a key name to a protocol level object path. </p> +<p>There is a distinction, because core properties have the form <code>/org/maemo/contextkit/Screen/TopEdge</code> on D-Bus level, but on higher levels they are <code>Screen.TopEdge</code>. Non-core properties should simply have a name like /com/nokia/modem/Specific/Feature, so they can be used as object paths without further conversions. </p> + +</div> +</div> +<a class="anchor" id="a1f2999785a6f653a95a946bcc09d05ba"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::mergeNullsWithMap" ref="a1f2999785a6f653a95a946bcc09d05ba" args="(QMap< QString, QVariant > &map, QStringList nulls) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QMap<QString, QVariant>& ContextSubscriber::ContextKitPlugin::mergeNullsWithMap </td> + <td>(</td> + <td class="paramtype">QMap< QString, QVariant > & </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QStringList </td> + <td class="paramname"> <em>nulls</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> const<code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a325ac3f7f3a87587218ee90fb6dd36be"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::newSubscribe" ref="a325ac3f7f3a87587218ee90fb6dd36be" args="(const QString &key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::newSubscribe </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>key</em></td> + <td> ) </td> + <td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a192e933ca4f023f84de709e84fbe47e7"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::onDBusGetSubscriberFailed" ref="a192e933ca4f023f84de709e84fbe47e7" args="(QDBusError err)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::onDBusGetSubscriberFailed </td> + <td>(</td> + <td class="paramtype">QDBusError </td> + <td class="paramname"> <em>err</em></td> + <td> ) </td> + <td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a9391a2ed305e25493a611c25ed9aa7a2"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::onDBusGetSubscriberFinished" ref="a9391a2ed305e25493a611c25ed9aa7a2" args="(QDBusObjectPath objectPath)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::onDBusGetSubscriberFinished </td> + <td>(</td> + <td class="paramtype">QDBusObjectPath </td> + <td class="paramname"> <em>objectPath</em></td> + <td> ) </td> + <td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Starts using the fresh subscriber interface when it is returned by the manager in response to the GetSubscriber call. </p> + +</div> +</div> +<a class="anchor" id="aca1f1f90efb47950385d5814dadc573d"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::onDBusSubscribeFailed" ref="aca1f1f90efb47950385d5814dadc573d" args="(QList< QString > keys, QString error)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::onDBusSubscribeFailed </td> + <td>(</td> + <td class="paramtype">QList< QString > </td> + <td class="paramname"> <em>keys</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>error</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Signals the <a class="el" href="class_context_subscriber_1_1_provider.html" title="Connects to a group of properties via the help of a plugin.">Provider</a> that the subscribe is failed. </p> + +</div> +</div> +<a class="anchor" id="a83385b7cf39ae293e6e06705f952f9a1"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::onDBusSubscribeFinished" ref="a83385b7cf39ae293e6e06705f952f9a1" args="(QList< QString > keys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::onDBusSubscribeFinished </td> + <td>(</td> + <td class="paramtype">QList< QString > </td> + <td class="paramname"> <em>keys</em></td> + <td> ) </td> + <td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Signals the <a class="el" href="class_context_subscriber_1_1_provider.html" title="Connects to a group of properties via the help of a plugin.">Provider</a> that the subscribe is finished. </p> + +</div> +</div> +<a class="anchor" id="a119181d213c126458f065a0b10e7e281"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::onDBusValuesChanged" ref="a119181d213c126458f065a0b10e7e281" args="(QMap< QString, QVariant > values)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::onDBusValuesChanged </td> + <td>(</td> + <td class="paramtype">QMap< QString, QVariant > </td> + <td class="paramname"> <em>values</em></td> + <td> ) </td> + <td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Forwards value changes from the wire to the upper layer (<a class="el" href="class_context_subscriber_1_1_provider.html" title="Connects to a group of properties via the help of a plugin.">Provider</a>). </p> + +</div> +</div> +<a class="anchor" id="a87a7194ff406805a3b0d38f47d0a0aff"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::onNewValueChanged" ref="a87a7194ff406805a3b0d38f47d0a0aff" args="(QList< QVariant > value, quint64 timestamp, QDBusMessage message)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::onNewValueChanged </td> + <td>(</td> + <td class="paramtype">QList< QVariant > </td> + <td class="paramname"> <em>value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">quint64 </td> + <td class="paramname"> <em>timestamp</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QDBusMessage </td> + <td class="paramname"> <em>message</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="aef61e0a51dad4988fe264474cb2bdd7d"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::onProviderAppeared" ref="aef61e0a51dad4988fe264474cb2bdd7d" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::onProviderAppeared </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Gets a new subscriber interface from manager when the provider appears. </p> + +</div> +</div> +<a class="anchor" id="a0ebafac80dca92564323f78a1fbfa6b7"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::onProviderDisappeared" ref="a0ebafac80dca92564323f78a1fbfa6b7" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::onProviderDisappeared </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Delete our subscriber interface when the provider goes away. </p> + +</div> +</div> +<a class="anchor" id="a3bf2af611eaccdca68e577c01b2a7607"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::pathToKey" ref="a3bf2af611eaccdca68e577c01b2a7607" args="(QString key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString ContextSubscriber::ContextKitPlugin::pathToKey </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em></td> + <td> ) </td> + <td><code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Inverse of <code>keyToPath</code>. </p> + +</div> +</div> +<a class="anchor" id="acb1ad4d2dafa9c137acff2a84916686f"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::ready" ref="acb1ad4d2dafa9c137acff2a84916686f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::ready </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Emitted when the GetSubscriber call returns successfully. </p> + +<p>Reimplemented from <a class="el" href="class_context_subscriber_1_1_i_provider_plugin.html#a236ba3dcfb3fd566fffb89e05855dbf8">ContextSubscriber::IProviderPlugin</a>.</p> + +</div> +</div> +<a class="anchor" id="ad5959b9c2e4976ad24025492bfd9109c"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::reset" ref="ad5959b9c2e4976ad24025492bfd9109c" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::reset </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="aa45ae69058525f998ed5eb0c275cac75"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::subscribe" ref="aa45ae69058525f998ed5eb0c275cac75" args="(QSet< QString > keys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::subscribe </td> + <td>(</td> + <td class="paramtype">QSet< QString > </td> + <td class="paramname"> <em>keys</em></td> + <td> ) </td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Forwards the subscribe request to the wire. </p> + +<p>Implements <a class="el" href="class_context_subscriber_1_1_i_provider_plugin.html#a96f3f5ea81859ddfef63c0e064cba365">ContextSubscriber::IProviderPlugin</a>.</p> + +</div> +</div> +<a class="anchor" id="a803a4bf54f2017025bc314fc14702513"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::subscribeFailed" ref="a803a4bf54f2017025bc314fc14702513" args="(QString failedKey, QString error)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::subscribeFailed </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>failedKey</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>error</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Emitted when Subscribe call fails on D-Bus. </p> + +<p>Reimplemented from <a class="el" href="class_context_subscriber_1_1_i_provider_plugin.html#ae62e69b51185cb0437230916cc306548">ContextSubscriber::IProviderPlugin</a>.</p> + +</div> +</div> +<a class="anchor" id="a4a3fcd522bbb2cc67c5821bcf15ed3d4"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::subscribeFinished" ref="a4a3fcd522bbb2cc67c5821bcf15ed3d4" args="(QString key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::subscribeFinished </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Emitted when Subscribe call succeeds on D-Bus. </p> + +<p>Reimplemented from <a class="el" href="class_context_subscriber_1_1_i_provider_plugin.html#a68cf30909195fcadb259056ad8a8d9ba">ContextSubscriber::IProviderPlugin</a>.</p> + +</div> +</div> +<a class="anchor" id="a4936904e1483e3f06c86e10d65a39e50"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::unsubscribe" ref="a4936904e1483e3f06c86e10d65a39e50" args="(QSet< QString > keys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::unsubscribe </td> + <td>(</td> + <td class="paramtype">QSet< QString > </td> + <td class="paramname"> <em>keys</em></td> + <td> ) </td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Forwards the unsubscribe request to the wire. </p> + +<p>Implements <a class="el" href="class_context_subscriber_1_1_i_provider_plugin.html#a9a5410b5898e5d1efde167752696f2f5">ContextSubscriber::IProviderPlugin</a>.</p> + +</div> +</div> +<a class="anchor" id="a5603631c4a9e7f6a4cbe05af6dfe5c48"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::valueChanged" ref="a5603631c4a9e7f6a4cbe05af6dfe5c48" args="(QString key, QVariant value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextSubscriber::ContextKitPlugin::valueChanged </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QVariant </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Emitted when ValueChanged signal comes on D-Bus. </p> + +<p>Reimplemented from <a class="el" href="class_context_subscriber_1_1_i_provider_plugin.html#a3a106b2d49454337f9269b2ffb07647e">ContextSubscriber::IProviderPlugin</a>.</p> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a80103689b09397c9a399987df806af1c"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::busName" ref="a80103689b09397c9a399987df806af1c" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString <a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a80103689b09397c9a399987df806af1c">ContextSubscriber::ContextKitPlugin::busName</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The D-Bus service name of the ContextKit provider connected to. </p> + +</div> +</div> +<a class="anchor" id="a0be51b23a1acd297bb9155d611d37270"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::connection" ref="a0be51b23a1acd297bb9155d611d37270" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QDBusConnection* <a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a0be51b23a1acd297bb9155d611d37270">ContextSubscriber::ContextKitPlugin::connection</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The connection to DBus. </p> + +</div> +</div> +<a class="anchor" id="ab46c98a850ad26f29b8256ace7317ea5"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::corePrefix" ref="ab46c98a850ad26f29b8256ace7317ea5" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const QString <a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#ab46c98a850ad26f29b8256ace7317ea5">ContextSubscriber::ContextKitPlugin::corePrefix</a> = "/org/maemo/contextkit/"<code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>/org/maemo/contextkit/ </p> + +</div> +</div> +<a class="anchor" id="a73f07ee2c97993ecefe0b0787cc33523"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::managerIName" ref="a73f07ee2c97993ecefe0b0787cc33523" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const QString <a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a73f07ee2c97993ecefe0b0787cc33523">ContextSubscriber::ContextKitPlugin::managerIName</a> = "org.freedesktop.ContextKit.Manager"<code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>org.freedesktop.ContextKit.Manager </p> + +</div> +</div> +<a class="anchor" id="afde8f2ee5e10b6625f3b023d6ad3523b"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::managerInterface" ref="afde8f2ee5e10b6625f3b023d6ad3523b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QDBusAbstractInterface* <a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#afde8f2ee5e10b6625f3b023d6ad3523b">ContextSubscriber::ContextKitPlugin::managerInterface</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The D-Bus interface for the Manager object. </p> + +</div> +</div> +<a class="anchor" id="ad8141ab741a7d60ba3d1e067f0bb290e"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::managerPath" ref="ad8141ab741a7d60ba3d1e067f0bb290e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const QString <a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#ad8141ab741a7d60ba3d1e067f0bb290e">ContextSubscriber::ContextKitPlugin::managerPath</a> = "/org/freedesktop/ContextKit/Manager"<code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>/org/freedesktop/ContextKit/Manager </p> + +</div> +</div> +<a class="anchor" id="aae19463cfcd2a2925420e9befaa42783"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::newProtocol" ref="aae19463cfcd2a2925420e9befaa42783" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#aae19463cfcd2a2925420e9befaa42783">ContextSubscriber::ContextKitPlugin::newProtocol</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The provider on D-Bus speaks the new protocol only. </p> + +</div> +</div> +<a class="anchor" id="a0ec50bd2ac114b96bb7a2b203aa1273a"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::propertyIName" ref="a0ec50bd2ac114b96bb7a2b203aa1273a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const QString <a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a0ec50bd2ac114b96bb7a2b203aa1273a">ContextSubscriber::ContextKitPlugin::propertyIName</a> = "org.maemo.contextkit.Property"<code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>org.maemo.contextkit.Property </p> + +</div> +</div> +<a class="anchor" id="a0e34a8c4b3dafd66d2a094cf2ee22424"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::providerListener" ref="a0e34a8c4b3dafd66d2a094cf2ee22424" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_context_subscriber_1_1_d_bus_name_listener.html">DBusNameListener</a>* <a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#a0e34a8c4b3dafd66d2a094cf2ee22424">ContextSubscriber::ContextKitPlugin::providerListener</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Listens to provider's (dis)appearance over DBus. </p> + +</div> +</div> +<a class="anchor" id="ac65d96beebc2af0eda5b79462c531836"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::subscriberIName" ref="ac65d96beebc2af0eda5b79462c531836" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const QString <a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#ac65d96beebc2af0eda5b79462c531836">ContextSubscriber::ContextKitPlugin::subscriberIName</a><code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>org.freedesktop.ContextKit.Subscriber </p> + +</div> +</div> +<a class="anchor" id="ac5cf234581bce7834ff86d57b5bcb331"></a><!-- doxytag: member="ContextSubscriber::ContextKitPlugin::subscriberInterface" ref="ac5cf234581bce7834ff86d57b5bcb331" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html">SubscriberInterface</a>* <a class="el" href="class_context_subscriber_1_1_context_kit_plugin.html#ac5cf234581bce7834ff86d57b5bcb331">ContextSubscriber::ContextKitPlugin::subscriberInterface</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The D-Bus interface for the Subscriber object. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="contextkitplugin_8h_source.html">contextkitplugin.h</a></li> +<li><a class="el" href="contextkitplugin_8cpp.html">contextkitplugin.cpp</a></li> +</ul> +</div> +<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Nov 27 10:23:11 2009 for libcontextsubscriber 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> |