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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="IBusConfigService">
<refmeta>
<refentrytitle role="top_of_page" id="IBusConfigService.top_of_page">IBusConfigService</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>IBUS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>IBusConfigService</refname>
<refpurpose>Configuration service back-end.</refpurpose>
</refnamediv>
<refsect1 id="IBusConfigService.stability-level">
<title>Stability Level</title>
Stable, unless otherwise indicated
</refsect1>
<refsynopsisdiv id="IBusConfigService.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="IBusConfigService-struct">IBusConfigService</link>;
<link linkend="IBusConfigService">IBusConfigService</link> * <link linkend="ibus-config-service-new">ibus_config_service_new</link> (<link linkend="IBusConnection">IBusConnection</link> *connection);
<link linkend="void">void</link> <link linkend="ibus-config-service-value-changed">ibus_config_service_value_changed</link> (<link linkend="IBusConfigService">IBusConfigService</link> *config,
const <link linkend="gchar">gchar</link> *section,
const <link linkend="gchar">gchar</link> *name,
const <link linkend="GValue">GValue</link> *value);
</synopsis>
</refsynopsisdiv>
<refsect1 id="IBusConfigService.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="IBusObject">IBusObject</link>
+----<link linkend="IBusService">IBusService</link>
+----IBusConfigService
</synopsis>
</refsect1>
<refsect1 id="IBusConfigService.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="IBusConfigService--connection">connection</link>" <link linkend="IBusConnection">IBusConnection</link>* : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="IBusConfigService.description" role="desc">
<title role="desc.title">Description</title>
<para>
An IBusConfigService is a base class for other configuration services such as GConf.
Currently, directly known sub class is IBusConfigGConf.
</para>
<para>
IBusConfigServiceClass has following member functions:
<itemizedlist>
<listitem>
<para>gboolean set_value(IBusConfigService *config, const gchar *section, const gchar *name,
const GValue *value, IBusError **error)
</para>
<variablelist>
<varlistentry>
<term>config:</term>
<listitem>A configure service</listitem>
</varlistentry>
<varlistentry>
<term>section:</term>
<listitem>Section name of the configuration option.</listitem>
</varlistentry>
<varlistentry>
<term>name:</term>
<listitem>Name of the configuration option.</listitem>
</varlistentry>
<varlistentry>
<term>value:</term>
<listitem>GValue that holds the value.</listitem>
</varlistentry>
<varlistentry>
<term>error:</term>
<listitem>Error outputs here.</listitem>
</varlistentry>
<varlistentry>
<term>Returns:</term>
<listitem>TRUE if succeed; FALSE otherwise.</listitem>
</varlistentry>
</variablelist>
<para>Set a value to a configuration option.
</para>
</listitem>
<listitem>
<para>gboolean get_value(IBusConfigService *config, const gchar *section, const gchar *name,
GValue *value, IBusError **error)
</para>
<variablelist>
<varlistentry>
<term>config:</term>
<listitem>A configure service</listitem>
</varlistentry>
<varlistentry>
<term>section:</term>
<listitem>Section name of the configuration option.</listitem>
</varlistentry>
<varlistentry>
<term>name:</term>
<listitem>Name of the configuration option.</listitem>
</varlistentry>
<varlistentry>
<term>value:</term>
<listitem>GValue that holds the value.</listitem>
</varlistentry>
<varlistentry>
<term>error:</term>
<listitem>Error outputs here.</listitem>
</varlistentry>
<varlistentry>
<term>Returns:</term>
<listitem>TRUE if succeed; FALSE otherwise.</listitem>
</varlistentry>
</variablelist>
<para>Get value of a configuration option.
</para>
</listitem>
</itemizedlist></para>
<para>
</para>
</refsect1>
<refsect1 id="IBusConfigService.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="IBusConfigService-struct" role="struct">
<title>IBusConfigService</title>
<indexterm zone="IBusConfigService-struct"><primary sortas="IBusConfigService">IBusConfigService</primary></indexterm><programlisting>typedef struct _IBusConfigService IBusConfigService;</programlisting>
<para>
An opaque data type representing a configure service.</para>
<para>
</para></refsect2>
<refsect2 id="ibus-config-service-new" role="function">
<title>ibus_config_service_new ()</title>
<indexterm zone="ibus-config-service-new"><primary sortas="ibus_config_service_new">ibus_config_service_new</primary></indexterm><programlisting><link linkend="IBusConfigService">IBusConfigService</link> * ibus_config_service_new (<link linkend="IBusConnection">IBusConnection</link> *connection);</programlisting>
<para>
New an IBusConfigService from an IBusConnection.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>connection</parameter> :</term>
<listitem><simpara> An IBusConnection.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated IBusConfigServices.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ibus-config-service-value-changed" role="function">
<title>ibus_config_service_value_changed ()</title>
<indexterm zone="ibus-config-service-value-changed"><primary sortas="ibus_config_service_value_changed">ibus_config_service_value_changed</primary></indexterm><programlisting><link linkend="void">void</link> ibus_config_service_value_changed (<link linkend="IBusConfigService">IBusConfigService</link> *config,
const <link linkend="gchar">gchar</link> *section,
const <link linkend="gchar">gchar</link> *name,
const <link linkend="GValue">GValue</link> *value);</programlisting>
<para>
Change a value of a configuration option
by sending a "ValueChanged" message to IBus service.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An IBusConfigService.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>section</parameter> :</term>
<listitem><simpara> Section name of the configuration option.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> Name of the configure option.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> GValue that holds the value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="IBusConfigService.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="IBusConfigService--connection" role="property"><title>The <literal>"connection"</literal> property</title>
<indexterm zone="IBusConfigService--connection"><primary sortas="IBusConfigService:connection">IBusConfigService:connection</primary></indexterm><programlisting> "connection" <link linkend="IBusConnection">IBusConnection</link>* : Read / Write / Construct Only</programlisting>
<para>
Connection of this IBusConfigService.</para>
<para>
</para></refsect2>
</refsect1>
</refentry>
|