forked from gtk-rs/gir-files
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAtk-1.0.gir
16279 lines (15306 loc) · 787 KB
/
Atk-1.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="GObject" version="2.0"/>
<package name="atk"/>
<c:include name="atk/atk.h"/>
<namespace name="Atk" version="1.0" shared-library="libatk-1.0.so.0" c:identifier-prefixes="Atk" c:symbol-prefixes="atk">
<alias name="AttributeSet" c:type="AtkAttributeSet">
<doc xml:space="preserve">This is a singly-linked list (a #GSList) of #AtkAttribute. It is
used by atk_text_get_run_attributes(),
atk_text_get_default_attributes(),
atk_editable_text_set_run_attributes(),
atk_document_get_attributes() and atk_object_get_attributes()</doc>
<type name="GLib.SList" c:type="GSList"/>
</alias>
<alias name="State" c:type="AtkState">
<type name="guint64" c:type="guint64"/>
</alias>
<function-macro name="ACTION" c:identifier="ATK_ACTION" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="ACTION_GET_IFACE" c:identifier="ATK_ACTION_GET_IFACE" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<interface name="Action" c:symbol-prefix="action" c:type="AtkAction" glib:type-name="AtkAction" glib:get-type="atk_action_get_type" glib:type-struct="ActionIface">
<doc xml:space="preserve">#AtkAction should be implemented by instances of #AtkObject classes
with which the user can interact directly, i.e. buttons,
checkboxes, scrollbars, e.g. components which are not "passive"
providers of UI information.
Exceptions: when the user interaction is already covered by another
appropriate interface such as #AtkEditableText (insert/delete text,
etc.) or #AtkValue (set value) then these actions should not be
exposed by #AtkAction as well.
Though most UI interactions on components should be invocable via
keyboard as well as mouse, there will generally be a close mapping
between "mouse actions" that are possible on a component and the
AtkActions. Where mouse and keyboard actions are redundant in
effect, #AtkAction should expose only one action rather than
exposing redundant actions if possible. By convention we have been
using "mouse centric" terminology for #AtkAction names.</doc>
<virtual-method name="do_action" invoker="do_action">
<doc xml:space="preserve">Perform the specified action on the object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if success, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_description" invoker="get_description">
<doc xml:space="preserve">Returns a description of the specified action of the object.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a description string, or %NULL if @action does
not implement this interface.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_keybinding" invoker="get_keybinding">
<doc xml:space="preserve">Gets the keybinding which can be used to activate this action, if one
exists. The string returned should contain localized, human-readable,
key sequences as they would appear when displayed on screen. It must
be in the format "mnemonic;sequence;shortcut".
- The mnemonic key activates the object if it is presently enabled onscreen.
This typically corresponds to the underlined letter within the widget.
Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for
a button.
- The sequence is the full list of keys which invoke the action even if the
relevant element is not currently shown on screen. For instance, for a menu
item the sequence is the keybindings used to open the parent menus before
invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a
traditional "New..." menu item.
- The shortcut, if it exists, will invoke the same action without showing
the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a
traditional "New..." menu item.
Example: For a traditional "New..." menu item, the expected return value
would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N"
for the German locale. If, hypothetically, this menu item lacked a mnemonic,
it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the keybinding which can be used to activate
this action, or %NULL if there is no keybinding for this action.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_localized_name" invoker="get_localized_name">
<doc xml:space="preserve">Returns the localized name of the specified action of the object.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a name string, or %NULL if @action does not
implement this interface.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_n_actions" invoker="get_n_actions">
<doc xml:space="preserve">Gets the number of accessible actions available on the object.
If there are more than one, the first one is considered the
"default" action of the object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a the number of actions, or 0 if @action does not
implement this interface.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="get_name" invoker="get_name">
<doc xml:space="preserve">Returns a non-localized string naming the specified action of the
object. This name is generally not descriptive of the end result
of the action, but instead names the 'interaction type' which the
object supports. By convention, the above strings should be used to
represent the actions which correspond to the common point-and-click
interaction techniques of the same name: i.e.
"click", "press", "release", "drag", "drop", "popup", etc.
The "popup" action should be used to pop up a context menu for the
object, if one exists.
For technical reasons, some toolkits cannot guarantee that the
reported action is actually 'bound' to a nontrivial user event;
i.e. the result of some actions via atk_action_do_action() may be
NIL.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a name string, or %NULL if @action does not
implement this interface.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_description" invoker="set_description">
<doc xml:space="preserve">Sets a description of the specified action of the object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a gboolean representing if the description was successfully set;</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="desc" transfer-ownership="none">
<doc xml:space="preserve">the description to be assigned to this action</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</virtual-method>
<method name="do_action" c:identifier="atk_action_do_action">
<doc xml:space="preserve">Perform the specified action on the object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if success, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="get_description" c:identifier="atk_action_get_description">
<doc xml:space="preserve">Returns a description of the specified action of the object.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a description string, or %NULL if @action does
not implement this interface.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="get_keybinding" c:identifier="atk_action_get_keybinding">
<doc xml:space="preserve">Gets the keybinding which can be used to activate this action, if one
exists. The string returned should contain localized, human-readable,
key sequences as they would appear when displayed on screen. It must
be in the format "mnemonic;sequence;shortcut".
- The mnemonic key activates the object if it is presently enabled onscreen.
This typically corresponds to the underlined letter within the widget.
Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for
a button.
- The sequence is the full list of keys which invoke the action even if the
relevant element is not currently shown on screen. For instance, for a menu
item the sequence is the keybindings used to open the parent menus before
invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a
traditional "New..." menu item.
- The shortcut, if it exists, will invoke the same action without showing
the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a
traditional "New..." menu item.
Example: For a traditional "New..." menu item, the expected return value
would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N"
for the German locale. If, hypothetically, this menu item lacked a mnemonic,
it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the keybinding which can be used to activate
this action, or %NULL if there is no keybinding for this action.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="get_localized_name" c:identifier="atk_action_get_localized_name">
<doc xml:space="preserve">Returns the localized name of the specified action of the object.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a name string, or %NULL if @action does not
implement this interface.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="get_n_actions" c:identifier="atk_action_get_n_actions">
<doc xml:space="preserve">Gets the number of accessible actions available on the object.
If there are more than one, the first one is considered the
"default" action of the object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a the number of actions, or 0 if @action does not
implement this interface.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name" c:identifier="atk_action_get_name">
<doc xml:space="preserve">Returns a non-localized string naming the specified action of the
object. This name is generally not descriptive of the end result
of the action, but instead names the 'interaction type' which the
object supports. By convention, the above strings should be used to
represent the actions which correspond to the common point-and-click
interaction techniques of the same name: i.e.
"click", "press", "release", "drag", "drop", "popup", etc.
The "popup" action should be used to pop up a context menu for the
object, if one exists.
For technical reasons, some toolkits cannot guarantee that the
reported action is actually 'bound' to a nontrivial user event;
i.e. the result of some actions via atk_action_do_action() may be
NIL.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a name string, or %NULL if @action does not
implement this interface.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_description" c:identifier="atk_action_set_description">
<doc xml:space="preserve">Sets a description of the specified action of the object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a gboolean representing if the description was successfully set;</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</instance-parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="desc" transfer-ownership="none">
<doc xml:space="preserve">the description to be assigned to this action</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
</interface>
<record name="ActionIface" c:type="AtkActionIface" glib:is-gtype-struct-for="Action">
<doc xml:space="preserve">The #AtkAction interface should be supported by any object that can
perform one or more actions. The interface provides the standard
mechanism for an assistive technology to determine what those actions
are as well as tell the object to perform them. Any object that can
be manipulated should support this interface.</doc>
<field name="parent" readable="0" private="1">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="do_action">
<callback name="do_action">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if success, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_n_actions">
<callback name="get_n_actions">
<return-value transfer-ownership="none">
<doc xml:space="preserve">a the number of actions, or 0 if @action does not
implement this interface.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_description">
<callback name="get_description">
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a description string, or %NULL if @action does
not implement this interface.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_name">
<callback name="get_name">
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a name string, or %NULL if @action does not
implement this interface.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_keybinding">
<callback name="get_keybinding">
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the keybinding which can be used to activate
this action, or %NULL if there is no keybinding for this action.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_description">
<callback name="set_description">
<return-value transfer-ownership="none">
<doc xml:space="preserve">a gboolean representing if the description was successfully set;</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="desc" transfer-ownership="none">
<doc xml:space="preserve">the description to be assigned to this action</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_localized_name">
<callback name="get_localized_name">
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a name string, or %NULL if @action does not
implement this interface.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="action" transfer-ownership="none">
<doc xml:space="preserve">a #GObject instance that implements AtkActionIface</doc>
<type name="Action" c:type="AtkAction*"/>
</parameter>
<parameter name="i" transfer-ownership="none">
<doc xml:space="preserve">the action index corresponding to the action to be performed</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<record name="Attribute" c:type="AtkAttribute">
<doc xml:space="preserve">AtkAttribute is a string name/value pair representing a generic
attribute. This can be used to expose additional information from
an accessible object as a whole (see atk_object_get_attributes())
or an document (see atk_document_get_attributes()). In the case of
text attributes (see atk_text_get_default_attributes()),
#AtkTextAttribute enum defines all the possible text attribute
names. You can use atk_text_attribute_get_name() to get the string
name from the enum value. See also atk_text_attribute_for_name()
and atk_text_attribute_get_value() for more information.
A string name/value pair representing a generic attribute.</doc>
<field name="name" writable="1">
<doc xml:space="preserve">The attribute name.</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<field name="value" writable="1">
<doc xml:space="preserve">the value of the attribute, represented as a string.</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<function name="set_free" c:identifier="atk_attribute_set_free">
<doc xml:space="preserve">Frees the memory used by an #AtkAttributeSet, including all its
#AtkAttributes.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="attrib_set" transfer-ownership="none">
<doc xml:space="preserve">The #AtkAttributeSet to free</doc>
<type name="AttributeSet" c:type="AtkAttributeSet*"/>
</parameter>
</parameters>
</function>
</record>
<constant name="BINARY_AGE" value="23511" c:type="ATK_BINARY_AGE" version="2.7.4">
<doc xml:space="preserve">Like atk_get_binary_age(), but from the headers used at
application compile time, rather than from the library linked
against at application run time.</doc>
<type name="gint" c:type="gint"/>
</constant>
<function-macro name="CHECK_VERSION" c:identifier="ATK_CHECK_VERSION" version="2.7.4" introspectable="0">
<doc xml:space="preserve">Returns %TRUE if the version of the ATK header files is the same as
or newer than the passed-in version.</doc>
<parameters>
<parameter name="major">
<doc xml:space="preserve">major version (e.g. 1 for version 1.2.5)</doc>
</parameter>
<parameter name="minor">
<doc xml:space="preserve">minor version (e.g. 2 for version 1.2.5)</doc>
</parameter>
<parameter name="micro">
<doc xml:space="preserve">micro version (e.g. 5 for version 1.2.5)</doc>
</parameter>
</parameters>
</function-macro>
<function-macro name="COMPONENT" c:identifier="ATK_COMPONENT" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="COMPONENT_GET_IFACE" c:identifier="ATK_COMPONENT_GET_IFACE" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<interface name="Component" c:symbol-prefix="component" c:type="AtkComponent" glib:type-name="AtkComponent" glib:get-type="atk_component_get_type" glib:type-struct="ComponentIface">
<doc xml:space="preserve">#AtkComponent should be implemented by most if not all UI elements
with an actual on-screen presence, i.e. components which can be
said to have a screen-coordinate bounding box. Virtually all
widgets will need to have #AtkComponent implementations provided
for their corresponding #AtkObject class. In short, only UI
elements which are *not* GUI elements will omit this ATK interface.
A possible exception might be textual information with a
transparent background, in which case text glyph bounding box
information is provided by #AtkText.</doc>
<virtual-method name="add_focus_handler" invoker="add_focus_handler" introspectable="0" deprecated="1" deprecated-version="2.9.4">
<doc xml:space="preserve">Add the specified handler to the set of functions to be called
when this object receives focus events (in or out). If the handler is
already added it is not added again</doc>
<doc-deprecated xml:space="preserve">If you need to track when an object gains or
lose the focus, use the #AtkObject::state-change "focused" notification instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a handler id which can be used in atk_component_remove_focus_handler()
or zero if the handler was already added.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">The #AtkComponent to attach the @handler to</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="handler" transfer-ownership="none">
<doc xml:space="preserve">The #AtkFocusHandler to be attached to @component</doc>
<type name="FocusHandler" c:type="AtkFocusHandler"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="bounds_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="bounds" transfer-ownership="none">
<type name="Rectangle" c:type="AtkRectangle*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="contains" invoker="contains">
<doc xml:space="preserve">Checks whether the specified point is within the extent of the @component.
Toolkit implementor note: ATK provides a default implementation for
this virtual method. In general there are little reason to
re-implement it.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE or %FALSE indicating whether the specified point is within
the extent of the @component or not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">the #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">x coordinate</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">y coordinate</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="coord_type" transfer-ownership="none">
<doc xml:space="preserve">specifies whether the coordinates are relative to the screen
or to the components top level window</doc>
<type name="CoordType" c:type="AtkCoordType"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_alpha" invoker="get_alpha" version="1.12">
<doc xml:space="preserve">Returns the alpha value (i.e. the opacity) for this
@component, on a scale from 0 (fully transparent) to 1.0
(fully opaque).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">An alpha value from 0 to 1.0, inclusive.</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">an #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="get_extents" invoker="get_extents">
<doc xml:space="preserve">Gets the rectangle which gives the extent of the @component.
If the extent can not be obtained (e.g. a non-embedded plug or missing
support), all of x, y, width, height are set to -1.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">an #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="x" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
<doc xml:space="preserve">address of #gint to put x coordinate</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="y" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
<doc xml:space="preserve">address of #gint to put y coordinate</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="width" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
<doc xml:space="preserve">address of #gint to put width</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="height" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
<doc xml:space="preserve">address of #gint to put height</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="coord_type" transfer-ownership="none">
<doc xml:space="preserve">specifies whether the coordinates are relative to the screen
or to the components top level window</doc>
<type name="CoordType" c:type="AtkCoordType"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_layer" invoker="get_layer">
<doc xml:space="preserve">Gets the layer of the component.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">an #AtkLayer which is the layer of the component</doc>
<type name="Layer" c:type="AtkLayer"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">an #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="get_mdi_zorder" invoker="get_mdi_zorder">
<doc xml:space="preserve">Gets the zorder of the component. The value G_MININT will be returned
if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a gint which is the zorder of the component, i.e. the depth at
which the component is shown in relation to other components in the same
container.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">an #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="get_position" invoker="get_position" deprecated="1">
<doc xml:space="preserve">Gets the position of @component in the form of
a point specifying @component's top-left corner.
If the position can not be obtained (e.g. a non-embedded plug or missing
support), x and y are set to -1.</doc>
<doc-deprecated xml:space="preserve">Since 2.12. Use atk_component_get_extents() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">an #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="x" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
<doc xml:space="preserve">address of #gint to put x coordinate position</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="y" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
<doc xml:space="preserve">address of #gint to put y coordinate position</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="coord_type" transfer-ownership="none">
<doc xml:space="preserve">specifies whether the coordinates are relative to the screen
or to the components top level window</doc>
<type name="CoordType" c:type="AtkCoordType"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_size" invoker="get_size" deprecated="1">
<doc xml:space="preserve">Gets the size of the @component in terms of width and height.
If the size can not be obtained (e.g. a non-embedded plug or missing
support), width and height are set to -1.</doc>
<doc-deprecated xml:space="preserve">Since 2.12. Use atk_component_get_extents() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">an #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="width" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
<doc xml:space="preserve">address of #gint to put width of @component</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="height" direction="out" caller-allocates="0" transfer-ownership="full" optional="1" allow-none="1">
<doc xml:space="preserve">address of #gint to put height of @component</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="grab_focus" invoker="grab_focus">
<doc xml:space="preserve">Grabs focus for this @component.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if successful, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">an #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="ref_accessible_at_point" invoker="ref_accessible_at_point">
<doc xml:space="preserve">Gets a reference to the accessible child, if one exists, at the
coordinate point specified by @x and @y.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a reference to the accessible
child, if one exists</doc>
<type name="Object" c:type="AtkObject*"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">the #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">x coordinate</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">y coordinate</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="coord_type" transfer-ownership="none">
<doc xml:space="preserve">specifies whether the coordinates are relative to the screen
or to the components top level window</doc>
<type name="CoordType" c:type="AtkCoordType"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="remove_focus_handler" invoker="remove_focus_handler" deprecated="1" deprecated-version="2.9.4">
<doc xml:space="preserve">Remove the handler specified by @handler_id from the list of
functions to be executed when this object receives focus events
(in or out).</doc>
<doc-deprecated xml:space="preserve">If you need to track when an object gains or
lose the focus, use the #AtkObject::state-change "focused" notification instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">the #AtkComponent to remove the focus handler from</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="handler_id" transfer-ownership="none">
<doc xml:space="preserve">the handler id of the focus handler to be removed
from @component</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="scroll_to" invoker="scroll_to" version="2.30">
<doc xml:space="preserve">Makes @component visible on the screen by scrolling all necessary parents.
Contrary to atk_component_set_position, this does not actually move
@component in its parent, this only makes the parents scroll so that the
object shows up on the screen, given its current position within the parents.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether scrolling was successful.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">an #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">specify where the object should be made visible.</doc>
<type name="ScrollType" c:type="AtkScrollType"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="scroll_to_point" invoker="scroll_to_point" version="2.30">
<doc xml:space="preserve">Move the top-left of @component to a given position of the screen by
scrolling all necessary parents.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether scrolling was successful.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">an #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="coords" transfer-ownership="none">
<doc xml:space="preserve">specify whether coordinates are relative to the screen or to the
parent object.</doc>
<type name="CoordType" c:type="AtkCoordType"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">x-position where to scroll to</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">y-position where to scroll to</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_extents" invoker="set_extents">
<doc xml:space="preserve">Sets the extents of @component.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE or %FALSE whether the extents were set or not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">an #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">x coordinate</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">y coordinate</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">width to set for @component</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">height to set for @component</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="coord_type" transfer-ownership="none">
<doc xml:space="preserve">specifies whether the coordinates are relative to the screen
or to the components top level window</doc>
<type name="CoordType" c:type="AtkCoordType"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_position" invoker="set_position">
<doc xml:space="preserve">Sets the position of @component.
Contrary to atk_component_scroll_to, this does not trigger any scrolling,
this just moves @component in its parent.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE or %FALSE whether or not the position was set or not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="component" transfer-ownership="none">
<doc xml:space="preserve">an #AtkComponent</doc>
<type name="Component" c:type="AtkComponent*"/>
</instance-parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">x coordinate</doc>