d5998e362bdab08b08f496add2cda502d513e6ec
[platform/upstream/dbus-glib.git] / doc / reference / tmpl / dbus-gtype-specialized.sgml
1 <!-- ##### SECTION Title ##### -->
2 Specializable GType System
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 <!-- ##### USER_FUNCTION DBusGTypeSpecializedCollectionIterator ##### -->
26 <para>
27
28 </para>
29
30 @value: 
31 @user_data: 
32
33
34 <!-- ##### USER_FUNCTION DBusGTypeSpecializedMapIterator ##### -->
35 <para>
36
37 </para>
38
39 @key_val: 
40 @value_val: 
41 @user_data: 
42
43
44 <!-- ##### STRUCT DBusGTypeSpecializedAppendContext ##### -->
45 <para>
46
47 </para>
48
49 @val: 
50 @specialization_type: 
51
52 <!-- ##### USER_FUNCTION DBusGTypeSpecializedConstructor ##### -->
53 <para>
54
55 </para>
56
57 @type: 
58 @Returns: 
59
60
61 <!-- ##### USER_FUNCTION DBusGTypeSpecializedFreeFunc ##### -->
62 <para>
63
64 </para>
65
66 @type: 
67 @val: 
68
69
70 <!-- ##### USER_FUNCTION DBusGTypeSpecializedCopyFunc ##### -->
71 <para>
72
73 </para>
74
75 @type: 
76 @src: 
77 @Returns: 
78
79
80 <!-- ##### STRUCT DBusGTypeSpecializedVtable ##### -->
81 <para>
82
83 </para>
84
85 @constructor: 
86 @free_func: 
87 @copy_func: 
88 @simple_free_func: 
89
90 <!-- ##### USER_FUNCTION DBusGTypeSpecializedCollectionFixedAccessorFunc ##### -->
91 <para>
92
93 </para>
94
95 @type: 
96 @instance: 
97 @values: 
98 @len: 
99 @Returns: 
100
101
102 <!-- ##### USER_FUNCTION DBusGTypeSpecializedCollectionIteratorFunc ##### -->
103 <para>
104
105 </para>
106
107 @type: 
108 @instance: 
109 @iterator: 
110 @user_data: 
111
112
113 <!-- ##### USER_FUNCTION DBusGTypeSpecializedCollectionAppendFunc ##### -->
114 <para>
115
116 </para>
117
118 @ctx: 
119 @val: 
120
121
122 <!-- ##### USER_FUNCTION DBusGTypeSpecializedCollectionEndAppendFunc ##### -->
123 <para>
124
125 </para>
126
127 @ctx: 
128
129
130 <!-- ##### STRUCT DBusGTypeSpecializedCollectionVtable ##### -->
131 <para>
132
133 </para>
134
135 @base_vtable: 
136 @fixed_accessor: 
137 @iterator: 
138 @append_func: 
139 @end_append_func: 
140
141 <!-- ##### USER_FUNCTION DBusGTypeSpecializedMapIteratorFunc ##### -->
142 <para>
143
144 </para>
145
146 @type: 
147 @instance: 
148 @iterator: 
149 @user_data: 
150
151
152 <!-- ##### USER_FUNCTION DBusGTypeSpecializedMapAppendFunc ##### -->
153 <para>
154
155 </para>
156
157 @ctx: 
158 @key: 
159 @val: 
160
161
162 <!-- ##### STRUCT DBusGTypeSpecializedMapVtable ##### -->
163 <para>
164
165 </para>
166
167 @base_vtable: 
168 @iterator: 
169 @append_func: 
170
171 <!-- ##### USER_FUNCTION DBusGTypeSpecializedStructGetMember ##### -->
172 <para>
173
174 </para>
175
176 @type: 
177 @instance: 
178 @member: 
179 @ret_value: 
180 @Returns: 
181
182
183 <!-- ##### USER_FUNCTION DBusGTypeSpecializedStructSetMember ##### -->
184 <para>
185
186 </para>
187
188 @type: 
189 @instance: 
190 @member: 
191 @new_value: 
192 @Returns: 
193
194
195 <!-- ##### STRUCT DBusGTypeSpecializedStructVtable ##### -->
196 <para>
197
198 </para>
199
200 @base_vtable: 
201 @get_member: 
202 @set_member: 
203
204 <!-- ##### FUNCTION dbus_g_type_get_collection ##### -->
205 <para>
206
207 </para>
208
209 @container: 
210 @specialization: 
211 @Returns: 
212
213
214 <!-- ##### FUNCTION dbus_g_type_get_map ##### -->
215 <para>
216
217 </para>
218
219 @container: 
220 @key_specialization: 
221 @value_specialization: 
222 @Returns: 
223
224
225 <!-- ##### FUNCTION dbus_g_type_get_structv ##### -->
226 <para>
227
228 </para>
229
230 @container: 
231 @num_members: 
232 @types: 
233 @Returns: 
234
235
236 <!-- ##### FUNCTION dbus_g_type_get_struct ##### -->
237 <para>
238
239 </para>
240
241 @container: 
242 @first_type: 
243 @...: 
244 @Returns: 
245
246
247 <!-- ##### FUNCTION dbus_g_type_is_collection ##### -->
248 <para>
249
250 </para>
251
252 @gtype: 
253 @Returns: 
254
255
256 <!-- ##### FUNCTION dbus_g_type_is_map ##### -->
257 <para>
258
259 </para>
260
261 @gtype: 
262 @Returns: 
263
264
265 <!-- ##### FUNCTION dbus_g_type_is_struct ##### -->
266 <para>
267
268 </para>
269
270 @gtype: 
271 @Returns: 
272
273
274 <!-- ##### FUNCTION dbus_g_type_get_collection_specialization ##### -->
275 <para>
276
277 </para>
278
279 @gtype: 
280 @Returns: 
281
282
283 <!-- ##### FUNCTION dbus_g_type_get_map_key_specialization ##### -->
284 <para>
285
286 </para>
287
288 @gtype: 
289 @Returns: 
290
291
292 <!-- ##### FUNCTION dbus_g_type_get_map_value_specialization ##### -->
293 <para>
294
295 </para>
296
297 @gtype: 
298 @Returns: 
299
300
301 <!-- ##### FUNCTION dbus_g_type_get_struct_member_type ##### -->
302 <para>
303
304 </para>
305
306 @gtype: 
307 @member: 
308 @Returns: 
309
310
311 <!-- ##### FUNCTION dbus_g_type_get_struct_size ##### -->
312 <para>
313
314 </para>
315
316 @gtype: 
317 @Returns: 
318
319
320 <!-- ##### FUNCTION dbus_g_type_specialized_construct ##### -->
321 <para>
322
323 </para>
324
325 @gtype: 
326 @Returns: 
327
328
329 <!-- ##### FUNCTION dbus_g_type_specialized_init_append ##### -->
330 <para>
331
332 </para>
333
334 @value: 
335 @ctx: 
336
337
338 <!-- ##### FUNCTION dbus_g_type_specialized_collection_append ##### -->
339 <para>
340
341 </para>
342
343 @ctx: 
344 @elt: 
345
346
347 <!-- ##### FUNCTION dbus_g_type_specialized_collection_end_append ##### -->
348 <para>
349
350 </para>
351
352 @ctx: 
353
354
355 <!-- ##### FUNCTION dbus_g_type_specialized_map_append ##### -->
356 <para>
357
358 </para>
359
360 @ctx: 
361 @key: 
362 @val: 
363
364
365 <!-- ##### FUNCTION dbus_g_type_collection_get_fixed ##### -->
366 <para>
367
368 </para>
369
370 @value: 
371 @data_ret: 
372 @len_ret: 
373 @Returns: 
374
375
376 <!-- ##### FUNCTION dbus_g_type_collection_value_iterate ##### -->
377 <para>
378
379 </para>
380
381 @value: 
382 @iterator: 
383 @user_data: 
384
385
386 <!-- ##### FUNCTION dbus_g_type_map_value_iterate ##### -->
387 <para>
388
389 </para>
390
391 @value: 
392 @iterator: 
393 @user_data: 
394
395
396 <!-- ##### FUNCTION dbus_g_type_struct_get_member ##### -->
397 <para>
398
399 </para>
400
401 @value: 
402 @member: 
403 @dest: 
404 @Returns: 
405
406
407 <!-- ##### FUNCTION dbus_g_type_struct_set_member ##### -->
408 <para>
409
410 </para>
411
412 @value: 
413 @member: 
414 @src: 
415 @Returns: 
416
417
418 <!-- ##### FUNCTION dbus_g_type_struct_get ##### -->
419 <para>
420
421 </para>
422
423 @value: 
424 @member: 
425 @...: 
426 @Returns: 
427
428
429 <!-- ##### FUNCTION dbus_g_type_struct_set ##### -->
430 <para>
431
432 </para>
433
434 @value: 
435 @member: 
436 @...: 
437 @Returns: 
438
439
440 <!-- ##### FUNCTION dbus_g_type_specialized_init ##### -->
441 <para>
442
443 </para>
444
445 @void: 
446
447
448 <!-- ##### FUNCTION dbus_g_type_register_collection ##### -->
449 <para>
450
451 </para>
452
453 @name: 
454 @vtable: 
455 @flags: 
456
457
458 <!-- ##### FUNCTION dbus_g_type_register_map ##### -->
459 <para>
460
461 </para>
462
463 @name: 
464 @vtable: 
465 @flags: 
466
467
468 <!-- ##### FUNCTION dbus_g_type_map_peek_vtable ##### -->
469 <para>
470
471 </para>
472
473 @map_type: 
474 @Returns: 
475
476
477 <!-- ##### FUNCTION dbus_g_type_collection_peek_vtable ##### -->
478 <para>
479
480 </para>
481
482 @collection_type: 
483 @Returns: 
484
485
486 <!-- ##### FUNCTION dbus_g_type_struct_peek_vtable ##### -->
487 <para>
488
489 </para>
490
491 @struct_type: 
492 @Returns: 
493
494
495 <!-- ##### FUNCTION dbus_g_type_register_struct ##### -->
496 <para>
497
498 </para>
499
500 @name: 
501 @vtable: 
502 @flags: 
503
504
505 <!-- ##### FUNCTION dbus_g_value_build_g_variant ##### -->
506 <para>
507
508 </para>
509
510 @value: 
511 @Returns: 
512
513
514 <!-- ##### FUNCTION dbus_g_value_parse_g_variant ##### -->
515 <para>
516
517 </para>
518
519 @variant: 
520 @value: 
521
522
523 <!-- ##### MACRO DBUS_TYPE_G_BOOLEAN_ARRAY ##### -->
524 <para>
525
526 </para>
527
528
529
530 <!-- ##### MACRO DBUS_TYPE_G_UCHAR_ARRAY ##### -->
531 <para>
532
533 </para>
534
535
536
537 <!-- ##### MACRO DBUS_TYPE_G_UINT_ARRAY ##### -->
538 <para>
539
540 </para>
541
542
543
544 <!-- ##### MACRO DBUS_TYPE_G_INT_ARRAY ##### -->
545 <para>
546
547 </para>
548
549
550
551 <!-- ##### MACRO DBUS_TYPE_G_UINT64_ARRAY ##### -->
552 <para>
553
554 </para>
555
556
557
558 <!-- ##### MACRO DBUS_TYPE_G_INT64_ARRAY ##### -->
559 <para>
560
561 </para>
562
563
564
565 <!-- ##### MACRO DBUS_TYPE_G_OBJECT_ARRAY ##### -->
566 <para>
567
568 </para>
569
570
571
572 <!-- ##### MACRO DBUS_TYPE_G_STRING_STRING_HASHTABLE ##### -->
573 <para>
574
575 </para>
576
577
578
579 <!-- ##### TYPEDEF DBusGSignature ##### -->
580 <para>
581
582 </para>
583
584
585 <!-- ##### MACRO DBUS_TYPE_G_SIGNATURE ##### -->
586 <para>
587
588 </para>
589
590
591
592 <!-- ##### TYPEDEF DBusGObjectPath ##### -->
593 <para>
594
595 </para>
596
597
598 <!-- ##### MACRO DBUS_TYPE_G_OBJECT_PATH ##### -->
599 <para>
600
601 </para>
602
603
604