diff options
Diffstat (limited to 'libcontextprovider/doc/html/contextc_8h.html')
-rw-r--r-- | libcontextprovider/doc/html/contextc_8h.html | 347 |
1 files changed, 347 insertions, 0 deletions
diff --git a/libcontextprovider/doc/html/contextc_8h.html b/libcontextprovider/doc/html/contextc_8h.html new file mode 100644 index 00000000..dcf39341 --- /dev/null +++ b/libcontextprovider/doc/html/contextc_8h.html @@ -0,0 +1,347 @@ +<!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: contextc.h 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.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><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.h File Reference</h1><code>#include <stdlib.h></code><br/> +<code>#include <dbus/dbus.h></code><br/> + +<p><a href="contextc_8h_source.html">Go to the source code of this file.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8h.html#af72f0df7ce613305c3beabeab61e57dd">ContextProviderSubscriptionChangedCallback</a> )(int subscribe, void *user_data)</td></tr> +<tr><td colspan="2"><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8h.html#a33b9763ab39ce494e115bffcab36360f">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="#a33b9763ab39ce494e115bffcab36360f"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8h.html#a35a12d14a227ea7905d9a9e00f1d9e25">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="#a35a12d14a227ea7905d9a9e00f1d9e25"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8h.html#aa6873ed47e24aaa57d4a327afaf24899">context_provider_install_key</a> (const char *key, int clear_values_on_subscribe, <a class="el" href="contextc_8h.html#af72f0df7ce613305c3beabeab61e57dd">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="#aa6873ed47e24aaa57d4a327afaf24899"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8h.html#a7c64c17cdf36feb89de45737a37baf3b">context_provider_install_group</a> (char *const *key_group, int clear_values_on_subscribe, <a class="el" href="contextc_8h.html#af72f0df7ce613305c3beabeab61e57dd">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="#a7c64c17cdf36feb89de45737a37baf3b"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8h.html#aac6f0ad56b4d250a2acb9b1af64eaa84">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="#aac6f0ad56b4d250a2acb9b1af64eaa84"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8h.html#a5668b35ebd428a798f8bbc8824edcd8c">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="#a5668b35ebd428a798f8bbc8824edcd8c"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8h.html#a0671fc551fe7ef0a5b51d0f9e3ffad96">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="#a0671fc551fe7ef0a5b51d0f9e3ffad96"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8h.html#af89f8107bb2b94aee6b356826d72d370">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="#af89f8107bb2b94aee6b356826d72d370"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="contextc_8h.html#ab50bb9e3b54bf0e47f9cc15b38fb987c">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="#ab50bb9e3b54bf0e47f9cc15b38fb987c"></a><br/></td></tr> +</table> +<hr/><h2>Typedef Documentation</h2> +<a class="anchor" id="af72f0df7ce613305c3beabeab61e57dd"></a><!-- doxytag: member="contextc.h::ContextProviderSubscriptionChangedCallback" ref="af72f0df7ce613305c3beabeab61e57dd" args=")(int subscribe, void *user_data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef void(* <a class="el" href="contextc_8h.html#af72f0df7ce613305c3beabeab61e57dd">ContextProviderSubscriptionChangedCallback</a>)(int subscribe, void *user_data)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<hr/><h2>Function Documentation</h2> +<a class="anchor" id="a33b9763ab39ce494e115bffcab36360f"></a><!-- doxytag: member="contextc.h::context_provider_init" ref="a33b9763ab39ce494e115bffcab36360f" 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> +<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. </p> + +</div> +</div> +<a class="anchor" id="a7c64c17cdf36feb89de45737a37baf3b"></a><!-- doxytag: member="contextc.h::context_provider_install_group" ref="a7c64c17cdf36feb89de45737a37baf3b" 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#af72f0df7ce613305c3beabeab61e57dd">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> +<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. </p> + +</div> +</div> +<a class="anchor" id="aa6873ed47e24aaa57d4a327afaf24899"></a><!-- doxytag: member="contextc.h::context_provider_install_key" ref="aa6873ed47e24aaa57d4a327afaf24899" 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#af72f0df7ce613305c3beabeab61e57dd">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> +<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. </p> + +</div> +</div> +<a class="anchor" id="a0671fc551fe7ef0a5b51d0f9e3ffad96"></a><!-- doxytag: member="contextc.h::context_provider_set_boolean" ref="a0671fc551fe7ef0a5b51d0f9e3ffad96" 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> +<a class="anchor" id="a5668b35ebd428a798f8bbc8824edcd8c"></a><!-- doxytag: member="contextc.h::context_provider_set_double" ref="a5668b35ebd428a798f8bbc8824edcd8c" 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> +<a class="anchor" id="aac6f0ad56b4d250a2acb9b1af64eaa84"></a><!-- doxytag: member="contextc.h::context_provider_set_integer" ref="aac6f0ad56b4d250a2acb9b1af64eaa84" 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> +<a class="anchor" id="ab50bb9e3b54bf0e47f9cc15b38fb987c"></a><!-- doxytag: member="contextc.h::context_provider_set_null" ref="ab50bb9e3b54bf0e47f9cc15b38fb987c" 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> +<a class="anchor" id="af89f8107bb2b94aee6b356826d72d370"></a><!-- doxytag: member="contextc.h::context_provider_set_string" ref="af89f8107bb2b94aee6b356826d72d370" 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> +<a class="anchor" id="a35a12d14a227ea7905d9a9e00f1d9e25"></a><!-- doxytag: member="contextc.h::context_provider_stop" ref="a35a12d14a227ea7905d9a9e00f1d9e25" 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> +<p>After calling this function a new service can be started by calling context_provider_init. </p> + +</div> +</div> +</div> +<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Nov 9 15:30:51 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> |