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
|
/*
* xfconf
*
* Copyright (c) 2007-2008 Brian Tarricone <bjt23@cornell.edu>
*
* 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; version 2
* of the License ONLY.
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef __XFCONF_CHANNEL_H__
#define __XFCONF_CHANNEL_H__
#if !defined(LIBXFCONF_COMPILATION) && !defined(XFCONF_IN_XFCONF_H)
#error "Do not include xfconf-channel.h, as this file may change or disappear in the future. Include <xfconf/xfconf.h> instead."
#endif
#include <glib-object.h>
#define XFCONF_TYPE_CHANNEL (xfconf_channel_get_type())
#define XFCONF_CHANNEL(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), XFCONF_TYPE_CHANNEL, XfconfChannel))
#define XFCONF_IS_CHANNEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), XFCONF_TYPE_CHANNEL))
#define XFCONF_CHANNEL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), XFCONF_TYPE_CHANNEL, XfconfChannelClass))
#define XFCONF_IS_CHANNEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), XFCONF_TYPE_CHANNEL))
#define XFCONF_CHANNEL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), XFCONF_TYPE_CHANNEL, XfconfChannelClass))
G_BEGIN_DECLS
typedef struct _XfconfChannel XfconfChannel;
GType xfconf_channel_get_type(void) G_GNUC_CONST;
XfconfChannel *xfconf_channel_get(const gchar *channel_name);
XfconfChannel *xfconf_channel_new(const gchar *channel_name) G_GNUC_WARN_UNUSED_RESULT;
XfconfChannel *xfconf_channel_new_with_property_base(const gchar *channel_name,
const gchar *property_base) G_GNUC_WARN_UNUSED_RESULT;
gboolean xfconf_channel_has_property(XfconfChannel *channel,
const gchar *property);
gboolean xfconf_channel_is_property_locked(XfconfChannel *channel,
const gchar *property);
void xfconf_channel_reset_property(XfconfChannel *channel,
const gchar *property_base,
gboolean recursive);
GHashTable *xfconf_channel_get_properties(XfconfChannel *channel,
const gchar *property_base) G_GNUC_WARN_UNUSED_RESULT;
/* basic types */
gchar *xfconf_channel_get_string(XfconfChannel *channel,
const gchar *property,
const gchar *default_value) G_GNUC_WARN_UNUSED_RESULT;
gboolean xfconf_channel_set_string(XfconfChannel *channel,
const gchar *property,
const gchar *value);
gint32 xfconf_channel_get_int(XfconfChannel *channel,
const gchar *property,
gint32 default_value);
gboolean xfconf_channel_set_int(XfconfChannel *channel,
const gchar *property,
gint32 value);
guint32 xfconf_channel_get_uint(XfconfChannel *channel,
const gchar *property,
guint32 default_value);
gboolean xfconf_channel_set_uint(XfconfChannel *channel,
const gchar *property,
guint32 value);
guint64 xfconf_channel_get_uint64(XfconfChannel *channel,
const gchar *property,
guint64 default_value);
gboolean xfconf_channel_set_uint64(XfconfChannel *channel,
const gchar *property,
guint64 value);
gdouble xfconf_channel_get_double(XfconfChannel *channel,
const gchar *property,
gdouble default_value);
gboolean xfconf_channel_set_double(XfconfChannel *channel,
const gchar *property,
gdouble value);
gboolean xfconf_channel_get_bool(XfconfChannel *channel,
const gchar *property,
gboolean default_value);
gboolean xfconf_channel_set_bool(XfconfChannel *channel,
const gchar *property,
gboolean value);
/* this is just convenience API for the array stuff, where
* all the values are G_TYPE_STRING */
gchar **xfconf_channel_get_string_list(XfconfChannel *channel,
const gchar *property) G_GNUC_WARN_UNUSED_RESULT;
gboolean xfconf_channel_set_string_list(XfconfChannel *channel,
const gchar *property,
const gchar * const *values);
/* really generic API - can set some value types that aren't
* supported by the basic type API, e.g., char, signed short,
* unsigned int, etc. no, you can't set arbitrary GTypes. */
gboolean xfconf_channel_get_property(XfconfChannel *channel,
const gchar *property,
GValue *value);
gboolean xfconf_channel_set_property(XfconfChannel *channel,
const gchar *property,
const GValue *value);
/* array types - arrays can be made up of values of arbitrary
* (and mixed) types, even some not supported by the basic
* type API */
gboolean xfconf_channel_get_array(XfconfChannel *channel,
const gchar *property,
GType first_value_type,
...);
gboolean xfconf_channel_get_array_valist(XfconfChannel *channel,
const gchar *property,
GType first_value_type,
va_list var_args);
GPtrArray *xfconf_channel_get_arrayv(XfconfChannel *channel,
const gchar *property) G_GNUC_WARN_UNUSED_RESULT;
gboolean xfconf_channel_set_array(XfconfChannel *channel,
const gchar *property,
GType first_value_type,
...);
gboolean xfconf_channel_set_array_valist(XfconfChannel *channel,
const gchar *property,
GType first_value_type,
va_list var_args);
gboolean xfconf_channel_set_arrayv(XfconfChannel *channel,
const gchar *property,
GPtrArray *values);
/* struct types */
gboolean xfconf_channel_get_named_struct(XfconfChannel *channel,
const gchar *property,
const gchar *struct_name,
gpointer value_struct);
gboolean xfconf_channel_set_named_struct(XfconfChannel *channel,
const gchar *property,
const gchar *struct_name,
gpointer value_struct);
gboolean xfconf_channel_get_struct(XfconfChannel *channel,
const gchar *property,
gpointer value_struct,
GType first_member_type,
...);
gboolean xfconf_channel_get_struct_valist(XfconfChannel *channel,
const gchar *property,
gpointer value_struct,
GType first_member_type,
va_list var_args);
gboolean xfconf_channel_get_structv(XfconfChannel *channel,
const gchar *property,
gpointer value_struct,
guint n_members,
GType *member_types);
gboolean xfconf_channel_set_struct(XfconfChannel *channel,
const gchar *property,
const gpointer value_struct,
GType first_member_type,
...);
gboolean xfconf_channel_set_struct_valist(XfconfChannel *channel,
const gchar *property,
const gpointer value_struct,
GType first_member_type,
va_list var_args);
gboolean xfconf_channel_set_structv(XfconfChannel *channel,
const gchar *property,
const gpointer value_struct,
guint n_members,
GType *member_types);
#if 0 /* future (maybe) */
//gboolean xfconf_channel_begin_transaction(XfconfChannel *channel);
//gboolean xfconf_channel_commit_transaction(XfconfChannel *channel);
//void xfconf_channel_cancel_transaction(XfconfChannel *channel);
#endif
G_END_DECLS
#endif /* __XFCONF_CHANNEL_H__ */
|
