« back to all changes in this revision
Viewing changes to atk/src/atk_docs.xml
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Krzysztof Klimonda
- Date: 2010-11-02 20:35:53 UTC
- Revision ID: james.westby@ubuntu.com-20101102203553-syno2w6yedmcdgk8
Import upstream version 2.22.1
- files added:
- MSVC_Net2005
- MSVC_Net2005/atkmm
- MSVC_Net2005/gendef
- MSVC_Net2008
- MSVC_Net2008/atkmm
- MSVC_Net2008/gendef
- MSVC_Net2010
- MSVC_Net2010/atkmm
- MSVC_Net2010/gendef
- atk
- atk/atkmm
- atk/atkmm/private
- atk/src
- build
- codegen
- codegen/extradefs
- codegen/m4
- doc
- doc/reference
- doc/reference/html
added
removed
atk/src/atk_docs.xml
1
<root>
2
<function name="atk_text_get_selection">
3
<description>
4
Gets the text from the specified selection.
5
6
7
</description>
8
<parameters>
9
<parameter name="text">
10
<parameter_description> an #AtkText
11
</parameter_description>
12
</parameter>
13
<parameter name="selection_num">
14
<parameter_description> The selection number. The selected regions are
15
assigned numbers that correspond to how far the region is from the
16
start of the text. The selected region closest to the beginning
17
of the text region is assigned the number 0, etc. Note that adding,
18
moving or deleting a selected region can change the numbering.
19
</parameter_description>
20
</parameter>
21
<parameter name="start_offset">
22
<parameter_description> passes back the start position of the selected region
23
</parameter_description>
24
</parameter>
25
<parameter name="end_offset">
26
<parameter_description> passes back the end position of (e.g. offset immediately past)
27
the selected region
28
</parameter_description>
29
</parameter>
30
</parameters>
31
<return> the selected text.
32
</return>
33
</function>
34
35
<function name="atk_image_get_image_position">
36
<description>
37
Gets the position of the image in the form of a point specifying the
38
images top-left corner.
39
40
</description>
41
<parameters>
42
<parameter name="image">
43
<parameter_description> a #GObject instance that implements AtkImageIface
44
</parameter_description>
45
</parameter>
46
<parameter name="x">
47
<parameter_description> address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained.
48
</parameter_description>
49
</parameter>
50
<parameter name="y">
51
<parameter_description> address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained.
52
</parameter_description>
53
</parameter>
54
<parameter name="coord_type">
55
<parameter_description> specifies whether the coordinates are relative to the screen
56
or to the components top level window
57
</parameter_description>
58
</parameter>
59
</parameters>
60
<return></return>
61
</function>
62
63
<function name="atk_table_set_column_header">
64
<description>
65
Sets the specified column header to @header.
66
67
</description>
68
<parameters>
69
<parameter name="table">
70
<parameter_description> a GObject instance that implements AtkTableIface
71
</parameter_description>
72
</parameter>
73
<parameter name="column">
74
<parameter_description> a #gint representing a column in @table
75
</parameter_description>
76
</parameter>
77
<parameter name="header">
78
<parameter_description> an #AtkTable
79
</parameter_description>
80
</parameter>
81
</parameters>
82
<return></return>
83
</function>
84
85
<function name="atk_table_is_row_selected">
86
<description>
87
Gets a boolean value indicating whether the specified @row
88
is selected
89
90
91
</description>
92
<parameters>
93
<parameter name="table">
94
<parameter_description> a GObject instance that implements AtkTableIface
95
</parameter_description>
96
</parameter>
97
<parameter name="row">
98
<parameter_description> a #gint representing a row in @table
99
</parameter_description>
100
</parameter>
101
</parameters>
102
<return> a gboolean representing if the row is selected, or 0
103
if value does not implement this interface.
104
</return>
105
</function>
106
107
<function name="atk_table_get_n_rows">
108
<description>
109
Gets the number of rows in the table.
110
111
112
</description>
113
<parameters>
114
<parameter name="table">
115
<parameter_description> a GObject instance that implements AtkTableIface
116
</parameter_description>
117
</parameter>
118
</parameters>
119
<return> a gint representing the number of rows, or 0
120
if value does not implement this interface.
121
</return>
122
</function>
123
124
<function name="atk_object_ref_state_set">
125
<description>
126
Gets a reference to the state set of the accessible; the caller must
127
unreference it when it is no longer needed.
128
129
130
</description>
131
<parameters>
132
<parameter name="accessible">
133
<parameter_description> an #AtkObject
134
</parameter_description>
135
</parameter>
136
</parameters>
137
<return> a reference to an #AtkStateSet which is the state
138
set of the accessible
139
</return>
140
</function>
141
142
<function name="atk_hyperlink_get_n_anchors">
143
<description>
144
Gets the number of anchors associated with this hyperlink.
145
146
147
</description>
148
<parameters>
149
<parameter name="link_">
150
<parameter_description> an #AtkHyperlink
151
</parameter_description>
152
</parameter>
153
</parameters>
154
<return> the number of anchors associated with this hyperlink
155
</return>
156
</function>
157
158
<function name="atk_object_set_description">
159
<description>
160
Sets the accessible description of the accessible.
161
162
</description>
163
<parameters>
164
<parameter name="accessible">
165
<parameter_description> an #AtkObject
166
</parameter_description>
167
</parameter>
168
<parameter name="description">
169
<parameter_description> a character string to be set as the accessible description
170
</parameter_description>
171
</parameter>
172
</parameters>
173
<return></return>
174
</function>
175
176
<function name="atk_state_type_register">
177
<description>
178
Register a new object state.
179
180
181
</description>
182
<parameters>
183
<parameter name="name">
184
<parameter_description> a character string describing the new state.
185
</parameter_description>
186
</parameter>
187
</parameters>
188
<return> an #AtkState value for the new state.
189
</return>
190
</function>
191
192
<function name="atk_component_get_mdi_zorder">
193
<description>
194
Gets the zorder of the component. The value G_MININT will be returned
195
if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.
196
197
198
</description>
199
<parameters>
200
<parameter name="component">
201
<parameter_description> an #AtkComponent
202
</parameter_description>
203
</parameter>
204
</parameters>
205
<return> a gint which is the zorder of the component, i.e. the depth at
206
which the component is shown in relation to other components in the same
207
container.
208
</return>
209
</function>
210
211
<function name="atk_focus_tracker_notify">
212
<description>
213
Cause the focus tracker functions which have been specified to be
214
executed for the object.
215
216
</description>
217
<parameters>
218
<parameter name="object">
219
<parameter_description> an #AtkObject
220
</parameter_description>
221
</parameter>
222
</parameters>
223
<return></return>
224
</function>
225
226
<function name="atk_image_set_image_description">
227
<description>
228
Sets the textual description for this image.
229
230
231
</description>
232
<parameters>
233
<parameter name="image">
234
<parameter_description> a #GObject instance that implements AtkImageIface
235
</parameter_description>
236
</parameter>
237
<parameter name="description">
238
<parameter_description> a string description to set for @image
239
</parameter_description>
240
</parameter>
241
</parameters>
242
<return> boolean TRUE, or FALSE if operation could
243
not be completed.
244
</return>
245
</function>
246
247
<function name="atk_state_type_get_name">
248
<description>
249
Gets the description string describing the #AtkStateType @type.
250
251
252
</description>
253
<parameters>
254
<parameter name="type">
255
<parameter_description> The #AtkStateType whose name is required
256
</parameter_description>
257
</parameter>
258
</parameters>
259
<return> the string describing the AtkStateType
260
</return>
261
</function>
262
263
<function name="atk_hyperlink_get_start_index">
264
<description>
265
Gets the index with the hypertext document at which this link begins.
266
267
268
</description>
269
<parameters>
270
<parameter name="link_">
271
<parameter_description> an #AtkHyperlink
272
</parameter_description>
273
</parameter>
274
</parameters>
275
<return> the index with the hypertext document at which this link begins
276
</return>
277
</function>
278
279
<function name="atk_object_get_layer">
280
<description>
281
Gets the layer of the accessible.
282
283
Deprecated: Use atk_component_get_layer instead.
284
285
286
</description>
287
<parameters>
288
<parameter name="accessible">
289
<parameter_description> an #AtkObject
290
</parameter_description>
291
</parameter>
292
</parameters>
293
<return> an #AtkLayer which is the layer of the accessible
294
</return>
295
</function>
296
297
<function name="atk_table_get_column_header">
298
<description>
299
Gets the column header of a specified column in an accessible table.
300
301
302
</description>
303
<parameters>
304
<parameter name="table">
305
<parameter_description> a GObject instance that implements AtkTableIface
306
</parameter_description>
307
</parameter>
308
<parameter name="column">
309
<parameter_description> a #gint representing a column in the table
310
</parameter_description>
311
</parameter>
312
</parameters>
313
<return> a AtkObject* representing the specified column header, or
314
%NULL if value does not implement this interface.
315
</return>
316
</function>
317
318
<function name="atk_implementor_ref_accessible">
319
<description>
320
Gets a reference to an object's #AtkObject implementation, if
321
the object implements #AtkObjectIface
322
323
324
</description>
325
<parameters>
326
<parameter name="implementor">
327
<parameter_description> The #GObject instance which should implement #AtkImplementorIface
328
if a non-null return value is required.
329
</parameter_description>
330
</parameter>
331
</parameters>
332
<return> a reference to an object's #AtkObject implementation
333
</return>
334
</function>
335
336
<function name="atk_hyperlink_is_valid">
337
<description>
338
Since the document that a link is associated with may have changed
339
this method returns %TRUE if the link is still valid (with
340
respect to the document it references) and %FALSE otherwise.
341
342
343
</description>
344
<parameters>
345
<parameter name="link_">
346
<parameter_description> an #AtkHyperlink
347
</parameter_description>
348
</parameter>
349
</parameters>
350
<return> whether or not this link is still valid
351
</return>
352
</function>
353
354
<function name="atk_text_get_offset_at_point">
355
<description>
356
Gets the offset of the character located at coordinates @x and @y. @x and @y
357
are interpreted as being relative to the screen or this widget's window
358
depending on @coords.
359
360
361
</description>
362
<parameters>
363
<parameter name="text">
364
<parameter_description> an #AtkText
365
</parameter_description>
366
</parameter>
367
<parameter name="x">
368
<parameter_description> screen x-position of character
369
</parameter_description>
370
</parameter>
371
<parameter name="y">
372
<parameter_description> screen y-position of character
373
</parameter_description>
374
</parameter>
375
<parameter name="coords">
376
<parameter_description> specify whether coordinates are relative to the screen or
377
widget window
378
</parameter_description>
379
</parameter>
380
</parameters>
381
<return> the offset to the character which is located at
382
the specified @x and @y coordinates.
383
</return>
384
</function>
385
386
<function name="atk_object_set_role">
387
<description>
388
Sets the role of the accessible.
389
390
</description>
391
<parameters>
392
<parameter name="accessible">
393
<parameter_description> an #AtkObject
394
</parameter_description>
395
</parameter>
396
<parameter name="role">
397
<parameter_description> an #AtkRole to be set as the role
398
</parameter_description>
399
</parameter>
400
</parameters>
401
<return></return>
402
</function>
403
404
<function name="atk_text_get_n_selections">
405
<description>
406
Gets the number of selected regions.
407
408
409
</description>
410
<parameters>
411
<parameter name="text">
412
<parameter_description> an #AtkText
413
</parameter_description>
414
</parameter>
415
</parameters>
416
<return> The number of selected regions, or -1 if a failure
417
occurred.
418
</return>
419
</function>
420
421
<function name="atk_hyperlink_impl_get_hyperlink">
422
<description>
423
Gets the hyperlink associated with this object.
424
425
Since: 1.12
426
427
</description>
428
<parameters>
429
<parameter name="obj">
430
<parameter_description> a GObject instance that implements AtkHyperlinkImplIface
431
</parameter_description>
432
</parameter>
433
</parameters>
434
<return>an AtkHyperlink object which points to this implementing AtkObject.
435
436
</return>
437
</function>
438
439
<function name="atk_text_get_run_attributes">
440
<description>
441
Creates an #AtkAttributeSet which consists of the attributes explicitly
442
set at the position @offset in the text. @start_offset and @end_offset are
443
set to the start and end of the range around @offset where the attributes are
444
invariant. Note that @end_offset is the offset of the first character
445
after the range. See the enum AtkTextAttribute for types of text
446
attributes that can be returned. Note that other attributes may also be
447
returned.
448
449
450
</description>
451
<parameters>
452
<parameter name="text">
453
<parameter_description> an #AtkText
454
</parameter_description>
455
</parameter>
456
<parameter name="offset">
457
<parameter_description> the offset at which to get the attributes, -1 means the offset of
458
the character to be inserted at the caret location.
459
</parameter_description>
460
</parameter>
461
<parameter name="start_offset">
462
<parameter_description> the address to put the start offset of the range
463
</parameter_description>
464
</parameter>
465
<parameter name="end_offset">
466
<parameter_description> the address to put the end offset of the range
467
</parameter_description>
468
</parameter>
469
</parameters>
470
<return> an #AtkAttributeSet which contains the attributes explicitly set
471
at @offset. This #AtkAttributeSet should be freed by a call to
472
atk_attribute_set_free().
473
</return>
474
</function>
475
476
<function name="atk_table_get_caption">
477
<description>
478
Gets the caption for the @table.
479
480
481
</description>
482
<parameters>
483
<parameter name="table">
484
<parameter_description> a GObject instance that implements AtkTableInterface
485
</parameter_description>
486
</parameter>
487
</parameters>
488
<return> a AtkObject* representing the table caption, or %NULL
489
if value does not implement this interface.
490
</return>
491
</function>
492
493
<function name="atk_component_ref_accessible_at_point">
494
<description>
495
Gets a reference to the accessible child, if one exists, at the
496
coordinate point specified by @x and @y.
497
498
499
</description>
500
<parameters>
501
<parameter name="component">
502
<parameter_description> the #AtkComponent
503
</parameter_description>
504
</parameter>
505
<parameter name="x">
506
<parameter_description> x coordinate
507
</parameter_description>
508
</parameter>
509
<parameter name="y">
510
<parameter_description> y coordinate
511
</parameter_description>
512
</parameter>
513
<parameter name="coord_type">
514
<parameter_description> specifies whether the coordinates are relative to the screen
515
or to the components top level window
516
</parameter_description>
517
</parameter>
518
</parameters>
519
<return> a reference to the accessible child, if one exists
520
</return>
521
</function>
522
523
<function name="atk_add_focus_tracker">
524
<description>
525
Adds the specified function to the list of functions to be called
526
when an object receives focus.
527
528
529
</description>
530
<parameters>
531
<parameter name="focus_tracker">
532
<parameter_description> Function to be added to the list of functions to be called
533
when an object receives focus.
534
</parameter_description>
535
</parameter>
536
</parameters>
537
<return> added focus tracker id, or 0 on failure.
538
</return>
539
</function>
540
541
<function name="atk_table_set_summary">
542
<description>
543
Sets the summary description of the table.
544
545
</description>
546
<parameters>
547
<parameter name="table">
548
<parameter_description> a GObject instance that implements AtkTableIface
549
</parameter_description>
550
</parameter>
551
<parameter name="accessible">
552
<parameter_description> an #AtkObject representing the summary description
553
to set for @table
554
</parameter_description>
555
</parameter>
556
</parameters>
557
<return></return>
558
</function>
559
560
<function name="atk_component_add_focus_handler">
561
<description>
562
Add the specified handler to the set of functions to be called
563
when this object receives focus events (in or out). If the handler is
564
already added it is not added again
565
566
567
</description>
568
<parameters>
569
<parameter name="component">
570
<parameter_description> The #AtkComponent to attach the @handler to
571
</parameter_description>
572
</parameter>
573
<parameter name="handler">
574
<parameter_description> The #AtkFocusHandler to be attached to @component
575
</parameter_description>
576
</parameter>
577
</parameters>
578
<return> a handler id which can be used in atk_component_remove_focus_handler
579
or zero if the handler was already added.
580
</return>
581
</function>
582
583
<function name="atk_editable_text_cut_text">
584
<description>
585
Copy text from @start_pos up to, but not including @end_pos
586
to the clipboard and then delete from the widget.
587
588
</description>
589
<parameters>
590
<parameter name="text">
591
<parameter_description> an #AtkEditableText
592
</parameter_description>
593
</parameter>
594
<parameter name="start_pos">
595
<parameter_description> start position
596
</parameter_description>
597
</parameter>
598
<parameter name="end_pos">
599
<parameter_description> end position
600
</parameter_description>
601
</parameter>
602
</parameters>
603
<return></return>
604
</function>
605
606
<function name="atk_gobject_accessible_for_object">
607
<description>
608
Gets the accessible object for the specified @obj.
609
610
611
</description>
612
<parameters>
613
<parameter name="obj">
614
<parameter_description> a #GObject
615
</parameter_description>
616
</parameter>
617
</parameters>
618
<return> a #AtkObject which is the accessible object for the @obj
619
</return>
620
</function>
621
622
<function name="atk_table_get_column_description">
623
<description>
624
Gets the description text of the specified @column in the table
625
626
627
</description>
628
<parameters>
629
<parameter name="table">
630
<parameter_description> a GObject instance that implements AtkTableIface
631
</parameter_description>
632
</parameter>
633
<parameter name="column">
634
<parameter_description> a #gint representing a column in @table
635
</parameter_description>
636
</parameter>
637
</parameters>
638
<return> a gchar* representing the column description, or %NULL
639
if value does not implement this interface.
640
</return>
641
</function>
642
643
<function name="atk_text_get_character_at_offset">
644
<description>
645
Gets the specified text.
646
647
648
</description>
649
<parameters>
650
<parameter name="text">
651
<parameter_description> an #AtkText
652
</parameter_description>
653
</parameter>
654
<parameter name="offset">
655
<parameter_description> position
656
</parameter_description>
657
</parameter>
658
</parameters>
659
<return> the character at @offset.
660
</return>
661
</function>
662
663
<function name="atk_no_op_object_factory_new">
664
<description>
665
Creates an instance of an #AtkObjectFactory which generates primitive
666
(non-functioning) #AtkObjects.
667
668
669
</description>
670
<parameters>
671
</parameters>
672
<return> an instance of an #AtkObjectFactory
673
</return>
674
</function>
675
676
<function name="atk_value_get_minimum_increment">
677
<description>
678
Gets the minimum increment by which the value of this object may be changed. If zero,
679
the minimum increment is undefined, which may mean that it is limited only by the
680
floating point precision of the platform.
681
682
Since: 1.12
683
684
</description>
685
<parameters>
686
<parameter name="obj">
687
<parameter_description> a GObject instance that implements AtkValueIface
688
</parameter_description>
689
</parameter>
690
<parameter name="value">
691
<parameter_description> a #GValue representing the minimum increment by which the accessible value may be changed
692
</parameter_description>
693
</parameter>
694
</parameters>
695
<return></return>
696
</function>
697
698
<function name="atk_role_get_name">
699
<description>
700
Gets the description string describing the #AtkRole @role.
701
702
703
</description>
704
<parameters>
705
<parameter name="role">
706
<parameter_description> The #AtkRole whose name is required
707
</parameter_description>
708
</parameter>
709
</parameters>
710
<return> the string describing the AtkRole
711
</return>
712
</function>
713
714
<function name="atk_object_get_attributes">
715
<description>
716
Get a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of
717
name-value pairs. As such these attributes may be considered weakly-typed properties or annotations,
718
as distinct from strongly-typed object data available via other get/set methods.
719
Not all objects have explicit "name-value pair" #AtkAttributeSet properties.
720
721
Since: 1.12
722
723
724
</description>
725
<parameters>
726
<parameter name="accessible">
727
<parameter_description> An #AtkObject.
728
</parameter_description>
729
</parameter>
730
</parameters>
731
<return> an #AtkAttributeSet consisting of all explicit properties/annotations applied to
732
the object, or an empty set if the object has no name-value pair attributes assigned to it.
733
</return>
734
</function>
735
736
<function name="atk_text_get_default_attributes">
737
<description>
738
Creates an #AtkAttributeSet which consists of the default values of
739
attributes for the text. See the enum AtkTextAttribute for types of text
740
attributes that can be returned. Note that other attributes may also be
741
returned.
742
743
744
</description>
745
<parameters>
746
<parameter name="text">
747
<parameter_description> an #AtkText
748
</parameter_description>
749
</parameter>
750
</parameters>
751
<return> an #AtkAttributeSet which contains the default values of attributes.
752
at @offset. This #AtkAttributeSet should be freed by a call to
753
atk_attribute_set_free().
754
</return>
755
</function>
756
757
<function name="atk_text_set_selection">
758
<description>
759
Changes the start and end offset of the specified selection.
760
761
762
</description>
763
<parameters>
764
<parameter name="text">
765
<parameter_description> an #AtkText
766
</parameter_description>
767
</parameter>
768
<parameter name="selection_num">
769
<parameter_description> The selection number. The selected regions are
770
assigned numbers that correspond to how far the region is from the
771
start of the text. The selected region closest to the beginning
772
of the text region is assigned the number 0, etc. Note that adding,
773
moving or deleting a selected region can change the numbering.
774
</parameter_description>
775
</parameter>
776
<parameter name="start_offset">
777
<parameter_description> the new start position of the selection
778
</parameter_description>
779
</parameter>
780
<parameter name="end_offset">
781
<parameter_description> the new end position of (e.g. offset immediately past)
782
the selection
783
</parameter_description>
784
</parameter>
785
</parameters>
786
<return> %TRUE if success, %FALSE otherwise
787
</return>
788
</function>
789
790
<function name="atk_streamable_content_get_n_mime_types">
791
<description>
792
Gets the number of mime types supported by this object.
793
794
795
</description>
796
<parameters>
797
<parameter name="streamable">
798
<parameter_description> a GObject instance that implements AtkStreamableContentIface
799
</parameter_description>
800
</parameter>
801
</parameters>
802
<return> a gint which is the number of mime types supported by the object.
803
</return>
804
</function>
805
806
<function name="atk_relation_get_relation_type">
807
<description>
808
Gets the type of @relation
809
810
811
</description>
812
<parameters>
813
<parameter name="relation">
814
<parameter_description> an #AtkRelation
815
</parameter_description>
816
</parameter>
817
</parameters>
818
<return> the type of @relation
819
</return>
820
</function>
821
822
<function name="atk_editable_text_paste_text">
823
<description>
824
Paste text from clipboard to specified @position.
825
826
</description>
827
<parameters>
828
<parameter name="text">
829
<parameter_description> an #AtkEditableText
830
</parameter_description>
831
</parameter>
832
<parameter name="position">
833
<parameter_description> position to paste
834
</parameter_description>
835
</parameter>
836
</parameters>
837
<return></return>
838
</function>
839
840
<function name="atk_misc_threads_enter">
841
<description>
842
Take the thread mutex for the GUI toolkit,
843
if one exists.
844
(This method is implemented by the toolkit ATK implementation layer;
845
for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER).
846
847
Since: 1.13
848
849
850
</description>
851
<parameters>
852
<parameter name="misc">
853
<parameter_description> an AtkMisc instance for this application.
854
</parameter_description>
855
</parameter>
856
</parameters>
857
<return></return>
858
</function>
859
860
<function name="atk_object_factory_get_accessible_type">
861
<description>
862
Gets the GType of the accessible which is created by the factory.
863
864
</description>
865
<parameters>
866
<parameter name="factory">
867
<parameter_description> an #AtkObjectFactory
868
</parameter_description>
869
</parameter>
870
</parameters>
871
<return> the type of the accessible which is created by the @factory.
872
The value G_TYPE_INVALID is returned if no type if found.
873
</return>
874
</function>
875
876
<function name="atk_component_get_layer">
877
<description>
878
Gets the layer of the component.
879
880
881
</description>
882
<parameters>
883
<parameter name="component">
884
<parameter_description> an #AtkComponent
885
</parameter_description>
886
</parameter>
887
</parameters>
888
<return> an #AtkLayer which is the layer of the component
889
</return>
890
</function>
891
892
<function name="atk_text_get_range_extents">
893
<description>
894
Get the bounding box for text within the specified range.
895
896
Since: 1.3
897
898
</description>
899
<parameters>
900
<parameter name="text">
901
<parameter_description> an #AtkText
902
</parameter_description>
903
</parameter>
904
<parameter name="start_offset">
905
<parameter_description> The offset of the first text character for which boundary
906
information is required.
907
</parameter_description>
908
</parameter>
909
<parameter name="end_offset">
910
<parameter_description> The offset of the text character after the last character
911
for which boundary information is required.
912
</parameter_description>
913
</parameter>
914
<parameter name="coord_type">
915
<parameter_description> Specify whether coordinates are relative to the screen or widget window.
916
</parameter_description>
917
</parameter>
918
<parameter name="rect">
919
<parameter_description> A pointer to a AtkTextRectangle which is filled in by this function.
920
</parameter_description>
921
</parameter>
922
</parameters>
923
<return></return>
924
</function>
925
926
<function name="atk_table_get_column_at_index">
927
<description>
928
Gets a #gint representing the column at the specified @index_.
929
930
931
</description>
932
<parameters>
933
<parameter name="table">
934
<parameter_description> a GObject instance that implements AtkTableInterface
935
</parameter_description>
936
</parameter>
937
<parameter name="index_">
938
<parameter_description> a #gint representing an index in @table
939
</parameter_description>
940
</parameter>
941
</parameters>
942
<return> a gint representing the column at the specified index,
943
or -1 if the table does not implement this interface
944
</return>
945
</function>
946
947
<function name="atk_object_get_parent">
948
<description>
949
Gets the accessible parent of the accessible.
950
951
952
</description>
953
<parameters>
954
<parameter name="accessible">
955
<parameter_description> an #AtkObject
956
</parameter_description>
957
</parameter>
958
</parameters>
959
<return> a #AtkObject representing the accessible parent of the accessible
960
</return>
961
</function>
962
963
<function name="atk_selection_is_child_selected">
964
<description>
965
Determines if the current child of this object is selected
966
Note: callers should not rely on %NULL or on a zero value for
967
indication of whether AtkSelectionIface is implemented, they should
968
use type checking/interface checking macros or the
969
atk_get_accessible_value() convenience method.
970
971
972
</description>
973
<parameters>
974
<parameter name="selection">
975
<parameter_description> a #GObject instance that implements AtkSelectionIface
976
</parameter_description>
977
</parameter>
978
<parameter name="i">
979
<parameter_description> a #gint specifying the child index.
980
</parameter_description>
981
</parameter>
982
</parameters>
983
<return> a gboolean representing the specified child is selected, or 0
984
if @selection does not implement this interface.
985
</return>
986
</function>
987
988
<function name="atk_table_is_column_selected">
989
<description>
990
Gets a boolean value indicating whether the specified @column
991
is selected
992
993
994
</description>
995
<parameters>
996
<parameter name="table">
997
<parameter_description> a GObject instance that implements AtkTableIface
998
</parameter_description>
999
</parameter>
1000
<parameter name="column">
1001
<parameter_description> a #gint representing a column in @table
1002
</parameter_description>
1003
</parameter>
1004
</parameters>
1005
<return> a gboolean representing if the column is selected, or 0
1006
if value does not implement this interface.
1007
</return>
1008
</function>
1009
1010
<function name="atk_text_get_character_count">
1011
<description>
1012
Gets the character count.
1013
1014
1015
</description>
1016
<parameters>
1017
<parameter name="text">
1018
<parameter_description> an #AtkText
1019
</parameter_description>
1020
</parameter>
1021
</parameters>
1022
<return> the number of characters.
1023
</return>
1024
</function>
1025
1026
<function name="atk_relation_type_get_name">
1027
<description>
1028
Gets the description string describing the #AtkRelationType @type.
1029
1030
1031
</description>
1032
<parameters>
1033
<parameter name="type">
1034
<parameter_description> The #AtkRelationType whose name is required
1035
</parameter_description>
1036
</parameter>
1037
</parameters>
1038
<return> the string describing the AtkRelationType
1039
</return>
1040
</function>
1041
1042
<function name="atk_table_set_row_header">
1043
<description>
1044
Sets the specified row header to @header.
1045
1046
</description>
1047
<parameters>
1048
<parameter name="table">
1049
<parameter_description> a GObject instance that implements AtkTableIface
1050
</parameter_description>
1051
</parameter>
1052
<parameter name="row">
1053
<parameter_description> a #gint representing a row in @table
1054
</parameter_description>
1055
</parameter>
1056
<parameter name="header">
1057
<parameter_description> an #AtkTable
1058
</parameter_description>
1059
</parameter>
1060
</parameters>
1061
<return></return>
1062
</function>
1063
1064
<function name="atk_gobject_accessible_get_object">
1065
<description>
1066
Gets the GObject for which @obj is the accessible object.
1067
1068
1069
</description>
1070
<parameters>
1071
<parameter name="obj">
1072
<parameter_description> a #AtkGObjectAccessible
1073
</parameter_description>
1074
</parameter>
1075
</parameters>
1076
<return> a #GObject which is the object for which @obj is the accessible object
1077
</return>
1078
</function>
1079
1080
<function name="atk_relation_set_new">
1081
<description>
1082
Creates a new empty relation set.
1083
1084
1085
</description>
1086
<parameters>
1087
</parameters>
1088
<return> a new #AtkRelationSet
1089
</return>
1090
</function>
1091
1092
<function name="atk_text_attribute_register">
1093
<description>
1094
Associate @name with a new #AtkTextAttribute
1095
1096
1097
</description>
1098
<parameters>
1099
<parameter name="name">
1100
<parameter_description> a name string
1101
</parameter_description>
1102
</parameter>
1103
</parameters>
1104
<return> an #AtkTextAttribute associated with @name
1105
</return>
1106
</function>
1107
1108
<function name="atk_object_connect_property_change_handler">
1109
<description>
1110
Specifies a function to be called when a property changes value.
1111
1112
1113
</description>
1114
<parameters>
1115
<parameter name="accessible">
1116
<parameter_description> an #AtkObject
1117
</parameter_description>
1118
</parameter>
1119
<parameter name="handler">
1120
<parameter_description> a function to be called when a property changes its value
1121
</parameter_description>
1122
</parameter>
1123
</parameters>
1124
<return> a #guint which is the handler id used in
1125
atk_object_remove_property_change_handler()
1126
</return>
1127
</function>
1128
1129
<function name="atk_object_set_name">
1130
<description>
1131
Sets the accessible name of the accessible.
1132
1133
</description>
1134
<parameters>
1135
<parameter name="accessible">
1136
<parameter_description> an #AtkObject
1137
</parameter_description>
1138
</parameter>
1139
<parameter name="name">
1140
<parameter_description> a character string to be set as the accessible name
1141
</parameter_description>
1142
</parameter>
1143
</parameters>
1144
<return></return>
1145
</function>
1146
1147
<function name="atk_hyperlink_is_selected_link">
1148
<description>
1149
Determines whether this AtkHyperlink is selected
1150
1151
Since: 1.4
1152
1153
@Deprecated: This method is deprecated since ATK version 1.8.
1154
Please use ATK_STATE_SELECTED to indicate when a hyperlink within a
1155
Hypertext container is selected.
1156
1157
1158
</description>
1159
<parameters>
1160
<parameter name="link_">
1161
<parameter_description> an #AtkHyperlink
1162
</parameter_description>
1163
</parameter>
1164
</parameters>
1165
<return> True is the AtkHyperlink is selected, False otherwise
1166
</return>
1167
</function>
1168
1169
<function name="atk_object_ref_accessible_child">
1170
<description>
1171
Gets a reference to the specified accessible child of the object.
1172
The accessible children are 0-based so the first accessible child is
1173
at index 0, the second at index 1 and so on.
1174
1175
1176
</description>
1177
<parameters>
1178
<parameter name="accessible">
1179
<parameter_description> an #AtkObject
1180
</parameter_description>
1181
</parameter>
1182
<parameter name="i">
1183
<parameter_description> a gint representing the position of the child, starting from 0
1184
</parameter_description>
1185
</parameter>
1186
</parameters>
1187
<return> an #AtkObject representing the specified accessible child
1188
of the accessible.
1189
</return>
1190
</function>
1191
1192
<function name="atk_document_get_attribute_value">
1193
<description>
1194
Since: 1.12
1195
1196
1197
</description>
1198
<parameters>
1199
<parameter name="document">
1200
<parameter_description> a #GObject instance that implements AtkDocumentIface
1201
</parameter_description>
1202
</parameter>
1203
<parameter name="attribute_name">
1204
<parameter_description> a character string representing the name of the attribute
1205
whose value is being queried.
1206
</parameter_description>
1207
</parameter>
1208
</parameters>
1209
<return> a string value associated with the named attribute for this
1210
document, or NULL if a value for #attribute_name has not been specified
1211
for this document.
1212
</return>
1213
</function>
1214
1215
<function name="atk_relation_set_get_relation">
1216
<description>
1217
Determines the relation at the specified position in the relation set.
1218
1219
1220
</description>
1221
<parameters>
1222
<parameter name="set">
1223
<parameter_description> an #AtkRelationSet
1224
</parameter_description>
1225
</parameter>
1226
<parameter name="i">
1227
<parameter_description> a gint representing a position in the set, starting from 0.
1228
</parameter_description>
1229
</parameter>
1230
</parameters>
1231
<return> a #AtkRelation, which is the relation at position i in the set.
1232
</return>
1233
</function>
1234
1235
<function name="atk_table_remove_row_selection">
1236
<description>
1237
Removes the specified @row from the selection.
1238
1239
1240
</description>
1241
<parameters>
1242
<parameter name="table">
1243
<parameter_description> a GObject instance that implements AtkTableIface
1244
</parameter_description>
1245
</parameter>
1246
<parameter name="row">
1247
<parameter_description> a #gint representing a row in @table
1248
</parameter_description>
1249
</parameter>
1250
</parameters>
1251
<return> a gboolean representing if the row was successfully removed from
1252
the selection, or 0 if value does not implement this interface.
1253
</return>
1254
</function>
1255
1256
<function name="atk_state_set_remove_state">
1257
<description>
1258
Removes the state for the specified type from the state set.
1259
1260
1261
</description>
1262
<parameters>
1263
<parameter name="set">
1264
<parameter_description> an #AtkStateSet
1265
</parameter_description>
1266
</parameter>
1267
<parameter name="type">
1268
<parameter_description> an #AtkType
1269
</parameter_description>
1270
</parameter>
1271
</parameters>
1272
<return> %TRUE if @type was the state type is in @set.
1273
</return>
1274
</function>
1275
1276
<function name="atk_text_attribute_for_name">
1277
<description>
1278
Get the #AtkTextAttribute type corresponding to a text attribute name.
1279
1280
1281
</description>
1282
<parameters>
1283
<parameter name="name">
1284
<parameter_description> a string which is the (non-localized) name of an ATK text attribute.
1285
</parameter_description>
1286
</parameter>
1287
</parameters>
1288
<return> the #AtkTextAttribute enumerated type corresponding to the specified
1289
name,
1290
or #ATK_TEXT_ATTRIBUTE_INVALID if no matching text attribute is found.
1291
</return>
1292
</function>
1293
1294
<function name="atk_image_get_image_description">
1295
<description>
1296
Get a textual description of this image.
1297
1298
1299
</description>
1300
<parameters>
1301
<parameter name="image">
1302
<parameter_description> a #GObject instance that implements AtkImageIface
1303
</parameter_description>
1304
</parameter>
1305
</parameters>
1306
<return> a string representing the image description
1307
</return>
1308
</function>
1309
1310
<function name="atk_document_get_document">
1311
<description>
1312
Gets a %gpointer that points to an instance of the DOM. It is
1313
up to the caller to check atk_document_get_type to determine
1314
how to cast this pointer.
1315
1316
1317
</description>
1318
<parameters>
1319
<parameter name="document">
1320
<parameter_description> a #GObject instance that implements AtkDocumentIface
1321
</parameter_description>
1322
</parameter>
1323
</parameters>
1324
<return> a %gpointer that points to an instance of the DOM.
1325
</return>
1326
</function>
1327
1328
<function name="atk_selection_ref_selection">
1329
<description>
1330
Gets a reference to the accessible object representing the specified
1331
selected child of the object.
1332
Note: callers should not rely on %NULL or on a zero value for
1333
indication of whether AtkSelectionIface is implemented, they should
1334
use type checking/interface checking macros or the
1335
atk_get_accessible_value() convenience method.
1336
1337
1338
</description>
1339
<parameters>
1340
<parameter name="selection">
1341
<parameter_description> a #GObject instance that implements AtkSelectionIface
1342
</parameter_description>
1343
</parameter>
1344
<parameter name="i">
1345
<parameter_description> a #gint specifying the index in the selection set. (e.g. the
1346
ith selection as opposed to the ith child).
1347
</parameter_description>
1348
</parameter>
1349
</parameters>
1350
<return> an #AtkObject representing the selected accessible , or %NULL
1351
if @selection does not implement this interface.
1352
</return>
1353
</function>
1354
1355
<function name="atk_remove_focus_tracker">
1356
<description>
1357
Removes the specified focus tracker from the list of functions
1358
to be called when any object receives focus.
1359
1360
</description>
1361
<parameters>
1362
<parameter name="tracker_id">
1363
<parameter_description> the id of the focus tracker to remove
1364
</parameter_description>
1365
</parameter>
1366
</parameters>
1367
<return></return>
1368
</function>
1369
1370
<function name="atk_component_grab_focus">
1371
<description>
1372
Grabs focus for this @component.
1373
1374
1375
</description>
1376
<parameters>
1377
<parameter name="component">
1378
<parameter_description> an #AtkComponent
1379
</parameter_description>
1380
</parameter>
1381
</parameters>
1382
<return> %TRUE if successful, %FALSE otherwise.
1383
</return>
1384
</function>
1385
1386
<function name="atk_relation_type_register">
1387
<description>
1388
Associate @name with a new #AtkRelationType
1389
1390
1391
</description>
1392
<parameters>
1393
<parameter name="name">
1394
<parameter_description> a name string
1395
</parameter_description>
1396
</parameter>
1397
</parameters>
1398
<return> an #AtkRelationType associated with @name
1399
</return>
1400
</function>
1401
1402
<function name="atk_editable_text_set_text_contents">
1403
<description>
1404
Set text contents of @text.
1405
1406
</description>
1407
<parameters>
1408
<parameter name="text">
1409
<parameter_description> an #AtkEditableText
1410
</parameter_description>
1411
</parameter>
1412
<parameter name="string">
1413
<parameter_description> string to set for text contents of @text
1414
</parameter_description>
1415
</parameter>
1416
</parameters>
1417
<return></return>
1418
</function>
1419
1420
<function name="atk_relation_set_add_relation_by_type">
1421
<description>
1422
Add a new relation of the specified type with the specified target to
1423
the current relation set if the relation set does not contain a relation
1424
of that type. If it is does contain a relation of that typea the target
1425
is added to the relation.
1426
1427
Since: 1.9
1428
1429
</description>
1430
<parameters>
1431
<parameter name="set">
1432
<parameter_description> an #AtkRelationSet
1433
</parameter_description>
1434
</parameter>
1435
<parameter name="relationship">
1436
<parameter_description> an #AtkRelationType
1437
</parameter_description>
1438
</parameter>
1439
<parameter name="target">
1440
<parameter_description> an #AtkObject
1441
</parameter_description>
1442
</parameter>
1443
</parameters>
1444
<return></return>
1445
</function>
1446
1447
<function name="atk_object_get_role">
1448
<description>
1449
Gets the role of the accessible.
1450
1451
1452
</description>
1453
<parameters>
1454
<parameter name="accessible">
1455
<parameter_description> an #AtkObject
1456
</parameter_description>
1457
</parameter>
1458
</parameters>
1459
<return> an #AtkRole which is the role of the accessible
1460
</return>
1461
</function>
1462
1463
<function name="atk_add_key_event_listener">
1464
<description>
1465
Adds the specified function to the list of functions to be called
1466
when a key event occurs. The @data element will be passed to the
1467
#AtkKeySnoopFunc (@listener) as the @func_data param, on notification.
1468
1469
1470
</description>
1471
<parameters>
1472
<parameter name="listener">
1473
<parameter_description> the listener to notify
1474
</parameter_description>
1475
</parameter>
1476
<parameter name="data">
1477
<parameter_description> a #gpointer that points to a block of data that should be sent to the registered listeners,
1478
along with the event notification, when it occurs.
1479
</parameter_description>
1480
</parameter>
1481
</parameters>
1482
<return> added event listener id, or 0 on failure.
1483
</return>
1484
</function>
1485
1486
<function name="atk_object_notify_state_change">
1487
<description>
1488
Emits a state-change signal for the specified state.
1489
1490
</description>
1491
<parameters>
1492
<parameter name="accessible">
1493
<parameter_description> an #AtkObject
1494
</parameter_description>
1495
</parameter>
1496
<parameter name="state">
1497
<parameter_description> an #AtkState whose state is changed
1498
</parameter_description>
1499
</parameter>
1500
<parameter name="value">
1501
<parameter_description> a gboolean which indicates whether the state is being set on or off
1502
</parameter_description>
1503
</parameter>
1504
</parameters>
1505
<return></return>
1506
</function>
1507
1508
<function name="atk_table_add_row_selection">
1509
<description>
1510
Adds the specified @row to the selection.
1511
1512
1513
</description>
1514
<parameters>
1515
<parameter name="table">
1516
<parameter_description> a GObject instance that implements AtkTableIface
1517
</parameter_description>
1518
</parameter>
1519
<parameter name="row">
1520
<parameter_description> a #gint representing a row in @table
1521
</parameter_description>
1522
</parameter>
1523
</parameters>
1524
<return> a gboolean representing if row was successfully added to selection,
1525
or 0 if value does not implement this interface.
1526
</return>
1527
</function>
1528
1529
<function name="atk_document_get_document_type">
1530
<description>
1531
Gets a string indicating the document type.
1532
1533
1534
</description>
1535
<parameters>
1536
<parameter name="document">
1537
<parameter_description> a #GObject instance that implements AtkDocumentIface
1538
</parameter_description>
1539
</parameter>
1540
</parameters>
1541
<return> a string indicating the document type
1542
</return>
1543
</function>
1544
1545
<function name="atk_no_op_object_new">
1546
<description>
1547
Provides a default (non-functioning stub) #AtkObject.
1548
Application maintainers should not use this method.
1549
1550
1551
</description>
1552
<parameters>
1553
<parameter name="obj">
1554
<parameter_description> a #GObject
1555
</parameter_description>
1556
</parameter>
1557
</parameters>
1558
<return> a default (non-functioning stub) #AtkObject
1559
</return>
1560
</function>
1561
1562
<function name="atk_get_root">
1563
<description>
1564
Gets the root accessible container for the current application.
1565
1566
1567
</description>
1568
<parameters>
1569
</parameters>
1570
<return> the root accessible container for the current application
1571
</return>
1572
</function>
1573
1574
<function name="atk_relation_remove_target">
1575
<description>
1576
Remove the specified AtkObject from the target for the relation.
1577
1578
1579
</description>
1580
<parameters>
1581
<parameter name="relation">
1582
<parameter_description> an #AtkRelation
1583
</parameter_description>
1584
</parameter>
1585
<parameter name="target">
1586
<parameter_description> an #AtkObject
1587
</parameter_description>
1588
</parameter>
1589
</parameters>
1590
<return>TRUE if the removal is successful.
1591
</return>
1592
</function>
1593
1594
<function name="atk_editable_text_copy_text">
1595
<description>
1596
Copy text from @start_pos up to, but not including @end_pos
1597
to the clipboard.
1598
1599
</description>
1600
<parameters>
1601
<parameter name="text">
1602
<parameter_description> an #AtkEditableText
1603
</parameter_description>
1604
</parameter>
1605
<parameter name="start_pos">
1606
<parameter_description> start position
1607
</parameter_description>
1608
</parameter>
1609
<parameter name="end_pos">
1610
<parameter_description> end position
1611
</parameter_description>
1612
</parameter>
1613
</parameters>
1614
<return></return>
1615
</function>
1616
1617
<function name="atk_object_ref_relation_set">
1618
<description>
1619
Gets the #AtkRelationSet associated with the object.
1620
1621
1622
</description>
1623
<parameters>
1624
<parameter name="accessible">
1625
<parameter_description> an #AtkObject
1626
</parameter_description>
1627
</parameter>
1628
</parameters>
1629
<return> an #AtkRelationSet representing the relation set of the object.
1630
</return>
1631
</function>
1632
1633
<function name="atk_object_factory_create_accessible">
1634
<description>
1635
Provides an #AtkObject that implements an accessibility interface
1636
on behalf of @obj
1637
1638
1639
</description>
1640
<parameters>
1641
<parameter name="factory">
1642
<parameter_description> The #AtkObjectFactory associated with @obj's
1643
object type
1644
</parameter_description>
1645
</parameter>
1646
<parameter name="obj">
1647
<parameter_description> a #GObject
1648
</parameter_description>
1649
</parameter>
1650
</parameters>
1651
<return> an #AtkObject that implements an accessibility interface
1652
on behalf of @obj
1653
</return>
1654
</function>
1655
1656
<function name="atk_table_get_selected_rows">
1657
<description>
1658
Gets the selected rows of the table by initializing **selected with
1659
the selected row numbers. This array should be freed by the caller.
1660
1661
1662
</description>
1663
<parameters>
1664
<parameter name="table">
1665
<parameter_description> a GObject instance that implements AtkTableIface
1666
</parameter_description>
1667
</parameter>
1668
<parameter name="selected">
1669
<parameter_description> a #gint** that is to contain the selected row numbers
1670
</parameter_description>
1671
</parameter>
1672
</parameters>
1673
<return> a gint representing the number of selected rows,
1674
or zero if value does not implement this interface.
1675
</return>
1676
</function>
1677
1678
<function name="atk_state_set_clear_states">
1679
<description>
1680
Removes all states from the state set.
1681
1682
</description>
1683
<parameters>
1684
<parameter name="set">
1685
<parameter_description> an #AtkStateSet
1686
</parameter_description>
1687
</parameter>
1688
</parameters>
1689
<return></return>
1690
</function>
1691
1692
<function name="atk_object_get_index_in_parent">
1693
<description>
1694
Gets the 0-based index of this accessible in its parent; returns -1 if the
1695
accessible does not have an accessible parent.
1696
1697
1698
</description>
1699
<parameters>
1700
<parameter name="accessible">
1701
<parameter_description> an #AtkObject
1702
</parameter_description>
1703
</parameter>
1704
</parameters>
1705
<return> an integer which is the index of the accessible in its parent
1706
</return>
1707
</function>
1708
1709
<function name="atk_text_get_text_at_offset">
1710
<description>
1711
Gets the specified text.
1712
1713
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the
1714
offset is returned.
1715
1716
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
1717
is from the word start at or before the offset to the word start after
1718
the offset.
1719
1720
The returned string will contain the word at the offset if the offset
1721
is inside a word and will contain the word before the offset if the
1722
offset is not inside a word.
1723
1724
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
1725
is from the word end before the offset to the word end at or after the
1726
offset.
1727
1728
The returned string will contain the word at the offset if the offset
1729
is inside a word and will contain the word after to the offset if the
1730
offset is not inside a word.
1731
1732
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
1733
string is from the sentence start at or before the offset to the sentence
1734
start after the offset.
1735
1736
The returned string will contain the sentence at the offset if the offset
1737
is inside a sentence and will contain the sentence before the offset
1738
if the offset is not inside a sentence.
1739
1740
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
1741
is from the sentence end before the offset to the sentence end at or
1742
after the offset.
1743
1744
The returned string will contain the sentence at the offset if the offset
1745
is inside a sentence and will contain the sentence after the offset
1746
if the offset is not inside a sentence.
1747
1748
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
1749
string is from the line start at or before the offset to the line
1750
start after the offset.
1751
1752
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
1753
is from the line end before the offset to the line end at or after
1754
the offset.
1755
1756
1757
</description>
1758
<parameters>
1759
<parameter name="text">
1760
<parameter_description> an #AtkText
1761
</parameter_description>
1762
</parameter>
1763
<parameter name="offset">
1764
<parameter_description> position
1765
</parameter_description>
1766
</parameter>
1767
<parameter name="boundary_type">
1768
<parameter_description> An #AtkTextBoundary
1769
</parameter_description>
1770
</parameter>
1771
<parameter name="start_offset">
1772
<parameter_description> the start offset of the returned string
1773
</parameter_description>
1774
</parameter>
1775
<parameter name="end_offset">
1776
<parameter_description> the offset of the first character after the
1777
returned substring
1778
</parameter_description>
1779
</parameter>
1780
</parameters>
1781
<return> the text at @offset bounded by the specified @boundary_type.
1782
</return>
1783
</function>
1784
1785
<function name="atk_table_add_column_selection">
1786
<description>
1787
Adds the specified @column to the selection.
1788
1789
1790
</description>
1791
<parameters>
1792
<parameter name="table">
1793
<parameter_description> a GObject instance that implements AtkTableIface
1794
</parameter_description>
1795
</parameter>
1796
<parameter name="column">
1797
<parameter_description> a #gint representing a column in @table
1798
</parameter_description>
1799
</parameter>
1800
</parameters>
1801
<return> a gboolean representing if the column was successfully added to
1802
the selection, or 0 if value does not implement this interface.
1803
</return>
1804
</function>
1805
1806
<function name="atk_value_get_minimum_value">
1807
<description>
1808
Gets the minimum value of this object.
1809
1810
</description>
1811
<parameters>
1812
<parameter name="obj">
1813
<parameter_description> a GObject instance that implements AtkValueIface
1814
</parameter_description>
1815
</parameter>
1816
<parameter name="value">
1817
<parameter_description> a #GValue representing the minimum accessible value
1818
</parameter_description>
1819
</parameter>
1820
</parameters>
1821
<return></return>
1822
</function>
1823
1824
<function name="atk_relation_get_target">
1825
<description>
1826
Gets the target list of @relation
1827
1828
1829
</description>
1830
<parameters>
1831
<parameter name="relation">
1832
<parameter_description> an #AtkRelation
1833
</parameter_description>
1834
</parameter>
1835
</parameters>
1836
<return> the target list of @relation
1837
</return>
1838
</function>
1839
1840
<function name="atk_get_focus_object">
1841
<description>
1842
Gets the currently focused object.
1843
1844
Since: 1.6
1845
1846
1847
</description>
1848
<parameters>
1849
</parameters>
1850
<return> the currently focused object for the current application
1851
</return>
1852
</function>
1853
1854
<function name="atk_hypertext_get_link">
1855
<description>
1856
Gets the link in this hypertext document at index
1857
@link_index
1858
1859
1860
</description>
1861
<parameters>
1862
<parameter name="hypertext">
1863
<parameter_description> an #AtkHypertext
1864
</parameter_description>
1865
</parameter>
1866
<parameter name="link_index">
1867
<parameter_description> an integer specifying the desired link
1868
</parameter_description>
1869
</parameter>
1870
</parameters>
1871
<return> the link in this hypertext document at
1872
index @link_index
1873
</return>
1874
</function>
1875
1876
<function name="atk_object_remove_relationship">
1877
<description>
1878
Removes a relationship of the specified type with the specified target.
1879
1880
1881
</description>
1882
<parameters>
1883
<parameter name="object">
1884
<parameter_description> The #AtkObject from which an AtkRelation is to be removed.
1885
</parameter_description>
1886
</parameter>
1887
<parameter name="relationship">
1888
<parameter_description> The #AtkRelationType of the relation
1889
</parameter_description>
1890
</parameter>
1891
<parameter name="target">
1892
<parameter_description> The #AtkObject which is the target of the relation to be removed.
1893
</parameter_description>
1894
</parameter>
1895
</parameters>
1896
<return>TRUE if the relationship is removed.
1897
</return>
1898
</function>
1899
1900
<function name="atk_text_attribute_get_value">
1901
<description>
1902
Gets the value for the index of the #AtkTextAttribute
1903
1904
1905
</description>
1906
<parameters>
1907
<parameter name="attr">
1908
<parameter_description> The #AtkTextAttribute for which a value is required
1909
</parameter_description>
1910
</parameter>
1911
<parameter name="index_">
1912
<parameter_description> The index of the required value
1913
</parameter_description>
1914
</parameter>
1915
</parameters>
1916
<return> a string containing the value; this string should not be freed;
1917
NULL is returned if there are no values maintained for the attr value.
1918
</return>
1919
</function>
1920
1921
<function name="atk_component_contains">
1922
<description>
1923
Checks whether the specified point is within the extent of the @component.
1924
1925
1926
</description>
1927
<parameters>
1928
<parameter name="component">
1929
<parameter_description> the #AtkComponent
1930
</parameter_description>
1931
</parameter>
1932
<parameter name="x">
1933
<parameter_description> x coordinate
1934
</parameter_description>
1935
</parameter>
1936
<parameter name="y">
1937
<parameter_description> y coordinate
1938
</parameter_description>
1939
</parameter>
1940
<parameter name="coord_type">
1941
<parameter_description> specifies whether the coordinates are relative to the screen
1942
or to the components top level window
1943
</parameter_description>
1944
</parameter>
1945
</parameters>
1946
<return> %TRUE or %FALSE indicating whether the specified point is within
1947
the extent of the @component or not
1948
</return>
1949
</function>
1950
1951
<function name="atk_value_get_maximum_value">
1952
<description>
1953
Gets the maximum value of this object.
1954
1955
</description>
1956
<parameters>
1957
<parameter name="obj">
1958
<parameter_description> a GObject instance that implements AtkValueIface
1959
</parameter_description>
1960
</parameter>
1961
<parameter name="value">
1962
<parameter_description> a #GValue representing the maximum accessible value
1963
</parameter_description>
1964
</parameter>
1965
</parameters>
1966
<return></return>
1967
</function>
1968
1969
<function name="atk_component_set_extents">
1970
<description>
1971
Sets the extents of @component.
1972
1973
1974
</description>
1975
<parameters>
1976
<parameter name="component">
1977
<parameter_description> an #AtkComponent
1978
</parameter_description>
1979
</parameter>
1980
<parameter name="x">
1981
<parameter_description> x coordinate
1982
</parameter_description>
1983
</parameter>
1984
<parameter name="y">
1985
<parameter_description> y coordinate
1986
</parameter_description>
1987
</parameter>
1988
<parameter name="width">
1989
<parameter_description> width to set for @component
1990
</parameter_description>
1991
</parameter>
1992
<parameter name="height">
1993
<parameter_description> height to set for @component
1994
</parameter_description>
1995
</parameter>
1996
<parameter name="coord_type">
1997
<parameter_description> specifies whether the coordinates are relative to the screen
1998
or to the components top level window
1999
</parameter_description>
2000
</parameter>
2001
</parameters>
2002
<return> %TRUE or %FALSE whether the extents were set or not
2003
</return>
2004
</function>
2005
2006
<function name="atk_relation_new">
2007
<description>
2008
Create a new relation for the specified key and the specified list
2009
of targets. See also atk_object_add_relationship().
2010
2011
2012
</description>
2013
<parameters>
2014
<parameter name="targets">
2015
<parameter_description> an array of pointers to #AtkObjects
2016
</parameter_description>
2017
</parameter>
2018
<parameter name="n_targets">
2019
<parameter_description> number of #AtkObjects pointed to by @targets
2020
</parameter_description>
2021
</parameter>
2022
<parameter name="relationship">
2023
<parameter_description> an #AtkRelationType with which to create the new
2024
#AtkRelation
2025
</parameter_description>
2026
</parameter>
2027
</parameters>
2028
<return> a pointer to a new #AtkRelation
2029
</return>
2030
</function>
2031
2032
<function name="atk_object_get_n_accessible_children">
2033
<description>
2034
Gets the number of accessible children of the accessible.
2035
2036
2037
</description>
2038
<parameters>
2039
<parameter name="accessible">
2040
<parameter_description> an #AtkObject
2041
</parameter_description>
2042
</parameter>
2043
</parameters>
2044
<return> an integer representing the number of accessible children
2045
of the accessible.
2046
</return>
2047
</function>
2048
2049
<function name="atk_document_set_attribute_value">
2050
<description>
2051
Since: 1.12
2052
2053
2054
</description>
2055
<parameters>
2056
<parameter name="document">
2057
<parameter_description> a #GObject instance that implements AtkDocumentIface
2058
</parameter_description>
2059
</parameter>
2060
<parameter name="attribute_name">
2061
<parameter_description> a character string representing the name of the attribute
2062
whose value is being set.
2063
</parameter_description>
2064
</parameter>
2065
<parameter name="attribute_value">
2066
<parameter_description> a string value to be associated with #attribute_name.
2067
</parameter_description>
2068
</parameter>
2069
</parameters>
2070
<return> TRUE if #value is successfully associated with #attribute_name
2071
for this document, FALSE otherwise (e.g. if the document does not
2072
allow the attribute to be modified).
2073
</return>
2074
</function>
2075
2076
<function name="atk_state_set_contains_states">
2077
<description>
2078
Checks whether the states for all the specified types are in the
2079
specified set.
2080
2081
2082
</description>
2083
<parameters>
2084
<parameter name="set">
2085
<parameter_description> an #AtkStateSet
2086
</parameter_description>
2087
</parameter>
2088
<parameter name="types">
2089
<parameter_description> an array of #AtkStateType
2090
</parameter_description>
2091
</parameter>
2092
<parameter name="n_types">
2093
<parameter_description> The number of elements in the array
2094
</parameter_description>
2095
</parameter>
2096
</parameters>
2097
<return> %TRUE if all the states for @type are in @set.
2098
</return>
2099
</function>
2100
2101
<function name="atk_table_set_row_description">
2102
<description>
2103
Sets the description text for the specified @row of @table.
2104
2105
</description>
2106
<parameters>
2107
<parameter name="table">
2108
<parameter_description> a GObject instance that implements AtkTableIface
2109
</parameter_description>
2110
</parameter>
2111
<parameter name="row">
2112
<parameter_description> a #gint representing a row in @table
2113
</parameter_description>
2114
</parameter>
2115
<parameter name="description">
2116
<parameter_description> a #gchar representing the description text
2117
to set for the specified @row of @table
2118
</parameter_description>
2119
</parameter>
2120
</parameters>
2121
<return></return>
2122
</function>
2123
2124
<function name="atk_object_initialize">
2125
<description>
2126
This function is called when implementing subclasses of #AtkObject.
2127
It does initialization required for the new object. It is intended
2128
that this function should called only in the ..._new() functions used
2129
to create an instance of a subclass of #AtkObject
2130
2131
</description>
2132
<parameters>
2133
<parameter name="accessible">
2134
<parameter_description> a #AtkObject
2135
</parameter_description>
2136
</parameter>
2137
<parameter name="data">
2138
<parameter_description> a #gpointer which identifies the object for which the AtkObject was created.
2139
</parameter_description>
2140
</parameter>
2141
</parameters>
2142
<return></return>
2143
</function>
2144
2145
<function name="atk_table_is_selected">
2146
<description>
2147
Gets a boolean value indicating whether the accessible object
2148
at the specified @row and @column is selected
2149
2150
2151
</description>
2152
<parameters>
2153
<parameter name="table">
2154
<parameter_description> a GObject instance that implements AtkTableIface
2155
</parameter_description>
2156
</parameter>
2157
<parameter name="row">
2158
<parameter_description> a #gint representing a row in @table
2159
</parameter_description>
2160
</parameter>
2161
<parameter name="column">
2162
<parameter_description> a #gint representing a column in @table
2163
</parameter_description>
2164
</parameter>
2165
</parameters>
2166
<return> a gboolean representing if the cell is selected, or 0
2167
if value does not implement this interface.
2168
</return>
2169
</function>
2170
2171
<function name="atk_selection_select_all_selection">
2172
<description>
2173
Causes every child of the object to be selected if the object
2174
supports multiple selections.
2175
2176
2177
</description>
2178
<parameters>
2179
<parameter name="selection">
2180
<parameter_description> a #GObject instance that implements AtkSelectionIface
2181
</parameter_description>
2182
</parameter>
2183
</parameters>
2184
<return> TRUE if success, FALSE otherwise.
2185
</return>
2186
</function>
2187
2188
<function name="atk_selection_clear_selection">
2189
<description>
2190
Clears the selection in the object so that no children in the object
2191
are selected.
2192
2193
2194
</description>
2195
<parameters>
2196
<parameter name="selection">
2197
<parameter_description> a #GObject instance that implements AtkSelectionIface
2198
</parameter_description>
2199
</parameter>
2200
</parameters>
2201
<return> TRUE if success, FALSE otherwise.
2202
</return>
2203
</function>
2204
2205
<function name="atk_registry_get_factory_type">
2206
<description>
2207
Provides a #GType indicating the #AtkObjectFactory subclass
2208
associated with @type.
2209
2210
2211
</description>
2212
<parameters>
2213
<parameter name="registry">
2214
<parameter_description> an #AtkRegistry
2215
</parameter_description>
2216
</parameter>
2217
<parameter name="type">
2218
<parameter_description> a #GType with which to look up the associated #AtkObjectFactory
2219
subclass
2220
</parameter_description>
2221
</parameter>
2222
</parameters>
2223
<return> a #GType associated with type @type
2224
</return>
2225
</function>
2226
2227
<function name="atk_focus_tracker_init">
2228
<description>
2229
Specifies the function to be called for focus tracker initialization.
2230
This function should be called by an implementation of the
2231
ATK interface if any specific work needs to be done to enable
2232
focus tracking.
2233
2234
</description>
2235
<parameters>
2236
<parameter name="init">
2237
<parameter_description> Function to be called for focus tracker initialization
2238
</parameter_description>
2239
</parameter>
2240
</parameters>
2241
<return></return>
2242
</function>
2243
2244
<function name="atk_table_get_n_columns">
2245
<description>
2246
Gets the number of columns in the table.
2247
2248
2249
</description>
2250
<parameters>
2251
<parameter name="table">
2252
<parameter_description> a GObject instance that implements AtkTableIface
2253
</parameter_description>
2254
</parameter>
2255
</parameters>
2256
<return> a gint representing the number of columns, or 0
2257
if value does not implement this interface.
2258
</return>
2259
</function>
2260
2261
<function name="atk_text_get_bounded_ranges">
2262
<description>
2263
Get the ranges of text in the specified bounding box.
2264
2265
Since: 1.3
2266
2267
2268
</description>
2269
<parameters>
2270
<parameter name="text">
2271
<parameter_description> an #AtkText
2272
</parameter_description>
2273
</parameter>
2274
<parameter name="rect">
2275
<parameter_description> An AtkTextRectagle giving the dimensions of the bounding box.
2276
</parameter_description>
2277
</parameter>
2278
<parameter name="coord_type">
2279
<parameter_description> Specify whether coordinates are relative to the screen or widget window.
2280
</parameter_description>
2281
</parameter>
2282
<parameter name="x_clip_type">
2283
<parameter_description> Specify the horizontal clip type.
2284
</parameter_description>
2285
</parameter>
2286
<parameter name="y_clip_type">
2287
<parameter_description> Specify the vertical clip type.
2288
</parameter_description>
2289
</parameter>
2290
</parameters>
2291
<return> Array of AtkTextRange. The last element of the array returned
2292
by this function will be NULL.
2293
</return>
2294
</function>
2295
2296
<function name="atk_table_get_row_extent_at">
2297
<description>
2298
Gets the number of rows occupied by the accessible object
2299
at a specified @row and @column in the @table.
2300
2301
2302
</description>
2303
<parameters>
2304
<parameter name="table">
2305
<parameter_description> a GObject instance that implements AtkTableIface
2306
</parameter_description>
2307
</parameter>
2308
<parameter name="row">
2309
<parameter_description> a #gint representing a row in @table
2310
</parameter_description>
2311
</parameter>
2312
<parameter name="column">
2313
<parameter_description> a #gint representing a column in @table
2314
</parameter_description>
2315
</parameter>
2316
</parameters>
2317
<return> a gint representing the row extent at specified position, or 0
2318
if value does not implement this interface.
2319
</return>
2320
</function>
2321
2322
<function name="atk_text_add_selection">
2323
<description>
2324
Adds a selection bounded by the specified offsets.
2325
2326
2327
</description>
2328
<parameters>
2329
<parameter name="text">
2330
<parameter_description> an #AtkText
2331
</parameter_description>
2332
</parameter>
2333
<parameter name="start_offset">
2334
<parameter_description> the start position of the selected region
2335
</parameter_description>
2336
</parameter>
2337
<parameter name="end_offset">
2338
<parameter_description> the offset of the first character after the selected region.
2339
</parameter_description>
2340
</parameter>
2341
</parameters>
2342
<return> %TRUE if success, %FALSE otherwise
2343
</return>
2344
</function>
2345
2346
<function name="atk_object_get_description">
2347
<description>
2348
Gets the accessible description of the accessible.
2349
2350
2351
</description>
2352
<parameters>
2353
<parameter name="accessible">
2354
<parameter_description> an #AtkObject
2355
</parameter_description>
2356
</parameter>
2357
</parameters>
2358
<return> a character string representing the accessible description
2359
of the accessible.
2360
2361
</return>
2362
</function>
2363
2364
<function name="atk_hyperlink_get_object">
2365
<description>
2366
Returns the item associated with this hyperlinks nth anchor.
2367
For instance, the returned #AtkObject will implement #AtkText
2368
if @link_ is a text hyperlink, #AtkImage if @link_ is an image
2369
hyperlink etc.
2370
2371
Multiple anchors are primarily used by client-side image maps.
2372
2373
2374
</description>
2375
<parameters>
2376
<parameter name="link_">
2377
<parameter_description> an #AtkHyperlink
2378
</parameter_description>
2379
</parameter>
2380
<parameter name="i">
2381
<parameter_description> a (zero-index) integer specifying the desired anchor
2382
</parameter_description>
2383
</parameter>
2384
</parameters>
2385
<return> an #AtkObject associated with this hyperlinks i-th anchor
2386
</return>
2387
</function>
2388
2389
<function name="atk_get_toolkit_name">
2390
<description>
2391
Gets name string for the GUI toolkit implementing ATK for this application.
2392
2393
2394
</description>
2395
<parameters>
2396
</parameters>
2397
<return> name string for the GUI toolkit implementing ATK for this application
2398
</return>
2399
</function>
2400
2401
<function name="atk_relation_type_for_name">
2402
<description>
2403
Get the #AtkRelationType type corresponding to a relation name.
2404
2405
2406
</description>
2407
<parameters>
2408
<parameter name="name">
2409
<parameter_description> a string which is the (non-localized) name of an ATK relation type.
2410
</parameter_description>
2411
</parameter>
2412
</parameters>
2413
<return> the #AtkRelationType enumerated type corresponding to the specified name,
2414
or #ATK_RELATION_NULL if no matching relation type is found.
2415
</return>
2416
</function>
2417
2418
<function name="atk_table_set_caption">
2419
<description>
2420
Sets the caption for the table.
2421
2422
</description>
2423
<parameters>
2424
<parameter name="table">
2425
<parameter_description> a GObject instance that implements AtkTableIface
2426
</parameter_description>
2427
</parameter>
2428
<parameter name="caption">
2429
<parameter_description> a #AtkObject representing the caption to set for @table
2430
</parameter_description>
2431
</parameter>
2432
</parameters>
2433
<return></return>
2434
</function>
2435
2436
<function name="atk_misc_get_instance">
2437
<description>
2438
Obtain the singleton instance of AtkMisc for this application.
2439
2440
Since: 1.13
2441
2442
2443
</description>
2444
<parameters>
2445
</parameters>
2446
<return> The singleton instance of AtkMisc for this application.
2447
2448
</return>
2449
</function>
2450
2451
<function name="atk_object_get_mdi_zorder">
2452
<description>
2453
Gets the zorder of the accessible. The value G_MININT will be returned
2454
if the layer of the accessible is not ATK_LAYER_MDI.
2455
2456
Deprecated: Use atk_component_get_mdi_zorder instead.
2457
2458
2459
</description>
2460
<parameters>
2461
<parameter name="accessible">
2462
<parameter_description> an #AtkObject
2463
</parameter_description>
2464
</parameter>
2465
</parameters>
2466
<return> a gint which is the zorder of the accessible, i.e. the depth at
2467
which the component is shown in relation to other components in the same
2468
container.
2469
2470
</return>
2471
</function>
2472
2473
<function name="atk_component_get_position">
2474
<description>
2475
Gets the position of @component in the form of
2476
a point specifying @component's top-left corner.
2477
2478
</description>
2479
<parameters>
2480
<parameter name="component">
2481
<parameter_description> an #AtkComponent
2482
</parameter_description>
2483
</parameter>
2484
<parameter name="x">
2485
<parameter_description> address of #gint to put x coordinate position
2486
</parameter_description>
2487
</parameter>
2488
<parameter name="y">
2489
<parameter_description> address of #gint to put y coordinate position
2490
</parameter_description>
2491
</parameter>
2492
<parameter name="coord_type">
2493
<parameter_description> specifies whether the coordinates are relative to the screen
2494
or to the components top level window
2495
</parameter_description>
2496
</parameter>
2497
</parameters>
2498
<return></return>
2499
</function>
2500
2501
<function name="atk_streamable_content_get_stream">
2502
<description>
2503
Gets the content in the specified mime type.
2504
2505
2506
</description>
2507
<parameters>
2508
<parameter name="streamable">
2509
<parameter_description> a GObject instance that implements AtkStreamableContentIface
2510
</parameter_description>
2511
</parameter>
2512
<parameter name="mime_type">
2513
<parameter_description> a gchar* representing the mime type
2514
</parameter_description>
2515
</parameter>
2516
</parameters>
2517
<return> A #GIOChannel which contains the content in the specified mime
2518
type.
2519
</return>
2520
</function>
2521
2522
<function name="atk_relation_set_contains">
2523
<description>
2524
Determines whether the relation set contains a relation that matches the
2525
specified type.
2526
2527
2528
</description>
2529
<parameters>
2530
<parameter name="set">
2531
<parameter_description> an #AtkRelationSet
2532
</parameter_description>
2533
</parameter>
2534
<parameter name="relationship">
2535
<parameter_description> an #AtkRelationType
2536
</parameter_description>
2537
</parameter>
2538
</parameters>
2539
<return> %TRUE if @relationship is the relationship type of a relation
2540
in @set, %FALSE otherwise
2541
</return>
2542
</function>
2543
2544
<function name="atk_action_get_name">
2545
<description>
2546
Returns a non-localized string naming the specified action of the
2547
object. This name is generally not descriptive of the end result
2548
of the action, but instead names the 'interaction type' which the
2549
object supports. By convention, the above strings should be used to
2550
represent the actions which correspond to the common point-and-click
2551
interaction techniques of the same name: i.e.
2552
"click", "press", "release", "drag", "drop", "popup", etc.
2553
The "popup" action should be used to pop up a context menu for the
2554
object, if one exists.
2555
2556
For technical reasons, some toolkits cannot guarantee that the
2557
reported action is actually 'bound' to a nontrivial user event;
2558
i.e. the result of some actions via atk_action_do_action() may be
2559
NIL.
2560
2561
2562
</description>
2563
<parameters>
2564
<parameter name="action">
2565
<parameter_description> a #GObject instance that implements AtkActionIface
2566
</parameter_description>
2567
</parameter>
2568
<parameter name="i">
2569
<parameter_description> the action index corresponding to the action to be performed
2570
</parameter_description>
2571
</parameter>
2572
</parameters>
2573
<return>a name string, or %NULL
2574
if @action does not implement this interface.
2575
</return>
2576
</function>
2577
2578
<function name="atk_state_set_new">
2579
<description>
2580
Creates a new empty state set.
2581
2582
2583
</description>
2584
<parameters>
2585
</parameters>
2586
<return> a new #AtkStateSet
2587
</return>
2588
</function>
2589
2590
<function name="atk_table_get_selected_columns">
2591
<description>
2592
Gets the selected columns of the table by initializing **selected with
2593
the selected column numbers. This array should be freed by the caller.
2594
2595
2596
</description>
2597
<parameters>
2598
<parameter name="table">
2599
<parameter_description> a GObject instance that implements AtkTableIface
2600
</parameter_description>
2601
</parameter>
2602
<parameter name="selected">
2603
<parameter_description> a #gint** that is to contain the selected columns numbers
2604
</parameter_description>
2605
</parameter>
2606
</parameters>
2607
<return> a gint representing the number of selected columns,
2608
or %0 if value does not implement this interface.
2609
</return>
2610
</function>
2611
2612
<function name="atk_relation_add_target">
2613
<description>
2614
Adds the specified AtkObject to the target for the relation, if it is
2615
not already present. See also atk_object_add_relationship().
2616
2617
2618
Since: 1.9
2619
2620
</description>
2621
<parameters>
2622
<parameter name="relation">
2623
<parameter_description> an #AtkRelation
2624
</parameter_description>
2625
</parameter>
2626
<parameter name="target">
2627
<parameter_description> an #AtkObject
2628
</parameter_description>
2629
</parameter>
2630
</parameters>
2631
<return></return>
2632
</function>
2633
2634
<function name="atk_plug_get_plug_id">
2635
<description>
2636
Gets the unique ID of an #AtkPlug object, which can be used to embed inside
2637
of an #AtkSocket using atk_socket_embed().
2638
2639
2640
</description>
2641
<parameters>
2642
<parameter name="obj">
2643
<parameter_description> an #AtkPlug
2644
</parameter_description>
2645
</parameter>
2646
</parameters>
2647
<return> the unique ID for the plug
2648
</return>
2649
</function>
2650
2651
<function name="atk_action_do_action">
2652
<description>
2653
Perform the specified action on the object.
2654
2655
2656
</description>
2657
<parameters>
2658
<parameter name="action">
2659
<parameter_description> a #GObject instance that implements AtkActionIface
2660
</parameter_description>
2661
</parameter>
2662
<parameter name="i">
2663
<parameter_description> the action index corresponding to the action to be performed
2664
</parameter_description>
2665
</parameter>
2666
</parameters>
2667
<return> %TRUE if success, %FALSE otherwise
2668
2669
</return>
2670
</function>
2671
2672
<function name="atk_streamable_content_get_uri">
2673
<description>
2674
Get a string representing a URI in IETF standard format
2675
(see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content
2676
may be streamed in the specified mime-type, if one is available.
2677
If mime_type is NULL, the URI for the default (and possibly only) mime-type is
2678
returned.
2679
2680
Note that it is possible for get_uri to return NULL but for
2681
get_stream to work nonetheless, since not all GIOChannels connect to URIs.
2682
2683
Since: 1.12
2684
2685
</description>
2686
<parameters>
2687
<parameter name="streamable">
2688
<parameter_description> a GObject instance that implements AtkStreamableContentIface
2689
</parameter_description>
2690
</parameter>
2691
<parameter name="mime_type">
2692
<parameter_description> a gchar* representing the mime type, or NULL to request a URI
2693
for the default mime type.
2694
</parameter_description>
2695
</parameter>
2696
</parameters>
2697
<return> Returns a string representing a URI, or NULL if no corresponding URI
2698
can be constructed.
2699
2700
</return>
2701
</function>
2702
2703
<function name="atk_hyperlink_is_inline">
2704
<description>
2705
Indicates whether the link currently displays some or all of its
2706
content inline. Ordinary HTML links will usually return
2707
%FALSE, but an inline <src> HTML element will return
2708
%TRUE.
2709
a *
2710
2711
</description>
2712
<parameters>
2713
<parameter name="link_">
2714
<parameter_description> an #AtkHyperlink
2715
</parameter_description>
2716
</parameter>
2717
</parameters>
2718
<return> whether or not this link displays its content inline.
2719
2720
</return>
2721
</function>
2722
2723
<function name="atk_table_get_row_header">
2724
<description>
2725
Gets the row header of a specified row in an accessible table.
2726
2727
2728
</description>
2729
<parameters>
2730
<parameter name="table">
2731
<parameter_description> a GObject instance that implements AtkTableIface
2732
</parameter_description>
2733
</parameter>
2734
<parameter name="row">
2735
<parameter_description> a #gint representing a row in the table
2736
</parameter_description>
2737
</parameter>
2738
</parameters>
2739
<return> a AtkObject* representing the specified row header, or
2740
%NULL if value does not implement this interface.
2741
</return>
2742
</function>
2743
2744
<function name="atk_editable_text_insert_text">
2745
<description>
2746
Insert text at a given position.
2747
2748
</description>
2749
<parameters>
2750
<parameter name="text">
2751
<parameter_description> an #AtkEditableText
2752
</parameter_description>
2753
</parameter>
2754
<parameter name="string">
2755
<parameter_description> the text to insert
2756
</parameter_description>
2757
</parameter>
2758
<parameter name="length">
2759
<parameter_description> the length of text to insert, in bytes
2760
</parameter_description>
2761
</parameter>
2762
<parameter name="position">
2763
<parameter_description> The caller initializes this to
2764
the position at which to insert the text. After the call it
2765
points at the position after the newly inserted text.
2766
</parameter_description>
2767
</parameter>
2768
</parameters>
2769
<return></return>
2770
</function>
2771
2772
<function name="atk_role_for_name">
2773
<description>
2774
Get the #AtkRole type corresponding to a rolew name.
2775
2776
2777
</description>
2778
<parameters>
2779
<parameter name="name">
2780
<parameter_description> a string which is the (non-localized) name of an ATK role.
2781
</parameter_description>
2782
</parameter>
2783
</parameters>
2784
<return> the #AtkRole enumerated type corresponding to the specified
2785
name,
2786
or #ATK_ROLE_INVALID if no matching role is found.
2787
</return>
2788
</function>
2789
2790
<function name="atk_selection_remove_selection">
2791
<description>
2792
Removes the specified child of the object from the object's selection.
2793
2794
2795
</description>
2796
<parameters>
2797
<parameter name="selection">
2798
<parameter_description> a #GObject instance that implements AtkSelectionIface
2799
</parameter_description>
2800
</parameter>
2801
<parameter name="i">
2802
<parameter_description> a #gint specifying the index in the selection set. (e.g. the
2803
ith selection as opposed to the ith child).
2804
</parameter_description>
2805
</parameter>
2806
</parameters>
2807
<return> TRUE if success, FALSE otherwise.
2808
</return>
2809
</function>
2810
2811
<function name="atk_text_free_ranges">
2812
<description>
2813
Frees the memory associated with an array of AtkTextRange. It is assumed
2814
that the array was returned by the function atk_text_get_bounded_ranges
2815
and is NULL terminated.
2816
2817
Since: 1.3
2818
2819
</description>
2820
<parameters>
2821
<parameter name="ranges">
2822
<parameter_description> A pointer to an array of #AtkTextRange which is to be freed.
2823
</parameter_description>
2824
</parameter>
2825
</parameters>
2826
<return></return>
2827
</function>
2828
2829
<function name="atk_table_set_column_description">
2830
<description>
2831
Sets the description text for the specified @column of the @table.
2832
2833
</description>
2834
<parameters>
2835
<parameter name="table">
2836
<parameter_description> a GObject instance that implements AtkTableIface
2837
</parameter_description>
2838
</parameter>
2839
<parameter name="column">
2840
<parameter_description> a #gint representing a column in @table
2841
</parameter_description>
2842
</parameter>
2843
<parameter name="description">
2844
<parameter_description> a #gchar representing the description text
2845
to set for the specified @column of the @table
2846
</parameter_description>
2847
</parameter>
2848
</parameters>
2849
<return></return>
2850
</function>
2851
2852
<function name="atk_component_set_position">
2853
<description>
2854
Sets the postition of @component.
2855
2856
2857
</description>
2858
<parameters>
2859
<parameter name="component">
2860
<parameter_description> an #AtkComponent
2861
</parameter_description>
2862
</parameter>
2863
<parameter name="x">
2864
<parameter_description> x coordinate
2865
</parameter_description>
2866
</parameter>
2867
<parameter name="y">
2868
<parameter_description> y coordinate
2869
</parameter_description>
2870
</parameter>
2871
<parameter name="coord_type">
2872
<parameter_description> specifies whether the coordinates are relative to the screen
2873
or to the components top level window
2874
</parameter_description>
2875
</parameter>
2876
</parameters>
2877
<return> %TRUE or %FALSE whether or not the position was set or not
2878
</return>
2879
</function>
2880
2881
<function name="atk_editable_text_delete_text">
2882
<description>
2883
Delete text @start_pos up to, but not including @end_pos.
2884
2885
</description>
2886
<parameters>
2887
<parameter name="text">
2888
<parameter_description> an #AtkEditableText
2889
</parameter_description>
2890
</parameter>
2891
<parameter name="start_pos">
2892
<parameter_description> start position
2893
</parameter_description>
2894
</parameter>
2895
<parameter name="end_pos">
2896
<parameter_description> end position
2897
</parameter_description>
2898
</parameter>
2899
</parameters>
2900
<return></return>
2901
</function>
2902
2903
<function name="atk_action_get_n_actions">
2904
<description>
2905
Gets the number of accessible actions available on the object.
2906
If there are more than one, the first one is considered the
2907
"default" action of the object.
2908
2909
2910
</description>
2911
<parameters>
2912
<parameter name="action">
2913
<parameter_description> a #GObject instance that implements AtkActionIface
2914
</parameter_description>
2915
</parameter>
2916
</parameters>
2917
<return> a the number of actions, or 0 if @action does not
2918
implement this interface.
2919
</return>
2920
</function>
2921
2922
<function name="atk_image_get_image_locale">
2923
<description>
2924
Since ATK 1.12
2925
2926
2927
</description>
2928
<parameters>
2929
<parameter name="image">
2930
<parameter_description> An #AtkImage
2931
</parameter_description>
2932
</parameter>
2933
</parameters>
2934
<return>a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the image does not specify a locale.
2935
2936
</return>
2937
</function>
2938
2939
<function name="atk_relation_set_remove">
2940
<description>
2941
Removes a relation from the relation set.
2942
This function unref's the #AtkRelation so it will be deleted unless there
2943
is another reference to it.
2944
2945
</description>
2946
<parameters>
2947
<parameter name="set">
2948
<parameter_description> an #AtkRelationSet
2949
</parameter_description>
2950
</parameter>
2951
<parameter name="relation">
2952
<parameter_description> an #AtkRelation
2953
</parameter_description>
2954
</parameter>
2955
</parameters>
2956
<return></return>
2957
</function>
2958
2959
<function name="atk_role_register">
2960
<description>
2961
Registers the role specified by @name.
2962
2963
2964
</description>
2965
<parameters>
2966
<parameter name="name">
2967
<parameter_description> a character string describing the new role.
2968
</parameter_description>
2969
</parameter>
2970
</parameters>
2971
<return> an #AtkRole for the new role.
2972
</return>
2973
</function>
2974
2975
<function name="atk_component_get_alpha">
2976
<description>
2977
Returns the alpha value (i.e. the opacity) for this
2978
@component, on a scale from 0 (fully transparent) to 1.0
2979
(fully opaque).
2980
2981
Since: 1.12
2982
2983
</description>
2984
<parameters>
2985
<parameter name="component">
2986
<parameter_description> an #AtkComponent
2987
</parameter_description>
2988
</parameter>
2989
</parameters>
2990
<return> An alpha value from 0 to 1.0, inclusive.
2991
</return>
2992
</function>
2993
2994
<function name="atk_document_get_locale">
2995
<description>
2996
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
2997
of the content of this document instance. Individual
2998
text substrings or images within this document may have
2999
a different locale, see atk_text_get_attributes and
3000
atk_image_get_image_locale.
3001
3002
3003
</description>
3004
<parameters>
3005
<parameter name="document">
3006
<parameter_description> a #GObject instance that implements AtkDocumentIface
3007
</parameter_description>
3008
</parameter>
3009
</parameters>
3010
<return> a UTF-8 string indicating the POSIX-style LC_MESSAGES
3011
locale of the document content as a whole, or NULL if
3012
the document content does not specify a locale.
3013
</return>
3014
</function>
3015
3016
<function name="atk_text_get_text">
3017
<description>
3018
Gets the specified text.
3019
3020
3021
</description>
3022
<parameters>
3023
<parameter name="text">
3024
<parameter_description> an #AtkText
3025
</parameter_description>
3026
</parameter>
3027
<parameter name="start_offset">
3028
<parameter_description> start position
3029
</parameter_description>
3030
</parameter>
3031
<parameter name="end_offset">
3032
<parameter_description> end position
3033
</parameter_description>
3034
</parameter>
3035
</parameters>
3036
<return> the text from @start_offset up to, but not including @end_offset.
3037
</return>
3038
</function>
3039
3040
<function name="atk_document_get_attributes">
3041
<description>
3042
Gets an AtkAttributeSet which describes document-wide
3043
attributes as name-value pairs.
3044
3045
Since: 1.12
3046
3047
3048
</description>
3049
<parameters>
3050
<parameter name="document">
3051
<parameter_description> a #GObject instance that implements AtkDocumentIface
3052
</parameter_description>
3053
</parameter>
3054
</parameters>
3055
<return> An AtkAttributeSet containing the explicitly
3056
set name-value-pair attributes associated with this document
3057
as a whole.
3058
</return>
3059
</function>
3060
3061
<function name="atk_image_get_image_size">
3062
<description>
3063
Get the width and height in pixels for the specified image.
3064
The values of @width and @height are returned as -1 if the
3065
values cannot be obtained (for instance, if the object is not onscreen).
3066
3067
</description>
3068
<parameters>
3069
<parameter name="image">
3070
<parameter_description> a #GObject instance that implements AtkImageIface
3071
</parameter_description>
3072
</parameter>
3073
<parameter name="width">
3074
<parameter_description> filled with the image width, or -1 if the value cannot be obtained.
3075
</parameter_description>
3076
</parameter>
3077
<parameter name="height">
3078
<parameter_description> filled with the image height, or -1 if the value cannot be obtained.
3079
</parameter_description>
3080
</parameter>
3081
</parameters>
3082
<return></return>
3083
</function>
3084
3085
<function name="atk_state_set_contains_state">
3086
<description>
3087
Checks whether the state for the specified type is in the specified set.
3088
3089
3090
</description>
3091
<parameters>
3092
<parameter name="set">
3093
<parameter_description> an #AtkStateSet
3094
</parameter_description>
3095
</parameter>
3096
<parameter name="type">
3097
<parameter_description> an #AtkStateType
3098
</parameter_description>
3099
</parameter>
3100
</parameters>
3101
<return> %TRUE if @type is the state type is in @set.
3102
</return>
3103
</function>
3104
3105
<function name="atk_hyperlink_get_end_index">
3106
<description>
3107
Gets the index with the hypertext document at which this link ends.
3108
3109
3110
</description>
3111
<parameters>
3112
<parameter name="link_">
3113
<parameter_description> an #AtkHyperlink
3114
</parameter_description>
3115
</parameter>
3116
</parameters>
3117
<return> the index with the hypertext document at which this link ends
3118
</return>
3119
</function>
3120
3121
<function name="atk_action_get_localized_name">
3122
<description>
3123
Returns the localized name of the specified action of the object.
3124
3125
3126
</description>
3127
<parameters>
3128
<parameter name="action">
3129
<parameter_description> a #GObject instance that implements AtkActionIface
3130
</parameter_description>
3131
</parameter>
3132
<parameter name="i">
3133
<parameter_description> the action index corresponding to the action to be performed
3134
</parameter_description>
3135
</parameter>
3136
</parameters>
3137
<return>a name string, or %NULL
3138
if @action does not implement this interface.
3139
</return>
3140
</function>
3141
3142
<function name="atk_registry_set_factory_type">
3143
<description>
3144
Associate an #AtkObjectFactory subclass with a #GType. Note:
3145
The associated @factory_type will thereafter be responsible for
3146
the creation of new #AtkObject implementations for instances
3147
appropriate for @type.
3148
3149
</description>
3150
<parameters>
3151
<parameter name="registry">
3152
<parameter_description> the #AtkRegistry in which to register the type association
3153
</parameter_description>
3154
</parameter>
3155
<parameter name="type">
3156
<parameter_description> an #AtkObject type
3157
</parameter_description>
3158
</parameter>
3159
<parameter name="factory_type">
3160
<parameter_description> an #AtkObjectFactory type to associate with @type. Must
3161
implement AtkObject appropriate for @type.
3162
</parameter_description>
3163
</parameter>
3164
</parameters>
3165
<return></return>
3166
</function>
3167
3168
<function name="atk_text_attribute_get_name">
3169
<description>
3170
Gets the name corresponding to the #AtkTextAttribute
3171
3172
3173
</description>
3174
<parameters>
3175
<parameter name="attr">
3176
<parameter_description> The #AtkTextAttribute whose name is required
3177
</parameter_description>
3178
</parameter>
3179
</parameters>
3180
<return> a string containing the name; this string should not be freed
3181
</return>
3182
</function>
3183
3184
<function name="atk_action_get_description">
3185
<description>
3186
Returns a description of the specified action of the object.
3187
3188
3189
</description>
3190
<parameters>
3191
<parameter name="action">
3192
<parameter_description> a #GObject instance that implements AtkActionIface
3193
</parameter_description>
3194
</parameter>
3195
<parameter name="i">
3196
<parameter_description> the action index corresponding to the action to be performed
3197
</parameter_description>
3198
</parameter>
3199
</parameters>
3200
<return>a description string, or %NULL
3201
if @action does not implement this interface.
3202
</return>
3203
</function>
3204
3205
<function name="atk_attribute_set_free">
3206
<description>
3207
Frees the memory used by an #AtkAttributeSet, including all its
3208
#AtkAttributes.
3209
3210
</description>
3211
<parameters>
3212
<parameter name="attrib_set">
3213
<parameter_description> The #AtkAttributeSet to free
3214
</parameter_description>
3215
</parameter>
3216
</parameters>
3217
<return></return>
3218
</function>
3219
3220
<function name="atk_get_default_registry">
3221
<description>
3222
Gets a default implementation of the #AtkObjectFactory/type
3223
registry.
3224
Note: For most toolkit maintainers, this will be the correct
3225
registry for registering new #AtkObject factories. Following
3226
a call to this function, maintainers may call atk_registry_set_factory_type()
3227
to associate an #AtkObjectFactory subclass with the GType of objects
3228
for whom accessibility information will be provided.
3229
3230
3231
</description>
3232
<parameters>
3233
</parameters>
3234
<return> a default implementation of the #AtkObjectFactory/type
3235
registry
3236
</return>
3237
</function>
3238
3239
<function name="atk_action_get_keybinding">
3240
<description>
3241
Returns a keybinding associated with this action, if one exists.
3242
The returned string is in the format "<a>;<b>;<c>"
3243
(i.e. semicolon-delimited), where <a> is the keybinding which
3244
activates the object if it is presently enabled onscreen,
3245
<b> corresponds to the keybinding or sequence of keys
3246
which invokes the action even if the relevant element is not
3247
currently posted on screen (for instance, for a menu item it
3248
posts the parent menus before invoking). The last token in the
3249
above string, if non-empty, represents a keyboard shortcut which
3250
invokes the same action without posting the component or its
3251
enclosing menus or dialogs.
3252
3253
3254
</description>
3255
<parameters>
3256
<parameter name="action">
3257
<parameter_description> a #GObject instance that implements AtkActionIface
3258
</parameter_description>
3259
</parameter>
3260
<parameter name="i">
3261
<parameter_description> the action index corresponding to the action to be performed
3262
</parameter_description>
3263
</parameter>
3264
</parameters>
3265
<return>a string representing the available keybindings, or %NULL
3266
if there is no keybinding for this action.
3267
3268
</return>
3269
</function>
3270
3271
<function name="atk_text_get_text_before_offset">
3272
<description>
3273
Gets the specified text.
3274
3275
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character before the
3276
offset is returned.
3277
3278
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
3279
is from the word start before the word start before the offset to
3280
the word start before the offset.
3281
3282
The returned string will contain the word before the offset if the offset
3283
is inside a word and will contain the word before the word before the
3284
offset if the offset is not inside a word.
3285
3286
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
3287
is from the word end before the word end at or before the offset to the
3288
word end at or before the offset.
3289
3290
The returned string will contain the word before the offset if the offset
3291
is inside a word or if the offset is not inside a word.
3292
3293
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
3294
string is from the sentence start before the sentence start before
3295
the offset to the sentence start before the offset.
3296
3297
The returned string will contain the sentence before the offset if the
3298
offset is inside a sentence and will contain the sentence before the
3299
sentence before the offset if the offset is not inside a sentence.
3300
3301
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
3302
is from the sentence end before the sentence end at or before the offset to
3303
the sentence end at or before the offset.
3304
3305
The returned string will contain the sentence before the offset if the
3306
offset is inside a sentence or if the offset is not inside a sentence.
3307
3308
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
3309
string is from the line start before the line start ar or before the offset
3310
to the line start ar or before the offset.
3311
3312
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
3313
is from the line end before the line end before the offset to the
3314
line end before the offset.
3315
3316
3317
</description>
3318
<parameters>
3319
<parameter name="text">
3320
<parameter_description> an #AtkText
3321
</parameter_description>
3322
</parameter>
3323
<parameter name="offset">
3324
<parameter_description> position
3325
</parameter_description>
3326
</parameter>
3327
<parameter name="boundary_type">
3328
<parameter_description> An #AtkTextBoundary
3329
</parameter_description>
3330
</parameter>
3331
<parameter name="start_offset">
3332
<parameter_description> the start offset of the returned string
3333
</parameter_description>
3334
</parameter>
3335
<parameter name="end_offset">
3336
<parameter_description> the offset of the first character after the
3337
returned substring
3338
</parameter_description>
3339
</parameter>
3340
</parameters>
3341
<return> the text before @offset bounded by the specified @boundary_type.
3342
</return>
3343
</function>
3344
3345
<function name="atk_table_get_index_at">
3346
<description>
3347
Gets a #gint representing the index at the specified @row and @column.
3348
3349
3350
</description>
3351
<parameters>
3352
<parameter name="table">
3353
<parameter_description> a GObject instance that implements AtkTableIface
3354
</parameter_description>
3355
</parameter>
3356
<parameter name="row">
3357
<parameter_description> a #gint representing a row in @table
3358
</parameter_description>
3359
</parameter>
3360
<parameter name="column">
3361
<parameter_description> a #gint representing a column in @table
3362
</parameter_description>
3363
</parameter>
3364
</parameters>
3365
<return> a #gint representing the index at specified position.
3366
The value -1 is returned if the object at row,column is not a child
3367
of table or table does not implement this interface.
3368
</return>
3369
</function>
3370
3371
<function name="atk_object_set_parent">
3372
<description>
3373
Sets the accessible parent of the accessible.
3374
3375
</description>
3376
<parameters>
3377
<parameter name="accessible">
3378
<parameter_description> an #AtkObject
3379
</parameter_description>
3380
</parameter>
3381
<parameter name="parent">
3382
<parameter_description> an #AtkObject to be set as the accessible parent
3383
</parameter_description>
3384
</parameter>
3385
</parameters>
3386
<return></return>
3387
</function>
3388
3389
<function name="atk_text_remove_selection">
3390
<description>
3391
Removes the specified selection.
3392
3393
3394
</description>
3395
<parameters>
3396
<parameter name="text">
3397
<parameter_description> an #AtkText
3398
</parameter_description>
3399
</parameter>
3400
<parameter name="selection_num">
3401
<parameter_description> The selection number. The selected regions are
3402
assigned numbers that correspond to how far the region is from the
3403
start of the text. The selected region closest to the beginning
3404
of the text region is assigned the number 0, etc. Note that adding,
3405
moving or deleting a selected region can change the numbering.
3406
</parameter_description>
3407
</parameter>
3408
</parameters>
3409
<return> %TRUE if success, %FALSE otherwise
3410
</return>
3411
</function>
3412
3413
<function name="atk_selection_get_selection_count">
3414
<description>
3415
Gets the number of accessible children currently selected.
3416
Note: callers should not rely on %NULL or on a zero value for
3417
indication of whether AtkSelectionIface is implemented, they should
3418
use type checking/interface checking macros or the
3419
atk_get_accessible_value() convenience method.
3420
3421
3422
</description>
3423
<parameters>
3424
<parameter name="selection">
3425
<parameter_description> a #GObject instance that implements AtkSelectionIface
3426
</parameter_description>
3427
</parameter>
3428
</parameters>
3429
<return> a gint representing the number of items selected, or 0
3430
if @selection does not implement this interface.
3431
</return>
3432
</function>
3433
3434
<function name="atk_get_toolkit_version">
3435
<description>
3436
Gets version string for the GUI toolkit implementing ATK for this application.
3437
3438
3439
</description>
3440
<parameters>
3441
</parameters>
3442
<return> version string for the GUI toolkit implementing ATK for this application
3443
</return>
3444
</function>
3445
3446
<function name="atk_component_get_extents">
3447
<description>
3448
Gets the rectangle which gives the extent of the @component.
3449
3450
3451
</description>
3452
<parameters>
3453
<parameter name="component">
3454
<parameter_description> an #AtkComponent
3455
</parameter_description>
3456
</parameter>
3457
<parameter name="x">
3458
<parameter_description> address of #gint to put x coordinate
3459
</parameter_description>
3460
</parameter>
3461
<parameter name="y">
3462
<parameter_description> address of #gint to put y coordinate
3463
</parameter_description>
3464
</parameter>
3465
<parameter name="width">
3466
<parameter_description> address of #gint to put width
3467
</parameter_description>
3468
</parameter>
3469
<parameter name="height">
3470
<parameter_description> address of #gint to put height
3471
</parameter_description>
3472
</parameter>
3473
<parameter name="coord_type">
3474
<parameter_description> specifies whether the coordinates are relative to the screen
3475
or to the components top level window
3476
</parameter_description>
3477
</parameter>
3478
</parameters>
3479
<return></return>
3480
</function>
3481
3482
<function name="atk_get_version">
3483
<description>
3484
Gets the current version for ATK.
3485
3486
3487
</description>
3488
<parameters>
3489
</parameters>
3490
<return> version string for ATK
3491
</return>
3492
</function>
3493
3494
<function name="atk_registry_get_factory">
3495
<description>
3496
Gets an #AtkObjectFactory appropriate for creating #AtkObjects
3497
appropriate for @type.
3498
3499
3500
</description>
3501
<parameters>
3502
<parameter name="registry">
3503
<parameter_description> an #AtkRegistry
3504
</parameter_description>
3505
</parameter>
3506
<parameter name="type">
3507
<parameter_description> a #GType with which to look up the associated #AtkObjectFactory
3508
</parameter_description>
3509
</parameter>
3510
</parameters>
3511
<return> an #AtkObjectFactory appropriate for creating #AtkObjects
3512
appropriate for @type.
3513
</return>
3514
</function>
3515
3516
<function name="atk_state_set_or_sets">
3517
<description>
3518
Constructs the union of the two sets.
3519
3520
3521
</description>
3522
<parameters>
3523
<parameter name="set">
3524
<parameter_description> an #AtkStateSet
3525
</parameter_description>
3526
</parameter>
3527
<parameter name="compare_set">
3528
<parameter_description> another #AtkStateSet
3529
</parameter_description>
3530
</parameter>
3531
</parameters>
3532
<return> a new #AtkStateSet which is the union of the two sets,
3533
returning %NULL is empty.
3534
</return>
3535
</function>
3536
3537
<function name="atk_component_get_size">
3538
<description>
3539
Gets the size of the @component in terms of width and height.
3540
3541
</description>
3542
<parameters>
3543
<parameter name="component">
3544
<parameter_description> an #AtkComponent
3545
</parameter_description>
3546
</parameter>
3547
<parameter name="width">
3548
<parameter_description> address of #gint to put width of @component
3549
</parameter_description>
3550
</parameter>
3551
<parameter name="height">
3552
<parameter_description> address of #gint to put height of @component
3553
</parameter_description>
3554
</parameter>
3555
</parameters>
3556
<return></return>
3557
</function>
3558
3559
<function name="atk_text_get_caret_offset">
3560
<description>
3561
Gets the offset position of the caret (cursor).
3562
3563
3564
</description>
3565
<parameters>
3566
<parameter name="text">
3567
<parameter_description> an #AtkText
3568
</parameter_description>
3569
</parameter>
3570
</parameters>
3571
<return> the offset position of the caret (cursor).
3572
</return>
3573
</function>
3574
3575
<function name="atk_relation_set_get_relation_by_type">
3576
<description>
3577
Finds a relation that matches the specified type.
3578
3579
3580
</description>
3581
<parameters>
3582
<parameter name="set">
3583
<parameter_description> an #AtkRelationSet
3584
</parameter_description>
3585
</parameter>
3586
<parameter name="relationship">
3587
<parameter_description> an #AtkRelationType
3588
</parameter_description>
3589
</parameter>
3590
</parameters>
3591
<return> an #AtkRelation, which is a relation matching the specified type.
3592
</return>
3593
</function>
3594
3595
<function name="atk_object_factory_invalidate">
3596
<description>
3597
Inform @factory that it is no longer being used to create
3598
accessibles. When called, @factory may need to inform
3599
#AtkObjects which it has created that they need to be re-instantiated.
3600
Note: primarily used for runtime replacement of #AtkObjectFactorys
3601
in object registries.
3602
3603
</description>
3604
<parameters>
3605
<parameter name="factory">
3606
<parameter_description> an #AtkObjectFactory to invalidate
3607
</parameter_description>
3608
</parameter>
3609
</parameters>
3610
<return></return>
3611
</function>
3612
3613
<function name="atk_table_get_row_description">
3614
<description>
3615
Gets the description text of the specified row in the table
3616
3617
3618
</description>
3619
<parameters>
3620
<parameter name="table">
3621
<parameter_description> a GObject instance that implements AtkTableIface
3622
</parameter_description>
3623
</parameter>
3624
<parameter name="row">
3625
<parameter_description> a #gint representing a row in @table
3626
</parameter_description>
3627
</parameter>
3628
</parameters>
3629
<return> a gchar* representing the row description, or %NULL
3630
if value does not implement this interface.
3631
</return>
3632
</function>
3633
3634
<function name="atk_state_set_and_sets">
3635
<description>
3636
Constructs the intersection of the two sets, returning %NULL if the
3637
intersection is empty.
3638
3639
3640
</description>
3641
<parameters>
3642
<parameter name="set">
3643
<parameter_description> an #AtkStateSet
3644
</parameter_description>
3645
</parameter>
3646
<parameter name="compare_set">
3647
<parameter_description> another #AtkStateSet
3648
</parameter_description>
3649
</parameter>
3650
</parameters>
3651
<return> a new #AtkStateSet which is the intersection of the two sets.
3652
</return>
3653
</function>
3654
3655
<function name="atk_table_remove_column_selection">
3656
<description>
3657
Adds the specified @column to the selection.
3658
3659
3660
</description>
3661
<parameters>
3662
<parameter name="table">
3663
<parameter_description> a GObject instance that implements AtkTableIface
3664
</parameter_description>
3665
</parameter>
3666
<parameter name="column">
3667
<parameter_description> a #gint representing a column in @table
3668
</parameter_description>
3669
</parameter>
3670
</parameters>
3671
<return> a gboolean representing if the column was successfully removed from
3672
the selection, or 0 if value does not implement this interface.
3673
</return>
3674
</function>
3675
3676
<function name="atk_table_get_row_at_index">
3677
<description>
3678
Gets a #gint representing the row at the specified @index_.
3679
3680
3681
</description>
3682
<parameters>
3683
<parameter name="table">
3684
<parameter_description> a GObject instance that implements AtkTableInterface
3685
</parameter_description>
3686
</parameter>
3687
<parameter name="index_">
3688
<parameter_description> a #gint representing an index in @table
3689
</parameter_description>
3690
</parameter>
3691
</parameters>
3692
<return> a gint representing the row at the specified index,
3693
or -1 if the table does not implement this interface
3694
</return>
3695
</function>
3696
3697
<function name="atk_action_set_description">
3698
<description>
3699
Sets a description of the specified action of the object.
3700
3701
3702
</description>
3703
<parameters>
3704
<parameter name="action">
3705
<parameter_description> a #GObject instance that implements AtkActionIface
3706
</parameter_description>
3707
</parameter>
3708
<parameter name="i">
3709
<parameter_description> the action index corresponding to the action to be performed
3710
</parameter_description>
3711
</parameter>
3712
<parameter name="desc">
3713
<parameter_description> the description to be assigned to this action
3714
</parameter_description>
3715
</parameter>
3716
</parameters>
3717
<return> a gboolean representing if the description was successfully set;
3718
</return>
3719
</function>
3720
3721
<function name="atk_socket_is_occupied">
3722
<description>
3723
Determines whether or not the socket has an embedded plug.
3724
3725
3726
</description>
3727
<parameters>
3728
<parameter name="obj">
3729
<parameter_description> an #AtkSocket
3730
</parameter_description>
3731
</parameter>
3732
</parameters>
3733
<return> TRUE if a plug is embedded in the socket
3734
</return>
3735
</function>
3736
3737
<function name="atk_component_set_size">
3738
<description>
3739
Set the size of the @component in terms of width and height.
3740
3741
3742
</description>
3743
<parameters>
3744
<parameter name="component">
3745
<parameter_description> an #AtkComponent
3746
</parameter_description>
3747
</parameter>
3748
<parameter name="width">
3749
<parameter_description> width to set for @component
3750
</parameter_description>
3751
</parameter>
3752
<parameter name="height">
3753
<parameter_description> height to set for @component
3754
</parameter_description>
3755
</parameter>
3756
</parameters>
3757
<return> %TRUE or %FALSE whether the size was set or not
3758
</return>
3759
</function>
3760
3761
<function name="atk_value_set_current_value">
3762
<description>
3763
Sets the value of this object.
3764
3765
3766
</description>
3767
<parameters>
3768
<parameter name="obj">
3769
<parameter_description> a GObject instance that implements AtkValueIface
3770
</parameter_description>
3771
</parameter>
3772
<parameter name="value">
3773
<parameter_description> a #GValue which is the desired new accessible value.
3774
</parameter_description>
3775
</parameter>
3776
</parameters>
3777
<return> %TRUE if new value is successfully set, %FALSE otherwise.
3778
</return>
3779
</function>
3780
3781
<function name="atk_remove_global_event_listener">
3782
<description>
3783
Removes the specified event listener
3784
3785
</description>
3786
<parameters>
3787
<parameter name="listener_id">
3788
<parameter_description> the id of the event listener to remove
3789
</parameter_description>
3790
</parameter>
3791
</parameters>
3792
<return></return>
3793
</function>
3794
3795
<function name="atk_add_global_event_listener">
3796
<description>
3797
Adds the specified function to the list of functions to be called
3798
when an event of type event_type occurs.
3799
3800
3801
</description>
3802
<parameters>
3803
<parameter name="listener">
3804
<parameter_description> the listener to notify
3805
</parameter_description>
3806
</parameter>
3807
<parameter name="event_type">
3808
<parameter_description> the type of event for which notification is requested
3809
</parameter_description>
3810
</parameter>
3811
</parameters>
3812
<return> added event listener id, or 0 on failure.
3813
</return>
3814
</function>
3815
3816
<function name="atk_table_ref_at">
3817
<description>
3818
Get a reference to the table cell at @row, @column.
3819
3820
3821
</description>
3822
<parameters>
3823
<parameter name="table">
3824
<parameter_description> a GObject instance that implements AtkTableIface
3825
</parameter_description>
3826
</parameter>
3827
<parameter name="row">
3828
<parameter_description> a #gint representing a row in @table
3829
</parameter_description>
3830
</parameter>
3831
<parameter name="column">
3832
<parameter_description> a #gint representing a column in @table
3833
</parameter_description>
3834
</parameter>
3835
</parameters>
3836
<return> a AtkObject* representing the referred to accessible
3837
</return>
3838
</function>
3839
3840
<function name="atk_object_get_name">
3841
<description>
3842
Gets the accessible name of the accessible.
3843
3844
3845
</description>
3846
<parameters>
3847
<parameter name="accessible">
3848
<parameter_description> an #AtkObject
3849
</parameter_description>
3850
</parameter>
3851
</parameters>
3852
<return> a character string representing the accessible name of the object.
3853
</return>
3854
</function>
3855
3856
<function name="atk_object_remove_property_change_handler">
3857
<description>
3858
Removes a property change handler.
3859
3860
</description>
3861
<parameters>
3862
<parameter name="accessible">
3863
<parameter_description> an #AtkObject
3864
</parameter_description>
3865
</parameter>
3866
<parameter name="handler_id">
3867
<parameter_description> a guint which identifies the handler to be removed.
3868
</parameter_description>
3869
</parameter>
3870
</parameters>
3871
<return></return>
3872
</function>
3873
3874
<function name="atk_table_get_summary">
3875
<description>
3876
Gets the summary description of the table.
3877
3878
3879
</description>
3880
<parameters>
3881
<parameter name="table">
3882
<parameter_description> a GObject instance that implements AtkTableIface
3883
</parameter_description>
3884
</parameter>
3885
</parameters>
3886
<return> a AtkObject* representing a summary description of the table,
3887
or zero if value does not implement this interface.
3888
</return>
3889
</function>
3890
3891
<function name="atk_text_set_caret_offset">
3892
<description>
3893
Sets the caret (cursor) position to the specified @offset.
3894
3895
3896
</description>
3897
<parameters>
3898
<parameter name="text">
3899
<parameter_description> an #AtkText
3900
</parameter_description>
3901
</parameter>
3902
<parameter name="offset">
3903
<parameter_description> position
3904
</parameter_description>
3905
</parameter>
3906
</parameters>
3907
<return> %TRUE if success, %FALSE otherwise.
3908
</return>
3909
</function>
3910
3911
<function name="atk_state_set_is_empty">
3912
<description>
3913
Checks whether the state set is empty, i.e. has no states set.
3914
3915
3916
</description>
3917
<parameters>
3918
<parameter name="set">
3919
<parameter_description> an #AtkStateType
3920
</parameter_description>
3921
</parameter>
3922
</parameters>
3923
<return> %TRUE if @set has no states set, otherwise %FALSE
3924
</return>
3925
</function>
3926
3927
<function name="atk_relation_set_get_n_relations">
3928
<description>
3929
Determines the number of relations in a relation set.
3930
3931
3932
</description>
3933
<parameters>
3934
<parameter name="set">
3935
<parameter_description> an #AtkRelationSet
3936
</parameter_description>
3937
</parameter>
3938
</parameters>
3939
<return> an integer representing the number of relations in the set.
3940
</return>
3941
</function>
3942
3943
<function name="atk_text_get_text_after_offset">
3944
<description>
3945
Gets the specified text.
3946
3947
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character after the
3948
offset is returned.
3949
3950
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
3951
is from the word start after the offset to the next word start.
3952
3953
The returned string will contain the word after the offset if the offset
3954
is inside a word or if the offset is not inside a word.
3955
3956
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
3957
is from the word end at or after the offset to the next work end.
3958
3959
The returned string will contain the word after the offset if the offset
3960
is inside a word and will contain the word after the word after the offset
3961
if the offset is not inside a word.
3962
3963
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
3964
string is from the sentence start after the offset to the next sentence
3965
start.
3966
3967
The returned string will contain the sentence after the offset if the offset
3968
is inside a sentence or if the offset is not inside a sentence.
3969
3970
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
3971
is from the sentence end at or after the offset to the next sentence end.
3972
3973
The returned string will contain the sentence after the offset if the offset
3974
is inside a sentence and will contain the sentence after the sentence
3975
after the offset if the offset is not inside a sentence.
3976
3977
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
3978
string is from the line start after the offset to the next line start.
3979
3980
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
3981
is from the line end at or after the offset to the next line start.
3982
3983
3984
</description>
3985
<parameters>
3986
<parameter name="text">
3987
<parameter_description> an #AtkText
3988
</parameter_description>
3989
</parameter>
3990
<parameter name="offset">
3991
<parameter_description> position
3992
</parameter_description>
3993
</parameter>
3994
<parameter name="boundary_type">
3995
<parameter_description> An #AtkTextBoundary
3996
</parameter_description>
3997
</parameter>
3998
<parameter name="start_offset">
3999
<parameter_description> the start offset of the returned string
4000
</parameter_description>
4001
</parameter>
4002
<parameter name="end_offset">
4003
<parameter_description> the offset of the first character after the
4004
returned substring
4005
</parameter_description>
4006
</parameter>
4007
</parameters>
4008
<return> the text after @offset bounded by the specified @boundary_type.
4009
</return>
4010
</function>
4011
4012
<function name="atk_relation_set_add">
4013
<description>
4014
Add a new relation to the current relation set if it is not already
4015
present.
4016
This function ref's the AtkRelation so the caller of this function
4017
should unref it to ensure that it will be destroyed when the AtkRelationSet
4018
is destroyed.
4019
4020
</description>
4021
<parameters>
4022
<parameter name="set">
4023
<parameter_description> an #AtkRelationSet
4024
</parameter_description>
4025
</parameter>
4026
<parameter name="relation">
4027
<parameter_description> an #AtkRelation
4028
</parameter_description>
4029
</parameter>
4030
</parameters>
4031
<return></return>
4032
</function>
4033
4034
<function name="atk_editable_text_set_run_attributes">
4035
<description>
4036
Sets the attributes for a specified range. See the ATK_ATTRIBUTE
4037
macros (such as #ATK_ATTRIBUTE_LEFT_MARGIN) for examples of attributes
4038
that can be set. Note that other attributes that do not have corresponding
4039
ATK_ATTRIBUTE macros may also be set for certain text widgets.
4040
4041
4042
</description>
4043
<parameters>
4044
<parameter name="text">
4045
<parameter_description> an #AtkEditableText
4046
</parameter_description>
4047
</parameter>
4048
<parameter name="attrib_set">
4049
<parameter_description> an #AtkAttributeSet
4050
</parameter_description>
4051
</parameter>
4052
<parameter name="start_offset">
4053
<parameter_description> start of range in which to set attributes
4054
</parameter_description>
4055
</parameter>
4056
<parameter name="end_offset">
4057
<parameter_description> end of range in which to set attributes
4058
</parameter_description>
4059
</parameter>
4060
</parameters>
4061
<return> %TRUE if attributes successfully set for the specified
4062
range, otherwise %FALSE
4063
</return>
4064
</function>
4065
4066
<function name="atk_table_get_column_extent_at">
4067
<description>
4068
Gets the number of columns occupied by the accessible object
4069
at the specified @row and @column in the @table.
4070
4071
4072
</description>
4073
<parameters>
4074
<parameter name="table">
4075
<parameter_description> a GObject instance that implements AtkTableIface
4076
</parameter_description>
4077
</parameter>
4078
<parameter name="row">
4079
<parameter_description> a #gint representing a row in @table
4080
</parameter_description>
4081
</parameter>
4082
<parameter name="column">
4083
<parameter_description> a #gint representing a column in @table
4084
</parameter_description>
4085
</parameter>
4086
</parameters>
4087
<return> a gint representing the column extent at specified position, or 0
4088
if value does not implement this interface.
4089
</return>
4090
</function>
4091
4092
<function name="atk_socket_embed">
4093
<description>
4094
Embeds the children of an #AtkPlug as the children of the #AtkSocket. The
4095
plug may be in the same process or in a different process.
4096
4097
</description>
4098
<parameters>
4099
<parameter name="obj">
4100
<parameter_description> an #AtkSocket
4101
</parameter_description>
4102
</parameter>
4103
<parameter name="plug_id">
4104
<parameter_description> the ID of an #AtkPlug
4105
</parameter_description>
4106
</parameter>
4107
</parameters>
4108
<return></return>
4109
</function>
4110
4111
<function name="atk_state_set_add_states">
4112
<description>
4113
Add the states for the specified types to the current state set.
4114
4115
</description>
4116
<parameters>
4117
<parameter name="set">
4118
<parameter_description> an #AtkStateSet
4119
</parameter_description>
4120
</parameter>
4121
<parameter name="types">
4122
<parameter_description> an array of #AtkStateType
4123
</parameter_description>
4124
</parameter>
4125
<parameter name="n_types">
4126
<parameter_description> The number of elements in the array
4127
</parameter_description>
4128
</parameter>
4129
</parameters>
4130
<return></return>
4131
</function>
4132
4133
<function name="atk_misc_threads_leave">
4134
<description>
4135
Release the thread mutex for the GUI toolkit,
4136
if one exists. This method, and atk_misc_threads_enter,
4137
are needed in some situations by threaded application code which
4138
services ATK requests, since fulfilling ATK requests often
4139
requires calling into the GUI toolkit. If a long-running or
4140
potentially blocking call takes place inside such a block, it should
4141
be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls.
4142
(This method is implemented by the toolkit ATK implementation layer;
4143
for instance, for GTK+, GAIL implements this via GDK_THREADS_LEAVE).
4144
4145
Since: 1.13
4146
4147
4148
</description>
4149
<parameters>
4150
<parameter name="misc">
4151
<parameter_description> an AtkMisc instance for this application.
4152
</parameter_description>
4153
</parameter>
4154
</parameters>
4155
<return></return>
4156
</function>
4157
4158
<function name="atk_state_type_for_name">
4159
<description>
4160
Gets the #AtkStateType corresponding to the description string @name.
4161
4162
4163
</description>
4164
<parameters>
4165
<parameter name="name">
4166
<parameter_description> a character string state name
4167
</parameter_description>
4168
</parameter>
4169
</parameters>
4170
<return> an #AtkStateType corresponding to @name
4171
</return>
4172
</function>
4173
4174
<function name="atk_hypertext_get_link_index">
4175
<description>
4176
Gets the index into the array of hyperlinks that is associated with
4177
the character specified by @char_index.
4178
4179
4180
</description>
4181
<parameters>
4182
<parameter name="hypertext">
4183
<parameter_description> an #AtkHypertext
4184
</parameter_description>
4185
</parameter>
4186
<parameter name="char_index">
4187
<parameter_description> a character index
4188
</parameter_description>
4189
</parameter>
4190
</parameters>
4191
<return> an index into the array of hyperlinks in @hypertext,
4192
or -1 if there is no hyperlink associated with this character.
4193
</return>
4194
</function>
4195
4196
<function name="atk_object_add_relationship">
4197
<description>
4198
Adds a relationship of the specified type with the specified target.
4199
4200
4201
</description>
4202
<parameters>
4203
<parameter name="object">
4204
<parameter_description> The #AtkObject to which an AtkRelation is to be added.
4205
</parameter_description>
4206
</parameter>
4207
<parameter name="relationship">
4208
<parameter_description> The #AtkRelationType of the relation
4209
</parameter_description>
4210
</parameter>
4211
<parameter name="target">
4212
<parameter_description> The #AtkObject which is to be the target of the relation.
4213
</parameter_description>
4214
</parameter>
4215
</parameters>
4216
<return>TRUE if the relationship is added.
4217
</return>
4218
</function>
4219
4220
<function name="atk_text_get_character_extents">
4221
<description>
4222
Get the bounding box containing the glyph representing the character at
4223
a particular text offset.
4224
4225
</description>
4226
<parameters>
4227
<parameter name="text">
4228
<parameter_description> an #AtkText
4229
</parameter_description>
4230
</parameter>
4231
<parameter name="offset">
4232
<parameter_description> The offset of the text character for which bounding information is required.
4233
</parameter_description>
4234
</parameter>
4235
<parameter name="x">
4236
<parameter_description> Pointer for the x cordinate of the bounding box
4237
</parameter_description>
4238
</parameter>
4239
<parameter name="y">
4240
<parameter_description> Pointer for the y cordinate of the bounding box
4241
</parameter_description>
4242
</parameter>
4243
<parameter name="width">
4244
<parameter_description> Pointer for the width of the bounding box
4245
</parameter_description>
4246
</parameter>
4247
<parameter name="height">
4248
<parameter_description> Pointer for the height of the bounding box
4249
</parameter_description>
4250
</parameter>
4251
<parameter name="coords">
4252
<parameter_description> specify whether coordinates are relative to the screen or widget window
4253
</parameter_description>
4254
</parameter>
4255
</parameters>
4256
<return></return>
4257
</function>
4258
4259
<function name="atk_component_remove_focus_handler">
4260
<description>
4261
Remove the handler specified by @handler_id from the list of
4262
functions to be executed when this object receives focus events
4263
(in or out).
4264
4265
</description>
4266
<parameters>
4267
<parameter name="component">
4268
<parameter_description> the #AtkComponent to remove the focus handler from
4269
</parameter_description>
4270
</parameter>
4271
<parameter name="handler_id">
4272
<parameter_description> the handler id of the focus handler to be removed
4273
from @component
4274
</parameter_description>
4275
</parameter>
4276
</parameters>
4277
<return></return>
4278
</function>
4279
4280
<function name="atk_state_set_add_state">
4281
<description>
4282
Add a new state for the specified type to the current state set if
4283
it is not already present.
4284
4285
4286
</description>
4287
<parameters>
4288
<parameter name="set">
4289
<parameter_description> an #AtkStateSet
4290
</parameter_description>
4291
</parameter>
4292
<parameter name="type">
4293
<parameter_description> an #AtkStateType
4294
</parameter_description>
4295
</parameter>
4296
</parameters>
4297
<return> %TRUE if the state for @type is not already in @set.
4298
</return>
4299
</function>
4300
4301
<function name="atk_value_get_current_value">
4302
<description>
4303
Gets the value of this object.
4304
4305
</description>
4306
<parameters>
4307
<parameter name="obj">
4308
<parameter_description> a GObject instance that implements AtkValueIface
4309
</parameter_description>
4310
</parameter>
4311
<parameter name="value">
4312
<parameter_description> a #GValue representing the current accessible value
4313
</parameter_description>
4314
</parameter>
4315
</parameters>
4316
<return></return>
4317
</function>
4318
4319
<function name="atk_state_set_xor_sets">
4320
<description>
4321
Constructs the exclusive-or of the two sets, returning %NULL is empty.
4322
The set returned by this operation contains the states in exactly
4323
one of the two sets.
4324
4325
4326
</description>
4327
<parameters>
4328
<parameter name="set">
4329
<parameter_description> an #AtkStateSet
4330
</parameter_description>
4331
</parameter>
4332
<parameter name="compare_set">
4333
<parameter_description> another #AtkStateSet
4334
</parameter_description>
4335
</parameter>
4336
</parameters>
4337
<return> a new #AtkStateSet which contains the states which are
4338
in exactly one of the two sets.
4339
</return>
4340
</function>
4341
4342
<function name="atk_role_get_localized_name">
4343
<description>
4344
Gets the localized description string describing the #AtkRole @role.
4345
4346
4347
</description>
4348
<parameters>
4349
<parameter name="role">
4350
<parameter_description> The #AtkRole whose localized name is required
4351
</parameter_description>
4352
</parameter>
4353
</parameters>
4354
<return> the localized string describing the AtkRole
4355
</return>
4356
</function>
4357
4358
<function name="atk_remove_key_event_listener">
4359
<description>
4360
Removes the specified event listener
4361
4362
</description>
4363
<parameters>
4364
<parameter name="listener_id">
4365
<parameter_description> the id of the event listener to remove
4366
</parameter_description>
4367
</parameter>
4368
</parameters>
4369
<return></return>
4370
</function>
4371
4372
<function name="atk_hypertext_get_n_links">
4373
<description>
4374
Gets the number of links within this hypertext document.
4375
4376
4377
</description>
4378
<parameters>
4379
<parameter name="hypertext">
4380
<parameter_description> an #AtkHypertext
4381
</parameter_description>
4382
</parameter>
4383
</parameters>
4384
<return> the number of links within this hypertext document
4385
</return>
4386
</function>
4387
4388
<function name="atk_streamable_content_get_mime_type">
4389
<description>
4390
Gets the character string of the specified mime type. The first mime
4391
type is at position 0, the second at position 1, and so on.
4392
4393
4394
</description>
4395
<parameters>
4396
<parameter name="streamable">
4397
<parameter_description> a GObject instance that implements AtkStreamableContent
4398
</parameter_description>
4399
</parameter>
4400
<parameter name="i">
4401
<parameter_description> a gint representing the position of the mime type starting from 0
4402
</parameter_description>
4403
</parameter>
4404
</parameters>
4405
<return> a gchar* representing the specified mime type; the caller
4406
should not free the character string.
4407
</return>
4408
</function>
4409
4410
<function name="atk_selection_add_selection">
4411
<description>
4412
Adds the specified accessible child of the object to the
4413
object's selection.
4414
4415
4416
</description>
4417
<parameters>
4418
<parameter name="selection">
4419
<parameter_description> a #GObject instance that implements AtkSelectionIface
4420
</parameter_description>
4421
</parameter>
4422
<parameter name="i">
4423
<parameter_description> a #gint specifying the child index.
4424
</parameter_description>
4425
</parameter>
4426
</parameters>
4427
<return> TRUE if success, FALSE otherwise.
4428
</return>
4429
</function>
4430
4431
<function name="atk_hyperlink_get_uri">
4432
<description>
4433
Get a the URI associated with the anchor specified
4434
by @i of @link_.
4435
4436
Multiple anchors are primarily used by client-side image maps.
4437
4438
4439
</description>
4440
<parameters>
4441
<parameter name="link_">
4442
<parameter_description> an #AtkHyperlink
4443
</parameter_description>
4444
</parameter>
4445
<parameter name="i">
4446
<parameter_description> a (zero-index) integer specifying the desired anchor
4447
</parameter_description>
4448
</parameter>
4449
</parameters>
4450
<return> a string specifying the URI
4451
</return>
4452
</function>
4453
4454
</root>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1