@girs/atspi-2.0 4.2.0 → 4.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/atspi-2.0.d.ts +1042 -234
- package/package.json +5 -5
package/atspi-2.0.d.ts
CHANGED
|
@@ -88,11 +88,11 @@ export namespace Atspi {
|
|
|
88
88
|
*/
|
|
89
89
|
CANONICAL,
|
|
90
90
|
/**
|
|
91
|
-
* Flow sort order
|
|
91
|
+
* Flow sort order. reserved for future use.
|
|
92
92
|
*/
|
|
93
93
|
FLOW,
|
|
94
94
|
/**
|
|
95
|
-
* Tab sort order
|
|
95
|
+
* Tab sort order. Reserved for future use.
|
|
96
96
|
*/
|
|
97
97
|
TAB,
|
|
98
98
|
/**
|
|
@@ -100,16 +100,18 @@ export namespace Atspi {
|
|
|
100
100
|
*/
|
|
101
101
|
REVERSE_CANONICAL,
|
|
102
102
|
/**
|
|
103
|
-
* Reverse flow sort order
|
|
103
|
+
* Reverse flow sort order. Reserved
|
|
104
|
+
* for future use.
|
|
104
105
|
*/
|
|
105
106
|
REVERSE_FLOW,
|
|
106
107
|
/**
|
|
107
|
-
* Reverse tab sort order
|
|
108
|
+
* Reverse tab sort order. Reserved
|
|
109
|
+
* for future use.
|
|
108
110
|
*/
|
|
109
111
|
REVERSE_TAB,
|
|
110
112
|
/**
|
|
111
|
-
* Used only to determine the end of
|
|
112
|
-
* enumeration.
|
|
113
|
+
* Used only to determine the end of
|
|
114
|
+
* the enumeration.
|
|
113
115
|
*/
|
|
114
116
|
LAST_DEFINED,
|
|
115
117
|
}
|
|
@@ -251,6 +253,7 @@ export namespace Atspi {
|
|
|
251
253
|
* immediate parent.
|
|
252
254
|
*/
|
|
253
255
|
PARENT,
|
|
256
|
+
LAST_DEFINED,
|
|
254
257
|
}
|
|
255
258
|
|
|
256
259
|
|
|
@@ -288,6 +291,7 @@ export namespace Atspi {
|
|
|
288
291
|
* human interface device (HID) was released.
|
|
289
292
|
*/
|
|
290
293
|
BUTTON_RELEASED_EVENT,
|
|
294
|
+
EVENT_LAST_DEFINED,
|
|
291
295
|
}
|
|
292
296
|
|
|
293
297
|
|
|
@@ -311,6 +315,7 @@ export namespace Atspi {
|
|
|
311
315
|
* Key release event
|
|
312
316
|
*/
|
|
313
317
|
RELEASED,
|
|
318
|
+
EVENT_LAST_DEFINED,
|
|
314
319
|
}
|
|
315
320
|
|
|
316
321
|
|
|
@@ -371,6 +376,37 @@ export namespace Atspi {
|
|
|
371
376
|
* Emulates unlocking a set of modifiers.
|
|
372
377
|
*/
|
|
373
378
|
UNLOCKMODIFIERS,
|
|
379
|
+
SYNTH_LAST_DEFINED,
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
/**
|
|
384
|
+
* @gir-type Enum
|
|
385
|
+
*/
|
|
386
|
+
export namespace Live {
|
|
387
|
+
export const $gtype: GObject.GType<Live>;
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
/**
|
|
391
|
+
* Enumeration used to indicate a type of live region and how assertive it
|
|
392
|
+
* should be in terms of speaking notifications. Currently, this is only used
|
|
393
|
+
* for "announcement" events, but it may be used for additional purposes
|
|
394
|
+
* in the future.
|
|
395
|
+
* @gir-type Enum
|
|
396
|
+
*/
|
|
397
|
+
enum Live {
|
|
398
|
+
/**
|
|
399
|
+
* No live region.
|
|
400
|
+
*/
|
|
401
|
+
NONE,
|
|
402
|
+
/**
|
|
403
|
+
* This live region should be considered polite.
|
|
404
|
+
*/
|
|
405
|
+
POLITE,
|
|
406
|
+
/**
|
|
407
|
+
* This live region should be considered assertive.
|
|
408
|
+
*/
|
|
409
|
+
ASSERTIVE,
|
|
374
410
|
}
|
|
375
411
|
|
|
376
412
|
|
|
@@ -415,6 +451,7 @@ export namespace Atspi {
|
|
|
415
451
|
* For time and date formatting.
|
|
416
452
|
*/
|
|
417
453
|
TIME,
|
|
454
|
+
LAST_DEFINED,
|
|
418
455
|
}
|
|
419
456
|
|
|
420
457
|
|
|
@@ -462,6 +499,10 @@ export namespace Atspi {
|
|
|
462
499
|
* See `ATSPI_MODIFIER_META`.
|
|
463
500
|
*/
|
|
464
501
|
META3,
|
|
502
|
+
/**
|
|
503
|
+
* Alias for META3.
|
|
504
|
+
*/
|
|
505
|
+
SUPER,
|
|
465
506
|
/**
|
|
466
507
|
* A symbolic meta key name that is mapped by AT-SPI
|
|
467
508
|
* to the appropriate META value, for the convenience of the client.
|
|
@@ -481,12 +522,12 @@ export namespace Atspi {
|
|
|
481
522
|
* {@link Atspi.RelationType} specifies a relationship between objects
|
|
482
523
|
* (possibly one-to-many
|
|
483
524
|
* or many-to-one) outside of the normal parent/child hierarchical
|
|
484
|
-
* relationship. It allows better semantic
|
|
525
|
+
* relationship. It allows better semantic identification of how objects
|
|
485
526
|
* are associated with one another. For instance the
|
|
486
527
|
* `ATSPI_RELATION_LABELLED_BY`
|
|
487
|
-
* relationship may be used to identify labelling information
|
|
528
|
+
* relationship may be used to identify labelling information that should
|
|
488
529
|
* accompany the accessible name property when presenting an object's content or
|
|
489
|
-
* identity
|
|
530
|
+
* identity to the end user. Similarly,
|
|
490
531
|
* `ATSPI_RELATION_CONTROLLER_FOR` can be used
|
|
491
532
|
* to further specify the context in which a valuator is useful, and/or the
|
|
492
533
|
* other UI components which are directly effected by user interactions with
|
|
@@ -616,35 +657,33 @@ export namespace Atspi {
|
|
|
616
657
|
*/
|
|
617
658
|
DESCRIBED_BY,
|
|
618
659
|
/**
|
|
619
|
-
* Reciprocal of {@link Atspi.RelationType.DETAILS_FOR}. Indicates
|
|
620
|
-
*
|
|
621
|
-
*
|
|
622
|
-
*
|
|
623
|
-
*
|
|
624
|
-
*
|
|
625
|
-
*
|
|
626
|
-
*
|
|
660
|
+
* Reciprocal of {@link Atspi.RelationType.DETAILS_FOR}. Indicates that this object has a
|
|
661
|
+
* detailed or extended description, the contents of which can be found in the
|
|
662
|
+
* target object(s). This relation type is most appropriate for information
|
|
663
|
+
* that is sufficiently lengthy as to make navigation to the container of that
|
|
664
|
+
* information desirable. For less verbose information suitable for
|
|
665
|
+
* announcement only, see {@link Atspi.RelationType.DESCRIBED_BY}. If the detailed
|
|
666
|
+
* information describes an error condition, {@link Atspi.RelationType.ERROR_FOR} should
|
|
667
|
+
* be used instead.
|
|
627
668
|
*/
|
|
628
669
|
DETAILS,
|
|
629
670
|
/**
|
|
630
|
-
* Reciprocal of {@link Atspi.RelationType.DETAILS}. Indicates
|
|
631
|
-
*
|
|
632
|
-
*
|
|
633
|
-
* {@link Atspi.RelationType.ERROR_FOR}. `Since`: 2.26.
|
|
671
|
+
* Reciprocal of {@link Atspi.RelationType.DETAILS}. Indicates that this object provides a
|
|
672
|
+
* detailed or extended description about the target object(s). See also
|
|
673
|
+
* {@link Atspi.RelationType.DESCRIPTION_FOR} and {@link Atspi.RelationType.ERROR_FOR}.
|
|
634
674
|
*/
|
|
635
675
|
DETAILS_FOR,
|
|
636
676
|
/**
|
|
637
|
-
* Reciprocal of {@link Atspi.RelationType.ERROR_FOR}.
|
|
638
|
-
*
|
|
639
|
-
*
|
|
640
|
-
*
|
|
641
|
-
* {@link Atspi.StateSet}. `Since`: 2.26.
|
|
677
|
+
* Reciprocal of {@link Atspi.RelationType.ERROR_FOR}. Indicates that this object has one
|
|
678
|
+
* or more errors, the nature of which is described in the contents of the
|
|
679
|
+
* target object(s). Objects that have this relation type should also contain
|
|
680
|
+
* {@link Atspi.StateType.INVALID_ENTRY} in their {@link Atspi.StateSet}.
|
|
642
681
|
*/
|
|
643
682
|
ERROR_MESSAGE,
|
|
644
683
|
/**
|
|
645
|
-
* Reciprocal of {@link Atspi.RelationType.ERROR_MESSAGE}.
|
|
646
|
-
*
|
|
647
|
-
*
|
|
684
|
+
* Reciprocal of {@link Atspi.RelationType.ERROR_MESSAGE}. Indicates that this object
|
|
685
|
+
* contains an error message describing an invalid condition in the target
|
|
686
|
+
* object(s).
|
|
648
687
|
*/
|
|
649
688
|
ERROR_FOR,
|
|
650
689
|
/**
|
|
@@ -703,7 +742,7 @@ export namespace Atspi {
|
|
|
703
742
|
CANVAS,
|
|
704
743
|
/**
|
|
705
744
|
* A choice that can be checked or unchecked and
|
|
706
|
-
* provides a separate
|
|
745
|
+
* provides a separate indicator for the current state.
|
|
707
746
|
*/
|
|
708
747
|
CHECK_BOX,
|
|
709
748
|
/**
|
|
@@ -729,7 +768,7 @@ export namespace Atspi {
|
|
|
729
768
|
*/
|
|
730
769
|
DATE_EDITOR,
|
|
731
770
|
/**
|
|
732
|
-
* An inconifed internal frame within a
|
|
771
|
+
* An inconifed internal frame within a DESKTOP_FRAME.
|
|
733
772
|
*/
|
|
734
773
|
DESKTOP_ICON,
|
|
735
774
|
/**
|
|
@@ -752,14 +791,14 @@ export namespace Atspi {
|
|
|
752
791
|
*/
|
|
753
792
|
DIRECTORY_PANE,
|
|
754
793
|
/**
|
|
755
|
-
*
|
|
756
|
-
*
|
|
757
|
-
* directory, or specify a filename.
|
|
794
|
+
* An object used for drawing custom user interface
|
|
795
|
+
* elements.
|
|
758
796
|
*/
|
|
759
797
|
DRAWING_AREA,
|
|
760
798
|
/**
|
|
761
|
-
*
|
|
762
|
-
*
|
|
799
|
+
* A specialized dialog that displays the files in
|
|
800
|
+
* the directory and lets the user select a file, browse a different
|
|
801
|
+
* directory, or specify a filename.
|
|
763
802
|
*/
|
|
764
803
|
FILE_CHOOSER,
|
|
765
804
|
/**
|
|
@@ -804,8 +843,9 @@ export namespace Atspi {
|
|
|
804
843
|
*/
|
|
805
844
|
INTERNAL_FRAME,
|
|
806
845
|
/**
|
|
807
|
-
*
|
|
808
|
-
*
|
|
846
|
+
* For text views, see `ATSPI_ROLE_TEXT`. For generic containers, see
|
|
847
|
+
* `ATSPI_ROLE_PANEL`. For objects whose role is not known by the implementor,
|
|
848
|
+
* see `ATSPI_ROLE_UNKNOWN`.
|
|
809
849
|
*/
|
|
810
850
|
LABEL,
|
|
811
851
|
/**
|
|
@@ -877,7 +917,7 @@ export namespace Atspi {
|
|
|
877
917
|
* An object the user can manipulate to tell the
|
|
878
918
|
* application to do something.
|
|
879
919
|
*/
|
|
880
|
-
|
|
920
|
+
BUTTON,
|
|
881
921
|
/**
|
|
882
922
|
* A specialized check box that will cause other
|
|
883
923
|
* radio buttons in the same group to become unchecked when this one is
|
|
@@ -909,7 +949,7 @@ export namespace Atspi {
|
|
|
909
949
|
* a large amount of information. `ATSPI_ROLE_SCROLL_PANE` objects are usually
|
|
910
950
|
* accompanied by `ATSPI_ROLE_SCROLL_BAR` controllers, on which the
|
|
911
951
|
* `ATSPI_RELATION_CONTROLLER_FOR` and `ATSPI_RELATION_CONTROLLED_BY`
|
|
912
|
-
* reciprocal relations are set. See
|
|
952
|
+
* reciprocal relations are set. See `atspi_get_relation_set`.
|
|
913
953
|
*/
|
|
914
954
|
SCROLL_PANE,
|
|
915
955
|
/**
|
|
@@ -919,14 +959,13 @@ export namespace Atspi {
|
|
|
919
959
|
SEPARATOR,
|
|
920
960
|
/**
|
|
921
961
|
* An object that allows the user to select from a bounded
|
|
922
|
-
* range.
|
|
962
|
+
* range. Unlike `ATSPI_ROLE_SCROLL_BAR`, `ATSPI_ROLE_SLIDER` objects need not control
|
|
963
|
+
* 'viewport'-like objects.
|
|
923
964
|
*/
|
|
924
965
|
SLIDER,
|
|
925
966
|
/**
|
|
926
967
|
* An object which allows one of a set of choices to
|
|
927
|
-
* be selected, and which displays the current choice.
|
|
928
|
-
* `ATSPI_ROLE_SCROLL_BAR`, `ATSPI_ROLE_SLIDER` objects need not control
|
|
929
|
-
* 'viewport'-like objects.
|
|
968
|
+
* be selected, and which displays the current choice.
|
|
930
969
|
*/
|
|
931
970
|
SPIN_BUTTON,
|
|
932
971
|
/**
|
|
@@ -1049,7 +1088,7 @@ export namespace Atspi {
|
|
|
1049
1088
|
/**
|
|
1050
1089
|
* An object corresponding to the toplevel accessible
|
|
1051
1090
|
* of an application, which may contain `ATSPI_ROLE_FRAME` objects or other
|
|
1052
|
-
* accessible objects. Children of
|
|
1091
|
+
* accessible objects. Children of objects with the #ATSPI_ROLE_DESKTOP_FRAME role are generally
|
|
1053
1092
|
* `ATSPI_ROLE_APPLICATION` objects.
|
|
1054
1093
|
*/
|
|
1055
1094
|
APPLICATION,
|
|
@@ -1082,7 +1121,7 @@ export namespace Atspi {
|
|
|
1082
1121
|
/**
|
|
1083
1122
|
* The object is a graphical depiction of quantitative data.
|
|
1084
1123
|
* It may contain multiple subelements whose attributes and/or description
|
|
1085
|
-
* may be queried to obtain both the
|
|
1124
|
+
* may be queried to obtain both the quantitative data and information about
|
|
1086
1125
|
* how the data is being presented. The `ATSPI_LABELLED_BY` relation is
|
|
1087
1126
|
* particularly important in interpreting objects of this type, as is the
|
|
1088
1127
|
* accessible description property. See `ATSPI_ROLE_CAPTION`.
|
|
@@ -1097,7 +1136,7 @@ export namespace Atspi {
|
|
|
1097
1136
|
/**
|
|
1098
1137
|
* The object is a visual frame or container which
|
|
1099
1138
|
* contains a view of document content. {@link Atspi.Document} frames may occur within
|
|
1100
|
-
* another {@link Atspi.Document} instance, in which case the second
|
|
1139
|
+
* another {@link Atspi.Document} instance, in which case the second document may be
|
|
1101
1140
|
* said to be embedded in the containing instance. HTML frames are often
|
|
1102
1141
|
* ATSPI_ROLE_DOCUMENT_FRAME: Either this object, or a singleton descendant,
|
|
1103
1142
|
* should implement the {@link Atspi.Document} interface.
|
|
@@ -1106,7 +1145,7 @@ export namespace Atspi {
|
|
|
1106
1145
|
/**
|
|
1107
1146
|
* The object serves as a heading for content which
|
|
1108
1147
|
* follows it in a document. The 'heading level' of the heading, if
|
|
1109
|
-
*
|
|
1148
|
+
* available, may be obtained by querying the object's attributes.
|
|
1110
1149
|
*/
|
|
1111
1150
|
HEADING,
|
|
1112
1151
|
/**
|
|
@@ -1226,81 +1265,70 @@ export namespace Atspi {
|
|
|
1226
1265
|
*/
|
|
1227
1266
|
INFO_BAR,
|
|
1228
1267
|
/**
|
|
1229
|
-
* A bar that serves as a level indicator to, for
|
|
1230
|
-
*
|
|
1268
|
+
* A bar that serves as a level indicator to, for instance, show the strength
|
|
1269
|
+
* of a password or the state of a battery.
|
|
1231
1270
|
*/
|
|
1232
1271
|
LEVEL_BAR,
|
|
1233
1272
|
/**
|
|
1234
|
-
* A bar that serves as the title of a window or a
|
|
1235
|
-
* dialog. `Since`: 2.12
|
|
1273
|
+
* A bar that serves as the title of a window or a dialog.
|
|
1236
1274
|
*/
|
|
1237
1275
|
TITLE_BAR,
|
|
1238
1276
|
/**
|
|
1239
|
-
* An object which contains a text section
|
|
1240
|
-
* that is quoted from another source. `Since`: 2.12
|
|
1277
|
+
* An object which contains a text section that is quoted from another source.
|
|
1241
1278
|
*/
|
|
1242
1279
|
BLOCK_QUOTE,
|
|
1243
1280
|
/**
|
|
1244
|
-
* An object which represents an audio
|
|
1245
|
-
* element. `Since`: 2.12
|
|
1281
|
+
* An object which represents an audio element.
|
|
1246
1282
|
*/
|
|
1247
1283
|
AUDIO,
|
|
1248
1284
|
/**
|
|
1249
|
-
* An object which represents a video
|
|
1250
|
-
* element. `Since`: 2.12
|
|
1285
|
+
* An object which represents a video element.
|
|
1251
1286
|
*/
|
|
1252
1287
|
VIDEO,
|
|
1253
1288
|
/**
|
|
1254
|
-
* A definition of a term or concept.
|
|
1289
|
+
* A definition of a term or concept.
|
|
1255
1290
|
*/
|
|
1256
1291
|
DEFINITION,
|
|
1257
1292
|
/**
|
|
1258
|
-
* A section of a page that consists of a
|
|
1259
|
-
*
|
|
1260
|
-
*
|
|
1261
|
-
* 2.12
|
|
1293
|
+
* A section of a page that consists of a composition that forms an
|
|
1294
|
+
* independent part of a document, page, or site. Examples: A blog entry, a
|
|
1295
|
+
* news story, a forum post.
|
|
1262
1296
|
*/
|
|
1263
1297
|
ARTICLE,
|
|
1264
1298
|
/**
|
|
1265
|
-
* A region of a web page intended as a
|
|
1266
|
-
*
|
|
1267
|
-
*
|
|
1268
|
-
* document. `Since`: 2.12
|
|
1299
|
+
* A region of a web page intended as a navigational landmark. This is
|
|
1300
|
+
* designed to allow Assistive Technologies to provide quick navigation among
|
|
1301
|
+
* key regions within a document.
|
|
1269
1302
|
*/
|
|
1270
1303
|
LANDMARK,
|
|
1271
1304
|
/**
|
|
1272
|
-
* A text widget or container holding log content, such
|
|
1273
|
-
*
|
|
1274
|
-
*
|
|
1275
|
-
*
|
|
1276
|
-
*
|
|
1277
|
-
* points. `Since`: 2.12
|
|
1305
|
+
* A text widget or container holding log content, such as chat history and
|
|
1306
|
+
* error logs. In this role there is a relationship between the arrival of new
|
|
1307
|
+
* items in the log and the reading order. The log contains a meaningful
|
|
1308
|
+
* sequence and new information is added only to the end of the log, not at
|
|
1309
|
+
* arbitrary points.
|
|
1278
1310
|
*/
|
|
1279
1311
|
LOG,
|
|
1280
1312
|
/**
|
|
1281
|
-
* A container where non-essential information
|
|
1282
|
-
*
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1285
|
-
* important content changes. `Since`: 2.12
|
|
1313
|
+
* A container where non-essential information changes frequently. Common
|
|
1314
|
+
* usages of marquee include stock tickers and ad banners. The primary
|
|
1315
|
+
* difference between a marquee and a log is that logs usually have a
|
|
1316
|
+
* meaningful order or sequence of important content changes.
|
|
1286
1317
|
*/
|
|
1287
1318
|
MARQUEE,
|
|
1288
1319
|
/**
|
|
1289
|
-
* A text widget or container that holds a mathematical
|
|
1290
|
-
* expression. `Since`: 2.12
|
|
1320
|
+
* A text widget or container that holds a mathematical expression.
|
|
1291
1321
|
*/
|
|
1292
1322
|
MATH,
|
|
1293
1323
|
/**
|
|
1294
|
-
* A widget whose purpose is to display a rating,
|
|
1295
|
-
*
|
|
1296
|
-
*
|
|
1297
|
-
* AtspiValue. `Since`: 2.12
|
|
1324
|
+
* A widget whose purpose is to display a rating, such as the number of stars
|
|
1325
|
+
* associated with a song in a media player. Objects of this role should also
|
|
1326
|
+
* implement AtspiValue.
|
|
1298
1327
|
*/
|
|
1299
1328
|
RATING,
|
|
1300
1329
|
/**
|
|
1301
|
-
* An object containing a numerical counter which
|
|
1302
|
-
*
|
|
1303
|
-
* remaining until an end point. `Since`: 2.12
|
|
1330
|
+
* An object containing a numerical counter which indicates an amount of
|
|
1331
|
+
* elapsed time from a start point, or the time remaining until an end point.
|
|
1304
1332
|
*/
|
|
1305
1333
|
TIMER,
|
|
1306
1334
|
/**
|
|
@@ -1314,87 +1342,87 @@ export namespace Atspi {
|
|
|
1314
1342
|
* object which has an accessible relation pointing to another object. The
|
|
1315
1343
|
* displayed information, as a general rule, should be exposed through the
|
|
1316
1344
|
* accessible name of the object. For labels which describe another widget, see
|
|
1317
|
-
* `ATSPI_ROLE_LABEL`. For text views, see `ATSPI_ROLE_TEXT`. For generic
|
|
1318
|
-
* containers, see `ATSPI_ROLE_PANEL`. For objects whose role is not known by the
|
|
1319
|
-
* implementor, see `ATSPI_ROLE_UNKNOWN`. `Since`: 2.16.
|
|
1320
1345
|
*/
|
|
1321
1346
|
STATIC,
|
|
1322
1347
|
/**
|
|
1323
|
-
* An object that represents a mathematical fraction.
|
|
1348
|
+
* An object that represents a mathematical fraction.
|
|
1324
1349
|
*/
|
|
1325
1350
|
MATH_FRACTION,
|
|
1326
1351
|
/**
|
|
1327
|
-
* An object that represents a mathematical expression
|
|
1328
|
-
*
|
|
1352
|
+
* An object that represents a mathematical expression displayed with a
|
|
1353
|
+
* radical.
|
|
1329
1354
|
*/
|
|
1330
1355
|
MATH_ROOT,
|
|
1331
1356
|
/**
|
|
1332
|
-
* An object that contains text that is displayed as a
|
|
1333
|
-
* subscript. `Since`: 2.16.
|
|
1357
|
+
* An object that contains text that is displayed as a subscript.
|
|
1334
1358
|
*/
|
|
1335
1359
|
SUBSCRIPT,
|
|
1336
1360
|
/**
|
|
1337
|
-
* An object that contains text that is displayed as a
|
|
1338
|
-
* superscript. `Since`: 2.16.
|
|
1361
|
+
* An object that contains text that is displayed as a superscript.
|
|
1339
1362
|
*/
|
|
1340
1363
|
SUPERSCRIPT,
|
|
1341
1364
|
/**
|
|
1342
|
-
* An object that represents a list of term-value
|
|
1343
|
-
*
|
|
1344
|
-
*
|
|
1345
|
-
*
|
|
1346
|
-
*
|
|
1365
|
+
* An object that represents a list of term-value groups. A term-value group
|
|
1366
|
+
* represents an individual description and consist of one or more names
|
|
1367
|
+
* (`ATSPI_ROLE_DESCRIPTION_TERM`) followed by one or more values
|
|
1368
|
+
* (`ATSPI_ROLE_DESCRIPTION_VALUE`). For each list, there should not be more
|
|
1369
|
+
* than one group with the same term name.
|
|
1347
1370
|
*/
|
|
1348
1371
|
DESCRIPTION_LIST,
|
|
1349
1372
|
/**
|
|
1350
|
-
* An object that represents a term or phrase
|
|
1351
|
-
* with a corresponding definition. `Since`: 2.26.
|
|
1373
|
+
* An object that represents a term or phrase with a corresponding definition.
|
|
1352
1374
|
*/
|
|
1353
1375
|
DESCRIPTION_TERM,
|
|
1354
1376
|
/**
|
|
1355
|
-
* An object that represents the description,
|
|
1356
|
-
* definition, or value of a term. `Since`: 2.26.
|
|
1377
|
+
* An object that represents the description, definition, or value of a term.
|
|
1357
1378
|
*/
|
|
1358
1379
|
DESCRIPTION_VALUE,
|
|
1359
1380
|
/**
|
|
1360
|
-
* An object that contains the text of a footnote.
|
|
1381
|
+
* An object that contains the text of a footnote.
|
|
1361
1382
|
*/
|
|
1362
1383
|
FOOTNOTE,
|
|
1363
1384
|
/**
|
|
1364
|
-
* Content previously deleted or proposed to be
|
|
1365
|
-
*
|
|
1366
|
-
* from reviewers. `Since`: 2.34.
|
|
1385
|
+
* Content previously deleted or proposed to be deleted, e.g. in revision
|
|
1386
|
+
* history or a content view providing suggestions from reviewers.
|
|
1367
1387
|
*/
|
|
1368
1388
|
CONTENT_DELETION,
|
|
1369
1389
|
/**
|
|
1370
|
-
* Content previously inserted or proposed to be
|
|
1371
|
-
*
|
|
1372
|
-
* from reviewers. `Since`: 2.34.
|
|
1390
|
+
* Content previously inserted or proposed to be inserted, e.g. in revision
|
|
1391
|
+
* history or a content view providing suggestions from reviewers.
|
|
1373
1392
|
*/
|
|
1374
1393
|
CONTENT_INSERTION,
|
|
1375
1394
|
/**
|
|
1376
|
-
* A run of content that is marked or highlighted, such as for
|
|
1377
|
-
*
|
|
1378
|
-
*
|
|
1379
|
-
*
|
|
1380
|
-
*
|
|
1395
|
+
* A run of content that is marked or highlighted, such as for reference
|
|
1396
|
+
* purposes, or to call it out as having a special purpose. If the marked
|
|
1397
|
+
* content has an associated section in the document elaborating on the reason
|
|
1398
|
+
* for the mark, then {@link Atspi.RelationType.DETAILS} should be used on the mark to
|
|
1399
|
+
* point to that associated section. In addition, the reciprocal relation
|
|
1381
1400
|
* {@link Atspi.RelationType.DETAILS_FOR} should be used on the associated content section
|
|
1382
|
-
* to point back to the mark.
|
|
1401
|
+
* to point back to the mark.
|
|
1383
1402
|
*/
|
|
1384
1403
|
MARK,
|
|
1385
1404
|
/**
|
|
1386
|
-
* A container for content that is called out as a proposed
|
|
1387
|
-
*
|
|
1388
|
-
*
|
|
1389
|
-
* {@link Atspi.Role.CONTENT_INSERTION}
|
|
1390
|
-
* actual change is.
|
|
1405
|
+
* A container for content that is called out as a proposed change from the
|
|
1406
|
+
* current version of the document, such as by a reviewer of the content. An
|
|
1407
|
+
* object with this role should include children with
|
|
1408
|
+
* {@link Atspi.Role.CONTENT_DELETION} and/or {@link Atspi.Role.CONTENT_INSERTION}, in any
|
|
1409
|
+
* order, to indicate what the actual change is.
|
|
1391
1410
|
*/
|
|
1392
1411
|
SUGGESTION,
|
|
1412
|
+
/**
|
|
1413
|
+
* A specialized push button to open a menu.
|
|
1414
|
+
*/
|
|
1415
|
+
PUSH_BUTTON_MENU,
|
|
1416
|
+
/**
|
|
1417
|
+
* A switch that can be toggled on/off.
|
|
1418
|
+
*/
|
|
1419
|
+
SWITCH,
|
|
1393
1420
|
/**
|
|
1394
1421
|
* Not a valid role, used for finding end of
|
|
1395
|
-
*
|
|
1422
|
+
* enumeration.
|
|
1396
1423
|
*/
|
|
1397
1424
|
LAST_DEFINED,
|
|
1425
|
+
PUSH_BUTTON,
|
|
1398
1426
|
}
|
|
1399
1427
|
|
|
1400
1428
|
|
|
@@ -1445,6 +1473,7 @@ export namespace Atspi {
|
|
|
1445
1473
|
* on the window.
|
|
1446
1474
|
*/
|
|
1447
1475
|
ANYWHERE,
|
|
1476
|
+
LAST_DEFINED,
|
|
1448
1477
|
}
|
|
1449
1478
|
|
|
1450
1479
|
|
|
@@ -1457,7 +1486,7 @@ export namespace Atspi {
|
|
|
1457
1486
|
|
|
1458
1487
|
/**
|
|
1459
1488
|
* Enumeration used by various interfaces indicating every possible state
|
|
1460
|
-
* an
|
|
1489
|
+
* an {@link Atspi.Accessible} object can assume.
|
|
1461
1490
|
* @gir-type Enum
|
|
1462
1491
|
*/
|
|
1463
1492
|
enum StateType {
|
|
@@ -1483,7 +1512,7 @@ export namespace Atspi {
|
|
|
1483
1512
|
ARMED,
|
|
1484
1513
|
/**
|
|
1485
1514
|
* Indicates the current object is busy, i.e. onscreen
|
|
1486
|
-
* representation is in the process of changing, or
|
|
1515
|
+
* representation is in the process of changing, or the object is
|
|
1487
1516
|
* temporarily unavailable for interaction due to activity already in progress.
|
|
1488
1517
|
*/
|
|
1489
1518
|
BUSY,
|
|
@@ -1497,7 +1526,7 @@ export namespace Atspi {
|
|
|
1497
1526
|
COLLAPSED,
|
|
1498
1527
|
/**
|
|
1499
1528
|
* Indicates that this object no longer has a valid
|
|
1500
|
-
* backing widget
|
|
1529
|
+
* backing widget (for instance, if its peer object has been destroyed).
|
|
1501
1530
|
*/
|
|
1502
1531
|
DEFUNCT,
|
|
1503
1532
|
/**
|
|
@@ -1582,7 +1611,7 @@ export namespace Atspi {
|
|
|
1582
1611
|
/**
|
|
1583
1612
|
* Indicates this object is the child of an object
|
|
1584
1613
|
* that allows its children to be selected and that this child is one of
|
|
1585
|
-
* those children
|
|
1614
|
+
* those children that can be selected.
|
|
1586
1615
|
*/
|
|
1587
1616
|
SELECTABLE,
|
|
1588
1617
|
/**
|
|
@@ -1735,23 +1764,20 @@ export namespace Atspi {
|
|
|
1735
1764
|
*/
|
|
1736
1765
|
VISITED,
|
|
1737
1766
|
/**
|
|
1738
|
-
* Indicates this object has the potential to
|
|
1739
|
-
*
|
|
1740
|
-
* 2.12
|
|
1767
|
+
* Indicates this object has the potential to be checked, such as a checkbox
|
|
1768
|
+
* or toggle-able table cell.
|
|
1741
1769
|
*/
|
|
1742
1770
|
CHECKABLE,
|
|
1743
1771
|
/**
|
|
1744
|
-
* Indicates that the object has a popup
|
|
1745
|
-
*
|
|
1746
|
-
*
|
|
1747
|
-
*
|
|
1748
|
-
* context. `Since`: 2.12
|
|
1772
|
+
* Indicates that the object has a popup context menu or sub-level menu
|
|
1773
|
+
* which may or may not be showing. This means that activation renders
|
|
1774
|
+
* conditional content. Note that ordinary tooltips are not considered
|
|
1775
|
+
* popups in this context.
|
|
1749
1776
|
*/
|
|
1750
1777
|
HAS_POPUP,
|
|
1751
1778
|
/**
|
|
1752
|
-
* Indicates that an object which is ENABLED and
|
|
1753
|
-
*
|
|
1754
|
-
* user. `Since`: 2.16
|
|
1779
|
+
* Indicates that an object which is ENABLED and SENSITIVE has a value
|
|
1780
|
+
* which can be read, but not modified, by the user.
|
|
1755
1781
|
*/
|
|
1756
1782
|
READ_ONLY,
|
|
1757
1783
|
/**
|
|
@@ -1831,6 +1857,7 @@ export namespace Atspi {
|
|
|
1831
1857
|
* range.
|
|
1832
1858
|
*/
|
|
1833
1859
|
LINE_END,
|
|
1860
|
+
LAST_DEFINED,
|
|
1834
1861
|
}
|
|
1835
1862
|
|
|
1836
1863
|
|
|
@@ -1866,6 +1893,7 @@ export namespace Atspi {
|
|
|
1866
1893
|
* bounded by min and max are retained.
|
|
1867
1894
|
*/
|
|
1868
1895
|
BOTH,
|
|
1896
|
+
LAST_DEFINED,
|
|
1869
1897
|
}
|
|
1870
1898
|
|
|
1871
1899
|
|
|
@@ -1914,11 +1942,47 @@ export namespace Atspi {
|
|
|
1914
1942
|
}
|
|
1915
1943
|
|
|
1916
1944
|
|
|
1945
|
+
/**
|
|
1946
|
+
* The version of the Application D-Bus interface.
|
|
1947
|
+
* @since 2.59
|
|
1948
|
+
*/
|
|
1949
|
+
const ACCESSIBLE_VERSION: number;
|
|
1950
|
+
|
|
1951
|
+
/**
|
|
1952
|
+
* The version of the Action D-Bus interface.
|
|
1953
|
+
* @since 2.59
|
|
1954
|
+
*/
|
|
1955
|
+
const ACTION_VERSION: number;
|
|
1956
|
+
|
|
1957
|
+
/**
|
|
1958
|
+
* The version of the Application D-Bus interface.
|
|
1959
|
+
* @since 2.59
|
|
1960
|
+
*/
|
|
1961
|
+
const APPLICATION_VERSION: number;
|
|
1962
|
+
|
|
1963
|
+
/**
|
|
1964
|
+
* The version of the Cache D-Bus interface.
|
|
1965
|
+
* @since 2.59
|
|
1966
|
+
*/
|
|
1967
|
+
const CACHE_VERSION: number;
|
|
1968
|
+
|
|
1969
|
+
/**
|
|
1970
|
+
* The version of the Collection D-Bus interface.
|
|
1971
|
+
* @since 2.59
|
|
1972
|
+
*/
|
|
1973
|
+
const COLLECTION_VERSION: number;
|
|
1974
|
+
|
|
1917
1975
|
/**
|
|
1918
1976
|
* One higher than the highest valid value of {@link Atspi.ComponentLayer}.
|
|
1919
1977
|
*/
|
|
1920
1978
|
const COMPONENTLAYER_COUNT: number;
|
|
1921
1979
|
|
|
1980
|
+
/**
|
|
1981
|
+
* The version of the Component D-Bus interface.
|
|
1982
|
+
* @since 2.59
|
|
1983
|
+
*/
|
|
1984
|
+
const COMPONENT_VERSION: number;
|
|
1985
|
+
|
|
1922
1986
|
/**
|
|
1923
1987
|
* One higher than the highest valid value of {@link Atspi.CoordType}.
|
|
1924
1988
|
*/
|
|
@@ -1958,6 +2022,10 @@ export namespace Atspi {
|
|
|
1958
2022
|
|
|
1959
2023
|
const DBUS_INTERFACE_IMAGE: string;
|
|
1960
2024
|
|
|
2025
|
+
const DBUS_INTERFACE_KEYBOARD_MONITOR: string;
|
|
2026
|
+
|
|
2027
|
+
const DBUS_INTERFACE_POINTER_LOCATOR: string;
|
|
2028
|
+
|
|
1961
2029
|
const DBUS_INTERFACE_REGISTRY: string;
|
|
1962
2030
|
|
|
1963
2031
|
const DBUS_INTERFACE_SELECTION: string;
|
|
@@ -1972,8 +2040,12 @@ export namespace Atspi {
|
|
|
1972
2040
|
|
|
1973
2041
|
const DBUS_INTERFACE_VALUE: string;
|
|
1974
2042
|
|
|
2043
|
+
const DBUS_NAME_A11Y_MANAGER: string;
|
|
2044
|
+
|
|
1975
2045
|
const DBUS_NAME_REGISTRY: string;
|
|
1976
2046
|
|
|
2047
|
+
const DBUS_PATH_A11Y_MANAGER: string;
|
|
2048
|
+
|
|
1977
2049
|
const DBUS_PATH_DEC: string;
|
|
1978
2050
|
|
|
1979
2051
|
const DBUS_PATH_NULL: string;
|
|
@@ -1984,11 +2056,63 @@ export namespace Atspi {
|
|
|
1984
2056
|
|
|
1985
2057
|
const DBUS_PATH_SCREEN_READER: string;
|
|
1986
2058
|
|
|
2059
|
+
const DEVICE_A11Y_MANAGER_VIRTUAL_MOD_END: number;
|
|
2060
|
+
|
|
2061
|
+
const DEVICE_A11Y_MANAGER_VIRTUAL_MOD_START: number;
|
|
2062
|
+
|
|
2063
|
+
/**
|
|
2064
|
+
* The version of the DeviceEventController D-Bus interface.
|
|
2065
|
+
* @since 2.59
|
|
2066
|
+
*/
|
|
2067
|
+
const DEVICE_EVENT_CONTROLLER_VERSION: number;
|
|
2068
|
+
|
|
2069
|
+
/**
|
|
2070
|
+
* The version of the DeviceEventListener D-Bus interface.
|
|
2071
|
+
* @since 2.59
|
|
2072
|
+
*/
|
|
2073
|
+
const DEVICE_EVENT_LISTENER_VERSION: number;
|
|
2074
|
+
|
|
2075
|
+
/**
|
|
2076
|
+
* The version of the Document D-Bus interface.
|
|
2077
|
+
* @since 2.59
|
|
2078
|
+
*/
|
|
2079
|
+
const DOCUMENT_VERSION: number;
|
|
2080
|
+
|
|
2081
|
+
/**
|
|
2082
|
+
* The version of the EditableText D-Bus interface.
|
|
2083
|
+
* @since 2.59
|
|
2084
|
+
*/
|
|
2085
|
+
const EDITABLE_TEXT_VERSION: number;
|
|
2086
|
+
|
|
1987
2087
|
/**
|
|
1988
2088
|
* One higher than the highest valid value of {@link Atspi.EventType}.
|
|
1989
2089
|
*/
|
|
1990
2090
|
const EVENTTYPE_COUNT: number;
|
|
1991
2091
|
|
|
2092
|
+
/**
|
|
2093
|
+
* The version of the Event D-Bus interface.
|
|
2094
|
+
* @since 2.59
|
|
2095
|
+
*/
|
|
2096
|
+
const EVENT_VERSION: number;
|
|
2097
|
+
|
|
2098
|
+
/**
|
|
2099
|
+
* The version of the Hyperlink D-Bus interface.
|
|
2100
|
+
* @since 2.59
|
|
2101
|
+
*/
|
|
2102
|
+
const HYPERLINK_VERSION: number;
|
|
2103
|
+
|
|
2104
|
+
/**
|
|
2105
|
+
* The version of the Hypertext D-Bus interface.
|
|
2106
|
+
* @since 2.59
|
|
2107
|
+
*/
|
|
2108
|
+
const HYPERTEXT_VERSION: number;
|
|
2109
|
+
|
|
2110
|
+
/**
|
|
2111
|
+
* The version of the Image D-Bus interface.
|
|
2112
|
+
* @since 2.59
|
|
2113
|
+
*/
|
|
2114
|
+
const IMAGE_VERSION: number;
|
|
2115
|
+
|
|
1992
2116
|
/**
|
|
1993
2117
|
* One higher than the highest valid value of {@link Atspi.KeyEventType}.
|
|
1994
2118
|
*/
|
|
@@ -2006,11 +2130,19 @@ export namespace Atspi {
|
|
|
2006
2130
|
|
|
2007
2131
|
const MATCHTYPES_COUNT: number;
|
|
2008
2132
|
|
|
2133
|
+
const MAX_CHILDREN: number;
|
|
2134
|
+
|
|
2009
2135
|
/**
|
|
2010
2136
|
* One higher than the highest valid value of {@link Atspi.ModifierType}.
|
|
2011
2137
|
*/
|
|
2012
2138
|
const MODIFIERTYPE_COUNT: number;
|
|
2013
2139
|
|
|
2140
|
+
/**
|
|
2141
|
+
* The version of the Registry D-Bus interface.
|
|
2142
|
+
* @since 2.59
|
|
2143
|
+
*/
|
|
2144
|
+
const REGISTRY_VERSION: number;
|
|
2145
|
+
|
|
2014
2146
|
/**
|
|
2015
2147
|
* One higher than the highest valid value of {@link Atspi.RelationType}.
|
|
2016
2148
|
*/
|
|
@@ -2026,6 +2158,18 @@ export namespace Atspi {
|
|
|
2026
2158
|
*/
|
|
2027
2159
|
const SCROLLTYPE_COUNT: number;
|
|
2028
2160
|
|
|
2161
|
+
/**
|
|
2162
|
+
* The version of the Selection D-Bus interface.
|
|
2163
|
+
* @since 2.59
|
|
2164
|
+
*/
|
|
2165
|
+
const SELECTION_VERSION: number;
|
|
2166
|
+
|
|
2167
|
+
/**
|
|
2168
|
+
* The version of the Socket D-Bus interface.
|
|
2169
|
+
* @since 2.59
|
|
2170
|
+
*/
|
|
2171
|
+
const SOCKET_VERSION: number;
|
|
2172
|
+
|
|
2029
2173
|
/**
|
|
2030
2174
|
* One higher than the highest valid value of {@link Atspi.CollectionSortOrder}.
|
|
2031
2175
|
*/
|
|
@@ -2036,6 +2180,18 @@ export namespace Atspi {
|
|
|
2036
2180
|
*/
|
|
2037
2181
|
const STATETYPE_COUNT: number;
|
|
2038
2182
|
|
|
2183
|
+
/**
|
|
2184
|
+
* The version of the TableCell D-Bus interface.
|
|
2185
|
+
* @since 2.59
|
|
2186
|
+
*/
|
|
2187
|
+
const TABLE_CELL_VERSION: number;
|
|
2188
|
+
|
|
2189
|
+
/**
|
|
2190
|
+
* The version of the Table D-Bus interface.
|
|
2191
|
+
* @since 2.59
|
|
2192
|
+
*/
|
|
2193
|
+
const TABLE_VERSION: number;
|
|
2194
|
+
|
|
2039
2195
|
/**
|
|
2040
2196
|
* One higher than the highest valid value of {@link Atspi.TextBoundaryType}.
|
|
2041
2197
|
*/
|
|
@@ -2046,12 +2202,24 @@ export namespace Atspi {
|
|
|
2046
2202
|
*/
|
|
2047
2203
|
const TEXT_CLIP_TYPE_COUNT: number;
|
|
2048
2204
|
|
|
2205
|
+
/**
|
|
2206
|
+
* The version of the Text D-Bus interface.
|
|
2207
|
+
* @since 2.59
|
|
2208
|
+
*/
|
|
2209
|
+
const TEXT_VERSION: number;
|
|
2210
|
+
|
|
2049
2211
|
/**
|
|
2050
2212
|
* One higher than the highest valid value of
|
|
2051
2213
|
* #AtspiCollection_TreeTraversalType.
|
|
2052
2214
|
*/
|
|
2053
2215
|
const TREETRAVERSALTYPE_COUNT: number;
|
|
2054
2216
|
|
|
2217
|
+
/**
|
|
2218
|
+
* The version of the Value D-Bus interface.
|
|
2219
|
+
* @since 2.59
|
|
2220
|
+
*/
|
|
2221
|
+
const VALUE_VERSION: number;
|
|
2222
|
+
|
|
2055
2223
|
/**
|
|
2056
2224
|
* Removes a device event listener from the registry's listener queue,
|
|
2057
2225
|
* ceasing notification of events of the specified type.
|
|
@@ -2117,6 +2285,15 @@ export namespace Atspi {
|
|
|
2117
2285
|
*/
|
|
2118
2286
|
function generate_mouse_event(x: bigint | number, y: bigint | number, name: string): boolean;
|
|
2119
2287
|
|
|
2288
|
+
/**
|
|
2289
|
+
* Like atspi_generate_mouse_event, but asynchronous.
|
|
2290
|
+
* @param x a `glong` indicating the screen x coordinate of the mouse event.
|
|
2291
|
+
* @param y a `glong` indicating the screen y coordinate of the mouse event.
|
|
2292
|
+
* @param name a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs").
|
|
2293
|
+
* @param callback a callback to be called when a reply is received. May be NULL.
|
|
2294
|
+
*/
|
|
2295
|
+
function generate_mouse_event_async(x: bigint | number, y: bigint | number, name: string, callback: GenerateMouseEventCB): void;
|
|
2296
|
+
|
|
2120
2297
|
/**
|
|
2121
2298
|
* Gets the virtual desktop indicated by index `i`.
|
|
2122
2299
|
* NOTE: currently multiple virtual desktops are not implemented;
|
|
@@ -2148,6 +2325,12 @@ export namespace Atspi {
|
|
|
2148
2325
|
*/
|
|
2149
2326
|
function get_desktop_list(): Accessible[];
|
|
2150
2327
|
|
|
2328
|
+
/**
|
|
2329
|
+
* Returns the version of the AT-SPI library being used at runtime.
|
|
2330
|
+
* @since 2.50
|
|
2331
|
+
*/
|
|
2332
|
+
function get_version(): [number, number, number];
|
|
2333
|
+
|
|
2151
2334
|
/**
|
|
2152
2335
|
* Connects to the accessibility registry and initializes the SPI.
|
|
2153
2336
|
* @returns 0 on success, 1 if already initialized, or an integer error code.
|
|
@@ -2161,11 +2344,11 @@ export namespace Atspi {
|
|
|
2161
2344
|
function is_initialized(): boolean;
|
|
2162
2345
|
|
|
2163
2346
|
/**
|
|
2164
|
-
*
|
|
2165
|
-
* @param listener
|
|
2166
|
-
* @param event_types
|
|
2167
|
-
* @param filter
|
|
2168
|
-
* @returns
|
|
2347
|
+
* This function does nothing and should not be called.
|
|
2348
|
+
* @param listener
|
|
2349
|
+
* @param event_types
|
|
2350
|
+
* @param filter
|
|
2351
|
+
* @returns Always returns `false`.
|
|
2169
2352
|
*/
|
|
2170
2353
|
function register_device_event_listener(listener: DeviceListener, event_types: DeviceEventMask, filter: null): boolean;
|
|
2171
2354
|
|
|
@@ -2186,14 +2369,32 @@ export namespace Atspi {
|
|
|
2186
2369
|
*/
|
|
2187
2370
|
function register_keystroke_listener(listener: DeviceListener, key_set: KeyDefinition[] | null, modmask: KeyMaskType, event_types: KeyEventMask, sync_type: KeyListenerSyncType): boolean;
|
|
2188
2371
|
|
|
2372
|
+
/**
|
|
2373
|
+
* Gets the localized description string describing the {@link Atspi.Role} `role`.
|
|
2374
|
+
* @param role an {@link Atspi.Role} object to query.
|
|
2375
|
+
* @returns the localized string describing the AtspiRole
|
|
2376
|
+
*/
|
|
2377
|
+
function role_get_localized_name(role: Role): string;
|
|
2378
|
+
|
|
2189
2379
|
/**
|
|
2190
2380
|
* Gets a localizable string that indicates the name of an {@link Atspi.Role}.
|
|
2191
|
-
* <em>DEPRECATED.</em>
|
|
2192
2381
|
* @param role an {@link Atspi.Role} object to query.
|
|
2193
2382
|
* @returns a localizable string name for an {@link Atspi.Role} enumerated type.
|
|
2194
2383
|
*/
|
|
2195
2384
|
function role_get_name(role: Role): string;
|
|
2196
2385
|
|
|
2386
|
+
/**
|
|
2387
|
+
* This function is used to configure whether a GMainLoop is used when
|
|
2388
|
+
* making DBus calls. Enabling this might be needed if the caller needs to
|
|
2389
|
+
* be able to handle communication from another process as part of handling
|
|
2390
|
+
* an AT-SPI method call, or if it has a UI that uses a gdbus-based AT-SPI
|
|
2391
|
+
* implementation (as with GTK 4, for instance). This introduces reentrancy,
|
|
2392
|
+
* which could potentially have undesired side-effects, so it is disabled
|
|
2393
|
+
* by default, which matches the pre-2.62 behavior.
|
|
2394
|
+
* @param enabled A gboolean indicating whether a GMainLoop should be used when making DBus calls.
|
|
2395
|
+
*/
|
|
2396
|
+
function set_g_main_loop_reentrancy(enabled: boolean): void;
|
|
2397
|
+
|
|
2197
2398
|
/**
|
|
2198
2399
|
* Sets the main loop context that AT-SPI should assume is in use when
|
|
2199
2400
|
* setting an idle callback.
|
|
@@ -2204,19 +2405,14 @@ export namespace Atspi {
|
|
|
2204
2405
|
function set_main_context(cnx: GLib.MainContext): void;
|
|
2205
2406
|
|
|
2206
2407
|
/**
|
|
2207
|
-
*
|
|
2208
|
-
* is called. Coordinates will be assumed to be relative to this window. This
|
|
2209
|
-
* is needed because, due to Wayland's security model, it is not currently
|
|
2210
|
-
* possible to retrieve global coordinates.
|
|
2211
|
-
* If NULL is passed, then AT-SPI will use the window that has focus at the
|
|
2212
|
-
* time that atspi_generate_mouse_event is called.
|
|
2408
|
+
* Deprecated. This function no longer does anything and should not be used.
|
|
2213
2409
|
* @param accessible the {@link Atspi.Accessible} corresponding to the window to select. should be a top-level window with a role of ATSPI_ROLE_APPLICATION.
|
|
2214
2410
|
*/
|
|
2215
2411
|
function set_reference_window(accessible: Accessible): void;
|
|
2216
2412
|
|
|
2217
2413
|
/**
|
|
2218
2414
|
* Set the timeout used for method calls. If this is not set explicitly,
|
|
2219
|
-
* a default of
|
|
2415
|
+
* a default of 800 ms is used.
|
|
2220
2416
|
* Note that at-spi2-registryd currently uses a timeout of 3 seconds when
|
|
2221
2417
|
* sending a keyboard event notification. This means that, if an AT makes
|
|
2222
2418
|
* a call in response to the keyboard notification and the application
|
|
@@ -2261,6 +2457,13 @@ export namespace Atspi {
|
|
|
2261
2457
|
(event: Event): void;
|
|
2262
2458
|
}
|
|
2263
2459
|
|
|
2460
|
+
/**
|
|
2461
|
+
* @gir-type Callback
|
|
2462
|
+
*/
|
|
2463
|
+
interface GenerateMouseEventCB {
|
|
2464
|
+
(user_data: null): void;
|
|
2465
|
+
}
|
|
2466
|
+
|
|
2264
2467
|
/**
|
|
2265
2468
|
* @gir-type Callback
|
|
2266
2469
|
*/
|
|
@@ -2294,6 +2497,50 @@ export namespace Atspi {
|
|
|
2294
2497
|
}
|
|
2295
2498
|
|
|
2296
2499
|
|
|
2500
|
+
/**
|
|
2501
|
+
* @gir-type Flags
|
|
2502
|
+
*/
|
|
2503
|
+
export namespace DeviceCapability {
|
|
2504
|
+
export const $gtype: GObject.GType<DeviceCapability>;
|
|
2505
|
+
}
|
|
2506
|
+
|
|
2507
|
+
/**
|
|
2508
|
+
* Enumeration used to query and enable device capabilities.
|
|
2509
|
+
* @gir-type Flags
|
|
2510
|
+
* @since 2.60
|
|
2511
|
+
*/
|
|
2512
|
+
enum DeviceCapability {
|
|
2513
|
+
/**
|
|
2514
|
+
* The capability to monitor keystrokes.
|
|
2515
|
+
*/
|
|
2516
|
+
KEYBOARD_MONITOR,
|
|
2517
|
+
/**
|
|
2518
|
+
* The capability to synthesize keystrokes.
|
|
2519
|
+
*/
|
|
2520
|
+
KEYBOARD_SYNTH,
|
|
2521
|
+
/**
|
|
2522
|
+
* The capability to set key grabs.
|
|
2523
|
+
*/
|
|
2524
|
+
KEYBOARD_GRAB,
|
|
2525
|
+
/**
|
|
2526
|
+
* The capability to monitor the location of the pointer.
|
|
2527
|
+
*/
|
|
2528
|
+
POINTER_MONITOR,
|
|
2529
|
+
/**
|
|
2530
|
+
* The capability to synthesize pointer motion.
|
|
2531
|
+
*/
|
|
2532
|
+
POINTER_SYNTH,
|
|
2533
|
+
/**
|
|
2534
|
+
* The capability to monitor touch presses.
|
|
2535
|
+
*/
|
|
2536
|
+
TOUCH_MONITOR,
|
|
2537
|
+
/**
|
|
2538
|
+
* The capability to synthesize touch events.
|
|
2539
|
+
*/
|
|
2540
|
+
TOUCH_SYNTH,
|
|
2541
|
+
}
|
|
2542
|
+
|
|
2543
|
+
|
|
2297
2544
|
/**
|
|
2298
2545
|
* @gir-type Flags
|
|
2299
2546
|
*/
|
|
@@ -2320,7 +2567,7 @@ export namespace Atspi {
|
|
|
2320
2567
|
NOSYNC,
|
|
2321
2568
|
/**
|
|
2322
2569
|
* Events are delivered synchronously, before the
|
|
2323
|
-
* currently
|
|
2570
|
+
* currently focused application sees them.
|
|
2324
2571
|
*/
|
|
2325
2572
|
SYNCHRONOUS,
|
|
2326
2573
|
/**
|
|
@@ -2374,6 +2621,11 @@ export namespace Atspi {
|
|
|
2374
2621
|
}
|
|
2375
2622
|
|
|
2376
2623
|
/**
|
|
2624
|
+
* The base interface which is implemented by all accessible objects.
|
|
2625
|
+
*
|
|
2626
|
+
* All objects support interfaces for querying their contained 'children'
|
|
2627
|
+
* and position in the accessible-object hierarchy, whether or not they
|
|
2628
|
+
* actually have children.
|
|
2377
2629
|
* @gir-type Class
|
|
2378
2630
|
*/
|
|
2379
2631
|
class Accessible extends Object implements Action, Collection, Component, Document, EditableText, Hypertext, Image, Selection, Table, TableCell, Text, Value {
|
|
@@ -2444,6 +2696,11 @@ export namespace Atspi {
|
|
|
2444
2696
|
*/
|
|
2445
2697
|
clear_cache(): void;
|
|
2446
2698
|
|
|
2699
|
+
/**
|
|
2700
|
+
* Clears the cached information only for the given accessible.
|
|
2701
|
+
*/
|
|
2702
|
+
clear_cache_single(): void;
|
|
2703
|
+
|
|
2447
2704
|
/**
|
|
2448
2705
|
* Gets the accessible id of the accessible. This is not meant to be presented
|
|
2449
2706
|
* to the user, but to be an id which is stable over application development.
|
|
@@ -2452,6 +2709,12 @@ export namespace Atspi {
|
|
|
2452
2709
|
*/
|
|
2453
2710
|
get_accessible_id(): string;
|
|
2454
2711
|
|
|
2712
|
+
/**
|
|
2713
|
+
* Gets the {@link Atspi.Action} interface for an {@link Atspi.Accessible}.
|
|
2714
|
+
* @returns a pointer to an {@link Atspi.Action} interface instance, or NULL if `obj` does not implement {@link Atspi.Action}.
|
|
2715
|
+
*/
|
|
2716
|
+
get_action(): Action;
|
|
2717
|
+
|
|
2455
2718
|
/**
|
|
2456
2719
|
* Gets the {@link Atspi.Action} interface for an {@link Atspi.Accessible}.
|
|
2457
2720
|
* @returns a pointer to an {@link Atspi.Action} interface instance, or NULL if `obj` does not implement {@link Atspi.Action}.
|
|
@@ -2503,12 +2766,24 @@ export namespace Atspi {
|
|
|
2503
2766
|
*/
|
|
2504
2767
|
get_child_count(): number;
|
|
2505
2768
|
|
|
2769
|
+
/**
|
|
2770
|
+
* Gets the {@link Atspi.Collection} interface for an {@link Atspi.Accessible}.
|
|
2771
|
+
* @returns a pointer to an {@link Atspi.Collection} interface instance, or NULL if `obj` does not implement {@link Atspi.Collection}.
|
|
2772
|
+
*/
|
|
2773
|
+
get_collection(): Collection;
|
|
2774
|
+
|
|
2506
2775
|
/**
|
|
2507
2776
|
* Gets the {@link Atspi.Collection} interface for an {@link Atspi.Accessible}.
|
|
2508
2777
|
* @returns a pointer to an {@link Atspi.Collection} interface instance, or NULL if `obj` does not implement {@link Atspi.Collection}.
|
|
2509
2778
|
*/
|
|
2510
2779
|
get_collection_iface(): Collection;
|
|
2511
2780
|
|
|
2781
|
+
/**
|
|
2782
|
+
* Gets the {@link Atspi.Component} interface for an {@link Atspi.Accessible}.
|
|
2783
|
+
* @returns a pointer to an {@link Atspi.Component} interface instance, or NULL if `obj` does not implement {@link Atspi.Component}.
|
|
2784
|
+
*/
|
|
2785
|
+
get_component(): Component;
|
|
2786
|
+
|
|
2512
2787
|
/**
|
|
2513
2788
|
* Gets the {@link Atspi.Component} interface for an {@link Atspi.Accessible}.
|
|
2514
2789
|
* @returns a pointer to an {@link Atspi.Component} interface instance, or NULL if `obj` does not implement {@link Atspi.Component}.
|
|
@@ -2521,24 +2796,50 @@ export namespace Atspi {
|
|
|
2521
2796
|
*/
|
|
2522
2797
|
get_description(): string;
|
|
2523
2798
|
|
|
2799
|
+
/**
|
|
2800
|
+
* Gets the {@link Atspi.Document} interface for an {@link Atspi.Accessible}.
|
|
2801
|
+
* @returns a pointer to an {@link Atspi.Document} interface instance, or NULL if `obj` does not implement {@link Atspi.Document}.
|
|
2802
|
+
*/
|
|
2803
|
+
get_document(): Document;
|
|
2804
|
+
|
|
2524
2805
|
/**
|
|
2525
2806
|
* Gets the {@link Atspi.Document} interface for an {@link Atspi.Accessible}.
|
|
2526
2807
|
* @returns a pointer to an {@link Atspi.Document} interface instance, or NULL if `obj` does not implement {@link Atspi.Document}.
|
|
2527
2808
|
*/
|
|
2528
2809
|
get_document_iface(): Document;
|
|
2529
2810
|
|
|
2811
|
+
/**
|
|
2812
|
+
* Gets the {@link Atspi.EditableText} interface for an {@link Atspi.Accessible}.
|
|
2813
|
+
* @returns a pointer to an {@link Atspi.EditableText} interface instance, or NULL if `obj` does not implement {@link Atspi.EditableText}.
|
|
2814
|
+
*/
|
|
2815
|
+
get_editable_text(): EditableText;
|
|
2816
|
+
|
|
2530
2817
|
/**
|
|
2531
2818
|
* Gets the {@link Atspi.EditableText} interface for an {@link Atspi.Accessible}.
|
|
2532
2819
|
* @returns a pointer to an {@link Atspi.EditableText} interface instance, or NULL if `obj` does not implement {@link Atspi.EditableText}.
|
|
2533
2820
|
*/
|
|
2534
2821
|
get_editable_text_iface(): EditableText;
|
|
2535
2822
|
|
|
2823
|
+
/**
|
|
2824
|
+
* Gets the help text associated with the accessible, if set. When this is
|
|
2825
|
+
* present, it provides information that a screen reader can relay to the user
|
|
2826
|
+
* to explain how to interact with the object.
|
|
2827
|
+
* @returns a character string representing the help text for the {@link Atspi.Accessible} object or NULL on exception.
|
|
2828
|
+
*/
|
|
2829
|
+
get_help_text(): string;
|
|
2830
|
+
|
|
2536
2831
|
/**
|
|
2537
2832
|
* Gets the {@link Atspi.Hyperlink} interface for an {@link Atspi.Accessible}.
|
|
2538
2833
|
* @returns the {@link Atspi.Hyperlink} object associated with the given {@link Atspi.Accessible}, or NULL if not supported.
|
|
2539
2834
|
*/
|
|
2540
2835
|
get_hyperlink(): Hyperlink;
|
|
2541
2836
|
|
|
2837
|
+
/**
|
|
2838
|
+
* Gets the {@link Atspi.Hypertext} interface for an {@link Atspi.Accessible}.
|
|
2839
|
+
* @returns a pointer to an {@link Atspi.Hypertext} interface instance, or NULL if `obj` does not implement {@link Atspi.Hypertext}.
|
|
2840
|
+
*/
|
|
2841
|
+
get_hypertext(): Hypertext;
|
|
2842
|
+
|
|
2542
2843
|
/**
|
|
2543
2844
|
* Gets the {@link Atspi.Hypertext} interface for an {@link Atspi.Accessible}.
|
|
2544
2845
|
* @returns a pointer to an {@link Atspi.Hypertext} interface instance, or NULL if `obj` does not implement {@link Atspi.Hypertext}.
|
|
@@ -2552,6 +2853,12 @@ export namespace Atspi {
|
|
|
2552
2853
|
*/
|
|
2553
2854
|
get_id(): number;
|
|
2554
2855
|
|
|
2856
|
+
/**
|
|
2857
|
+
* Gets the {@link Atspi.Image} interface for an {@link Atspi.Accessible}.
|
|
2858
|
+
* @returns a pointer to an {@link Atspi.Image} interface instance, or NULL if `obj` does not implement {@link Atspi.Image}.
|
|
2859
|
+
*/
|
|
2860
|
+
get_image(): Image;
|
|
2861
|
+
|
|
2555
2862
|
/**
|
|
2556
2863
|
* Gets the {@link Atspi.Image} interface for an {@link Atspi.Accessible}.
|
|
2557
2864
|
* @returns a pointer to an {@link Atspi.Image} interface instance, or NULL if `obj` does not implement {@link Atspi.Image}.
|
|
@@ -2624,6 +2931,18 @@ export namespace Atspi {
|
|
|
2624
2931
|
*/
|
|
2625
2932
|
get_role_name(): string;
|
|
2626
2933
|
|
|
2934
|
+
/**
|
|
2935
|
+
* Gets the {@link Atspi.Selection} interface for an {@link Atspi.Accessible}.
|
|
2936
|
+
* @returns a pointer to an {@link Atspi.Selection} interface instance, or NULL if `obj` does not implement {@link Atspi.Selection}.
|
|
2937
|
+
*/
|
|
2938
|
+
get_selection(): Selection;
|
|
2939
|
+
|
|
2940
|
+
/**
|
|
2941
|
+
* @param args
|
|
2942
|
+
*/
|
|
2943
|
+
// Conflicted with Atspi.Text.get_selection
|
|
2944
|
+
get_selection(...args: never[]): any;
|
|
2945
|
+
|
|
2627
2946
|
/**
|
|
2628
2947
|
* Gets the {@link Atspi.Selection} interface for an {@link Atspi.Accessible}.
|
|
2629
2948
|
* @returns a pointer to an {@link Atspi.Selection} interface instance, or NULL if `obj` does not implement {@link Atspi.Selection}.
|
|
@@ -2640,7 +2959,13 @@ export namespace Atspi {
|
|
|
2640
2959
|
* Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
|
|
2641
2960
|
* @returns a pointer to an {@link Atspi.Table} interface instance, or NULL if `obj` does not implement {@link Atspi.Table}.
|
|
2642
2961
|
*/
|
|
2643
|
-
|
|
2962
|
+
get_table(): Table;
|
|
2963
|
+
|
|
2964
|
+
/**
|
|
2965
|
+
* @param args
|
|
2966
|
+
*/
|
|
2967
|
+
// Conflicted with Atspi.TableCell.get_table
|
|
2968
|
+
get_table(...args: never[]): any;
|
|
2644
2969
|
|
|
2645
2970
|
/**
|
|
2646
2971
|
* Gets the {@link Atspi.TableCell} interface for an {@link Atspi.Accessible}.
|
|
@@ -2648,6 +2973,24 @@ export namespace Atspi {
|
|
|
2648
2973
|
*/
|
|
2649
2974
|
get_table_cell(): TableCell;
|
|
2650
2975
|
|
|
2976
|
+
/**
|
|
2977
|
+
* Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
|
|
2978
|
+
* @returns a pointer to an {@link Atspi.Table} interface instance, or NULL if `obj` does not implement {@link Atspi.Table}.
|
|
2979
|
+
*/
|
|
2980
|
+
get_table_iface(): Table;
|
|
2981
|
+
|
|
2982
|
+
/**
|
|
2983
|
+
* Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
|
|
2984
|
+
* @returns a pointer to an {@link Atspi.Text} interface instance, or NULL if `obj` does not implement {@link Atspi.Text}.
|
|
2985
|
+
*/
|
|
2986
|
+
get_text(): Text;
|
|
2987
|
+
|
|
2988
|
+
/**
|
|
2989
|
+
* @param args
|
|
2990
|
+
*/
|
|
2991
|
+
// Conflicted with Atspi.Text.get_text
|
|
2992
|
+
get_text(...args: never[]): any;
|
|
2993
|
+
|
|
2651
2994
|
/**
|
|
2652
2995
|
* Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
|
|
2653
2996
|
* @returns a pointer to an {@link Atspi.Text} interface instance, or NULL if `obj` does not implement {@link Atspi.Text}.
|
|
@@ -2668,12 +3011,115 @@ export namespace Atspi {
|
|
|
2668
3011
|
*/
|
|
2669
3012
|
get_toolkit_version(): string;
|
|
2670
3013
|
|
|
3014
|
+
/**
|
|
3015
|
+
* Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
|
|
3016
|
+
* @returns a pointer to an {@link Atspi.Value} interface instance, or NULL if `obj` does not implement {@link Atspi.Value}.
|
|
3017
|
+
*/
|
|
3018
|
+
get_value(): Value;
|
|
3019
|
+
|
|
2671
3020
|
/**
|
|
2672
3021
|
* Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
|
|
2673
3022
|
* @returns a pointer to an {@link Atspi.Value} interface instance, or NULL if `obj` does not implement {@link Atspi.Value}.
|
|
2674
3023
|
*/
|
|
2675
3024
|
get_value_iface(): Value;
|
|
2676
3025
|
|
|
3026
|
+
/**
|
|
3027
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3028
|
+
* {@link Atspi.Action} interface.
|
|
3029
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Action} interface, `FALSE` otherwise.
|
|
3030
|
+
*/
|
|
3031
|
+
is_action(): boolean;
|
|
3032
|
+
|
|
3033
|
+
/**
|
|
3034
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3035
|
+
* {@link Atspi.Application} interface.
|
|
3036
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Application} interface, `FALSE` otherwise.
|
|
3037
|
+
*/
|
|
3038
|
+
is_application(): boolean;
|
|
3039
|
+
|
|
3040
|
+
/**
|
|
3041
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3042
|
+
* {@link Atspi.Collection} interface.
|
|
3043
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Collection} interface, `FALSE` otherwise.
|
|
3044
|
+
*/
|
|
3045
|
+
is_collection(): boolean;
|
|
3046
|
+
|
|
3047
|
+
/**
|
|
3048
|
+
* Query whether the specified {@link Atspi.Accessible} implements {@link Atspi.Component}.
|
|
3049
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Component} interface, `FALSE` otherwise.
|
|
3050
|
+
*/
|
|
3051
|
+
is_component(): boolean;
|
|
3052
|
+
|
|
3053
|
+
/**
|
|
3054
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3055
|
+
* {@link Atspi.Document} interface.
|
|
3056
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Document} interface, `FALSE` otherwise.
|
|
3057
|
+
*/
|
|
3058
|
+
is_document(): boolean;
|
|
3059
|
+
|
|
3060
|
+
/**
|
|
3061
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3062
|
+
* {@link Atspi.EditableText} interface.
|
|
3063
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.EditableText} interface, `FALSE` otherwise.
|
|
3064
|
+
*/
|
|
3065
|
+
is_editable_text(): boolean;
|
|
3066
|
+
|
|
3067
|
+
/**
|
|
3068
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3069
|
+
* {@link Atspi.Hyperlink} interface.
|
|
3070
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Hypertext} interface, `FALSE` otherwise.
|
|
3071
|
+
*/
|
|
3072
|
+
is_hyperlink(): boolean;
|
|
3073
|
+
|
|
3074
|
+
/**
|
|
3075
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3076
|
+
* {@link Atspi.Hypertext} interface.
|
|
3077
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Hypertext} interface, `FALSE` otherwise.
|
|
3078
|
+
*/
|
|
3079
|
+
is_hypertext(): boolean;
|
|
3080
|
+
|
|
3081
|
+
/**
|
|
3082
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3083
|
+
* {@link Atspi.Image} interface.
|
|
3084
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Image} interface, `FALSE` otherwise.
|
|
3085
|
+
*/
|
|
3086
|
+
is_image(): boolean;
|
|
3087
|
+
|
|
3088
|
+
/**
|
|
3089
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3090
|
+
* {@link Atspi.Selection} interface.
|
|
3091
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Selection} interface, `FALSE` otherwise.
|
|
3092
|
+
*/
|
|
3093
|
+
is_selection(): boolean;
|
|
3094
|
+
|
|
3095
|
+
/**
|
|
3096
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3097
|
+
* {@link Atspi.Table} interface.
|
|
3098
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Table} interface, `FALSE` otherwise.
|
|
3099
|
+
*/
|
|
3100
|
+
is_table(): boolean;
|
|
3101
|
+
|
|
3102
|
+
/**
|
|
3103
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3104
|
+
* {@link Atspi.TableCell} interface.
|
|
3105
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Table} interface, `FALSE` otherwise.
|
|
3106
|
+
*/
|
|
3107
|
+
is_table_cell(): boolean;
|
|
3108
|
+
|
|
3109
|
+
/**
|
|
3110
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3111
|
+
* {@link Atspi.Text} interface.
|
|
3112
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Text} interface, `FALSE` otherwise.
|
|
3113
|
+
*/
|
|
3114
|
+
is_text(): boolean;
|
|
3115
|
+
|
|
3116
|
+
/**
|
|
3117
|
+
* Query whether the specified {@link Atspi.Accessible} implements the
|
|
3118
|
+
* {@link Atspi.Value} interface.
|
|
3119
|
+
* @returns `TRUE` if `obj` implements the {@link Atspi.Value} interface, `FALSE` otherwise.
|
|
3120
|
+
*/
|
|
3121
|
+
is_value(): boolean;
|
|
3122
|
+
|
|
2677
3123
|
/**
|
|
2678
3124
|
* Sets the type of data to cache for accessibles.
|
|
2679
3125
|
* If this is not set for an application or is reset to ATSPI_CACHE_UNDEFINED,
|
|
@@ -2761,7 +3207,7 @@ export namespace Atspi {
|
|
|
2761
3207
|
* @param rule An {@link Atspi.MatchRule} describing the match criteria.
|
|
2762
3208
|
* @param sortby An {@link Atspi.CollectionSortOrder} specifying the way the results are to be sorted.
|
|
2763
3209
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
2764
|
-
* @param traverse
|
|
3210
|
+
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
2765
3211
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule.
|
|
2766
3212
|
*/
|
|
2767
3213
|
get_matches(rule: MatchRule, sortby: CollectionSortOrder, count: number, traverse: boolean): Accessible[];
|
|
@@ -2774,7 +3220,7 @@ export namespace Atspi {
|
|
|
2774
3220
|
* @param sortby An {@link Atspi.CollectionSortOrder} specifying the way the results are to be sorted.
|
|
2775
3221
|
* @param tree An {@link Atspi.CollectionTreeTraversalType} specifying restrictions on the objects to be traversed.
|
|
2776
3222
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
2777
|
-
* @param traverse
|
|
3223
|
+
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
2778
3224
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule that preceed `current_object`.
|
|
2779
3225
|
*/
|
|
2780
3226
|
get_matches_from(current_object: Accessible, rule: MatchRule, sortby: CollectionSortOrder, tree: CollectionTreeTraversalType, count: number, traverse: boolean): Accessible[];
|
|
@@ -2788,7 +3234,7 @@ export namespace Atspi {
|
|
|
2788
3234
|
* @param tree An {@link Atspi.CollectionTreeTraversalType} specifying restrictions on the objects to be traversed.
|
|
2789
3235
|
* @param limit_scope If `TRUE`, only descendants of `current_object`'s parent will be returned. Otherwise (if `FALSE`), any accessible may be returned if it would preceed `current_object` in a flattened hierarchy.
|
|
2790
3236
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
2791
|
-
* @param traverse
|
|
3237
|
+
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
2792
3238
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule after `current_object`.
|
|
2793
3239
|
*/
|
|
2794
3240
|
get_matches_to(current_object: Accessible, rule: MatchRule, sortby: CollectionSortOrder, tree: CollectionTreeTraversalType, limit_scope: boolean, count: number, traverse: boolean): Accessible[];
|
|
@@ -2896,8 +3342,8 @@ export namespace Atspi {
|
|
|
2896
3342
|
|
|
2897
3343
|
/**
|
|
2898
3344
|
* Moves and resizes the specified component.
|
|
2899
|
-
* @param x the new
|
|
2900
|
-
* @param y the new
|
|
3345
|
+
* @param x the new horizontal position to which the component should be moved.
|
|
3346
|
+
* @param y the new vertical position to which the component should be moved.
|
|
2901
3347
|
* @param width the width to which the component should be resized.
|
|
2902
3348
|
* @param height the height to which the component should be resized.
|
|
2903
3349
|
* @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
@@ -2907,15 +3353,15 @@ export namespace Atspi {
|
|
|
2907
3353
|
|
|
2908
3354
|
/**
|
|
2909
3355
|
* Moves the component to the specified position.
|
|
2910
|
-
* @param x the new
|
|
2911
|
-
* @param y the new
|
|
3356
|
+
* @param x the new horizontal position to which the component should be moved.
|
|
3357
|
+
* @param y the new vertical position to which the component should be moved.
|
|
2912
3358
|
* @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
2913
3359
|
* @returns `TRUE` if successful; `FALSE` otherwise.
|
|
2914
3360
|
*/
|
|
2915
3361
|
set_position(x: number, y: number, ctype: CoordType): boolean;
|
|
2916
3362
|
|
|
2917
3363
|
/**
|
|
2918
|
-
* Resizes the specified component to the given
|
|
3364
|
+
* Resizes the specified component to the given pixel dimensions.
|
|
2919
3365
|
* @param width the width to which the component should be resized.
|
|
2920
3366
|
* @param height the height to which the component should be resized.
|
|
2921
3367
|
* @returns `TRUE` if successful; `FALSE` otherwise.
|
|
@@ -2955,6 +3401,23 @@ export namespace Atspi {
|
|
|
2955
3401
|
*/
|
|
2956
3402
|
get_page_count(): number;
|
|
2957
3403
|
|
|
3404
|
+
/**
|
|
3405
|
+
* Returns an array of AtspiTextSelections within this document.
|
|
3406
|
+
* @returns a GArray of AtspiTextSelection structures representing the selection.
|
|
3407
|
+
*/
|
|
3408
|
+
get_text_selections(): TextSelection[];
|
|
3409
|
+
|
|
3410
|
+
/**
|
|
3411
|
+
* Makes 1 or more selections within this document denoted by the given
|
|
3412
|
+
* array of AtspiTextSelections. Any existing physical selection (inside or
|
|
3413
|
+
* outside this document) is replaced by the new selections. All objects within
|
|
3414
|
+
* the given selection ranges must be descendants of this document. Otherwise
|
|
3415
|
+
* FALSE will be returned.
|
|
3416
|
+
* @param selections a GArray of AtspiTextSelections to be selected.
|
|
3417
|
+
* @returns TRUE if the selection was made successfully; FALSE otherwise.
|
|
3418
|
+
*/
|
|
3419
|
+
set_text_selections(selections: TextSelection[]): boolean;
|
|
3420
|
+
|
|
2958
3421
|
/**
|
|
2959
3422
|
* Copies text from an {@link Atspi.EditableText} object into the system clipboard.
|
|
2960
3423
|
*
|
|
@@ -3098,11 +3561,11 @@ export namespace Atspi {
|
|
|
3098
3561
|
|
|
3099
3562
|
/**
|
|
3100
3563
|
* Removes a child from the selected children list of an {@link Atspi.Selection}.
|
|
3101
|
-
* Note that `
|
|
3102
|
-
* not the index in the parent container.
|
|
3103
|
-
* method
|
|
3104
|
-
* are asymmetric.
|
|
3105
|
-
* @param selected_child_index a `gint` indicating which of the selected children of the {@link Atspi.Accessible} is to be
|
|
3564
|
+
* Note that `selected_child_index` is the index in the
|
|
3565
|
+
* selected-children list, not the index in the parent container.
|
|
3566
|
+
* `selected_child_index` in this method and `child_index` in
|
|
3567
|
+
* `atspi_selection_select_child` are asymmetric.
|
|
3568
|
+
* @param selected_child_index a `gint` indicating which of the selected children of the {@link Atspi.Accessible} is to be deselected.
|
|
3106
3569
|
* @returns `TRUE` if the child was successfully deselected, `FALSE` otherwise.
|
|
3107
3570
|
*/
|
|
3108
3571
|
deselect_selected_child(selected_child_index: number): boolean;
|
|
@@ -3429,12 +3892,6 @@ export namespace Atspi {
|
|
|
3429
3892
|
*/
|
|
3430
3893
|
get_row_span(): number;
|
|
3431
3894
|
|
|
3432
|
-
/**
|
|
3433
|
-
* Returns a reference to the accessible of the containing table.
|
|
3434
|
-
* @returns the AtspiAccessible for the containing table.
|
|
3435
|
-
*/
|
|
3436
|
-
get_table(): Accessible;
|
|
3437
|
-
|
|
3438
3895
|
/**
|
|
3439
3896
|
* Selects some text (adds a text selection) in an {@link Atspi.Text} object.
|
|
3440
3897
|
* @param start_offset the starting offset of the desired new selection.
|
|
@@ -3464,7 +3921,6 @@ export namespace Atspi {
|
|
|
3464
3921
|
* Gets the attributes applied to a range of text from an {@link Atspi.Text}
|
|
3465
3922
|
* object. The text attributes correspond to CSS attributes
|
|
3466
3923
|
* where possible.
|
|
3467
|
-
* <em>DEPRECATED</em>
|
|
3468
3924
|
* @param offset a `gint` indicating the offset from which the attribute search is based.
|
|
3469
3925
|
* @returns a {@link GLib.HashTable} describing the attributes at the given character offset.
|
|
3470
3926
|
*/
|
|
@@ -3551,13 +4007,6 @@ export namespace Atspi {
|
|
|
3551
4007
|
*/
|
|
3552
4008
|
get_range_extents(start_offset: number, end_offset: number, type: CoordType): Rect;
|
|
3553
4009
|
|
|
3554
|
-
/**
|
|
3555
|
-
* Gets the bounds of the `selection_num`-th active text selection for an
|
|
3556
|
-
* {@link Atspi.Text} object.
|
|
3557
|
-
* @param selection_num a `gint` indicating which selection to query.
|
|
3558
|
-
*/
|
|
3559
|
-
get_selection(selection_num: number): Range;
|
|
3560
|
-
|
|
3561
4010
|
/**
|
|
3562
4011
|
* Gets a portion of the text exposed through an {@link Atspi.Text} according to a given `offset`
|
|
3563
4012
|
* and a specific `granularity`, along with the start and end offsets defining the
|
|
@@ -3595,22 +4044,6 @@ export namespace Atspi {
|
|
|
3595
4044
|
*/
|
|
3596
4045
|
get_string_at_offset(offset: number, granularity: TextGranularity): TextRange;
|
|
3597
4046
|
|
|
3598
|
-
/**
|
|
3599
|
-
* Gets a range of text from an {@link Atspi.Text} object. The number of bytes
|
|
3600
|
-
* in the returned string may exceed either end_offset or start_offset, since
|
|
3601
|
-
* UTF-8 is a variable-width encoding.
|
|
3602
|
-
* @param start_offset a `gint` indicating the start of the desired text range.
|
|
3603
|
-
* @param end_offset a `gint` indicating the first character past the desired range.
|
|
3604
|
-
* @returns a text string containing characters from `start_offset` to `end_offset`-1, inclusive, encoded as UTF-8.
|
|
3605
|
-
*/
|
|
3606
|
-
get_text(start_offset: number, end_offset: number): string;
|
|
3607
|
-
|
|
3608
|
-
/**
|
|
3609
|
-
* @param args
|
|
3610
|
-
*/
|
|
3611
|
-
// Conflicted with Atspi.Value.get_text
|
|
3612
|
-
get_text(...args: never[]): any;
|
|
3613
|
-
|
|
3614
4047
|
/**
|
|
3615
4048
|
* Gets delimited text from an {@link Atspi.Text} object which follows a given
|
|
3616
4049
|
* text offset.
|
|
@@ -3725,6 +4158,11 @@ export namespace Atspi {
|
|
|
3725
4158
|
}
|
|
3726
4159
|
|
|
3727
4160
|
/**
|
|
4161
|
+
* An interface identifying the root object associated
|
|
4162
|
+
* with a running application.
|
|
4163
|
+
*
|
|
4164
|
+
* An interface identifying an object which is the root of the
|
|
4165
|
+
* hierarchy associated with a running application.
|
|
3728
4166
|
* @gir-type Class
|
|
3729
4167
|
*/
|
|
3730
4168
|
class Application extends GObject.Object {
|
|
@@ -3754,6 +4192,8 @@ export namespace Atspi {
|
|
|
3754
4192
|
|
|
3755
4193
|
time_added: null;
|
|
3756
4194
|
|
|
4195
|
+
pid: never;
|
|
4196
|
+
|
|
3757
4197
|
// Constructors
|
|
3758
4198
|
constructor(properties?: Partial<Application.ConstructorProps>, ...args: any[]);
|
|
3759
4199
|
|
|
@@ -3776,10 +4216,31 @@ export namespace Atspi {
|
|
|
3776
4216
|
|
|
3777
4217
|
namespace Device {
|
|
3778
4218
|
// Signal signatures
|
|
3779
|
-
interface SignalSignatures extends GObject.Object.SignalSignatures {
|
|
4219
|
+
interface SignalSignatures extends GObject.Object.SignalSignatures {
|
|
4220
|
+
/**
|
|
4221
|
+
* @signal
|
|
4222
|
+
* @run-last
|
|
4223
|
+
*/
|
|
4224
|
+
"key-pressed": (arg0: number, arg1: number, arg2: ModifierType, arg3: string) => void;
|
|
4225
|
+
/**
|
|
4226
|
+
* @signal
|
|
4227
|
+
* @run-last
|
|
4228
|
+
*/
|
|
4229
|
+
"key-released": (arg0: number, arg1: number, arg2: ModifierType, arg3: string) => void;
|
|
4230
|
+
/**
|
|
4231
|
+
* Signals that the pointer has moved.
|
|
4232
|
+
* @signal
|
|
4233
|
+
* @run-last
|
|
4234
|
+
*/
|
|
4235
|
+
"pointer-moved": (arg0: Accessible, arg1: number, arg2: number) => void;
|
|
4236
|
+
"notify::app-id": (pspec: GObject.ParamSpec) => void;
|
|
4237
|
+
}
|
|
3780
4238
|
|
|
3781
4239
|
// Constructor properties interface
|
|
3782
|
-
interface ConstructorProps extends GObject.Object.ConstructorProps {
|
|
4240
|
+
interface ConstructorProps extends GObject.Object.ConstructorProps {
|
|
4241
|
+
app_id: string;
|
|
4242
|
+
appId: string;
|
|
4243
|
+
}
|
|
3783
4244
|
}
|
|
3784
4245
|
|
|
3785
4246
|
/**
|
|
@@ -3788,6 +4249,19 @@ export namespace Atspi {
|
|
|
3788
4249
|
class Device extends GObject.Object {
|
|
3789
4250
|
static $gtype: GObject.GType<Device>;
|
|
3790
4251
|
|
|
4252
|
+
// Properties
|
|
4253
|
+
/**
|
|
4254
|
+
* @construct-only
|
|
4255
|
+
* @default null
|
|
4256
|
+
*/
|
|
4257
|
+
get app_id(): string;
|
|
4258
|
+
|
|
4259
|
+
/**
|
|
4260
|
+
* @construct-only
|
|
4261
|
+
* @default null
|
|
4262
|
+
*/
|
|
4263
|
+
get appId(): string;
|
|
4264
|
+
|
|
3791
4265
|
/**
|
|
3792
4266
|
* Compile-time signal type information.
|
|
3793
4267
|
*
|
|
@@ -3804,6 +4278,8 @@ export namespace Atspi {
|
|
|
3804
4278
|
|
|
3805
4279
|
static ["new"](): Device;
|
|
3806
4280
|
|
|
4281
|
+
static new_full(app_id: string | null): Device;
|
|
4282
|
+
|
|
3807
4283
|
// Signals
|
|
3808
4284
|
/** @signal */
|
|
3809
4285
|
connect<K extends keyof Device.SignalSignatures>(signal: K, callback: GObject.SignalCallback<this, Device.SignalSignatures[K]>): number;
|
|
@@ -3822,7 +4298,38 @@ export namespace Atspi {
|
|
|
3822
4298
|
* @param kd
|
|
3823
4299
|
* @virtual
|
|
3824
4300
|
*/
|
|
3825
|
-
vfunc_add_key_grab(kd: KeyDefinition):
|
|
4301
|
+
vfunc_add_key_grab(kd: KeyDefinition): boolean;
|
|
4302
|
+
|
|
4303
|
+
/**
|
|
4304
|
+
* Synthesizes a mouse event at a specific screen coordinate.
|
|
4305
|
+
* Most AT clients should use the `AccessibleAction` interface when
|
|
4306
|
+
* tempted to generate mouse events, rather than this method.
|
|
4307
|
+
* Event names: b1p = button 1 press; b2r = button 2 release;
|
|
4308
|
+
* b3c = button 3 click; b2d = button 2 double-click;
|
|
4309
|
+
* abs = absolute motion; rel = relative motion.
|
|
4310
|
+
* @param obj The {@link Atspi.Accessible} that should receive the click.
|
|
4311
|
+
* @param x a `gint` indicating the x coordinate of the mouse event, relative to `obj`..
|
|
4312
|
+
* @param y a `gint` indicating the y coordinate of the mouse event, relative to `obj`..
|
|
4313
|
+
* @param name a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs").
|
|
4314
|
+
* @virtual
|
|
4315
|
+
*/
|
|
4316
|
+
vfunc_generate_mouse_event(obj: Accessible, x: number, y: number, name: string): void;
|
|
4317
|
+
|
|
4318
|
+
/**
|
|
4319
|
+
* Returns the capabilities currently enabled for this device.
|
|
4320
|
+
* @virtual
|
|
4321
|
+
*/
|
|
4322
|
+
vfunc_get_capabilities(): DeviceCapability;
|
|
4323
|
+
|
|
4324
|
+
/**
|
|
4325
|
+
* Gets the modifier for a given keysym, if one exists. Does not create a new
|
|
4326
|
+
* mapping. This function should be used when the intention is to query a
|
|
4327
|
+
* locking modifier such as num lock via atspi_device_get_locked_modifiers,
|
|
4328
|
+
* rather than to add key grabs.
|
|
4329
|
+
* @param keysym the XKB keysym to map.
|
|
4330
|
+
* @virtual
|
|
4331
|
+
*/
|
|
4332
|
+
vfunc_get_keysym_modifier(keysym: number): number;
|
|
3826
4333
|
|
|
3827
4334
|
/**
|
|
3828
4335
|
* Returns the locked modifiers (ie, num lock, caps lock) associated with this
|
|
@@ -3832,7 +4339,7 @@ export namespace Atspi {
|
|
|
3832
4339
|
vfunc_get_locked_modifiers(): number;
|
|
3833
4340
|
|
|
3834
4341
|
/**
|
|
3835
|
-
* Gets the modifier for a given keycode, if one exists. Does not
|
|
4342
|
+
* Gets the modifier for a given keycode, if one exists. Does not create a new
|
|
3836
4343
|
* mapping. This function should be used when the intention is to query a
|
|
3837
4344
|
* locking modifier such as num lock via atspi_device_get_locked_modifiers,
|
|
3838
4345
|
* rather than to add key grabs.
|
|
@@ -3849,6 +4356,20 @@ export namespace Atspi {
|
|
|
3849
4356
|
*/
|
|
3850
4357
|
vfunc_grab_keyboard(): boolean;
|
|
3851
4358
|
|
|
4359
|
+
/**
|
|
4360
|
+
* Maps the specified keysym to a modifier so that it can be used in
|
|
4361
|
+
* conjunction with other keys to create a key grab. If the given keysym is
|
|
4362
|
+
* already mapped, then this function will return the modifier that is
|
|
4363
|
+
* currently mapped to the keysym, without doing anything else. Otherwise,
|
|
4364
|
+
* it will use the last modifier that AT-SPI used to map a keysym. If no keys
|
|
4365
|
+
* have yet been mapped using this device, then it will look for a modifier
|
|
4366
|
+
* that is not currently being used. If no unused modifier can be found,
|
|
4367
|
+
* then it will use the first modifier by default.
|
|
4368
|
+
* @param keysym the XKB keysym to map.
|
|
4369
|
+
* @virtual
|
|
4370
|
+
*/
|
|
4371
|
+
vfunc_map_keysym_modifier(keysym: number): number;
|
|
4372
|
+
|
|
3852
4373
|
/**
|
|
3853
4374
|
* Maps the specified key code to a modifier so that it can be used in
|
|
3854
4375
|
* conjunction with other keys to create a key grab. If the given keycode is
|
|
@@ -3870,12 +4391,25 @@ export namespace Atspi {
|
|
|
3870
4391
|
*/
|
|
3871
4392
|
vfunc_remove_key_grab(id: number): void;
|
|
3872
4393
|
|
|
4394
|
+
/**
|
|
4395
|
+
* @param capabilities A bitmask specifying the capabilities that should be enabled. This replaces the existing set of enabled capabilities, so, if it excludes some capabilities that are currently enabled, then those capabilities may be disabled.
|
|
4396
|
+
* @virtual
|
|
4397
|
+
*/
|
|
4398
|
+
vfunc_set_capabilities(capabilities: DeviceCapability): DeviceCapability;
|
|
4399
|
+
|
|
3873
4400
|
/**
|
|
3874
4401
|
* Removes a keyboard grab added via a call to atspi_device_add_keyboard.
|
|
3875
4402
|
* @virtual
|
|
3876
4403
|
*/
|
|
3877
4404
|
vfunc_ungrab_keyboard(): void;
|
|
3878
4405
|
|
|
4406
|
+
/**
|
|
4407
|
+
* Removes a mapped modifier from the given keysym.
|
|
4408
|
+
* @param keysym the XKB keysym to unmap.
|
|
4409
|
+
* @virtual
|
|
4410
|
+
*/
|
|
4411
|
+
vfunc_unmap_keysym_modifier(keysym: number): void;
|
|
4412
|
+
|
|
3879
4413
|
/**
|
|
3880
4414
|
* Removes a mapped modifier from the given keycode.
|
|
3881
4415
|
* @param keycode the keycode to unmap.
|
|
@@ -3887,22 +4421,58 @@ export namespace Atspi {
|
|
|
3887
4421
|
/**
|
|
3888
4422
|
* @param kd a {@link Atspi.KeyDefinition} specifying the key code to grab.
|
|
3889
4423
|
* @param callback the function to call when the given key is pressed.
|
|
3890
|
-
* @returns an identifier that can be later used to remove the grab. Add a key grab for the given key/modifier combination.
|
|
4424
|
+
* @returns an identifier that can be later used to remove the grab, or 0 if the key/modifier combination could not be grabbed. Add a key grab for the given key/modifier combination.
|
|
3891
4425
|
*/
|
|
3892
4426
|
add_key_grab(kd: KeyDefinition, callback: KeyCallback | null): number;
|
|
3893
4427
|
|
|
3894
4428
|
/**
|
|
3895
4429
|
* Add a callback that will receive a notification whenever a key is
|
|
3896
4430
|
* pressed or released.
|
|
3897
|
-
* @param callback the
|
|
4431
|
+
* @param callback the function to call when the given key is pressed.
|
|
3898
4432
|
*/
|
|
3899
|
-
add_key_watcher(callback: KeyCallback
|
|
4433
|
+
add_key_watcher(callback: KeyCallback): void;
|
|
4434
|
+
|
|
4435
|
+
clear_key_grabs(): void;
|
|
4436
|
+
|
|
4437
|
+
/**
|
|
4438
|
+
* Synthesizes a mouse event at a specific screen coordinate.
|
|
4439
|
+
* Most AT clients should use the `AccessibleAction` interface when
|
|
4440
|
+
* tempted to generate mouse events, rather than this method.
|
|
4441
|
+
* Event names: b1p = button 1 press; b2r = button 2 release;
|
|
4442
|
+
* b3c = button 3 click; b2d = button 2 double-click;
|
|
4443
|
+
* abs = absolute motion; rel = relative motion.
|
|
4444
|
+
* @param obj The {@link Atspi.Accessible} that should receive the click.
|
|
4445
|
+
* @param x a `gint` indicating the x coordinate of the mouse event, relative to `obj`..
|
|
4446
|
+
* @param y a `gint` indicating the y coordinate of the mouse event, relative to `obj`..
|
|
4447
|
+
* @param name a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs").
|
|
4448
|
+
*/
|
|
4449
|
+
generate_mouse_event(obj: Accessible, x: number, y: number, name: string): void;
|
|
4450
|
+
|
|
4451
|
+
/**
|
|
4452
|
+
* Returns the application ID of the device.
|
|
4453
|
+
*/
|
|
4454
|
+
get_app_id(): string;
|
|
4455
|
+
|
|
4456
|
+
/**
|
|
4457
|
+
* Returns the capabilities currently enabled for this device.
|
|
4458
|
+
*/
|
|
4459
|
+
get_capabilities(): DeviceCapability;
|
|
3900
4460
|
|
|
3901
4461
|
/**
|
|
3902
4462
|
* @param id
|
|
3903
4463
|
*/
|
|
3904
4464
|
get_grab_by_id(id: number): KeyDefinition;
|
|
3905
4465
|
|
|
4466
|
+
/**
|
|
4467
|
+
* Gets the modifier for a given keysym, if one exists. Does not create a new
|
|
4468
|
+
* mapping. This function should be used when the intention is to query a
|
|
4469
|
+
* locking modifier such as num lock via atspi_device_get_locked_modifiers,
|
|
4470
|
+
* rather than to add key grabs.
|
|
4471
|
+
* @param keysym the XKB keysym to map.
|
|
4472
|
+
* @returns the modifier that is mapped to this keysym.
|
|
4473
|
+
*/
|
|
4474
|
+
get_keysym_modifier(keysym: number): number;
|
|
4475
|
+
|
|
3906
4476
|
/**
|
|
3907
4477
|
* Returns the locked modifiers (ie, num lock, caps lock) associated with this
|
|
3908
4478
|
* keyboard.
|
|
@@ -3911,7 +4481,7 @@ export namespace Atspi {
|
|
|
3911
4481
|
get_locked_modifiers(): number;
|
|
3912
4482
|
|
|
3913
4483
|
/**
|
|
3914
|
-
* Gets the modifier for a given keycode, if one exists. Does not
|
|
4484
|
+
* Gets the modifier for a given keycode, if one exists. Does not create a new
|
|
3915
4485
|
* mapping. This function should be used when the intention is to query a
|
|
3916
4486
|
* locking modifier such as num lock via atspi_device_get_locked_modifiers,
|
|
3917
4487
|
* rather than to add key grabs.
|
|
@@ -3928,6 +4498,20 @@ export namespace Atspi {
|
|
|
3928
4498
|
*/
|
|
3929
4499
|
grab_keyboard(): boolean;
|
|
3930
4500
|
|
|
4501
|
+
/**
|
|
4502
|
+
* Maps the specified keysym to a modifier so that it can be used in
|
|
4503
|
+
* conjunction with other keys to create a key grab. If the given keysym is
|
|
4504
|
+
* already mapped, then this function will return the modifier that is
|
|
4505
|
+
* currently mapped to the keysym, without doing anything else. Otherwise,
|
|
4506
|
+
* it will use the last modifier that AT-SPI used to map a keysym. If no keys
|
|
4507
|
+
* have yet been mapped using this device, then it will look for a modifier
|
|
4508
|
+
* that is not currently being used. If no unused modifier can be found,
|
|
4509
|
+
* then it will use the first modifier by default.
|
|
4510
|
+
* @param keysym the XKB keysym to map.
|
|
4511
|
+
* @returns the modifier that is now mapped to this keysym. This return value can be passed to atspi_device_add_key_grab.
|
|
4512
|
+
*/
|
|
4513
|
+
map_keysym_modifier(keysym: number): number;
|
|
4514
|
+
|
|
3931
4515
|
/**
|
|
3932
4516
|
* Maps the specified key code to a modifier so that it can be used in
|
|
3933
4517
|
* conjunction with other keys to create a key grab. If the given keycode is
|
|
@@ -3957,11 +4541,29 @@ export namespace Atspi {
|
|
|
3957
4541
|
*/
|
|
3958
4542
|
remove_key_grab(id: number): void;
|
|
3959
4543
|
|
|
4544
|
+
/**
|
|
4545
|
+
* Sets the application ID of the device.
|
|
4546
|
+
* @param app_id the application ID.
|
|
4547
|
+
*/
|
|
4548
|
+
set_app_id(app_id: string): void;
|
|
4549
|
+
|
|
4550
|
+
/**
|
|
4551
|
+
* @param capabilities A bitmask specifying the capabilities that should be enabled. This replaces the existing set of enabled capabilities, so, if it excludes some capabilities that are currently enabled, then those capabilities may be disabled.
|
|
4552
|
+
* @returns The new set of capabilities that are enabled. This may differ from the value passed in if the device does not support all of the requested capabilities.
|
|
4553
|
+
*/
|
|
4554
|
+
set_capabilities(capabilities: DeviceCapability): DeviceCapability;
|
|
4555
|
+
|
|
3960
4556
|
/**
|
|
3961
4557
|
* Removes a keyboard grab added via a call to atspi_device_add_keyboard.
|
|
3962
4558
|
*/
|
|
3963
4559
|
ungrab_keyboard(): void;
|
|
3964
4560
|
|
|
4561
|
+
/**
|
|
4562
|
+
* Removes a mapped modifier from the given keysym.
|
|
4563
|
+
* @param keysym the XKB keysym to unmap.
|
|
4564
|
+
*/
|
|
4565
|
+
unmap_keysym_modifier(keysym: number): void;
|
|
4566
|
+
|
|
3965
4567
|
/**
|
|
3966
4568
|
* Removes a mapped modifier from the given keycode.
|
|
3967
4569
|
* @param keycode the keycode to unmap.
|
|
@@ -3970,9 +4572,60 @@ export namespace Atspi {
|
|
|
3970
4572
|
}
|
|
3971
4573
|
|
|
3972
4574
|
|
|
4575
|
+
namespace DeviceA11yManager {
|
|
4576
|
+
// Signal signatures
|
|
4577
|
+
interface SignalSignatures extends Device.SignalSignatures {
|
|
4578
|
+
"notify::app-id": (pspec: GObject.ParamSpec) => void;
|
|
4579
|
+
}
|
|
4580
|
+
|
|
4581
|
+
// Constructor properties interface
|
|
4582
|
+
interface ConstructorProps extends Device.ConstructorProps {}
|
|
4583
|
+
}
|
|
4584
|
+
|
|
4585
|
+
/**
|
|
4586
|
+
* @gir-type Class
|
|
4587
|
+
*/
|
|
4588
|
+
class DeviceA11yManager extends Device {
|
|
4589
|
+
static $gtype: GObject.GType<DeviceA11yManager>;
|
|
4590
|
+
|
|
4591
|
+
/**
|
|
4592
|
+
* Compile-time signal type information.
|
|
4593
|
+
*
|
|
4594
|
+
* This instance property is generated only for TypeScript type checking.
|
|
4595
|
+
* It is not defined at runtime and should not be accessed in JS code.
|
|
4596
|
+
* @internal
|
|
4597
|
+
*/
|
|
4598
|
+
$signals: DeviceA11yManager.SignalSignatures;
|
|
4599
|
+
|
|
4600
|
+
// Constructors
|
|
4601
|
+
constructor(properties?: Partial<DeviceA11yManager.ConstructorProps>, ...args: any[]);
|
|
4602
|
+
|
|
4603
|
+
_init(...args: any[]): void;
|
|
4604
|
+
|
|
4605
|
+
static try_new(): DeviceA11yManager;
|
|
4606
|
+
|
|
4607
|
+
static try_new_full(app_id: string | null): DeviceA11yManager;
|
|
4608
|
+
|
|
4609
|
+
// Signals
|
|
4610
|
+
/** @signal */
|
|
4611
|
+
connect<K extends keyof DeviceA11yManager.SignalSignatures>(signal: K, callback: GObject.SignalCallback<this, DeviceA11yManager.SignalSignatures[K]>): number;
|
|
4612
|
+
connect(signal: string, callback: (...args: any[]) => any): number;
|
|
4613
|
+
|
|
4614
|
+
/** @signal */
|
|
4615
|
+
connect_after<K extends keyof DeviceA11yManager.SignalSignatures>(signal: K, callback: GObject.SignalCallback<this, DeviceA11yManager.SignalSignatures[K]>): number;
|
|
4616
|
+
connect_after(signal: string, callback: (...args: any[]) => any): number;
|
|
4617
|
+
|
|
4618
|
+
/** @signal */
|
|
4619
|
+
emit<K extends keyof DeviceA11yManager.SignalSignatures>(signal: K, ...args: GObject.GjsParameters<DeviceA11yManager.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never): void;
|
|
4620
|
+
emit(signal: string, ...args: any[]): void;
|
|
4621
|
+
}
|
|
4622
|
+
|
|
4623
|
+
|
|
3973
4624
|
namespace DeviceLegacy {
|
|
3974
4625
|
// Signal signatures
|
|
3975
|
-
interface SignalSignatures extends Device.SignalSignatures {
|
|
4626
|
+
interface SignalSignatures extends Device.SignalSignatures {
|
|
4627
|
+
"notify::app-id": (pspec: GObject.ParamSpec) => void;
|
|
4628
|
+
}
|
|
3976
4629
|
|
|
3977
4630
|
// Constructor properties interface
|
|
3978
4631
|
interface ConstructorProps extends Device.ConstructorProps {}
|
|
@@ -4000,6 +4653,8 @@ export namespace Atspi {
|
|
|
4000
4653
|
|
|
4001
4654
|
static ["new"](): DeviceLegacy;
|
|
4002
4655
|
|
|
4656
|
+
static new_full(app_id: string | null): DeviceLegacy;
|
|
4657
|
+
|
|
4003
4658
|
// Signals
|
|
4004
4659
|
/** @signal */
|
|
4005
4660
|
connect<K extends keyof DeviceLegacy.SignalSignatures>(signal: K, callback: GObject.SignalCallback<this, DeviceLegacy.SignalSignatures[K]>): number;
|
|
@@ -4048,7 +4703,7 @@ export namespace Atspi {
|
|
|
4048
4703
|
|
|
4049
4704
|
_init(...args: any[]): void;
|
|
4050
4705
|
|
|
4051
|
-
static ["new"](callback: DeviceListenerCB): DeviceListener;
|
|
4706
|
+
static ["new"](callback: DeviceListenerCB | null): DeviceListener;
|
|
4052
4707
|
|
|
4053
4708
|
// Signals
|
|
4054
4709
|
/** @signal */
|
|
@@ -4073,7 +4728,7 @@ export namespace Atspi {
|
|
|
4073
4728
|
// Methods
|
|
4074
4729
|
/**
|
|
4075
4730
|
* Adds an in-process callback function to an existing {@link Atspi.DeviceListener}.
|
|
4076
|
-
* @param callback an
|
|
4731
|
+
* @param callback an {@link Atspi.DeviceListenerCB} function pointer.
|
|
4077
4732
|
*/
|
|
4078
4733
|
add_callback(callback: DeviceListenerCB): void;
|
|
4079
4734
|
|
|
@@ -4088,7 +4743,9 @@ export namespace Atspi {
|
|
|
4088
4743
|
|
|
4089
4744
|
namespace DeviceX11 {
|
|
4090
4745
|
// Signal signatures
|
|
4091
|
-
interface SignalSignatures extends Device.SignalSignatures {
|
|
4746
|
+
interface SignalSignatures extends Device.SignalSignatures {
|
|
4747
|
+
"notify::app-id": (pspec: GObject.ParamSpec) => void;
|
|
4748
|
+
}
|
|
4092
4749
|
|
|
4093
4750
|
// Constructor properties interface
|
|
4094
4751
|
interface ConstructorProps extends Device.ConstructorProps {}
|
|
@@ -4116,6 +4773,8 @@ export namespace Atspi {
|
|
|
4116
4773
|
|
|
4117
4774
|
static ["new"](): DeviceX11;
|
|
4118
4775
|
|
|
4776
|
+
static new_full(app_id: string | null): DeviceX11;
|
|
4777
|
+
|
|
4119
4778
|
// Signals
|
|
4120
4779
|
/** @signal */
|
|
4121
4780
|
connect<K extends keyof DeviceX11.SignalSignatures>(signal: K, callback: GObject.SignalCallback<this, DeviceX11.SignalSignatures[K]>): number;
|
|
@@ -4140,6 +4799,13 @@ export namespace Atspi {
|
|
|
4140
4799
|
}
|
|
4141
4800
|
|
|
4142
4801
|
/**
|
|
4802
|
+
* A generic interface implemented by objects for the receipt of event
|
|
4803
|
+
* notifications.
|
|
4804
|
+
*
|
|
4805
|
+
* A generic interface implemented by objects for the receipt of event
|
|
4806
|
+
* notifications. atspi-event-listener is the interface via which clients of
|
|
4807
|
+
* the atspi-registry receive notification of changes to an application's user
|
|
4808
|
+
* interface and content.
|
|
4143
4809
|
* @gir-type Class
|
|
4144
4810
|
*/
|
|
4145
4811
|
class EventListener extends GObject.Object {
|
|
@@ -4184,33 +4850,33 @@ export namespace Atspi {
|
|
|
4184
4850
|
// Static methods
|
|
4185
4851
|
/**
|
|
4186
4852
|
* Deregisters an {@link Atspi.EventListenerCB} from the registry, for a specific
|
|
4187
|
-
*
|
|
4188
|
-
* @param callback the {@link Atspi.EventListenerCB}
|
|
4189
|
-
* @param event_type a string specifying the event type for which this
|
|
4853
|
+
* event type.
|
|
4854
|
+
* @param callback the {@link Atspi.EventListenerCB} registered against an event type.
|
|
4855
|
+
* @param event_type a string specifying the event type for which this listener is to be deregistered.
|
|
4190
4856
|
*/
|
|
4191
4857
|
static deregister_from_callback(callback: EventListenerCB, event_type: string): boolean;
|
|
4192
4858
|
|
|
4193
4859
|
/**
|
|
4194
4860
|
* Registers an {@link Atspi.EventListenerCB} against an `event_type`.
|
|
4195
|
-
* @param callback the
|
|
4196
|
-
* @param event_type a character string indicating the type of events for which
|
|
4861
|
+
* @param callback the {@link Atspi.EventListenerCB} to be registered against an event type.
|
|
4862
|
+
* @param event_type a character string indicating the type of events for which notification is requested. See `atspi_event_listener_register()` for a description of the format.
|
|
4197
4863
|
*/
|
|
4198
4864
|
static register_from_callback(callback: EventListenerCB, event_type: string): boolean;
|
|
4199
4865
|
|
|
4200
4866
|
/**
|
|
4201
|
-
* @param callback an
|
|
4867
|
+
* @param callback an {@link Atspi.EventListenerCB} function pointer.
|
|
4202
4868
|
* @param event_type
|
|
4203
4869
|
* @param properties
|
|
4204
4870
|
*/
|
|
4205
|
-
static register_from_callback_full(callback: EventListenerCB
|
|
4871
|
+
static register_from_callback_full(callback: EventListenerCB, event_type: string, properties: string[]): boolean;
|
|
4206
4872
|
|
|
4207
4873
|
/**
|
|
4208
|
-
* @param callback an
|
|
4874
|
+
* @param callback an {@link Atspi.EventListenerCB} function pointer.
|
|
4209
4875
|
* @param event_type
|
|
4210
4876
|
* @param properties
|
|
4211
4877
|
* @param app
|
|
4212
4878
|
*/
|
|
4213
|
-
static register_from_callback_with_app(callback: EventListenerCB
|
|
4879
|
+
static register_from_callback_with_app(callback: EventListenerCB, event_type: string, properties: string[], app: Accessible | null): boolean;
|
|
4214
4880
|
|
|
4215
4881
|
// Methods
|
|
4216
4882
|
/**
|
|
@@ -4231,6 +4897,7 @@ export namespace Atspi {
|
|
|
4231
4897
|
* object:property-change
|
|
4232
4898
|
* object:property-change:accessible-name
|
|
4233
4899
|
* object:property-change:accessible-description
|
|
4900
|
+
* object:property-change:accessible-help-text
|
|
4234
4901
|
* object:property-change:accessible-parent
|
|
4235
4902
|
* object:property-change:accessible-value
|
|
4236
4903
|
* object:property-change:accessible-role
|
|
@@ -4258,6 +4925,7 @@ export namespace Atspi {
|
|
|
4258
4925
|
* object:column-deleted
|
|
4259
4926
|
* object:model-changed
|
|
4260
4927
|
* object:active-descendant-changed
|
|
4928
|
+
* object:announcement
|
|
4261
4929
|
*
|
|
4262
4930
|
* (screen reader events)
|
|
4263
4931
|
* screen-reader:region-changed
|
|
@@ -4337,6 +5005,16 @@ export namespace Atspi {
|
|
|
4337
5005
|
}
|
|
4338
5006
|
|
|
4339
5007
|
/**
|
|
5008
|
+
* Instances of atspi-hyperlink are the means by which end users
|
|
5009
|
+
* and clients interact with linked content.
|
|
5010
|
+
*
|
|
5011
|
+
* Instances of atspi-hyperlink are returned by
|
|
5012
|
+
* atspi-hypertext objects, and are the means by
|
|
5013
|
+
* which end users and clients interact with linked,
|
|
5014
|
+
* and in some cases embedded, content. These instances
|
|
5015
|
+
* may have multiple "anchors", where an anchor corresponds to a
|
|
5016
|
+
* reference to a particular resource with a corresponding resource
|
|
5017
|
+
* identified (URI).
|
|
4340
5018
|
* @gir-type Class
|
|
4341
5019
|
*/
|
|
4342
5020
|
class Hyperlink extends Object {
|
|
@@ -4432,6 +5110,8 @@ export namespace Atspi {
|
|
|
4432
5110
|
}
|
|
4433
5111
|
|
|
4434
5112
|
/**
|
|
5113
|
+
* An interface that allows the definition of match rules
|
|
5114
|
+
* for accessible objects.
|
|
4435
5115
|
* @gir-type Class
|
|
4436
5116
|
*/
|
|
4437
5117
|
class MatchRule extends GObject.Object {
|
|
@@ -4468,7 +5148,7 @@ export namespace Atspi {
|
|
|
4468
5148
|
|
|
4469
5149
|
_init(...args: any[]): void;
|
|
4470
5150
|
|
|
4471
|
-
static ["new"](states: StateSet, statematchtype: CollectionMatchType, attributes: { [key: string]: string }, attributematchtype: CollectionMatchType, roles: Role[], rolematchtype: CollectionMatchType, interfaces: string[], interfacematchtype: CollectionMatchType, invert: boolean): MatchRule;
|
|
5151
|
+
static ["new"](states: StateSet | null, statematchtype: CollectionMatchType, attributes: { [key: string]: string } | null, attributematchtype: CollectionMatchType, roles: Role[] | null, rolematchtype: CollectionMatchType, interfaces: string[] | null, interfacematchtype: CollectionMatchType, invert: boolean): MatchRule;
|
|
4472
5152
|
|
|
4473
5153
|
// Signals
|
|
4474
5154
|
/** @signal */
|
|
@@ -4542,6 +5222,12 @@ export namespace Atspi {
|
|
|
4542
5222
|
}
|
|
4543
5223
|
|
|
4544
5224
|
/**
|
|
5225
|
+
* An interface via which non-hierarchical relationships
|
|
5226
|
+
* are indicated.
|
|
5227
|
+
*
|
|
5228
|
+
* An interface via which non-hierarchical relationships
|
|
5229
|
+
* are indicated. An instance of this interface represents
|
|
5230
|
+
* a "one-to-many" correspondence.
|
|
4545
5231
|
* @gir-type Class
|
|
4546
5232
|
*/
|
|
4547
5233
|
class Relation extends GObject.Object {
|
|
@@ -4612,6 +5298,8 @@ export namespace Atspi {
|
|
|
4612
5298
|
}
|
|
4613
5299
|
|
|
4614
5300
|
/**
|
|
5301
|
+
* The atspi-stateset objects implement wrappers around a
|
|
5302
|
+
* bitmap of accessible states.
|
|
4615
5303
|
* @gir-type Class
|
|
4616
5304
|
*/
|
|
4617
5305
|
class StateSet extends GObject.Object {
|
|
@@ -4732,6 +5420,11 @@ export namespace Atspi {
|
|
|
4732
5420
|
*/
|
|
4733
5421
|
type ApplicationClass = typeof Application;
|
|
4734
5422
|
|
|
5423
|
+
/**
|
|
5424
|
+
* @gir-type Alias
|
|
5425
|
+
*/
|
|
5426
|
+
type DeviceA11yManagerClass = typeof DeviceA11yManager;
|
|
5427
|
+
|
|
4735
5428
|
/**
|
|
4736
5429
|
* @gir-type Alias
|
|
4737
5430
|
*/
|
|
@@ -5018,6 +5711,45 @@ export namespace Atspi {
|
|
|
5018
5711
|
}
|
|
5019
5712
|
|
|
5020
5713
|
|
|
5714
|
+
/**
|
|
5715
|
+
* This structure represents a single text selection within a document. This
|
|
5716
|
+
* selection is defined by two points in the content, where each one is defined
|
|
5717
|
+
* by an AtkObject supporting the AtkText interface and a character offset
|
|
5718
|
+
* relative to it.
|
|
5719
|
+
*
|
|
5720
|
+
* The end object must appear after the start object in the accessibility tree,
|
|
5721
|
+
* i.e. the end object must be reachable from the start object by navigating
|
|
5722
|
+
* forward (next, first child etc).
|
|
5723
|
+
*
|
|
5724
|
+
* This struct also contains a `start_is_active` boolean, to communicate if the
|
|
5725
|
+
* start of the selection is the active point or not.
|
|
5726
|
+
*
|
|
5727
|
+
* The active point corresponds to the user's focus or point of interest. The
|
|
5728
|
+
* user moves the active point to expand or collapse the range. The anchor
|
|
5729
|
+
* point is the other point of the range and typically remains constant. In
|
|
5730
|
+
* most cases, anchor is the start of the range and active is the end. However,
|
|
5731
|
+
* when selecting backwards (e.g. pressing shift+left arrow in a text field),
|
|
5732
|
+
* the start of the range is the active point, as the user moves this to
|
|
5733
|
+
* manipulate the selection.
|
|
5734
|
+
* @gir-type Struct
|
|
5735
|
+
* @since 2.52
|
|
5736
|
+
*/
|
|
5737
|
+
class TextSelection {
|
|
5738
|
+
static $gtype: GObject.GType<TextSelection>;
|
|
5739
|
+
|
|
5740
|
+
// Fields
|
|
5741
|
+
start_object: Accessible;
|
|
5742
|
+
|
|
5743
|
+
start_offset: number;
|
|
5744
|
+
|
|
5745
|
+
end_object: Accessible;
|
|
5746
|
+
|
|
5747
|
+
end_offset: number;
|
|
5748
|
+
|
|
5749
|
+
start_is_active: boolean;
|
|
5750
|
+
}
|
|
5751
|
+
|
|
5752
|
+
|
|
5021
5753
|
namespace Action {
|
|
5022
5754
|
|
|
5023
5755
|
// Constructor properties interface
|
|
@@ -5115,6 +5847,12 @@ export namespace Atspi {
|
|
|
5115
5847
|
prototype: Collection;
|
|
5116
5848
|
}
|
|
5117
5849
|
/**
|
|
5850
|
+
* An interface designed to allow accessibles which satisfy a set of
|
|
5851
|
+
* criteria to be returned.
|
|
5852
|
+
*
|
|
5853
|
+
* An interface designed to allow accessibles which satisfy a set of
|
|
5854
|
+
* criteria to be returned. This interface can be used to avoid iteration
|
|
5855
|
+
* or client-side search of the object tree.
|
|
5118
5856
|
* @gir-type Interface
|
|
5119
5857
|
*/
|
|
5120
5858
|
interface Collection extends GObject.Object {
|
|
@@ -5131,7 +5869,7 @@ export namespace Atspi {
|
|
|
5131
5869
|
* @param rule An {@link Atspi.MatchRule} describing the match criteria.
|
|
5132
5870
|
* @param sortby An {@link Atspi.CollectionSortOrder} specifying the way the results are to be sorted.
|
|
5133
5871
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
5134
|
-
* @param traverse
|
|
5872
|
+
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
5135
5873
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule.
|
|
5136
5874
|
*/
|
|
5137
5875
|
get_matches(rule: MatchRule, sortby: CollectionSortOrder, count: number, traverse: boolean): Accessible[];
|
|
@@ -5144,7 +5882,7 @@ export namespace Atspi {
|
|
|
5144
5882
|
* @param sortby An {@link Atspi.CollectionSortOrder} specifying the way the results are to be sorted.
|
|
5145
5883
|
* @param tree An {@link Atspi.CollectionTreeTraversalType} specifying restrictions on the objects to be traversed.
|
|
5146
5884
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
5147
|
-
* @param traverse
|
|
5885
|
+
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
5148
5886
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule that preceed `current_object`.
|
|
5149
5887
|
*/
|
|
5150
5888
|
get_matches_from(current_object: Accessible, rule: MatchRule, sortby: CollectionSortOrder, tree: CollectionTreeTraversalType, count: number, traverse: boolean): Accessible[];
|
|
@@ -5158,7 +5896,7 @@ export namespace Atspi {
|
|
|
5158
5896
|
* @param tree An {@link Atspi.CollectionTreeTraversalType} specifying restrictions on the objects to be traversed.
|
|
5159
5897
|
* @param limit_scope If `TRUE`, only descendants of `current_object`'s parent will be returned. Otherwise (if `FALSE`), any accessible may be returned if it would preceed `current_object` in a flattened hierarchy.
|
|
5160
5898
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
5161
|
-
* @param traverse
|
|
5899
|
+
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
5162
5900
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule after `current_object`.
|
|
5163
5901
|
*/
|
|
5164
5902
|
get_matches_to(current_object: Accessible, rule: MatchRule, sortby: CollectionSortOrder, tree: CollectionTreeTraversalType, limit_scope: boolean, count: number, traverse: boolean): Accessible[];
|
|
@@ -5186,6 +5924,17 @@ export namespace Atspi {
|
|
|
5186
5924
|
prototype: Component;
|
|
5187
5925
|
}
|
|
5188
5926
|
/**
|
|
5927
|
+
* An interface implemented by objects which have onscreen visual
|
|
5928
|
+
* representations.
|
|
5929
|
+
*
|
|
5930
|
+
* The Component interface is implemented by objects which occupy on-screen
|
|
5931
|
+
* space, e.g. objects which have onscreen visual representations. The methods
|
|
5932
|
+
* in Component allow clients to identify where the objects lie in the onscreen
|
|
5933
|
+
* coordinate system, their relative size, stacking order, and position. It
|
|
5934
|
+
* also provides a mechanism whereby keyboard focus may be transferred to
|
|
5935
|
+
* specific user interface elements programmatically. This is a 2D API.
|
|
5936
|
+
* Coordinates of 3D objects are projected into the 2-dimensional screen view
|
|
5937
|
+
* for purposes of this interface.
|
|
5189
5938
|
* @gir-type Interface
|
|
5190
5939
|
*/
|
|
5191
5940
|
interface Component extends GObject.Object {
|
|
@@ -5282,8 +6031,8 @@ export namespace Atspi {
|
|
|
5282
6031
|
|
|
5283
6032
|
/**
|
|
5284
6033
|
* Moves and resizes the specified component.
|
|
5285
|
-
* @param x the new
|
|
5286
|
-
* @param y the new
|
|
6034
|
+
* @param x the new horizontal position to which the component should be moved.
|
|
6035
|
+
* @param y the new vertical position to which the component should be moved.
|
|
5287
6036
|
* @param width the width to which the component should be resized.
|
|
5288
6037
|
* @param height the height to which the component should be resized.
|
|
5289
6038
|
* @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
@@ -5293,15 +6042,15 @@ export namespace Atspi {
|
|
|
5293
6042
|
|
|
5294
6043
|
/**
|
|
5295
6044
|
* Moves the component to the specified position.
|
|
5296
|
-
* @param x the new
|
|
5297
|
-
* @param y the new
|
|
6045
|
+
* @param x the new horizontal position to which the component should be moved.
|
|
6046
|
+
* @param y the new vertical position to which the component should be moved.
|
|
5298
6047
|
* @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
5299
6048
|
* @returns `TRUE` if successful; `FALSE` otherwise.
|
|
5300
6049
|
*/
|
|
5301
6050
|
set_position(x: number, y: number, ctype: CoordType): boolean;
|
|
5302
6051
|
|
|
5303
6052
|
/**
|
|
5304
|
-
* Resizes the specified component to the given
|
|
6053
|
+
* Resizes the specified component to the given pixel dimensions.
|
|
5305
6054
|
* @param width the width to which the component should be resized.
|
|
5306
6055
|
* @param height the height to which the component should be resized.
|
|
5307
6056
|
* @returns `TRUE` if successful; `FALSE` otherwise.
|
|
@@ -5362,6 +6111,23 @@ export namespace Atspi {
|
|
|
5362
6111
|
* @returns a `gint` indicating the page count of an `AccessibleDocument` object.
|
|
5363
6112
|
*/
|
|
5364
6113
|
get_page_count(): number;
|
|
6114
|
+
|
|
6115
|
+
/**
|
|
6116
|
+
* Returns an array of AtspiTextSelections within this document.
|
|
6117
|
+
* @returns a GArray of AtspiTextSelection structures representing the selection.
|
|
6118
|
+
*/
|
|
6119
|
+
get_text_selections(): TextSelection[];
|
|
6120
|
+
|
|
6121
|
+
/**
|
|
6122
|
+
* Makes 1 or more selections within this document denoted by the given
|
|
6123
|
+
* array of AtspiTextSelections. Any existing physical selection (inside or
|
|
6124
|
+
* outside this document) is replaced by the new selections. All objects within
|
|
6125
|
+
* the given selection ranges must be descendants of this document. Otherwise
|
|
6126
|
+
* FALSE will be returned.
|
|
6127
|
+
* @param selections a GArray of AtspiTextSelections to be selected.
|
|
6128
|
+
* @returns TRUE if the selection was made successfully; FALSE otherwise.
|
|
6129
|
+
*/
|
|
6130
|
+
set_text_selections(selections: TextSelection[]): boolean;
|
|
5365
6131
|
}
|
|
5366
6132
|
|
|
5367
6133
|
|
|
@@ -5463,6 +6229,14 @@ export namespace Atspi {
|
|
|
5463
6229
|
prototype: Hypertext;
|
|
5464
6230
|
}
|
|
5465
6231
|
/**
|
|
6232
|
+
* An interface used for objects which implement linking between
|
|
6233
|
+
* multiple resource locations.
|
|
6234
|
+
*
|
|
6235
|
+
* An interface used for objects which implement linking between
|
|
6236
|
+
* multiple resource or content locations, or multiple 'markers'
|
|
6237
|
+
* within a single document. A hypertext instance is associated
|
|
6238
|
+
* with one or more hyperlinks which are associated with particular
|
|
6239
|
+
* offsets within the hypertext's content.
|
|
5466
6240
|
* @gir-type Interface
|
|
5467
6241
|
*/
|
|
5468
6242
|
interface Hypertext extends GObject.Object {
|
|
@@ -5569,6 +6343,14 @@ export namespace Atspi {
|
|
|
5569
6343
|
prototype: Selection;
|
|
5570
6344
|
}
|
|
5571
6345
|
/**
|
|
6346
|
+
* An interface which indicates that an object exposes a 'selection' model,
|
|
6347
|
+
* allowing the selection of one or more of its children.
|
|
6348
|
+
*
|
|
6349
|
+
* An interface which indicates that an object exposes a 'selection'
|
|
6350
|
+
* model, allowing the selection of one or more of its children.
|
|
6351
|
+
* Read-only Selection instances are possible, in which case the
|
|
6352
|
+
* interface is used to programmatically determine the selected-ness
|
|
6353
|
+
* of its children.
|
|
5572
6354
|
* @gir-type Interface
|
|
5573
6355
|
*/
|
|
5574
6356
|
interface Selection extends GObject.Object {
|
|
@@ -5594,11 +6376,11 @@ export namespace Atspi {
|
|
|
5594
6376
|
|
|
5595
6377
|
/**
|
|
5596
6378
|
* Removes a child from the selected children list of an {@link Atspi.Selection}.
|
|
5597
|
-
* Note that `
|
|
5598
|
-
* not the index in the parent container.
|
|
5599
|
-
* method
|
|
5600
|
-
* are asymmetric.
|
|
5601
|
-
* @param selected_child_index a `gint` indicating which of the selected children of the {@link Atspi.Accessible} is to be
|
|
6379
|
+
* Note that `selected_child_index` is the index in the
|
|
6380
|
+
* selected-children list, not the index in the parent container.
|
|
6381
|
+
* `selected_child_index` in this method and `child_index` in
|
|
6382
|
+
* `atspi_selection_select_child` are asymmetric.
|
|
6383
|
+
* @param selected_child_index a `gint` indicating which of the selected children of the {@link Atspi.Accessible} is to be deselected.
|
|
5602
6384
|
* @returns `TRUE` if the child was successfully deselected, `FALSE` otherwise.
|
|
5603
6385
|
*/
|
|
5604
6386
|
deselect_selected_child(selected_child_index: number): boolean;
|
|
@@ -5667,6 +6449,17 @@ export namespace Atspi {
|
|
|
5667
6449
|
prototype: Table;
|
|
5668
6450
|
}
|
|
5669
6451
|
/**
|
|
6452
|
+
* An interface used by containers whose data is arranged in a tabular form.
|
|
6453
|
+
*
|
|
6454
|
+
* An interface used by containers whose contained data is arranged
|
|
6455
|
+
* in a tabular (i.e. row-column) form. Tables may resemble
|
|
6456
|
+
* a two-dimensional grid, as in a spreadsheet, or may feature objects
|
|
6457
|
+
* which span multiple rows and/or columns, but whose bounds are
|
|
6458
|
+
* aligned on a row/column matrix. Objects within tables are children
|
|
6459
|
+
* of the table object, and they may be referenced either via a child
|
|
6460
|
+
* index or via a row/column pair. Table 'cells' may implement other
|
|
6461
|
+
* interfaces, such as Text, Action, Image, and Component, and should do
|
|
6462
|
+
* so as appropriate to their onscreen presentation and/or behavior.
|
|
5670
6463
|
* @gir-type Interface
|
|
5671
6464
|
*/
|
|
5672
6465
|
interface Table extends GObject.Object {
|
|
@@ -5998,6 +6791,15 @@ export namespace Atspi {
|
|
|
5998
6791
|
prototype: Text;
|
|
5999
6792
|
}
|
|
6000
6793
|
/**
|
|
6794
|
+
* An interface implemented by objects which place textual
|
|
6795
|
+
* information onscreen.
|
|
6796
|
+
*
|
|
6797
|
+
* The text interface should be implemented by objects which place textual
|
|
6798
|
+
* information onscreen as character strings or glyphs. The text interface
|
|
6799
|
+
* allows access to textual content including display attributes and
|
|
6800
|
+
* semantic hints associated with runs of text, and to bounding
|
|
6801
|
+
* information for glyphs and substrings. It also allows portions of text to
|
|
6802
|
+
* be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT.
|
|
6001
6803
|
* @gir-type Interface
|
|
6002
6804
|
*/
|
|
6003
6805
|
interface Text extends GObject.Object {
|
|
@@ -6032,7 +6834,6 @@ export namespace Atspi {
|
|
|
6032
6834
|
* Gets the attributes applied to a range of text from an {@link Atspi.Text}
|
|
6033
6835
|
* object. The text attributes correspond to CSS attributes
|
|
6034
6836
|
* where possible.
|
|
6035
|
-
* <em>DEPRECATED</em>
|
|
6036
6837
|
* @param offset a `gint` indicating the offset from which the attribute search is based.
|
|
6037
6838
|
* @returns a {@link GLib.HashTable} describing the attributes at the given character offset.
|
|
6038
6839
|
*/
|
|
@@ -6262,6 +7063,13 @@ export namespace Atspi {
|
|
|
6262
7063
|
prototype: Value;
|
|
6263
7064
|
}
|
|
6264
7065
|
/**
|
|
7066
|
+
* An interface supporting a one-dimensional scalar
|
|
7067
|
+
* to be modified, or which reflects its value.
|
|
7068
|
+
*
|
|
7069
|
+
* An interface supporting a one-dimensional scalar
|
|
7070
|
+
* to be modified, or which reflects its value. If
|
|
7071
|
+
* STATE_EDITABLE is not present, the value is
|
|
7072
|
+
* treated as "read only".
|
|
6265
7073
|
* @gir-type Interface
|
|
6266
7074
|
*/
|
|
6267
7075
|
interface Value extends GObject.Object {
|