← Back to branch summary

~ubuntu-branches/ubuntu/saucy/glib2.0/saucy-proposed

« back to all changes in this revision

Viewing changes to docs/reference/glib/tmpl/keyfile.sgml

  • Committer: Package Import Robot
  • Author(s): Iain Lane
  • Date: 2013-08-21 10:08:49 UTC
  • mfrom: (1.63.24)
  • Revision ID: package-import@ubuntu.com-20130821100849-enhti9o2tk0iug5r
Tags: 2.37.6-1ubuntu1
* Resynchronise with Debian, remaining change:
  - Build-Depend on python:any for cross-building.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/glib/tmpl/keyfile.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
Key-value file parser
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
 
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
<para>
 
9
 
 
10
</para>
 
11
 
 
12
 
 
13
<!-- ##### SECTION See_Also ##### -->
 
14
<para>
 
15
 
 
16
</para>
 
17
 
 
18
 
 
19
<!-- ##### SECTION Stability_Level ##### -->
 
20
 
 
21
 
 
22
<!-- ##### SECTION Image ##### -->
 
23
 
 
24
 
 
25
<!-- ##### STRUCT GKeyFile ##### -->
 
26
<para>
 
27
 
 
28
</para>
 
29
 
 
30
 
 
31
<!-- ##### MACRO G_KEY_FILE_ERROR ##### -->
 
32
<para>
 
33
 
 
34
</para>
 
35
 
 
36
 
 
37
 
 
38
<!-- ##### ENUM GKeyFileError ##### -->
 
39
<para>
 
40
 
 
41
</para>
 
42
 
 
43
@G_KEY_FILE_ERROR_UNKNOWN_ENCODING: 
 
44
@G_KEY_FILE_ERROR_PARSE: 
 
45
@G_KEY_FILE_ERROR_NOT_FOUND: 
 
46
@G_KEY_FILE_ERROR_KEY_NOT_FOUND: 
 
47
@G_KEY_FILE_ERROR_GROUP_NOT_FOUND: 
 
48
@G_KEY_FILE_ERROR_INVALID_VALUE: 
 
49
 
 
50
<!-- ##### ENUM GKeyFileFlags ##### -->
 
51
<para>
 
52
 
 
53
</para>
 
54
 
 
55
@G_KEY_FILE_NONE: 
 
56
@G_KEY_FILE_KEEP_COMMENTS: 
 
57
@G_KEY_FILE_KEEP_TRANSLATIONS: 
 
58
 
 
59
<!-- ##### FUNCTION g_key_file_new ##### -->
 
60
<para>
 
61
 
 
62
</para>
 
63
 
 
64
@void: 
 
65
@Returns: 
 
66
 
 
67
 
 
68
<!-- ##### FUNCTION g_key_file_free ##### -->
 
69
<para>
 
70
 
 
71
</para>
 
72
 
 
73
@key_file: 
 
74
 
 
75
 
 
76
<!-- ##### FUNCTION g_key_file_ref ##### -->
 
77
<para>
 
78
 
 
79
</para>
 
80
 
 
81
@key_file: 
 
82
@Returns: 
 
83
 
 
84
 
 
85
<!-- ##### FUNCTION g_key_file_unref ##### -->
 
86
<para>
 
87
 
 
88
</para>
 
89
 
 
90
@key_file: 
 
91
 
 
92
 
 
93
<!-- ##### FUNCTION g_key_file_set_list_separator ##### -->
 
94
<para>
 
95
 
 
96
</para>
 
97
 
 
98
@key_file: 
 
99
@separator: 
 
100
 
 
101
 
 
102
<!-- ##### FUNCTION g_key_file_load_from_file ##### -->
 
103
<para>
 
104
 
 
105
</para>
 
106
 
 
107
@key_file: 
 
108
@file: 
 
109
@flags: 
 
110
@error: 
 
111
@Returns: 
 
112
 
 
113
 
 
114
<!-- ##### FUNCTION g_key_file_load_from_data ##### -->
 
