← Back to branch summary

~ubuntu-branches/ubuntu/quantal/dbus-glib/quantal

« back to all changes in this revision

Viewing changes to doc/reference/tmpl/dbus-glib.sgml

  • Committer: Package Import Robot
  • Author(s): Simon McVittie
  • Date: 2012-06-25 18:25:27 UTC
  • mfrom: (2.1.17 sid)
  • Revision ID: package-import@ubuntu.com-20120625182527-4427g7sb4bietikt
Tags: 0.100-1
* Update dbus-daemon introspection (from dbus 1.6.2)
* New upstream version
  - fixes the build with -Werror=format-security (patch from Ubuntu)
* Include /usr/share/dpkg/default.mk for recommended build flags

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/tmpl/dbus-glib.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
DBusGProxy
 
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
<!-- ##### MACRO DBUS_GERROR ##### -->
 
24
<para>
 
25
 
 
26
</para>
 
27
 
 
28
 
 
29
 
 
30
<!-- ##### MACRO DBUS_INSIDE_DBUS_GLIB_H ##### -->
 
31
<para>
 
32
 
 
33
</para>
 
34
 
 
35
 
 
36
 
 
37
<!-- ##### MACRO DBUS_TYPE_G_BOOLEAN_ARRAY ##### -->
 
38
<para>
 
39
 
 
40
</para>
 
41
 
 
42
 
 
43
 
 
44
<!-- ##### MACRO DBUS_TYPE_G_CONNECTION ##### -->
 
45
<para>
 
46
 
 
47
</para>
 
48
 
 
49
 
 
50
 
 
51
<!-- ##### MACRO DBUS_TYPE_G_INT64_ARRAY ##### -->
 
52
<para>
 
53
 
 
54
</para>
 
55
 
 
56
 
 
57
 
 
58
<!-- ##### MACRO DBUS_TYPE_G_INT_ARRAY ##### -->
 
59
<para>
 
60
 
 
61
</para>
 
62
 
 
63
 
 
64
 
 
65
<!-- ##### MACRO DBUS_TYPE_G_MESSAGE ##### -->
 
66
<para>
 
67
 
 
68
</para>
 
69
 
 
70
 
 
71
 
 
72
<!-- ##### MACRO DBUS_TYPE_G_OBJECT_ARRAY ##### -->
 
73
<para>
 
74
 
 
75
</para>
 
76
 
 
77
 
 
78
 
 
79
<!-- ##### MACRO DBUS_TYPE_G_OBJECT_PATH ##### -->
 
80
<para>
 
81
 
 
82
</para>
 
83
 
 
84
 
 
85
 
 
86
<!-- ##### MACRO DBUS_TYPE_G_SIGNATURE ##### -->
 
87
<para>
 
88
 
 
89
</para>
 
90
 
 
91
 
 
92
 
 
93
<!-- ##### MACRO DBUS_TYPE_G_STRING_STRING_HASHTABLE ##### -->
 
94
<para>
 
95
 
 
96
</para>
 
97
 
 
98
 
 
99
 
 
100
<!-- ##### MACRO DBUS_TYPE_G_UCHAR_ARRAY ##### -->
 
101
<para>
 
102
 
 
103
</para>
 
104
 
 
105
 
 
106
 
 
107
<!-- ##### MACRO DBUS_TYPE_G_UINT64_ARRAY ##### -->
 
108
<para>
 
109
 
 
110
</para>
 
111
 
 
112
 
 
113
 
 
114
<!-- ##### MACRO DBUS_TYPE_G_UINT_ARRAY ##### -->
 
115
<para>
 
116
 
 
117
</para>
 
118
 
 
119
 
 
120
 
 
121
<!-- ##### STRUCT DBusGAsyncData ##### -->
 
122
<para>
 
123
 
 
124
</para>
 
125
 
 
126
@cb: 
 
127
@userdata: 
 
128
 
 
129
<!-- ##### STRUCT DBusGConnection ##### -->
 
130
<para>
 
131
 
 
132
</para>
 
133
 
 
134
 
 
135
<!-- ##### ENUM DBusGError ##### -->
 
136
<para>
 
137
 
 
138
</para>
 
139
 
 
140
@DBUS_GERROR_FAILED: 
 
141
@DBUS_GERROR_NO_MEMORY: 
 
142
@DBUS_GERROR_SERVICE_UNKNOWN: 
 
143
@DBUS_GERROR_NAME_HAS_NO_OWNER: 
 
