~ubuntu-branches/ubuntu/precise/evolution/precise

« back to all changes in this revision

Viewing changes to doc/reference/shell/tmpl/e-util.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-05-30 14:08:05 UTC
  • mfrom: (1.1.79 upstream)
  • Revision ID: james.westby@ubuntu.com-20110530140805-nhlx5os5z2ru31vy
Tags: 3.0.2-0ubuntu1
New upstream release 3.0.2.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!-- ##### SECTION Title ##### -->
 
2
Miscellaneous Utilities
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
 
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
<para>
 
9
 
 
10
</para>
 
11
 
 
12
<!-- ##### SECTION See_Also ##### -->
 
13
<para>
 
14
 
 
15
</para>
 
16
 
 
17
<!-- ##### SECTION Stability_Level ##### -->
 
18
 
 
19
 
 
20
<!-- ##### SECTION Image ##### -->
 
21
 
 
22
 
 
23
<!-- ##### FUNCTION e_get_gnome2_user_dir ##### -->
 
24
<para>
 
25
 
 
26
</para>
 
27
 
 
28
@void: 
 
29
@Returns: 
 
30
 
 
31
 
 
32
<!-- ##### FUNCTION e_get_accels_filename ##### -->
 
33
<para>
 
34
 
 
35
</para>
 
36
 
 
37
@void: 
 
38
@Returns: 
 
39
 
 
40
 
 
41
<!-- ##### FUNCTION e_show_uri ##### -->
 
42
<para>
 
43
 
 
44
</para>
 
45
 
 
46
@parent: 
 
47
@uri: 
 
48
 
 
49
 
 
50
<!-- ##### FUNCTION e_display_help ##### -->
 
51
<para>
 
52
 
 
53
</para>
 
54
 
 
55
@parent: 
 
56
@link_id: 
 
57
 
 
58
 
 
59
<!-- ##### FUNCTION e_lookup_action ##### -->
 
60
<para>
 
61
 
 
62
</para>
 
63
 
 
64
@ui_manager: 
 
65
@action_name: 
 
66
@Returns: 
 
67
 
 
68
 
 
69
<!-- ##### FUNCTION e_lookup_action_group ##### -->
 
70
<para>
 
71
 
 
72
</para>
 
73
 
 
74
@ui_manager: 
 
75
@group_name: 
 
76
@Returns: 
 
77
 
 
78
 
 
79
<!-- ##### FUNCTION e_action_compare_by_label ##### -->
 
80
<para>
 
81
 
 
82
</para>
 
83
 
 
84
@action1: 
 
85
@action2: 
 
86
@Returns: 
 
87
 
 
88
 
 
89
<!-- ##### FUNCTION e_action_group_remove_all_actions ##### -->
 
90
<para>
 
91
 
 
92
</para>
 
93
 
 
94
@action_group: 
 
95
 
 
96
 
 
97
<!-- ##### FUNCTION e_radio_action_get_current_action ##### -->
 
98
<para>
 
99
 
 
100
</para>
 
101
 
 
102
@radio_action: 
 
103
@Returns: 
 
104
 
 
105
 
 
106
<!-- ##### FUNCTION e_categories_add_change_hook ##### -->
 
107
<para>
 
108
 
 
109
</para>
 
110
 
 
111
@func: 
 
112
@object: 
 
113
 
 
114
 
 
115
<!-- ##### FUNCTION e_type_traverse ##### -->
 
116
<para>
 
117
 
 
118
</para>
 
119
 
 
120
@parent_type: 
 
121
@func: 
 
122
@user_data: 
 
123
 
 
124
 
 
125
<!-- ##### FUNCTION e_str_without_underscores ##### -->
 
126
<para>
 
127
 
 
128
</para>
 
129
 
 
130
@string: 
 
131
@Returns: 
 
132
 
 
133
 
 
134
<!-- ##### FUNCTION e_str_compare ##### -->
 
135
<para>
 
136
 
 
137
</para>
 
138
 
 
139
@x: 
 
140
@y: 
 
141
@Returns: 
 
142
 
 
143
 
 
144
<!-- ##### FUNCTION e_str_case_compare ##### -->
 
145
<para>
 
146
 
 
147
</para>
 