115
<para>
 
116
 
 
117
</para>
 
118
 
 
119
@key_file: 
 
120
@data: 
 
121
@length: 
 
122
@flags: 
 
123
@error: 
 
124
@Returns: 
 
125
 
 
126
 
 
127
<!-- ##### FUNCTION g_key_file_load_from_data_dirs ##### -->
 
128
<para>
 
129
 
 
130
</para>
 
131
 
 
132
@key_file: 
 
133
@file: 
 
134
@full_path: 
 
135
@flags: 
 
136
@error: 
 
137
@Returns: 
 
138
 
 
139
 
 
140
<!-- ##### FUNCTION g_key_file_load_from_dirs ##### -->
 
141
<para>
 
142
 
 
143
</para>
 
144
 
 
145
@key_file: 
 
146
@file: 
 
147
@search_dirs: 
 
148
@full_path: 
 
149
@flags: 
 
150
@error: 
 
151
@Returns: 
 
152
 
 
153
 
 
154
<!-- ##### FUNCTION g_key_file_to_data ##### -->
 
155
<para>
 
156
 
 
157
</para>
 
158
 
 
159
@key_file: 
 
160
@length: 
 
161
@error: 
 
162
@Returns: 
 
163
 
 
164
 
 
165
<!-- ##### FUNCTION g_key_file_get_start_group ##### -->
 
166
<para>
 
167
 
 
168
</para>
 
169
 
 
170
@key_file: 
 
171
@Returns: 
 
172
 
 
173
 
 
174
<!-- ##### FUNCTION g_key_file_get_groups ##### -->
 
175
<para>
 
176
 
 
177
</para>
 
178
 
 
179
@key_file: 
 
180
@length: 
 
181
@Returns: 
 
182
 
 
183
 
 
184
<!-- ##### FUNCTION g_key_file_get_keys ##### -->
 
185
<para>
 
186
 
 
187
</para>
 
188
 
 
189
@key_file: 
 
190
@group_name: 
 
191
@length: 
 
192
@error: 
 
193
@Returns: 
 
194
 
 
195
 
 
196
<!-- ##### FUNCTION g_key_file_has_group ##### -->
 
197
<para>
 
198
 
 
199
</para>
 
200
 
 
201
@key_file: 
 
202
@group_name: 
 
203
@Returns: 
 
204
 
 
205
 
 
206
<!-- ##### FUNCTION g_key_file_has_key ##### -->
 
207
<para>
 
208
 
 
209
</para>
 
210
 
 
211
@key_file: 
 
212
@group_name: 
 
213
@key: 
 
214
@error: 
 
215
@Returns: 
 
216
 
 
217
 
 
218
<!-- ##### FUNCTION g_key_file_get_value ##### -->
 
219
<para>
 
220
 
 
221
</para>
 
222
 
 
223
@key_file: 
 
224
@group_name: 
 
225
@key: 
 
226
@error: 
 
227
@Returns: 
 
228
 
 
229
 
 
230
<!-- ##### FUNCTION g_key_file_get_string ##### -->
 
231
<para>
 
232
 
 
233
</para>
 
234
 
 
235
@key_file: 
 
236
@group_name: 
 
237
@key: 
 
238
@error: 
 
239
@Returns: 
 
240
 
 
241
 
 
242
<!-- ##### FUNCTION g_key_file_get_locale_string ##### -->
 
243
<para>
 
244
 
 
245
</para>
 
246
 
 
247
@key_file: 
 
248
@group_name: 
 
249
@key: 
 
250
@locale: 
 
251
@error: 
 
252
@Returns: 
 
253
 
 
254
 
 
255
<!-- ##### FUNCTION g_key_file_get_boolean ##### -->
 
256
<para>
 
257
 
 
258
</para>
 
259
 
 
260
@key_file: 
 
261
@group_name: 
 
262
@key: 
 
263
@error: 
 
264
@Returns: 
 
265
 
 
266
 
 
267
<!-- ##### FUNCTION g_key_file_get_integer ##### -->
 