144
@DBUS_GERROR_NO_REPLY: 
 
145
@DBUS_GERROR_IO_ERROR: 
 
146
@DBUS_GERROR_BAD_ADDRESS: 
 
147
@DBUS_GERROR_NOT_SUPPORTED: 
 
148
@DBUS_GERROR_LIMITS_EXCEEDED: 
 
149
@DBUS_GERROR_ACCESS_DENIED: 
 
150
@DBUS_GERROR_AUTH_FAILED: 
 
151
@DBUS_GERROR_NO_SERVER: 
 
152
@DBUS_GERROR_TIMEOUT: 
 
153
@DBUS_GERROR_NO_NETWORK: 
 
154
@DBUS_GERROR_ADDRESS_IN_USE: 
 
155
@DBUS_GERROR_DISCONNECTED: 
 
156
@DBUS_GERROR_INVALID_ARGS: 
 
157
@DBUS_GERROR_FILE_NOT_FOUND: 
 
158
@DBUS_GERROR_FILE_EXISTS: 
 
159
@DBUS_GERROR_UNKNOWN_METHOD: 
 
160
@DBUS_GERROR_TIMED_OUT: 
 
161
@DBUS_GERROR_MATCH_RULE_NOT_FOUND: 
 
162
@DBUS_GERROR_MATCH_RULE_INVALID: 
 
163
@DBUS_GERROR_SPAWN_EXEC_FAILED: 
 
164
@DBUS_GERROR_SPAWN_FORK_FAILED: 
 
165
@DBUS_GERROR_SPAWN_CHILD_EXITED: 
 
166
@DBUS_GERROR_SPAWN_CHILD_SIGNALED: 
 
167
@DBUS_GERROR_SPAWN_FAILED: 
 
168
@DBUS_GERROR_UNIX_PROCESS_ID_UNKNOWN: 
 
169
@DBUS_GERROR_INVALID_SIGNATURE: 
 
170
@DBUS_GERROR_INVALID_FILE_CONTENT: 
 
171
@DBUS_GERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN: 
 
172
@DBUS_GERROR_REMOTE_EXCEPTION: 
 
173
 
 
174
<!-- ##### STRUCT DBusGMessage ##### -->
 
175
<para>
 
176
 
 
177
</para>
 
178
 
 
179
 
 
180
<!-- ##### STRUCT DBusGMethodInfo ##### -->
 
181
<para>
 
182
 
 
183
</para>
 
184
 
 
185
@function: 
 
186
@marshaller: 
 
187
@data_offset: 
 
188
 
 
189
<!-- ##### STRUCT DBusGMethodInvocation ##### -->
 
190
<para>
 
191
 
 
192
</para>
 
193
 
 
194
 
 
195
<!-- ##### STRUCT DBusGObjectInfo ##### -->
 
196
<para>
 
197
 
 
198
</para>
 
199
 
 
200
@format_version: 
 
201
@method_infos: 
 
202
@n_method_infos: 
 
203
@data: 
 
204
@exported_signals: 
 
205
@exported_properties: 
 
206
 
 
207
<!-- ##### TYPEDEF DBusGObjectPath ##### -->
 
208
<para>
 
209
 
 
210
</para>
 
211
 
 
212
 
 
213
<!-- ##### STRUCT DBusGProxy ##### -->
 
214
<para>
 
215
 
 
216
</para>
 
217
 
 
218
 
 
219
<!-- ##### SIGNAL DBusGProxy::destroy ##### -->
 
220
<para>
 
221
 
 
222
</para>
 
223
 
 
224
@dbusgproxy: the object which received the signal.
 
225
 
 
226
<!-- ##### SIGNAL DBusGProxy::received ##### -->
 
227
<para>
 
228
 
 
229
</para>
 
230
 
 
231
@dbusgproxy: the object which received the signal.
 
232
@arg1: 
 
233
@arg2: 
 
234
 
 
235
<!-- ##### ARG DBusGProxy:connection ##### -->
 
236
<para>
 
237
 
 
238
</para>
 
239
 
 
240
<!-- ##### ARG DBusGProxy:interface ##### -->
 
241
<para>
 
242
 
 
243
</para>
 
244
 
 
245
<!-- ##### ARG DBusGProxy:name ##### -->
 
246
<para>
 
247
 
 
248
</para>
 
249
 
 
250
<!-- ##### ARG DBusGProxy:path ##### -->
 
251
<para>
 
252
 
 
253
</para>
 
