/
ibusconfigservice.h
238 lines (221 loc) · 8.64 KB
/
ibusconfigservice.h
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
/* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/* vim:set et sts=4: */
/* ibus - The Input Bus
* Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
* Copyright (C) 2008-2010 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#if !defined (__IBUS_H_INSIDE__) && !defined (IBUS_COMPILATION)
#error "Only <ibus.h> can be included directly"
#endif
/**
* SECTION: ibusconfigservice
* @short_description: Configuration service back-end.
* @stability: Stable
*
* An IBusConfigService is a base class for other configuration services such as GConf.
* Currently, directly known sub class is IBusConfigGConf.
*
* 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>
* <listitem>
* <para>gboolean unset(IBusConfigService *config, const gchar *section, const gchar *name,
* 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>error:</term>
* <listitem>Error outputs here.</listitem>
* </varlistentry>
* <varlistentry>
* <term>Returns:</term>
* <listitem>TRUE if succeed; FALSE otherwise.</listitem>
* </varlistentry>
* </variablelist>
* <para>Remove an entry to a configuration option.
* </para>
* </listitem>
* </itemizedlist>
*/
#ifndef __IBUS_CONFIG_SERVICE_H_
#define __IBUS_CONFIG_SERVICE_H_
#include "ibusservice.h"
/*
* Type macros.
*/
/* define GOBJECT macros */
#define IBUS_TYPE_CONFIG_SERVICE \
(ibus_config_service_get_type ())
#define IBUS_CONFIG_SERVICE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_CONFIG_SERVICE, IBusConfigService))
#define IBUS_CONFIG_SERVICE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_CONFIG_SERVICE, IBusConfigServiceClass))
#define IBUS_IS_CONFIG_SERVICE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_CONFIG_SERVICE))
#define IBUS_IS_CONFIG_SERVICE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_CONFIG_SERVICE))
#define IBUS_CONFIG_SERVICE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_CONFIG_SERVICE, IBusConfigServiceClass))
G_BEGIN_DECLS
typedef struct _IBusConfigService IBusConfigService;
typedef struct _IBusConfigServiceClass IBusConfigServiceClass;
/**
* IBusConfigService:
*
* An opaque data type representing a configure service.
*/
struct _IBusConfigService {
/*< private >*/
IBusService parent;
/* IBusConfigServicePriv *priv */
/* instance members */
};
struct _IBusConfigServiceClass {
/*< private >*/
IBusServiceClass parent;
/*< public >*/
/* 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);
/*< private >*/
/* padding */
gpointer pdummy[13];
};
GType ibus_config_service_get_type (void);
/**
* ibus_config_service_new:
* @connection: An GDBusConnection.
* @returns: A newly allocated IBusConfigServices.
*
* New an IBusConfigService from an GDBusConnection.
*/
IBusConfigService *ibus_config_service_new (GDBusConnection *connection);
/**
* ibus_config_service_value_changed:
* @config: An IBusConfigService.
* @section: Section name of the configuration option.
* @name: Name of the configure option.
* @value: GVariant that holds the value.
*
* Change a value of a configuration option
* by sending a "ValueChanged" message to IBus service.
*/
void ibus_config_service_value_changed
(IBusConfigService *config,
const gchar *section,
const gchar *name,
GVariant *value);
G_END_DECLS
#endif