← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gnome-panel/oneiric

« back to all changes in this revision

Viewing changes to doc/reference/panel-applet/xml/panel-applet-gconf.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-01-14 22:20:05 UTC
  • mto: (2.1.6 squeeze) (1.3.3 upstream)
  • mto: This revision was merged to the branch mainline in revision 171.
  • Revision ID: james.westby@ubuntu.com-20100114222005-rll7tw9fojl3ac6z
Tags: upstream-2.29.5.1
Import upstream version 2.29.5.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/panel-applet/xml/panel-applet-gconf.xml
1
 
<refentry id="panel-applet-Panel-Applet-GConf-Utilities">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="panel-applet-Panel-Applet-GConf-Utilities.top_of_page">Panel Applet GConf Utilities</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>PANEL-APPLET Library</refmiscinfo>
6
 
</refmeta>
7
 
<refnamediv>
8
 
<refname>Panel Applet GConf Utilities</refname>
9
 
<refpurpose>Utility methods for manipulating per-applet GConf preferences.</refpurpose>
10
 
</refnamediv>
11
 
 
12
 
<refsynopsisdiv id="panel-applet-Panel-Applet-GConf-Utilities.synopsis" role="synopsis">
13
 
<title role="synopsis.title">Synopsis</title>
14
 
 
15
 
<synopsis>
16
 
#include &lt;panel-applet-gconf.h&gt;
17
 
 
18
 
<link linkend="gchar">gchar</link> *             <link linkend="panel-applet-gconf-get-full-key">panel_applet_gconf_get_full_key</link>     (<link linkend="PanelApplet">PanelApplet</link> *applet,
19
 
                                                         const <link linkend="gchar">gchar</link> *key);
20
 
<link linkend="gboolean">gboolean</link>            <link linkend="panel-applet-gconf-get-bool">panel_applet_gconf_get_bool</link>         (<link linkend="PanelApplet">PanelApplet</link> *applet,
21
 
                                                         const <link linkend="gchar">gchar</link> *key,
22
 
                                                         <link linkend="GError">GError</link> **opt_error);
23
 
<link linkend="gint">gint</link>                <link linkend="panel-applet-gconf-get-int">panel_applet_gconf_get_int</link>          (<link linkend="PanelApplet">PanelApplet</link> *applet,
24
 
                                                         const <link linkend="gchar">gchar</link> *key,
25
 
                                                         <link linkend="GError">GError</link> **opt_error);
26
 
<link linkend="gchar">gchar</link> *             <link linkend="panel-applet-gconf-get-string">panel_applet_gconf_get_string</link>       (<link linkend="PanelApplet">PanelApplet</link> *applet,
27
 
                                                         const <link linkend="gchar">gchar</link> *key,
28
 
                                                         <link linkend="GError">GError</link> **opt_error);
29
 
<link linkend="gdouble">gdouble</link>             <link linkend="panel-applet-gconf-get-float">panel_applet_gconf_get_float</link>        (<link linkend="PanelApplet">PanelApplet</link> *applet,
30
 
                                                         const <link linkend="gchar">gchar</link> *key,
31
 
                                                         <link linkend="GError">GError</link> **opt_error);
32
 
<link linkend="GSList">GSList</link> *            <link linkend="panel-applet-gconf-get-list">panel_applet_gconf_get_list</link>         (<link linkend="PanelApplet">PanelApplet</link> *applet,
33
 
                                                         const <link linkend="gchar">gchar</link> *key,
34
 
                                                         <link linkend="GConfValueType">GConfValueType</link> list_type,
35
 
                                                         <link linkend="GError">GError</link> **opt_error);
36
 
<link linkend="GConfValue">GConfValue</link> *        <link linkend="panel-applet-gconf-get-value">panel_applet_gconf_get_value</link>        (<link linkend="PanelApplet">PanelApplet</link> *applet,
37
 
                                                         const <link linkend="gchar">gchar</link> *key,
38
 
                                                         <link linkend="GError">GError</link> **opt_error);
39
 
<link linkend="void">void</link>                <link linkend="panel-applet-gconf-set-bool">panel_applet_gconf_set_bool</link>         (<link linkend="PanelApplet">PanelApplet</link> *applet,
40
 
                                                         const <link linkend="gchar">gchar</link> *key,
41
 
                                                         <link linkend="gboolean">gboolean</link> the_bool,
42
 
                                                         <link linkend="GError">GError</link> **opt_error);