254
 
 
255
<!-- ##### STRUCT DBusGProxyCall ##### -->
 
256
<para>
 
257
 
 
258
</para>
 
259
 
 
260
 
 
261
<!-- ##### USER_FUNCTION DBusGProxyCallNotify ##### -->
 
262
<para>
 
263
 
 
264
</para>
 
265
 
 
266
@proxy: 
 
267
@call_id: 
 
268
@user_data: 
 
269
 
 
270
 
 
271
<!-- ##### STRUCT DBusGProxyClass ##### -->
 
272
<para>
 
273
 
 
274
</para>
 
275
 
 
276
 
 
277
<!-- ##### TYPEDEF DBusGSignature ##### -->
 
278
<para>
 
279
 
 
280
</para>
 
281
 
 
282
 
 
283
<!-- ##### FUNCTION dbus_g_bus_get ##### -->
 
284
<para>
 
285
 
 
286
</para>
 
287
 
 
288
@type: 
 
289
@error: 
 
290
@Returns: 
 
291
 
 
292
 
 
293
<!-- ##### FUNCTION dbus_g_bus_get_private ##### -->
 
294
<para>
 
295
 
 
296
</para>
 
297
 
 
298
@type: 
 
299
@context: 
 
300
@error: 
 
301
@Returns: 
 
302
 
 
303
 
 
304
<!-- ##### FUNCTION dbus_g_connection_flush ##### -->
 
305
<para>
 
306
 
 
307
</para>
 
308
 
 
309
@connection: 
 
310
 
 
311
 
 
312
<!-- ##### FUNCTION dbus_g_connection_get_g_type ##### -->
 
313
<para>
 
314
 
 
315
</para>
 
316
 
 
317
@void: 
 
318
@Returns: 
 
319
 
 
320
 
 
321
<!-- ##### FUNCTION dbus_g_connection_lookup_g_object ##### -->
 
322
<para>
 
323
 
 
324
</para>
 
325
 
 
326
@connection: 
 
327
@at_path: 
 
328
@Returns: 
 
329
 
 
330
 
 
331
<!-- ##### FUNCTION dbus_g_connection_open ##### -->
 
332
<para>
 
333
 
 
334
</para>
 
335
 
 
336
@address: 
 
337
@error: 
 
338
@Returns: 
 
339
 
 
340
 
 
341
<!-- ##### FUNCTION dbus_g_connection_ref ##### -->
 
342
<para>
 
343
 
 
344
</para>
 
345
 
 
346
@connection: 
 
347
@Returns: 
 
348
 
 
349
 
 
350
<!-- ##### FUNCTION dbus_g_connection_register_g_object ##### -->
 
351
<para>
 
352
 
 
353
</para>
 
354
 
 
355
@connection: 
 
356
@at_path: 
 
357
@object: 
 
358
 
 
359
 
 
360
<!-- ##### FUNCTION dbus_g_connection_unref ##### -->
 
361
<para>
 
362
 
 
363
</para>
 
364
 
 
365
@connection: 
 
366
 
 
367
 
 
368
<!-- ##### FUNCTION dbus_g_connection_unregister_g_object ##### -->
 
369
<para>
 
370
 
 
371
</para>
 
372
 
 
373
@connection: 
 
374
@object: 
 
375
 
 
376
 
 
377
<!-- ##### FUNCTION dbus_g_error_domain_register ##### -->
 
378
<para>
 
379
 
 
380
</para>
 
381
 
 
382
@domain: 
 
383
@default_iface: 
 
384
@code_enum: 
 
385
 
 
386
 
 
387
<!-- ##### FUNCTION dbus_g_error_get_name ##### -->
 
388
<para>
 
389
 
 
390
</para>
 
391
 
 
392
@error: 
 
393
@Returns: 
 
394
 
 
395
 
 
396
<!-- ##### FUNCTION dbus_g_error_has_name ##### -->
 
397
<para>
 
398
 
 
399
</para>
 
400
 
 
401
@error: 
 
402
@name: 
 
403
@Returns: 
 
404
 
 
405
 
 
406
<!-- ##### FUNCTION dbus_g_error_quark ##### -->
 
407
<para>
 
408
 
 
409
</para>
 
410
 
 
411
@void: 
 
412
@Returns: 
 
413
 
 
414
 
 
415
<!-- ##### FUNCTION dbus_g_message_get_g_type ##### -->
 
416
<para>
 
417
 
 
418
</para>
 
419
 
 
420
@void: 
 
421
@Returns: 
 
