-
Notifications
You must be signed in to change notification settings - Fork 64
/
GObject-2.0.gir
10070 lines (10070 loc) · 474 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 version="1.2"
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">
<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="g">
<alias name="SignalCMarshaller" c:type="GSignalCMarshaller">
<doc xml:whitespace="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="Strv" c:type="GStrv">
<doc xml:whitespace="preserve">A C representable type name for #G_TYPE_STRV.</doc>
<type name="gpointer" c:type="gpointer"/>
</alias>
<alias name="Type" c:type="GType">
<doc xml:whitespace="preserve">A numerical value which represents the unique identifier of a registered
type.</doc>
<type name="gsize" c:type="gsize"/>
</alias>
<glib:boxed glib:name="Array"
c:symbol-prefix="array"
glib:type-name="GArray"
glib:get-type="g_array_get_type">
</glib:boxed>
<callback name="BaseFinalizeFunc" c:type="GBaseFinalizeFunc">
<doc xml:whitespace="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 intialization is performed.
See GClassInitFunc() for a discussion of the class intialization 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:whitespace="preserve">The #GTypeClass structure to finalize.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<callback name="BaseInitFunc" c:type="GBaseInitFunc">
<doc xml:whitespace="preserve">A callback function used by the type system to do base initialization
of the class structures of derived types. It 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
intialization 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:whitespace="preserve">The #GTypeClass structure to initialize.</doc>
<type name="gpointer" 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:whitespace="preserve"><structname>GBinding</structname> is an opaque structure whose members
cannot be accessed directly.</doc>
<method name="get_flags"
c:identifier="g_binding_get_flags"
version="2.26">
<doc xml:whitespace="preserve">Retrieves the flags passed when constructing the #GBinding</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the #GBindingFlags used by the #GBinding</doc>
<type name="BindingFlags" c:type="GBindingFlags"/>
</return-value>
</method>
<method name="get_source"
c:identifier="g_binding_get_source"
version="2.26">
<doc xml:whitespace="preserve">Retrieves the #GObject instance used as the source of the binding</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the source #GObject</doc>
<type name="Object" c:type="GObject*"/>
</return-value>
</method>
<method name="get_source_property"
c:identifier="g_binding_get_source_property"
version="2.26">
<doc xml:whitespace="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:whitespace="preserve">the name of the source property</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
</method>
<method name="get_target"
c:identifier="g_binding_get_target"
version="2.26">
<doc xml:whitespace="preserve">Retrieves the #GObject instance used as the target of the binding</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the target #GObject</doc>
<type name="Object" c:type="GObject*"/>
</return-value>
</method>
<method name="get_target_property"
c:identifier="g_binding_get_target_property"
version="2.26">
<doc xml:whitespace="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:whitespace="preserve">the name of the target property</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
</method>
<property name="flags"
version="2.26"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:whitespace="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">
<doc xml:whitespace="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">
<doc xml:whitespace="preserve">The name of the property of #GBinding:source that should be used
as the source of the binding</doc>
<type name="utf8"/>
</property>
<property name="target"
version="2.26"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:whitespace="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">
<doc xml:whitespace="preserve">The name of the property of #GBinding:target that should be used
as the target of the binding</doc>
<type name="utf8"/>
</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:whitespace="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"/>
<member name="bidirectional"
value="1"
c:identifier="G_BINDING_BIDIRECTIONAL"
glib:nick="bidirectional"/>
<member name="sync_create"
value="2"
c:identifier="G_BINDING_SYNC_CREATE"
glib:nick="sync-create"/>
<member name="invert_boolean"
value="4"
c:identifier="G_BINDING_INVERT_BOOLEAN"
glib:nick="invert-boolean"/>
</bitfield>
<callback name="BindingTransformFunc"
c:type="GBindingTransformFunc"
version="2.26">
<doc xml:whitespace="preserve">A function to be called to transform the source property of @source
from @source_value into the target property of @target
using @target_value.
otherwise</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if the transformation was successful, and %FALSE</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="binding" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GBinding</doc>
<type name="Binding" c:type="GBinding*"/>
</parameter>
<parameter name="source_value" transfer-ownership="none">
<doc xml:whitespace="preserve">the value of the source property</doc>
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="target_value" transfer-ownership="none">
<doc xml:whitespace="preserve">the value of the target property</doc>
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="3">
<doc xml:whitespace="preserve">data passed to the transform function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<callback name="BoxedCopyFunc" c:type="GBoxedCopyFunc" introspectable="0">
<doc xml:whitespace="preserve">This function is provided by the user and should produce a copy of the passed
in boxed structure.</doc>
<return-value>
<doc xml:whitespace="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:whitespace="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:whitespace="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:whitespace="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>
<record name="CClosure" c:type="GCClosure">
<doc xml:whitespace="preserve">A #GCClosure is a specialization of #GClosure for C function callbacks.</doc>
<field name="closure" writable="1">
<type name="Closure" c:type="GClosure"/>
</field>
<field name="callback" writable="1">
<type name="gpointer" c:type="gpointer"/>
</field>
</record>
<callback name="Callback" c:type="GCallback">
<doc xml:whitespace="preserve">The type used for callback functions in structure definitions and function
signatures. This doesn't mean that all callback functions must take no
parameters and return void. The required signature of a callback function
is determined by the context in which is used (e.g. the signal to which it
is connected). Use G_CALLBACK() to cast the callback function to a #GCallback.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
<callback name="ClassFinalizeFunc" c:type="GClassFinalizeFunc">
<doc xml:whitespace="preserve">A callback function used by the type system to finalize a class.
This function is rarely needed, as dynamically allocated class resources
should be handled by GBaseInitFunc() and GBaseFinalizeFunc().
Also, specification of a GClassFinalizeFunc() in the #GTypeInfo
structure of a static type is invalid, because classes of static types
will never be finalized (they are artificially kept alive when their
reference count drops to zero).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="g_class" transfer-ownership="none">
<doc xml:whitespace="preserve">The #GTypeClass structure to finalize.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="class_data" transfer-ownership="none">
<doc xml:whitespace="preserve">The @class_data member supplied via the #GTypeInfo structure.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<callback name="ClassInitFunc" c:type="GClassInitFunc">
<doc xml:whitespace="preserve">A callback function used by the type system to initialize the class
of a specific type. This function should initialize all static class
members.
The initialization process of a class involves:
<itemizedlist>
<listitem><para>
1 - Copying common members from the parent class over to the
derived class structure.
</para></listitem>
<listitem><para>
2 - Zero initialization of the remaining members not copied
over from the parent class.
</para></listitem>
<listitem><para>
3 - Invocation of the GBaseInitFunc() initializers of all parent
types and the class' type.
</para></listitem>
<listitem><para>
4 - Invocation of the class' GClassInitFunc() initializer.
</para></listitem>
</itemizedlist>
Since derived classes are partially initialized through a memory copy
of the parent class, the general rule is that GBaseInitFunc() and
GBaseFinalizeFunc() should take care of necessary reinitialization
and release of those class members that were introduced by the type
that specified these GBaseInitFunc()/GBaseFinalizeFunc().
GClassInitFunc() should only care about initializing static
class members, while dynamic class members (such as allocated strings
or reference counted resources) are better handled by a GBaseInitFunc()
for this type, so proper initialization of the dynamic class members
is performed for class initialization of derived types as well.
An example may help to correspond the intend of the different class
initializers:
|[
typedef struct {
GObjectClass parent_class;
gint static_integer;
gchar *dynamic_string;
} TypeAClass;
static void
type_a_base_class_init (TypeAClass *class)
{
class->dynamic_string = g_strdup ("some string");
}
static void
type_a_base_class_finalize (TypeAClass *class)
{
g_free (class->dynamic_string);
}
static void
type_a_class_init (TypeAClass *class)
{
class->static_integer = 42;
}
typedef struct {
TypeAClass parent_class;
gfloat static_float;
GString *dynamic_gstring;
} TypeBClass;
static void
type_b_base_class_init (TypeBClass *class)
{
class->dynamic_gstring = g_string_new ("some other string");
}
static void
type_b_base_class_finalize (TypeBClass *class)
{
g_string_free (class->dynamic_gstring);
}
static void
type_b_class_init (TypeBClass *class)
{
class->static_float = 3.14159265358979323846;
}
]|
Initialization of TypeBClass will first cause initialization of
TypeAClass (derived classes reference their parent classes, see
g_type_class_ref() on this).
Initialization of TypeAClass roughly involves zero-initializing its fields,
then calling its GBaseInitFunc() type_a_base_class_init() to allocate
its dynamic members (dynamic_string), and finally calling its GClassInitFunc()
type_a_class_init() to initialize its static members (static_integer).
The first step in the initialization process of TypeBClass is then
a plain memory copy of the contents of TypeAClass into TypeBClass and
zero-initialization of the remaining fields in TypeBClass.
The dynamic members of TypeAClass within TypeBClass now need
reinitialization which is performed by calling type_a_base_class_init()
with an argument of TypeBClass.
After that, the GBaseInitFunc() of TypeBClass, type_b_base_class_init()
is called to allocate the dynamic members of TypeBClass (dynamic_gstring),
and finally the GClassInitFunc() of TypeBClass, type_b_class_init(),
is called to complete the initialization process with the static members
(static_float).
Corresponding finalization counter parts to the GBaseInitFunc() functions
have to be provided to release allocated resources at class finalization
time.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="g_class" transfer-ownership="none">
<doc xml:whitespace="preserve">The #GTypeClass structure to initialize.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="class_data" transfer-ownership="none">
<doc xml:whitespace="preserve">The @class_data member supplied via the #GTypeInfo structure.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="Closure"
c:type="GClosure"
glib:type-name="GClosure"
glib:get-type="g_closure_get_type"
c:symbol-prefix="closure">
<doc xml:whitespace="preserve">A #GClosure represents a callback supplied by the programmer.</doc>
<field name="ref_count" writable="1" bits="15">
<type name="guint" c:type="guint"/>
</field>
<field name="meta_marshal" writable="1" bits="1">
<type name="guint" c:type="guint"/>
</field>
<field name="n_guards" writable="1" bits="1">
<type name="guint" c:type="guint"/>
</field>
<field name="n_fnotifiers" writable="1" bits="2">
<type name="guint" c:type="guint"/>
</field>
<field name="n_inotifiers" writable="1" bits="8">
<type name="guint" c:type="guint"/>
</field>
<field name="in_inotify" writable="1" bits="1">
<type name="guint" c:type="guint"/>
</field>
<field name="floating" writable="1" bits="1">
<type name="guint" c:type="guint"/>
</field>
<field name="derivative_flag" writable="1" bits="1">
<type name="guint" c:type="guint"/>
</field>
<field name="in_marshal" writable="1" bits="1">
<type name="guint" c:type="guint"/>
</field>
<field name="is_invalid" writable="1" bits="1">
<type name="guint" c:type="guint"/>
</field>
<field name="marshal">
<callback name="marshal">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<type name="Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none">
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="n_param_values" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="param_values" transfer-ownership="none">
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="invocation_hint" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="marshal_data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
<field name="data" writable="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="notifiers" writable="1">
<type name="ClosureNotifyData" c:type="GClosureNotifyData*"/>
</field>
<constructor name="new_object" c:identifier="g_closure_new_object">
<doc xml:whitespace="preserve">A variant of g_closure_new_simple() which stores @object in the
when implementing new types of closures.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a newly allocated #GClosure</doc>
<type name="Closure" c:type="GClosure*"/>
</return-value>
<parameters>
<parameter name="sizeof_closure" transfer-ownership="none">
<doc xml:whitespace="preserve">the size of the structure to allocate, must be at least <literal>sizeof (GClosure)</literal></doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="object" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GObject pointer to store in the @data field of the newly allocated #GClosure</doc>
<type name="Object" c:type="GObject*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_simple" c:identifier="g_closure_new_simple">
<doc xml:whitespace="preserve">Allocates a struct of the given size and initializes the initial
part as a #GClosure. This function is mainly useful when
implementing new types of closures.
|[
typedef struct _MyClosure MyClosure;
struct _MyClosure
{
GClosure closure;
// extra data goes here
};
static void
my_closure_finalize (gpointer notify_data,
GClosure *closure)
{
MyClosure *my_closure = (MyClosure *)closure;
// free extra data here
}
MyClosure *my_closure_new (gpointer data)
{
GClosure *closure;
MyClosure *my_closure;
closure = g_closure_new_simple (sizeof (MyClosure), data);
my_closure = (MyClosure *) closure;
// initialize extra data here
g_closure_add_finalize_notifier (closure, notify_data,
my_closure_finalize);
return my_closure;
}
]|</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a newly allocated #GClosure</doc>
<type name="Closure" c:type="GClosure*"/>
</return-value>
<parameters>
<parameter name="sizeof_closure" transfer-ownership="none">
<doc xml:whitespace="preserve">the size of the structure to allocate, must be at least <literal>sizeof (GClosure)</literal></doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:whitespace="preserve">data to store in the @data field of the newly allocated #GClosure</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</constructor>
<method name="add_finalize_notifier"
c:identifier="g_closure_add_finalize_notifier"
introspectable="0">
<doc xml:whitespace="preserve">Registers a finalization notifier which will be called when the
reference count of @closure goes down to 0. Multiple finalization
notifiers on a single closure are invoked in unspecified order. If
a single call to g_closure_unref() results in the closure being
both invalidated and finalized, then the invalidate notifiers will
be run before the finalize notifiers.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="notify_data" transfer-ownership="none">
<doc xml:whitespace="preserve">data to pass to @notify_func</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="notify_func" transfer-ownership="none">
<doc xml:whitespace="preserve">the callback function to register</doc>
<type name="ClosureNotify" c:type="GClosureNotify"/>
</parameter>
</parameters>
</method>
<method name="add_invalidate_notifier"
c:identifier="g_closure_add_invalidate_notifier"
introspectable="0">
<doc xml:whitespace="preserve">Registers an invalidation notifier which will be called when the
notifiers are invoked before finalization notifiers, in an
unspecified order.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="notify_data" transfer-ownership="none">
<doc xml:whitespace="preserve">data to pass to @notify_func</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="notify_func" transfer-ownership="none">
<doc xml:whitespace="preserve">the callback function to register</doc>
<type name="ClosureNotify" c:type="GClosureNotify"/>
</parameter>
</parameters>
</method>
<method name="add_marshal_guards"
c:identifier="g_closure_add_marshal_guards"
introspectable="0">
<doc xml:whitespace="preserve">Adds a pair of notifiers which get invoked before and after the
closure callback, respectively. This is typically used to protect
the extra arguments for the duration of the callback. See
g_object_watch_closure() for an example of marshal guards.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="pre_marshal_data" transfer-ownership="none">
<doc xml:whitespace="preserve">data to pass to @pre_marshal_notify</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="pre_marshal_notify"
transfer-ownership="none"
closure="2">
<doc xml:whitespace="preserve">a function to call before the closure callback</doc>
<type name="ClosureNotify" c:type="GClosureNotify"/>
</parameter>
<parameter name="post_marshal_data" transfer-ownership="none">
<doc xml:whitespace="preserve">data to pass to @post_marshal_notify</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="post_marshal_notify" transfer-ownership="none">
<doc xml:whitespace="preserve">a function to call after the closure callback</doc>
<type name="ClosureNotify" c:type="GClosureNotify"/>
</parameter>
</parameters>
</method>
<method name="invalidate" c:identifier="g_closure_invalidate">
<doc xml:whitespace="preserve">Sets a flag on the closure to indicate that its calling
environment has become invalid, and thus causes any future
invocations of g_closure_invoke() on this @closure to be
ignored. Also, invalidation notifiers installed on the closure will
be called at this point. Note that unless you are holding a
reference to the closure yourself, the invalidation notifiers may
unref the closure and cause it to be destroyed, so if you need to
access the closure after calling g_closure_invalidate(), make sure
that you've previously called g_closure_ref().
Note that g_closure_invalidate() will also be called when the
reference count of a closure drops to zero (unless it has already
been invalidated before).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</method>
<method name="invoke" c:identifier="g_closure_invoke">
<doc xml:whitespace="preserve">Invokes the closure, i.e. executes the callback represented by the @closure.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="return_value" transfer-ownership="none">
<doc xml:whitespace="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:whitespace="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:whitespace="preserve">an array of #GValue<!-- -->s holding the arguments on which to invoke the callback of @closure</doc>
<array length="1" c:type="GValue*">
<type name="Value"/>
</array>
</parameter>
<parameter name="invocation_hint" transfer-ownership="none">
<doc xml:whitespace="preserve">a context-dependent invocation hint</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="ref" c:identifier="g_closure_ref">
<doc xml:whitespace="preserve">Increments the reference count on a closure to force it staying
alive while the caller holds a pointer to it.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">The @closure passed in, for convenience</doc>
<type name="Closure" c:type="GClosure*"/>
</return-value>
</method>
<method name="remove_finalize_notifier"
c:identifier="g_closure_remove_finalize_notifier"
introspectable="0">
<doc xml:whitespace="preserve">Removes a finalization notifier.
Notice that notifiers are automatically removed after they are run.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="notify_data" transfer-ownership="none">
<doc xml:whitespace="preserve">data which was passed to g_closure_add_finalize_notifier() when registering @notify_func</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="notify_func" transfer-ownership="none">
<doc xml:whitespace="preserve">the callback function to remove</doc>
<type name="ClosureNotify" c:type="GClosureNotify"/>
</parameter>
</parameters>
</method>
<method name="remove_invalidate_notifier"
c:identifier="g_closure_remove_invalidate_notifier"
introspectable="0">
<doc xml:whitespace="preserve">Removes an invalidation notifier.
Notice that notifiers are automatically removed after they are run.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="notify_data" transfer-ownership="none">
<doc xml:whitespace="preserve">data which was passed to g_closure_add_invalidate_notifier() when registering @notify_func</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="notify_func" transfer-ownership="none">
<doc xml:whitespace="preserve">the callback function to remove</doc>
<type name="ClosureNotify" c:type="GClosureNotify"/>
</parameter>
</parameters>
</method>
<method name="set_marshal"
c:identifier="g_closure_set_marshal"
introspectable="0">
<doc xml:whitespace="preserve">Sets the marshaller of @closure. The <literal>marshal_data</literal>
of @marshal provides a way for a meta marshaller to provide additional
information to the marshaller. (See g_closure_set_meta_marshal().) For
GObject's C predefined marshallers (the g_cclosure_marshal_*()
functions), what it provides is a callback function to use instead of</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="marshal" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GClosureMarshal function</doc>
<type name="ClosureMarshal" c:type="GClosureMarshal"/>
</parameter>
</parameters>
</method>
<method name="set_meta_marshal"
c:identifier="g_closure_set_meta_marshal"
introspectable="0">
<doc xml:whitespace="preserve">Sets the meta marshaller of @closure. A meta marshaller wraps
fashion. The most common use of this facility is for C callbacks.
The same marshallers (generated by <link
linkend="glib-genmarshal">glib-genmarshal</link>) are used
everywhere, but the way that we get the callback function
differs. In most cases we want to use @closure->callback, but in
other cases we want to use some different technique to retrieve the
callback function.
For example, class closures for signals (see
g_signal_type_cclosure_new()) retrieve the callback function from a
fixed offset in the class structure. The meta marshaller retrieves
the right callback and passes it to the marshaller as the</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="marshal_data" transfer-ownership="none">
<doc xml:whitespace="preserve">context-dependent data to pass to @meta_marshal</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="meta_marshal" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GClosureMarshal function</doc>
<type name="ClosureMarshal" c:type="GClosureMarshal"/>
</parameter>
</parameters>
</method>
<method name="sink" c:identifier="g_closure_sink">
<doc xml:whitespace="preserve">Takes over the initial ownership of a closure. Each closure is
initially created in a <firstterm>floating</firstterm> state, which
means that the initial reference count is not owned by any caller.
g_closure_sink() checks to see if the object is still floating, and
if so, unsets the floating state and decreases the reference
count. If the closure is not floating, g_closure_sink() does
nothing. The reason for the existance of the floating state is to
prevent cumbersome code sequences like:
|[
closure = g_cclosure_new (cb_func, cb_data);
g_source_set_closure (source, closure);
g_closure_unref (closure); // XXX GObject doesn't really need this
]|
Because g_source_set_closure() (and similar functions) take ownership of the
initial reference count, if it is unowned, we instead can write:
|[
g_source_set_closure (source, g_cclosure_new (cb_func, cb_data));
]|
Generally, this function is used together with g_closure_ref(). Ane example
of storing a closure for later notification looks like:
|[
static GClosure *notify_closure = NULL;
void
foo_notify_set_closure (GClosure *closure)
{
if (notify_closure)
g_closure_unref (notify_closure);
notify_closure = closure;
if (notify_closure)
{
g_closure_ref (notify_closure);
g_closure_sink (notify_closure);
}
}
]|
Because g_closure_sink() may decrement the reference count of a closure
(if it hasn't been called on @closure yet) just like g_closure_unref(),
g_closure_ref() should be called prior to this function.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</method>
<method name="unref" c:identifier="g_closure_unref">
<doc xml:whitespace="preserve">Decrements the reference count of a closure after it was previously
incremented by the same caller. If no other callers are using the
closure, then the closure will be destroyed and freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</method>
</record>
<callback name="ClosureMarshal" c:type="GClosureMarshal">
<doc xml:whitespace="preserve">The type used for marshaller functions.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="closure" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GClosure to which the marshaller belongs</doc>
<type name="Closure" c:type="GClosure*"/>
</parameter>
<parameter name="return_value" transfer-ownership="none">
<doc xml:whitespace="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:whitespace="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:whitespace="preserve">an array of #GValue<!-- -->s holding the arguments on which to invoke the callback of @closure</doc>
<type name="Value" c:type="GValue*"/>
</parameter>
<parameter name="invocation_hint" transfer-ownership="none">
<doc xml:whitespace="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">
<doc xml:whitespace="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>
</callback>
<callback name="ClosureNotify" c:type="GClosureNotify">
<doc xml:whitespace="preserve">The type used for the various notification callbacks which can be registered
on closures.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="data" transfer-ownership="none">
<doc xml:whitespace="preserve">data specified when registering the notification callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="closure" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GClosure on which the notification is emitted</doc>
<type name="Closure" c:type="GClosure*"/>
</parameter>
</parameters>
</callback>
<record name="ClosureNotifyData" c:type="GClosureNotifyData">
<field name="data" writable="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="notify" writable="1">
<type name="ClosureNotify" c:type="GClosureNotify"/>
</field>
</record>
<bitfield name="ConnectFlags" c:type="GConnectFlags">
<doc xml:whitespace="preserve">The connection flags are used to specify the behaviour of a signal's
connection.</doc>
<member name="after" value="1" c:identifier="G_CONNECT_AFTER"/>
<member name="swapped" value="2" c:identifier="G_CONNECT_SWAPPED"/>
</bitfield>
<glib:boxed glib:name="Date"
c:symbol-prefix="date"
glib:type-name="GDate"
glib:get-type="g_date_get_type">
</glib:boxed>
<glib:boxed glib:name="DateTime"
c:symbol-prefix="date_time"
glib:type-name="GDateTime"
glib:get-type="g_date_time_get_type">
</glib:boxed>
<record name="EnumClass" c:type="GEnumClass">
<doc xml:whitespace="preserve">The class of an enumeration type holds information about its
possible values.</doc>
<field name="g_type_class" writable="1">
<type name="TypeClass" c:type="GTypeClass"/>
</field>
<field name="minimum" writable="1">
<type name="gint" c:type="gint"/>
</field>
<field name="maximum" writable="1">
<type name="gint" c:type="gint"/>
</field>
<field name="n_values" writable="1">
<type name="guint" c:type="guint"/>
</field>
<field name="values" writable="1">
<type name="EnumValue" c:type="GEnumValue*"/>
</field>
</record>
<record name="EnumValue" c:type="GEnumValue">
<doc xml:whitespace="preserve">A structure which contains a single enum value, its name, and its
nickname.</doc>
<field name="value" writable="1">
<type name="gint" c:type="gint"/>
</field>
<field name="value_name" writable="1">
<type name="utf8" c:type="gchar*"/>
</field>
<field name="value_nick" writable="1">
<type name="utf8" c:type="gchar*"/>
</field>
</record>
<glib:boxed glib:name="Error"
c:symbol-prefix="error"
glib:type-name="GError"
glib:get-type="g_error_get_type">
</glib:boxed>
<record name="FlagsClass" c:type="GFlagsClass">
<doc xml:whitespace="preserve">The class of a flags type holds information about its
possible values.</doc>
<field name="g_type_class" writable="1">
<type name="TypeClass" c:type="GTypeClass"/>
</field>
<field name="mask" writable="1">
<type name="guint" c:type="guint"/>
</field>
<field name="n_values" writable="1">
<type name="guint" c:type="guint"/>
</field>
<field name="values" writable="1">
<type name="FlagsValue" c:type="GFlagsValue*"/>
</field>
</record>
<record name="FlagsValue" c:type="GFlagsValue">
<doc xml:whitespace="preserve">A structure which contains a single flags value, its name, and its
nickname.</doc>
<field name="value" writable="1">
<type name="guint" c:type="guint"/>
</field>
<field name="value_name" writable="1">
<type name="utf8" c:type="gchar*"/>
</field>
<field name="value_nick" writable="1">
<type name="utf8" c:type="gchar*"/>
</field>
</record>
<glib:boxed glib:name="HashTable"
c:symbol-prefix="hash_table"
glib:type-name="GHashTable"
glib:get-type="g_hash_table_get_type">
</glib:boxed>
<glib:boxed glib:name="IOChannel"
c:symbol-prefix="io_channel"
glib:type-name="GIOChannel"
glib:get-type="g_io_channel_get_type">
</glib:boxed>
<bitfield name="IOCondition"
glib:type-name="GIOCondition"
glib:get-type="g_io_condition_get_type"
c:type="GIOCondition">
<member name="in" value="1" c:identifier="G_IO_IN" glib:nick="in"/>
<member name="out" value="4" c:identifier="G_IO_OUT" glib:nick="out"/>
<member name="pri" value="2" c:identifier="G_IO_PRI" glib:nick="pri"/>
<member name="err" value="8" c:identifier="G_IO_ERR" glib:nick="err"/>
<member name="hup" value="16" c:identifier="G_IO_HUP" glib:nick="hup"/>
<member name="nval"
value="32"
c:identifier="G_IO_NVAL"
glib:nick="nval"/>
</bitfield>
<class name="InitiallyUnowned"
c:symbol-prefix="object"
parent="Object"
abstract="1"
glib:type-name="GInitiallyUnowned"
glib:get-type="g_initially_unowned_get_type"
glib:type-struct="InitiallyUnownedClass">
<doc xml:whitespace="preserve">All the fields in the <structname>GInitiallyUnowned</structname> structure
are private to the #GInitiallyUnowned implementation and should never be
accessed directly.</doc>
<function name="bind_property"
c:identifier="g_object_bind_property"
version="2.26">
<doc xml:whitespace="preserve">Creates a binding between @source_property on @source and @target_property
on @target. Whenever the @source_property is changed the @target_property is
updated using the same value. For instance:
|[
g_object_bind_property (action, "active", widget, "sensitive", 0);
]|
Will result in the "sensitive" property of the widget #GObject instance to be
updated with the same value of the "active" property of the action #GObject
instance.
If @flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if @target_property on @target changes then the @source_property on @source
will be updated as well.
The binding will automatically be removed when either the @source or the
#GBinding instance.
A #GObject can have multiple bindings.
binding between the two #GObject instances. The binding is released
whenever the #GBinding reference count reaches zero.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the #GBinding instance representing the</doc>