43
 
<link linkend="void">void</link>                <link linkend="panel-applet-gconf-set-int">panel_applet_gconf_set_int</link>          (<link linkend="PanelApplet">PanelApplet</link> *applet,
44
 
                                                         const <link linkend="gchar">gchar</link> *key,
45
 
                                                         <link linkend="gint">gint</link> the_int,
46
 
                                                         <link linkend="GError">GError</link> **opt_error);
47
 
<link linkend="void">void</link>                <link linkend="panel-applet-gconf-set-string">panel_applet_gconf_set_string</link>       (<link linkend="PanelApplet">PanelApplet</link> *applet,
48
 
                                                         const <link linkend="gchar">gchar</link> *key,
49
 
                                                         const <link linkend="gchar">gchar</link> *the_string,
50
 
                                                         <link linkend="GError">GError</link> **opt_error);
51
 
<link linkend="void">void</link>                <link linkend="panel-applet-gconf-set-float">panel_applet_gconf_set_float</link>        (<link linkend="PanelApplet">PanelApplet</link> *applet,
52
 
                                                         const <link linkend="gchar">gchar</link> *key,
53
 
                                                         <link linkend="gdouble">gdouble</link> the_float,
54
 
                                                         <link linkend="GError">GError</link> **opt_error);
55
 
<link linkend="void">void</link>                <link linkend="panel-applet-gconf-set-list">panel_applet_gconf_set_list</link>         (<link linkend="PanelApplet">PanelApplet</link> *applet,
56
 
                                                         const <link linkend="gchar">gchar</link> *key,
57
 
                                                         <link linkend="GConfValueType">GConfValueType</link> list_type,
58
 
                                                         <link linkend="GSList">GSList</link> *list,
59
 
                                                         <link linkend="GError">GError</link> **opt_error);
60
 
<link linkend="void">void</link>                <link linkend="panel-applet-gconf-set-value">panel_applet_gconf_set_value</link>        (<link linkend="PanelApplet">PanelApplet</link> *applet,
61
 
                                                         const <link linkend="gchar">gchar</link> *key,
62
 
                                                         <link linkend="GConfValue">GConfValue</link> *value,
63
 
                                                         <link linkend="GError">GError</link> **opt_error);
64
 
</synopsis>
65
 
</refsynopsisdiv>
66
 
 
67
 
<refsect1 id="panel-applet-Panel-Applet-GConf-Utilities.description" role="desc">
68
 
<title role="desc.title">Description</title>
69
 
<para>
70
 
Applets typically define a set of preferences using a schemas
71
 
file and <link linkend="panel-applet-add-preferences"><function>panel_applet_add_preferences()</function></link>. Such preferences apply
72
 
only to an individual applet instance. For example, you may add
73
 
two clock applets to the panel and configure them differently.
74
 
</para>
75
 
<para>
76
 
In order for the preferences to only apply to a single applet,
77
 
each applet must have a seperate GConf key for each of these
78
 
preferences. The methods described below provide convient wrappers
79
 
around the usual <link linkend="GConfClient"><type>GConfClient</type></link> functions and operate on these
80
 
per-applet keys.
81
 
</para>
82
 
</refsect1>
83
 
<refsect1 id="panel-applet-Panel-Applet-GConf-Utilities.details" role="details">
84
 
<title role="details.title">Details</title>
85
 
<refsect2 id="panel-applet-gconf-get-full-key" role="function">
86
 
<title>panel_applet_gconf_get_full_key ()</title>
87
 
<indexterm zone="panel-applet-gconf-get-full-key"><primary>panel_applet_gconf_get_full_key</primary></indexterm>
88
 
<programlisting><link linkend="gchar">gchar</link> *             panel_applet_gconf_get_full_key     (<link linkend="PanelApplet">PanelApplet</link> *applet,
89
 
                                                         const <link linkend="gchar">gchar</link> *key);</programlisting>
90
 
<para>
91
 
Access the full path for an individual per-applet GConf key. Using
92
 
the returned path you may directly modify the preference using
93
 
the usual GConf functions without using any of the convenience
94
 
wrappers described below.
95
 
</para><variablelist role="params">
96
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
97
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
98
 
</simpara></listitem></varlistentry>
99
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
100
 
<listitem><simpara>The key name of the preference.
101
 
</simpara></listitem></varlistentry>
102
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The full GConf key - free using <link linkend="g-free"><function>g_free()</function></link>.
103
 