422
 
 
423
 
 
424
<!-- ##### FUNCTION dbus_g_message_ref ##### -->
 
425
<para>
 
426
 
 
427
</para>
 
428
 
 
429
@message: 
 
430
@Returns: 
 
431
 
 
432
 
 
433
<!-- ##### FUNCTION dbus_g_message_unref ##### -->
 
434
<para>
 
435
 
 
436
</para>
 
437
 
 
438
@message: 
 
439
 
 
440
 
 
441
<!-- ##### FUNCTION dbus_g_method_return ##### -->
 
442
<para>
 
443
 
 
444
</para>
 
445
 
 
446
@context: 
 
447
@...: 
 
448
 
 
449
 
 
450
<!-- ##### FUNCTION dbus_g_method_return_error ##### -->
 
451
<para>
 
452
 
 
453
</para>
 
454
 
 
455
@context: 
 
456
@error: 
 
457
 
 
458
 
 
459
<!-- ##### FUNCTION dbus_g_object_path_get_g_type ##### -->
 
460
<para>
 
461
 
 
462
</para>
 
463
 
 
464
@void: 
 
465
@Returns: 
 
466
 
 
467
 
 
468
<!-- ##### FUNCTION dbus_g_object_register_marshaller ##### -->
 
469
<para>
 
470
 
 
471
</para>
 
472
 
 
473
@marshaller: 
 
474
@rettype: 
 
475
@...: 
 
476
 
 
477
 
 
478
<!-- ##### FUNCTION dbus_g_object_register_marshaller_array ##### -->
 
479
<para>
 
480
 
 
481
</para>
 
482
 
 
483
@marshaller: 
 
484
@rettype: 
 
485
@n_types: 
 
486
@types: 
 
487
 
 
488
 
 
489
<!-- ##### FUNCTION dbus_g_object_type_install_info ##### -->
 
490
<para>
 
491
 
 
492
</para>
 
493
 
 
494
@object_type: 
 
495
@info: 
 
496
 
 
497
 
 
498
<!-- ##### FUNCTION dbus_g_object_type_register_shadow_property ##### -->
 
499
<para>
 
500
 
 
501
</para>
 
502
 
 
503
@iface_type: 
 
504
@dbus_prop_name: 
 
505
@shadow_prop_name: 
 
506
 
 
507
 
 
508
<!-- ##### FUNCTION dbus_g_proxy_add_signal ##### -->
 
509
<para>
 
510
 
 
511
</para>
 
512
 
 
513
@proxy: 
 
514
@signal_name: 
 
515
@first_type: 
 
516
@...: 
 
517
 
 
518
 
 
519
<!-- ##### FUNCTION dbus_g_proxy_begin_call ##### -->
 
520
<para>
 
521
 
 
522
</para>
 
523
 
 
524
@proxy: 
 
525
@method: 
 
526
@notify: 
 
527
@user_data: 
 
528
@destroy: 
 
529
@first_arg_type: 
 
530
@...: 
 
531
@Returns: 
 
532
 
 
533
 
 
534
<!-- ##### FUNCTION dbus_g_proxy_begin_call_with_timeout ##### -->
 
535
<para>
 
536
 
 
537
</para>
 
538
 
 
539
@proxy: 
 
540
@method: 
 
541
@notify: 
 
542
@user_data: 
 
543
@destroy: 
 
544
@timeout: 
 
545
@first_arg_type: 
 
546
@...: 
 
547
@Returns: 
 
548
 
 
549
 
 
550
<!-- ##### FUNCTION dbus_g_proxy_call ##### -->
 
551
<para>
 
552
 
 
553
</para>
 
554
 
 
555
@proxy: 
 
556
@method: 
 
557
@error: 
 
558
@first_arg_type: 
 
559
@...: 
 
560
@Returns: 
 
561
 
 
562
 
 
563
<!-- ##### FUNCTION dbus_g_proxy_call_no_reply ##### -->
 
564
<para>
 
565
 
 
566
</para>
 
567
 
 
568
@proxy: 
 
569
@method: 
 
570
@first_arg_type: 
 
571
@...: 
 
572
 
 
573
 
 
574
<!-- ##### FUNCTION dbus_g_proxy_call_with_timeout ##### -->
 
575
<para>
 
576
 
 
577
</para>
 
578
 
 
579
@proxy: 
 
580
@method: 
 
581
@timeout: 
 
582
@error: 
 
583
@first_arg_type: 
 
584
@...: 
 
585
@Returns: 
 
