-
-
Notifications
You must be signed in to change notification settings - Fork 46
/
GObject-2.0.gir
19370 lines (18705 loc) · 931 KB
/
GObject-2.0.gir
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository xmlns="http://www.gtk.org/introspection/core/1.0" xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0" version="1.2">
<include name="GLib" version="2.0"/>
<package name="gobject-2.0"/>
<c:include name="glib-object.h"/>
<namespace name="GObject" version="2.0" shared-library="libgobject-2.0.so.0" c:identifier-prefixes="G" c:symbol-prefixes="gobject,g">
<alias name="SignalCMarshaller" c:type="GSignalCMarshaller">
<doc xml:space="preserve">This is the signature of marshaller functions, required to marshall
arrays of parameter values to signal emissions into C language callback
invocations.
It is merely an alias to #GClosureMarshal since the #GClosure mechanism
takes over responsibility of actual function invocation for the signal
system.</doc>
<type name="ClosureMarshal" c:type="GClosureMarshal"/>
</alias>
<alias name="SignalCVaMarshaller" c:type="GSignalCVaMarshaller">
<doc xml:space="preserve">This is the signature of va_list marshaller functions, an optional
marshaller that can be used in some situations to avoid
marshalling the signal argument into GValues.</doc>
<type name="VaClosureMarshal" c:type="GVaClosureMarshal"/>
</alias>
<alias name="Type" c:type="GType">
<doc xml:space="preserve">A numerical value which represents the unique identifier of a registered
type.</doc>
<type name="gsize" c:type="gsize"/>
</alias>
<function-macro name="ADD_PRIVATE" c:identifier="G_ADD_PRIVATE" version="2.38" introspectable="0">
<doc xml:space="preserve">A convenience macro to ease adding private data to instances of a new type
in the @_C_ section of G_DEFINE_TYPE_WITH_CODE() or
G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
For instance:
|[<!-- language="C" -->
typedef struct _MyObject MyObject;
typedef struct _MyObjectClass MyObjectClass;
typedef struct {
gint foo;
gint bar;
} MyObjectPrivate;
G_DEFINE_TYPE_WITH_CODE (MyObject, my_object, G_TYPE_OBJECT,
G_ADD_PRIVATE (MyObject))
]|
Will add `MyObjectPrivate` as the private data to any instance of the
`MyObject` type.
`G_DEFINE_TYPE_*` macros will automatically create a private function
based on the arguments to this macro, which can be used to safely
retrieve the private data from an instance of the type; for instance:
|[<!-- language="C" -->
gint
my_object_get_foo (MyObject *obj)
{
MyObjectPrivate *priv = my_object_get_instance_private (obj);
g_return_val_if_fail (MY_IS_OBJECT (obj), 0);
return priv->foo;
}
void
my_object_set_bar (MyObject *obj,
gint bar)
{
MyObjectPrivate *priv = my_object_get_instance_private (obj);
g_return_if_fail (MY_IS_OBJECT (obj));
if (priv->bar != bar)
priv->bar = bar;
}
]|
Since GLib 2.72, the returned `MyObjectPrivate` pointer is guaranteed to be
aligned to at least the alignment of the largest basic GLib type (typically
this is #guint64 or #gdouble). If you need larger alignment for an element in
the struct, you should allocate it on the heap (aligned), or arrange for your
`MyObjectPrivate` struct to be appropriately padded.
Note that this macro can only be used together with the `G_DEFINE_TYPE_*`
macros, since it depends on variable names from those macros.
Also note that private structs added with these macros must have a struct
name of the form `TypeNamePrivate`.
It is safe to call the `_get_instance_private` function on %NULL or invalid
objects since it's only adding an offset to the instance pointer. In that
case the returned pointer must not be dereferenced.</doc>
<parameters>
<parameter name="TypeName">
<doc xml:space="preserve">the name of the type in CamelCase</doc>
</parameter>
</parameters>
</function-macro>
<function-macro name="ADD_PRIVATE_DYNAMIC" c:identifier="G_ADD_PRIVATE_DYNAMIC" version="2.38" introspectable="0">
<doc xml:space="preserve">A convenience macro to ease adding private data to instances of a new dynamic
type in the @_C_ section of G_DEFINE_DYNAMIC_TYPE_EXTENDED().
See G_ADD_PRIVATE() for details, it is similar but for static types.
Note that this macro can only be used together with the
G_DEFINE_DYNAMIC_TYPE_EXTENDED macros, since it depends on variable
names from that macro.</doc>
<parameters>
<parameter name="TypeName">
<doc xml:space="preserve">the name of the type in CamelCase</doc>
</parameter>
</parameters>
</function-macro>
<glib:boxed glib:name="Array" c:symbol-prefix="array" glib:type-name="GArray" glib:get-type="g_array_get_type">
</glib:boxed>
<function-macro name="BINDING" c:identifier="G_BINDING" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="BINDING_GROUP" c:identifier="G_BINDING_GROUP" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<callback name="BaseFinalizeFunc" c:type="GBaseFinalizeFunc">
<doc xml:space="preserve">A callback function used by the type system to finalize those portions
of a derived types class structure that were setup from the corresponding
GBaseInitFunc() function.
Class finalization basically works the inverse way in which class
initialization is performed.
See GClassInitFunc() for a discussion of the class initialization process.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="g_class" transfer-ownership="none">
<doc xml:space="preserve">The #GTypeClass structure to finalize</doc>
<type name="TypeClass" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<callback name="BaseInitFunc" c:type="GBaseInitFunc">
<doc xml:space="preserve">A callback function used by the type system to do base initialization
of the class structures of derived types.
This function is called as part of the initialization process of all derived
classes and should reallocate or reset all dynamic class members copied over
from the parent class.
For example, class members (such as strings) that are not sufficiently
handled by a plain memory copy of the parent class into the derived class
have to be altered. See GClassInitFunc() for a discussion of the class
initialization process.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="g_class" transfer-ownership="none">
<doc xml:space="preserve">The #GTypeClass structure to initialize</doc>
<type name="TypeClass" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<class name="Binding" c:symbol-prefix="binding" c:type="GBinding" version="2.26" parent="Object" glib:type-name="GBinding" glib:get-type="g_binding_get_type">
<doc xml:space="preserve">`GObject` instance (or source) and another property on another `GObject`
instance (or target).
Whenever the source property changes, the same value is applied to the
target property; for instance, the following binding:
```c
g_object_bind_property (object1, "property-a",
object2, "property-b",
G_BINDING_DEFAULT);
```
will cause the property named "property-b" of @object2 to be updated
every time [[email protected]] or the specific accessor changes the value of
the property "property-a" of @object1.
It is possible to create a bidirectional binding between two properties
of two `GObject` instances, so that if either property changes, the
other is updated as well, for instance:
```c
g_object_bind_property (object1, "property-a",
object2, "property-b",
G_BINDING_BIDIRECTIONAL);
```
will keep the two properties in sync.
It is also possible to set a custom transformation function (in both
directions, in case of a bidirectional binding) to apply a custom
transformation from the source value to the target value before
applying it; for instance, the following binding:
```c
g_object_bind_property_full (adjustment1, "value",
adjustment2, "value",
G_BINDING_BIDIRECTIONAL,
celsius_to_fahrenheit,
fahrenheit_to_celsius,
NULL, NULL);
```
will keep the "value" property of the two adjustments in sync; the
@celsius_to_fahrenheit function will be called whenever the "value"
property of @adjustment1 changes and will transform the current value
of the property before applying it to the "value" property of @adjustment2.
Vice versa, the @fahrenheit_to_celsius function will be called whenever
the "value" property of @adjustment2 changes, and will transform the
current value of the property before applying it to the "value" property
of @adjustment1.
Note that #GBinding does not resolve cycles by itself; a cycle like
```
object1:propertyA -> object2:propertyB
object2:propertyB -> object3:propertyC
object3:propertyC -> object1:propertyA
```
might lead to an infinite loop. The loop, in this particular case,
can be avoided if the objects emit the `GObject::notify` signal only
if the value has effectively been changed. A binding is implemented
using the `GObject::notify` signal, so it is susceptible to all the
various ways of blocking a signal emission, like [[email protected]_stop_emission]
or [[email protected]_handler_block].
A binding will be severed, and the resources it allocates freed, whenever
either one of the `GObject` instances it refers to are finalized, or when
the #GBinding instance loses its last reference.
Bindings for languages with garbage collection can use
[[email protected]] to explicitly release a binding between the source
and target properties, instead of relying on the last reference on the
binding, source, and target instances to drop.</doc>
<method name="dup_source" c:identifier="g_binding_dup_source" version="2.68">
<doc xml:space="preserve">Retrieves the #GObject instance used as the source of the binding.
A #GBinding can outlive the source #GObject as the binding does not hold a
strong reference to the source. If the source is destroyed before the
binding then this function will return %NULL.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the source #GObject, or %NULL if the
source does not exist any more.</doc>
<type name="Object" c:type="GObject*"/>
</return-value>
<parameters>
<instance-parameter name="binding" transfer-ownership="none">
<doc xml:space="preserve">a #GBinding</doc>
<type name="Binding" c:type="GBinding*"/>
</instance-parameter>
</parameters>
</method>
<method name="dup_target" c:identifier="g_binding_dup_target" version="2.68">
<doc xml:space="preserve">Retrieves the #GObject instance used as the target of the binding.
A #GBinding can outlive the target #GObject as the binding does not hold a
strong reference to the target. If the target is destroyed before the
binding then this function will return %NULL.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the target #GObject, or %NULL if the
target does not exist any more.</doc>
<type name="Object" c:type="GObject*"/>
</return-value>
<parameters>
<instance-parameter name="binding" transfer-ownership="none">
<doc xml:space="preserve">a #GBinding</doc>
<type name="Binding" c:type="GBinding*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_flags" c:identifier="g_binding_get_flags" glib:get-property="flags" version="2.26">
<doc xml:space="preserve">Retrieves the flags passed when constructing the #GBinding.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #GBindingFlags used by the #GBinding</doc>
<type name="BindingFlags" c:type="GBindingFlags"/>
</return-value>
<parameters>
<instance-parameter name="binding" transfer-ownership="none">
<doc xml:space="preserve">a #GBinding</doc>
<type name="Binding" c:type="GBinding*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_source" c:identifier="g_binding_get_source" glib:get-property="source" version="2.26" deprecated="1" deprecated-version="2.68">
<doc xml:space="preserve">Retrieves the #GObject instance used as the source of the binding.
A #GBinding can outlive the source #GObject as the binding does not hold a
strong reference to the source. If the source is destroyed before the
binding then this function will return %NULL.
Use g_binding_dup_source() if the source or binding are used from different
threads as otherwise the pointer returned from this function might become
invalid if the source is finalized from another thread in the meantime.</doc>
<doc-deprecated xml:space="preserve">Use g_binding_dup_source() for a safer version of this
function.</doc-deprecated>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the source #GObject, or %NULL if the
source does not exist any more.</doc>
<type name="Object" c:type="GObject*"/>
</return-value>
<parameters>
<instance-parameter name="binding" transfer-ownership="none">
<doc xml:space="preserve">a #GBinding</doc>
<type name="Binding" c:type="GBinding*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_source_property" c:identifier="g_binding_get_source_property" glib:get-property="source-property" version="2.26">
<doc xml:space="preserve">Retrieves the name of the property of #GBinding:source used as the source
of the binding.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the name of the source property</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="binding" transfer-ownership="none">
<doc xml:space="preserve">a #GBinding</doc>
<type name="Binding" c:type="GBinding*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_target" c:identifier="g_binding_get_target" glib:get-property="target" version="2.26" deprecated="1" deprecated-version="2.68">
<doc xml:space="preserve">Retrieves the #GObject instance used as the target of the binding.
A #GBinding can outlive the target #GObject as the binding does not hold a
strong reference to the target. If the target is destroyed before the
binding then this function will return %NULL.
Use g_binding_dup_target() if the target or binding are used from different
threads as otherwise the pointer returned from this function might become
invalid if the target is finalized from another thread in the meantime.</doc>
<doc-deprecated xml:space="preserve">Use g_binding_dup_target() for a safer version of this
function.</doc-deprecated>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the target #GObject, or %NULL if the
target does not exist any more.</doc>
<type name="Object" c:type="GObject*"/>
</return-value>
<parameters>
<instance-parameter name="binding" transfer-ownership="none">
<doc xml:space="preserve">a #GBinding</doc>
<type name="Binding" c:type="GBinding*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_target_property" c:identifier="g_binding_get_target_property" glib:get-property="target-property" version="2.26">
<doc xml:space="preserve">Retrieves the name of the property of #GBinding:target used as the target
of the binding.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the name of the target property</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="binding" transfer-ownership="none">
<doc xml:space="preserve">a #GBinding</doc>
<type name="Binding" c:type="GBinding*"/>
</instance-parameter>
</parameters>
</method>
<method name="unbind" c:identifier="g_binding_unbind" version="2.38">
<doc xml:space="preserve">Explicitly releases the binding between the source and the target
property expressed by @binding.
This function will release the reference that is being held on
the @binding instance if the binding is still bound; if you want to hold on
to the #GBinding instance after calling g_binding_unbind(), you will need
to hold a reference to it.
Note however that this function does not take ownership of @binding, it
only unrefs the reference that was initially created by
g_object_bind_property() and is owned by the binding.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="binding" transfer-ownership="none">
<doc xml:space="preserve">a #GBinding</doc>
<type name="Binding" c:type="GBinding*"/>
</instance-parameter>
</parameters>
</method>
<property name="flags" version="2.26" writable="1" construct-only="1" transfer-ownership="none" getter="get_flags" default-value="G_BINDING_DEFAULT">
<doc xml:space="preserve">Flags to be used to control the #GBinding</doc>
<type name="BindingFlags"/>
</property>
<property name="source" version="2.26" writable="1" construct-only="1" transfer-ownership="none" getter="get_source">
<doc xml:space="preserve">The #GObject that should be used as the source of the binding</doc>
<type name="Object"/>
</property>
<property name="source-property" version="2.26" writable="1" construct-only="1" transfer-ownership="none" getter="get_source_property" default-value="NULL">
<doc xml:space="preserve">The name of the property of #GBinding:source that should be used
as the source of the binding.
This should be in [canonical form][canonical-parameter-names] to get the
best performance.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="target" version="2.26" writable="1" construct-only="1" transfer-ownership="none" getter="get_target">
<doc xml:space="preserve">The #GObject that should be used as the target of the binding</doc>
<type name="Object"/>
</property>
<property name="target-property" version="2.26" writable="1" construct-only="1" transfer-ownership="none" getter="get_target_property" default-value="NULL">
<doc xml:space="preserve">The name of the property of #GBinding:target that should be used
as the target of the binding.
This should be in [canonical form][canonical-parameter-names] to get the
best performance.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
</class>
<bitfield name="BindingFlags" version="2.26" glib:type-name="GBindingFlags" glib:get-type="g_binding_flags_get_type" c:type="GBindingFlags">
<doc xml:space="preserve">Flags to be passed to g_object_bind_property() or
g_object_bind_property_full().
This enumeration can be extended at later date.</doc>
<member name="default" value="0" c:identifier="G_BINDING_DEFAULT" glib:nick="default" glib:name="G_BINDING_DEFAULT">
<doc xml:space="preserve">The default binding; if the source property
changes, the target property is updated with its value.</doc>
</member>
<member name="bidirectional" value="1" c:identifier="G_BINDING_BIDIRECTIONAL" glib:nick="bidirectional" glib:name="G_BINDING_BIDIRECTIONAL">
<doc xml:space="preserve">Bidirectional binding; if either the
property of the source or the property of the target changes,
the other is updated.</doc>
</member>
<member name="sync_create" value="2" c:identifier="G_BINDING_SYNC_CREATE" glib:nick="sync-create" glib:name="G_BINDING_SYNC_CREATE">
<doc xml:space="preserve">Synchronize the values of the source and
target properties when creating the binding; the direction of
the synchronization is always from the source to the target.</doc>
</member>
<member name="invert_boolean" value="4" c:identifier="G_BINDING_INVERT_BOOLEAN" glib:nick="invert-boolean" glib:name="G_BINDING_INVERT_BOOLEAN">
<doc xml:space="preserve">If the two properties being bound are
booleans, setting one to %TRUE will result in the other being
set to %FALSE and vice versa. This flag will only work for
boolean properties, and cannot be used when passing custom
transformation functions to g_object_bind_property_full().</doc>
</member>
</bitfield>
<class name="BindingGroup" c:symbol-prefix="binding_group" c:type="GBindingGroup" version="2.72" parent="Object" glib:type-name="GBindingGroup" glib:get-type="g_binding_group_get_type">
<doc xml:space="preserve">`GBindingGroup` can be used to bind multiple properties
from an object collectively.
Use the various methods to bind properties from a single source
object to multiple destination objects. Properties can be bound
bidirectionally and are connected when the source object is set
with [[email protected]_source].</doc>
<constructor name="new" c:identifier="g_binding_group_new" version="2.72">
<doc xml:space="preserve">Creates a new #GBindingGroup.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GBindingGroup</doc>
<type name="BindingGroup" c:type="GBindingGroup*"/>
</return-value>
</constructor>
<method name="bind" c:identifier="g_binding_group_bind" version="2.72">
<doc xml:space="preserve">Creates a binding between @source_property on the source object
and @target_property on @target. Whenever the @source_property
is changed the @target_property is updated using the same value.
The binding flag %G_BINDING_SYNC_CREATE is automatically specified.
See g_object_bind_property() for more information.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the #GBindingGroup</doc>
<type name="BindingGroup" c:type="GBindingGroup*"/>
</instance-parameter>
<parameter name="source_property" transfer-ownership="none">
<doc xml:space="preserve">the property on the source to bind</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="target" transfer-ownership="none">
<doc xml:space="preserve">the target #GObject</doc>
<type name="Object" c:type="gpointer"/>
</parameter>
<parameter name="target_property" transfer-ownership="none">
<doc xml:space="preserve">the property on @target to bind</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">the flags used to create the #GBinding</doc>
<type name="BindingFlags" c:type="GBindingFlags"/>
</parameter>
</parameters>
</method>
<method name="bind_full" c:identifier="g_binding_group_bind_full" shadowed-by="bind_with_closures" version="2.72">
<doc xml:space="preserve">Creates a binding between @source_property on the source object and
@target_property on @target, allowing you to set the transformation
functions to be used by the binding. The binding flag
%G_BINDING_SYNC_CREATE is automatically specified.
See g_object_bind_property_full() for more information.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the #GBindingGroup</doc>
<type name="BindingGroup" c:type="GBindingGroup*"/>
</instance-parameter>
<parameter name="source_property" transfer-ownership="none">
<doc xml:space="preserve">the property on the source to bind</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="target" transfer-ownership="none">
<doc xml:space="preserve">the target #GObject</doc>
<type name="Object" c:type="gpointer"/>
</parameter>
<parameter name="target_property" transfer-ownership="none">
<doc xml:space="preserve">the property on @target to bind</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">the flags used to create the #GBinding</doc>
<type name="BindingFlags" c:type="GBindingFlags"/>
</parameter>
<parameter name="transform_to" transfer-ownership="none" nullable="1" allow-none="1" scope="notified">
<doc xml:space="preserve">the transformation function
from the source object to the @target, or %NULL to use the default</doc>
<type name="BindingTransformFunc" c:type="GBindingTransformFunc"/>
</parameter>
<parameter name="transform_from" transfer-ownership="none" nullable="1" allow-none="1" scope="notified" closure="6" destroy="7">
<doc xml:space="preserve">the transformation function
from the @target to the source object, or %NULL to use the default</doc>
<type name="BindingTransformFunc" c:type="GBindingTransformFunc"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">custom data to be passed to the transformation
functions, or %NULL</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="user_data_destroy" transfer-ownership="none" scope="async">
<doc xml:space="preserve">function to be called when disposing the binding,
to free the resources used by the transformation functions</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="bind_with_closures" c:identifier="g_binding_group_bind_with_closures" shadows="bind_full" version="2.72">
<doc xml:space="preserve">Creates a binding between @source_property on the source object and
@target_property on @target, allowing you to set the transformation
functions to be used by the binding. The binding flag
%G_BINDING_SYNC_CREATE is automatically specified.
This function is the language bindings friendly version of
g_binding_group_bind_property_full(), using #GClosures
instead of function pointers.
See g_object_bind_property_with_closures() for more information.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the #GBindingGroup</doc>
<type name="BindingGroup" c:type="GBindingGroup*"/>
</instance-parameter>
<parameter name="source_property" transfer-ownership="none">
<doc xml:space="preserve">the property on the source to bind</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="target" transfer-ownership="none">
<doc xml:space="preserve">the target #GObject</doc>
<type name="Object" c:type="gpointer"/>
</parameter>
<parameter name="target_property" transfer-ownership="none">
<doc xml:space="preserve">the property on @target to bind</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">the flags used to create the #GBinding</doc>
<type name="BindingFlags" c:type="GBindingFlags"/>
</parameter>
<parameter name="transform_to" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">a #GClosure wrapping the
transformation function from the source object to the @target,
or %NULL to use the default</doc>
<type name="Closure" c:type="GClosure*"/>
</parameter>
<parameter name="transform_from" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">a #GClosure wrapping the
transformation function from the @target to the source object,
or %NULL to use the default</doc>
<type name="Closure" c:type="GClosure*"/>
</parameter>
</parameters>
</method>
<method name="dup_source" c:identifier="g_binding_group_dup_source" version="2.72">
<doc xml:space="preserve">Gets the source object used for binding properties.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a #GObject or %NULL.</doc>
<type name="Object" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the #GBindingGroup</doc>
<type name="BindingGroup" c:type="GBindingGroup*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_source" c:identifier="g_binding_group_set_source" glib:set-property="source" version="2.72">
<doc xml:space="preserve">Sets @source as the source object used for creating property
bindings. If there is already a source object all bindings from it
will be removed.
Note that all properties that have been bound must exist on @source.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the #GBindingGroup</doc>
<type name="BindingGroup" c:type="GBindingGroup*"/>
</instance-parameter>
<parameter name="source" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">the source #GObject,
or %NULL to clear it</doc>
<type name="Object" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<property name="source" version="2.72" writable="1" transfer-ownership="none" setter="set_source">
<doc xml:space="preserve">The source object used for binding properties.</doc>
<type name="Object"/>
</property>
</class>
<callback name="BindingTransformFunc" c:type="GBindingTransformFunc" version="2.26">
<doc xml:space="preserve">A function to be called to transform @from_value to @to_value.
If this is the @transform_to function of a binding, then @from_value
is the @source_property on the @source object, and @to_value is the
@target_property on the @target object. If this is the
@transform_from function of a %G_BINDING_BIDIRECTIONAL binding,
then those roles are reversed.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the transformation was successful, and %FALSE
otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="binding" transfer-ownership="none">
<doc xml:space="preserve">a #GBinding</doc>
<type name="Binding" c:type="GBinding*"/>
</parameter>
<parameter name="from_value" transfer-ownership="none">
<doc xml:space="preserve">the #GValue containing the value to transform</doc>
<type name="Value" c:type="const GValue*"/>
</parameter>
<parameter name="to_value" transfer-ownership="none">
<doc xml:space="preserve">the #GValue in which to store the transformed value</doc>
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" nullable="1" allow-none="1" closure="3">
<doc xml:space="preserve">data passed to the transform function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<glib:boxed glib:name="BookmarkFile" c:symbol-prefix="bookmark_file" glib:type-name="GBookmarkFile" glib:get-type="g_bookmark_file_get_type">
</glib:boxed>
<callback name="BoxedCopyFunc" c:type="GBoxedCopyFunc">
<doc xml:space="preserve">This function is provided by the user and should produce a copy
of the passed in boxed structure.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The newly created copy of the boxed structure.</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<parameter name="boxed" transfer-ownership="none">
<doc xml:space="preserve">The boxed structure to be copied.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<callback name="BoxedFreeFunc" c:type="GBoxedFreeFunc">
<doc xml:space="preserve">This function is provided by the user and should free the boxed
structure passed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="boxed" transfer-ownership="none">
<doc xml:space="preserve">The boxed structure to be freed.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<glib:boxed glib:name="ByteArray" c:symbol-prefix="byte_array" glib:type-name="GByteArray" glib:get-type="g_byte_array_get_type">
</glib:boxed>
<glib:boxed glib:name="Bytes" c:symbol-prefix="bytes" glib:type-name="GBytes" glib:get-type="g_bytes_get_type">
</glib:boxed>
<function-macro name="CALLBACK" c:identifier="G_CALLBACK" introspectable="0">
<doc xml:space="preserve">Cast a function pointer to a #GCallback.</doc>
<parameters>
<parameter name="f">
<doc xml:space="preserve">a function pointer.</doc>
</parameter>
</parameters>
</function-macro>
<function-macro name="CCLOSURE_SWAP_DATA" c:identifier="G_CCLOSURE_SWAP_DATA" introspectable="0">
<doc xml:space="preserve">Checks whether the user data of the #GCClosure should be passed as the
first parameter to the callback. See g_cclosure_new_swap().</doc>
<parameters>
<parameter name="cclosure">
<doc xml:space="preserve">a #GCClosure</doc>
</parameter>
</parameters>
</function-macro>
<record name="CClosure" c:type="GCClosure">
<doc xml:space="preserve">A #GCClosure is a specialization of #GClosure for C function callbacks.</doc>
<field name="closure" writable="1">
<doc xml:space="preserve">the #GClosure</doc>
<type name="Closure" c:type="GClosure"/>
</field>
<field name="callback" writable="1">
<doc xml:space="preserve">the callback function</doc>
<type name="gpointer" c:type="gpointer"/>
</field>
<function name="marshal_BOOLEAN__BOXED_BOXED" c:identifier="g_cclosure_marshal_BOOLEAN__BOXED_BOXED">
<doc xml:space="preserve">A #GClosureMarshal function for use with signals with handlers that
take two boxed pointers as arguments and return a boolean. If you
have such a signal, you will probably also need to use an
accumulator, such as g_signal_accumulator_true_handled().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<doc xml:space="preserve">A #GClosure.</doc>
<type name="Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none">
<doc xml:space="preserve">A #GValue to store the return value. May be %NULL
if the callback of closure doesn't return a value.</doc>
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="n_param_values" transfer-ownership="none">
<doc xml:space="preserve">The length of the @param_values array.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="param_values" transfer-ownership="none">
<doc xml:space="preserve">An array of #GValues holding the arguments
on which to invoke the callback of closure.</doc>
<type name="Value" c:type="const GValue*"/>
</parameter>
<parameter name="invocation_hint" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">The invocation hint given as the last argument to
g_closure_invoke().</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">Additional data specified when registering the
marshaller, see g_closure_set_marshal() and
g_closure_set_meta_marshal()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="marshal_BOOLEAN__BOXED_BOXEDv" c:identifier="g_cclosure_marshal_BOOLEAN__BOXED_BOXEDv" introspectable="0">
<doc xml:space="preserve">The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__BOXED_BOXED().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<doc xml:space="preserve">the #GClosure to which the marshaller belongs</doc>
<type name="Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">a #GValue to store the return
value. May be %NULL if the callback of @closure doesn't return a
value.</doc>
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="instance" transfer-ownership="none">
<doc xml:space="preserve">the instance on which the closure is invoked.</doc>
<type name="TypeInstance" c:type="gpointer"/>
</parameter>
<parameter name="args" transfer-ownership="none">
<doc xml:space="preserve">va_list of arguments to be passed to the closure.</doc>
<type name="va_list" c:type="va_list"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">additional data specified when
registering the marshaller, see g_closure_set_marshal() and
g_closure_set_meta_marshal()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="n_params" transfer-ownership="none">
<doc xml:space="preserve">the length of the @param_types array</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="param_types" transfer-ownership="none">
<doc xml:space="preserve">the #GType of each argument from
@args.</doc>
<array length="5" zero-terminated="0" c:type="GType*">
<type name="GType" c:type="GType"/>
</array>
</parameter>
</parameters>
</function>
<function name="marshal_BOOLEAN__FLAGS" c:identifier="g_cclosure_marshal_BOOLEAN__FLAGS">
<doc xml:space="preserve">A #GClosureMarshal function for use with signals with handlers that
take a flags type as an argument and return a boolean. If you have
such a signal, you will probably also need to use an accumulator,
such as g_signal_accumulator_true_handled().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<doc xml:space="preserve">A #GClosure.</doc>
<type name="Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none">
<doc xml:space="preserve">A #GValue to store the return value. May be %NULL
if the callback of closure doesn't return a value.</doc>
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="n_param_values" transfer-ownership="none">
<doc xml:space="preserve">The length of the @param_values array.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="param_values" transfer-ownership="none">
<doc xml:space="preserve">An array of #GValues holding the arguments
on which to invoke the callback of closure.</doc>
<type name="Value" c:type="const GValue*"/>
</parameter>
<parameter name="invocation_hint" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">The invocation hint given as the last argument to
g_closure_invoke().</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">Additional data specified when registering the
marshaller, see g_closure_set_marshal() and
g_closure_set_meta_marshal()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="marshal_BOOLEAN__FLAGSv" c:identifier="g_cclosure_marshal_BOOLEAN__FLAGSv" introspectable="0">
<doc xml:space="preserve">The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__FLAGS().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<doc xml:space="preserve">the #GClosure to which the marshaller belongs</doc>
<type name="Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">a #GValue to store the return
value. May be %NULL if the callback of @closure doesn't return a
value.</doc>
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="instance" transfer-ownership="none">
<doc xml:space="preserve">the instance on which the closure is invoked.</doc>
<type name="TypeInstance" c:type="gpointer"/>
</parameter>
<parameter name="args" transfer-ownership="none">
<doc xml:space="preserve">va_list of arguments to be passed to the closure.</doc>
<type name="va_list" c:type="va_list"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">additional data specified when
registering the marshaller, see g_closure_set_marshal() and
g_closure_set_meta_marshal()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="n_params" transfer-ownership="none">
<doc xml:space="preserve">the length of the @param_types array</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="param_types" transfer-ownership="none">
<doc xml:space="preserve">the #GType of each argument from
@args.</doc>
<array length="5" zero-terminated="0" c:type="GType*">
<type name="GType" c:type="GType"/>
</array>
</parameter>
</parameters>
</function>
<function name="marshal_STRING__OBJECT_POINTER" c:identifier="g_cclosure_marshal_STRING__OBJECT_POINTER">
<doc xml:space="preserve">A #GClosureMarshal function for use with signals with handlers that
take a #GObject and a pointer and produce a string. It is highly
unlikely that your signal handler fits this description.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<doc xml:space="preserve">A #GClosure.</doc>
<type name="Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none">
<doc xml:space="preserve">A #GValue to store the return value. May be %NULL
if the callback of closure doesn't return a value.</doc>
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="n_param_values" transfer-ownership="none">
<doc xml:space="preserve">The length of the @param_values array.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="param_values" transfer-ownership="none">
<doc xml:space="preserve">An array of #GValues holding the arguments
on which to invoke the callback of closure.</doc>
<type name="Value" c:type="const GValue*"/>
</parameter>
<parameter name="invocation_hint" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">The invocation hint given as the last argument to
g_closure_invoke().</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">Additional data specified when registering the
marshaller, see g_closure_set_marshal() and
g_closure_set_meta_marshal()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="marshal_STRING__OBJECT_POINTERv" c:identifier="g_cclosure_marshal_STRING__OBJECT_POINTERv" introspectable="0">
<doc xml:space="preserve">The #GVaClosureMarshal equivalent to g_cclosure_marshal_STRING__OBJECT_POINTER().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<doc xml:space="preserve">the #GClosure to which the marshaller belongs</doc>
<type name="Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">a #GValue to store the return
value. May be %NULL if the callback of @closure doesn't return a
value.</doc>
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="instance" transfer-ownership="none">
<doc xml:space="preserve">the instance on which the closure is invoked.</doc>
<type name="TypeInstance" c:type="gpointer"/>
</parameter>
<parameter name="args" transfer-ownership="none">
<doc xml:space="preserve">va_list of arguments to be passed to the closure.</doc>
<type name="va_list" c:type="va_list"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">additional data specified when
registering the marshaller, see g_closure_set_marshal() and
g_closure_set_meta_marshal()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="n_params" transfer-ownership="none">
<doc xml:space="preserve">the length of the @param_types array</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="param_types" transfer-ownership="none">
<doc xml:space="preserve">the #GType of each argument from
@args.</doc>
<array length="5" zero-terminated="0" c:type="GType*">
<type name="GType" c:type="GType"/>
</array>
</parameter>
</parameters>
</function>
<function name="marshal_VOID__BOOLEAN" c:identifier="g_cclosure_marshal_VOID__BOOLEAN">
<doc xml:space="preserve">A #GClosureMarshal function for use with signals with a single
boolean argument.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<doc xml:space="preserve">A #GClosure.</doc>
<type name="Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none">
<doc xml:space="preserve">A #GValue to store the return value. May be %NULL
if the callback of closure doesn't return a value.</doc>
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="n_param_values" transfer-ownership="none">
<doc xml:space="preserve">The length of the @param_values array.</doc>
<type name="guint" c:type="guint"/>
</parameter>