268
<para>
 
269
 
 
270
</para>
 
271
 
 
272
@key_file: 
 
273
@group_name: 
 
274
@key: 
 
275
@error: 
 
276
@Returns: 
 
277
 
 
278
 
 
279
<!-- ##### FUNCTION g_key_file_get_int64 ##### -->
 
280
<para>
 
281
 
 
282
</para>
 
283
 
 
284
@key_file: 
 
285
@group_name: 
 
286
@key: 
 
287
@error: 
 
288
@Returns: 
 
289
 
 
290
 
 
291
<!-- ##### FUNCTION g_key_file_get_uint64 ##### -->
 
292
<para>
 
293
 
 
294
</para>
 
295
 
 
296
@key_file: 
 
297
@group_name: 
 
298
@key: 
 
299
@error: 
 
300
@Returns: 
 
301
 
 
302
 
 
303
<!-- ##### FUNCTION g_key_file_get_double ##### -->
 
304
<para>
 
305
 
 
306
</para>
 
307
 
 
308
@key_file: 
 
309
@group_name: 
 
310
@key: 
 
311
@error: 
 
312
@Returns: 
 
313
 
 
314
 
 
315
<!-- ##### FUNCTION g_key_file_get_string_list ##### -->
 
316
<para>
 
317
 
 
318
</para>
 
319
 
 
320
@key_file: 
 
321
@group_name: 
 
322
@key: 
 
323
@length: 
 
324
@error: 
 
325
@Returns: 
 
326
 
 
327
 
 
328
<!-- ##### FUNCTION g_key_file_get_locale_string_list ##### -->
 
329
<para>
 
330
 
 
331
</para>
 
332
 
 
333
@key_file: 
 
334
@group_name: 
 
335
@key: 
 
336
@locale: 
 
337
@length: 
 
338
@error: 
 
339
@Returns: 
 
340
 
 
341
 
 
342
<!-- ##### FUNCTION g_key_file_get_boolean_list ##### -->
 
343
<para>
 
344
 
 
345
</para>
 
346
 
 
347
@key_file: 
 
348
@group_name: 
 
349
@key: 
 
350
@length: 
 
351
@error: 
 
352
@Returns: 
 
353
 
 
354
 
 
355
<!-- ##### FUNCTION g_key_file_get_integer_list ##### -->
 
356
<para>
 
357
 
 
358
</para>
 
359
 
 
360
@key_file: 
 
361
@group_name: 
 
362
@key: 
 
363
@length: 
 
364
@error: 
 
365
@Returns: 
 
366
 
 
367
 
 
368
<!-- ##### FUNCTION g_key_file_get_double_list ##### -->
 
369
<para>
 
370
 
 
371
</para>
 
372
 
 
373
@key_file: 
 
374
@group_name: 
 
375
@key: 
 
376
@length: 
 
377
@error: 
 
378
@Returns: 
 
379
 
 
380
 
 
381
<!-- ##### FUNCTION g_key_file_get_comment ##### -->
 
382
<para>
 
383
 
 
384
</para>
 
385
 
 
386
@key_file: 
 
387
@group_name: 
 
388
@key: 
 
389
@error: 
 
390
@Returns: 
 
391
 
 
392
 
 
393
<!-- ##### FUNCTION g_key_file_set_value ##### -->
 
394
<para>
 
395
 
 
396
</para>
 
397
 
 
398
@key_file: 
 
399
@group_name: 
 
400
@key: 
 
401
@value: 
 
402
 
 
403
 
 
404
<!-- ##### FUNCTION g_key_file_set_string ##### -->
 
405
<para>
 
406
 
 
407
</para>
 
408
 
 
409
@key_file: 
 
410
@group_name: 
 
411
@key: 
 
412
@string: 
 
413
 
 
414
 
 
415
<!-- ##### FUNCTION g_key_file_set_locale_string ##### -->
 
416
<para>
 
417
 
 
418
</para>
 
419
 
 
420
@key_file: 
 
