diff options
Diffstat (limited to 'libcontextprovider/doc/html/class_context_provider_1_1_subscriber.html')
| -rw-r--r-- | libcontextprovider/doc/html/class_context_provider_1_1_subscriber.html | 241 |
1 files changed, 241 insertions, 0 deletions
diff --git a/libcontextprovider/doc/html/class_context_provider_1_1_subscriber.html b/libcontextprovider/doc/html/class_context_provider_1_1_subscriber.html new file mode 100644 index 00000000..f2072a60 --- /dev/null +++ b/libcontextprovider/doc/html/class_context_provider_1_1_subscriber.html @@ -0,0 +1,241 @@ +<!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>libcontextprovider: ContextProvider::Subscriber 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_provider.html">ContextProvider</a>::<a class="el" href="class_context_provider_1_1_subscriber.html">Subscriber</a> + </div> +</div> +<div class="contents"> +<h1>ContextProvider::Subscriber Class Reference</h1><!-- doxytag: class="ContextProvider::Subscriber" --><!-- doxytag: inherits="ContextProvider::QueuedInvoker" --> +<p><a class="el" href="class_context_provider_1_1_subscriber.html" title="Subscriber implements the org.freedesktop.ContextKit.Subscriber DBus interface with...">Subscriber</a> implements the org.freedesktop.ContextKit.Subscriber DBus interface with help of the SubsciberAdaptor. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="subscriber_8h_source.html">subscriber.h</a>></code></p> + +<p><a href="class_context_provider_1_1_subscriber-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_provider_1_1_subscriber.html#a185b6a3ba9f09b4e45cb4cf011a4b3dc">changed</a> (const QMap< QString, QVariant > &values, const QStringList &undetermined)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when any of the subscribed keys changes it's value. <a href="#a185b6a3ba9f09b4e45cb4cf011a4b3dc"></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_provider_1_1_subscriber.html#abacc217f5389cca9e37f44278752a4c6">Subscriber</a> (const QString &dbusPath, <a class="el" href="class_context_provider_1_1_manager.html">Manager</a> *manager)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#abacc217f5389cca9e37f44278752a4c6"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_subscriber.html#acbaa9a1a17dbd0337b025255df2b9b53">~Subscriber</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the subscriber. <a href="#acbaa9a1a17dbd0337b025255df2b9b53"></a><br/></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_provider_1_1_subscriber.html#a38b01c1486af496970ed00e8bb9dd503">subscribe</a> (const QStringList &keys, QStringList &undetermined)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribes to te specified list of <em>keys</em>. <a href="#a38b01c1486af496970ed00e8bb9dd503"></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_provider_1_1_subscriber.html#ad006229fc6745798dbe55ceb81f88722">unsubscribe</a> (const QStringList &keys)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribes from the passed list of keys. <a href="#ad006229fc6745798dbe55ceb81f88722"></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_provider_1_1_subscriber.html#acc24c10d7e14b445eff6b216ad01caf0">dbusPath</a> () const </td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the dbus object path for this <a class="el" href="class_context_provider_1_1_subscriber.html" title="Subscriber implements the org.freedesktop.ContextKit.Subscriber DBus interface with...">Subscriber</a>. <a href="#acc24c10d7e14b445eff6b216ad01caf0"></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_provider_1_1_subscriber.html#a80406eb66a937045a8071c70ec0f1ba5">isSubscribedToKey</a> (const QString &key)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the <a class="el" href="class_context_provider_1_1_subscriber.html" title="Subscriber implements the org.freedesktop.ContextKit.Subscriber DBus interface with...">Subscriber</a> is currently subscribed to the specified key. <a href="#a80406eb66a937045a8071c70ec0f1ba5"></a><br/></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p><a class="el" href="class_context_provider_1_1_subscriber.html" title="Subscriber implements the org.freedesktop.ContextKit.Subscriber DBus interface with...">Subscriber</a> implements the org.freedesktop.ContextKit.Subscriber DBus interface with help of the SubsciberAdaptor. </p> +<p><a class="el" href="class_context_provider_1_1_subscriber.html" title="Subscriber implements the org.freedesktop.ContextKit.Subscriber DBus interface with...">Subscriber</a> lets the user to suscribe to or unsubscribe from properties and get informed when their values change. </p> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="abacc217f5389cca9e37f44278752a4c6"></a><!-- doxytag: member="ContextProvider::Subscriber::Subscriber" ref="abacc217f5389cca9e37f44278752a4c6" args="(const QString &dbusPath, Manager *manager)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ContextProvider::Subscriber::Subscriber </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>dbusPath</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="class_context_provider_1_1_manager.html">Manager</a> * </td> + <td class="paramname"> <em>man</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Constructor. </p> +<p>Creates a new <a class="el" href="class_context_provider_1_1_subscriber.html" title="Subscriber implements the org.freedesktop.ContextKit.Subscriber DBus interface with...">Subscriber</a> with the given <em>dbusPath</em> object path and a parent <a class="el" href="class_context_provider_1_1_manager.html" title="Manager implements the org.freedesktop.ContextKit.Manager DBus interface. (With the...">Manager</a> <em>man</em>. The <a class="el" href="class_context_provider_1_1_subscriber.html" title="Subscriber implements the org.freedesktop.ContextKit.Subscriber DBus interface with...">Subscriber</a> will use the <a class="el" href="class_context_provider_1_1_manager.html" title="Manager implements the org.freedesktop.ContextKit.Manager DBus interface. (With the...">Manager</a> to obtain values etc. </p> + +</div> +</div> +<a class="anchor" id="acbaa9a1a17dbd0337b025255df2b9b53"></a><!-- doxytag: member="ContextProvider::Subscriber::~Subscriber" ref="acbaa9a1a17dbd0337b025255df2b9b53" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ContextProvider::Subscriber::~Subscriber </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Destroys the subscriber. </p> +<p>Decreases the subscription count on the parent <a class="el" href="class_context_provider_1_1_manager.html" title="Manager implements the org.freedesktop.ContextKit.Manager DBus interface. (With the...">Manager</a> before going down. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a185b6a3ba9f09b4e45cb4cf011a4b3dc"></a><!-- doxytag: member="ContextProvider::Subscriber::changed" ref="a185b6a3ba9f09b4e45cb4cf011a4b3dc" args="(const QMap< QString, QVariant > &values, const QStringList &undetermined)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Subscriber::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>undetermined</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 any of the subscribed keys changes it's value. </p> +<p>The <em>values</em> map contains a mapping of keys -> new values. The <em>undetermined</em> list contains the names of keys that could not be determined. The <em>values</em> and <em>undetermined</em> contains only the keys that actually changed value. </p> + +</div> +</div> +<a class="anchor" id="acc24c10d7e14b445eff6b216ad01caf0"></a><!-- doxytag: member="ContextProvider::Subscriber::dbusPath" ref="acc24c10d7e14b445eff6b216ad01caf0" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString ContextProvider::Subscriber::dbusPath </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Returns the dbus object path for this <a class="el" href="class_context_provider_1_1_subscriber.html" title="Subscriber implements the org.freedesktop.ContextKit.Subscriber DBus interface with...">Subscriber</a>. </p> + +</div> +</div> +<a class="anchor" id="a80406eb66a937045a8071c70ec0f1ba5"></a><!-- doxytag: member="ContextProvider::Subscriber::isSubscribedToKey" ref="a80406eb66a937045a8071c70ec0f1ba5" args="(const QString &key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool ContextProvider::Subscriber::isSubscribedToKey </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>key</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Returns true if the <a class="el" href="class_context_provider_1_1_subscriber.html" title="Subscriber implements the org.freedesktop.ContextKit.Subscriber DBus interface with...">Subscriber</a> is currently subscribed to the specified key. </p> + +</div> +</div> +<a class="anchor" id="a38b01c1486af496970ed00e8bb9dd503"></a><!-- doxytag: member="ContextProvider::Subscriber::subscribe" ref="a38b01c1486af496970ed00e8bb9dd503" args="(const QStringList &keys, QStringList &undetermined)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QMap< QString, QVariant > ContextProvider::Subscriber::subscribe </td> + <td>(</td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>keys</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QStringList & </td> + <td class="paramname"> <em>undetermined</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Subscribes to te specified list of <em>keys</em>. </p> +<p>The keys for which values could not be determined are placed in the <code>undetermined</code> list. Otherwise the current values are placed in the returned map in a key -> value order. </p> + +</div> +</div> +<a class="anchor" id="ad006229fc6745798dbe55ceb81f88722"></a><!-- doxytag: member="ContextProvider::Subscriber::unsubscribe" ref="ad006229fc6745798dbe55ceb81f88722" args="(const QStringList &keys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Subscriber::unsubscribe </td> + <td>(</td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>keys</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Unsubscribes from the passed list of keys. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="subscriber_8h_source.html">subscriber.h</a></li> +<li><a class="el" href="subscriber_8cpp.html">subscriber.cpp</a></li> +</ul> +</div> +<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Oct 19 14:19:52 2009 for libcontextprovider 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> |