diff options
Diffstat (limited to 'libcontextsubscriber/doc/html/class_context_subscriber_1_1_subscriber_interface.html')
| -rw-r--r-- | libcontextsubscriber/doc/html/class_context_subscriber_1_1_subscriber_interface.html | 453 |
1 files changed, 453 insertions, 0 deletions
diff --git a/libcontextsubscriber/doc/html/class_context_subscriber_1_1_subscriber_interface.html b/libcontextsubscriber/doc/html/class_context_subscriber_1_1_subscriber_interface.html new file mode 100644 index 00000000..553c141b --- /dev/null +++ b/libcontextsubscriber/doc/html/class_context_subscriber_1_1_subscriber_interface.html @@ -0,0 +1,453 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>libcontextsubscriber: ContextSubscriber::SubscriberInterface 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.5.8 --> +<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_subscriber_interface.html">SubscriberInterface</a> + </div> +</div> +<div class="contents"> +<h1>ContextSubscriber::SubscriberInterface Class Reference</h1><!-- doxytag: class="ContextSubscriber::SubscriberInterface" --><code>#include <<a class="el" href="subscriberinterface_8h-source.html">subscriberinterface.h</a>></code> +<p> + +<p> +<a href="class_context_subscriber_1_1_subscriber_interface-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Signals</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#960dc79d9b47fbbda16e6eed05826c5d">valuesChanged</a> (QMap< QString, QVariant > values)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#1705fc2b48624313ef52f279ede97e5b">subscribeFinished</a> (QList< QString > keys)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#0e99f03c74e942caed4a12013771a4d2">subscribeFailed</a> (QList< QString > keys, QString error)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#af5cbaccd8318fd13389b2da11b03e7c">Changed</a> (const QMap< QString, QVariant > &values, const QStringList &unknownKeys)</td></tr> + +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#87e096c9a1ecfb1453d29722731fbb51">SubscriberInterface</a> (const QDBusConnection connection, const QString &busName, const QString &objectPath, QObject *parent=0)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the <a class="el" href="class_context_subscriber_1_1_subscriber_interface.html">SubscriberInterface</a>. <a href="#87e096c9a1ecfb1453d29722731fbb51"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#da9126ec7363321f97124a4edc6553ec">subscribe</a> (QSet< QString > keys)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Calls the Subscribe function over DBus asynchronously. <a href="#da9126ec7363321f97124a4edc6553ec"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#4227c404be7915805dbab93e0704914d">unsubscribe</a> (QSet< QString > keys)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Calls the Unsubscribe function over DBus asynchronously. <a href="#4227c404be7915805dbab93e0704914d"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#1c7ee2c99941a60bc1a3d43aa794063b">connectNotify</a> (const char *signal)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#9f726b29f65d7340ac2df345cf462c66">disconnectNotify</a> (const char *signal)</td></tr> + +<tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#6ebfcf76e474281993e681afb15975c9">interfaceName</a> = "org.freedesktop.ContextKit.Subscriber"</td></tr> + +<tr><td colspan="2"><br><h2>Private Slots</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#5405b720d8596ab0abbc2ce817a61b14">onSubscribeFinished</a> (QDBusPendingCallWatcher *watcher)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Is called when the asynchronous DBus call to Subscribe has finished. <a href="#5405b720d8596ab0abbc2ce817a61b14"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#20de105eef3bdd1de40708536a7f4238">onChanged</a> (const QMap< QString, QVariant > &values, const QStringList &unknownKeys)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Processes the results of the Changed signal which comes over DBus. <a href="#20de105eef3bdd1de40708536a7f4238"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#7acaf30ea27426e6aa00207e0310980c">SubscriberInterface</a> (const <a class="el" href="class_context_subscriber_1_1_subscriber_interface.html">SubscriberInterface</a> &other)</td></tr> + +<tr><td class="memItemLeft" nowrap 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_subscriber_interface.html#a9b18edfb5899e8884a1c3c7c7d5caff">operator=</a> (const <a class="el" href="class_context_subscriber_1_1_subscriber_interface.html">SubscriberInterface</a> &other)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">QMap< QString, QVariant > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#913f90d59398e97fbb363c84b0d3c403">mergeNullsWithMap</a> (QMap< QString, QVariant > &map, QStringList nulls) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A helper function. Sets the values of given keys to a null QVariant in a QMap. <a href="#913f90d59398e97fbb363c84b0d3c403"></a><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="87e096c9a1ecfb1453d29722731fbb51"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::SubscriberInterface" ref="87e096c9a1ecfb1453d29722731fbb51" args="(const QDBusConnection connection, const QString &busName, const QString &objectPath, QObject *parent=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SubscriberInterface::SubscriberInterface </td> + <td>(</td> + <td class="paramtype">const QDBusConnection </td> + <td class="paramname"> <em>connection</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>busName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>objectPath</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QObject * </td> + <td class="paramname"> <em>parent</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructs the <a class="el" href="class_context_subscriber_1_1_subscriber_interface.html">SubscriberInterface</a>. +<p> +Connects to the DBus object specified by <em>busType</em> (session or system bus), <em>busName</em> and <em>objectPath</em>. +</div> +</div><p> +<a class="anchor" name="7acaf30ea27426e6aa00207e0310980c"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::SubscriberInterface" ref="7acaf30ea27426e6aa00207e0310980c" args="(const SubscriberInterface &other)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ContextSubscriber::SubscriberInterface::SubscriberInterface </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_context_subscriber_1_1_subscriber_interface.html">SubscriberInterface</a> & </td> + <td class="paramname"> <em>other</em> </td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="af5cbaccd8318fd13389b2da11b03e7c"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::Changed" ref="af5cbaccd8318fd13389b2da11b03e7c" args="(const QMap< QString, QVariant > &values, const QStringList &unknownKeys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void SubscriberInterface::Changed </td> + <td>(</td> + <td class="paramtype">const QMap< QString, QVariant > & </td> + <td class="paramname"> <em>values</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>unknownKeys</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> + +</div> +</div><p> +<a class="anchor" name="1c7ee2c99941a60bc1a3d43aa794063b"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::connectNotify" ref="1c7ee2c99941a60bc1a3d43aa794063b" args="(const char *signal)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void SubscriberInterface::connectNotify </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>signal</em> </td> + <td> ) </td> + <td><code> [protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="9f726b29f65d7340ac2df345cf462c66"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::disconnectNotify" ref="9f726b29f65d7340ac2df345cf462c66" args="(const char *signal)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void SubscriberInterface::disconnectNotify </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>signal</em> </td> + <td> ) </td> + <td><code> [protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="913f90d59398e97fbb363c84b0d3c403"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::mergeNullsWithMap" ref="913f90d59398e97fbb363c84b0d3c403" args="(QMap< QString, QVariant > &map, QStringList nulls) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QMap< QString, QVariant > & SubscriberInterface::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"> + +<p> +A helper function. Sets the values of given keys to a null QVariant in a QMap. +<p> + +</div> +</div><p> +<a class="anchor" name="20de105eef3bdd1de40708536a7f4238"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::onChanged" ref="20de105eef3bdd1de40708536a7f4238" args="(const QMap< QString, QVariant > &values, const QStringList &unknownKeys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void SubscriberInterface::onChanged </td> + <td>(</td> + <td class="paramtype">const QMap< QString, QVariant > & </td> + <td class="paramname"> <em>values</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>unknownKeys</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> +Processes the results of the Changed signal which comes over DBus. +<p> + +</div> +</div><p> +<a class="anchor" name="5405b720d8596ab0abbc2ce817a61b14"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::onSubscribeFinished" ref="5405b720d8596ab0abbc2ce817a61b14" args="(QDBusPendingCallWatcher *watcher)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void SubscriberInterface::onSubscribeFinished </td> + <td>(</td> + <td class="paramtype">QDBusPendingCallWatcher * </td> + <td class="paramname"> <em>watcher</em> </td> + <td> ) </td> + <td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Is called when the asynchronous DBus call to Subscribe has finished. +<p> +Emits the signal valuesChanged with the return values of the subscribed keys. +</div> +</div><p> +<a class="anchor" name="a9b18edfb5899e8884a1c3c7c7d5caff"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::operator=" ref="a9b18edfb5899e8884a1c3c7c7d5caff" args="(const SubscriberInterface &other)" --> +<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>& ContextSubscriber::SubscriberInterface::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_context_subscriber_1_1_subscriber_interface.html">SubscriberInterface</a> & </td> + <td class="paramname"> <em>other</em> </td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="da9126ec7363321f97124a4edc6553ec"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::subscribe" ref="da9126ec7363321f97124a4edc6553ec" args="(QSet< QString > keys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void SubscriberInterface::subscribe </td> + <td>(</td> + <td class="paramtype">QSet< QString > </td> + <td class="paramname"> <em>keys</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Calls the Subscribe function over DBus asynchronously. +<p> + +</div> +</div><p> +<a class="anchor" name="0e99f03c74e942caed4a12013771a4d2"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::subscribeFailed" ref="0e99f03c74e942caed4a12013771a4d2" args="(QList< QString > keys, QString error)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void SubscriberInterface::subscribeFailed </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> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="1705fc2b48624313ef52f279ede97e5b"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::subscribeFinished" ref="1705fc2b48624313ef52f279ede97e5b" args="(QList< QString > keys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void SubscriberInterface::subscribeFinished </td> + <td>(</td> + <td class="paramtype">QList< QString > </td> + <td class="paramname"> <em>keys</em> </td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="4227c404be7915805dbab93e0704914d"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::unsubscribe" ref="4227c404be7915805dbab93e0704914d" args="(QSet< QString > keys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void SubscriberInterface::unsubscribe </td> + <td>(</td> + <td class="paramtype">QSet< QString > </td> + <td class="paramname"> <em>keys</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Calls the Unsubscribe function over DBus asynchronously. +<p> + +</div> +</div><p> +<a class="anchor" name="960dc79d9b47fbbda16e6eed05826c5d"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::valuesChanged" ref="960dc79d9b47fbbda16e6eed05826c5d" args="(QMap< QString, QVariant > values)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void SubscriberInterface::valuesChanged </td> + <td>(</td> + <td class="paramtype">QMap< QString, QVariant > </td> + <td class="paramname"> <em>values</em> </td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="6ebfcf76e474281993e681afb15975c9"></a><!-- doxytag: member="ContextSubscriber::SubscriberInterface::interfaceName" ref="6ebfcf76e474281993e681afb15975c9" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char * <a class="el" href="class_context_subscriber_1_1_subscriber_interface.html#6ebfcf76e474281993e681afb15975c9">SubscriberInterface::interfaceName</a> = "org.freedesktop.ContextKit.Subscriber"<code> [static, protected]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="subscriberinterface_8h-source.html">subscriberinterface.h</a><li><a class="el" href="mocs_8cpp.html">mocs.cpp</a><li><a class="el" href="subscriberinterface_8cpp.html">subscriberinterface.cpp</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 23 08:59:23 2009 for libcontextsubscriber by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> +</body> +</html> |