421
@group_name: 
 
422
@key: 
 
423
@locale: 
 
424
@string: 
 
425
 
 
426
 
 
427
<!-- ##### FUNCTION g_key_file_set_boolean ##### -->
 
428
<para>
 
429
 
 
430
</para>
 
431
 
 
432
@key_file: 
 
433
@group_name: 
 
434
@key: 
 
435
@value: 
 
436
 
 
437
 
 
438
<!-- ##### FUNCTION g_key_file_set_integer ##### -->
 
439
<para>
 
440
 
 
441
</para>
 
442
 
 
443
@key_file: 
 
444
@group_name: 
 
445
@key: 
 
446
@value: 
 
447
 
 
448
 
 
449
<!-- ##### FUNCTION g_key_file_set_int64 ##### -->
 
450
<para>
 
451
 
 
452
</para>
 
453
 
 
454
@key_file: 
 
455
@group_name: 
 
456
@key: 
 
457
@value: 
 
458
 
 
459
 
 
460
<!-- ##### FUNCTION g_key_file_set_uint64 ##### -->
 
461
<para>
 
462
 
 
463
</para>
 
464
 
 
465
@key_file: 
 
466
@group_name: 
 
467
@key: 
 
468
@value: 
 
469
 
 
470
 
 
471
<!-- ##### FUNCTION g_key_file_set_double ##### -->
 
472
<para>
 
473
 
 
474
</para>
 
475
 
 
476
@key_file: 
 
477
@group_name: 
 
478
@key: 
 
479
@value: 
 
480
 
 
481
 
 
482
<!-- ##### FUNCTION g_key_file_set_string_list ##### -->
 
483
<para>
 
484
 
 
485
</para>
 
486
 
 
487
@key_file: 
 
488
@group_name: 
 
489
@key: 
 
490
@list: 
 
491
@length: 
 
492
 
 
493
 
 
494
<!-- ##### FUNCTION g_key_file_set_locale_string_list ##### -->
 
495
<para>
 
496
 
 
497
</para>
 
498
 
 
499
@key_file: 
 
500
@group_name: 
 
501
@key: 
 
502
@locale: 
 
503
@list: 
 
504
@length: 
 
505
 
 
506
 
 
507
<!-- ##### FUNCTION g_key_file_set_boolean_list ##### -->
 
508
<para>
 
509
 
 
510
</para>
 
511
 
 
512
@key_file: 
 
513
@group_name: 
 
514
@key: 
 
515
@list: 
 
516
@length: 
 
517
 
 
518
 
 
519
<!-- ##### FUNCTION g_key_file_set_integer_list ##### -->
 
520
<para>
 
521
 
 
522
</para>
 
523
 
 
524
@key_file: 
 
525
@group_name: 
 
526
@key: 
 
527
@list: 
 
528
@length: 
 
529
 
 
530
 
 
531
<!-- ##### FUNCTION g_key_file_set_double_list ##### -->
 
532
<para>
 
533
 
 
534
</para>
 
535
 
 
536
@key_file: 
 
537
@group_name: 
 
538
@key: 
 
539
@list: 
 
540
@length: 
 
541
 
 
542
 
 
543
<!-- ##### FUNCTION g_key_file_set_comment ##### -->
 
544
<para>
 
545
 
 
546
</para>
 
547
 
 
548
@key_file: 
 
549
@group_name: 
 
550
@key: 
 
551
@comment: 
 
552
@error: 
 
553
@Returns: 
 
554
 
 
555
 
 
556
<!-- ##### FUNCTION g_key_file_remove_group ##### -->
 
557
<para>
 
558
 
 
559
</para>
 
560
 
 
561
@key_file: 
 
562
@group_name: 
 
563
@error: 
 
564
@Returns: 
 
565
 
 
566
 
 
567
<!-- ##### FUNCTION g_key_file_remove_key ##### -->
 
568
<para>
 
569
 
 
570
</para>
 
571
 
 
572
@key_file: 
 
573
@group_name: 
 
574
@key: 
 