586
 
 
587
 
 
588
<!-- ##### FUNCTION dbus_g_proxy_cancel_call ##### -->
 
589
<para>
 
590
 
 
591
</para>
 
592
 
 
593
@proxy: 
 
594
@call: 
 
595
 
 
596
 
 
597
<!-- ##### FUNCTION dbus_g_proxy_connect_signal ##### -->
 
598
<para>
 
599
 
 
600
</para>
 
601
 
 
602
@proxy: 
 
603
@signal_name: 
 
604
@handler: 
 
605
@data: 
 
606
@free_data_func: 
 
607
 
 
608
 
 
609
<!-- ##### FUNCTION dbus_g_proxy_disconnect_signal ##### -->
 
610
<para>
 
611
 
 
612
</para>
 
613
 
 
614
@proxy: 
 
615
@signal_name: 
 
616
@handler: 
 
617
@data: 
 
618
 
 
619
 
 
620
<!-- ##### FUNCTION dbus_g_proxy_end_call ##### -->
 
621
<para>
 
622
 
 
623
</para>
 
624
 
 
625
@proxy: 
 
626
@call: 
 
627
@error: 
 
628
@first_arg_type: 
 
629
@...: 
 
630
@Returns: 
 
631
 
 
632
 
 
633
<!-- ##### FUNCTION dbus_g_proxy_get_bus_name ##### -->
 
634
<para>
 
635
 
 
636
</para>
 
637
 
 
638
@proxy: 
 
639
@Returns: 
 
640
 
 
641
 
 
642
<!-- ##### FUNCTION dbus_g_proxy_get_interface ##### -->
 
643
<para>
 
644
 
 
645
</para>
 
646
 
 
647
@proxy: 
 
648
@Returns: 
 
649
 
 
650
 
 
651
<!-- ##### FUNCTION dbus_g_proxy_get_path ##### -->
 
652
<para>
 
653
 
 
654
</para>
 
655
 
 
656
@proxy: 
 
657
@Returns: 
 
658
 
 
659
 
 
660
<!-- ##### FUNCTION dbus_g_proxy_new_for_name ##### -->
 
661
<para>
 
662
 
 
663
</para>
 
664
 
 
665
@connection: 
 
666
@name: 
 
667
@path: 
 
668
@iface: 
 
669
@Returns: 
 
670
 
 
671
 
 
672
<!-- ##### FUNCTION dbus_g_proxy_new_for_name_owner ##### -->
 
673
<para>
 
674
 
 
675
</para>
 
676
 
 
677
@connection: 
 
678
@name: 
 
679
@path: 
 
680
@iface: 
 
681
@error: 
 
682
@Returns: 
 
683
 
 
684
 
 
685
<!-- ##### FUNCTION dbus_g_proxy_new_for_peer ##### -->
 
686
<para>
 
687
 
 
688
</para>
 
689
 
 
690
@connection: 
 
691
@path: 
 
692
@iface: 
 
693
@Returns: 
 
694
 
 
695
 
 
696
<!-- ##### FUNCTION dbus_g_proxy_new_from_proxy ##### -->
 
697
<para>
 
698
 
 
699
</para>
 
700
 
 
701
@proxy: 
 
702
@iface: 
 
703
@path: 
 
704
@Returns: 
 
705
 
 
706
 
 
707
<!-- ##### FUNCTION dbus_g_proxy_set_default_timeout ##### -->
 
708
<para>
 
709
 
 
710
</para>
 
711
 
 
712
@proxy: 
 
713
@timeout: 
 
714
 
 
715
 
 
716
<!-- ##### FUNCTION dbus_g_proxy_set_interface ##### -->
 
717
<para>
 
718
 
 
719
</para>
 
720
 
 
721
@proxy: 
 
722
@interface_name: 
 
723
 
 
724
 
 
725
<!-- ##### FUNCTION dbus_g_signature_get_g_type ##### -->
 
726
<para>
 
727
 
 
728
</para>
 
729
 
 
730
@void: 
 
731
@Returns: 
 
732
 
 
733
 
 
734
<!-- ##### FUNCTION dbus_g_thread_init ##### -->
 
735
<para>
 
736
 
 
737
</para>
 
738
 
 
739
@void: 
 
740
 
 
741
 
 
742
<!-- ##### FUNCTION dbus_glib_global_set_disable_legacy_property_access ##### -->
 
743
<para>
 
744
 
 
745
</para>
 
746
 
 
747
@void: 
 
748
 
 
749