/usr/share/doc/ibus/html/IBusConfigService.html is in ibus-doc 1.4.1-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IBusConfigService</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="IBus Reference Manual">
<link rel="up" href="ch04.html" title="Configuration">
<link rel="prev" href="IBusConfig.html" title="IBusConfig">
<link rel="next" href="IBusObservedPath.html" title="IBusObservedPath">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="IBusConfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.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">IBus Reference Manual</th>
<td><a accesskey="n" href="IBusObservedPath.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IBusConfigService.synopsis" class="shortcut">Top</a>
|
<a href="#IBusConfigService.description" class="shortcut">Description</a>
|
<a href="#IBusConfigService.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="IBusConfigService"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IBusConfigService.top_of_page"></a>IBusConfigService</span></h2>
<p>IBusConfigService — Configuration service back-end.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="IBusConfigService.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="IBusConfigService.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="IBusConfigService.html#IBusConfigService-struct" title="struct IBusConfigService">IBusConfigService</a>;
struct <a class="link" href="IBusConfigService.html#IBusConfigServiceClass" title="struct IBusConfigServiceClass">IBusConfigServiceClass</a>;
<a class="link" href="IBusConfigService.html" title="IBusConfigService"><span class="returnvalue">IBusConfigService</span></a> * <a class="link" href="IBusConfigService.html#ibus-config-service-new" title="ibus_config_service_new ()">ibus_config_service_new</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GDBusConnection.html"><span class="type">GDBusConnection</span></a> *connection</code></em>);
<span class="returnvalue">void</span> <a class="link" href="IBusConfigService.html#ibus-config-service-value-changed" title="ibus_config_service_value_changed ()">ibus_config_service_value_changed</a> (<em class="parameter"><code><a class="link" href="IBusConfigService.html" title="IBusConfigService"><span class="type">IBusConfigService</span></a> *config</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *section</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="IBusConfigService.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a class="link" href="IBusObject.html" title="IBusObject">IBusObject</a>
+----<a class="link" href="IBusService.html" title="IBusService">IBusService</a>
+----IBusConfigService
</pre>
</div>
<div class="refsect1">
<a name="IBusConfigService.description"></a><h2>Description</h2>
<p>
An IBusConfigService is a base class for other configuration services such as GConf.
Currently, directly known sub class is IBusConfigGConf.
</p>
<p>
IBusConfigServiceClass has following member functions:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>gboolean set_value(IBusConfigService *config, const gchar *section, const gchar *name,
const GValue *value, IBusError **error)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">config:</span></p></td>
<td>A configure service</td>
</tr>
<tr>
<td><p><span class="term">section:</span></p></td>
<td>Section name of the configuration option.</td>
</tr>
<tr>
<td><p><span class="term">name:</span></p></td>
<td>Name of the configuration option.</td>
</tr>
<tr>
<td><p><span class="term">value:</span></p></td>
<td>GValue that holds the value.</td>
</tr>
<tr>
<td><p><span class="term">error:</span></p></td>
<td>Error outputs here.</td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td>TRUE if succeed; FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
<p>Set a value to a configuration option.
</p>
</li>
<li class="listitem">
<p>gboolean get_value(IBusConfigService *config, const gchar *section, const gchar *name,
GValue *value, IBusError **error)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">config:</span></p></td>
<td>A configure service</td>
</tr>
<tr>
<td><p><span class="term">section:</span></p></td>
<td>Section name of the configuration option.</td>
</tr>
<tr>
<td><p><span class="term">name:</span></p></td>
<td>Name of the configuration option.</td>
</tr>
<tr>
<td><p><span class="term">value:</span></p></td>
<td>GValue that holds the value.</td>
</tr>
<tr>
<td><p><span class="term">error:</span></p></td>
<td>Error outputs here.</td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td>TRUE if succeed; FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
<p>Get value of a configuration option.
</p>
</li>
<li class="listitem">
<p>gboolean unset(IBusConfigService *config, const gchar *section, const gchar *name,
IBusError **error)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">config:</span></p></td>
<td>A configure service</td>
</tr>
<tr>
<td><p><span class="term">section:</span></p></td>
<td>Section name of the configuration option.</td>
</tr>
<tr>
<td><p><span class="term">name:</span></p></td>
<td>Name of the configuration option.</td>
</tr>
<tr>
<td><p><span class="term">error:</span></p></td>
<td>Error outputs here.</td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td>TRUE if succeed; FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
<p>Remove an entry to a configuration option.
</p>
</li>
</ul></div>
<p>
</p>
</div>
<div class="refsect1">
<a name="IBusConfigService.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="IBusConfigService-struct"></a><h3>struct IBusConfigService</h3>
<pre class="programlisting">struct IBusConfigService;</pre>
<p>
An opaque data type representing a configure service.
</p>
</div>
<hr>
<div class="refsect2">
<a name="IBusConfigServiceClass"></a><h3>struct IBusConfigServiceClass</h3>
<pre class="programlisting">struct IBusConfigServiceClass {
/* class members */
gboolean (* set_value) (IBusConfigService *config,
const gchar *section,
const gchar *name,
GVariant *value,
GError **error);
/**
* get_value:
* @config: An IBusConfig.
* @section: section name
* @name: value name
*
* @returns: (transfer full): The value in config associated with section and name.
*
*/
GVariant * (* get_value) (IBusConfigService *config,
const gchar *section,
const gchar *name,
GError **error);
gboolean (* unset_value) (IBusConfigService *config,
const gchar *section,
const gchar *name,
GError **error);
GVariant * (* get_values) (IBusConfigService *config,
const gchar *section,
GError **error);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ibus-config-service-new"></a><h3>ibus_config_service_new ()</h3>
<pre class="programlisting"><a class="link" href="IBusConfigService.html" title="IBusConfigService"><span class="returnvalue">IBusConfigService</span></a> * ibus_config_service_new (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GDBusConnection.html"><span class="type">GDBusConnection</span></a> *connection</code></em>);</pre>
<p>
New an IBusConfigService from an GDBusConnection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>An GDBusConnection.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated IBusConfigServices.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-config-service-value-changed"></a><h3>ibus_config_service_value_changed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ibus_config_service_value_changed (<em class="parameter"><code><a class="link" href="IBusConfigService.html" title="IBusConfigService"><span class="type">IBusConfigService</span></a> *config</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *section</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);</pre>
<p>
Change a value of a configuration option
by sending a "ValueChanged" message to IBus service.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>An IBusConfigService.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>section</code></em> :</span></p></td>
<td>Section name of the configuration option.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Name of the configure option.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>GVariant that holds the value.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|