148
 
 
149
@x: 
 
150
@y: 
 
151
@Returns: 
 
152
 
 
153
 
 
154
<!-- ##### FUNCTION e_collate_compare ##### -->
 
155
<para>
 
156
 
 
157
</para>
 
158
 
 
159
@x: 
 
160
@y: 
 
161
@Returns: 
 
162
 
 
163
 
 
164
<!-- ##### FUNCTION e_int_compare ##### -->
 
165
<para>
 
166
 
 
167
</para>
 
168
 
 
169
@x: 
 
170
@y: 
 
171
@Returns: 
 
172
 
 
173
 
 
174
<!-- ##### FUNCTION e_color_to_value ##### -->
 
175
<para>
 
176
 
 
177
</para>
 
178
 
 
179
@color: 
 
180
@Returns: 
 
181
 
 
182
 
 
183
<!-- ##### FUNCTION e_format_number ##### -->
 
184
<para>
 
185
 
 
186
</para>
 
187
 
 
188
@number: 
 
189
@Returns: 
 
190
 
 
191
 
 
192
<!-- ##### USER_FUNCTION ESortCompareFunc ##### -->
 
193
<para>
 
194
 
 
195
</para>
 
196
 
 
197
@first: 
 
198
@second: 
 
199
@closure: 
 
200
@Returns: 
 
201
 
 
202
 
 
203
<!-- ##### FUNCTION e_bsearch ##### -->
 
204
<para>
 
205
 
 
206
</para>
 
207
 
 
208
@key: 
 
209
@base: 
 
210
@nmemb: 
 
211
@size: 
 
212
@compare: 
 
213
@closure: 
 
214
@start: 
 
215
@end: 
 
216
 
 
217
 
 
218
<!-- ##### FUNCTION e_strftime_fix_am_pm ##### -->
 
219
<para>
 
220
 
 
221
</para>
 
222
 
 
223
@str: 
 
224
@max: 
 
225
@fmt: 
 
226
@tm: 
 
227
@Returns: 
 
228
 
 
229
 
 
230
<!-- ##### FUNCTION e_utf8_strftime_fix_am_pm ##### -->
 
231
<para>
 
232
 
 
233
</para>
 
234
 
 
235
@str: 
 
236
@max: 
 
237
@fmt: 
 
238
@tm: 
 
239
@Returns: 
 
240
 
 
241
 
 
242
<!-- ##### FUNCTION e_get_month_name ##### -->
 
243
<para>
 
244
 
 
245
</para>
 
246
 
 
247
@month: 
 
248
@abbreviated: 
 
249
@Returns: 
 
250
 
 
251
 
 
252
<!-- ##### FUNCTION e_get_weekday_name ##### -->
 
253
<para>
 
254
 
 
255
</para>
 
256
 
 
257
@weekday: 
 
258
@abbreviated: 
 
259
@Returns: 
 
260
 
 
261
 
 
262
<!-- ##### FUNCTION e_flexible_strtod ##### -->
 
263
<para>
 
264
 
 
265
</para>
 
266
 
 
267
@nptr: 
 
268
@endptr: 
 
269
@Returns: 
 
270
 
 
271
 
 
272
<!-- ##### FUNCTION e_ascii_dtostr ##### -->
 
273
<para>
 
274
 
 
275
</para>
 
276
 
 
277
@buffer: 
 
278
@buf_len: 
 
279
@format: 
 
280
@d: 
 
281
@Returns: 
 
282
 
 
283
 
 
284
<!-- ##### FUNCTION e_file_lock_create ##### -->
 
285
<para>
 
286
 
 
287
</para>
 
288
 
 
289
@void: 
 
290
@Returns: 
 
291
 
 
292
 
 
293
<!-- ##### FUNCTION e_file_lock_destroy ##### -->
 
294
<para>
 
295
 
 
296
</para>
 
297
 
 
298
@void: 
 
299
 
 
300
 
 
301
<!-- ##### FUNCTION e_file_lock_exists ##### -->
 
302
<para>
 
303
 
 
304
</para>
 
305
 
 
306
@void: 
 
307
@Returns: 
 
308
 
 
309
 
 
310
<!-- ##### FUNCTION e_util_guess_mime_type ##### -->
 
