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="rhythmbox-eel-gconf-extensions">
6
<refentrytitle>eel-gconf-extensions</refentrytitle>
7
<manvolnum>3</manvolnum>
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
12
<refname>eel-gconf-extensions</refname><refpurpose></refpurpose>
15
<refsynopsisdiv><title>Synopsis</title>
21
#define <link linkend="EEL-GCONF-UNDEFINED-CONNECTION:CAPS">EEL_GCONF_UNDEFINED_CONNECTION</link>
22
<link linkend="GConfClient">GConfClient</link>* <link linkend="eel-gconf-client-get-global">eel_gconf_client_get_global</link> (void);
23
<link linkend="gboolean">gboolean</link> <link linkend="eel-gconf-handle-error">eel_gconf_handle_error</link> (<link linkend="GError">GError</link> **error);
24
<link linkend="void">void</link> <link linkend="eel-gconf-set-boolean">eel_gconf_set_boolean</link> (const <link linkend="char">char</link> *key,
25
<link linkend="gboolean">gboolean</link> boolean_value);
26
<link linkend="gboolean">gboolean</link> <link linkend="eel-gconf-get-boolean">eel_gconf_get_boolean</link> (const <link linkend="char">char</link> *key);
27
<link linkend="int">int</link> <link linkend="eel-gconf-get-integer">eel_gconf_get_integer</link> (const <link linkend="char">char</link> *key);
28
<link linkend="void">void</link> <link linkend="eel-gconf-set-integer">eel_gconf_set_integer</link> (const <link linkend="char">char</link> *key,
29
<link linkend="int">int</link> int_value);
30
<link linkend="gfloat">gfloat</link> <link linkend="eel-gconf-get-float">eel_gconf_get_float</link> (const <link linkend="char">char</link> *key);
31
<link linkend="void">void</link> <link linkend="eel-gconf-set-float">eel_gconf_set_float</link> (const <link linkend="char">char</link> *key,
32
<link linkend="gfloat">gfloat</link> float_value);
33
<link linkend="char">char</link>* <link linkend="eel-gconf-get-string">eel_gconf_get_string</link> (const <link linkend="char">char</link> *key);
34
<link linkend="void">void</link> <link linkend="eel-gconf-set-string">eel_gconf_set_string</link> (const <link linkend="char">char</link> *key,
35
const <link linkend="char">char</link> *string_value);
36
<link linkend="GSList">GSList</link>* <link linkend="eel-gconf-get-string-list">eel_gconf_get_string_list</link> (const <link linkend="char">char</link> *key);
37
<link linkend="void">void</link> <link linkend="eel-gconf-set-string-list">eel_gconf_set_string_list</link> (const <link linkend="char">char</link> *key,
38
const <link linkend="GSList">GSList</link> *string_list_value);
39
<link linkend="gboolean">gboolean</link> <link linkend="eel-gconf-is-default">eel_gconf_is_default</link> (const <link linkend="char">char</link> *key);
40
<link linkend="gboolean">gboolean</link> <link linkend="eel-gconf-monitor-add">eel_gconf_monitor_add</link> (const <link linkend="char">char</link> *directory);
41
<link linkend="gboolean">gboolean</link> <link linkend="eel-gconf-monitor-remove">eel_gconf_monitor_remove</link> (const <link linkend="char">char</link> *directory);
42
<link linkend="void">void</link> <link linkend="eel-gconf-suggest-sync">eel_gconf_suggest_sync</link> (void);
43
<link linkend="GConfValue">GConfValue</link>* <link linkend="eel-gconf-get-value">eel_gconf_get_value</link> (const <link linkend="char">char</link> *key);
44
<link linkend="gboolean">gboolean</link> <link linkend="eel-gconf-value-is-equal">eel_gconf_value_is_equal</link> (const <link linkend="GConfValue">GConfValue</link> *a,
45
const <link linkend="GConfValue">GConfValue</link> *b);
46
<link linkend="void">void</link> <link linkend="eel-gconf-set-value">eel_gconf_set_value</link> (const <link linkend="char">char</link> *key,
47
<link linkend="GConfValue">GConfValue</link> *value);
48
<link linkend="void">void</link> <link linkend="eel-gconf-value-free">eel_gconf_value_free</link> (<link linkend="GConfValue">GConfValue</link> *value);
49
<link linkend="GSList">GSList</link>* <link linkend="eel-gconf-get-integer-list">eel_gconf_get_integer_list</link> (const <link linkend="char">char</link> *key);
50
<link linkend="void">void</link> <link linkend="eel-gconf-set-integer-list">eel_gconf_set_integer_list</link> (const <link linkend="char">char</link> *key,
51
const <link linkend="GSList">GSList</link> *slist);
52
<link linkend="guint">guint</link> <link linkend="eel-gconf-notification-add">eel_gconf_notification_add</link> (const <link linkend="char">char</link> *key,
53
<link linkend="GConfClientNotifyFunc">GConfClientNotifyFunc</link> notification_callback,
54
<link linkend="gpointer">gpointer</link> callback_data);
55
<link linkend="void">void</link> <link linkend="eel-gconf-notification-remove">eel_gconf_notification_remove</link> (<link linkend="guint">guint</link> notification_id);
56
<link linkend="void">void</link> <link linkend="eel-gconf-unset">eel_gconf_unset</link> (const <link linkend="char">char</link> *key);
69
<title>Description</title>
76
<title>Details</title>
78
<title><anchor id="EEL-GCONF-UNDEFINED-CONNECTION:CAPS"/>EEL_GCONF_UNDEFINED_CONNECTION</title>
79
<indexterm><primary>EEL_GCONF_UNDEFINED_CONNECTION</primary></indexterm><programlisting>#define EEL_GCONF_UNDEFINED_CONNECTION 0
85
<title><anchor id="eel-gconf-client-get-global"/>eel_gconf_client_get_global ()</title>
86
<indexterm><primary>eel_gconf_client_get_global</primary></indexterm><programlisting><link linkend="GConfClient">GConfClient</link>* eel_gconf_client_get_global (void);</programlisting>
89
</para><variablelist role="params">
90
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
93
</simpara></listitem></varlistentry>
94
</variablelist></refsect2>
96
<title><anchor id="eel-gconf-handle-error"/>eel_gconf_handle_error ()</title>
97
<indexterm><primary>eel_gconf_handle_error</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> eel_gconf_handle_error (<link linkend="GError">GError</link> **error);</programlisting>
100
</para><variablelist role="params">
101
<varlistentry><term><parameter>error</parameter> :</term>
103
</simpara></listitem></varlistentry>
104
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
107
</simpara></listitem></varlistentry>
108
</variablelist></refsect2>
110
<title><anchor id="eel-gconf-set-boolean"/>eel_gconf_set_boolean ()</title>
111
<indexterm><primary>eel_gconf_set_boolean</primary></indexterm><programlisting><link linkend="void">void</link> eel_gconf_set_boolean (const <link linkend="char">char</link> *key,
112
<link linkend="gboolean">gboolean</link> boolean_value);</programlisting>
115
</para><variablelist role="params">
116
<varlistentry><term><parameter>key</parameter> :</term>
118
</simpara></listitem></varlistentry>
119
<varlistentry><term><parameter>boolean_value</parameter> :</term>
123
</simpara></listitem></varlistentry>
124
</variablelist></refsect2>
126
<title><anchor id="eel-gconf-get-boolean"/>eel_gconf_get_boolean ()</title>
127
<indexterm><primary>eel_gconf_get_boolean</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> eel_gconf_get_boolean (const <link linkend="char">char</link> *key);</programlisting>
130
</para><variablelist role="params">
131
<varlistentry><term><parameter>key</parameter> :</term>
133
</simpara></listitem></varlistentry>
134
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
137
</simpara></listitem></varlistentry>
138
</variablelist></refsect2>
140
<title><anchor id="eel-gconf-get-integer"/>eel_gconf_get_integer ()</title>
141
<indexterm><primary>eel_gconf_get_integer</primary></indexterm><programlisting><link linkend="int">int</link> eel_gconf_get_integer (const <link linkend="char">char</link> *key);</programlisting>
144
</para><variablelist role="params">
145
<varlistentry><term><parameter>key</parameter> :</term>
147
</simpara></listitem></varlistentry>
148
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
151
</simpara></listitem></varlistentry>
152
</variablelist></refsect2>
154
<title><anchor id="eel-gconf-set-integer"/>eel_gconf_set_integer ()</title>
155
<indexterm><primary>eel_gconf_set_integer</primary></indexterm><programlisting><link linkend="void">void</link> eel_gconf_set_integer (const <link linkend="char">char</link> *key,
156
<link linkend="int">int</link> int_value);</programlisting>
159
</para><variablelist role="params">
160
<varlistentry><term><parameter>key</parameter> :</term>
162
</simpara></listitem></varlistentry>
163
<varlistentry><term><parameter>int_value</parameter> :</term>
167
</simpara></listitem></varlistentry>
168
</variablelist></refsect2>
170
<title><anchor id="eel-gconf-get-float"/>eel_gconf_get_float ()</title>
171
<indexterm><primary>eel_gconf_get_float</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link> eel_gconf_get_float (const <link linkend="char">char</link> *key);</programlisting>
174
</para><variablelist role="params">
175
<varlistentry><term><parameter>key</parameter> :</term>
177
</simpara></listitem></varlistentry>
178
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
181
</simpara></listitem></varlistentry>
182
</variablelist></refsect2>
184
<title><anchor id="eel-gconf-set-float"/>eel_gconf_set_float ()</title>
185
<indexterm><primary>eel_gconf_set_float</primary></indexterm><programlisting><link linkend="void">void</link> eel_gconf_set_float (const <link linkend="char">char</link> *key,
186
<link linkend="gfloat">gfloat</link> float_value);</programlisting>
189
</para><variablelist role="params">
190
<varlistentry><term><parameter>key</parameter> :</term>
192
</simpara></listitem></varlistentry>
193
<varlistentry><term><parameter>float_value</parameter> :</term>
197
</simpara></listitem></varlistentry>
198
</variablelist></refsect2>
200
<title><anchor id="eel-gconf-get-string"/>eel_gconf_get_string ()</title>
201
<indexterm><primary>eel_gconf_get_string</primary></indexterm><programlisting><link linkend="char">char</link>* eel_gconf_get_string (const <link linkend="char">char</link> *key);</programlisting>
204
</para><variablelist role="params">
205
<varlistentry><term><parameter>key</parameter> :</term>
207
</simpara></listitem></varlistentry>
208
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
211
</simpara></listitem></varlistentry>
212
</variablelist></refsect2>
214
<title><anchor id="eel-gconf-set-string"/>eel_gconf_set_string ()</title>
215
<indexterm><primary>eel_gconf_set_string</primary></indexterm><programlisting><link linkend="void">void</link> eel_gconf_set_string (const <link linkend="char">char</link> *key,
216
const <link linkend="char">char</link> *string_value);</programlisting>
219
</para><variablelist role="params">
220
<varlistentry><term><parameter>key</parameter> :</term>
222
</simpara></listitem></varlistentry>
223
<varlistentry><term><parameter>string_value</parameter> :</term>
227
</simpara></listitem></varlistentry>
228
</variablelist></refsect2>
230
<title><anchor id="eel-gconf-get-string-list"/>eel_gconf_get_string_list ()</title>
231
<indexterm><primary>eel_gconf_get_string_list</primary></indexterm><programlisting><link linkend="GSList">GSList</link>* eel_gconf_get_string_list (const <link linkend="char">char</link> *key);</programlisting>
234
</para><variablelist role="params">
235
<varlistentry><term><parameter>key</parameter> :</term>
237
</simpara></listitem></varlistentry>
238
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
241
</simpara></listitem></varlistentry>
242
</variablelist></refsect2>
244
<title><anchor id="eel-gconf-set-string-list"/>eel_gconf_set_string_list ()</title>
245
<indexterm><primary>eel_gconf_set_string_list</primary></indexterm><programlisting><link linkend="void">void</link> eel_gconf_set_string_list (const <link linkend="char">char</link> *key,
246
const <link linkend="GSList">GSList</link> *string_list_value);</programlisting>
249
</para><variablelist role="params">
250
<varlistentry><term><parameter>key</parameter> :</term>
252
</simpara></listitem></varlistentry>
253
<varlistentry><term><parameter>string_list_value</parameter> :</term>
257
</simpara></listitem></varlistentry>
258
</variablelist></refsect2>
260
<title><anchor id="eel-gconf-is-default"/>eel_gconf_is_default ()</title>
261
<indexterm><primary>eel_gconf_is_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> eel_gconf_is_default (const <link linkend="char">char</link> *key);</programlisting>
264
</para><variablelist role="params">
265
<varlistentry><term><parameter>key</parameter> :</term>
267
</simpara></listitem></varlistentry>
268
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
271
</simpara></listitem></varlistentry>
272
</variablelist></refsect2>
274
<title><anchor id="eel-gconf-monitor-add"/>eel_gconf_monitor_add ()</title>
275
<indexterm><primary>eel_gconf_monitor_add</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> eel_gconf_monitor_add (const <link linkend="char">char</link> *directory);</programlisting>
278
</para><variablelist role="params">
279
<varlistentry><term><parameter>directory</parameter> :</term>
281
</simpara></listitem></varlistentry>
282
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
285
</simpara></listitem></varlistentry>
286
</variablelist></refsect2>
288
<title><anchor id="eel-gconf-monitor-remove"/>eel_gconf_monitor_remove ()</title>
289
<indexterm><primary>eel_gconf_monitor_remove</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> eel_gconf_monitor_remove (const <link linkend="char">char</link> *directory);</programlisting>
292
</para><variablelist role="params">
293
<varlistentry><term><parameter>directory</parameter> :</term>
295
</simpara></listitem></varlistentry>
296
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
299
</simpara></listitem></varlistentry>
300
</variablelist></refsect2>
302
<title><anchor id="eel-gconf-suggest-sync"/>eel_gconf_suggest_sync ()</title>
303
<indexterm><primary>eel_gconf_suggest_sync</primary></indexterm><programlisting><link linkend="void">void</link> eel_gconf_suggest_sync (void);</programlisting>
308
<title><anchor id="eel-gconf-get-value"/>eel_gconf_get_value ()</title>
309
<indexterm><primary>eel_gconf_get_value</primary></indexterm><programlisting><link linkend="GConfValue">GConfValue</link>* eel_gconf_get_value (const <link linkend="char">char</link> *key);</programlisting>
312
</para><variablelist role="params">
313
<varlistentry><term><parameter>key</parameter> :</term>
315
</simpara></listitem></varlistentry>
316
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
319
</simpara></listitem></varlistentry>
320
</variablelist></refsect2>
322
<title><anchor id="eel-gconf-value-is-equal"/>eel_gconf_value_is_equal ()</title>
323
<indexterm><primary>eel_gconf_value_is_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> eel_gconf_value_is_equal (const <link linkend="GConfValue">GConfValue</link> *a,
324
const <link linkend="GConfValue">GConfValue</link> *b);</programlisting>
327
</para><variablelist role="params">
328
<varlistentry><term><parameter>a</parameter> :</term>
330
</simpara></listitem></varlistentry>
331
<varlistentry><term><parameter>b</parameter> :</term>
333
</simpara></listitem></varlistentry>
334
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
337
</simpara></listitem></varlistentry>
338
</variablelist></refsect2>
340
<title><anchor id="eel-gconf-set-value"/>eel_gconf_set_value ()</title>
341
<indexterm><primary>eel_gconf_set_value</primary></indexterm><programlisting><link linkend="void">void</link> eel_gconf_set_value (const <link linkend="char">char</link> *key,
342
<link linkend="GConfValue">GConfValue</link> *value);</programlisting>
345
</para><variablelist role="params">
346
<varlistentry><term><parameter>key</parameter> :</term>
348
</simpara></listitem></varlistentry>
349
<varlistentry><term><parameter>value</parameter> :</term>
353
</simpara></listitem></varlistentry>
354
</variablelist></refsect2>
356
<title><anchor id="eel-gconf-value-free"/>eel_gconf_value_free ()</title>
357
<indexterm><primary>eel_gconf_value_free</primary></indexterm><programlisting><link linkend="void">void</link> eel_gconf_value_free (<link linkend="GConfValue">GConfValue</link> *value);</programlisting>
360
</para><variablelist role="params">
361
<varlistentry><term><parameter>value</parameter> :</term>
365
</simpara></listitem></varlistentry>
366
</variablelist></refsect2>
368
<title><anchor id="eel-gconf-get-integer-list"/>eel_gconf_get_integer_list ()</title>
369
<indexterm><primary>eel_gconf_get_integer_list</primary></indexterm><programlisting><link linkend="GSList">GSList</link>* eel_gconf_get_integer_list (const <link linkend="char">char</link> *key);</programlisting>
372
</para><variablelist role="params">
373
<varlistentry><term><parameter>key</parameter> :</term>
375
</simpara></listitem></varlistentry>
376
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
379
</simpara></listitem></varlistentry>
380
</variablelist></refsect2>
382
<title><anchor id="eel-gconf-set-integer-list"/>eel_gconf_set_integer_list ()</title>
383
<indexterm><primary>eel_gconf_set_integer_list</primary></indexterm><programlisting><link linkend="void">void</link> eel_gconf_set_integer_list (const <link linkend="char">char</link> *key,
384
const <link linkend="GSList">GSList</link> *slist);</programlisting>
387
</para><variablelist role="params">
388
<varlistentry><term><parameter>key</parameter> :</term>
390
</simpara></listitem></varlistentry>
391
<varlistentry><term><parameter>slist</parameter> :</term>
395
</simpara></listitem></varlistentry>
396
</variablelist></refsect2>
398
<title><anchor id="eel-gconf-notification-add"/>eel_gconf_notification_add ()</title>
399
<indexterm><primary>eel_gconf_notification_add</primary></indexterm><programlisting><link linkend="guint">guint</link> eel_gconf_notification_add (const <link linkend="char">char</link> *key,
400
<link linkend="GConfClientNotifyFunc">GConfClientNotifyFunc</link> notification_callback,
401
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
404
</para><variablelist role="params">
405
<varlistentry><term><parameter>key</parameter> :</term>
407
</simpara></listitem></varlistentry>
408
<varlistentry><term><parameter>notification_callback</parameter> :</term>
410
</simpara></listitem></varlistentry>
411
<varlistentry><term><parameter>callback_data</parameter> :</term>
413
</simpara></listitem></varlistentry>
414
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
417
</simpara></listitem></varlistentry>
418
</variablelist></refsect2>
420
<title><anchor id="eel-gconf-notification-remove"/>eel_gconf_notification_remove ()</title>
421
<indexterm><primary>eel_gconf_notification_remove</primary></indexterm><programlisting><link linkend="void">void</link> eel_gconf_notification_remove (<link linkend="guint">guint</link> notification_id);</programlisting>
424
</para><variablelist role="params">
425
<varlistentry><term><parameter>notification_id</parameter> :</term>
429
</simpara></listitem></varlistentry>
430
</variablelist></refsect2>
432
<title><anchor id="eel-gconf-unset"/>eel_gconf_unset ()</title>
433
<indexterm><primary>eel_gconf_unset</primary></indexterm><programlisting><link linkend="void">void</link> eel_gconf_unset (const <link linkend="char">char</link> *key);</programlisting>
436
</para><variablelist role="params">
437
<varlistentry><term><parameter>key</parameter> :</term>
441
</simpara></listitem></varlistentry>
442
</variablelist></refsect2>