1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
<!-- ##### SECTION Title ##### -->
Panel Applet MateConf Utilities
<!-- ##### SECTION Short_Description ##### -->
Utility methods for manipulating per-applet MateConf preferences.
<!-- ##### SECTION Long_Description ##### -->
<para>
Applets typically define a set of preferences using a schemas
file and mate_panel_applet_add_preferences(). Such preferences apply
only to an individual applet instance. For example, you may add
two clock applets to the panel and configure them differently.
</para>
<para>
In order for the preferences to only apply to a single applet,
each applet must have a seperate MateConf key for each of these
preferences. The methods described below provide convient wrappers
around the usual #MateConfClient functions and operate on these
per-applet keys.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### FUNCTION mate_panel_applet_mateconf_get_full_key ##### -->
<para>
Access the full path for an individual per-applet MateConf key. Using
the returned path you may directly modify the preference using
the usual MateConf functions without using any of the convenience
wrappers described below.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@Returns: The full MateConf key - free using g_free().
<!-- ##### FUNCTION mate_panel_applet_mateconf_get_bool ##### -->
<para>
Convience wrapper for mateconf_client_get_bool() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_get_bool()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@opt_error: Optional #GError**.
@Returns: The bool value of the key.
<!-- ##### FUNCTION mate_panel_applet_mateconf_get_int ##### -->
<para>
Convience wrapper for mateconf_client_get_int() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_get_int()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@opt_error: Optional #GError**.
@Returns: The integer value of the key.
<!-- ##### FUNCTION mate_panel_applet_mateconf_get_string ##### -->
<para>
Convience wrapper for mateconf_client_get_string() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_get_string()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@opt_error: Optional #GError**.
@Returns: The string value of the key, or %NULL if unset.
<!-- ##### FUNCTION mate_panel_applet_mateconf_get_float ##### -->
<para>
Convience wrapper for mateconf_client_get_float() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_get_float()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@opt_error: Optional #GError**.
@Returns: The floating point value of the key.
<!-- ##### FUNCTION mate_panel_applet_mateconf_get_list ##### -->
<para>
Convience wrapper for mateconf_client_get_list() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_get_list()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@list_type: The MateConf value type of the list elements.
@opt_error: Optional #GError**.
@Returns: The list of values set for the key.
<!-- ##### FUNCTION mate_panel_applet_mateconf_get_value ##### -->
<para>
Convience wrapper for mateconf_client_get_value() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_get_value()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@opt_error: Optional #GError**.
@Returns: The MateConf value set for the key.
<!-- ##### FUNCTION mate_panel_applet_mateconf_set_bool ##### -->
<para>
Convience wrapper for mateconf_client_set_bool() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_set_bool()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@the_bool: The boolean value to set the key with.
@opt_error: Optional #GError**.
<!-- ##### FUNCTION mate_panel_applet_mateconf_set_int ##### -->
<para>
Convience wrapper for mateconf_client_set_int() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_set_int()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@the_int: The integer value to set the key with.
@opt_error: Optional #GError**.
<!-- ##### FUNCTION mate_panel_applet_mateconf_set_string ##### -->
<para>
Convience wrapper for mateconf_client_set_string() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_set_string()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@the_string: The string value to set the key with.
@opt_error: Optional #GError**.
<!-- ##### FUNCTION mate_panel_applet_mateconf_set_float ##### -->
<para>
Convience wrapper for mateconf_client_set_float() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_set_float()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@the_float: The floating point value to set the key with.
@opt_error: Optional #GError**.
<!-- ##### FUNCTION mate_panel_applet_mateconf_set_list ##### -->
<para>
Convience wrapper for mateconf_client_set_list() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_set_list()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@list_type: The MateConf value type of the list items.
@list: The list of values to set the key with.
@opt_error: Optional #GError**.
<!-- ##### FUNCTION mate_panel_applet_mateconf_set_value ##### -->
<para>
Convience wrapper for mateconf_client_set_value() which operates
on the individual per-applet key.
</para>
<para>
If you pass %NULL for @opt_error, this function will print
a warning message from any #GError which mateconf_client_set_value()
returns.
</para>
@applet: The #MatePanelApplet.
@key: The key name of the preference.
@value: The MateConf value to set the key with.
@opt_error: Optional #GError**.
|
