diff options
Diffstat (limited to 'libcontextprovider/doc/html/contextc_8cpp.html')
| -rw-r--r-- | libcontextprovider/doc/html/contextc_8cpp.html | 447 |
1 files changed, 447 insertions, 0 deletions
diff --git a/libcontextprovider/doc/html/contextc_8cpp.html b/libcontextprovider/doc/html/contextc_8cpp.html new file mode 100644 index 00000000..5c211a5a --- /dev/null +++ b/libcontextprovider/doc/html/contextc_8cpp.html @@ -0,0 +1,447 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>libcontextprovider: contextc.cpp File 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><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>contextc.cpp File Reference</h1><code>#include "<a class="el" href="contextc_8h-source.html">contextc.h</a>"</code><br> +<code>#include "<a class="el" href="service_8h-source.html">service.h</a>"</code><br> +<code>#include "<a class="el" href="property_8h-source.html">property.h</a>"</code><br> +<code>#include "<a class="el" href="group_8h-source.html">group.h</a>"</code><br> +<code>#include "<a class="el" href="logging_8h-source.html">logging.h</a>"</code><br> +<code>#include "<a class="el" href="sconnect_8h-source.html">sconnect.h</a>"</code><br> +<code>#include "<a class="el" href="listeners_8h-source.html">listeners.h</a>"</code><br> +<code>#include "<a class="el" href="loggingfeatures_8h-source.html">loggingfeatures.h</a>"</code><br> +<code>#include <QCoreApplication></code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_context_provider.html">ContextProvider</a></td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#33b9763ab39ce494e115bffcab36360f">context_provider_init</a> (DBusBusType bus_type, const char *bus_name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes and starts the service with a given <em>bus_type</em> and a <em>bus_name</em>. <a href="#33b9763ab39ce494e115bffcab36360f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#35a12d14a227ea7905d9a9e00f1d9e25">context_provider_stop</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Stops the currently started service with context_provider_init. <a href="#35a12d14a227ea7905d9a9e00f1d9e25"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#a6873ed47e24aaa57d4a327afaf24899">context_provider_install_key</a> (const char *key, int clear_values_on_subscribe, <a class="el" href="contextc_8h.html#f72f0df7ce613305c3beabeab61e57dd">ContextProviderSubscriptionChangedCallback</a> subscription_changed_cb, void *subscription_changed_cb_target)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Installs (adds) a <em>key</em> to be provided by the service. <a href="#a6873ed47e24aaa57d4a327afaf24899"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#7c64c17cdf36feb89de45737a37baf3b">context_provider_install_group</a> (char *const *key_group, int clear_values_on_subscribe, <a class="el" href="contextc_8h.html#f72f0df7ce613305c3beabeab61e57dd">ContextProviderSubscriptionChangedCallback</a> subscription_changed_cb, void *subscription_changed_cb_target)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Installs (adds) a <em>key_group</em> to be provided by the service. <a href="#7c64c17cdf36feb89de45737a37baf3b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#ac6f0ad56b4d250a2acb9b1af64eaa84">context_provider_set_integer</a> (const char *key, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the <em>key</em> to a specified integer <em>value</em>. <a href="#ac6f0ad56b4d250a2acb9b1af64eaa84"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#5668b35ebd428a798f8bbc8824edcd8c">context_provider_set_double</a> (const char *key, double value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the <em>key</em> to a specified double <em>value</em>. <a href="#5668b35ebd428a798f8bbc8824edcd8c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#0671fc551fe7ef0a5b51d0f9e3ffad96">context_provider_set_boolean</a> (const char *key, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the <em>key</em> to a specified boolean <em>value</em>. <a href="#0671fc551fe7ef0a5b51d0f9e3ffad96"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#f89f8107bb2b94aee6b356826d72d370">context_provider_set_string</a> (const char *key, const char *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the <em>key</em> to a specified string <em>value</em>. <a href="#f89f8107bb2b94aee6b356826d72d370"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#b50bb9e3b54bf0e47f9cc15b38fb987c">context_provider_set_null</a> (const char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the <em>key</em> to NULL. In other words - unsets the key. <a href="#b50bb9e3b54bf0e47f9cc15b38fb987c"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Variables</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QList< <a class="el" href="class_context_provider_1_1_listener.html">Listener</a> * > * </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#f8e91994e1c1955177da64fc01e70532">listeners</a> = NULL</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#34d7542664850bdf79197020d3e9532f">argv</a> [] = "libcontextprovider"</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#aa1ebe818ec1c763a776cc580551f3e6">p</a> = <a class="el" href="contextc_8cpp.html#34d7542664850bdf79197020d3e9532f">argv</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#d1447518f4372828b8435ae82e48499e">argc</a> = 1</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">QCoreApplication * </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8cpp.html#b751c4ea835b01f1db167e4fbc8f042d">app</a> = 0</td></tr> + +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="33b9763ab39ce494e115bffcab36360f"></a><!-- doxytag: member="contextc.cpp::context_provider_init" ref="33b9763ab39ce494e115bffcab36360f" args="(DBusBusType bus_type, const char *bus_name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int context_provider_init </td> + <td>(</td> + <td class="paramtype">DBusBusType </td> + <td class="paramname"> <em>bus_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>bus_name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Initializes and starts the service with a given <em>bus_type</em> and a <em>bus_name</em>. +<p> +The <em>bus_type</em> can be DBUS_BUS_SESSION or DBUS_BUS_SYSTEM. This function can be called only once till a matching context_provider_stop is called. +</div> +</div><p> +<a class="anchor" name="7c64c17cdf36feb89de45737a37baf3b"></a><!-- doxytag: member="contextc.cpp::context_provider_install_group" ref="7c64c17cdf36feb89de45737a37baf3b" args="(char *const *key_group, int clear_values_on_subscribe, ContextProviderSubscriptionChangedCallback subscription_changed_cb, void *subscription_changed_cb_target)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void context_provider_install_group </td> + <td>(</td> + <td class="paramtype">char *const * </td> + <td class="paramname"> <em>key_group</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>clear_values_on_subscribe</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="contextc_8h.html#f72f0df7ce613305c3beabeab61e57dd">ContextProviderSubscriptionChangedCallback</a> </td> + <td class="paramname"> <em>subscription_changed_cb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>subscription_changed_cb_target</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Installs (adds) a <em>key_group</em> to be provided by the service. +<p> +The <em>key_group</em> is a NULL-terminated array containing the keys. The callback function <em>subscription_changed_cb</em> will be called with the passed user data <em>subscription_changed_cb_target</em> when the status of the subscription changes -- when the first subscriber appears or the last subscriber disappears. The <em>clear_values_on_subscribe</em> when enabled will automatically clear (set to null/undetermined) the group keys on first subscribe. +</div> +</div><p> +<a class="anchor" name="a6873ed47e24aaa57d4a327afaf24899"></a><!-- doxytag: member="contextc.cpp::context_provider_install_key" ref="a6873ed47e24aaa57d4a327afaf24899" args="(const char *key, int clear_values_on_subscribe, ContextProviderSubscriptionChangedCallback subscription_changed_cb, void *subscription_changed_cb_target)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void context_provider_install_key </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>clear_values_on_subscribe</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="contextc_8h.html#f72f0df7ce613305c3beabeab61e57dd">ContextProviderSubscriptionChangedCallback</a> </td> + <td class="paramname"> <em>subscription_changed_cb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>subscription_changed_cb_target</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Installs (adds) a <em>key</em> to be provided by the service. +<p> +The callback function <em>subscription_changed_cb</em> will be called with the passed user data <em>subscription_changed_cb_target</em> when the status of the subscription changes -- when the first subscriber appears or the last subscriber disappears. The <em>clear_values_on_subscribe</em> when enabled will automatically clear (set to null/undetermined) the group keys on first subscribe. +</div> +</div><p> +<a class="anchor" name="0671fc551fe7ef0a5b51d0f9e3ffad96"></a><!-- doxytag: member="contextc.cpp::context_provider_set_boolean" ref="0671fc551fe7ef0a5b51d0f9e3ffad96" args="(const char *key, int value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void context_provider_set_boolean </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the <em>key</em> to a specified boolean <em>value</em>. +<p> + +</div> +</div><p> +<a class="anchor" name="5668b35ebd428a798f8bbc8824edcd8c"></a><!-- doxytag: member="contextc.cpp::context_provider_set_double" ref="5668b35ebd428a798f8bbc8824edcd8c" args="(const char *key, double value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void context_provider_set_double </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the <em>key</em> to a specified double <em>value</em>. +<p> + +</div> +</div><p> +<a class="anchor" name="ac6f0ad56b4d250a2acb9b1af64eaa84"></a><!-- doxytag: member="contextc.cpp::context_provider_set_integer" ref="ac6f0ad56b4d250a2acb9b1af64eaa84" args="(const char *key, int value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void context_provider_set_integer </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the <em>key</em> to a specified integer <em>value</em>. +<p> + +</div> +</div><p> +<a class="anchor" name="b50bb9e3b54bf0e47f9cc15b38fb987c"></a><!-- doxytag: member="contextc.cpp::context_provider_set_null" ref="b50bb9e3b54bf0e47f9cc15b38fb987c" args="(const char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void context_provider_set_null </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the <em>key</em> to NULL. In other words - unsets the key. +<p> + +</div> +</div><p> +<a class="anchor" name="f89f8107bb2b94aee6b356826d72d370"></a><!-- doxytag: member="contextc.cpp::context_provider_set_string" ref="f89f8107bb2b94aee6b356826d72d370" args="(const char *key, const char *value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void context_provider_set_string </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the <em>key</em> to a specified string <em>value</em>. +<p> + +</div> +</div><p> +<a class="anchor" name="35a12d14a227ea7905d9a9e00f1d9e25"></a><!-- doxytag: member="contextc.cpp::context_provider_stop" ref="35a12d14a227ea7905d9a9e00f1d9e25" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void context_provider_stop </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Stops the currently started service with context_provider_init. +<p> +After calling this function a new service can be started by calling context_provider_init. +</div> +</div><p> +<hr><h2>Variable Documentation</h2> +<a class="anchor" name="b751c4ea835b01f1db167e4fbc8f042d"></a><!-- doxytag: member="contextc.cpp::app" ref="b751c4ea835b01f1db167e4fbc8f042d" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QCoreApplication* <a class="el" href="contextc_8cpp.html#b751c4ea835b01f1db167e4fbc8f042d">app</a> = 0 </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="d1447518f4372828b8435ae82e48499e"></a><!-- doxytag: member="contextc.cpp::argc" ref="d1447518f4372828b8435ae82e48499e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="contextc_8cpp.html#d1447518f4372828b8435ae82e48499e">argc</a> = 1 </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="34d7542664850bdf79197020d3e9532f"></a><!-- doxytag: member="contextc.cpp::argv" ref="34d7542664850bdf79197020d3e9532f" args="[]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="contextc_8cpp.html#34d7542664850bdf79197020d3e9532f">argv</a>[] = "libcontextprovider" </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="f8e91994e1c1955177da64fc01e70532"></a><!-- doxytag: member="contextc.cpp::listeners" ref="f8e91994e1c1955177da64fc01e70532" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QList<<a class="el" href="class_context_provider_1_1_listener.html">Listener</a>*>* <a class="el" href="contextc_8cpp.html#f8e91994e1c1955177da64fc01e70532">listeners</a> = NULL </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="aa1ebe818ec1c763a776cc580551f3e6"></a><!-- doxytag: member="contextc.cpp::p" ref="aa1ebe818ec1c763a776cc580551f3e6" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* <a class="el" href="contextc_8cpp.html#aa1ebe818ec1c763a776cc580551f3e6">p</a> = <a class="el" href="contextc_8cpp.html#34d7542664850bdf79197020d3e9532f">argv</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 23 08:58:39 2009 for libcontextprovider 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> |