← Back to branch summary

~ubuntu-branches/debian/squeeze/avant-window-navigator/squeeze

« back to all changes in this revision

Viewing changes to doc/reference/xml/awn-config-client.xml

  • Committer: Bazaar Package Importer
  • Author(s): Julien Lavergne
  • Date: 2008-05-24 14:42:01 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080524144201-r3v8e4g2hv2q1i9x
Tags: 0.2.6-6
http://bugs.debian.org/482030
* debian/patches/04-fix-colormap.patch
 - Fix crash in awn-manager if colormap == None. Thanks Emme for the 
   patch. (Closes: #482030) 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/awn-config-client.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="libawn-awn-config-client">
 
5
<refmeta>
 
6
<refentrytitle role="top_of_page">awn-config-client</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>LIBAWN Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>awn-config-client</refname>
 
13
<refpurpose>The configuration API for both Awn proper and
 
14
Awn applets.
 
15
<parameter>include</parameter> libawn/awn-config-client.h</refpurpose>
 
16
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
17
</refnamediv>
 
18
 
 
19
<refsynopsisdiv role="synopsis">
 
20
<title role="synopsis.title">Synopsis</title>
 
21
 
 
22
<synopsis>
 
23
 
 
24
 
 
25
 
 
26
                    <link linkend="AwnConfigClient">AwnConfigClient</link>;
 
27
#define             <link linkend="AWN-CONFIG-CLIENT:CAPS">AWN_CONFIG_CLIENT</link>                   (obj)
 
28
                    <link linkend="AwnConfigClientNotifyEntry">AwnConfigClientNotifyEntry</link>;
 
29
<link linkend="void">void</link>                (<link linkend="AwnConfigClientNotifyFunc">*AwnConfigClientNotifyFunc</link>)        (<link linkend="AwnConfigClientNotifyEntry">AwnConfigClientNotifyEntry</link> *entry,
 
30
                                                         <link linkend="gpointer">gpointer</link> data);
 
31
#define             <link linkend="AWN-CONFIG-CLIENT-DEFAULT-GROUP:CAPS">AWN_CONFIG_CLIENT_DEFAULT_GROUP</link>
 
32
enum                <link linkend="AwnConfigValueType">AwnConfigValueType</link>;
 
33
enum                <link linkend="AwnConfigListType">AwnConfigListType</link>;
 
34
<link linkend="AwnConfigClient">AwnConfigClient</link>*    <link linkend="awn-config-client-new">awn_config_client_new</link>               ();
 
35
<link linkend="AwnConfigClient">AwnConfigClient</link>*    <link linkend="awn-config-client-new-for-applet">awn_config_client_new_for_applet</link>    (<link linkend="gchar">gchar</link> *name,
 
36
                                                         <link linkend="gchar">gchar</link> *uid);
 
37
<link linkend="void">void</link>                <link linkend="awn-config-client-clear">awn_config_client_clear</link>             (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
38
                                                         <link linkend="GError">GError</link> **err);
 
39
<link linkend="void">void</link>                <link linkend="awn-config-client-ensure-group">awn_config_client_ensure_group</link>      (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
40
                                                         const <link linkend="gchar">gchar</link> *group);
 
41
<link linkend="void">void</link>                <link linkend="awn-config-client-notify-add">awn_config_client_notify_add</link>        (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
42
                                                         const <link linkend="gchar">gchar</link> *group,
 
43
                                                         const <link linkend="gchar">gchar</link> *key,
 
44
                                                         <link linkend="AwnConfigClientNotifyFunc">AwnConfigClientNotifyFunc</link> callback,
 
45
                                                         <link linkend="gpointer">gpointer</link> data);
 
46
<link linkend="gboolean">gboolean</link>            <link linkend="awn-config-client-entry-exists">awn_config_client_entry_exists</link>      (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
47
                                                         const <link linkend="gchar">gchar</link> *group,
 
48
                                                         const <link linkend="gchar">gchar</link> *key);
 
49
<link linkend="gboolean">gboolean</link>            <link linkend="awn-config-client-get-bool">awn_config_client_get_bool</link>          (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
50
                                                         const <link linkend="gchar">gchar</link> *group,
 
51
                                                         const <link linkend="gchar">gchar</link> *key,
 
52
                                                         <link linkend="GError">GError</link> **err);
 
53
<link linkend="void">void</link>                <link linkend="awn-config-client-set-bool">awn_config_client_set_bool</link>          (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
54
                                                         const <link linkend="gchar">gchar</link> *group,
 
55
                                                         const <link linkend="gchar">gchar</link> *key,
 
56
                                                         <link linkend="gboolean">gboolean</link> value,
 
57
                                                         <link linkend="GError">GError</link> **err);
 
58
<link linkend="gfloat">gfloat</link>              <link linkend="awn-config-client-get-float">awn_config_client_get_float</link>         (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
59
                                                         const <link linkend="gchar">gchar</link> *group,
 
60
                                                         const <link linkend="gchar">gchar</link> *key,
 
61
                                                         <link linkend="GError">GError</link> **err);
 
62
<link linkend="void">void</link>                <link linkend="awn-config-client-set-float">awn_config_client_set_float</link>         (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
63
                                                         const <link linkend="gchar">gchar</link> *group,
 
64
                                                         const <link linkend="gchar">gchar</link> *key,
 
65
                                                         <link linkend="gfloat">gfloat</link> value,
 
66
                                                         <link linkend="GError">GError</link> **err);
 
67
<link linkend="gint">gint</link>                <link linkend="awn-config-client-get-int">awn_config_client_get_int</link>           (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
68
                                                         const <link linkend="gchar">gchar</link> *group,
 
69
                                                         const <link linkend="gchar">gchar</link> *key,
 
70
                                                         <link linkend="GError">GError</link> **err);
 
71
<link linkend="void">void</link>                <link linkend="awn-config-client-set-int">awn_config_client_set_int</link>           (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
72
                                                         const <link linkend="gchar">gchar</link> *group,
 
73
                                                         const <link linkend="gchar">gchar</link> *key,
 
74
                                                         <link linkend="gint">gint</link> value,
 
75
                                                         <link linkend="GError">GError</link> **err);
 
76
<link linkend="gchar">gchar</link>*              <link linkend="awn-config-client-get-string">awn_config_client_get_string</link>        (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
77
                                                         const <link linkend="gchar">gchar</link> *group,
 
78
                                                         const <link linkend="gchar">gchar</link> *key,
 
79
                                                         <link linkend="GError">GError</link> **err);
 
80
<link linkend="void">void</link>                <link linkend="awn-config-client-set-string">awn_config_client_set_string</link>        (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
81
                                                         const <link linkend="gchar">gchar</link> *group,
 
82
                                                         const <link linkend="gchar">gchar</link> *key,
 
83
                                                         <link linkend="gchar">gchar</link> *value,
 
84
                                                         <link linkend="GError">GError</link> **err);
 
85
<link linkend="GSList">GSList</link>*             <link linkend="awn-config-client-get-list">awn_config_client_get_list</link>          (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
86
                                                         const <link linkend="gchar">gchar</link> *group,
 
87
                                                         const <link linkend="gchar">gchar</link> *key,
 
88
                                                         <link linkend="AwnConfigListType">AwnConfigListType</link> list_type,
 
89
                                                         <link linkend="GError">GError</link> **err);
 
90
<link linkend="void">void</link>                <link linkend="awn-config-client-set-list">awn_config_client_set_list</link>          (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
91
                                                         const <link linkend="gchar">gchar</link> *group,
 
92
                                                         const <link linkend="gchar">gchar</link> *key,
 
93
                                                         <link linkend="AwnConfigListType">AwnConfigListType</link> list_type,
 
94
                                                         <link linkend="GSList">GSList</link> *value,
 
95
                                                         <link linkend="GError">GError</link> **err);
 
96
</synopsis>
 
97
</refsynopsisdiv>
 
98
 
 
99
 
 
100
 
 
101
 
 
102
 
 
103
 
 
104
 
 
105
 
 
106
 
 
107
<refsect1 role="desc">
 
108
<title role="desc.title">Description</title>
 
109
<para>
 
110
A configuration wrapper API that supports both a GConf backend, as well as
 
111
a GKeyFile-based backend.  Used for both Awn proper and its applets.</para>
 
112
<para>
 
113
 
 
114
</para>
 
115
</refsect1>
 
116
 
 
117
<refsect1 role="details">
 
118
<title role="details.title">Details</title>
 
119
<refsect2>
 
120
<title><anchor id="AwnConfigClient" role="struct"/>AwnConfigClient</title>
 
121
<indexterm><primary>AwnConfigClient</primary></indexterm><programlisting>typedef struct _AwnConfigClient AwnConfigClient;</programlisting>
 
122
<para>
 
123
An opaque structure that facilitates having multiple configuration backends
 
124
available to Awn.</para>
 
125
<para>
 
126
 
 
127
</para></refsect2>
 
128
<refsect2>
 
129
<title><anchor id="AWN-CONFIG-CLIENT:CAPS" role="macro"/>AWN_CONFIG_CLIENT()</title>
 
130
<indexterm><primary>AWN_CONFIG_CLIENT</primary></indexterm><programlisting>#define AWN_CONFIG_CLIENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), AWN_TYPE_CONFIG_CLIENT, AwnConfigClient))
 
131
</programlisting>
 
132
<para>
 
133
Casts a variable/value to be an <link linkend="AwnConfigClient"><type>AwnConfigClient</type></link>.</para>
 
134
<para>
 
135
 
 
136
</para><variablelist role="params">
 
137
<varlistentry><term><parameter>obj</parameter>&nbsp;:</term>
 
138
<listitem><simpara> The variable/value to cast
 
139
</simpara></listitem></varlistentry>
 
140
</variablelist></refsect2>
 
141
<refsect2>
 
142
<title><anchor id="AwnConfigClientNotifyEntry" role="struct"/>AwnConfigClientNotifyEntry</title>
 
143
<indexterm><primary>AwnConfigClientNotifyEntry</primary></indexterm><programlisting>typedef struct {
 
144
        AwnConfigClient *client;
 
145
        gchar *group;
 
146
        gchar *key;
 
147
        AwnConfigClientValue value;
 
148
} AwnConfigClientNotifyEntry;
 
149
</programlisting>
 
150
<para>
 
151
The structure used to transport data to the notification functions of
 
152
a configuration entry.</para>
 
153
<para>
 
154
 
 
155
</para><variablelist role="struct">
 
156
<varlistentry>
 
157
<term><link linkend="AwnConfigClient">AwnConfigClient</link>&nbsp;*<structfield>client</structfield>;</term>
 
158
<listitem><simpara> The client associated with the entry.
 
159
</simpara></listitem>
 
160
</varlistentry>
 
161
<varlistentry>
 
162
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>group</structfield>;</term>
 
163
<listitem><simpara> The group name of the entry.
 
164
</simpara></listitem>
 
165
</varlistentry>
 
166
<varlistentry>
 
167
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>key</structfield>;</term>
 
168
<listitem><simpara> The key name of the entry.
 
169
</simpara></listitem>
 
170
</varlistentry>
 
171
<varlistentry>
 
172
<term><link linkend="AwnConfigClientValue">AwnConfigClientValue</link>&nbsp;<structfield>value</structfield>;</term>
 
173
<listitem><simpara> The new value of the entry.
 
174
</simpara></listitem>
 
175
</varlistentry>
 
176
</variablelist></refsect2>
 
177
<refsect2>
 
178
<title><anchor id="AwnConfigClientNotifyFunc" role="function"/>AwnConfigClientNotifyFunc ()</title>
 
179
<indexterm><primary>AwnConfigClientNotifyFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*AwnConfigClientNotifyFunc)        (<link linkend="AwnConfigClientNotifyEntry">AwnConfigClientNotifyEntry</link> *entry,
 
180
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
 
181
<para>
 
182
The callback template for configuration change notification functions.</para>
 
183
<para>
 
184
 
 
185
</para><variablelist role="params">
 
186
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
187
<listitem><simpara> The metadata about the new entry value.
 
188
</simpara></listitem></varlistentry>
 
189
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
190
<listitem><simpara> Extra data passed to the callback, as defined in the call
 
191
to <link linkend="awn-config-client-notify-add"><function>awn_config_client_notify_add()</function></link>.
 
192
</simpara></listitem></varlistentry>
 
193
</variablelist></refsect2>
 
194
<refsect2>
 
195
<title><anchor id="AWN-CONFIG-CLIENT-DEFAULT-GROUP:CAPS" role="macro"/>AWN_CONFIG_CLIENT_DEFAULT_GROUP</title>
 
196
<indexterm><primary>AWN_CONFIG_CLIENT_DEFAULT_GROUP</primary></indexterm><programlisting>#define AWN_CONFIG_CLIENT_DEFAULT_GROUP "DEFAULT"
 
197
</programlisting>
 
198
<para>
 
199
In the <link linkend="GKeyFile"><type>GKeyFile</type></link> backend, the group name with which "top-level" configuration
 
200
entries are associated.</para>
 
201
<para>
 
202
 
 
203
</para></refsect2>
 
204
<refsect2>
 
205
<title><anchor id="AwnConfigValueType" role="enum"/>enum AwnConfigValueType</title>
 
206
<indexterm><primary>AwnConfigValueType</primary></indexterm><programlisting>typedef enum {
 
207
        AWN_CONFIG_VALUE_TYPE_NULL = -1,
 
208
        AWN_CONFIG_VALUE_TYPE_BOOL,
 
209
        AWN_CONFIG_VALUE_TYPE_FLOAT,
 
210
        AWN_CONFIG_VALUE_TYPE_INT,
 
211
        AWN_CONFIG_VALUE_TYPE_STRING,
 
212
        AWN_CONFIG_VALUE_TYPE_LIST_BOOL,
 
213
        AWN_CONFIG_VALUE_TYPE_LIST_FLOAT,
 
214
        AWN_CONFIG_VALUE_TYPE_LIST_INT,
 
215
        AWN_CONFIG_VALUE_TYPE_LIST_STRING
 
216
} AwnConfigValueType;
 
217
</programlisting>
 
218
<para>
 
219
Indicates the value type of a particular configuration entry.</para>
 
220
<para>
 
221
 
 
222
</para><variablelist role="enum">
 
223
<varlistentry>
 
224
<term><anchor id="AWN-CONFIG-VALUE-TYPE-NULL:CAPS" role="constant"/><literal>AWN_CONFIG_VALUE_TYPE_NULL</literal></term>
 
225
<listitem><simpara> Indicates that the configuration value type
 
226
is unknown.
 
227
</simpara></listitem>
 
228
</varlistentry>
 
229
<varlistentry>
 
230
<term><anchor id="AWN-CONFIG-VALUE-TYPE-BOOL:CAPS" role="constant"/><literal>AWN_CONFIG_VALUE_TYPE_BOOL</literal></term>
 
231
<listitem><simpara> Indicates that the configuration value type
 
232
is boolean.
 
233
</simpara></listitem>
 
234
</varlistentry>
 
235
<varlistentry>
 
236
<term><anchor id="AWN-CONFIG-VALUE-TYPE-FLOAT:CAPS" role="constant"/><literal>AWN_CONFIG_VALUE_TYPE_FLOAT</literal></term>
 
237
<listitem><simpara> Indicates that the configuration value type
 
238
is float.
 
239
</simpara></listitem>
 
240
</varlistentry>
 
241
<varlistentry>
 
242
<term><anchor id="AWN-CONFIG-VALUE-TYPE-INT:CAPS" role="constant"/><literal>AWN_CONFIG_VALUE_TYPE_INT</literal></term>
 
243
<listitem><simpara> Indicates that the configuration value type
 
244
is integer.
 
245
</simpara></listitem>
 
246
</varlistentry>
 
247
<varlistentry>
 
248
<term><anchor id="AWN-CONFIG-VALUE-TYPE-STRING:CAPS" role="constant"/><literal>AWN_CONFIG_VALUE_TYPE_STRING</literal></term>
 
249
<listitem><simpara> Indicates that the configuration value type
 
250
is string.
 
251
</simpara></listitem>
 
252
</varlistentry>
 
253
<varlistentry>
 
254
<term><anchor id="AWN-CONFIG-VALUE-TYPE-LIST-BOOL:CAPS" role="constant"/><literal>AWN_CONFIG_VALUE_TYPE_LIST_BOOL</literal></term>
 
255
<listitem><simpara> Indicates that the configuration value
 
256
type is list whose items are booleans.
 
257
</simpara></listitem>
 
258
</varlistentry>
 
259
<varlistentry>
 
260
<term><anchor id="AWN-CONFIG-VALUE-TYPE-LIST-FLOAT:CAPS" role="constant"/><literal>AWN_CONFIG_VALUE_TYPE_LIST_FLOAT</literal></term>
 
261
<listitem><simpara> Indicates that the configuration value
 
262
type is list whose items are floats.
 
263
</simpara></listitem>
 
264
</varlistentry>
 
265
<varlistentry>
 
266
<term><anchor id="AWN-CONFIG-VALUE-TYPE-LIST-INT:CAPS" role="constant"/><literal>AWN_CONFIG_VALUE_TYPE_LIST_INT</literal></term>
 
267
<listitem><simpara> Indicates that the configuration value
 
268
type is list whose items are integers.
 
269
</simpara></listitem>
 
270
</varlistentry>
 
271
<varlistentry>
 
272
<term><anchor id="AWN-CONFIG-VALUE-TYPE-LIST-STRING:CAPS" role="constant"/><literal>AWN_CONFIG_VALUE_TYPE_LIST_STRING</literal></term>
 
273
<listitem><simpara> Indicates that the configuration value
 
274
type is list whose items are strings.
 
275
</simpara></listitem>
 
276
</varlistentry>
 
277
</variablelist></refsect2>
 
278
<refsect2>
 
279
<title><anchor id="AwnConfigListType" role="enum"/>enum AwnConfigListType</title>
 
280
<indexterm><primary>AwnConfigListType</primary></indexterm><programlisting>typedef enum {
 
281
        AWN_CONFIG_CLIENT_LIST_TYPE_BOOL,
 
282
        AWN_CONFIG_CLIENT_LIST_TYPE_FLOAT,
 
283
        AWN_CONFIG_CLIENT_LIST_TYPE_INT,
 
284
        AWN_CONFIG_CLIENT_LIST_TYPE_STRING
 
285
} AwnConfigListType;
 
286
</programlisting>
 
287
<para>
 
288
Indicates the value type of every item in a configuration entry of
 
289
type "list".</para>
 
290
<para>
 
291
 
 
292
</para><variablelist role="enum">
 
293
<varlistentry>
 
294
<term><anchor id="AWN-CONFIG-CLIENT-LIST-TYPE-BOOL:CAPS" role="constant"/><literal>AWN_CONFIG_CLIENT_LIST_TYPE_BOOL</literal></term>
 
295
<listitem><simpara> Indicates that the list value type
 
296
is boolean.
 
297
</simpara></listitem>
 
298
</varlistentry>
 
299
<varlistentry>
 
300
<term><anchor id="AWN-CONFIG-CLIENT-LIST-TYPE-FLOAT:CAPS" role="constant"/><literal>AWN_CONFIG_CLIENT_LIST_TYPE_FLOAT</literal></term>
 
301
<listitem><simpara> Indicates that the list value type
 
302
is float.
 
303
</simpara></listitem>
 
304
</varlistentry>
 
305
<varlistentry>
 
306
<term><anchor id="AWN-CONFIG-CLIENT-LIST-TYPE-INT:CAPS" role="constant"/><literal>AWN_CONFIG_CLIENT_LIST_TYPE_INT</literal></term>
 
307
<listitem><simpara> Indicates that the list value type
 
308
is integer.
 
309
</simpara></listitem>
 
310
</varlistentry>
 
311
<varlistentry>
 
312
<term><anchor id="AWN-CONFIG-CLIENT-LIST-TYPE-STRING:CAPS" role="constant"/><literal>AWN_CONFIG_CLIENT_LIST_TYPE_STRING</literal></term>
 
313
<listitem><simpara> Indicates that the list value type
 
314
is string.
 
315
</simpara></listitem>
 
316
</varlistentry>
 
317
</variablelist></refsect2>
 
318
<refsect2>
 
319
<title><anchor id="awn-config-client-new" role="function"/>awn_config_client_new ()</title>
 
320
<indexterm><primary>awn_config_client_new</primary></indexterm><programlisting><link linkend="AwnConfigClient">AwnConfigClient</link>*    awn_config_client_new               ();</programlisting>
 
321
<para>
 
322
Retrieves the configuration client for Awn proper.  If none exists,
 
323
one is created.</para>
 
324
<para>
 
325
 
 
326
</para><variablelist role="params">
 
327
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a singleton instance of <link linkend="AwnConfigClient"><type>AwnConfigClient</type></link>.
 
328
</simpara></listitem></varlistentry>
 
329
</variablelist></refsect2>
 
330
<refsect2>
 
331
<title><anchor id="awn-config-client-new-for-applet" role="function"/>awn_config_client_new_for_applet ()</title>
 
332
<indexterm><primary>awn_config_client_new_for_applet</primary></indexterm><programlisting><link linkend="AwnConfigClient">AwnConfigClient</link>*    awn_config_client_new_for_applet    (<link linkend="gchar">gchar</link> *name,
 
333
                                                         <link linkend="gchar">gchar</link> *uid);</programlisting>
 
334
<para>
 
335
Creates a configuration client for the applet named in the parameter.  If
 
336
<parameter>uid</parameter> is not defined, it is implied that the applet is a singleton.</para>
 
337
<para>
 
338
 
 
339
</para><variablelist role="params">
 
340
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
341
<listitem><simpara> The name of the applet.
 
342
</simpara></listitem></varlistentry>
 
343
<varlistentry><term><parameter>uid</parameter>&nbsp;:</term>
 
344
<listitem><simpara> The unique identifier for the applet (used for positioning on the
 
345
dock).  Optional value (i.e., may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>).
 
346
</simpara></listitem></varlistentry>
 
347
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an instance of <link linkend="AwnConfigClient"><type>AwnConfigClient</type></link> for the specified applet.
 
348
</simpara></listitem></varlistentry>
 
349
</variablelist></refsect2>
 
350
<refsect2>
 
351
<title><anchor id="awn-config-client-clear" role="function"/>awn_config_client_clear ()</title>
 
352
<indexterm><primary>awn_config_client_clear</primary></indexterm><programlisting><link linkend="void">void</link>                awn_config_client_clear             (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
353
                                                         <link linkend="GError">GError</link> **err);</programlisting>
 
354
<para>
 
355
Removes all of the configuration entries from the client.</para>
 
356
<para>
 
357
 
 
358
</para><variablelist role="params">
 
359
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
360
<listitem><simpara> The configuration client that is to be used.
 
361
</simpara></listitem></varlistentry>
 
362
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 
363
<listitem><simpara> The pointer to the <link linkend="GError"><type>GError</type></link> structure that contains an error
 
364
message on failure.
 
365
</simpara></listitem></varlistentry>
 
366
</variablelist></refsect2>
 
367
<refsect2>
 
368
<title><anchor id="awn-config-client-ensure-group" role="function"/>awn_config_client_ensure_group ()</title>
 
369
<indexterm><primary>awn_config_client_ensure_group</primary></indexterm><programlisting><link linkend="void">void</link>                awn_config_client_ensure_group      (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
370
                                                         const <link linkend="gchar">gchar</link> *group);</programlisting>
 
371
<para>
 
372
Ensures that the <parameter>group</parameter> named has been created in the configuration backend.</para>
 
373
<para>
 
374
 
 
375
</para><variablelist role="params">
 
376
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
377
<listitem><simpara> The configuration client to be queried.
 
378
</simpara></listitem></varlistentry>
 
379
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
380
<listitem><simpara> The name of the group.
 
381
</simpara></listitem></varlistentry>
 
382
</variablelist></refsect2>
 
383
<refsect2>
 
384
<title><anchor id="awn-config-client-notify-add" role="function"/>awn_config_client_notify_add ()</title>
 
385
<indexterm><primary>awn_config_client_notify_add</primary></indexterm><programlisting><link linkend="void">void</link>                awn_config_client_notify_add        (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
386
                                                         const <link linkend="gchar">gchar</link> *group,
 
387
                                                         const <link linkend="gchar">gchar</link> *key,
 
388
                                                         <link linkend="AwnConfigClientNotifyFunc">AwnConfigClientNotifyFunc</link> callback,
 
389
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
 
390
<para>
 
391
Associates a callback function with a group and a key, which is called
 
392
when that key's value has been modified in some way.</para>
 
393
<para>
 
394
 
 
395
</para><variablelist role="params">
 
396
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
397
<listitem><simpara> The configuration client that is to be used.
 
398
</simpara></listitem></varlistentry>
 
399
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
400
<listitem><simpara> The name of the group.
 
401
</simpara></listitem></varlistentry>
 
402
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
403
<listitem><simpara> The name of the key.
 
404
</simpara></listitem></varlistentry>
 
405
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
406
<listitem><simpara> The function that is called when the key value has been modified.
 
407
</simpara></listitem></varlistentry>
 
408
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
409
<listitem><simpara> Extra data that is passed to the callback.
 
410
</simpara></listitem></varlistentry>
 
411
</variablelist></refsect2>
 
412
<refsect2>
 
413
<title><anchor id="awn-config-client-entry-exists" role="function"/>awn_config_client_entry_exists ()</title>
 
414
<indexterm><primary>awn_config_client_entry_exists</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            awn_config_client_entry_exists      (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
415
                                                         const <link linkend="gchar">gchar</link> *group,
 
416
                                                         const <link linkend="gchar">gchar</link> *key);</programlisting>
 
417
<para>
 
418
Determines whether the group and key exists in the configuration backend.</para>
 
419
<para>
 
420
 
 
421
</para><variablelist role="params">
 
422
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
423
<listitem><simpara> The configuration client that is to be queried.
 
424
</simpara></listitem></varlistentry>
 
425
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
426
<listitem><simpara> The name of the group.
 
427
</simpara></listitem></varlistentry>
 
428
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
429
<listitem><simpara> The name of the key.
 
430
</simpara></listitem></varlistentry>
 
431
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
 
432
</simpara></listitem></varlistentry>
 
433
</variablelist></refsect2>
 
434
<refsect2>
 
435
<title><anchor id="awn-config-client-get-bool" role="function"/>awn_config_client_get_bool ()</title>
 
436
<indexterm><primary>awn_config_client_get_bool</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            awn_config_client_get_bool          (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
437
                                                         const <link linkend="gchar">gchar</link> *group,
 
438
                                                         const <link linkend="gchar">gchar</link> *key,
 
439
                                                         <link linkend="GError">GError</link> **err);</programlisting>
 
440
<para>
 
441
Retrieves the value (as a boolean) of the specified group and key.</para>
 
442
<para>
 
443
 
 
444
</para><variablelist role="params">
 
445
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
446
<listitem><simpara> The configuration client that is to be queried.
 
447
</simpara></listitem></varlistentry>
 
448
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
449
<listitem><simpara> The name of the group.
 
450
</simpara></listitem></varlistentry>
 
451
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
452
<listitem><simpara> The name of the key.
 
453
</simpara></listitem></varlistentry>
 
454
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 
455
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> structure, which contains an error message
 
456
if the function fails.
 
457
</simpara></listitem></varlistentry>
 
458
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a boolean value.
 
459
</simpara></listitem></varlistentry>
 
460
</variablelist></refsect2>
 
461
<refsect2>
 
462
<title><anchor id="awn-config-client-set-bool" role="function"/>awn_config_client_set_bool ()</title>
 
463
<indexterm><primary>awn_config_client_set_bool</primary></indexterm><programlisting><link linkend="void">void</link>                awn_config_client_set_bool          (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
464
                                                         const <link linkend="gchar">gchar</link> *group,
 
465
                                                         const <link linkend="gchar">gchar</link> *key,
 
466
                                                         <link linkend="gboolean">gboolean</link> value,
 
467
                                                         <link linkend="GError">GError</link> **err);</programlisting>
 
468
<para>
 
469
Changes the value (as a boolean) of the specified group and key.</para>
 
470
<para>
 
471
 
 
472
</para><variablelist role="params">
 
473
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
474
<listitem><simpara> The configuration client that is to be used.
 
475
</simpara></listitem></varlistentry>
 
476
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
477
<listitem><simpara> The name of the group.
 
478
</simpara></listitem></varlistentry>
 
479
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
480
<listitem><simpara> The name of the key.
 
481
</simpara></listitem></varlistentry>
 
482
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
483
<listitem><simpara> The new value of the key.
 
484
</simpara></listitem></varlistentry>
 
485
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 
486
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> structure, which contains an error message
 
487
if the function fails.
 
488
</simpara></listitem></varlistentry>
 
489
</variablelist></refsect2>
 
490
<refsect2>
 
491
<title><anchor id="awn-config-client-get-float" role="function"/>awn_config_client_get_float ()</title>
 
492
<indexterm><primary>awn_config_client_get_float</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link>              awn_config_client_get_float         (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
493
                                                         const <link linkend="gchar">gchar</link> *group,
 
494
                                                         const <link linkend="gchar">gchar</link> *key,
 
495
                                                         <link linkend="GError">GError</link> **err);</programlisting>
 
496
<para>
 
497
Retrieves the value (as a float) of the specified group and key.</para>
 
498
<para>
 
499
 
 
500
</para><variablelist role="params">
 
501
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
502
<listitem><simpara> The configuration client that is to be queried.
 
503
</simpara></listitem></varlistentry>
 
504
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
505
<listitem><simpara> The name of the group.
 
506
</simpara></listitem></varlistentry>
 
507
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
508
<listitem><simpara> The name of the key.
 
509
</simpara></listitem></varlistentry>
 
510
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 
511
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> structure, which contains an error message
 
512
if the function fails.
 
513
</simpara></listitem></varlistentry>
 
514
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a float value.
 
515
</simpara></listitem></varlistentry>
 
516
</variablelist></refsect2>
 
517
<refsect2>
 
518
<title><anchor id="awn-config-client-set-float" role="function"/>awn_config_client_set_float ()</title>
 
519
<indexterm><primary>awn_config_client_set_float</primary></indexterm><programlisting><link linkend="void">void</link>                awn_config_client_set_float         (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
520
                                                         const <link linkend="gchar">gchar</link> *group,
 
521
                                                         const <link linkend="gchar">gchar</link> *key,
 
522
                                                         <link linkend="gfloat">gfloat</link> value,
 
523
                                                         <link linkend="GError">GError</link> **err);</programlisting>
 
524
<para>
 
525
Changes the value (as a float) of the specified group and key.
 
526
If you need double precision, use a string.</para>
 
527
<para>
 
528
 
 
529
</para><variablelist role="params">
 
530
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
531
<listitem><simpara> The configuration client that is to be used.
 
532
</simpara></listitem></varlistentry>
 
533
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
534
<listitem><simpara> The name of the group.
 
535
</simpara></listitem></varlistentry>
 
536
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
537
<listitem><simpara> The name of the key.
 
538
</simpara></listitem></varlistentry>
 
539
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
540
<listitem><simpara> The new value of the key.
 
541
</simpara></listitem></varlistentry>
 
542
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 
543
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> structure, which contains an error message
 
544
if the function fails.
 
545
</simpara></listitem></varlistentry>
 
546
</variablelist></refsect2>
 
547
<refsect2>
 
548
<title><anchor id="awn-config-client-get-int" role="function"/>awn_config_client_get_int ()</title>
 
549
<indexterm><primary>awn_config_client_get_int</primary></indexterm><programlisting><link linkend="gint">gint</link>                awn_config_client_get_int           (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
550
                                                         const <link linkend="gchar">gchar</link> *group,
 
551
                                                         const <link linkend="gchar">gchar</link> *key,
 
552
                                                         <link linkend="GError">GError</link> **err);</programlisting>
 
553
<para>
 
554
Retrieves the value (as an integer) of the specified group and key.</para>
 
555
<para>
 
556
 
 
557
</para><variablelist role="params">
 
558
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
559
<listitem><simpara> The configuration client that is to be queried.
 
560
</simpara></listitem></varlistentry>
 
561
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
562
<listitem><simpara> The name of the group.
 
563
</simpara></listitem></varlistentry>
 
564
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
565
<listitem><simpara> The name of the key.
 
566
</simpara></listitem></varlistentry>
 
567
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 
568
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> structure, which contains an error message
 
569
if the function fails.
 
570
</simpara></listitem></varlistentry>
 
571
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer value.
 
572
</simpara></listitem></varlistentry>
 
573
</variablelist></refsect2>
 
574
<refsect2>
 
575
<title><anchor id="awn-config-client-set-int" role="function"/>awn_config_client_set_int ()</title>
 
576
<indexterm><primary>awn_config_client_set_int</primary></indexterm><programlisting><link linkend="void">void</link>                awn_config_client_set_int           (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
577
                                                         const <link linkend="gchar">gchar</link> *group,
 
578
                                                         const <link linkend="gchar">gchar</link> *key,
 
579
                                                         <link linkend="gint">gint</link> value,
 
580
                                                         <link linkend="GError">GError</link> **err);</programlisting>
 
581
<para>
 
582
Changes the value (as an integer) of the specified group and key.</para>
 
583
<para>
 
584
 
 
585
</para><variablelist role="params">
 
586
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
587
<listitem><simpara> The configuration client that is to be used.
 
588
</simpara></listitem></varlistentry>
 
589
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
590
<listitem><simpara> The name of the group.
 
591
</simpara></listitem></varlistentry>
 
592
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
593
<listitem><simpara> The name of the key.
 
594
</simpara></listitem></varlistentry>
 
595
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
596
<listitem><simpara> The new value of the key.
 
597
</simpara></listitem></varlistentry>
 
598
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 
599
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> structure, which contains an error message
 
600
if the function fails.
 
601
</simpara></listitem></varlistentry>
 
602
</variablelist></refsect2>
 
603
<refsect2>
 
604
<title><anchor id="awn-config-client-get-string" role="function"/>awn_config_client_get_string ()</title>
 
605
<indexterm><primary>awn_config_client_get_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              awn_config_client_get_string        (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
606
                                                         const <link linkend="gchar">gchar</link> *group,
 
607
                                                         const <link linkend="gchar">gchar</link> *key,
 
608
                                                         <link linkend="GError">GError</link> **err);</programlisting>
 
609
<para>
 
610
Retrieves the value (as a string) of the specified group and key.</para>
 
611
<para>
 
612
 
 
613
</para><variablelist role="params">
 
614
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
615
<listitem><simpara> The configuration client that is to be queried.
 
616
</simpara></listitem></varlistentry>
 
617
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
618
<listitem><simpara> The name of the group.
 
619
</simpara></listitem></varlistentry>
 
620
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
621
<listitem><simpara> The name of the key.
 
622
</simpara></listitem></varlistentry>
 
623
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 
624
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> structure, which contains an error message
 
625
if the function fails.
 
626
</simpara></listitem></varlistentry>
 
627
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated string value.  The caller is responsible
 
628
for freeing the memory.
 
629
</simpara></listitem></varlistentry>
 
630
</variablelist></refsect2>
 
631
<refsect2>
 
632
<title><anchor id="awn-config-client-set-string" role="function"/>awn_config_client_set_string ()</title>
 
633
<indexterm><primary>awn_config_client_set_string</primary></indexterm><programlisting><link linkend="void">void</link>                awn_config_client_set_string        (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
634
                                                         const <link linkend="gchar">gchar</link> *group,
 
635
                                                         const <link linkend="gchar">gchar</link> *key,
 
636
                                                         <link linkend="gchar">gchar</link> *value,
 
637
                                                         <link linkend="GError">GError</link> **err);</programlisting>
 
638
<para>
 
639
Changes the value (as a string) of the specified group and key.</para>
 
640
<para>
 
641
 
 
642
</para><variablelist role="params">
 
643
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
644
<listitem><simpara> The configuration client that is to be used.
 
645
</simpara></listitem></varlistentry>
 
646
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
647
<listitem><simpara> The name of the group.
 
648
</simpara></listitem></varlistentry>
 
649
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
650
<listitem><simpara> The name of the key.
 
651
</simpara></listitem></varlistentry>
 
652
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
653
<listitem><simpara> The new value of the key.
 
654
</simpara></listitem></varlistentry>
 
655
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 
656
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> structure, which contains an error message
 
657
if the function fails.
 
658
</simpara></listitem></varlistentry>
 
659
</variablelist></refsect2>
 
660
<refsect2>
 
661
<title><anchor id="awn-config-client-get-list" role="function"/>awn_config_client_get_list ()</title>
 
662
<indexterm><primary>awn_config_client_get_list</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*             awn_config_client_get_list          (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
663
                                                         const <link linkend="gchar">gchar</link> *group,
 
664
                                                         const <link linkend="gchar">gchar</link> *key,
 
665
                                                         <link linkend="AwnConfigListType">AwnConfigListType</link> list_type,
 
666
                                                         <link linkend="GError">GError</link> **err);</programlisting>
 
667
<para>
 
668
Retrieves the value (as a <link linkend="GSList"><type>GSList</type></link>) of the specified group and key.</para>
 
669
<para>
 
670
 
 
671
</para><variablelist role="params">
 
672
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
673
<listitem><simpara> The configuration client that is to be queried.
 
674
</simpara></listitem></varlistentry>
 
675
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
676
<listitem><simpara> The name of the group.
 
677
</simpara></listitem></varlistentry>
 
678
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
679
<listitem><simpara> The name of the key.
 
680
</simpara></listitem></varlistentry>
 
681
<varlistentry><term><parameter>list_type</parameter>&nbsp;:</term>
 
682
<listitem><simpara> The value type of every item in the list.
 
683
</simpara></listitem></varlistentry>
 
684
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 
685
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> structure, which contains an error message
 
686
if the function fails.
 
687
</simpara></listitem></varlistentry>
 
688
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated list value.  The caller is responsible
 
689
for freeing the memory.
 
690
</simpara></listitem></varlistentry>
 
691
</variablelist></refsect2>
 
692
<refsect2>
 
693
<title><anchor id="awn-config-client-set-list" role="function"/>awn_config_client_set_list ()</title>
 
694
<indexterm><primary>awn_config_client_set_list</primary></indexterm><programlisting><link linkend="void">void</link>                awn_config_client_set_list          (<link linkend="AwnConfigClient">AwnConfigClient</link> *client,
 
695
                                                         const <link linkend="gchar">gchar</link> *group,
 
696
                                                         const <link linkend="gchar">gchar</link> *key,
 
697
                                                         <link linkend="AwnConfigListType">AwnConfigListType</link> list_type,
 
698
                                                         <link linkend="GSList">GSList</link> *value,
 
699
                                                         <link linkend="GError">GError</link> **err);</programlisting>
 
700
<para>
 
701
Changes the value (as a list of values) of the specified group and key.</para>
 
702
<para>
 
703
 
 
704
</para><variablelist role="params">
 
705
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
 
706
<listitem><simpara> The configuration client that is to be used.
 
707
</simpara></listitem></varlistentry>
 
708
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
 
709
<listitem><simpara> The name of the group.
 
710
</simpara></listitem></varlistentry>
 
711
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
712
<listitem><simpara> The name of the key.
 
713
</simpara></listitem></varlistentry>
 
714
<varlistentry><term><parameter>list_type</parameter>&nbsp;:</term>
 
715
<listitem><simpara> The value type of every item in the list.
 
716
</simpara></listitem></varlistentry>
 
717
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
718
<listitem><simpara> The new value of the key.
 
719
</simpara></listitem></varlistentry>
 
720
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 
721
<listitem><simpara> A pointer to a <link linkend="GError"><type>GError</type></link> structure, which contains an error message
 
722
if the function fails.
 
723
</simpara></listitem></varlistentry>
 
724
</variablelist></refsect2>
 
725
 
 
726
</refsect1>
 
727
 
 
728
 
 
729
 
 
730
 
 
731
</refentry>