diff options
Diffstat (limited to 'doc/reference/libcontextprovider/html/libcontextprovider-ContextProviderChangeSet.html')
| -rw-r--r-- | doc/reference/libcontextprovider/html/libcontextprovider-ContextProviderChangeSet.html | 297 |
1 files changed, 297 insertions, 0 deletions
diff --git a/doc/reference/libcontextprovider/html/libcontextprovider-ContextProviderChangeSet.html b/doc/reference/libcontextprovider/html/libcontextprovider-ContextProviderChangeSet.html new file mode 100644 index 00000000..f142cf09 --- /dev/null +++ b/doc/reference/libcontextprovider/html/libcontextprovider-ContextProviderChangeSet.html @@ -0,0 +1,297 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ContextProviderChangeSet</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.73.2"> +<link rel="start" href="index.html" title="libcontextprovider Reference Manual"> +<link rel="up" href="ch01.html" title="ContextKit Context provider C Interface"> +<link rel="prev" href="libcontextprovider-Context-provider-setup.html" title="Context provider setup"> +<link rel="next" href="libcontextprovider-ContextProviderStringSet.html" title="ContextProviderStringSet"> +<meta name="generator" content="GTK-Doc V1.11 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +<link rel="chapter" href="ch01.html" title="ContextKit Context provider C Interface"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libcontextprovider-Context-provider-setup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">libcontextprovider Reference Manual</th> +<td><a accesskey="n" href="libcontextprovider-ContextProviderStringSet.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libcontextprovider-ContextProviderChangeSet.synopsis" class="shortcut">Top</a> + | + <a href="#libcontextprovider-ContextProviderChangeSet.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry" lang="en"> +<a name="libcontextprovider-ContextProviderChangeSet"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libcontextprovider-ContextProviderChangeSet.top_of_page"></a>ContextProviderChangeSet</span></h2> +<p>ContextProviderChangeSet — Context value change handling</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="libcontextprovider-ContextProviderChangeSet.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> + +#include <context_provider.h> + + <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a>; +<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a>* <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#context-provider-change-set-create" title="context_provider_change_set_create ()">context_provider_change_set_create</a> + (void); +<a +href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean" +>gboolean</a> <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#context-provider-change-set-commit" title="context_provider_change_set_commit ()">context_provider_change_set_commit</a> (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *change_set); +void <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#context-provider-change-set-cancel" title="context_provider_change_set_cancel ()">context_provider_change_set_cancel</a> (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *change_set); +void <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#context-provider-change-set-add-boolean" title="context_provider_change_set_add_boolean ()">context_provider_change_set_add_boolean</a> + (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *self, + const char *key, + <a +href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean" +>gboolean</a> value); +void <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#context-provider-change-set-add-integer" title="context_provider_change_set_add_integer ()">context_provider_change_set_add_integer</a> + (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *self, + const char *key, + <a +href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint" +>gint</a> value); +void <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#context-provider-change-set-add-double" title="context_provider_change_set_add_double ()">context_provider_change_set_add_double</a> + (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *self, + const char *key, + double value); +void <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#context-provider-change-set-add-undetermined-key" title="context_provider_change_set_add_undetermined_key ()">context_provider_change_set_add_undetermined_key</a> + (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *self, + const char *key); +</pre> +</div> +<div class="refsect1" lang="en"> +<a name="libcontextprovider-ContextProviderChangeSet.description"></a><h2>Description</h2> +<p> +<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet"><span class="type">ContextProviderChangeSet</span></a> is used to signal changes to contextual values by a provider. +As a provider you can asynchronously emit value changes for keys which you are providing +by creating a <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet"><span class="type">ContextProviderChangeSet</span></a> and commiting it using <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#context-provider-change-set-commit" title="context_provider_change_set_commit ()"><span class="type">context_provider_change_set_commit</span></a>. +<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet"><span class="type">ContextProviderChangeSet</span></a> can also be provided to you, for example in +<a class="link" href="libcontextprovider-Context-provider-setup.html#ContextProviderGetCallback" title="ContextProviderGetCallback ()"><span class="type">ContextProviderGetCallback</span></a>. In this case, you should simply add the values requested +and return without calling <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#context-provider-change-set-commit" title="context_provider_change_set_commit ()"><span class="type">context_provider_change_set_commit</span></a>.</p> +<p> +</p> +</div> +<div class="refsect1" lang="en"> +<a name="libcontextprovider-ContextProviderChangeSet.details"></a><h2>Details</h2> +<div class="refsect2" lang="en"> +<a name="ContextProviderChangeSet"></a><h3>ContextProviderChangeSet</h3> +<pre class="programlisting">typedef struct { + GTypeInstance parent_instance; + volatile int ref_count; + ContextProviderChangeSetPrivate * priv; + GeeArrayList* undeterminable_keys; +} ContextProviderChangeSet; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" lang="en"> +<a name="context-provider-change-set-create"></a><h3>context_provider_change_set_create ()</h3> +<pre class="programlisting"><a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a>* context_provider_change_set_create + (void);</pre> +<p> +Create a new change set to emit key changes</p> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> a new <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet"><span class="type">ContextProviderChangeSet</span></a> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" lang="en"> +<a name="context-provider-change-set-commit"></a><h3>context_provider_change_set_commit ()</h3> +<pre class="programlisting"><a +href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean" +>gboolean</a> context_provider_change_set_commit (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *change_set);</pre> +<p> +Emits the contents of the changeset to all +listeners interested in the properties that have changed.</p> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>change_set</code></em> :</span></p></td> +<td> a <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet"><span class="type">ContextProviderChangeSet</span></a> to commit +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> TRUE if changes were emitted +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" lang="en"> +<a name="context-provider-change-set-cancel"></a><h3>context_provider_change_set_cancel ()</h3> +<pre class="programlisting">void context_provider_change_set_cancel (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *change_set);</pre> +<p> +Cancels a changeset, cleaning up without emitting the contents.</p> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>change_set</code></em> :</span></p></td> +<td> a <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet"><span class="type">ContextProviderChangeSet</span></a> to cancel +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" lang="en"> +<a name="context-provider-change-set-add-boolean"></a><h3>context_provider_change_set_add_boolean ()</h3> +<pre class="programlisting">void context_provider_change_set_add_boolean + (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *self, + const char *key, + <a +href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean" +>gboolean</a> value);</pre> +<p> +Set a key to have an boolean value of <span class="type">val</span></p> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td> a <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet"><span class="type">ContextProviderChangeSet</span></a> to add a value to +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td> name of key +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td> new value of key +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" lang="en"> +<a name="context-provider-change-set-add-integer"></a><h3>context_provider_change_set_add_integer ()</h3> +<pre class="programlisting">void context_provider_change_set_add_integer + (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *self, + const char *key, + <a +href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint" +>gint</a> value);</pre> +<p> +Set a key to have an integer value of <span class="type">value</span></p> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td> a <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet"><span class="type">ContextProviderChangeSet</span></a> to add a value to +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td> name of key +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td> new value of key +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" lang="en"> +<a name="context-provider-change-set-add-double"></a><h3>context_provider_change_set_add_double ()</h3> +<pre class="programlisting">void context_provider_change_set_add_double + (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *self, + const char *key, + double value);</pre> +<p> +Set a key to have an floating point value of <span class="type">value</span></p> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td> a <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet"><span class="type">ContextProviderChangeSet</span></a> to add a value to +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td> name of key +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td> new value of key +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" lang="en"> +<a name="context-provider-change-set-add-undetermined-key"></a><h3>context_provider_change_set_add_undetermined_key ()</h3> +<pre class="programlisting">void context_provider_change_set_add_undetermined_key + (<a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet">ContextProviderChangeSet</a> *self, + const char *key);</pre> +<p> +Marks <span class="type">key</span> as not having a determinable value.</p> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td> a <a class="link" href="libcontextprovider-ContextProviderChangeSet.html#ContextProviderChangeSet" title="ContextProviderChangeSet"><span class="type">ContextProviderChangeSet</span></a> to which to add an undeterminable value +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td> name of key +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="libcontextprovider-ContextProviderChangeSet.see-also"></a><h2>See Also</h2> +#ContextProviderGetCallback +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.11</div> +</body> +</html> |