← Back to branch summary

~ubuntu-branches/ubuntu/karmic/ibus/karmic-updates

« back to all changes in this revision

Viewing changes to docs/reference/ibus/html/IBusConfigService.html

  • Committer: Bazaar Package Importer
  • Author(s): LI Daobing
  • Date: 2009-06-13 11:39:05 UTC
  • mfrom: (1.1.3 upstream) (6.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20090613113905-0mfi5hhoz8w9y6k2
Tags: 1.1.0.20090612-1
http://bugs.debian.org/532163
* new upstream release.
* Fix "python-ibus should depends on iso-codes" (Closes: #532163)
* debian/libibus0.symbols: update symbols

Show diffs side-by-side

added added

removed removed

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