</simpara></listitem></varlistentry>
104
 
</variablelist></refsect2>
105
 
<refsect2 id="panel-applet-gconf-get-bool" role="function">
106
 
<title>panel_applet_gconf_get_bool ()</title>
107
 
<indexterm zone="panel-applet-gconf-get-bool"><primary>panel_applet_gconf_get_bool</primary></indexterm>
108
 
<programlisting><link linkend="gboolean">gboolean</link>            panel_applet_gconf_get_bool         (<link linkend="PanelApplet">PanelApplet</link> *applet,
109
 
                                                         const <link linkend="gchar">gchar</link> *key,
110
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
111
 
<para>
112
 
Convience wrapper for <link linkend="gconf-client-get-bool"><function>gconf_client_get_bool()</function></link> which operates
113
 
on the individual per-applet key.
114
 
</para>
115
 
<para>
116
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
117
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-get-bool"><function>gconf_client_get_bool()</function></link>
118
 
returns.
119
 
</para><variablelist role="params">
120
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
121
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
122
 
</simpara></listitem></varlistentry>
123
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
124
 
<listitem><simpara>The key name of the preference.
125
 
</simpara></listitem></varlistentry>
126
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
127
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
128
 
</simpara></listitem></varlistentry>
129
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The bool value of the key.
130
 
</simpara></listitem></varlistentry>
131
 
</variablelist></refsect2>
132
 
<refsect2 id="panel-applet-gconf-get-int" role="function">
133
 
<title>panel_applet_gconf_get_int ()</title>
134
 
<indexterm zone="panel-applet-gconf-get-int"><primary>panel_applet_gconf_get_int</primary></indexterm>
135
 
<programlisting><link linkend="gint">gint</link>                panel_applet_gconf_get_int          (<link linkend="PanelApplet">PanelApplet</link> *applet,
136
 
                                                         const <link linkend="gchar">gchar</link> *key,
137
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
138
 
<para>
139
 
Convience wrapper for <link linkend="gconf-client-get-int"><function>gconf_client_get_int()</function></link> which operates
140
 
on the individual per-applet key.
141
 
</para>
142
 
<para>
143
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
144
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-get-int"><function>gconf_client_get_int()</function></link>
145
 
returns.
146
 
</para><variablelist role="params">
147
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
148
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
149
 
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
151
 
<listitem><simpara>The key name of the preference.
152
 
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
154
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
155
 
</simpara></listitem></varlistentry>
156
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The integer value of the key.
157
 
</simpara></listitem></varlistentry>
158
 
</variablelist></refsect2>
159
 
<refsect2 id="panel-applet-gconf-get-string" role="function">
160
 
<title>panel_applet_gconf_get_string ()</title>
161
 
<indexterm zone="panel-applet-gconf-get-string"><primary>panel_applet_gconf_get_string</primary></indexterm>
162
 
<programlisting><link linkend="gchar">gchar</link> *             panel_applet_gconf_get_string       (<link linkend="PanelApplet">PanelApplet</link> *applet,
163
 
                                                         const <link linkend="gchar">gchar</link> *key,
164
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
165
 
<para>
166
 
Convience wrapper for <link linkend="gconf-client-get-string"><function>gconf_client_get_string()</function></link> which operates
167
 
on the individual per-applet key.
168
 
</para>
169
 
<para>
170
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
171
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-get-string"><function>gconf_client_get_string()</function></link>
172
 
returns.
173
 
</para><variablelist role="params">
174
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
175
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
176
 
</simpara></listitem></varlistentry>
177
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
178
 
<listitem><simpara>The key name of the preference.
179
 
</simpara></listitem></varlistentry>
180
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
181
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
182
 
</simpara></listitem></varlistentry>
183
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The string value of the key, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if unset.
184
 
</simpara></listitem></varlistentry>
185
 
</variablelist></refsect2>
186
 
<refsect2 id="panel-applet-gconf-get-float" role="function">
187
 
<title>panel_applet_gconf_get_float ()</title>
188
 
<indexterm zone="panel-applet-gconf-get-float"><primary>panel_applet_gconf_get_float</primary></indexterm>
189
 
<programlisting><link linkend="gdouble">gdouble</link>             panel_applet_gconf_get_float        (<link linkend="PanelApplet">PanelApplet</link> *applet,
190
 
                                                         const <link linkend="gchar">gchar</link> *key,
191
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
192
 
<para>
193
 
Convience wrapper for <link linkend="gconf-client-get-float"><function>gconf_client_get_float()</function></link> which operates
194
 
on the individual per-applet key.
195
 
</para>
196
 
<para>
197
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
198
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-get-float"><function>gconf_client_get_float()</function></link>
199
 
returns.
200
 
</para><variablelist role="params">
201
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
202
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
203
 
</simpara></listitem></varlistentry>
204
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
205
 
<listitem><simpara>The key name of the preference.
206
 
</simpara></listitem></varlistentry>
207
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
208
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
209
 
</simpara></listitem></varlistentry>
210
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The floating point value of the key.
211
 
</simpara></listitem></varlistentry>
212
 
</variablelist></refsect2>
213
 
<refsect2 id="panel-applet-gconf-get-list" role="function">
214
 
<title>panel_applet_gconf_get_list ()</title>
215
 
<indexterm zone="panel-applet-gconf-get-list"><primary>panel_applet_gconf_get_list</primary></indexterm>
216
 
<programlisting><link linkend="GSList">GSList</link> *            panel_applet_gconf_get_list         (<link linkend="PanelApplet">PanelApplet</link> *applet,
217
 
                                                         const <link linkend="gchar">gchar</link> *key,
218
 
                                                         <link linkend="GConfValueType">GConfValueType</link> list_type,
219
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
220
 
<para>
221
 
Convience wrapper for <link linkend="gconf-client-get-list"><function>gconf_client_get_list()</function></link> which operates
222
 
on the individual per-applet key.
223
 
</para>
224
 
<para>
225
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
226
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-get-list"><function>gconf_client_get_list()</function></link>
227
 
returns.
228
 
</para><variablelist role="params">
229
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
230
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
231
 
</simpara></listitem></varlistentry>
232
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
233
 
<listitem><simpara>The key name of the preference.
234
 
</simpara></listitem></varlistentry>
235
 
<varlistentry><term><parameter>list_type</parameter>&#160;:</term>
236
 
<listitem><simpara>The GConf value type of the list elements.
237
 
</simpara></listitem></varlistentry>
238
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
239
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
240
 
</simpara></listitem></varlistentry>
241
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The list of values set for the key.
242
 
</simpara></listitem></varlistentry>
243
 
</variablelist></refsect2>
244
 
<refsect2 id="panel-applet-gconf-get-value" role="function">
245
 
<title>panel_applet_gconf_get_value ()</title>
246
 
<indexterm zone="panel-applet-gconf-get-value"><primary>panel_applet_gconf_get_value</primary></indexterm>
247
 
<programlisting><link linkend="GConfValue">GConfValue</link> *        panel_applet_gconf_get_value        (<link linkend="PanelApplet">PanelApplet</link> *applet,
248
 
                                                         const <link linkend="gchar">gchar</link> *key,
249
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
250
 
<para>
251
 
Convience wrapper for <link linkend="gconf-client-get-value"><function>gconf_client_get_value()</function></link> which operates
252
 
on the individual per-applet key.
253
 
</para>
254
 
<para>
255
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
256
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-get-value"><function>gconf_client_get_value()</function></link>
257
 
returns.
258
 
</para><variablelist role="params">
259
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
260
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
261
 
</simpara></listitem></varlistentry>
262
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
263
 
<listitem><simpara>The key name of the preference.
264
 
</simpara></listitem></varlistentry>
265
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
266
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
267
 
</simpara></listitem></varlistentry>
268
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The GConf value set for the key.
269
 
</simpara></listitem></varlistentry>
270
 
</variablelist></refsect2>
271
 
<refsect2 id="panel-applet-gconf-set-bool" role="function">
272
 
<title>panel_applet_gconf_set_bool ()</title>
273
 
<indexterm zone="panel-applet-gconf-set-bool"><primary>panel_applet_gconf_set_bool</primary></indexterm>
274
 
<programlisting><link linkend="void">void</link>                panel_applet_gconf_set_bool         (<link linkend="PanelApplet">PanelApplet</link> *applet,
275
 
                                                         const <link linkend="gchar">gchar</link> *key,
276
 
                                                         <link linkend="gboolean">gboolean</link> the_bool,
277
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
278
 
<para>
279
 
Convience wrapper for <link linkend="gconf-client-set-bool"><function>gconf_client_set_bool()</function></link> which operates
280
 
on the individual per-applet key.
281
 
</para>
282
 
<para>
283
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
284
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-set-bool"><function>gconf_client_set_bool()</function></link>
285
 
returns.
286
 
</para><variablelist role="params">
287
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
288
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
289
 
</simpara></listitem></varlistentry>
290
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
291
 
<listitem><simpara>The key name of the preference.
292
 
</simpara></listitem></varlistentry>
293
 
<varlistentry><term><parameter>the_bool</parameter>&#160;:</term>
294
 
<listitem><simpara>The boolean value to set the key with.
295
 
</simpara></listitem></varlistentry>
296
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
297
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
298
 
</simpara></listitem></varlistentry>
299
 
</variablelist></refsect2>
300
 
<refsect2 id="panel-applet-gconf-set-int" role="function">
301
 
<title>panel_applet_gconf_set_int ()</title>
302
 
<indexterm zone="panel-applet-gconf-set-int"><primary>panel_applet_gconf_set_int</primary></indexterm>
303
 
<programlisting><link linkend="void">void</link>                panel_applet_gconf_set_int          (<link linkend="PanelApplet">PanelApplet</link> *applet,
304
 
                                                         const <link linkend="gchar">gchar</link> *key,
305
 
                                                         <link linkend="gint">gint</link> the_int,
306
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
307
 
<para>
308
 
Convience wrapper for <link linkend="gconf-client-set-int"><function>gconf_client_set_int()</function></link> which operates
309
 
on the individual per-applet key.
310
 
</para>
311
 
<para>
312
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
313
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-set-int"><function>gconf_client_set_int()</function></link>
314
 
returns.
315
 
</para><variablelist role="params">
316
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
317
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
318
 
</simpara></listitem></varlistentry>
319
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
320
 
<listitem><simpara>The key name of the preference.
321
 
</simpara></listitem></varlistentry>
322
 
<varlistentry><term><parameter>the_int</parameter>&#160;:</term>
323
 
<listitem><simpara>The integer value to set the key with.
324
 
</simpara></listitem></varlistentry>
325
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
326
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
327
 
</simpara></listitem></varlistentry>
328
 
</variablelist></refsect2>
329
 
<refsect2 id="panel-applet-gconf-set-string" role="function">
330
 
<title>panel_applet_gconf_set_string ()</title>
331
 
<indexterm zone="panel-applet-gconf-set-string"><primary>panel_applet_gconf_set_string</primary></indexterm>
332
 
<programlisting><link linkend="void">void</link>                panel_applet_gconf_set_string       (<link linkend="PanelApplet">PanelApplet</link> *applet,
333
 
                                                         const <link linkend="gchar">gchar</link> *key,
334
 
                                                         const <link linkend="gchar">gchar</link> *the_string,
335
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
336
 
<para>
337
 
Convience wrapper for <link linkend="gconf-client-set-string"><function>gconf_client_set_string()</function></link> which operates
338
 
on the individual per-applet key.
339
 
</para>
340
 
<para>
341
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
342
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-set-string"><function>gconf_client_set_string()</function></link>
343
 
returns.
344
 
</para><variablelist role="params">
345
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
346
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
347
 
</simpara></listitem></varlistentry>
348
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
349
 
<listitem><simpara>The key name of the preference.
350
 
</simpara></listitem></varlistentry>
351
 
<varlistentry><term><parameter>the_string</parameter>&#160;:</term>
352
 
<listitem><simpara>The string value to set the key with.
353
 
</simpara></listitem></varlistentry>
354
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
355
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
356
 
</simpara></listitem></varlistentry>
357
 
</variablelist></refsect2>
358
 
<refsect2 id="panel-applet-gconf-set-float" role="function">
359
 
<title>panel_applet_gconf_set_float ()</title>
360
 
<indexterm zone="panel-applet-gconf-set-float"><primary>panel_applet_gconf_set_float</primary></indexterm>
361
 
<programlisting><link linkend="void">void</link>                panel_applet_gconf_set_float        (<link linkend="PanelApplet">PanelApplet</link> *applet,
362
 
                                                         const <link linkend="gchar">gchar</link> *key,
363
 
                                                         <link linkend="gdouble">gdouble</link> the_float,
364
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
365
 
<para>
366
 
Convience wrapper for <link linkend="gconf-client-set-float"><function>gconf_client_set_float()</function></link> which operates
367
 
on the individual per-applet key.
368
 
</para>
369
 
<para>
370
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
371
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-set-float"><function>gconf_client_set_float()</function></link>
372
 
returns.
373
 
</para><variablelist role="params">
374
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
375
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
376
 
</simpara></listitem></varlistentry>
377
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
378
 
<listitem><simpara>The key name of the preference.
379
 
</simpara></listitem></varlistentry>
380
 
<varlistentry><term><parameter>the_float</parameter>&#160;:</term>
381
 
<listitem><simpara>The floating point value to set the key with.
382
 
</simpara></listitem></varlistentry>
383
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
384
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
385
 
</simpara></listitem></varlistentry>
386
 
</variablelist></refsect2>
387
 
<refsect2 id="panel-applet-gconf-set-list" role="function">
388
 
<title>panel_applet_gconf_set_list ()</title>
389
 
<indexterm zone="panel-applet-gconf-set-list"><primary>panel_applet_gconf_set_list</primary></indexterm>
390
 
<programlisting><link linkend="void">void</link>                panel_applet_gconf_set_list         (<link linkend="PanelApplet">PanelApplet</link> *applet,
391
 
                                                         const <link linkend="gchar">gchar</link> *key,
392
 
                                                         <link linkend="GConfValueType">GConfValueType</link> list_type,
393
 
                                                         <link linkend="GSList">GSList</link> *list,
394
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
395
 
<para>
396
 
Convience wrapper for <link linkend="gconf-client-set-list"><function>gconf_client_set_list()</function></link> which operates
397
 
on the individual per-applet key.
398
 
</para>
399
 
<para>
400
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
401
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-set-list"><function>gconf_client_set_list()</function></link>
402
 
returns.
403
 
</para><variablelist role="params">
404
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
405
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
406
 
</simpara></listitem></varlistentry>
407
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
408
 
<listitem><simpara>The key name of the preference.
409
 
</simpara></listitem></varlistentry>
410
 
<varlistentry><term><parameter>list_type</parameter>&#160;:</term>
411
 
<listitem><simpara>The GConf value type of the list items.
412
 
</simpara></listitem></varlistentry>
413
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
414
 
<listitem><simpara>The list of values to set the key with.
415
 
</simpara></listitem></varlistentry>
416
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
417
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
418
 
</simpara></listitem></varlistentry>
419
 
</variablelist></refsect2>
420
 
<refsect2 id="panel-applet-gconf-set-value" role="function">
421
 
<title>panel_applet_gconf_set_value ()</title>
422
 
<indexterm zone="panel-applet-gconf-set-value"><primary>panel_applet_gconf_set_value</primary></indexterm>
423
 
<programlisting><link linkend="void">void</link>                panel_applet_gconf_set_value        (<link linkend="PanelApplet">PanelApplet</link> *applet,
424
 
                                                         const <link linkend="gchar">gchar</link> *key,
425
 
                                                         <link linkend="GConfValue">GConfValue</link> *value,
426
 
                                                         <link linkend="GError">GError</link> **opt_error);</programlisting>
427
 
<para>
428
 
Convience wrapper for <link linkend="gconf-client-set-value"><function>gconf_client_set_value()</function></link> which operates
429
 
on the individual per-applet key.
430
 
</para>
431
 
<para>
432
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for <parameter>opt_error</parameter>, this function will print
433
 
a warning message from any <link linkend="GError"><type>GError</type></link> which <link linkend="gconf-client-set-value"><function>gconf_client_set_value()</function></link>
434
 
returns.
435
 
</para><variablelist role="params">
436
 
<varlistentry><term><parameter>applet</parameter>&#160;:</term>
437
 
<listitem><simpara>The <link linkend="PanelApplet."><type>PanelApplet.</type></link>
438
 
</simpara></listitem></varlistentry>
439
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
440
 
<listitem><simpara>The key name of the preference.
441
 
</simpara></listitem></varlistentry>
442
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
443
 
<listitem><simpara>The GConf value to set the key with.
444
 
</simpara></listitem></varlistentry>
445
 
<varlistentry><term><parameter>opt_error</parameter>&#160;:</term>
446
 
<listitem><simpara>Optional <link linkend="GError"><type>GError</type></link>**.
447
 
</simpara></listitem></varlistentry>
448
 
</variablelist></refsect2>
449
 
 
450
 
</refsect1>
451
 
 
452
 
</refentry>