311
<para>
 
312
 
 
313
</para>
 
314
 
 
315
@filename: 
 
316
@localfile: 
 
317
@Returns: 
 
318
 
 
319
 
 
320
<!-- ##### FUNCTION e_util_get_category_filter_options ##### -->
 
321
<para>
 
322
 
 
323
</para>
 
324
 
 
325
@void: 
 
326
@Returns: 
 
327
 
 
328
 
 
329
<!-- ##### FUNCTION e_binding_transform_color_to_string ##### -->
 
330
<para>
 
331
 
 
332
</para>
 
333
 
 
334
@binding: 
 
335
@source_value: 
 
336
@target_value: 
 
337
@not_used: 
 
338
@Returns: 
 
339
 
 
340
 
 
341
<!-- ##### FUNCTION e_binding_transform_string_to_color ##### -->
 
342
<para>
 
343
 
 
344
</para>
 
345
 
 
346
@binding: 
 
347
@source_value: 
 
348
@target_value: 
 
349
@not_used: 
 
350
@Returns: 
 
351
 
 
352
 
 
353
<!-- ##### FUNCTION e_binding_transform_enum_nick_to_value ##### -->
 
354
<para>
 
355
 
 
356
</para>
 
357
 
 
358
@binding: 
 
359
@source_value: 
 
360
@target_value: 
 
361
@not_used: 
 
362
@Returns: 
 
363
 
 
364
 
 
365
<!-- ##### FUNCTION e_binding_transform_enum_value_to_nick ##### -->
 
366
<para>
 
367
 
 
368
</para>
 
369
 
 
370
@binding: 
 
371
@source_value: 
 
372
@target_value: 
 
373
@not_used: 
 
374
@Returns: 
 
375
 
 
376
 
 
377
<!-- ##### FUNCTION e_binding_transform_source_to_uid ##### -->
 
378
<para>
 
379
 
 
380
</para>
 
381
 
 
382
@binding: 
 
383
@source_value: 
 
384
@target_value: 
 
385
@source_list: 
 
386
@Returns: 
 
387
 
 
388
 
 
389
<!-- ##### FUNCTION e_binding_transform_uid_to_source ##### -->
 
390
<para>
 
391
 
 
392
</para>
 
393
 
 
394
@binding: 
 
395
@source_value: 
 
396
@target_value: 
 
397
@source_list: 
 
398
@Returns: 
 
399
 
 
400
 
 
401
<!-- ##### FUNCTION e_charset_add_radio_actions ##### -->
 
402
<para>
 
403
 
 
404
</para>
 
405
 
 
406
@action_group: 
 
407
@action_prefix: 
 
408
@default_charset: 
 
409
@callback: 
 
410
@user_data: 
 
411
@Returns: 
 
412
 
 
413
 
 
414
<!-- ##### FUNCTION e_file_replace_contents_async ##### -->
 
415
<para>
 
416
 
 
417
</para>
 
418
 
 
419
@file: 
 
420
@contents: 
 
421
@length: 
 
422
@etag: 
 
423
@make_backup: 
 
424
@flags: 
 
425
@callback: 
 
426
@user_data: 
 
427
@Returns: 
 
428
 
 
429
 
 
430
<!-- ##### FUNCTION e_file_replace_contents_finish ##### -->
 
431
<para>
 
432
 
 
433
</para>
 
434
 
 
435
@file: 
 
436
@result: 
 
437
@new_etag: 
 
438
@error: 
 
439
@Returns: 
 
440
 
 
441
 
 
442
<!-- ##### FUNCTION e_mktemp ##### -->
 
443
<para>
 
444
 
 
445
</para>
 
446
 
 
447
@template: 
 
448
@Returns: 
 
449
 
 
450
 
 
451
<!-- ##### FUNCTION e_mkstemp ##### -->
 
452
<para>
 
453
 
 
454
</para>
 
455
 
 
456
@template: 
 
457
@Returns: 
 
458
 
 
459
 
 
460
<!-- ##### FUNCTION e_mkdtemp ##### -->
 
461
<para>
 
462
 
 
463
</para>
 
464
 
 
465
@template: 
 
466
@Returns: 
 
467
 
 
468