575
@error: 
 
576
@Returns: 
 
577
 
 
578
 
 
579
<!-- ##### FUNCTION g_key_file_remove_comment ##### -->
 
580
<para>
 
581
 
 
582
</para>
 
583
 
 
584
@key_file: 
 
585
@group_name: 
 
586
@key: 
 
587
@error: 
 
588
@Returns: 
 
589
 
 
590
 
 
591
<!-- ##### MACRO G_KEY_FILE_DESKTOP_GROUP ##### -->
 
592
<para>
 
593
 
 
594
</para>
 
595
 
 
596
 
 
597
 
 
598
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_TYPE ##### -->
 
599
<para>
 
600
 
 
601
</para>
 
602
 
 
603
 
 
604
 
 
605
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_VERSION ##### -->
 
606
<para>
 
607
 
 
608
</para>
 
609
 
 
610
 
 
611
 
 
612
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_NAME ##### -->
 
613
<para>
 
614
 
 
615
</para>
 
616
 
 
617
 
 
618
 
 
619
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME ##### -->
 
620
<para>
 
621
 
 
622
</para>
 
623
 
 
624
 
 
625
 
 
626
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY ##### -->
 
627
<para>
 
628
 
 
629
</para>
 
630
 
 
631
 
 
632
 
 
633
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_COMMENT ##### -->
 
634
<para>
 
635
 
 
636
</para>
 
637
 
 
638
 
 
639
 
 
640
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_ICON ##### -->
 
641
<para>
 
642
 
 
643
</para>
 
644
 
 
645
 
 
646
 
 
647
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_HIDDEN ##### -->
 
648
<para>
 
649
 
 
650
</para>
 
651
 
 
652
 
 
653
 
 
654
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN ##### -->
 
655
<para>
 
656
 
 
657
</para>
 
658
 
 
659
 
 
660
 
 
661
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN ##### -->
 
662
<para>
 
663
 
 
664
</para>
 
665
 
 
666
 
 
667
 
 
668
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_TRY_EXEC ##### -->
 
669
<para>
 
670
 
 
671
</para>
 
672
 
 
673
 
 
674
 
 
675
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_EXEC ##### -->
 
676
<para>
 
677
 
 
678
</para>
 
679
 
 
680
 
 
681
 
 
682
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_PATH ##### -->
 
683
<para>
 
684
 
 
685
</para>
 
686
 
 
687
 
 
688
 
 
689
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_TERMINAL ##### -->
 
690
<para>
 
691
 
 
692
</para>
 
693
 
 
694
 
 
695
 
 
696
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_MIME_TYPE ##### -->
 
697
<para>
 
698
 
 
699
</para>
 
700
 
 
701
 
 
702
 
 
703
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_CATEGORIES ##### -->
 
704
<para>
 
705
 
 
706
</para>
 
707
 
 
708
 
 
709
 
 
710
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY ##### -->
 
711
<para>
 
712
 
 
713
</para>
 
714
 
 
715
 
 
716
 
 
717
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS ##### -->
 
718
<para>
 
719
 
 
720
</para>
 
721
 
 
722
 
 
723
 
 
724
<!-- ##### MACRO G_KEY_FILE_DESKTOP_KEY_URL ##### -->
 
725
<para>
 
726
 
 
727
</para>
 
728
 
 
729
 
 
730
 
 
731
<!-- ##### MACRO G_KEY_FILE_DESKTOP_TYPE_APPLICATION ##### -->
 
732
<para>
 
733
 
 
734
</para>
 
735
 
 
736
 
 
737
 
 
738
<!-- ##### MACRO G_KEY_FILE_DESKTOP_TYPE_LINK ##### -->
 
739
<para>
 
740
 
 
741
</para>
 
742
 
 
743
 
 
744
 
 
745
<!-- ##### MACRO G_KEY_FILE_DESKTOP_TYPE_DIRECTORY ##### -->
 
746
<para>
 
747
 
 
748
</para>
 
749
 
 
750
 
 
751