1
<!-- ##### SECTION Title ##### -->
2
Panel Applet GConf Utilities
4
<!-- ##### SECTION Short_Description ##### -->
5
Utility methods for manipulating per-applet GConf preferences.
7
<!-- ##### SECTION Long_Description ##### -->
9
Applets typically define a set of preferences using a schemas
10
file and panel_applet_add_preferences(). Such preferences apply
11
only to an individual applet instance. For example, you may add
12
two clock applets to the panel and configure them differently.
16
In order for the preferences to only apply to a single applet,
17
each applet must have a seperate GConf key for each of these
18
preferences. The methods described below provide convient wrappers
19
around the usual #GConfClient functions and operate on these
23
<!-- ##### SECTION See_Also ##### -->
27
<!-- ##### SECTION Stability_Level ##### -->
30
<!-- ##### SECTION Image ##### -->
33
<!-- ##### FUNCTION panel_applet_gconf_get_full_key ##### -->
35
Access the full path for an individual per-applet GConf key. Using
36
the returned path you may directly modify the preference using
37
the usual GConf functions without using any of the convenience
38
wrappers described below.
41
@applet: The #PanelApplet.
42
@key: The key name of the preference.
43
@Returns: The full GConf key - free using g_free().
46
<!-- ##### FUNCTION panel_applet_gconf_get_bool ##### -->
48
Convience wrapper for gconf_client_get_bool() which operates
49
on the individual per-applet key.
53
If you pass %NULL for @opt_error, this function will print
54
a warning message from any #GError which gconf_client_get_bool()
58
@applet: The #PanelApplet.
59
@key: The key name of the preference.
60
@opt_error: Optional #GError**.
61
@Returns: The bool value of the key.
64
<!-- ##### FUNCTION panel_applet_gconf_get_int ##### -->
66
Convience wrapper for gconf_client_get_int() which operates
67
on the individual per-applet key.
71
If you pass %NULL for @opt_error, this function will print
72
a warning message from any #GError which gconf_client_get_int()
76
@applet: The #PanelApplet.
77
@key: The key name of the preference.
78
@opt_error: Optional #GError**.
79
@Returns: The integer value of the key.
82
<!-- ##### FUNCTION panel_applet_gconf_get_string ##### -->
84
Convience wrapper for gconf_client_get_string() which operates
85
on the individual per-applet key.
89
If you pass %NULL for @opt_error, this function will print
90
a warning message from any #GError which gconf_client_get_string()
94
@applet: The #PanelApplet.
95
@key: The key name of the preference.
96
@opt_error: Optional #GError**.
97
@Returns: The string value of the key, or %NULL if unset.
100
<!-- ##### FUNCTION panel_applet_gconf_get_float ##### -->
102
Convience wrapper for gconf_client_get_float() which operates
103
on the individual per-applet key.
107
If you pass %NULL for @opt_error, this function will print
108
a warning message from any #GError which gconf_client_get_float()
112
@applet: The #PanelApplet.
113
@key: The key name of the preference.
114
@opt_error: Optional #GError**.
115
@Returns: The floating point value of the key.
118
<!-- ##### FUNCTION panel_applet_gconf_get_list ##### -->
120
Convience wrapper for gconf_client_get_list() which operates
121
on the individual per-applet key.
125
If you pass %NULL for @opt_error, this function will print
126
a warning message from any #GError which gconf_client_get_list()
130
@applet: The #PanelApplet.
131
@key: The key name of the preference.
132
@list_type: The GConf value type of the list elements.
133
@opt_error: Optional #GError**.
134
@Returns: The list of values set for the key.
137
<!-- ##### FUNCTION panel_applet_gconf_get_value ##### -->
139
Convience wrapper for gconf_client_get_value() which operates
140
on the individual per-applet key.
144
If you pass %NULL for @opt_error, this function will print
145
a warning message from any #GError which gconf_client_get_value()
149
@applet: The #PanelApplet.
150
@key: The key name of the preference.
151
@opt_error: Optional #GError**.
152
@Returns: The GConf value set for the key.
155
<!-- ##### FUNCTION panel_applet_gconf_set_bool ##### -->
157
Convience wrapper for gconf_client_set_bool() which operates
158
on the individual per-applet key.
162
If you pass %NULL for @opt_error, this function will print
163
a warning message from any #GError which gconf_client_set_bool()
167
@applet: The #PanelApplet.
168
@key: The key name of the preference.
169
@the_bool: The boolean value to set the key with.
170
@opt_error: Optional #GError**.
173
<!-- ##### FUNCTION panel_applet_gconf_set_int ##### -->
175
Convience wrapper for gconf_client_set_int() which operates
176
on the individual per-applet key.
180
If you pass %NULL for @opt_error, this function will print
181
a warning message from any #GError which gconf_client_set_int()
185
@applet: The #PanelApplet.
186
@key: The key name of the preference.
187
@the_int: The integer value to set the key with.
188
@opt_error: Optional #GError**.
191
<!-- ##### FUNCTION panel_applet_gconf_set_string ##### -->
193
Convience wrapper for gconf_client_set_string() which operates
194
on the individual per-applet key.
198
If you pass %NULL for @opt_error, this function will print
199
a warning message from any #GError which gconf_client_set_string()
203
@applet: The #PanelApplet.
204
@key: The key name of the preference.
205
@the_string: The string value to set the key with.
206
@opt_error: Optional #GError**.
209
<!-- ##### FUNCTION panel_applet_gconf_set_float ##### -->
211
Convience wrapper for gconf_client_set_float() which operates
212
on the individual per-applet key.
216
If you pass %NULL for @opt_error, this function will print
217
a warning message from any #GError which gconf_client_set_float()
221
@applet: The #PanelApplet.
222
@key: The key name of the preference.
223
@the_float: The floating point value to set the key with.
224
@opt_error: Optional #GError**.
227
<!-- ##### FUNCTION panel_applet_gconf_set_list ##### -->
229
Convience wrapper for gconf_client_set_list() which operates
230
on the individual per-applet key.
234
If you pass %NULL for @opt_error, this function will print
235
a warning message from any #GError which gconf_client_set_list()
239
@applet: The #PanelApplet.
240
@key: The key name of the preference.
241
@list_type: The GConf value type of the list items.
242
@list: The list of values to set the key with.
243
@opt_error: Optional #GError**.
246
<!-- ##### FUNCTION panel_applet_gconf_set_value ##### -->
248
Convience wrapper for gconf_client_set_value() which operates
249
on the individual per-applet key.
253
If you pass %NULL for @opt_error, this function will print
254
a warning message from any #GError which gconf_client_set_value()
258
@applet: The #PanelApplet.
259
@key: The key name of the preference.
260
@value: The GConf value to set the key with.
261
@opt_error: Optional #GError**.
added
removed
doc/reference/panel-applet/tmpl/panel-applet-gconf.sgml
