@girs/atspi-2.0 4.3.0 → 4.5.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 +36 -41
- package/atspi-2.0.d.ts +834 -323
- package/package.json +5 -5
package/atspi-2.0.d.ts
CHANGED
|
@@ -39,30 +39,30 @@ export namespace Atspi {
|
|
|
39
39
|
* Indicates an error condition or
|
|
40
40
|
* uninitialized value.
|
|
41
41
|
*/
|
|
42
|
-
INVALID,
|
|
42
|
+
INVALID = 0,
|
|
43
43
|
/**
|
|
44
44
|
* `TRUE` if all of the criteria are met.
|
|
45
45
|
*/
|
|
46
|
-
ALL,
|
|
46
|
+
ALL = 1,
|
|
47
47
|
/**
|
|
48
48
|
* `TRUE` if any of the criteria are met.
|
|
49
49
|
*/
|
|
50
|
-
ANY,
|
|
50
|
+
ANY = 2,
|
|
51
51
|
/**
|
|
52
52
|
* `TRUE` if none of the criteria are met.
|
|
53
53
|
*/
|
|
54
|
-
NONE,
|
|
54
|
+
NONE = 3,
|
|
55
55
|
/**
|
|
56
56
|
* Same as `ATSPI_Collection_MATCH_ALL` if
|
|
57
57
|
* the criteria is non-empty; for empty criteria this rule requires returned
|
|
58
58
|
* value to also have empty set.
|
|
59
59
|
*/
|
|
60
|
-
EMPTY,
|
|
60
|
+
EMPTY = 4,
|
|
61
61
|
/**
|
|
62
62
|
* Used only to determine the end of the
|
|
63
63
|
* enumeration.
|
|
64
64
|
*/
|
|
65
|
-
LAST_DEFINED,
|
|
65
|
+
LAST_DEFINED = 5,
|
|
66
66
|
}
|
|
67
67
|
|
|
68
68
|
|
|
@@ -82,38 +82,38 @@ export namespace Atspi {
|
|
|
82
82
|
/**
|
|
83
83
|
* Invalid sort order
|
|
84
84
|
*/
|
|
85
|
-
INVALID,
|
|
85
|
+
INVALID = 0,
|
|
86
86
|
/**
|
|
87
87
|
* Canonical sort order
|
|
88
88
|
*/
|
|
89
|
-
CANONICAL,
|
|
89
|
+
CANONICAL = 1,
|
|
90
90
|
/**
|
|
91
91
|
* Flow sort order. reserved for future use.
|
|
92
92
|
*/
|
|
93
|
-
FLOW,
|
|
93
|
+
FLOW = 2,
|
|
94
94
|
/**
|
|
95
95
|
* Tab sort order. Reserved for future use.
|
|
96
96
|
*/
|
|
97
|
-
TAB,
|
|
97
|
+
TAB = 3,
|
|
98
98
|
/**
|
|
99
99
|
* Reverse canonical sort order
|
|
100
100
|
*/
|
|
101
|
-
REVERSE_CANONICAL,
|
|
101
|
+
REVERSE_CANONICAL = 4,
|
|
102
102
|
/**
|
|
103
103
|
* Reverse flow sort order. Reserved
|
|
104
104
|
* for future use.
|
|
105
105
|
*/
|
|
106
|
-
REVERSE_FLOW,
|
|
106
|
+
REVERSE_FLOW = 5,
|
|
107
107
|
/**
|
|
108
108
|
* Reverse tab sort order. Reserved
|
|
109
109
|
* for future use.
|
|
110
110
|
*/
|
|
111
|
-
REVERSE_TAB,
|
|
111
|
+
REVERSE_TAB = 6,
|
|
112
112
|
/**
|
|
113
113
|
* Used only to determine the end of
|
|
114
114
|
* the enumeration.
|
|
115
115
|
*/
|
|
116
|
-
LAST_DEFINED,
|
|
116
|
+
LAST_DEFINED = 7,
|
|
117
117
|
}
|
|
118
118
|
|
|
119
119
|
|
|
@@ -133,20 +133,20 @@ export namespace Atspi {
|
|
|
133
133
|
/**
|
|
134
134
|
* Restrict children tree traveral
|
|
135
135
|
*/
|
|
136
|
-
RESTRICT_CHILDREN,
|
|
136
|
+
RESTRICT_CHILDREN = 0,
|
|
137
137
|
/**
|
|
138
138
|
* Restrict sibling tree traversal
|
|
139
139
|
*/
|
|
140
|
-
RESTRICT_SIBLING,
|
|
140
|
+
RESTRICT_SIBLING = 1,
|
|
141
141
|
/**
|
|
142
142
|
* In-order tree traversal.
|
|
143
143
|
*/
|
|
144
|
-
INORDER,
|
|
144
|
+
INORDER = 2,
|
|
145
145
|
/**
|
|
146
146
|
* Used only to determine the end of the
|
|
147
147
|
* enumeration.
|
|
148
148
|
*/
|
|
149
|
-
LAST_DEFINED,
|
|
149
|
+
LAST_DEFINED = 3,
|
|
150
150
|
}
|
|
151
151
|
|
|
152
152
|
|
|
@@ -182,47 +182,47 @@ export namespace Atspi {
|
|
|
182
182
|
/**
|
|
183
183
|
* Indicates an error condition or uninitialized value.
|
|
184
184
|
*/
|
|
185
|
-
INVALID,
|
|
185
|
+
INVALID = 0,
|
|
186
186
|
/**
|
|
187
187
|
* The bottom-most layer, over which everything else
|
|
188
188
|
* is painted. The 'desktop background' is generally in this layer.
|
|
189
189
|
*/
|
|
190
|
-
BACKGROUND,
|
|
190
|
+
BACKGROUND = 1,
|
|
191
191
|
/**
|
|
192
192
|
* The 'background' layer for most content renderers and
|
|
193
193
|
* UI {@link Atspi.Component} containers.
|
|
194
194
|
*/
|
|
195
|
-
CANVAS,
|
|
195
|
+
CANVAS = 2,
|
|
196
196
|
/**
|
|
197
197
|
* The layer in which the majority of ordinary
|
|
198
198
|
* 'foreground' widgets reside.
|
|
199
199
|
*/
|
|
200
|
-
WIDGET,
|
|
200
|
+
WIDGET = 3,
|
|
201
201
|
/**
|
|
202
202
|
* A special layer between `ATSPI_LAYER_CANVAS` and
|
|
203
203
|
* `ATSPI_LAYER_WIDGET`, in which the 'pseudo windows' (e.g. the MDI frames)
|
|
204
204
|
* reside. See `atspi_component_get_mdi_z_order`.
|
|
205
205
|
*/
|
|
206
|
-
MDI,
|
|
206
|
+
MDI = 4,
|
|
207
207
|
/**
|
|
208
208
|
* A layer for popup window content, above
|
|
209
209
|
* `ATSPI_LAYER_WIDGET`.
|
|
210
210
|
*/
|
|
211
|
-
POPUP,
|
|
211
|
+
POPUP = 5,
|
|
212
212
|
/**
|
|
213
213
|
* The topmost layer.
|
|
214
214
|
*/
|
|
215
|
-
OVERLAY,
|
|
215
|
+
OVERLAY = 6,
|
|
216
216
|
/**
|
|
217
217
|
* The layer in which a toplevel window background usually
|
|
218
218
|
* resides.
|
|
219
219
|
*/
|
|
220
|
-
WINDOW,
|
|
220
|
+
WINDOW = 7,
|
|
221
221
|
/**
|
|
222
222
|
* Used only to determine the end of the
|
|
223
223
|
* enumeration.
|
|
224
224
|
*/
|
|
225
|
-
LAST_DEFINED,
|
|
225
|
+
LAST_DEFINED = 8,
|
|
226
226
|
}
|
|
227
227
|
|
|
228
228
|
|
|
@@ -242,18 +242,18 @@ export namespace Atspi {
|
|
|
242
242
|
/**
|
|
243
243
|
* Specifies xy coordinates relative to the screen.
|
|
244
244
|
*/
|
|
245
|
-
SCREEN,
|
|
245
|
+
SCREEN = 0,
|
|
246
246
|
/**
|
|
247
247
|
* Specifies xy coordinates relative to the widget's
|
|
248
248
|
* top-level window.
|
|
249
249
|
*/
|
|
250
|
-
WINDOW,
|
|
250
|
+
WINDOW = 1,
|
|
251
251
|
/**
|
|
252
252
|
* Specifies xy coordinates relative to the widget's
|
|
253
253
|
* immediate parent.
|
|
254
254
|
*/
|
|
255
|
-
PARENT,
|
|
256
|
-
LAST_DEFINED,
|
|
255
|
+
PARENT = 2,
|
|
256
|
+
LAST_DEFINED = 3,
|
|
257
257
|
}
|
|
258
258
|
|
|
259
259
|
|
|
@@ -275,23 +275,23 @@ export namespace Atspi {
|
|
|
275
275
|
* Indicates that a key on a keyboard device was
|
|
276
276
|
* pressed.
|
|
277
277
|
*/
|
|
278
|
-
KEY_PRESSED_EVENT,
|
|
278
|
+
KEY_PRESSED_EVENT = 0,
|
|
279
279
|
/**
|
|
280
280
|
* Indicates that a key on a keyboard device was
|
|
281
281
|
* released.
|
|
282
282
|
*/
|
|
283
|
-
KEY_RELEASED_EVENT,
|
|
283
|
+
KEY_RELEASED_EVENT = 1,
|
|
284
284
|
/**
|
|
285
285
|
* Indicates that a button on a non-keyboard
|
|
286
286
|
* human interface device (HID) was pressed.
|
|
287
287
|
*/
|
|
288
|
-
BUTTON_PRESSED_EVENT,
|
|
288
|
+
BUTTON_PRESSED_EVENT = 2,
|
|
289
289
|
/**
|
|
290
290
|
* Indicates that a button on a non-keyboard
|
|
291
291
|
* human interface device (HID) was released.
|
|
292
292
|
*/
|
|
293
|
-
BUTTON_RELEASED_EVENT,
|
|
294
|
-
EVENT_LAST_DEFINED,
|
|
293
|
+
BUTTON_RELEASED_EVENT = 3,
|
|
294
|
+
EVENT_LAST_DEFINED = 4,
|
|
295
295
|
}
|
|
296
296
|
|
|
297
297
|
|
|
@@ -310,12 +310,12 @@ export namespace Atspi {
|
|
|
310
310
|
/**
|
|
311
311
|
* Key press event
|
|
312
312
|
*/
|
|
313
|
-
PRESSED,
|
|
313
|
+
PRESSED = 0,
|
|
314
314
|
/**
|
|
315
315
|
* Key release event
|
|
316
316
|
*/
|
|
317
|
-
RELEASED,
|
|
318
|
-
EVENT_LAST_DEFINED,
|
|
317
|
+
RELEASED = 1,
|
|
318
|
+
EVENT_LAST_DEFINED = 2,
|
|
319
319
|
}
|
|
320
320
|
|
|
321
321
|
|
|
@@ -335,16 +335,16 @@ export namespace Atspi {
|
|
|
335
335
|
/**
|
|
336
336
|
* Emulates the pressing of a hardware keyboard key.
|
|
337
337
|
*/
|
|
338
|
-
PRESS,
|
|
338
|
+
PRESS = 0,
|
|
339
339
|
/**
|
|
340
340
|
* Emulates the release of a hardware keyboard key.
|
|
341
341
|
*/
|
|
342
|
-
RELEASE,
|
|
342
|
+
RELEASE = 1,
|
|
343
343
|
/**
|
|
344
344
|
* Emulates the pressing and immediate releasing
|
|
345
345
|
* of a hardware keyboard key.
|
|
346
346
|
*/
|
|
347
|
-
PRESSRELEASE,
|
|
347
|
+
PRESSRELEASE = 2,
|
|
348
348
|
/**
|
|
349
349
|
* A symbolic key event is generated, without specifying a
|
|
350
350
|
* hardware key. Note: if the keysym is not present in the current keyboard
|
|
@@ -358,7 +358,7 @@ export namespace Atspi {
|
|
|
358
358
|
* i.e., present on the system keyboard for the current locale (even if a
|
|
359
359
|
* physical hardware keyboard is not connected).
|
|
360
360
|
*/
|
|
361
|
-
SYM,
|
|
361
|
+
SYM = 3,
|
|
362
362
|
/**
|
|
363
363
|
* A string is converted to its equivalent keyboard events
|
|
364
364
|
* and emitted. If the string consists of complex characters or composed
|
|
@@ -367,16 +367,16 @@ export namespace Atspi {
|
|
|
367
367
|
* `ATSPI_KEY_SYM`. In practice this limitation primarily effects
|
|
368
368
|
* Chinese and Japanese locales.
|
|
369
369
|
*/
|
|
370
|
-
STRING,
|
|
370
|
+
STRING = 4,
|
|
371
371
|
/**
|
|
372
372
|
* Emulates locking a set of modifiers.
|
|
373
373
|
*/
|
|
374
|
-
LOCKMODIFIERS,
|
|
374
|
+
LOCKMODIFIERS = 5,
|
|
375
375
|
/**
|
|
376
376
|
* Emulates unlocking a set of modifiers.
|
|
377
377
|
*/
|
|
378
|
-
UNLOCKMODIFIERS,
|
|
379
|
-
SYNTH_LAST_DEFINED,
|
|
378
|
+
UNLOCKMODIFIERS = 6,
|
|
379
|
+
SYNTH_LAST_DEFINED = 7,
|
|
380
380
|
}
|
|
381
381
|
|
|
382
382
|
|
|
@@ -398,15 +398,15 @@ export namespace Atspi {
|
|
|
398
398
|
/**
|
|
399
399
|
* No live region.
|
|
400
400
|
*/
|
|
401
|
-
NONE,
|
|
401
|
+
NONE = 0,
|
|
402
402
|
/**
|
|
403
403
|
* This live region should be considered polite.
|
|
404
404
|
*/
|
|
405
|
-
POLITE,
|
|
405
|
+
POLITE = 1,
|
|
406
406
|
/**
|
|
407
407
|
* This live region should be considered assertive.
|
|
408
408
|
*/
|
|
409
|
-
ASSERTIVE,
|
|
409
|
+
ASSERTIVE = 2,
|
|
410
410
|
}
|
|
411
411
|
|
|
412
412
|
|
|
@@ -426,32 +426,32 @@ export namespace Atspi {
|
|
|
426
426
|
/**
|
|
427
427
|
* For localizable natural-language messages.
|
|
428
428
|
*/
|
|
429
|
-
MESSAGES,
|
|
429
|
+
MESSAGES = 0,
|
|
430
430
|
/**
|
|
431
431
|
* For regular expression matching and string
|
|
432
432
|
* collation.
|
|
433
433
|
*/
|
|
434
|
-
COLLATE,
|
|
434
|
+
COLLATE = 1,
|
|
435
435
|
/**
|
|
436
436
|
* For regular expression matching, character
|
|
437
437
|
* classification, conversion, case-sensitive comparison, and wide character
|
|
438
438
|
* functions.
|
|
439
439
|
*/
|
|
440
|
-
CTYPE,
|
|
440
|
+
CTYPE = 2,
|
|
441
441
|
/**
|
|
442
442
|
* For monetary formatting.
|
|
443
443
|
*/
|
|
444
|
-
MONETARY,
|
|
444
|
+
MONETARY = 3,
|
|
445
445
|
/**
|
|
446
446
|
* For number formatting (such as the decimal
|
|
447
447
|
* point and the thousands separator).
|
|
448
448
|
*/
|
|
449
|
-
NUMERIC,
|
|
449
|
+
NUMERIC = 4,
|
|
450
450
|
/**
|
|
451
451
|
* For time and date formatting.
|
|
452
452
|
*/
|
|
453
|
-
TIME,
|
|
454
|
-
LAST_DEFINED,
|
|
453
|
+
TIME = 5,
|
|
454
|
+
LAST_DEFINED = 6,
|
|
455
455
|
}
|
|
456
456
|
|
|
457
457
|
|
|
@@ -469,19 +469,19 @@ export namespace Atspi {
|
|
|
469
469
|
/**
|
|
470
470
|
* The left or right 'Shift' key.
|
|
471
471
|
*/
|
|
472
|
-
SHIFT,
|
|
472
|
+
SHIFT = 0,
|
|
473
473
|
/**
|
|
474
474
|
* The ShiftLock or CapsLock key.
|
|
475
475
|
*/
|
|
476
|
-
SHIFTLOCK,
|
|
476
|
+
SHIFTLOCK = 1,
|
|
477
477
|
/**
|
|
478
478
|
* 'Control'/'Ctrl'.
|
|
479
479
|
*/
|
|
480
|
-
CONTROL,
|
|
480
|
+
CONTROL = 2,
|
|
481
481
|
/**
|
|
482
482
|
* The Alt key (as opposed to AltGr).
|
|
483
483
|
*/
|
|
484
|
-
ALT,
|
|
484
|
+
ALT = 3,
|
|
485
485
|
/**
|
|
486
486
|
* Depending on the platform, this may map to 'Window',
|
|
487
487
|
* 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will
|
|
@@ -490,24 +490,24 @@ export namespace Atspi {
|
|
|
490
490
|
* event having `ATSPI_MODIFIER_META2` means that the 'Mod2Mask' bit
|
|
491
491
|
* is set in the corresponding XEvent.
|
|
492
492
|
*/
|
|
493
|
-
META,
|
|
493
|
+
META = 4,
|
|
494
494
|
/**
|
|
495
495
|
* See `ATSPI_MODIFIER_META`.
|
|
496
496
|
*/
|
|
497
|
-
META2,
|
|
497
|
+
META2 = 5,
|
|
498
498
|
/**
|
|
499
499
|
* See `ATSPI_MODIFIER_META`.
|
|
500
500
|
*/
|
|
501
|
-
META3,
|
|
501
|
+
META3 = 6,
|
|
502
502
|
/**
|
|
503
503
|
* Alias for META3.
|
|
504
504
|
*/
|
|
505
|
-
SUPER,
|
|
505
|
+
SUPER = 6,
|
|
506
506
|
/**
|
|
507
507
|
* A symbolic meta key name that is mapped by AT-SPI
|
|
508
508
|
* to the appropriate META value, for the convenience of the client.
|
|
509
509
|
*/
|
|
510
|
-
NUMLOCK,
|
|
510
|
+
NUMLOCK = 14,
|
|
511
511
|
}
|
|
512
512
|
|
|
513
513
|
|
|
@@ -544,80 +544,80 @@ export namespace Atspi {
|
|
|
544
544
|
* Not a meaningful relationship; clients should not
|
|
545
545
|
* normally encounter this {@link Atspi.RelationType} value.
|
|
546
546
|
*/
|
|
547
|
-
NULL,
|
|
547
|
+
NULL = 0,
|
|
548
548
|
/**
|
|
549
549
|
* Object is a label for one or more other objects.
|
|
550
550
|
*/
|
|
551
|
-
LABEL_FOR,
|
|
551
|
+
LABEL_FOR = 1,
|
|
552
552
|
/**
|
|
553
553
|
* Object is labelled by one or more other
|
|
554
554
|
* objects.
|
|
555
555
|
*/
|
|
556
|
-
LABELLED_BY,
|
|
556
|
+
LABELLED_BY = 2,
|
|
557
557
|
/**
|
|
558
558
|
* Object is an interactive object which
|
|
559
559
|
* modifies the state, onscreen location, or other attributes of one or more
|
|
560
560
|
* target objects.
|
|
561
561
|
*/
|
|
562
|
-
CONTROLLER_FOR,
|
|
562
|
+
CONTROLLER_FOR = 3,
|
|
563
563
|
/**
|
|
564
564
|
* Object state, position, etc. is
|
|
565
565
|
* modified/controlled by user interaction with one or more other objects.
|
|
566
566
|
* For instance a viewport or scroll pane may be `ATSPI_RELATION_CONTROLLED_BY`
|
|
567
567
|
* scrollbars.
|
|
568
568
|
*/
|
|
569
|
-
CONTROLLED_BY,
|
|
569
|
+
CONTROLLED_BY = 4,
|
|
570
570
|
/**
|
|
571
571
|
* Object has a grouping relationship (e.g. 'same
|
|
572
572
|
* group as') to one or more other objects.
|
|
573
573
|
*/
|
|
574
|
-
MEMBER_OF,
|
|
574
|
+
MEMBER_OF = 5,
|
|
575
575
|
/**
|
|
576
576
|
* Object is a tooltip associated with another
|
|
577
577
|
* object.
|
|
578
578
|
*/
|
|
579
|
-
TOOLTIP_FOR,
|
|
579
|
+
TOOLTIP_FOR = 6,
|
|
580
580
|
/**
|
|
581
581
|
* Object is a child of the target.
|
|
582
582
|
*/
|
|
583
|
-
NODE_CHILD_OF,
|
|
583
|
+
NODE_CHILD_OF = 7,
|
|
584
584
|
/**
|
|
585
585
|
* Object is a parent of the target.
|
|
586
586
|
*/
|
|
587
|
-
NODE_PARENT_OF,
|
|
587
|
+
NODE_PARENT_OF = 8,
|
|
588
588
|
/**
|
|
589
589
|
* Used to indicate that a relationship exists, but
|
|
590
590
|
* its type is not specified in the enumeration.
|
|
591
591
|
*/
|
|
592
|
-
EXTENDED,
|
|
592
|
+
EXTENDED = 9,
|
|
593
593
|
/**
|
|
594
594
|
* Object renders content which flows logically to
|
|
595
595
|
* another object. For instance, text in a paragraph may flow to another
|
|
596
596
|
* object which is not the 'next sibling' in the accessibility hierarchy.
|
|
597
597
|
*/
|
|
598
|
-
FLOWS_TO,
|
|
598
|
+
FLOWS_TO = 10,
|
|
599
599
|
/**
|
|
600
600
|
* Reciprocal of `ATSPI_RELATION_FLOWS_TO`.
|
|
601
601
|
*/
|
|
602
|
-
FLOWS_FROM,
|
|
602
|
+
FLOWS_FROM = 11,
|
|
603
603
|
/**
|
|
604
604
|
* Object is visually and semantically considered
|
|
605
605
|
* a subwindow of another object, even though it is not the object's child.
|
|
606
606
|
* Useful when dealing with embedded applications and other cases where the
|
|
607
607
|
* widget hierarchy does not map cleanly to the onscreen presentation.
|
|
608
608
|
*/
|
|
609
|
-
SUBWINDOW_OF,
|
|
609
|
+
SUBWINDOW_OF = 12,
|
|
610
610
|
/**
|
|
611
611
|
* Similar to `ATSPI_RELATION_SUBWINDOW_OF`, but
|
|
612
612
|
* specifically used for cross-process embedding.
|
|
613
613
|
*/
|
|
614
|
-
EMBEDS,
|
|
614
|
+
EMBEDS = 13,
|
|
615
615
|
/**
|
|
616
616
|
* Reciprocal of `ATSPI_RELATION_EMBEDS`. Used to
|
|
617
617
|
* denote content rendered by embedded renderers that live in a separate process
|
|
618
618
|
* space from the embedding context.
|
|
619
619
|
*/
|
|
620
|
-
EMBEDDED_BY,
|
|
620
|
+
EMBEDDED_BY = 14,
|
|
621
621
|
/**
|
|
622
622
|
* Denotes that the object is a transient window or
|
|
623
623
|
* frame associated with another onscreen object. Similar to `ATSPI_TOOLTIP_FOR`,
|
|
@@ -629,18 +629,18 @@ export namespace Atspi {
|
|
|
629
629
|
* of assistive technology clients, even though the previous toplevel
|
|
630
630
|
* `ATSPI_ROLE_FRAME` object may still be the active window.
|
|
631
631
|
*/
|
|
632
|
-
POPUP_FOR,
|
|
632
|
+
POPUP_FOR = 15,
|
|
633
633
|
/**
|
|
634
634
|
* This is the reciprocal relation to
|
|
635
635
|
* `ATSPI_RELATION_POPUP_FOR`.
|
|
636
636
|
*/
|
|
637
|
-
PARENT_WINDOW_OF,
|
|
637
|
+
PARENT_WINDOW_OF = 16,
|
|
638
638
|
/**
|
|
639
639
|
* Reciprocal of {@link Atspi.RelationType.DESCRIBED_BY}.
|
|
640
640
|
* Indicates that this object provides descriptive information about the target
|
|
641
641
|
* object(s). See also {@link Atspi.RelationType.DETAILS_FOR} and {@link Atspi.RelationType.ERROR_FOR}.
|
|
642
642
|
*/
|
|
643
|
-
DESCRIPTION_FOR,
|
|
643
|
+
DESCRIPTION_FOR = 17,
|
|
644
644
|
/**
|
|
645
645
|
* Reciprocal of {@link Atspi.RelationType.DESCRIPTION_FOR}.
|
|
646
646
|
* Indicates that one or more target objects provide descriptive information
|
|
@@ -655,7 +655,7 @@ export namespace Atspi {
|
|
|
655
655
|
* objects containing detailed descriptions so that their content can be more
|
|
656
656
|
* closely reviewed.
|
|
657
657
|
*/
|
|
658
|
-
DESCRIBED_BY,
|
|
658
|
+
DESCRIBED_BY = 18,
|
|
659
659
|
/**
|
|
660
660
|
* Reciprocal of {@link Atspi.RelationType.DETAILS_FOR}. Indicates that this object has a
|
|
661
661
|
* detailed or extended description, the contents of which can be found in the
|
|
@@ -665,32 +665,36 @@ export namespace Atspi {
|
|
|
665
665
|
* announcement only, see {@link Atspi.RelationType.DESCRIBED_BY}. If the detailed
|
|
666
666
|
* information describes an error condition, {@link Atspi.RelationType.ERROR_FOR} should
|
|
667
667
|
* be used instead.
|
|
668
|
+
* @since 2.26
|
|
668
669
|
*/
|
|
669
|
-
DETAILS,
|
|
670
|
+
DETAILS = 19,
|
|
670
671
|
/**
|
|
671
672
|
* Reciprocal of {@link Atspi.RelationType.DETAILS}. Indicates that this object provides a
|
|
672
673
|
* detailed or extended description about the target object(s). See also
|
|
673
674
|
* {@link Atspi.RelationType.DESCRIPTION_FOR} and {@link Atspi.RelationType.ERROR_FOR}.
|
|
675
|
+
* @since 2.26
|
|
674
676
|
*/
|
|
675
|
-
DETAILS_FOR,
|
|
677
|
+
DETAILS_FOR = 20,
|
|
676
678
|
/**
|
|
677
679
|
* Reciprocal of {@link Atspi.RelationType.ERROR_FOR}. Indicates that this object has one
|
|
678
680
|
* or more errors, the nature of which is described in the contents of the
|
|
679
681
|
* target object(s). Objects that have this relation type should also contain
|
|
680
682
|
* {@link Atspi.StateType.INVALID_ENTRY} in their {@link Atspi.StateSet}.
|
|
683
|
+
* @since 2.26
|
|
681
684
|
*/
|
|
682
|
-
ERROR_MESSAGE,
|
|
685
|
+
ERROR_MESSAGE = 21,
|
|
683
686
|
/**
|
|
684
687
|
* Reciprocal of {@link Atspi.RelationType.ERROR_MESSAGE}. Indicates that this object
|
|
685
688
|
* contains an error message describing an invalid condition in the target
|
|
686
689
|
* object(s).
|
|
690
|
+
* @since 2.26
|
|
687
691
|
*/
|
|
688
|
-
ERROR_FOR,
|
|
692
|
+
ERROR_FOR = 22,
|
|
689
693
|
/**
|
|
690
694
|
* Do not use as a parameter value, used to
|
|
691
695
|
* determine the size of the enumeration.
|
|
692
696
|
*/
|
|
693
|
-
LAST_DEFINED,
|
|
697
|
+
LAST_DEFINED = 23,
|
|
694
698
|
}
|
|
695
699
|
|
|
696
700
|
|
|
@@ -711,239 +715,240 @@ export namespace Atspi {
|
|
|
711
715
|
* A role indicating an error condition, such as
|
|
712
716
|
* uninitialized Role data.
|
|
713
717
|
*/
|
|
714
|
-
INVALID,
|
|
718
|
+
INVALID = 0,
|
|
715
719
|
/**
|
|
716
720
|
* Object is a label indicating the keyboard
|
|
717
721
|
* accelerators for the parent.
|
|
718
722
|
*/
|
|
719
|
-
ACCELERATOR_LABEL,
|
|
723
|
+
ACCELERATOR_LABEL = 1,
|
|
720
724
|
/**
|
|
721
725
|
* Object is used to alert the user about something.
|
|
722
726
|
*/
|
|
723
|
-
ALERT,
|
|
727
|
+
ALERT = 2,
|
|
724
728
|
/**
|
|
725
729
|
* Object contains a dynamic or moving image of some
|
|
726
730
|
* kind.
|
|
727
731
|
*/
|
|
728
|
-
ANIMATION,
|
|
732
|
+
ANIMATION = 3,
|
|
729
733
|
/**
|
|
730
734
|
* Object is a 2d directional indicator.
|
|
731
735
|
*/
|
|
732
|
-
ARROW,
|
|
736
|
+
ARROW = 4,
|
|
733
737
|
/**
|
|
734
738
|
* Object contains one or more dates, usually arranged
|
|
735
739
|
* into a 2d list.
|
|
736
740
|
*/
|
|
737
|
-
CALENDAR,
|
|
741
|
+
CALENDAR = 5,
|
|
738
742
|
/**
|
|
739
743
|
* Object that can be drawn into and is used to trap
|
|
740
744
|
* events.
|
|
741
745
|
*/
|
|
742
|
-
CANVAS,
|
|
746
|
+
CANVAS = 6,
|
|
743
747
|
/**
|
|
744
748
|
* A choice that can be checked or unchecked and
|
|
745
749
|
* provides a separate indicator for the current state.
|
|
746
750
|
*/
|
|
747
|
-
CHECK_BOX,
|
|
751
|
+
CHECK_BOX = 7,
|
|
748
752
|
/**
|
|
749
753
|
* A menu item that behaves like a check box. See
|
|
750
754
|
* `ATSPI_ROLE_CHECK_BOX`.
|
|
751
755
|
*/
|
|
752
|
-
CHECK_MENU_ITEM,
|
|
756
|
+
CHECK_MENU_ITEM = 8,
|
|
753
757
|
/**
|
|
754
758
|
* A specialized dialog that lets the user choose a
|
|
755
759
|
* color.
|
|
756
760
|
*/
|
|
757
|
-
COLOR_CHOOSER,
|
|
761
|
+
COLOR_CHOOSER = 9,
|
|
758
762
|
/**
|
|
759
763
|
* The header for a column of data.
|
|
760
764
|
*/
|
|
761
|
-
COLUMN_HEADER,
|
|
765
|
+
COLUMN_HEADER = 10,
|
|
762
766
|
/**
|
|
763
767
|
* A list of choices the user can select from.
|
|
764
768
|
*/
|
|
765
|
-
COMBO_BOX,
|
|
769
|
+
COMBO_BOX = 11,
|
|
766
770
|
/**
|
|
767
771
|
* An object which allows entry of a date.
|
|
768
772
|
*/
|
|
769
|
-
DATE_EDITOR,
|
|
773
|
+
DATE_EDITOR = 12,
|
|
770
774
|
/**
|
|
771
775
|
* An inconifed internal frame within a DESKTOP_FRAME.
|
|
772
776
|
*/
|
|
773
|
-
DESKTOP_ICON,
|
|
777
|
+
DESKTOP_ICON = 13,
|
|
774
778
|
/**
|
|
775
779
|
* A pane that supports internal frames and
|
|
776
780
|
* iconified versions of those internal frames.
|
|
777
781
|
*/
|
|
778
|
-
DESKTOP_FRAME,
|
|
782
|
+
DESKTOP_FRAME = 14,
|
|
779
783
|
/**
|
|
780
784
|
* An object that allows a value to be changed via rotating a
|
|
781
785
|
* visual element, or which displays a value via such a rotating element.
|
|
782
786
|
*/
|
|
783
|
-
DIAL,
|
|
787
|
+
DIAL = 15,
|
|
784
788
|
/**
|
|
785
789
|
* A top level window with title bar and a border.
|
|
786
790
|
*/
|
|
787
|
-
DIALOG,
|
|
791
|
+
DIALOG = 16,
|
|
788
792
|
/**
|
|
789
793
|
* A pane that allows the user to navigate through
|
|
790
794
|
* and select the contents of a directory.
|
|
791
795
|
*/
|
|
792
|
-
DIRECTORY_PANE,
|
|
796
|
+
DIRECTORY_PANE = 17,
|
|
793
797
|
/**
|
|
794
798
|
* An object used for drawing custom user interface
|
|
795
799
|
* elements.
|
|
796
800
|
*/
|
|
797
|
-
DRAWING_AREA,
|
|
801
|
+
DRAWING_AREA = 18,
|
|
798
802
|
/**
|
|
799
803
|
* A specialized dialog that displays the files in
|
|
800
804
|
* the directory and lets the user select a file, browse a different
|
|
801
805
|
* directory, or specify a filename.
|
|
802
806
|
*/
|
|
803
|
-
FILE_CHOOSER,
|
|
807
|
+
FILE_CHOOSER = 19,
|
|
804
808
|
/**
|
|
805
809
|
* A object that fills up space in a user interface.
|
|
806
810
|
*/
|
|
807
|
-
FILLER,
|
|
811
|
+
FILLER = 20,
|
|
808
812
|
/**
|
|
809
813
|
* Don't use, reserved for future use.
|
|
810
814
|
*/
|
|
811
|
-
FOCUS_TRAVERSABLE,
|
|
815
|
+
FOCUS_TRAVERSABLE = 21,
|
|
812
816
|
/**
|
|
813
817
|
* Allows selection of a display font.
|
|
814
818
|
*/
|
|
815
|
-
FONT_CHOOSER,
|
|
819
|
+
FONT_CHOOSER = 22,
|
|
816
820
|
/**
|
|
817
821
|
* A top level window with a title bar, border, menubar,
|
|
818
822
|
* etc.
|
|
819
823
|
*/
|
|
820
|
-
FRAME,
|
|
824
|
+
FRAME = 23,
|
|
821
825
|
/**
|
|
822
826
|
* A pane that is guaranteed to be painted on top of
|
|
823
827
|
* all panes beneath it.
|
|
824
828
|
*/
|
|
825
|
-
GLASS_PANE,
|
|
829
|
+
GLASS_PANE = 24,
|
|
826
830
|
/**
|
|
827
831
|
* A document container for HTML, whose children
|
|
828
832
|
* represent the document content.
|
|
829
833
|
*/
|
|
830
|
-
HTML_CONTAINER,
|
|
834
|
+
HTML_CONTAINER = 25,
|
|
831
835
|
/**
|
|
832
836
|
* A small fixed size picture, typically used to decorate
|
|
833
837
|
* components.
|
|
834
838
|
*/
|
|
835
|
-
ICON,
|
|
839
|
+
ICON = 26,
|
|
836
840
|
/**
|
|
837
841
|
* An image, typically static.
|
|
838
842
|
*/
|
|
839
|
-
IMAGE,
|
|
843
|
+
IMAGE = 27,
|
|
840
844
|
/**
|
|
841
845
|
* A frame-like object that is clipped by a desktop
|
|
842
846
|
* pane.
|
|
843
847
|
*/
|
|
844
|
-
INTERNAL_FRAME,
|
|
848
|
+
INTERNAL_FRAME = 28,
|
|
845
849
|
/**
|
|
846
850
|
* For text views, see `ATSPI_ROLE_TEXT`. For generic containers, see
|
|
847
851
|
* `ATSPI_ROLE_PANEL`. For objects whose role is not known by the implementor,
|
|
848
852
|
* see `ATSPI_ROLE_UNKNOWN`.
|
|
853
|
+
* @since 2.16
|
|
849
854
|
*/
|
|
850
|
-
LABEL,
|
|
855
|
+
LABEL = 29,
|
|
851
856
|
/**
|
|
852
857
|
* A specialized pane that allows its children to be
|
|
853
858
|
* drawn in layers, providing a form of stacking order.
|
|
854
859
|
*/
|
|
855
|
-
LAYERED_PANE,
|
|
860
|
+
LAYERED_PANE = 30,
|
|
856
861
|
/**
|
|
857
862
|
* An object that presents a list of objects to the user and
|
|
858
863
|
* allows the user to select one or more of them.
|
|
859
864
|
*/
|
|
860
|
-
LIST,
|
|
865
|
+
LIST = 31,
|
|
861
866
|
/**
|
|
862
867
|
* An object that represents an element of a list.
|
|
863
868
|
*/
|
|
864
|
-
LIST_ITEM,
|
|
869
|
+
LIST_ITEM = 32,
|
|
865
870
|
/**
|
|
866
871
|
* An object usually found inside a menu bar that contains a
|
|
867
872
|
* list of actions the user can choose from.
|
|
868
873
|
*/
|
|
869
|
-
MENU,
|
|
874
|
+
MENU = 33,
|
|
870
875
|
/**
|
|
871
876
|
* An object usually drawn at the top of the primary
|
|
872
877
|
* dialog box of an application that contains a list of menus the user can
|
|
873
878
|
* choose from.
|
|
874
879
|
*/
|
|
875
|
-
MENU_BAR,
|
|
880
|
+
MENU_BAR = 34,
|
|
876
881
|
/**
|
|
877
882
|
* An object usually contained in a menu that presents
|
|
878
883
|
* an action the user can choose.
|
|
879
884
|
*/
|
|
880
|
-
MENU_ITEM,
|
|
885
|
+
MENU_ITEM = 35,
|
|
881
886
|
/**
|
|
882
887
|
* A specialized pane whose primary use is inside a
|
|
883
888
|
* dialog.
|
|
884
889
|
*/
|
|
885
|
-
OPTION_PANE,
|
|
890
|
+
OPTION_PANE = 36,
|
|
886
891
|
/**
|
|
887
892
|
* An object that is a child of a page tab list.
|
|
888
893
|
*/
|
|
889
|
-
PAGE_TAB,
|
|
894
|
+
PAGE_TAB = 37,
|
|
890
895
|
/**
|
|
891
896
|
* An object that presents a series of panels (or
|
|
892
897
|
* page tabs), one at a time,through some mechanism provided by the
|
|
893
898
|
* object.
|
|
894
899
|
*/
|
|
895
|
-
PAGE_TAB_LIST,
|
|
900
|
+
PAGE_TAB_LIST = 38,
|
|
896
901
|
/**
|
|
897
902
|
* A generic container that is often used to group objects.
|
|
898
903
|
*/
|
|
899
|
-
PANEL,
|
|
904
|
+
PANEL = 39,
|
|
900
905
|
/**
|
|
901
906
|
* A text object uses for passwords, or other places
|
|
902
907
|
* where the text content is not shown visibly to the user.
|
|
903
908
|
*/
|
|
904
|
-
PASSWORD_TEXT,
|
|
909
|
+
PASSWORD_TEXT = 40,
|
|
905
910
|
/**
|
|
906
911
|
* A temporary window that is usually used to offer the
|
|
907
912
|
* user a list of choices, and then hides when the user selects one of those
|
|
908
913
|
* choices.
|
|
909
914
|
*/
|
|
910
|
-
POPUP_MENU,
|
|
915
|
+
POPUP_MENU = 41,
|
|
911
916
|
/**
|
|
912
917
|
* An object used to indicate how much of a task has
|
|
913
918
|
* been completed.
|
|
914
919
|
*/
|
|
915
|
-
PROGRESS_BAR,
|
|
920
|
+
PROGRESS_BAR = 42,
|
|
916
921
|
/**
|
|
917
922
|
* An object the user can manipulate to tell the
|
|
918
923
|
* application to do something.
|
|
919
924
|
*/
|
|
920
|
-
BUTTON,
|
|
925
|
+
BUTTON = 43,
|
|
921
926
|
/**
|
|
922
927
|
* A specialized check box that will cause other
|
|
923
928
|
* radio buttons in the same group to become unchecked when this one is
|
|
924
929
|
* checked.
|
|
925
930
|
*/
|
|
926
|
-
RADIO_BUTTON,
|
|
931
|
+
RADIO_BUTTON = 44,
|
|
927
932
|
/**
|
|
928
933
|
* Object is both a menu item and a "radio button"
|
|
929
934
|
* . See `ATSPI_ROLE_RADIO_BUTTON`.
|
|
930
935
|
*/
|
|
931
|
-
RADIO_MENU_ITEM,
|
|
936
|
+
RADIO_MENU_ITEM = 45,
|
|
932
937
|
/**
|
|
933
938
|
* A specialized pane that has a glass pane and a
|
|
934
939
|
* layered pane as its children.
|
|
935
940
|
*/
|
|
936
|
-
ROOT_PANE,
|
|
941
|
+
ROOT_PANE = 46,
|
|
937
942
|
/**
|
|
938
943
|
* The header for a row of data.
|
|
939
944
|
*/
|
|
940
|
-
ROW_HEADER,
|
|
945
|
+
ROW_HEADER = 47,
|
|
941
946
|
/**
|
|
942
947
|
* An object usually used to allow a user to
|
|
943
948
|
* incrementally view a large amount of data by moving the bounds of a
|
|
944
949
|
* viewport along a one-dimensional axis.
|
|
945
950
|
*/
|
|
946
|
-
SCROLL_BAR,
|
|
951
|
+
SCROLL_BAR = 48,
|
|
947
952
|
/**
|
|
948
953
|
* An object that allows a user to incrementally view
|
|
949
954
|
* a large amount of information. `ATSPI_ROLE_SCROLL_PANE` objects are usually
|
|
@@ -951,65 +956,65 @@ export namespace Atspi {
|
|
|
951
956
|
* `ATSPI_RELATION_CONTROLLER_FOR` and `ATSPI_RELATION_CONTROLLED_BY`
|
|
952
957
|
* reciprocal relations are set. See `atspi_get_relation_set`.
|
|
953
958
|
*/
|
|
954
|
-
SCROLL_PANE,
|
|
959
|
+
SCROLL_PANE = 49,
|
|
955
960
|
/**
|
|
956
961
|
* An object usually contained in a menu to provide a
|
|
957
962
|
* visible and logical separation of the contents in a menu.
|
|
958
963
|
*/
|
|
959
|
-
SEPARATOR,
|
|
964
|
+
SEPARATOR = 50,
|
|
960
965
|
/**
|
|
961
966
|
* An object that allows the user to select from a bounded
|
|
962
967
|
* range. Unlike `ATSPI_ROLE_SCROLL_BAR`, `ATSPI_ROLE_SLIDER` objects need not control
|
|
963
968
|
* 'viewport'-like objects.
|
|
964
969
|
*/
|
|
965
|
-
SLIDER,
|
|
970
|
+
SLIDER = 51,
|
|
966
971
|
/**
|
|
967
972
|
* An object which allows one of a set of choices to
|
|
968
973
|
* be selected, and which displays the current choice.
|
|
969
974
|
*/
|
|
970
|
-
SPIN_BUTTON,
|
|
975
|
+
SPIN_BUTTON = 52,
|
|
971
976
|
/**
|
|
972
977
|
* A specialized panel that presents two other panels
|
|
973
978
|
* at the same time.
|
|
974
979
|
*/
|
|
975
|
-
SPLIT_PANE,
|
|
980
|
+
SPLIT_PANE = 53,
|
|
976
981
|
/**
|
|
977
982
|
* Object displays non-quantitative status information
|
|
978
983
|
* (c.f. `ATSPI_ROLE_PROGRESS_BAR`)
|
|
979
984
|
*/
|
|
980
|
-
STATUS_BAR,
|
|
985
|
+
STATUS_BAR = 54,
|
|
981
986
|
/**
|
|
982
987
|
* An object used to repesent information in terms of rows
|
|
983
988
|
* and columns.
|
|
984
989
|
*/
|
|
985
|
-
TABLE,
|
|
990
|
+
TABLE = 55,
|
|
986
991
|
/**
|
|
987
992
|
* A 'cell' or discrete child within a Table. Note:
|
|
988
993
|
* Table cells need not have `ATSPI_ROLE_TABLE_CELL`, other
|
|
989
994
|
* `AtspiRoleType` values are valid as well.
|
|
990
995
|
*/
|
|
991
|
-
TABLE_CELL,
|
|
996
|
+
TABLE_CELL = 56,
|
|
992
997
|
/**
|
|
993
998
|
* An object which labels a particular column
|
|
994
999
|
* in an {@link Atspi.Table}.
|
|
995
1000
|
*/
|
|
996
|
-
TABLE_COLUMN_HEADER,
|
|
1001
|
+
TABLE_COLUMN_HEADER = 57,
|
|
997
1002
|
/**
|
|
998
1003
|
* An object which labels a particular row in a
|
|
999
1004
|
* {@link Atspi.Table}. {@link Atspi.Table} rows and columns may also be labelled via the
|
|
1000
1005
|
* `ATSPI_RELATION_LABEL_FOR`/`ATSPI_RELATION_LABELLED_BY` relationships.
|
|
1001
1006
|
* See `atspi_get_relation_set`.
|
|
1002
1007
|
*/
|
|
1003
|
-
TABLE_ROW_HEADER,
|
|
1008
|
+
TABLE_ROW_HEADER = 58,
|
|
1004
1009
|
/**
|
|
1005
1010
|
* Object allows menu to be removed from menubar
|
|
1006
1011
|
* and shown in its own window.
|
|
1007
1012
|
*/
|
|
1008
|
-
TEAROFF_MENU_ITEM,
|
|
1013
|
+
TEAROFF_MENU_ITEM = 59,
|
|
1009
1014
|
/**
|
|
1010
1015
|
* An object that emulates a terminal.
|
|
1011
1016
|
*/
|
|
1012
|
-
TERMINAL,
|
|
1017
|
+
TERMINAL = 60,
|
|
1013
1018
|
/**
|
|
1014
1019
|
* An interactive widget that supports multiple lines of text
|
|
1015
1020
|
* and optionally accepts user input, but whose purpose is not to solicit user
|
|
@@ -1019,89 +1024,89 @@ export namespace Atspi {
|
|
|
1019
1024
|
* and `ATSPI_ROLE_PASSWORD_TEXT`. For generic objects which display a brief amount
|
|
1020
1025
|
* of textual information, see `ATSPI_ROLE_STATIC`.
|
|
1021
1026
|
*/
|
|
1022
|
-
TEXT,
|
|
1027
|
+
TEXT = 61,
|
|
1023
1028
|
/**
|
|
1024
1029
|
* A specialized push button that can be checked or
|
|
1025
1030
|
* unchecked, but does not procide a separate indicator for the current
|
|
1026
1031
|
* state.
|
|
1027
1032
|
*/
|
|
1028
|
-
TOGGLE_BUTTON,
|
|
1033
|
+
TOGGLE_BUTTON = 62,
|
|
1029
1034
|
/**
|
|
1030
1035
|
* A bar or palette usually composed of push buttons or
|
|
1031
1036
|
* toggle buttons.
|
|
1032
1037
|
*/
|
|
1033
|
-
TOOL_BAR,
|
|
1038
|
+
TOOL_BAR = 63,
|
|
1034
1039
|
/**
|
|
1035
1040
|
* An object that provides information about another
|
|
1036
1041
|
* object.
|
|
1037
1042
|
*/
|
|
1038
|
-
TOOL_TIP,
|
|
1043
|
+
TOOL_TIP = 64,
|
|
1039
1044
|
/**
|
|
1040
1045
|
* An object used to repsent hierarchical information to the
|
|
1041
1046
|
* user.
|
|
1042
1047
|
*/
|
|
1043
|
-
TREE,
|
|
1048
|
+
TREE = 65,
|
|
1044
1049
|
/**
|
|
1045
1050
|
* An object that presents both tabular and
|
|
1046
1051
|
* hierarchical info to the user.
|
|
1047
1052
|
*/
|
|
1048
|
-
TREE_TABLE,
|
|
1053
|
+
TREE_TABLE = 66,
|
|
1049
1054
|
/**
|
|
1050
1055
|
* The object contains some {@link Atspi.Accessible} information,
|
|
1051
1056
|
* but its role is not known.
|
|
1052
1057
|
*/
|
|
1053
|
-
UNKNOWN,
|
|
1058
|
+
UNKNOWN = 67,
|
|
1054
1059
|
/**
|
|
1055
1060
|
* An object usually used in a scroll pane, or to
|
|
1056
1061
|
* otherwise clip a larger object or content renderer to a specific
|
|
1057
1062
|
* onscreen viewport.
|
|
1058
1063
|
*/
|
|
1059
|
-
VIEWPORT,
|
|
1064
|
+
VIEWPORT = 68,
|
|
1060
1065
|
/**
|
|
1061
1066
|
* A top level window with no title or border.
|
|
1062
1067
|
*/
|
|
1063
|
-
WINDOW,
|
|
1068
|
+
WINDOW = 69,
|
|
1064
1069
|
/**
|
|
1065
1070
|
* means that the role for this item is known, but not
|
|
1066
1071
|
* included in the core enumeration. Deprecated since 2.24.
|
|
1067
1072
|
*/
|
|
1068
|
-
EXTENDED,
|
|
1073
|
+
EXTENDED = 70,
|
|
1069
1074
|
/**
|
|
1070
1075
|
* An object that serves as a document header.
|
|
1071
1076
|
*/
|
|
1072
|
-
HEADER,
|
|
1077
|
+
HEADER = 71,
|
|
1073
1078
|
/**
|
|
1074
1079
|
* An object that serves as a document footer.
|
|
1075
1080
|
*/
|
|
1076
|
-
FOOTER,
|
|
1081
|
+
FOOTER = 72,
|
|
1077
1082
|
/**
|
|
1078
1083
|
* An object which is contains a single paragraph of
|
|
1079
1084
|
* text content. See also `ATSPI_ROLE_TEXT`.
|
|
1080
1085
|
*/
|
|
1081
|
-
PARAGRAPH,
|
|
1086
|
+
PARAGRAPH = 73,
|
|
1082
1087
|
/**
|
|
1083
1088
|
* An object which describes margins and tab stops, etc.
|
|
1084
1089
|
* for text objects which it controls (should have
|
|
1085
1090
|
* `ATSPI_RELATION_CONTROLLER_FOR` relation to such).
|
|
1086
1091
|
*/
|
|
1087
|
-
RULER,
|
|
1092
|
+
RULER = 74,
|
|
1088
1093
|
/**
|
|
1089
1094
|
* An object corresponding to the toplevel accessible
|
|
1090
1095
|
* of an application, which may contain `ATSPI_ROLE_FRAME` objects or other
|
|
1091
1096
|
* accessible objects. Children of objects with the #ATSPI_ROLE_DESKTOP_FRAME role are generally
|
|
1092
1097
|
* `ATSPI_ROLE_APPLICATION` objects.
|
|
1093
1098
|
*/
|
|
1094
|
-
APPLICATION,
|
|
1099
|
+
APPLICATION = 75,
|
|
1095
1100
|
/**
|
|
1096
1101
|
* The object is a dialog or list containing items
|
|
1097
1102
|
* for insertion into an entry widget, for instance a list of words for
|
|
1098
1103
|
* completion of a text entry.
|
|
1099
1104
|
*/
|
|
1100
|
-
AUTOCOMPLETE,
|
|
1105
|
+
AUTOCOMPLETE = 76,
|
|
1101
1106
|
/**
|
|
1102
1107
|
* The object is an editable text object in a toolbar.
|
|
1103
1108
|
*/
|
|
1104
|
-
EDITBAR,
|
|
1109
|
+
EDITBAR = 77,
|
|
1105
1110
|
/**
|
|
1106
1111
|
* The object is an embedded component container. This
|
|
1107
1112
|
* role is a "grouping" hint that the contained objects share a context
|
|
@@ -1109,7 +1114,7 @@ export namespace Atspi {
|
|
|
1109
1114
|
* embedded. In particular, it is used for some kinds of document embedding,
|
|
1110
1115
|
* and for embedding of out-of-process component, "panel applets", etc.
|
|
1111
1116
|
*/
|
|
1112
|
-
EMBEDDED,
|
|
1117
|
+
EMBEDDED = 78,
|
|
1113
1118
|
/**
|
|
1114
1119
|
* The object is a component whose textual content may be
|
|
1115
1120
|
* entered or modified by the user, provided `ATSPI_STATE_EDITABLE` is present.
|
|
@@ -1117,7 +1122,7 @@ export namespace Atspi {
|
|
|
1117
1122
|
* not present) implies a read-only 'text field' in a form, as opposed to a
|
|
1118
1123
|
* title, label, or caption.
|
|
1119
1124
|
*/
|
|
1120
|
-
ENTRY,
|
|
1125
|
+
ENTRY = 79,
|
|
1121
1126
|
/**
|
|
1122
1127
|
* The object is a graphical depiction of quantitative data.
|
|
1123
1128
|
* It may contain multiple subelements whose attributes and/or description
|
|
@@ -1126,13 +1131,13 @@ export namespace Atspi {
|
|
|
1126
1131
|
* particularly important in interpreting objects of this type, as is the
|
|
1127
1132
|
* accessible description property. See `ATSPI_ROLE_CAPTION`.
|
|
1128
1133
|
*/
|
|
1129
|
-
CHART,
|
|
1134
|
+
CHART = 80,
|
|
1130
1135
|
/**
|
|
1131
1136
|
* The object contains descriptive information, usually
|
|
1132
1137
|
* textual, about another user interface element such as a table, chart, or
|
|
1133
1138
|
* image.
|
|
1134
1139
|
*/
|
|
1135
|
-
CAPTION,
|
|
1140
|
+
CAPTION = 81,
|
|
1136
1141
|
/**
|
|
1137
1142
|
* The object is a visual frame or container which
|
|
1138
1143
|
* contains a view of document content. {@link Atspi.Document} frames may occur within
|
|
@@ -1141,19 +1146,19 @@ export namespace Atspi {
|
|
|
1141
1146
|
* ATSPI_ROLE_DOCUMENT_FRAME: Either this object, or a singleton descendant,
|
|
1142
1147
|
* should implement the {@link Atspi.Document} interface.
|
|
1143
1148
|
*/
|
|
1144
|
-
DOCUMENT_FRAME,
|
|
1149
|
+
DOCUMENT_FRAME = 82,
|
|
1145
1150
|
/**
|
|
1146
1151
|
* The object serves as a heading for content which
|
|
1147
1152
|
* follows it in a document. The 'heading level' of the heading, if
|
|
1148
1153
|
* available, may be obtained by querying the object's attributes.
|
|
1149
1154
|
*/
|
|
1150
|
-
HEADING,
|
|
1155
|
+
HEADING = 83,
|
|
1151
1156
|
/**
|
|
1152
1157
|
* The object is a containing instance which encapsulates a
|
|
1153
1158
|
* page of information. `ATSPI_ROLE_PAGE` is used in documents and content which
|
|
1154
1159
|
* support a paginated navigation model.
|
|
1155
1160
|
*/
|
|
1156
|
-
PAGE,
|
|
1161
|
+
PAGE = 84,
|
|
1157
1162
|
/**
|
|
1158
1163
|
* The object is a containing instance of document content
|
|
1159
1164
|
* which constitutes a particular 'logical' section of the document. The
|
|
@@ -1161,13 +1166,13 @@ export namespace Atspi {
|
|
|
1161
1166
|
* itself, may be obtained by querying the object's attributes. Sections
|
|
1162
1167
|
* may be nested.
|
|
1163
1168
|
*/
|
|
1164
|
-
SECTION,
|
|
1169
|
+
SECTION = 85,
|
|
1165
1170
|
/**
|
|
1166
1171
|
* The object is redundant with another object in
|
|
1167
1172
|
* the hierarchy, and is exposed for purely technical reasons. Objects of
|
|
1168
1173
|
* this role should be ignored by clients, if they are encountered at all.
|
|
1169
1174
|
*/
|
|
1170
|
-
REDUNDANT_OBJECT,
|
|
1175
|
+
REDUNDANT_OBJECT = 86,
|
|
1171
1176
|
/**
|
|
1172
1177
|
* The object is a containing instance of document content
|
|
1173
1178
|
* which has within it components with which the user can interact in order
|
|
@@ -1181,7 +1186,7 @@ export namespace Atspi {
|
|
|
1181
1186
|
* associated with the current document, rather than the current foreground
|
|
1182
1187
|
* application or viewer instance.
|
|
1183
1188
|
*/
|
|
1184
|
-
FORM,
|
|
1189
|
+
FORM = 87,
|
|
1185
1190
|
/**
|
|
1186
1191
|
* The object is a hypertext anchor, i.e. a "link" in a
|
|
1187
1192
|
* hypertext document. Such objects are distinct from 'inline' content
|
|
@@ -1189,148 +1194,161 @@ export namespace Atspi {
|
|
|
1189
1194
|
* the range/location within a text object where an inline or embedded object
|
|
1190
1195
|
* lies.
|
|
1191
1196
|
*/
|
|
1192
|
-
LINK,
|
|
1197
|
+
LINK = 88,
|
|
1193
1198
|
/**
|
|
1194
1199
|
* The object is a window or similar viewport
|
|
1195
1200
|
* which is used to allow composition or input of a 'complex character',
|
|
1196
1201
|
* in other words it is an "input method window".
|
|
1197
1202
|
*/
|
|
1198
|
-
INPUT_METHOD_WINDOW,
|
|
1203
|
+
INPUT_METHOD_WINDOW = 89,
|
|
1199
1204
|
/**
|
|
1200
1205
|
* A row in a table.
|
|
1201
1206
|
*/
|
|
1202
|
-
TABLE_ROW,
|
|
1207
|
+
TABLE_ROW = 90,
|
|
1203
1208
|
/**
|
|
1204
1209
|
* An object that represents an element of a tree.
|
|
1205
1210
|
*/
|
|
1206
|
-
TREE_ITEM,
|
|
1211
|
+
TREE_ITEM = 91,
|
|
1207
1212
|
/**
|
|
1208
1213
|
* A document frame which contains a
|
|
1209
1214
|
* spreadsheet.
|
|
1210
1215
|
*/
|
|
1211
|
-
DOCUMENT_SPREADSHEET,
|
|
1216
|
+
DOCUMENT_SPREADSHEET = 92,
|
|
1212
1217
|
/**
|
|
1213
1218
|
* A document frame which contains a
|
|
1214
1219
|
* presentation or slide content.
|
|
1215
1220
|
*/
|
|
1216
|
-
DOCUMENT_PRESENTATION,
|
|
1221
|
+
DOCUMENT_PRESENTATION = 93,
|
|
1217
1222
|
/**
|
|
1218
1223
|
* A document frame which contains textual content,
|
|
1219
1224
|
* such as found in a word processing
|
|
1220
1225
|
* application.
|
|
1221
1226
|
*/
|
|
1222
|
-
DOCUMENT_TEXT,
|
|
1227
|
+
DOCUMENT_TEXT = 94,
|
|
1223
1228
|
/**
|
|
1224
1229
|
* A document frame which contains HTML or other
|
|
1225
1230
|
* markup suitable for display in a web browser.
|
|
1226
1231
|
*/
|
|
1227
|
-
DOCUMENT_WEB,
|
|
1232
|
+
DOCUMENT_WEB = 95,
|
|
1228
1233
|
/**
|
|
1229
1234
|
* A document frame which contains email content
|
|
1230
1235
|
* to be displayed or composed either in plain text or
|
|
1231
1236
|
* HTML.
|
|
1232
1237
|
*/
|
|
1233
|
-
DOCUMENT_EMAIL,
|
|
1238
|
+
DOCUMENT_EMAIL = 96,
|
|
1234
1239
|
/**
|
|
1235
1240
|
* An object found within a document and designed to
|
|
1236
1241
|
* present a comment, note, or other annotation. In some cases, this object
|
|
1237
1242
|
* might not be visible until activated.
|
|
1238
1243
|
*/
|
|
1239
|
-
COMMENT,
|
|
1244
|
+
COMMENT = 97,
|
|
1240
1245
|
/**
|
|
1241
1246
|
* A non-collapsible list of choices the user can
|
|
1242
1247
|
* select from.
|
|
1243
1248
|
*/
|
|
1244
|
-
LIST_BOX,
|
|
1249
|
+
LIST_BOX = 98,
|
|
1245
1250
|
/**
|
|
1246
1251
|
* A group of related widgets. This group typically has
|
|
1247
1252
|
* a label.
|
|
1248
1253
|
*/
|
|
1249
|
-
GROUPING,
|
|
1254
|
+
GROUPING = 99,
|
|
1250
1255
|
/**
|
|
1251
1256
|
* An image map object. Usually a graphic with multiple
|
|
1252
1257
|
* hotspots, where each hotspot can be activated resulting in the loading of
|
|
1253
1258
|
* another document or section of a document.
|
|
1254
1259
|
*/
|
|
1255
|
-
IMAGE_MAP,
|
|
1260
|
+
IMAGE_MAP = 100,
|
|
1256
1261
|
/**
|
|
1257
1262
|
* A transitory object designed to present a
|
|
1258
1263
|
* message to the user, typically at the desktop level rather than inside a
|
|
1259
1264
|
* particular application.
|
|
1260
1265
|
*/
|
|
1261
|
-
NOTIFICATION,
|
|
1266
|
+
NOTIFICATION = 101,
|
|
1262
1267
|
/**
|
|
1263
1268
|
* An object designed to present a message to the user
|
|
1264
1269
|
* within an existing window.
|
|
1265
1270
|
*/
|
|
1266
|
-
INFO_BAR,
|
|
1271
|
+
INFO_BAR = 102,
|
|
1267
1272
|
/**
|
|
1268
1273
|
* A bar that serves as a level indicator to, for instance, show the strength
|
|
1269
1274
|
* of a password or the state of a battery.
|
|
1275
|
+
* @since 2.8
|
|
1270
1276
|
*/
|
|
1271
|
-
LEVEL_BAR,
|
|
1277
|
+
LEVEL_BAR = 103,
|
|
1272
1278
|
/**
|
|
1273
1279
|
* A bar that serves as the title of a window or a dialog.
|
|
1280
|
+
* @since 2.12
|
|
1274
1281
|
*/
|
|
1275
|
-
TITLE_BAR,
|
|
1282
|
+
TITLE_BAR = 104,
|
|
1276
1283
|
/**
|
|
1277
1284
|
* An object which contains a text section that is quoted from another source.
|
|
1285
|
+
* @since 2.12
|
|
1278
1286
|
*/
|
|
1279
|
-
BLOCK_QUOTE,
|
|
1287
|
+
BLOCK_QUOTE = 105,
|
|
1280
1288
|
/**
|
|
1281
1289
|
* An object which represents an audio element.
|
|
1290
|
+
* @since 2.12
|
|
1282
1291
|
*/
|
|
1283
|
-
AUDIO,
|
|
1292
|
+
AUDIO = 106,
|
|
1284
1293
|
/**
|
|
1285
1294
|
* An object which represents a video element.
|
|
1295
|
+
* @since 2.12
|
|
1286
1296
|
*/
|
|
1287
|
-
VIDEO,
|
|
1297
|
+
VIDEO = 107,
|
|
1288
1298
|
/**
|
|
1289
1299
|
* A definition of a term or concept.
|
|
1300
|
+
* @since 2.12
|
|
1290
1301
|
*/
|
|
1291
|
-
DEFINITION,
|
|
1302
|
+
DEFINITION = 108,
|
|
1292
1303
|
/**
|
|
1293
1304
|
* A section of a page that consists of a composition that forms an
|
|
1294
1305
|
* independent part of a document, page, or site. Examples: A blog entry, a
|
|
1295
1306
|
* news story, a forum post.
|
|
1307
|
+
* @since 2.12
|
|
1296
1308
|
*/
|
|
1297
|
-
ARTICLE,
|
|
1309
|
+
ARTICLE = 109,
|
|
1298
1310
|
/**
|
|
1299
1311
|
* A region of a web page intended as a navigational landmark. This is
|
|
1300
1312
|
* designed to allow Assistive Technologies to provide quick navigation among
|
|
1301
1313
|
* key regions within a document.
|
|
1314
|
+
* @since 2.12
|
|
1302
1315
|
*/
|
|
1303
|
-
LANDMARK,
|
|
1316
|
+
LANDMARK = 110,
|
|
1304
1317
|
/**
|
|
1305
1318
|
* A text widget or container holding log content, such as chat history and
|
|
1306
1319
|
* error logs. In this role there is a relationship between the arrival of new
|
|
1307
1320
|
* items in the log and the reading order. The log contains a meaningful
|
|
1308
1321
|
* sequence and new information is added only to the end of the log, not at
|
|
1309
1322
|
* arbitrary points.
|
|
1323
|
+
* @since 2.12
|
|
1310
1324
|
*/
|
|
1311
|
-
LOG,
|
|
1325
|
+
LOG = 111,
|
|
1312
1326
|
/**
|
|
1313
1327
|
* A container where non-essential information changes frequently. Common
|
|
1314
1328
|
* usages of marquee include stock tickers and ad banners. The primary
|
|
1315
1329
|
* difference between a marquee and a log is that logs usually have a
|
|
1316
1330
|
* meaningful order or sequence of important content changes.
|
|
1331
|
+
* @since 2.12
|
|
1317
1332
|
*/
|
|
1318
|
-
MARQUEE,
|
|
1333
|
+
MARQUEE = 112,
|
|
1319
1334
|
/**
|
|
1320
1335
|
* A text widget or container that holds a mathematical expression.
|
|
1336
|
+
* @since 2.12
|
|
1321
1337
|
*/
|
|
1322
|
-
MATH,
|
|
1338
|
+
MATH = 113,
|
|
1323
1339
|
/**
|
|
1324
1340
|
* A widget whose purpose is to display a rating, such as the number of stars
|
|
1325
1341
|
* associated with a song in a media player. Objects of this role should also
|
|
1326
1342
|
* implement AtspiValue.
|
|
1343
|
+
* @since 2.12
|
|
1327
1344
|
*/
|
|
1328
|
-
RATING,
|
|
1345
|
+
RATING = 114,
|
|
1329
1346
|
/**
|
|
1330
1347
|
* An object containing a numerical counter which indicates an amount of
|
|
1331
1348
|
* elapsed time from a start point, or the time remaining until an end point.
|
|
1349
|
+
* @since 2.12
|
|
1332
1350
|
*/
|
|
1333
|
-
TIMER,
|
|
1351
|
+
TIMER = 115,
|
|
1334
1352
|
/**
|
|
1335
1353
|
* A generic non-container object whose purpose is to display
|
|
1336
1354
|
* a brief amount of information to the user and whose role is known by the
|
|
@@ -1343,54 +1361,64 @@ export namespace Atspi {
|
|
|
1343
1361
|
* displayed information, as a general rule, should be exposed through the
|
|
1344
1362
|
* accessible name of the object. For labels which describe another widget, see
|
|
1345
1363
|
*/
|
|
1346
|
-
STATIC,
|
|
1364
|
+
STATIC = 116,
|
|
1347
1365
|
/**
|
|
1348
1366
|
* An object that represents a mathematical fraction.
|
|
1367
|
+
* @since 2.16
|
|
1349
1368
|
*/
|
|
1350
|
-
MATH_FRACTION,
|
|
1369
|
+
MATH_FRACTION = 117,
|
|
1351
1370
|
/**
|
|
1352
1371
|
* An object that represents a mathematical expression displayed with a
|
|
1353
1372
|
* radical.
|
|
1373
|
+
* @since 2.16
|
|
1354
1374
|
*/
|
|
1355
|
-
MATH_ROOT,
|
|
1375
|
+
MATH_ROOT = 118,
|
|
1356
1376
|
/**
|
|
1357
1377
|
* An object that contains text that is displayed as a subscript.
|
|
1378
|
+
* @since 2.16
|
|
1358
1379
|
*/
|
|
1359
|
-
SUBSCRIPT,
|
|
1380
|
+
SUBSCRIPT = 119,
|
|
1360
1381
|
/**
|
|
1361
1382
|
* An object that contains text that is displayed as a superscript.
|
|
1383
|
+
* @since 2.16
|
|
1362
1384
|
*/
|
|
1363
|
-
SUPERSCRIPT,
|
|
1385
|
+
SUPERSCRIPT = 120,
|
|
1364
1386
|
/**
|
|
1365
1387
|
* An object that represents a list of term-value groups. A term-value group
|
|
1366
1388
|
* represents an individual description and consist of one or more names
|
|
1367
1389
|
* (`ATSPI_ROLE_DESCRIPTION_TERM`) followed by one or more values
|
|
1368
1390
|
* (`ATSPI_ROLE_DESCRIPTION_VALUE`). For each list, there should not be more
|
|
1369
1391
|
* than one group with the same term name.
|
|
1392
|
+
* @since 2.26
|
|
1370
1393
|
*/
|
|
1371
|
-
DESCRIPTION_LIST,
|
|
1394
|
+
DESCRIPTION_LIST = 121,
|
|
1372
1395
|
/**
|
|
1373
1396
|
* An object that represents a term or phrase with a corresponding definition.
|
|
1397
|
+
* @since 2.26
|
|
1374
1398
|
*/
|
|
1375
|
-
DESCRIPTION_TERM,
|
|
1399
|
+
DESCRIPTION_TERM = 122,
|
|
1376
1400
|
/**
|
|
1377
1401
|
* An object that represents the description, definition, or value of a term.
|
|
1402
|
+
* @since 2.26
|
|
1378
1403
|
*/
|
|
1379
|
-
DESCRIPTION_VALUE,
|
|
1404
|
+
DESCRIPTION_VALUE = 123,
|
|
1380
1405
|
/**
|
|
1381
1406
|
* An object that contains the text of a footnote.
|
|
1407
|
+
* @since 2.26
|
|
1382
1408
|
*/
|
|
1383
|
-
FOOTNOTE,
|
|
1409
|
+
FOOTNOTE = 124,
|
|
1384
1410
|
/**
|
|
1385
1411
|
* Content previously deleted or proposed to be deleted, e.g. in revision
|
|
1386
1412
|
* history or a content view providing suggestions from reviewers.
|
|
1413
|
+
* @since 2.34
|
|
1387
1414
|
*/
|
|
1388
|
-
CONTENT_DELETION,
|
|
1415
|
+
CONTENT_DELETION = 125,
|
|
1389
1416
|
/**
|
|
1390
1417
|
* Content previously inserted or proposed to be inserted, e.g. in revision
|
|
1391
1418
|
* history or a content view providing suggestions from reviewers.
|
|
1419
|
+
* @since 2.34
|
|
1392
1420
|
*/
|
|
1393
|
-
CONTENT_INSERTION,
|
|
1421
|
+
CONTENT_INSERTION = 126,
|
|
1394
1422
|
/**
|
|
1395
1423
|
* A run of content that is marked or highlighted, such as for reference
|
|
1396
1424
|
* purposes, or to call it out as having a special purpose. If the marked
|
|
@@ -1399,30 +1427,34 @@ export namespace Atspi {
|
|
|
1399
1427
|
* point to that associated section. In addition, the reciprocal relation
|
|
1400
1428
|
* {@link Atspi.RelationType.DETAILS_FOR} should be used on the associated content section
|
|
1401
1429
|
* to point back to the mark.
|
|
1430
|
+
* @since 2.36
|
|
1402
1431
|
*/
|
|
1403
|
-
MARK,
|
|
1432
|
+
MARK = 127,
|
|
1404
1433
|
/**
|
|
1405
1434
|
* A container for content that is called out as a proposed change from the
|
|
1406
1435
|
* current version of the document, such as by a reviewer of the content. An
|
|
1407
1436
|
* object with this role should include children with
|
|
1408
1437
|
* {@link Atspi.Role.CONTENT_DELETION} and/or {@link Atspi.Role.CONTENT_INSERTION}, in any
|
|
1409
1438
|
* order, to indicate what the actual change is.
|
|
1439
|
+
* @since 2.36
|
|
1410
1440
|
*/
|
|
1411
|
-
SUGGESTION,
|
|
1441
|
+
SUGGESTION = 128,
|
|
1412
1442
|
/**
|
|
1413
1443
|
* A specialized push button to open a menu.
|
|
1444
|
+
* @since 2.46
|
|
1414
1445
|
*/
|
|
1415
|
-
PUSH_BUTTON_MENU,
|
|
1446
|
+
PUSH_BUTTON_MENU = 129,
|
|
1416
1447
|
/**
|
|
1417
1448
|
* A switch that can be toggled on/off.
|
|
1449
|
+
* @since 2.56
|
|
1418
1450
|
*/
|
|
1419
|
-
SWITCH,
|
|
1451
|
+
SWITCH = 130,
|
|
1420
1452
|
/**
|
|
1421
1453
|
* Not a valid role, used for finding end of
|
|
1422
1454
|
* enumeration.
|
|
1423
1455
|
*/
|
|
1424
|
-
LAST_DEFINED,
|
|
1425
|
-
PUSH_BUTTON,
|
|
1456
|
+
LAST_DEFINED = 131,
|
|
1457
|
+
PUSH_BUTTON = 43,
|
|
1426
1458
|
}
|
|
1427
1459
|
|
|
1428
1460
|
|
|
@@ -1443,37 +1475,37 @@ export namespace Atspi {
|
|
|
1443
1475
|
* Scroll the object to the top left corner of the
|
|
1444
1476
|
* window.
|
|
1445
1477
|
*/
|
|
1446
|
-
TOP_LEFT,
|
|
1478
|
+
TOP_LEFT = 0,
|
|
1447
1479
|
/**
|
|
1448
1480
|
* Scroll the object to the bottom right corner of
|
|
1449
1481
|
* the window.
|
|
1450
1482
|
*/
|
|
1451
|
-
BOTTOM_RIGHT,
|
|
1483
|
+
BOTTOM_RIGHT = 1,
|
|
1452
1484
|
/**
|
|
1453
1485
|
* Scroll the object to the top edge of the window.
|
|
1454
1486
|
*/
|
|
1455
|
-
TOP_EDGE,
|
|
1487
|
+
TOP_EDGE = 2,
|
|
1456
1488
|
/**
|
|
1457
1489
|
* Scroll the object to the bottom edge of the
|
|
1458
1490
|
* window.
|
|
1459
1491
|
*/
|
|
1460
|
-
BOTTOM_EDGE,
|
|
1492
|
+
BOTTOM_EDGE = 3,
|
|
1461
1493
|
/**
|
|
1462
1494
|
* Scroll the object to the left edge of the
|
|
1463
1495
|
* window.
|
|
1464
1496
|
*/
|
|
1465
|
-
LEFT_EDGE,
|
|
1497
|
+
LEFT_EDGE = 4,
|
|
1466
1498
|
/**
|
|
1467
1499
|
* Scroll the object to the right edge of the
|
|
1468
1500
|
* window.
|
|
1469
1501
|
*/
|
|
1470
|
-
RIGHT_EDGE,
|
|
1502
|
+
RIGHT_EDGE = 5,
|
|
1471
1503
|
/**
|
|
1472
1504
|
* Scroll the object to application-dependent position
|
|
1473
1505
|
* on the window.
|
|
1474
1506
|
*/
|
|
1475
|
-
ANYWHERE,
|
|
1476
|
-
LAST_DEFINED,
|
|
1507
|
+
ANYWHERE = 6,
|
|
1508
|
+
LAST_DEFINED = 7,
|
|
1477
1509
|
}
|
|
1478
1510
|
|
|
1479
1511
|
|
|
@@ -1494,7 +1526,7 @@ export namespace Atspi {
|
|
|
1494
1526
|
* Indicates an invalid state - probably an error
|
|
1495
1527
|
* condition.
|
|
1496
1528
|
*/
|
|
1497
|
-
INVALID,
|
|
1529
|
+
INVALID = 0,
|
|
1498
1530
|
/**
|
|
1499
1531
|
* Indicates a window is currently the active window, or
|
|
1500
1532
|
* an object is the active subelement within a container or table.
|
|
@@ -1505,35 +1537,35 @@ export namespace Atspi {
|
|
|
1505
1537
|
* focusable and not selectable is the currently-active item within its
|
|
1506
1538
|
* parent container.
|
|
1507
1539
|
*/
|
|
1508
|
-
ACTIVE,
|
|
1540
|
+
ACTIVE = 1,
|
|
1509
1541
|
/**
|
|
1510
1542
|
* Indicates that the object is armed.
|
|
1511
1543
|
*/
|
|
1512
|
-
ARMED,
|
|
1544
|
+
ARMED = 2,
|
|
1513
1545
|
/**
|
|
1514
1546
|
* Indicates the current object is busy, i.e. onscreen
|
|
1515
1547
|
* representation is in the process of changing, or the object is
|
|
1516
1548
|
* temporarily unavailable for interaction due to activity already in progress.
|
|
1517
1549
|
*/
|
|
1518
|
-
BUSY,
|
|
1550
|
+
BUSY = 3,
|
|
1519
1551
|
/**
|
|
1520
1552
|
* Indicates this object is currently checked.
|
|
1521
1553
|
*/
|
|
1522
|
-
CHECKED,
|
|
1554
|
+
CHECKED = 4,
|
|
1523
1555
|
/**
|
|
1524
1556
|
* Indicates this object is collapsed.
|
|
1525
1557
|
*/
|
|
1526
|
-
COLLAPSED,
|
|
1558
|
+
COLLAPSED = 5,
|
|
1527
1559
|
/**
|
|
1528
1560
|
* Indicates that this object no longer has a valid
|
|
1529
1561
|
* backing widget (for instance, if its peer object has been destroyed).
|
|
1530
1562
|
*/
|
|
1531
|
-
DEFUNCT,
|
|
1563
|
+
DEFUNCT = 6,
|
|
1532
1564
|
/**
|
|
1533
1565
|
* Indicates the user can change the contents of this
|
|
1534
1566
|
* object.
|
|
1535
1567
|
*/
|
|
1536
|
-
EDITABLE,
|
|
1568
|
+
EDITABLE = 7,
|
|
1537
1569
|
/**
|
|
1538
1570
|
* Indicates that this object is enabled, i.e. that it
|
|
1539
1571
|
* currently reflects some application state. Objects that are "greyed out"
|
|
@@ -1541,85 +1573,85 @@ export namespace Atspi {
|
|
|
1541
1573
|
* user interaction cannot cause them to acquire `ATSPI_STATE_ENABLED`.
|
|
1542
1574
|
* See `ATSPI_STATE_SENSITIVE`.
|
|
1543
1575
|
*/
|
|
1544
|
-
ENABLED,
|
|
1576
|
+
ENABLED = 8,
|
|
1545
1577
|
/**
|
|
1546
1578
|
* Indicates this object allows progressive
|
|
1547
1579
|
* disclosure of its children.
|
|
1548
1580
|
*/
|
|
1549
|
-
EXPANDABLE,
|
|
1581
|
+
EXPANDABLE = 9,
|
|
1550
1582
|
/**
|
|
1551
1583
|
* Indicates this object is expanded.
|
|
1552
1584
|
*/
|
|
1553
|
-
EXPANDED,
|
|
1585
|
+
EXPANDED = 10,
|
|
1554
1586
|
/**
|
|
1555
1587
|
* Indicates this object can accept keyboard focus,
|
|
1556
1588
|
* which means all events resulting from typing on the keyboard will
|
|
1557
1589
|
* normally be passed to it when it has focus.
|
|
1558
1590
|
*/
|
|
1559
|
-
FOCUSABLE,
|
|
1591
|
+
FOCUSABLE = 11,
|
|
1560
1592
|
/**
|
|
1561
1593
|
* Indicates this object currently has the keyboard
|
|
1562
1594
|
* focus.
|
|
1563
1595
|
*/
|
|
1564
|
-
FOCUSED,
|
|
1596
|
+
FOCUSED = 12,
|
|
1565
1597
|
/**
|
|
1566
1598
|
* Indicates that the object has an associated
|
|
1567
1599
|
* tooltip.
|
|
1568
1600
|
*/
|
|
1569
|
-
HAS_TOOLTIP,
|
|
1601
|
+
HAS_TOOLTIP = 13,
|
|
1570
1602
|
/**
|
|
1571
1603
|
* Indicates the orientation of this object is
|
|
1572
1604
|
* horizontal.
|
|
1573
1605
|
*/
|
|
1574
|
-
HORIZONTAL,
|
|
1606
|
+
HORIZONTAL = 14,
|
|
1575
1607
|
/**
|
|
1576
1608
|
* Indicates this object is minimized and is
|
|
1577
1609
|
* represented only by an icon.
|
|
1578
1610
|
*/
|
|
1579
|
-
ICONIFIED,
|
|
1611
|
+
ICONIFIED = 15,
|
|
1580
1612
|
/**
|
|
1581
1613
|
* Indicates something must be done with this object
|
|
1582
1614
|
* before the user can interact with an object in a different window.
|
|
1583
1615
|
*/
|
|
1584
|
-
MODAL,
|
|
1616
|
+
MODAL = 16,
|
|
1585
1617
|
/**
|
|
1586
1618
|
* Indicates this (text) object can contain multiple
|
|
1587
1619
|
* lines of text.
|
|
1588
1620
|
*/
|
|
1589
|
-
MULTI_LINE,
|
|
1621
|
+
MULTI_LINE = 17,
|
|
1590
1622
|
/**
|
|
1591
1623
|
* Indicates this object allows more than one of
|
|
1592
1624
|
* its children to be selected at the same time, or in the case of text
|
|
1593
1625
|
* objects, that the object supports non-contiguous text selections.
|
|
1594
1626
|
*/
|
|
1595
|
-
MULTISELECTABLE,
|
|
1627
|
+
MULTISELECTABLE = 18,
|
|
1596
1628
|
/**
|
|
1597
1629
|
* Indicates this object paints every pixel within its
|
|
1598
1630
|
* rectangular region. It also indicates an alpha value of unity, if it
|
|
1599
1631
|
* supports alpha blending.
|
|
1600
1632
|
*/
|
|
1601
|
-
OPAQUE,
|
|
1633
|
+
OPAQUE = 19,
|
|
1602
1634
|
/**
|
|
1603
1635
|
* Indicates this object is currently pressed.
|
|
1604
1636
|
*/
|
|
1605
|
-
PRESSED,
|
|
1637
|
+
PRESSED = 20,
|
|
1606
1638
|
/**
|
|
1607
1639
|
* Indicates the size of this object's size is not
|
|
1608
1640
|
* fixed.
|
|
1609
1641
|
*/
|
|
1610
|
-
RESIZABLE,
|
|
1642
|
+
RESIZABLE = 21,
|
|
1611
1643
|
/**
|
|
1612
1644
|
* Indicates this object is the child of an object
|
|
1613
1645
|
* that allows its children to be selected and that this child is one of
|
|
1614
1646
|
* those children that can be selected.
|
|
1615
1647
|
*/
|
|
1616
|
-
SELECTABLE,
|
|
1648
|
+
SELECTABLE = 22,
|
|
1617
1649
|
/**
|
|
1618
1650
|
* Indicates this object is the child of an object that
|
|
1619
1651
|
* allows its children to be selected and that this child is one of those
|
|
1620
1652
|
* children that has been selected.
|
|
1621
1653
|
*/
|
|
1622
|
-
SELECTED,
|
|
1654
|
+
SELECTED = 23,
|
|
1623
1655
|
/**
|
|
1624
1656
|
* Indicates this object is sensitive, e.g. to user
|
|
1625
1657
|
* interaction. `ATSPI_STATE_SENSITIVE` usually accompanies.
|
|
@@ -1631,36 +1663,36 @@ export namespace Atspi {
|
|
|
1631
1663
|
* current state is ambiguous or undefined. See `ATSPI_STATE_ENABLED`,
|
|
1632
1664
|
* `ATSPI_STATE_INDETERMINATE`.
|
|
1633
1665
|
*/
|
|
1634
|
-
SENSITIVE,
|
|
1666
|
+
SENSITIVE = 24,
|
|
1635
1667
|
/**
|
|
1636
1668
|
* Indicates this object, the object's parent, the
|
|
1637
1669
|
* object's parent's parent, and so on, are all 'shown' to the end-user,
|
|
1638
1670
|
* i.e. subject to "exposure" if blocking or obscuring objects do not
|
|
1639
1671
|
* interpose between this object and the top of the window stack.
|
|
1640
1672
|
*/
|
|
1641
|
-
SHOWING,
|
|
1673
|
+
SHOWING = 25,
|
|
1642
1674
|
/**
|
|
1643
1675
|
* Indicates this (text) object can contain only a
|
|
1644
1676
|
* single line of text.
|
|
1645
1677
|
*/
|
|
1646
|
-
SINGLE_LINE,
|
|
1678
|
+
SINGLE_LINE = 26,
|
|
1647
1679
|
/**
|
|
1648
1680
|
* Indicates that the information returned for this object
|
|
1649
1681
|
* may no longer be synchronized with the application state. This can occur
|
|
1650
1682
|
* if the object has `ATSPI_STATE_TRANSIENT`, and can also occur towards the
|
|
1651
1683
|
* end of the object peer's lifecycle.
|
|
1652
1684
|
*/
|
|
1653
|
-
STALE,
|
|
1685
|
+
STALE = 27,
|
|
1654
1686
|
/**
|
|
1655
1687
|
* Indicates this object is transient.
|
|
1656
1688
|
*/
|
|
1657
|
-
TRANSIENT,
|
|
1689
|
+
TRANSIENT = 28,
|
|
1658
1690
|
/**
|
|
1659
1691
|
* Indicates the orientation of this object is vertical;
|
|
1660
1692
|
* for example this state may appear on such objects as scrollbars, text
|
|
1661
1693
|
* objects (with vertical text flow), separators, etc.
|
|
1662
1694
|
*/
|
|
1663
|
-
VERTICAL,
|
|
1695
|
+
VERTICAL = 29,
|
|
1664
1696
|
/**
|
|
1665
1697
|
* Indicates this object is visible, e.g. has been
|
|
1666
1698
|
* explicitly marked for exposure to the user. `ATSPI_STATE_VISIBLE` is no
|
|
@@ -1672,7 +1704,7 @@ export namespace Atspi {
|
|
|
1672
1704
|
* `ATSPI_STATE_VISIBLE` and `ATSPI_STATE_SHOWING` is
|
|
1673
1705
|
* semantically equivalent to saying that an object is 'hidden'.
|
|
1674
1706
|
*/
|
|
1675
|
-
VISIBLE,
|
|
1707
|
+
VISIBLE = 30,
|
|
1676
1708
|
/**
|
|
1677
1709
|
* Indicates that "active-descendant-changed"
|
|
1678
1710
|
* event is sent when children become 'active' (i.e. are selected or
|
|
@@ -1685,7 +1717,7 @@ export namespace Atspi {
|
|
|
1685
1717
|
* visibility changes and activation of their contained child objects, without
|
|
1686
1718
|
* the client having previously requested references to those children.
|
|
1687
1719
|
*/
|
|
1688
|
-
MANAGES_DESCENDANTS,
|
|
1720
|
+
MANAGES_DESCENDANTS = 31,
|
|
1689
1721
|
/**
|
|
1690
1722
|
* Indicates that a check box or other boolean
|
|
1691
1723
|
* indicator is in a state other than checked or not checked. This
|
|
@@ -1699,18 +1731,18 @@ export namespace Atspi {
|
|
|
1699
1731
|
* `ATSPI_STATE_INDETERMINATE` and a corresponding state-changed event will be
|
|
1700
1732
|
* fired.
|
|
1701
1733
|
*/
|
|
1702
|
-
INDETERMINATE,
|
|
1734
|
+
INDETERMINATE = 32,
|
|
1703
1735
|
/**
|
|
1704
1736
|
* Indicates that user interaction with this object is
|
|
1705
1737
|
* 'required' from the user, for instance before completing the
|
|
1706
1738
|
* processing of a form.
|
|
1707
1739
|
*/
|
|
1708
|
-
REQUIRED,
|
|
1740
|
+
REQUIRED = 33,
|
|
1709
1741
|
/**
|
|
1710
1742
|
* Indicates that an object's onscreen content
|
|
1711
1743
|
* is truncated, e.g. a text value in a spreadsheet cell.
|
|
1712
1744
|
*/
|
|
1713
|
-
TRUNCATED,
|
|
1745
|
+
TRUNCATED = 34,
|
|
1714
1746
|
/**
|
|
1715
1747
|
* Indicates this object's visual representation is
|
|
1716
1748
|
* dynamic, not static. This state may be applied to an object during an
|
|
@@ -1721,13 +1753,13 @@ export namespace Atspi {
|
|
|
1721
1753
|
* definitive evidence that the object's visual representation is
|
|
1722
1754
|
* static; this state is advisory.
|
|
1723
1755
|
*/
|
|
1724
|
-
ANIMATED,
|
|
1756
|
+
ANIMATED = 35,
|
|
1725
1757
|
/**
|
|
1726
1758
|
* This object has indicated an error condition
|
|
1727
1759
|
* due to failure of input validation. For instance, a form control may
|
|
1728
1760
|
* acquire this state in response to invalid or malformed user input.
|
|
1729
1761
|
*/
|
|
1730
|
-
INVALID_ENTRY,
|
|
1762
|
+
INVALID_ENTRY = 36,
|
|
1731
1763
|
/**
|
|
1732
1764
|
* This state indicates that the object
|
|
1733
1765
|
* in question implements some form of typeahead or
|
|
@@ -1740,7 +1772,7 @@ export namespace Atspi {
|
|
|
1740
1772
|
* completion of the data in the input field, in which case
|
|
1741
1773
|
* these input events may trigger text-changed events from the source.
|
|
1742
1774
|
*/
|
|
1743
|
-
SUPPORTS_AUTOCOMPLETION,
|
|
1775
|
+
SUPPORTS_AUTOCOMPLETION = 37,
|
|
1744
1776
|
/**
|
|
1745
1777
|
* This state indicates that the object in
|
|
1746
1778
|
* question supports text selection. It should only be exposed on objects
|
|
@@ -1749,43 +1781,46 @@ export namespace Atspi {
|
|
|
1749
1781
|
* selectable child of an object which implements {@link Atspi.Selection}. While
|
|
1750
1782
|
* similar, text selection and subelement selection are distinct operations.
|
|
1751
1783
|
*/
|
|
1752
|
-
SELECTABLE_TEXT,
|
|
1784
|
+
SELECTABLE_TEXT = 38,
|
|
1753
1785
|
/**
|
|
1754
1786
|
* This state indicates that the object in question is
|
|
1755
1787
|
* the 'default' interaction object in a dialog, i.e. the one that gets
|
|
1756
1788
|
* activated if the user presses "Enter" when the dialog is initially
|
|
1757
1789
|
* posted.
|
|
1758
1790
|
*/
|
|
1759
|
-
IS_DEFAULT,
|
|
1791
|
+
IS_DEFAULT = 39,
|
|
1760
1792
|
/**
|
|
1761
1793
|
* This state indicates that the object (typically a
|
|
1762
1794
|
* hyperlink) has already been activated or invoked, with the result that
|
|
1763
1795
|
* some backing data has been downloaded or rendered.
|
|
1764
1796
|
*/
|
|
1765
|
-
VISITED,
|
|
1797
|
+
VISITED = 40,
|
|
1766
1798
|
/**
|
|
1767
1799
|
* Indicates this object has the potential to be checked, such as a checkbox
|
|
1768
1800
|
* or toggle-able table cell.
|
|
1801
|
+
* @since 2.12
|
|
1769
1802
|
*/
|
|
1770
|
-
CHECKABLE,
|
|
1803
|
+
CHECKABLE = 41,
|
|
1771
1804
|
/**
|
|
1772
1805
|
* Indicates that the object has a popup context menu or sub-level menu
|
|
1773
1806
|
* which may or may not be showing. This means that activation renders
|
|
1774
1807
|
* conditional content. Note that ordinary tooltips are not considered
|
|
1775
1808
|
* popups in this context.
|
|
1809
|
+
* @since 2.12
|
|
1776
1810
|
*/
|
|
1777
|
-
HAS_POPUP,
|
|
1811
|
+
HAS_POPUP = 42,
|
|
1778
1812
|
/**
|
|
1779
1813
|
* Indicates that an object which is ENABLED and SENSITIVE has a value
|
|
1780
1814
|
* which can be read, but not modified, by the user.
|
|
1815
|
+
* @since 2.16
|
|
1781
1816
|
*/
|
|
1782
|
-
READ_ONLY,
|
|
1817
|
+
READ_ONLY = 43,
|
|
1783
1818
|
/**
|
|
1784
1819
|
* This value of the enumeration should not be used
|
|
1785
1820
|
* as a parameter, it indicates the number of items in the {@link Atspi.StateType}
|
|
1786
1821
|
* enumeration.
|
|
1787
1822
|
*/
|
|
1788
|
-
LAST_DEFINED,
|
|
1823
|
+
LAST_DEFINED = 44,
|
|
1789
1824
|
}
|
|
1790
1825
|
|
|
1791
1826
|
|
|
@@ -1811,12 +1846,12 @@ export namespace Atspi {
|
|
|
1811
1846
|
* character only. Start and end offsets differ by one, by definition,
|
|
1812
1847
|
* for this value.
|
|
1813
1848
|
*/
|
|
1814
|
-
CHAR,
|
|
1849
|
+
CHAR = 0,
|
|
1815
1850
|
/**
|
|
1816
1851
|
* Boundary condition is start of a word; i.e.
|
|
1817
1852
|
* range is from start of one word to the start of another word.
|
|
1818
1853
|
*/
|
|
1819
|
-
WORD_START,
|
|
1854
|
+
WORD_START = 1,
|
|
1820
1855
|
/**
|
|
1821
1856
|
* Boundary condition is the end of a word; i.e.
|
|
1822
1857
|
* range is from the end of one word to the end of another. Some locales
|
|
@@ -1825,7 +1860,7 @@ export namespace Atspi {
|
|
|
1825
1860
|
* In these cases, characters may be returned in lieu of multi-character
|
|
1826
1861
|
* substrings.
|
|
1827
1862
|
*/
|
|
1828
|
-
WORD_END,
|
|
1863
|
+
WORD_END = 2,
|
|
1829
1864
|
/**
|
|
1830
1865
|
* Boundary condition is start of a
|
|
1831
1866
|
* sentence, as determined by the application. Some locales or
|
|
@@ -1833,7 +1868,7 @@ export namespace Atspi {
|
|
|
1833
1868
|
* boundary type can not always be honored. Some locales will return lines
|
|
1834
1869
|
* of text instead of grammatical sentences.
|
|
1835
1870
|
*/
|
|
1836
|
-
SENTENCE_START,
|
|
1871
|
+
SENTENCE_START = 3,
|
|
1837
1872
|
/**
|
|
1838
1873
|
* Boundary condition is end of a sentence,
|
|
1839
1874
|
* as determined by the application, including the sentence-delimiting
|
|
@@ -1842,22 +1877,22 @@ export namespace Atspi {
|
|
|
1842
1877
|
* always be honored. Some locales will return lines of text instead of
|
|
1843
1878
|
* grammatical sentences.
|
|
1844
1879
|
*/
|
|
1845
|
-
SENTENCE_END,
|
|
1880
|
+
SENTENCE_END = 4,
|
|
1846
1881
|
/**
|
|
1847
1882
|
* Boundary condition is the start of a line;
|
|
1848
1883
|
* i.e. range is from start of one line to the start of another. This
|
|
1849
1884
|
* generally means that an end-of-line character will appear at the end of
|
|
1850
1885
|
* the range.
|
|
1851
1886
|
*/
|
|
1852
|
-
LINE_START,
|
|
1887
|
+
LINE_START = 5,
|
|
1853
1888
|
/**
|
|
1854
1889
|
* Boundary condition is the end of a line; i.e.
|
|
1855
1890
|
* range is from start of one line to the start of another. This generally
|
|
1856
1891
|
* means that an end-of-line character will be the first character of the
|
|
1857
1892
|
* range.
|
|
1858
1893
|
*/
|
|
1859
|
-
LINE_END,
|
|
1860
|
-
LAST_DEFINED,
|
|
1894
|
+
LINE_END = 6,
|
|
1895
|
+
LAST_DEFINED = 7,
|
|
1861
1896
|
}
|
|
1862
1897
|
|
|
1863
1898
|
|
|
@@ -1877,23 +1912,23 @@ export namespace Atspi {
|
|
|
1877
1912
|
/**
|
|
1878
1913
|
* No characters/glyphs are omitted.
|
|
1879
1914
|
*/
|
|
1880
|
-
NONE,
|
|
1915
|
+
NONE = 0,
|
|
1881
1916
|
/**
|
|
1882
1917
|
* Characters/glyphs clipped by the minimum coordinate
|
|
1883
1918
|
* are omitted.
|
|
1884
1919
|
*/
|
|
1885
|
-
MIN,
|
|
1920
|
+
MIN = 1,
|
|
1886
1921
|
/**
|
|
1887
1922
|
* Characters/glyphs which intersect the maximum
|
|
1888
1923
|
* coordinate are omitted.
|
|
1889
1924
|
*/
|
|
1890
|
-
MAX,
|
|
1925
|
+
MAX = 2,
|
|
1891
1926
|
/**
|
|
1892
1927
|
* Only glyphs falling entirely within the region
|
|
1893
1928
|
* bounded by min and max are retained.
|
|
1894
1929
|
*/
|
|
1895
|
-
BOTH,
|
|
1896
|
-
LAST_DEFINED,
|
|
1930
|
+
BOTH = 3,
|
|
1931
|
+
LAST_DEFINED = 4,
|
|
1897
1932
|
}
|
|
1898
1933
|
|
|
1899
1934
|
|
|
@@ -1914,309 +1949,459 @@ export namespace Atspi {
|
|
|
1914
1949
|
* Granularity is defined by the boundaries between characters
|
|
1915
1950
|
* (including non-printing characters)
|
|
1916
1951
|
*/
|
|
1917
|
-
CHAR,
|
|
1952
|
+
CHAR = 0,
|
|
1918
1953
|
/**
|
|
1919
1954
|
* Granularity is defined by the boundaries of a word,
|
|
1920
1955
|
* starting at the beginning of the current word and finishing at the beginning of
|
|
1921
1956
|
* the following one, if present.
|
|
1922
1957
|
*/
|
|
1923
|
-
WORD,
|
|
1958
|
+
WORD = 1,
|
|
1924
1959
|
/**
|
|
1925
1960
|
* Granularity is defined by the boundaries of a sentence,
|
|
1926
1961
|
* starting at the beginning of the current sentence and finishing at the beginning of
|
|
1927
1962
|
* the following one, if present.
|
|
1928
1963
|
*/
|
|
1929
|
-
SENTENCE,
|
|
1964
|
+
SENTENCE = 2,
|
|
1930
1965
|
/**
|
|
1931
1966
|
* Granularity is defined by the boundaries of a line,
|
|
1932
1967
|
* starting at the beginning of the current line and finishing at the beginning of
|
|
1933
1968
|
* the following one, if present.
|
|
1934
1969
|
*/
|
|
1935
|
-
LINE,
|
|
1970
|
+
LINE = 3,
|
|
1936
1971
|
/**
|
|
1937
1972
|
* Granularity is defined by the boundaries of a paragraph,
|
|
1938
1973
|
* starting at the beginning of the current paragraph and finishing at the beginning of
|
|
1939
1974
|
* the following one, if present.
|
|
1940
1975
|
*/
|
|
1941
|
-
PARAGRAPH,
|
|
1976
|
+
PARAGRAPH = 4,
|
|
1942
1977
|
}
|
|
1943
1978
|
|
|
1944
1979
|
|
|
1945
1980
|
/**
|
|
1946
1981
|
* The version of the Application D-Bus interface.
|
|
1947
1982
|
* @since 2.59
|
|
1983
|
+
* @default 1
|
|
1948
1984
|
*/
|
|
1949
1985
|
const ACCESSIBLE_VERSION: number;
|
|
1950
1986
|
|
|
1951
1987
|
/**
|
|
1952
1988
|
* The version of the Action D-Bus interface.
|
|
1953
1989
|
* @since 2.59
|
|
1990
|
+
* @default 1
|
|
1954
1991
|
*/
|
|
1955
1992
|
const ACTION_VERSION: number;
|
|
1956
1993
|
|
|
1957
1994
|
/**
|
|
1958
1995
|
* The version of the Application D-Bus interface.
|
|
1959
1996
|
* @since 2.59
|
|
1997
|
+
* @default 1
|
|
1960
1998
|
*/
|
|
1961
1999
|
const APPLICATION_VERSION: number;
|
|
1962
2000
|
|
|
1963
2001
|
/**
|
|
1964
2002
|
* The version of the Cache D-Bus interface.
|
|
1965
2003
|
* @since 2.59
|
|
2004
|
+
* @default 1
|
|
1966
2005
|
*/
|
|
1967
2006
|
const CACHE_VERSION: number;
|
|
1968
2007
|
|
|
1969
2008
|
/**
|
|
1970
2009
|
* The version of the Collection D-Bus interface.
|
|
1971
2010
|
* @since 2.59
|
|
2011
|
+
* @default 1
|
|
1972
2012
|
*/
|
|
1973
2013
|
const COLLECTION_VERSION: number;
|
|
1974
2014
|
|
|
1975
2015
|
/**
|
|
1976
2016
|
* One higher than the highest valid value of {@link Atspi.ComponentLayer}.
|
|
2017
|
+
* @default 9
|
|
1977
2018
|
*/
|
|
1978
2019
|
const COMPONENTLAYER_COUNT: number;
|
|
1979
2020
|
|
|
1980
2021
|
/**
|
|
1981
2022
|
* The version of the Component D-Bus interface.
|
|
1982
2023
|
* @since 2.59
|
|
2024
|
+
* @default 1
|
|
1983
2025
|
*/
|
|
1984
2026
|
const COMPONENT_VERSION: number;
|
|
1985
2027
|
|
|
1986
2028
|
/**
|
|
1987
2029
|
* One higher than the highest valid value of {@link Atspi.CoordType}.
|
|
2030
|
+
* @default 4
|
|
1988
2031
|
*/
|
|
1989
2032
|
const COORD_TYPE_COUNT: number;
|
|
1990
2033
|
|
|
2034
|
+
/**
|
|
2035
|
+
* @default org.a11y.atspi.Accessible
|
|
2036
|
+
*/
|
|
1991
2037
|
const DBUS_INTERFACE_ACCESSIBLE: string;
|
|
1992
2038
|
|
|
2039
|
+
/**
|
|
2040
|
+
* @default org.a11y.atspi.Action
|
|
2041
|
+
*/
|
|
1993
2042
|
const DBUS_INTERFACE_ACTION: string;
|
|
1994
2043
|
|
|
2044
|
+
/**
|
|
2045
|
+
* @default org.a11y.atspi.Application
|
|
2046
|
+
*/
|
|
1995
2047
|
const DBUS_INTERFACE_APPLICATION: string;
|
|
1996
2048
|
|
|
2049
|
+
/**
|
|
2050
|
+
* @default org.a11y.atspi.Cache
|
|
2051
|
+
*/
|
|
1997
2052
|
const DBUS_INTERFACE_CACHE: string;
|
|
1998
2053
|
|
|
2054
|
+
/**
|
|
2055
|
+
* @default org.a11y.atspi.Collection
|
|
2056
|
+
*/
|
|
1999
2057
|
const DBUS_INTERFACE_COLLECTION: string;
|
|
2000
2058
|
|
|
2059
|
+
/**
|
|
2060
|
+
* @default org.a11y.atspi.Component
|
|
2061
|
+
*/
|
|
2001
2062
|
const DBUS_INTERFACE_COMPONENT: string;
|
|
2002
2063
|
|
|
2064
|
+
/**
|
|
2065
|
+
* @default org.a11y.atspi.DeviceEventController
|
|
2066
|
+
*/
|
|
2003
2067
|
const DBUS_INTERFACE_DEC: string;
|
|
2004
2068
|
|
|
2069
|
+
/**
|
|
2070
|
+
* @default org.a11y.atspi.DeviceEventListener
|
|
2071
|
+
*/
|
|
2005
2072
|
const DBUS_INTERFACE_DEVICE_EVENT_LISTENER: string;
|
|
2006
2073
|
|
|
2074
|
+
/**
|
|
2075
|
+
* @default org.a11y.atspi.Document
|
|
2076
|
+
*/
|
|
2007
2077
|
const DBUS_INTERFACE_DOCUMENT: string;
|
|
2008
2078
|
|
|
2079
|
+
/**
|
|
2080
|
+
* @default org.a11y.atspi.EditableText
|
|
2081
|
+
*/
|
|
2009
2082
|
const DBUS_INTERFACE_EDITABLE_TEXT: string;
|
|
2010
2083
|
|
|
2084
|
+
/**
|
|
2085
|
+
* @default org.a11y.atspi.Event.Keyboard
|
|
2086
|
+
*/
|
|
2011
2087
|
const DBUS_INTERFACE_EVENT_KEYBOARD: string;
|
|
2012
2088
|
|
|
2089
|
+
/**
|
|
2090
|
+
* @default org.a11y.atspi.Event.Mouse
|
|
2091
|
+
*/
|
|
2013
2092
|
const DBUS_INTERFACE_EVENT_MOUSE: string;
|
|
2014
2093
|
|
|
2094
|
+
/**
|
|
2095
|
+
* @default org.a11y.atspi.Event.Object
|
|
2096
|
+
*/
|
|
2015
2097
|
const DBUS_INTERFACE_EVENT_OBJECT: string;
|
|
2016
2098
|
|
|
2099
|
+
/**
|
|
2100
|
+
* @default org.a11y.atspi.Event.ScreenReader
|
|
2101
|
+
*/
|
|
2017
2102
|
const DBUS_INTERFACE_EVENT_SCREEN_READER: string;
|
|
2018
2103
|
|
|
2104
|
+
/**
|
|
2105
|
+
* @default org.a11y.atspi.Hyperlink
|
|
2106
|
+
*/
|
|
2019
2107
|
const DBUS_INTERFACE_HYPERLINK: string;
|
|
2020
2108
|
|
|
2109
|
+
/**
|
|
2110
|
+
* @default org.a11y.atspi.Hypertext
|
|
2111
|
+
*/
|
|
2021
2112
|
const DBUS_INTERFACE_HYPERTEXT: string;
|
|
2022
2113
|
|
|
2114
|
+
/**
|
|
2115
|
+
* @default org.a11y.atspi.Image
|
|
2116
|
+
*/
|
|
2023
2117
|
const DBUS_INTERFACE_IMAGE: string;
|
|
2024
2118
|
|
|
2119
|
+
/**
|
|
2120
|
+
* @default org.freedesktop.a11y.KeyboardMonitor
|
|
2121
|
+
*/
|
|
2025
2122
|
const DBUS_INTERFACE_KEYBOARD_MONITOR: string;
|
|
2026
2123
|
|
|
2124
|
+
/**
|
|
2125
|
+
* @default org.freedesktop.a11y.PointerLocator
|
|
2126
|
+
*/
|
|
2027
2127
|
const DBUS_INTERFACE_POINTER_LOCATOR: string;
|
|
2028
2128
|
|
|
2129
|
+
/**
|
|
2130
|
+
* @default org.a11y.atspi.Registry
|
|
2131
|
+
*/
|
|
2029
2132
|
const DBUS_INTERFACE_REGISTRY: string;
|
|
2030
2133
|
|
|
2134
|
+
/**
|
|
2135
|
+
* @default org.a11y.atspi.Selection
|
|
2136
|
+
*/
|
|
2031
2137
|
const DBUS_INTERFACE_SELECTION: string;
|
|
2032
2138
|
|
|
2139
|
+
/**
|
|
2140
|
+
* @default org.a11y.atspi.Socket
|
|
2141
|
+
*/
|
|
2033
2142
|
const DBUS_INTERFACE_SOCKET: string;
|
|
2034
2143
|
|
|
2144
|
+
/**
|
|
2145
|
+
* @default org.a11y.atspi.Table
|
|
2146
|
+
*/
|
|
2035
2147
|
const DBUS_INTERFACE_TABLE: string;
|
|
2036
2148
|
|
|
2149
|
+
/**
|
|
2150
|
+
* @default org.a11y.atspi.TableCell
|
|
2151
|
+
*/
|
|
2037
2152
|
const DBUS_INTERFACE_TABLE_CELL: string;
|
|
2038
2153
|
|
|
2154
|
+
/**
|
|
2155
|
+
* @default org.a11y.atspi.Text
|
|
2156
|
+
*/
|
|
2039
2157
|
const DBUS_INTERFACE_TEXT: string;
|
|
2040
2158
|
|
|
2159
|
+
/**
|
|
2160
|
+
* @default org.a11y.atspi.Value
|
|
2161
|
+
*/
|
|
2041
2162
|
const DBUS_INTERFACE_VALUE: string;
|
|
2042
2163
|
|
|
2164
|
+
/**
|
|
2165
|
+
* @default org.freedesktop.a11y.Manager
|
|
2166
|
+
*/
|
|
2043
2167
|
const DBUS_NAME_A11Y_MANAGER: string;
|
|
2044
2168
|
|
|
2169
|
+
/**
|
|
2170
|
+
* @default org.a11y.atspi.Registry
|
|
2171
|
+
*/
|
|
2045
2172
|
const DBUS_NAME_REGISTRY: string;
|
|
2046
2173
|
|
|
2174
|
+
/**
|
|
2175
|
+
* @default /org/freedesktop/a11y/Manager
|
|
2176
|
+
*/
|
|
2047
2177
|
const DBUS_PATH_A11Y_MANAGER: string;
|
|
2048
2178
|
|
|
2179
|
+
/**
|
|
2180
|
+
* @default /org/a11y/atspi/registry/deviceeventcontroller
|
|
2181
|
+
*/
|
|
2049
2182
|
const DBUS_PATH_DEC: string;
|
|
2050
2183
|
|
|
2184
|
+
/**
|
|
2185
|
+
* @default /org/a11y/atspi/null
|
|
2186
|
+
*/
|
|
2051
2187
|
const DBUS_PATH_NULL: string;
|
|
2052
2188
|
|
|
2189
|
+
/**
|
|
2190
|
+
* @default /org/a11y/atspi/registry
|
|
2191
|
+
*/
|
|
2053
2192
|
const DBUS_PATH_REGISTRY: string;
|
|
2054
2193
|
|
|
2194
|
+
/**
|
|
2195
|
+
* @default /org/a11y/atspi/accessible/root
|
|
2196
|
+
*/
|
|
2055
2197
|
const DBUS_PATH_ROOT: string;
|
|
2056
2198
|
|
|
2199
|
+
/**
|
|
2200
|
+
* @default /org/a11y/atspi/screenreader
|
|
2201
|
+
*/
|
|
2057
2202
|
const DBUS_PATH_SCREEN_READER: string;
|
|
2058
2203
|
|
|
2204
|
+
/**
|
|
2205
|
+
* @default 31
|
|
2206
|
+
*/
|
|
2059
2207
|
const DEVICE_A11Y_MANAGER_VIRTUAL_MOD_END: number;
|
|
2060
2208
|
|
|
2209
|
+
/**
|
|
2210
|
+
* @default 15
|
|
2211
|
+
*/
|
|
2061
2212
|
const DEVICE_A11Y_MANAGER_VIRTUAL_MOD_START: number;
|
|
2062
2213
|
|
|
2063
2214
|
/**
|
|
2064
2215
|
* The version of the DeviceEventController D-Bus interface.
|
|
2065
2216
|
* @since 2.59
|
|
2217
|
+
* @default 1
|
|
2066
2218
|
*/
|
|
2067
2219
|
const DEVICE_EVENT_CONTROLLER_VERSION: number;
|
|
2068
2220
|
|
|
2069
2221
|
/**
|
|
2070
2222
|
* The version of the DeviceEventListener D-Bus interface.
|
|
2071
2223
|
* @since 2.59
|
|
2224
|
+
* @default 1
|
|
2072
2225
|
*/
|
|
2073
2226
|
const DEVICE_EVENT_LISTENER_VERSION: number;
|
|
2074
2227
|
|
|
2075
2228
|
/**
|
|
2076
2229
|
* The version of the Document D-Bus interface.
|
|
2077
2230
|
* @since 2.59
|
|
2231
|
+
* @default 1
|
|
2078
2232
|
*/
|
|
2079
2233
|
const DOCUMENT_VERSION: number;
|
|
2080
2234
|
|
|
2081
2235
|
/**
|
|
2082
2236
|
* The version of the EditableText D-Bus interface.
|
|
2083
2237
|
* @since 2.59
|
|
2238
|
+
* @default 1
|
|
2084
2239
|
*/
|
|
2085
2240
|
const EDITABLE_TEXT_VERSION: number;
|
|
2086
2241
|
|
|
2087
2242
|
/**
|
|
2088
2243
|
* One higher than the highest valid value of {@link Atspi.EventType}.
|
|
2244
|
+
* @default 5
|
|
2089
2245
|
*/
|
|
2090
2246
|
const EVENTTYPE_COUNT: number;
|
|
2091
2247
|
|
|
2092
2248
|
/**
|
|
2093
2249
|
* The version of the Event D-Bus interface.
|
|
2094
2250
|
* @since 2.59
|
|
2251
|
+
* @default 1
|
|
2095
2252
|
*/
|
|
2096
2253
|
const EVENT_VERSION: number;
|
|
2097
2254
|
|
|
2098
2255
|
/**
|
|
2099
2256
|
* The version of the Hyperlink D-Bus interface.
|
|
2100
2257
|
* @since 2.59
|
|
2258
|
+
* @default 1
|
|
2101
2259
|
*/
|
|
2102
2260
|
const HYPERLINK_VERSION: number;
|
|
2103
2261
|
|
|
2104
2262
|
/**
|
|
2105
2263
|
* The version of the Hypertext D-Bus interface.
|
|
2106
2264
|
* @since 2.59
|
|
2265
|
+
* @default 1
|
|
2107
2266
|
*/
|
|
2108
2267
|
const HYPERTEXT_VERSION: number;
|
|
2109
2268
|
|
|
2110
2269
|
/**
|
|
2111
2270
|
* The version of the Image D-Bus interface.
|
|
2112
2271
|
* @since 2.59
|
|
2272
|
+
* @default 1
|
|
2113
2273
|
*/
|
|
2114
2274
|
const IMAGE_VERSION: number;
|
|
2115
2275
|
|
|
2116
2276
|
/**
|
|
2117
2277
|
* One higher than the highest valid value of {@link Atspi.KeyEventType}.
|
|
2278
|
+
* @default 3
|
|
2118
2279
|
*/
|
|
2119
2280
|
const KEYEVENTTYPE_COUNT: number;
|
|
2120
2281
|
|
|
2121
2282
|
/**
|
|
2122
2283
|
* One higher than the highest valid value of {@link Atspi.KeySynthType}.
|
|
2284
|
+
* @default 8
|
|
2123
2285
|
*/
|
|
2124
2286
|
const KEYSYNTHTYPE_COUNT: number;
|
|
2125
2287
|
|
|
2126
2288
|
/**
|
|
2127
2289
|
* One higher than the highest valid value of {@link Atspi.LocaleType}.
|
|
2290
|
+
* @default 7
|
|
2128
2291
|
*/
|
|
2129
2292
|
const LOCALE_TYPE_COUNT: number;
|
|
2130
2293
|
|
|
2294
|
+
/**
|
|
2295
|
+
* @default 6
|
|
2296
|
+
*/
|
|
2131
2297
|
const MATCHTYPES_COUNT: number;
|
|
2132
2298
|
|
|
2299
|
+
/**
|
|
2300
|
+
* @default 65536
|
|
2301
|
+
*/
|
|
2133
2302
|
const MAX_CHILDREN: number;
|
|
2134
2303
|
|
|
2135
2304
|
/**
|
|
2136
2305
|
* One higher than the highest valid value of {@link Atspi.ModifierType}.
|
|
2306
|
+
* @default 8
|
|
2137
2307
|
*/
|
|
2138
2308
|
const MODIFIERTYPE_COUNT: number;
|
|
2139
2309
|
|
|
2140
2310
|
/**
|
|
2141
2311
|
* The version of the Registry D-Bus interface.
|
|
2142
2312
|
* @since 2.59
|
|
2313
|
+
* @default 2
|
|
2143
2314
|
*/
|
|
2144
2315
|
const REGISTRY_VERSION: number;
|
|
2145
2316
|
|
|
2146
2317
|
/**
|
|
2147
2318
|
* One higher than the highest valid value of {@link Atspi.RelationType}.
|
|
2319
|
+
* @default 24
|
|
2148
2320
|
*/
|
|
2149
2321
|
const RELATIONTYPE_COUNT: number;
|
|
2150
2322
|
|
|
2151
2323
|
/**
|
|
2152
2324
|
* One higher than the highest valid value of {@link Atspi.Role}.
|
|
2325
|
+
* @default 132
|
|
2153
2326
|
*/
|
|
2154
2327
|
const ROLE_COUNT: number;
|
|
2155
2328
|
|
|
2156
2329
|
/**
|
|
2157
2330
|
* One higher than the highest valid value of {@link Atspi.ScrollType}.
|
|
2331
|
+
* @default 8
|
|
2158
2332
|
*/
|
|
2159
2333
|
const SCROLLTYPE_COUNT: number;
|
|
2160
2334
|
|
|
2161
2335
|
/**
|
|
2162
2336
|
* The version of the Selection D-Bus interface.
|
|
2163
2337
|
* @since 2.59
|
|
2338
|
+
* @default 1
|
|
2164
2339
|
*/
|
|
2165
2340
|
const SELECTION_VERSION: number;
|
|
2166
2341
|
|
|
2167
2342
|
/**
|
|
2168
2343
|
* The version of the Socket D-Bus interface.
|
|
2169
2344
|
* @since 2.59
|
|
2345
|
+
* @default 1
|
|
2170
2346
|
*/
|
|
2171
2347
|
const SOCKET_VERSION: number;
|
|
2172
2348
|
|
|
2173
2349
|
/**
|
|
2174
2350
|
* One higher than the highest valid value of {@link Atspi.CollectionSortOrder}.
|
|
2351
|
+
* @default 8
|
|
2175
2352
|
*/
|
|
2176
2353
|
const SORTORDER_COUNT: number;
|
|
2177
2354
|
|
|
2178
2355
|
/**
|
|
2179
2356
|
* One higher than the highest valid value of {@link Atspi.StateType}.
|
|
2357
|
+
* @default 45
|
|
2180
2358
|
*/
|
|
2181
2359
|
const STATETYPE_COUNT: number;
|
|
2182
2360
|
|
|
2183
2361
|
/**
|
|
2184
2362
|
* The version of the TableCell D-Bus interface.
|
|
2185
2363
|
* @since 2.59
|
|
2364
|
+
* @default 1
|
|
2186
2365
|
*/
|
|
2187
2366
|
const TABLE_CELL_VERSION: number;
|
|
2188
2367
|
|
|
2189
2368
|
/**
|
|
2190
2369
|
* The version of the Table D-Bus interface.
|
|
2191
2370
|
* @since 2.59
|
|
2371
|
+
* @default 1
|
|
2192
2372
|
*/
|
|
2193
2373
|
const TABLE_VERSION: number;
|
|
2194
2374
|
|
|
2195
2375
|
/**
|
|
2196
2376
|
* One higher than the highest valid value of {@link Atspi.TextBoundaryType}.
|
|
2377
|
+
* @default 8
|
|
2197
2378
|
*/
|
|
2198
2379
|
const TEXT_BOUNDARY_TYPE_COUNT: number;
|
|
2199
2380
|
|
|
2200
2381
|
/**
|
|
2201
2382
|
* One higher than the highest valid value of {@link Atspi.TextClipType}.
|
|
2383
|
+
* @default 5
|
|
2202
2384
|
*/
|
|
2203
2385
|
const TEXT_CLIP_TYPE_COUNT: number;
|
|
2204
2386
|
|
|
2205
2387
|
/**
|
|
2206
2388
|
* The version of the Text D-Bus interface.
|
|
2207
2389
|
* @since 2.59
|
|
2390
|
+
* @default 1
|
|
2208
2391
|
*/
|
|
2209
2392
|
const TEXT_VERSION: number;
|
|
2210
2393
|
|
|
2211
2394
|
/**
|
|
2212
2395
|
* One higher than the highest valid value of
|
|
2213
2396
|
* #AtspiCollection_TreeTraversalType.
|
|
2397
|
+
* @default 4
|
|
2214
2398
|
*/
|
|
2215
2399
|
const TREETRAVERSALTYPE_COUNT: number;
|
|
2216
2400
|
|
|
2217
2401
|
/**
|
|
2218
2402
|
* The version of the Value D-Bus interface.
|
|
2219
2403
|
* @since 2.59
|
|
2404
|
+
* @default 1
|
|
2220
2405
|
*/
|
|
2221
2406
|
const VALUE_VERSION: number;
|
|
2222
2407
|
|
|
@@ -2226,6 +2411,7 @@ export namespace Atspi {
|
|
|
2226
2411
|
* @param listener a pointer to the {@link Atspi.DeviceListener} for which device events are requested.
|
|
2227
2412
|
* @param filter Unused parameter.
|
|
2228
2413
|
* @returns `true` if successful, otherwise `false`.
|
|
2414
|
+
* @throws GLib.Error
|
|
2229
2415
|
*/
|
|
2230
2416
|
function deregister_device_event_listener(listener: DeviceListener, filter: null): boolean;
|
|
2231
2417
|
|
|
@@ -2237,6 +2423,7 @@ export namespace Atspi {
|
|
|
2237
2423
|
* @param modmask the key modifier mask for which this listener is to be 'deregistered' (of type {@link Atspi.KeyMaskType}).
|
|
2238
2424
|
* @param event_types an {@link Atspi.KeyMaskType} mask indicating which types of key events were requested ({@link Atspi.KeyEventType.PRESSED}, etc.).
|
|
2239
2425
|
* @returns `true` if successful, otherwise `false`.
|
|
2426
|
+
* @throws GLib.Error
|
|
2240
2427
|
*/
|
|
2241
2428
|
function deregister_keystroke_listener(listener: DeviceListener, key_set: KeyDefinition[] | null, modmask: KeyMaskType, event_types: KeyEventMask): boolean;
|
|
2242
2429
|
|
|
@@ -2268,6 +2455,7 @@ export namespace Atspi {
|
|
|
2268
2455
|
* @param keystring an (optional) UTF-8 string which, if `synth_type` is {@link Atspi.KeySynthType.STRING}, indicates a 'composed' keyboard input string being synthesized; this type of keyboard event synthesis does not emulate hardware keypresses but injects the string as though a composing input method (such as XIM) were used.
|
|
2269
2456
|
* @param synth_type an {@link Atspi.KeySynthType} flag indicating whether `keyval` is to be interpreted as a keysym rather than a keycode ({@link Atspi.KeySynthType.SYM}) or a string ({@link Atspi.KeySynthType.STRING}) or a modifier mask ({@link Atspi.KeySynthType.LOCKMODIFIERS} and {@link Atspi.KeySynthType.UNLOCKMODIFIERS}), or whether to synthesize {@link Atspi.KeySynthType.PRESS}, {@link Atspi.KeySynthType.RELEASE}, or both ({@link Atspi.KeySynthType.PRESSRELEASE}).
|
|
2270
2457
|
* @returns `true` if successful, otherwise `false`.
|
|
2458
|
+
* @throws GLib.Error
|
|
2271
2459
|
*/
|
|
2272
2460
|
function generate_keyboard_event(keyval: bigint | number, keystring: string | null, synth_type: KeySynthType): boolean;
|
|
2273
2461
|
|
|
@@ -2282,6 +2470,7 @@ export namespace Atspi {
|
|
|
2282
2470
|
* @param y a `glong` indicating the screen y coordinate of the mouse event.
|
|
2283
2471
|
* @param name a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs").
|
|
2284
2472
|
* @returns `true` if successful, otherwise `false`.
|
|
2473
|
+
* @throws GLib.Error
|
|
2285
2474
|
*/
|
|
2286
2475
|
function generate_mouse_event(x: bigint | number, y: bigint | number, name: string): boolean;
|
|
2287
2476
|
|
|
@@ -2291,6 +2480,7 @@ export namespace Atspi {
|
|
|
2291
2480
|
* @param y a `glong` indicating the screen y coordinate of the mouse event.
|
|
2292
2481
|
* @param name a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs").
|
|
2293
2482
|
* @param callback a callback to be called when a reply is received. May be NULL.
|
|
2483
|
+
* @throws GLib.Error
|
|
2294
2484
|
*/
|
|
2295
2485
|
function generate_mouse_event_async(x: bigint | number, y: bigint | number, name: string, callback: GenerateMouseEventCB): void;
|
|
2296
2486
|
|
|
@@ -2349,6 +2539,7 @@ export namespace Atspi {
|
|
|
2349
2539
|
* @param event_types
|
|
2350
2540
|
* @param filter
|
|
2351
2541
|
* @returns Always returns `false`.
|
|
2542
|
+
* @throws GLib.Error
|
|
2352
2543
|
*/
|
|
2353
2544
|
function register_device_event_listener(listener: DeviceListener, event_types: DeviceEventMask, filter: null): boolean;
|
|
2354
2545
|
|
|
@@ -2366,6 +2557,7 @@ export namespace Atspi {
|
|
|
2366
2557
|
* @param event_types an {@link Atspi.KeyMaskType} mask indicating which types of key events are requested ({@link Atspi.KeyEventType.PRESSED} etc.).
|
|
2367
2558
|
* @param sync_type an {@link Atspi.KeyListenerSyncType} parameter indicating the behavior of the notification/listener transaction.
|
|
2368
2559
|
* @returns `true` if successful, otherwise `false`.
|
|
2560
|
+
* @throws GLib.Error
|
|
2369
2561
|
*/
|
|
2370
2562
|
function register_keystroke_listener(listener: DeviceListener, key_set: KeyDefinition[] | null, modmask: KeyMaskType, event_types: KeyEventMask, sync_type: KeyListenerSyncType): boolean;
|
|
2371
2563
|
|
|
@@ -2482,18 +2674,18 @@ export namespace Atspi {
|
|
|
2482
2674
|
* @gir-type Flags
|
|
2483
2675
|
*/
|
|
2484
2676
|
enum Cache {
|
|
2485
|
-
NONE,
|
|
2486
|
-
PARENT,
|
|
2487
|
-
CHILDREN,
|
|
2488
|
-
NAME,
|
|
2489
|
-
DESCRIPTION,
|
|
2490
|
-
STATES,
|
|
2491
|
-
ROLE,
|
|
2492
|
-
INTERFACES,
|
|
2493
|
-
ATTRIBUTES,
|
|
2494
|
-
ALL,
|
|
2495
|
-
DEFAULT,
|
|
2496
|
-
UNDEFINED,
|
|
2677
|
+
NONE = 0,
|
|
2678
|
+
PARENT = 1,
|
|
2679
|
+
CHILDREN = 2,
|
|
2680
|
+
NAME = 4,
|
|
2681
|
+
DESCRIPTION = 8,
|
|
2682
|
+
STATES = 16,
|
|
2683
|
+
ROLE = 32,
|
|
2684
|
+
INTERFACES = 64,
|
|
2685
|
+
ATTRIBUTES = 128,
|
|
2686
|
+
ALL = 1073741823,
|
|
2687
|
+
DEFAULT = 127,
|
|
2688
|
+
UNDEFINED = 1073741824,
|
|
2497
2689
|
}
|
|
2498
2690
|
|
|
2499
2691
|
|
|
@@ -2513,31 +2705,31 @@ export namespace Atspi {
|
|
|
2513
2705
|
/**
|
|
2514
2706
|
* The capability to monitor keystrokes.
|
|
2515
2707
|
*/
|
|
2516
|
-
KEYBOARD_MONITOR,
|
|
2708
|
+
KEYBOARD_MONITOR = 1,
|
|
2517
2709
|
/**
|
|
2518
2710
|
* The capability to synthesize keystrokes.
|
|
2519
2711
|
*/
|
|
2520
|
-
KEYBOARD_SYNTH,
|
|
2712
|
+
KEYBOARD_SYNTH = 2,
|
|
2521
2713
|
/**
|
|
2522
2714
|
* The capability to set key grabs.
|
|
2523
2715
|
*/
|
|
2524
|
-
KEYBOARD_GRAB,
|
|
2716
|
+
KEYBOARD_GRAB = 4,
|
|
2525
2717
|
/**
|
|
2526
2718
|
* The capability to monitor the location of the pointer.
|
|
2527
2719
|
*/
|
|
2528
|
-
POINTER_MONITOR,
|
|
2720
|
+
POINTER_MONITOR = 8,
|
|
2529
2721
|
/**
|
|
2530
2722
|
* The capability to synthesize pointer motion.
|
|
2531
2723
|
*/
|
|
2532
|
-
POINTER_SYNTH,
|
|
2724
|
+
POINTER_SYNTH = 16,
|
|
2533
2725
|
/**
|
|
2534
2726
|
* The capability to monitor touch presses.
|
|
2535
2727
|
*/
|
|
2536
|
-
TOUCH_MONITOR,
|
|
2728
|
+
TOUCH_MONITOR = 32,
|
|
2537
2729
|
/**
|
|
2538
2730
|
* The capability to synthesize touch events.
|
|
2539
2731
|
*/
|
|
2540
|
-
TOUCH_SYNTH,
|
|
2732
|
+
TOUCH_SYNTH = 64,
|
|
2541
2733
|
}
|
|
2542
2734
|
|
|
2543
2735
|
|
|
@@ -2564,17 +2756,17 @@ export namespace Atspi {
|
|
|
2564
2756
|
* which means in some cases they may already have been delivered to the
|
|
2565
2757
|
* application before the AT client receives the notification.
|
|
2566
2758
|
*/
|
|
2567
|
-
NOSYNC,
|
|
2759
|
+
NOSYNC = 0,
|
|
2568
2760
|
/**
|
|
2569
2761
|
* Events are delivered synchronously, before the
|
|
2570
2762
|
* currently focused application sees them.
|
|
2571
2763
|
*/
|
|
2572
|
-
SYNCHRONOUS,
|
|
2764
|
+
SYNCHRONOUS = 1,
|
|
2573
2765
|
/**
|
|
2574
2766
|
* Events may be consumed by the AT client. Presumes and
|
|
2575
2767
|
* requires #ATSPI_KEYLISTENER_SYNCHRONOUS, incompatible with #ATSPI_KEYLISTENER_NOSYNC.
|
|
2576
2768
|
*/
|
|
2577
|
-
CANCONSUME,
|
|
2769
|
+
CANCONSUME = 2,
|
|
2578
2770
|
/**
|
|
2579
2771
|
* Events are received not from the application toolkit layer, but
|
|
2580
2772
|
* from the device driver or windowing system subsystem; such notifications are 'global' in the
|
|
@@ -2584,7 +2776,7 @@ export namespace Atspi {
|
|
|
2584
2776
|
* event notifications, even when inaccessible or "broken" applications have focus, are not
|
|
2585
2777
|
* required, it may be best to avoid this enum value/flag.
|
|
2586
2778
|
*/
|
|
2587
|
-
ALL_WINDOWS,
|
|
2779
|
+
ALL_WINDOWS = 4,
|
|
2588
2780
|
}
|
|
2589
2781
|
|
|
2590
2782
|
|
|
@@ -2603,7 +2795,7 @@ export namespace Atspi {
|
|
|
2603
2795
|
* @detailed
|
|
2604
2796
|
* @run-last
|
|
2605
2797
|
*/
|
|
2606
|
-
"mode-changed": (
|
|
2798
|
+
"mode-changed": (arg1: number, why: string) => void;
|
|
2607
2799
|
/**
|
|
2608
2800
|
* The signal "region-changed" is emitted by a screen reader to indicate
|
|
2609
2801
|
* that it is now reading or tracking a new object, or, a new piece of
|
|
@@ -2612,8 +2804,8 @@ export namespace Atspi {
|
|
|
2612
2804
|
* @signal
|
|
2613
2805
|
* @run-last
|
|
2614
2806
|
*/
|
|
2615
|
-
"region-changed": (
|
|
2616
|
-
[key: `mode-changed::${string}`]: (
|
|
2807
|
+
"region-changed": (arg1: number, arg2: number) => void;
|
|
2808
|
+
[key: `mode-changed::${string}`]: (arg1: number, why: string) => void;
|
|
2617
2809
|
}
|
|
2618
2810
|
|
|
2619
2811
|
// Constructor properties interface
|
|
@@ -2706,12 +2898,15 @@ export namespace Atspi {
|
|
|
2706
2898
|
* to the user, but to be an id which is stable over application development.
|
|
2707
2899
|
* Typically, this is the gtkbuilder id.
|
|
2708
2900
|
* @returns a character string representing the accessible id of the {@link Atspi.Accessible} object or NULL on exception.
|
|
2901
|
+
* @since 2.34
|
|
2902
|
+
* @throws GLib.Error
|
|
2709
2903
|
*/
|
|
2710
2904
|
get_accessible_id(): string;
|
|
2711
2905
|
|
|
2712
2906
|
/**
|
|
2713
2907
|
* Gets the {@link Atspi.Action} interface for an {@link Atspi.Accessible}.
|
|
2714
2908
|
* @returns a pointer to an {@link Atspi.Action} interface instance, or NULL if `obj` does not implement {@link Atspi.Action}.
|
|
2909
|
+
* @deprecated since 2.10: Use atspi_accessible_get_action_iface instead.
|
|
2715
2910
|
*/
|
|
2716
2911
|
get_action(): Action;
|
|
2717
2912
|
|
|
@@ -2724,6 +2919,7 @@ export namespace Atspi {
|
|
|
2724
2919
|
/**
|
|
2725
2920
|
* Gets the containing {@link Atspi.Application} for an object.
|
|
2726
2921
|
* @returns the containing {@link Atspi.Application} instance for this object.
|
|
2922
|
+
* @throws GLib.Error
|
|
2727
2923
|
*/
|
|
2728
2924
|
get_application(): Accessible;
|
|
2729
2925
|
|
|
@@ -2732,6 +2928,7 @@ export namespace Atspi {
|
|
|
2732
2928
|
* pointed to by the {@link Atspi.Accessible} object.
|
|
2733
2929
|
* Only works on application root objects.
|
|
2734
2930
|
* @returns a UTF-8 string indicating the AT-SPI version for the {@link Atspi.Accessible} object or NULL on exception.
|
|
2931
|
+
* @throws GLib.Error
|
|
2735
2932
|
*/
|
|
2736
2933
|
get_atspi_version(): string;
|
|
2737
2934
|
|
|
@@ -2741,6 +2938,7 @@ export namespace Atspi {
|
|
|
2741
2938
|
* For typographic, textual, or textually-semantic attributes, see
|
|
2742
2939
|
* atspi_text_get_attributes instead.
|
|
2743
2940
|
* @returns The name-value-pair attributes assigned to this object.
|
|
2941
|
+
* @throws GLib.Error
|
|
2744
2942
|
*/
|
|
2745
2943
|
get_attributes(): { [key: string]: string };
|
|
2746
2944
|
|
|
@@ -2750,6 +2948,7 @@ export namespace Atspi {
|
|
|
2750
2948
|
* For typographic, textual, or textually-semantic attributes, see
|
|
2751
2949
|
* atspi_text_get_attributes_as_array instead.
|
|
2752
2950
|
* @returns The name-value-pair attributes assigned to this object.
|
|
2951
|
+
* @throws GLib.Error
|
|
2753
2952
|
*/
|
|
2754
2953
|
get_attributes_as_array(): string[];
|
|
2755
2954
|
|
|
@@ -2757,18 +2956,21 @@ export namespace Atspi {
|
|
|
2757
2956
|
* Gets the {@link Atspi.Accessible} child of an {@link Atspi.Accessible} object at a given index.
|
|
2758
2957
|
* @param child_index a #long indicating which child is specified.
|
|
2759
2958
|
* @returns a pointer to the {@link Atspi.Accessible} child object at index `child_index` or NULL on exception.
|
|
2959
|
+
* @throws GLib.Error
|
|
2760
2960
|
*/
|
|
2761
2961
|
get_child_at_index(child_index: number): Accessible;
|
|
2762
2962
|
|
|
2763
2963
|
/**
|
|
2764
2964
|
* Gets the number of children contained by an {@link Atspi.Accessible} object.
|
|
2765
2965
|
* @returns a #long indicating the number of {@link Atspi.Accessible} children contained by an {@link Atspi.Accessible} object or -1 on exception.
|
|
2966
|
+
* @throws GLib.Error
|
|
2766
2967
|
*/
|
|
2767
2968
|
get_child_count(): number;
|
|
2768
2969
|
|
|
2769
2970
|
/**
|
|
2770
2971
|
* Gets the {@link Atspi.Collection} interface for an {@link Atspi.Accessible}.
|
|
2771
2972
|
* @returns a pointer to an {@link Atspi.Collection} interface instance, or NULL if `obj` does not implement {@link Atspi.Collection}.
|
|
2973
|
+
* @deprecated since 2.10: Use atspi_accessible_get_collection_iface instead.
|
|
2772
2974
|
*/
|
|
2773
2975
|
get_collection(): Collection;
|
|
2774
2976
|
|
|
@@ -2781,6 +2983,7 @@ export namespace Atspi {
|
|
|
2781
2983
|
/**
|
|
2782
2984
|
* Gets the {@link Atspi.Component} interface for an {@link Atspi.Accessible}.
|
|
2783
2985
|
* @returns a pointer to an {@link Atspi.Component} interface instance, or NULL if `obj` does not implement {@link Atspi.Component}.
|
|
2986
|
+
* @deprecated since 2.10: Use atspi_accessible_get_component_iface instead.
|
|
2784
2987
|
*/
|
|
2785
2988
|
get_component(): Component;
|
|
2786
2989
|
|
|
@@ -2793,12 +2996,14 @@ export namespace Atspi {
|
|
|
2793
2996
|
/**
|
|
2794
2997
|
* Gets the description of an {@link Atspi.Accessible} object.
|
|
2795
2998
|
* @returns a UTF-8 string describing the {@link Atspi.Accessible} object or NULL on exception.
|
|
2999
|
+
* @throws GLib.Error
|
|
2796
3000
|
*/
|
|
2797
3001
|
get_description(): string;
|
|
2798
3002
|
|
|
2799
3003
|
/**
|
|
2800
3004
|
* Gets the {@link Atspi.Document} interface for an {@link Atspi.Accessible}.
|
|
2801
3005
|
* @returns a pointer to an {@link Atspi.Document} interface instance, or NULL if `obj` does not implement {@link Atspi.Document}.
|
|
3006
|
+
* @deprecated since 2.10: Use atspi_accessible_get_document_iface instead.
|
|
2802
3007
|
*/
|
|
2803
3008
|
get_document(): Document;
|
|
2804
3009
|
|
|
@@ -2811,6 +3016,7 @@ export namespace Atspi {
|
|
|
2811
3016
|
/**
|
|
2812
3017
|
* Gets the {@link Atspi.EditableText} interface for an {@link Atspi.Accessible}.
|
|
2813
3018
|
* @returns a pointer to an {@link Atspi.EditableText} interface instance, or NULL if `obj` does not implement {@link Atspi.EditableText}.
|
|
3019
|
+
* @deprecated since 2.10: Use atspi_accessible_get_editable_text_iface instead.
|
|
2814
3020
|
*/
|
|
2815
3021
|
get_editable_text(): EditableText;
|
|
2816
3022
|
|
|
@@ -2825,6 +3031,8 @@ export namespace Atspi {
|
|
|
2825
3031
|
* present, it provides information that a screen reader can relay to the user
|
|
2826
3032
|
* to explain how to interact with the object.
|
|
2827
3033
|
* @returns a character string representing the help text for the {@link Atspi.Accessible} object or NULL on exception.
|
|
3034
|
+
* @since 2.52
|
|
3035
|
+
* @throws GLib.Error
|
|
2828
3036
|
*/
|
|
2829
3037
|
get_help_text(): string;
|
|
2830
3038
|
|
|
@@ -2837,6 +3045,7 @@ export namespace Atspi {
|
|
|
2837
3045
|
/**
|
|
2838
3046
|
* Gets the {@link Atspi.Hypertext} interface for an {@link Atspi.Accessible}.
|
|
2839
3047
|
* @returns a pointer to an {@link Atspi.Hypertext} interface instance, or NULL if `obj` does not implement {@link Atspi.Hypertext}.
|
|
3048
|
+
* @deprecated since 2.10: Use atspi_accessible_get_hypertext_iface instead.
|
|
2840
3049
|
*/
|
|
2841
3050
|
get_hypertext(): Hypertext;
|
|
2842
3051
|
|
|
@@ -2850,12 +3059,14 @@ export namespace Atspi {
|
|
|
2850
3059
|
* Gets the application id for a {@link Atspi.Accessible} object.
|
|
2851
3060
|
* Only works on application root objects.
|
|
2852
3061
|
* @returns a positive `gint` indicating the id for the {@link Atspi.Accessible} object or -1 on exception.
|
|
3062
|
+
* @throws GLib.Error
|
|
2853
3063
|
*/
|
|
2854
3064
|
get_id(): number;
|
|
2855
3065
|
|
|
2856
3066
|
/**
|
|
2857
3067
|
* Gets the {@link Atspi.Image} interface for an {@link Atspi.Accessible}.
|
|
2858
3068
|
* @returns a pointer to an {@link Atspi.Image} interface instance, or NULL if `obj` does not implement {@link Atspi.Image}.
|
|
3069
|
+
* @deprecated since 2.10: Use atspi_accessible_get_image_iface instead.
|
|
2859
3070
|
*/
|
|
2860
3071
|
get_image(): Image;
|
|
2861
3072
|
|
|
@@ -2869,6 +3080,7 @@ export namespace Atspi {
|
|
|
2869
3080
|
* Gets the index of an {@link Atspi.Accessible} object within its parent's
|
|
2870
3081
|
* {@link Atspi.Accessible} children list.
|
|
2871
3082
|
* @returns a `glong` indicating the index of the {@link Atspi.Accessible} object in its parent, or -1 if `obj` has no containing parent or on exception.
|
|
3083
|
+
* @throws GLib.Error
|
|
2872
3084
|
*/
|
|
2873
3085
|
get_index_in_parent(): number;
|
|
2874
3086
|
|
|
@@ -2884,20 +3096,26 @@ export namespace Atspi {
|
|
|
2884
3096
|
* This method will return useful values for roles that fall outside the
|
|
2885
3097
|
* enumeration used in atspi_accessible_getRole ().
|
|
2886
3098
|
* @returns a localized, UTF-8 string specifying the type of UI role played by an {@link Atspi.Accessible} object.
|
|
3099
|
+
* @throws GLib.Error
|
|
2887
3100
|
*/
|
|
2888
3101
|
get_localized_role_name(): string;
|
|
2889
3102
|
|
|
2890
3103
|
/**
|
|
2891
3104
|
* Gets the name of an {@link Atspi.Accessible} object.
|
|
2892
3105
|
* @returns a UTF-8 string indicating the name of the {@link Atspi.Accessible} object or NULL on exception.
|
|
3106
|
+
* @throws GLib.Error
|
|
2893
3107
|
*/
|
|
2894
3108
|
get_name(): string;
|
|
2895
3109
|
|
|
3110
|
+
/**
|
|
3111
|
+
* @throws GLib.Error
|
|
3112
|
+
*/
|
|
2896
3113
|
get_object_locale(): string;
|
|
2897
3114
|
|
|
2898
3115
|
/**
|
|
2899
3116
|
* Gets an {@link Atspi.Accessible} object's parent container.
|
|
2900
3117
|
* @returns a pointer to the {@link Atspi.Accessible} object which contains the given {@link Atspi.Accessible} instance, or NULL if the `obj` has no parent container.
|
|
3118
|
+
* @throws GLib.Error
|
|
2901
3119
|
*/
|
|
2902
3120
|
get_parent(): Accessible | null;
|
|
2903
3121
|
|
|
@@ -2906,6 +3124,7 @@ export namespace Atspi {
|
|
|
2906
3124
|
* added for debugging; it is a shortcut to explicitly querying the
|
|
2907
3125
|
* accessible's app->bus_name and then calling GetConnectionUnixProcessID.
|
|
2908
3126
|
* @returns The process ID or undetermined value if `error` is set.
|
|
3127
|
+
* @throws GLib.Error
|
|
2909
3128
|
*/
|
|
2910
3129
|
get_process_id(): number;
|
|
2911
3130
|
|
|
@@ -2913,6 +3132,7 @@ export namespace Atspi {
|
|
|
2913
3132
|
* Gets the set of {@link Atspi.Relation} objects which describes this {@link Atspi.Accessible} object's
|
|
2914
3133
|
* relationships with other {@link Atspi.Accessible} objects.
|
|
2915
3134
|
* @returns a {@link GLib.Array} of {@link Atspi.Relation} pointers or NULL on exception.
|
|
3135
|
+
* @throws GLib.Error
|
|
2916
3136
|
*/
|
|
2917
3137
|
get_relation_set(): Relation[];
|
|
2918
3138
|
|
|
@@ -2920,6 +3140,7 @@ export namespace Atspi {
|
|
|
2920
3140
|
* Gets the UI role played by an {@link Atspi.Accessible} object.
|
|
2921
3141
|
* This role's name can be obtained via atspi_accessible_get_role_name ().
|
|
2922
3142
|
* @returns the {@link Atspi.Role} of an {@link Atspi.Accessible} object.
|
|
3143
|
+
* @throws GLib.Error
|
|
2923
3144
|
*/
|
|
2924
3145
|
get_role(): Role;
|
|
2925
3146
|
|
|
@@ -2928,12 +3149,14 @@ export namespace Atspi {
|
|
|
2928
3149
|
* This method will return useful values for roles that fall outside the
|
|
2929
3150
|
* enumeration used in atspi_accessible_get_role ().
|
|
2930
3151
|
* @returns a UTF-8 string specifying the type of UI role played by an {@link Atspi.Accessible} object.
|
|
3152
|
+
* @throws GLib.Error
|
|
2931
3153
|
*/
|
|
2932
3154
|
get_role_name(): string;
|
|
2933
3155
|
|
|
2934
3156
|
/**
|
|
2935
3157
|
* Gets the {@link Atspi.Selection} interface for an {@link Atspi.Accessible}.
|
|
2936
3158
|
* @returns a pointer to an {@link Atspi.Selection} interface instance, or NULL if `obj` does not implement {@link Atspi.Selection}.
|
|
3159
|
+
* @deprecated since 2.10: Use atspi_accessible_get_selection_iface instead.
|
|
2937
3160
|
*/
|
|
2938
3161
|
get_selection(): Selection;
|
|
2939
3162
|
|
|
@@ -2958,6 +3181,7 @@ export namespace Atspi {
|
|
|
2958
3181
|
/**
|
|
2959
3182
|
* Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
|
|
2960
3183
|
* @returns a pointer to an {@link Atspi.Table} interface instance, or NULL if `obj` does not implement {@link Atspi.Table}.
|
|
3184
|
+
* @deprecated since 2.10: Use atspi_accessible_get_table_iface instead.
|
|
2961
3185
|
*/
|
|
2962
3186
|
get_table(): Table;
|
|
2963
3187
|
|
|
@@ -2982,6 +3206,7 @@ export namespace Atspi {
|
|
|
2982
3206
|
/**
|
|
2983
3207
|
* Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
|
|
2984
3208
|
* @returns a pointer to an {@link Atspi.Text} interface instance, or NULL if `obj` does not implement {@link Atspi.Text}.
|
|
3209
|
+
* @deprecated since 2.10: Use atspi_accessible_get_text_iface instead.
|
|
2985
3210
|
*/
|
|
2986
3211
|
get_text(): Text;
|
|
2987
3212
|
|
|
@@ -3001,6 +3226,7 @@ export namespace Atspi {
|
|
|
3001
3226
|
* Gets the toolkit name for an {@link Atspi.Accessible} object.
|
|
3002
3227
|
* Only works on application root objects.
|
|
3003
3228
|
* @returns a UTF-8 string indicating the toolkit name for the {@link Atspi.Accessible} object or NULL on exception.
|
|
3229
|
+
* @throws GLib.Error
|
|
3004
3230
|
*/
|
|
3005
3231
|
get_toolkit_name(): string;
|
|
3006
3232
|
|
|
@@ -3008,12 +3234,14 @@ export namespace Atspi {
|
|
|
3008
3234
|
* Gets the toolkit version for an {@link Atspi.Accessible} object.
|
|
3009
3235
|
* Only works on application root objects.
|
|
3010
3236
|
* @returns a UTF-8 string indicating the toolkit version for the {@link Atspi.Accessible} object or NULL on exception.
|
|
3237
|
+
* @throws GLib.Error
|
|
3011
3238
|
*/
|
|
3012
3239
|
get_toolkit_version(): string;
|
|
3013
3240
|
|
|
3014
3241
|
/**
|
|
3015
3242
|
* Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
|
|
3016
3243
|
* @returns a pointer to an {@link Atspi.Value} interface instance, or NULL if `obj` does not implement {@link Atspi.Value}.
|
|
3244
|
+
* @deprecated since 2.10: Use atspi_accessible_get_value_iface instead.
|
|
3017
3245
|
*/
|
|
3018
3246
|
get_value(): Value;
|
|
3019
3247
|
|
|
@@ -3136,6 +3364,7 @@ export namespace Atspi {
|
|
|
3136
3364
|
* Invoke the action indicated by #index.
|
|
3137
3365
|
* @param i an integer specifying which action to invoke.
|
|
3138
3366
|
* @returns `TRUE` if the action is successfully invoked, otherwise `FALSE`.
|
|
3367
|
+
* @throws GLib.Error
|
|
3139
3368
|
*/
|
|
3140
3369
|
do_action(i: number): boolean;
|
|
3141
3370
|
|
|
@@ -3144,6 +3373,8 @@ export namespace Atspi {
|
|
|
3144
3373
|
* object implementing {@link Atspi.Action}.
|
|
3145
3374
|
* @param i an integer indicating which action to query.
|
|
3146
3375
|
* @returns a UTF-8 string describing the '`i`-th' invocable action.
|
|
3376
|
+
* @deprecated since 2.10: Use atspi_action_get_action_description instead.
|
|
3377
|
+
* @throws GLib.Error
|
|
3147
3378
|
*/
|
|
3148
3379
|
get_action_description(i: number): string;
|
|
3149
3380
|
|
|
@@ -3171,6 +3402,7 @@ export namespace Atspi {
|
|
|
3171
3402
|
* gtk+-2.X.
|
|
3172
3403
|
* @param i an integer indicating which action to query.
|
|
3173
3404
|
* @returns a UTF-8 string which can be parsed to determine the `i`-th invocable action's keybindings.
|
|
3405
|
+
* @throws GLib.Error
|
|
3174
3406
|
*/
|
|
3175
3407
|
get_key_binding(i: number): string;
|
|
3176
3408
|
|
|
@@ -3179,12 +3411,14 @@ export namespace Atspi {
|
|
|
3179
3411
|
* object implementing {@link Atspi.Action}.
|
|
3180
3412
|
* @param i an integer indicating which action to query.
|
|
3181
3413
|
* @returns the name of the action, as a UTF-8 string.
|
|
3414
|
+
* @throws GLib.Error
|
|
3182
3415
|
*/
|
|
3183
3416
|
get_localized_name(i: number): string;
|
|
3184
3417
|
|
|
3185
3418
|
/**
|
|
3186
3419
|
* Get the number of actions invokable on an {@link Atspi.Action} implementor.
|
|
3187
3420
|
* @returns an integer indicating the number of invocable actions.
|
|
3421
|
+
* @throws GLib.Error
|
|
3188
3422
|
*/
|
|
3189
3423
|
get_n_actions(): number;
|
|
3190
3424
|
|
|
@@ -3193,11 +3427,14 @@ export namespace Atspi {
|
|
|
3193
3427
|
* object implementing {@link Atspi.Action}.
|
|
3194
3428
|
* @param i an integer indicating which action to query.
|
|
3195
3429
|
* @returns the non-localized name of the action, as a UTF-8 string.
|
|
3430
|
+
* @deprecated since 2.10: Use atspi_action_get_action_name instead.
|
|
3431
|
+
* @throws GLib.Error
|
|
3196
3432
|
*/
|
|
3197
3433
|
get_action_name(i: number): string;
|
|
3198
3434
|
|
|
3199
3435
|
/**
|
|
3200
3436
|
* @returns The active descendant of the given object. Not yet implemented.
|
|
3437
|
+
* @throws GLib.Error
|
|
3201
3438
|
*/
|
|
3202
3439
|
get_active_descendant(): Accessible;
|
|
3203
3440
|
|
|
@@ -3209,6 +3446,7 @@ export namespace Atspi {
|
|
|
3209
3446
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
3210
3447
|
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
3211
3448
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule.
|
|
3449
|
+
* @throws GLib.Error
|
|
3212
3450
|
*/
|
|
3213
3451
|
get_matches(rule: MatchRule, sortby: CollectionSortOrder, count: number, traverse: boolean): Accessible[];
|
|
3214
3452
|
|
|
@@ -3222,6 +3460,7 @@ export namespace Atspi {
|
|
|
3222
3460
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
3223
3461
|
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
3224
3462
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule that preceed `current_object`.
|
|
3463
|
+
* @throws GLib.Error
|
|
3225
3464
|
*/
|
|
3226
3465
|
get_matches_from(current_object: Accessible, rule: MatchRule, sortby: CollectionSortOrder, tree: CollectionTreeTraversalType, count: number, traverse: boolean): Accessible[];
|
|
3227
3466
|
|
|
@@ -3236,12 +3475,14 @@ export namespace Atspi {
|
|
|
3236
3475
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
3237
3476
|
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
3238
3477
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule after `current_object`.
|
|
3478
|
+
* @throws GLib.Error
|
|
3239
3479
|
*/
|
|
3240
3480
|
get_matches_to(current_object: Accessible, rule: MatchRule, sortby: CollectionSortOrder, tree: CollectionTreeTraversalType, limit_scope: boolean, count: number, traverse: boolean): Accessible[];
|
|
3241
3481
|
|
|
3242
3482
|
/**
|
|
3243
3483
|
* Not yet implemented.
|
|
3244
3484
|
* @param test
|
|
3485
|
+
* @throws GLib.Error
|
|
3245
3486
|
*/
|
|
3246
3487
|
is_ancestor_of(test: Accessible): boolean;
|
|
3247
3488
|
|
|
@@ -3251,6 +3492,7 @@ export namespace Atspi {
|
|
|
3251
3492
|
* @param y a `gint` specifying the y coordinate in question.
|
|
3252
3493
|
* @param ctype the desired coordinate system of the point (`x`, `y`) (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
|
|
3253
3494
|
* @returns `TRUE` if the specified component contains the point (`x`, `y`), `FALSE` otherwise.
|
|
3495
|
+
* @throws GLib.Error
|
|
3254
3496
|
*/
|
|
3255
3497
|
contains(x: number, y: number, ctype: CoordType): boolean;
|
|
3256
3498
|
|
|
@@ -3260,12 +3502,14 @@ export namespace Atspi {
|
|
|
3260
3502
|
* @param y a `gint` specifying the y coordinate of the point in question.
|
|
3261
3503
|
* @param ctype the coordinate system of the point (`x`, `y`) (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
3262
3504
|
* @returns a pointer to an {@link Atspi.Accessible} child of the specified component which contains the point (`x`, `y`), or NULL if no child contains the point.
|
|
3505
|
+
* @throws GLib.Error
|
|
3263
3506
|
*/
|
|
3264
3507
|
get_accessible_at_point(x: number, y: number, ctype: CoordType): Accessible | null;
|
|
3265
3508
|
|
|
3266
3509
|
/**
|
|
3267
3510
|
* Gets the opacity/alpha value of a component, if alpha blending is in use.
|
|
3268
3511
|
* @returns the opacity value of a component, as a `gdouble` between 0.0 and 1.0.
|
|
3512
|
+
* @throws GLib.Error
|
|
3269
3513
|
*/
|
|
3270
3514
|
get_alpha(): number;
|
|
3271
3515
|
|
|
@@ -3275,6 +3519,7 @@ export namespace Atspi {
|
|
|
3275
3519
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
3276
3520
|
* @param ctype the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
3277
3521
|
* @returns An {@link Atspi.Rect} giving the accessible's extents.
|
|
3522
|
+
* @throws GLib.Error
|
|
3278
3523
|
*/
|
|
3279
3524
|
get_extents(ctype: CoordType): Rect;
|
|
3280
3525
|
|
|
@@ -3282,6 +3527,7 @@ export namespace Atspi {
|
|
|
3282
3527
|
* Queries which layer the component is painted into, to help determine its
|
|
3283
3528
|
* visibility in terms of stacking order.
|
|
3284
3529
|
* @returns the {@link Atspi.ComponentLayer} into which this component is painted.
|
|
3530
|
+
* @throws GLib.Error
|
|
3285
3531
|
*/
|
|
3286
3532
|
get_layer(): ComponentLayer;
|
|
3287
3533
|
|
|
@@ -3289,6 +3535,7 @@ export namespace Atspi {
|
|
|
3289
3535
|
* Queries the z stacking order of a component which is in the MDI or window
|
|
3290
3536
|
* layer. (Bigger z-order numbers mean nearer the top)
|
|
3291
3537
|
* @returns a `gshort` indicating the stacking order of the component in the MDI layer, or -1 if the component is not in the MDI layer.
|
|
3538
|
+
* @throws GLib.Error
|
|
3292
3539
|
*/
|
|
3293
3540
|
get_mdi_z_order(): number;
|
|
3294
3541
|
|
|
@@ -3298,6 +3545,7 @@ export namespace Atspi {
|
|
|
3298
3545
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
3299
3546
|
* @param ctype the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
3300
3547
|
* @returns An {@link Atspi.Point} giving the `obj`'s position.
|
|
3548
|
+
* @throws GLib.Error
|
|
3301
3549
|
*/
|
|
3302
3550
|
get_position(ctype: CoordType): Point;
|
|
3303
3551
|
|
|
@@ -3312,6 +3560,7 @@ export namespace Atspi {
|
|
|
3312
3560
|
* The returned values are meaningful only if the Component has both
|
|
3313
3561
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
3314
3562
|
* @returns An {@link Atspi.Point} giving the `obj`'s size.
|
|
3563
|
+
* @throws GLib.Error
|
|
3315
3564
|
*/
|
|
3316
3565
|
get_size(): Point;
|
|
3317
3566
|
|
|
@@ -3319,6 +3568,7 @@ export namespace Atspi {
|
|
|
3319
3568
|
* Attempts to set the keyboard input focus to the specified
|
|
3320
3569
|
* {@link Atspi.Component}.
|
|
3321
3570
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
3571
|
+
* @throws GLib.Error
|
|
3322
3572
|
*/
|
|
3323
3573
|
grab_focus(): boolean;
|
|
3324
3574
|
|
|
@@ -3327,6 +3577,7 @@ export namespace Atspi {
|
|
|
3327
3577
|
* visible on the screen.
|
|
3328
3578
|
* @param type a {@link Atspi.ScrollType} indicating where the object should be placed on the screen.
|
|
3329
3579
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
3580
|
+
* @throws GLib.Error
|
|
3330
3581
|
*/
|
|
3331
3582
|
scroll_to(type: ScrollType): boolean;
|
|
3332
3583
|
|
|
@@ -3337,6 +3588,7 @@ export namespace Atspi {
|
|
|
3337
3588
|
* @param x the x coordinate of the point to reach
|
|
3338
3589
|
* @param y the y coordinate of the point to reach
|
|
3339
3590
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
3591
|
+
* @throws GLib.Error
|
|
3340
3592
|
*/
|
|
3341
3593
|
scroll_to_point(coords: CoordType, x: number, y: number): boolean;
|
|
3342
3594
|
|
|
@@ -3348,6 +3600,7 @@ export namespace Atspi {
|
|
|
3348
3600
|
* @param height the height to which the component should be resized.
|
|
3349
3601
|
* @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
3350
3602
|
* @returns `TRUE` if successful; `FALSE` otherwise.
|
|
3603
|
+
* @throws GLib.Error
|
|
3351
3604
|
*/
|
|
3352
3605
|
set_extents(x: number, y: number, width: number, height: number, ctype: CoordType): boolean;
|
|
3353
3606
|
|
|
@@ -3357,6 +3610,7 @@ export namespace Atspi {
|
|
|
3357
3610
|
* @param y the new vertical position to which the component should be moved.
|
|
3358
3611
|
* @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
3359
3612
|
* @returns `TRUE` if successful; `FALSE` otherwise.
|
|
3613
|
+
* @throws GLib.Error
|
|
3360
3614
|
*/
|
|
3361
3615
|
set_position(x: number, y: number, ctype: CoordType): boolean;
|
|
3362
3616
|
|
|
@@ -3365,6 +3619,7 @@ export namespace Atspi {
|
|
|
3365
3619
|
* @param width the width to which the component should be resized.
|
|
3366
3620
|
* @param height the height to which the component should be resized.
|
|
3367
3621
|
* @returns `TRUE` if successful; `FALSE` otherwise.
|
|
3622
|
+
* @throws GLib.Error
|
|
3368
3623
|
*/
|
|
3369
3624
|
set_size(width: number, height: number): boolean;
|
|
3370
3625
|
|
|
@@ -3372,6 +3627,8 @@ export namespace Atspi {
|
|
|
3372
3627
|
* Gets the value of a single attribute, if specified for the document as a whole.
|
|
3373
3628
|
* @param attribute a string indicating the name of a specific attribute.
|
|
3374
3629
|
* @returns a string corresponding to the value of the specified attribute, or an empty string if the attribute is unspecified for the object.
|
|
3630
|
+
* @deprecated since 2.10: Use atspi_document_get_document_attribute_value instead.
|
|
3631
|
+
* @throws GLib.Error
|
|
3375
3632
|
*/
|
|
3376
3633
|
get_document_attribute_value(attribute: string): string;
|
|
3377
3634
|
|
|
@@ -3379,12 +3636,15 @@ export namespace Atspi {
|
|
|
3379
3636
|
* Gets all constant attributes for the document as a whole. For attributes
|
|
3380
3637
|
* that change within the document content, see `atspi_text_get_attribute_run` instead.
|
|
3381
3638
|
* @returns a {@link GLib.HashTable} containing the constant attributes of the document, as name-value pairs.
|
|
3639
|
+
* @deprecated since 2.10: Use atspi_document_get_document_attributes instead.
|
|
3640
|
+
* @throws GLib.Error
|
|
3382
3641
|
*/
|
|
3383
3642
|
get_document_attributes(): { [key: string]: string };
|
|
3384
3643
|
|
|
3385
3644
|
/**
|
|
3386
3645
|
* Gets the current page number of an `AccessibleDocument` object.
|
|
3387
3646
|
* @returns a `gint` indicating the current page number in the `AccessibleDocument` object.
|
|
3647
|
+
* @throws GLib.Error
|
|
3388
3648
|
*/
|
|
3389
3649
|
get_current_page_number(): number;
|
|
3390
3650
|
|
|
@@ -3392,18 +3652,22 @@ export namespace Atspi {
|
|
|
3392
3652
|
* Gets the locale associated with the document's content,
|
|
3393
3653
|
* e.g. the locale for LOCALE_TYPE_MESSAGES.
|
|
3394
3654
|
* @returns a string compliant with the POSIX standard for locale description.
|
|
3655
|
+
* @throws GLib.Error
|
|
3395
3656
|
*/
|
|
3396
3657
|
get_locale(): string;
|
|
3397
3658
|
|
|
3398
3659
|
/**
|
|
3399
3660
|
* Gets the page count of an `AccessibleDocument` object.
|
|
3400
3661
|
* @returns a `gint` indicating the page count of an `AccessibleDocument` object.
|
|
3662
|
+
* @throws GLib.Error
|
|
3401
3663
|
*/
|
|
3402
3664
|
get_page_count(): number;
|
|
3403
3665
|
|
|
3404
3666
|
/**
|
|
3405
3667
|
* Returns an array of AtspiTextSelections within this document.
|
|
3406
3668
|
* @returns a GArray of AtspiTextSelection structures representing the selection.
|
|
3669
|
+
* @since 2.52
|
|
3670
|
+
* @throws GLib.Error
|
|
3407
3671
|
*/
|
|
3408
3672
|
get_text_selections(): TextSelection[];
|
|
3409
3673
|
|
|
@@ -3415,6 +3679,8 @@ export namespace Atspi {
|
|
|
3415
3679
|
* FALSE will be returned.
|
|
3416
3680
|
* @param selections a GArray of AtspiTextSelections to be selected.
|
|
3417
3681
|
* @returns TRUE if the selection was made successfully; FALSE otherwise.
|
|
3682
|
+
* @since 2.52
|
|
3683
|
+
* @throws GLib.Error
|
|
3418
3684
|
*/
|
|
3419
3685
|
set_text_selections(selections: TextSelection[]): boolean;
|
|
3420
3686
|
|
|
@@ -3425,6 +3691,7 @@ export namespace Atspi {
|
|
|
3425
3691
|
* @param start_pos a `gint` indicating the starting character offset of the text to copy.
|
|
3426
3692
|
* @param end_pos a `gint` indicating the offset of the first character past the end of the text section to be copied.
|
|
3427
3693
|
* @returns `TRUE` if the operation was successful, otherwise `FALSE`.
|
|
3694
|
+
* @throws GLib.Error
|
|
3428
3695
|
*/
|
|
3429
3696
|
copy_text(start_pos: number, end_pos: number): boolean;
|
|
3430
3697
|
|
|
@@ -3436,6 +3703,7 @@ export namespace Atspi {
|
|
|
3436
3703
|
* @param start_pos a `gint` indicating the starting character offset of the text to cut.
|
|
3437
3704
|
* @param end_pos a `gint` indicating the offset of the first character past the end of the text section to be cut.
|
|
3438
3705
|
* @returns `TRUE` if operation was successful, `FALSE` otherwise.
|
|
3706
|
+
* @throws GLib.Error
|
|
3439
3707
|
*/
|
|
3440
3708
|
cut_text(start_pos: number, end_pos: number): boolean;
|
|
3441
3709
|
|
|
@@ -3447,6 +3715,7 @@ export namespace Atspi {
|
|
|
3447
3715
|
* @param start_pos a `gint` indicating the starting character offset of the text to delete.
|
|
3448
3716
|
* @param end_pos a `gint` indicating the offset of the first character past the end of the text section to be deleted.
|
|
3449
3717
|
* @returns `TRUE` if the operation was successful, otherwise `FALSE`.
|
|
3718
|
+
* @throws GLib.Error
|
|
3450
3719
|
*/
|
|
3451
3720
|
delete_text(start_pos: number, end_pos: number): boolean;
|
|
3452
3721
|
|
|
@@ -3459,6 +3728,7 @@ export namespace Atspi {
|
|
|
3459
3728
|
* @param text a string representing the text to insert, in UTF-8 encoding.
|
|
3460
3729
|
* @param length the number of characters of text to insert, in bytes. If the byte count of text is less than or equal to length, the entire contents of text will be inserted.
|
|
3461
3730
|
* @returns `TRUE` if the operation was successful, otherwise `FALSE`.
|
|
3731
|
+
* @throws GLib.Error
|
|
3462
3732
|
*/
|
|
3463
3733
|
insert_text(position: number, text: string, length: number): boolean;
|
|
3464
3734
|
|
|
@@ -3469,6 +3739,7 @@ export namespace Atspi {
|
|
|
3469
3739
|
* variable-width encoding.
|
|
3470
3740
|
* @param position a `gint` indicating the character offset at which to insert the new text.
|
|
3471
3741
|
* @returns `TRUE` if the operation was successful, otherwise `FALSE`.
|
|
3742
|
+
* @throws GLib.Error
|
|
3472
3743
|
*/
|
|
3473
3744
|
paste_text(position: number): boolean;
|
|
3474
3745
|
|
|
@@ -3476,6 +3747,7 @@ export namespace Atspi {
|
|
|
3476
3747
|
* Replace the entire text contents of an {@link Atspi.EditableText} object.
|
|
3477
3748
|
* @param new_contents a character string, encoded in UTF-8, which is to become the new text contents of the {@link Atspi.EditableText} object.
|
|
3478
3749
|
* @returns `TRUE` if the operation was successful, otherwise `FALSE`.
|
|
3750
|
+
* @throws GLib.Error
|
|
3479
3751
|
*/
|
|
3480
3752
|
set_text_contents(new_contents: string): boolean;
|
|
3481
3753
|
|
|
@@ -3483,6 +3755,7 @@ export namespace Atspi {
|
|
|
3483
3755
|
* Gets the {@link Atspi.Hyperlink} object at a specified index.
|
|
3484
3756
|
* @param link_index a (zero-index) `gint` indicating which hyperlink to query.
|
|
3485
3757
|
* @returns the {@link Atspi.Hyperlink} object specified by `link_index`.
|
|
3758
|
+
* @throws GLib.Error
|
|
3486
3759
|
*/
|
|
3487
3760
|
get_link(link_index: number): Hyperlink | null;
|
|
3488
3761
|
|
|
@@ -3491,6 +3764,7 @@ export namespace Atspi {
|
|
|
3491
3764
|
* character offset.
|
|
3492
3765
|
* @param character_offset a `gint` specifying the character offset to query.
|
|
3493
3766
|
* @returns the linkIndex of the {@link Atspi.Hyperlink} active at character offset `character_offset`, or -1 if there is no hyperlink at the specified character offset.
|
|
3767
|
+
* @throws GLib.Error
|
|
3494
3768
|
*/
|
|
3495
3769
|
get_link_index(character_offset: number): number;
|
|
3496
3770
|
|
|
@@ -3498,12 +3772,14 @@ export namespace Atspi {
|
|
|
3498
3772
|
* Gets the total number of {@link Atspi.Hyperlink} objects that an
|
|
3499
3773
|
* {@link Atspi.Hypertext} implementor has.
|
|
3500
3774
|
* @returns a `gint` indicating the number of {@link Atspi.Hyperlink} objects of the {@link Atspi.Hypertext} implementor, or -1 if the number cannot be determined (for example, if the {@link Atspi.Hypertext} object is so large that it is not all currently in the memory cache).
|
|
3775
|
+
* @throws GLib.Error
|
|
3501
3776
|
*/
|
|
3502
3777
|
get_n_links(): number;
|
|
3503
3778
|
|
|
3504
3779
|
/**
|
|
3505
3780
|
* Gets the description of the image displayed in an {@link Atspi.Image} object.
|
|
3506
3781
|
* @returns a UTF-8 string describing the image.
|
|
3782
|
+
* @throws GLib.Error
|
|
3507
3783
|
*/
|
|
3508
3784
|
get_image_description(): string;
|
|
3509
3785
|
|
|
@@ -3514,12 +3790,14 @@ export namespace Atspi {
|
|
|
3514
3790
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
3515
3791
|
* @param ctype the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
3516
3792
|
* @returns a pointer to an {@link Atspi.Rect} corresponding to the image's bounding box. The minimum x and y coordinates, width, and height are specified.
|
|
3793
|
+
* @throws GLib.Error
|
|
3517
3794
|
*/
|
|
3518
3795
|
get_image_extents(ctype: CoordType): Rect;
|
|
3519
3796
|
|
|
3520
3797
|
/**
|
|
3521
3798
|
* Gets the locale associated with an image and its textual representation.
|
|
3522
3799
|
* @returns A POSIX LC_MESSAGES-style locale value for image description and text.
|
|
3800
|
+
* @throws GLib.Error
|
|
3523
3801
|
*/
|
|
3524
3802
|
get_image_locale(): string;
|
|
3525
3803
|
|
|
@@ -3530,6 +3808,7 @@ export namespace Atspi {
|
|
|
3530
3808
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
3531
3809
|
* @param ctype the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
3532
3810
|
* @returns a pointer to an {@link Atspi.Point} where x and y correspond to the minimum coordinates of the displayed image.
|
|
3811
|
+
* @throws GLib.Error
|
|
3533
3812
|
*/
|
|
3534
3813
|
get_image_position(ctype: CoordType): Point;
|
|
3535
3814
|
|
|
@@ -3538,6 +3817,7 @@ export namespace Atspi {
|
|
|
3538
3817
|
* The returned values are meaningful only if the Image has both
|
|
3539
3818
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
3540
3819
|
* @returns a pointer to an {@link Atspi.Point} where x corresponds to the image's width and y corresponds to the image's height.
|
|
3820
|
+
* @throws GLib.Error
|
|
3541
3821
|
*/
|
|
3542
3822
|
get_image_size(): Point;
|
|
3543
3823
|
|
|
@@ -3545,6 +3825,7 @@ export namespace Atspi {
|
|
|
3545
3825
|
* Clears the current selection, removing all selected children from the
|
|
3546
3826
|
* specified {@link Atspi.Selection} implementor's selection list.
|
|
3547
3827
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
3828
|
+
* @throws GLib.Error
|
|
3548
3829
|
*/
|
|
3549
3830
|
clear_selection(): boolean;
|
|
3550
3831
|
|
|
@@ -3556,6 +3837,7 @@ export namespace Atspi {
|
|
|
3556
3837
|
* See `atspi_selection_deselect_selected_child`
|
|
3557
3838
|
* @param child_index a `gint` indicating which of the children of the {@link Atspi.Accessible} is to be de-selected.
|
|
3558
3839
|
* @returns `TRUE` if the child was successfully deselected, `FALSE` otherwise.
|
|
3840
|
+
* @throws GLib.Error
|
|
3559
3841
|
*/
|
|
3560
3842
|
deselect_child(child_index: number): boolean;
|
|
3561
3843
|
|
|
@@ -3567,6 +3849,7 @@ export namespace Atspi {
|
|
|
3567
3849
|
* `atspi_selection_select_child` are asymmetric.
|
|
3568
3850
|
* @param selected_child_index a `gint` indicating which of the selected children of the {@link Atspi.Accessible} is to be deselected.
|
|
3569
3851
|
* @returns `TRUE` if the child was successfully deselected, `FALSE` otherwise.
|
|
3852
|
+
* @throws GLib.Error
|
|
3570
3853
|
*/
|
|
3571
3854
|
deselect_selected_child(selected_child_index: number): boolean;
|
|
3572
3855
|
|
|
@@ -3574,6 +3857,7 @@ export namespace Atspi {
|
|
|
3574
3857
|
* Gets the number of children of an {@link Atspi.Selection} implementor which are
|
|
3575
3858
|
* currently selected.
|
|
3576
3859
|
* @returns a `gint` indicating the number of {@link Atspi.Accessible} children of the {@link Atspi.Selection} implementor which are currently selected.
|
|
3860
|
+
* @throws GLib.Error
|
|
3577
3861
|
*/
|
|
3578
3862
|
get_n_selected_children(): number;
|
|
3579
3863
|
|
|
@@ -3588,6 +3872,7 @@ export namespace Atspi {
|
|
|
3588
3872
|
* and `atspi_selection_get_n_selected_children` - 1, inclusive.
|
|
3589
3873
|
* @param selected_child_index a `gint` indicating which of the selected children is specified.
|
|
3590
3874
|
* @returns a pointer to a selected {@link Atspi.Accessible} child object, specified by `selected_child_index`.
|
|
3875
|
+
* @throws GLib.Error
|
|
3591
3876
|
*/
|
|
3592
3877
|
get_selected_child(selected_child_index: number): Accessible;
|
|
3593
3878
|
|
|
@@ -3597,6 +3882,7 @@ export namespace Atspi {
|
|
|
3597
3882
|
* standard {@link Atspi.Accessible} container's list of children.
|
|
3598
3883
|
* @param child_index an index into the {@link Atspi.Selection}'s list of children.
|
|
3599
3884
|
* @returns `TRUE` if the specified child is currently selected, `FALSE` otherwise.
|
|
3885
|
+
* @throws GLib.Error
|
|
3600
3886
|
*/
|
|
3601
3887
|
is_child_selected(child_index: number): boolean;
|
|
3602
3888
|
|
|
@@ -3604,6 +3890,7 @@ export namespace Atspi {
|
|
|
3604
3890
|
* Attempts to select all of the children of an {@link Atspi.Selection} implementor.
|
|
3605
3891
|
* Not all {@link Atspi.Selection} implementors support this operation.
|
|
3606
3892
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
3893
|
+
* @throws GLib.Error
|
|
3607
3894
|
*/
|
|
3608
3895
|
select_all(): boolean;
|
|
3609
3896
|
|
|
@@ -3614,6 +3901,7 @@ export namespace Atspi {
|
|
|
3614
3901
|
* selection.
|
|
3615
3902
|
* @param child_index a `gint` indicating which child of the {@link Atspi.Accessible} is to be selected.
|
|
3616
3903
|
* @returns `TRUE` if the child was successfully selected, `FALSE` otherwise.
|
|
3904
|
+
* @throws GLib.Error
|
|
3617
3905
|
*/
|
|
3618
3906
|
select_child(child_index: number): boolean;
|
|
3619
3907
|
|
|
@@ -3622,6 +3910,7 @@ export namespace Atspi {
|
|
|
3622
3910
|
* Not all tables support column selection.
|
|
3623
3911
|
* @param column the zero-indexed column number of the column being selected.
|
|
3624
3912
|
* @returns `TRUE` if the specified column was successfully selected, `FALSE` if not.
|
|
3913
|
+
* @throws GLib.Error
|
|
3625
3914
|
*/
|
|
3626
3915
|
add_column_selection(column: number): boolean;
|
|
3627
3916
|
|
|
@@ -3630,6 +3919,7 @@ export namespace Atspi {
|
|
|
3630
3919
|
* Not all tables support row selection.
|
|
3631
3920
|
* @param row the zero-indexed row number of the row being selected.
|
|
3632
3921
|
* @returns `TRUE` if the specified row was successfully selected, `FALSE` if not.
|
|
3922
|
+
* @throws GLib.Error
|
|
3633
3923
|
*/
|
|
3634
3924
|
add_row_selection(row: number): boolean;
|
|
3635
3925
|
|
|
@@ -3640,12 +3930,14 @@ export namespace Atspi {
|
|
|
3640
3930
|
* @param row the specified table row, zero-indexed.
|
|
3641
3931
|
* @param column the specified table column, zero-indexed.
|
|
3642
3932
|
* @returns an {@link Atspi.Accessible} object representing the specified table cell.
|
|
3933
|
+
* @throws GLib.Error
|
|
3643
3934
|
*/
|
|
3644
3935
|
get_accessible_at(row: number, column: number): Accessible;
|
|
3645
3936
|
|
|
3646
3937
|
/**
|
|
3647
3938
|
* Gets an accessible representation of the caption for an {@link Atspi.Table}.
|
|
3648
3939
|
* @returns an {@link Atspi.Accessible} object that serves as the table's caption.
|
|
3940
|
+
* @throws GLib.Error
|
|
3649
3941
|
*/
|
|
3650
3942
|
get_caption(): Accessible;
|
|
3651
3943
|
|
|
@@ -3656,6 +3948,7 @@ export namespace Atspi {
|
|
|
3656
3948
|
* `see` `atspi_table_get_index_at`, `atspi_table_get_row_at_index`
|
|
3657
3949
|
* @param index the specified child index, zero-indexed.
|
|
3658
3950
|
* @returns a `gint` indicating the first column spanned by the child of a table, at the specified 1-D (zero-offset) `index`.
|
|
3951
|
+
* @throws GLib.Error
|
|
3659
3952
|
*/
|
|
3660
3953
|
get_column_at_index(index: number): number;
|
|
3661
3954
|
|
|
@@ -3664,6 +3957,7 @@ export namespace Atspi {
|
|
|
3664
3957
|
* `atspi_table_get_column_header`, which returns an {@link Atspi.Accessible}.
|
|
3665
3958
|
* @param column the specified table column, zero-indexed.
|
|
3666
3959
|
* @returns a UTF-8 string describing the specified table column, if available.
|
|
3960
|
+
* @throws GLib.Error
|
|
3667
3961
|
*/
|
|
3668
3962
|
get_column_description(column: number): string;
|
|
3669
3963
|
|
|
@@ -3676,6 +3970,7 @@ export namespace Atspi {
|
|
|
3676
3970
|
* @param row the specified table row, zero-indexed.
|
|
3677
3971
|
* @param column the specified table column, zero-indexed.
|
|
3678
3972
|
* @returns a `gint` indicating the number of columns spanned by the specified cell.
|
|
3973
|
+
* @throws GLib.Error
|
|
3679
3974
|
*/
|
|
3680
3975
|
get_column_extent_at(row: number, column: number): number;
|
|
3681
3976
|
|
|
@@ -3685,6 +3980,7 @@ export namespace Atspi {
|
|
|
3685
3980
|
* returns a string.
|
|
3686
3981
|
* @param column the specified table column, zero-indexed.
|
|
3687
3982
|
* @returns an {@link Atspi.Accessible} representation of the specified table column, if available.
|
|
3983
|
+
* @throws GLib.Error
|
|
3688
3984
|
*/
|
|
3689
3985
|
get_column_header(column: number): Accessible;
|
|
3690
3986
|
|
|
@@ -3697,6 +3993,7 @@ export namespace Atspi {
|
|
|
3697
3993
|
* @param row the specified table row, zero-indexed.
|
|
3698
3994
|
* @param column the specified table column, zero-indexed.
|
|
3699
3995
|
* @returns a `gint` which serves as the index of a specified cell in the table, in a form usable by `atspi_get_child_at_index`.
|
|
3996
|
+
* @throws GLib.Error
|
|
3700
3997
|
*/
|
|
3701
3998
|
get_index_at(row: number, column: number): number;
|
|
3702
3999
|
|
|
@@ -3705,6 +4002,7 @@ export namespace Atspi {
|
|
|
3705
4002
|
* exclusive of any columns that are programmatically hidden, but inclusive
|
|
3706
4003
|
* of columns that may be outside of the current scrolling window or viewport.
|
|
3707
4004
|
* @returns a `gint` indicating the number of columns in the table.
|
|
4005
|
+
* @throws GLib.Error
|
|
3708
4006
|
*/
|
|
3709
4007
|
get_n_columns(): number;
|
|
3710
4008
|
|
|
@@ -3713,6 +4011,7 @@ export namespace Atspi {
|
|
|
3713
4011
|
* exclusive of any rows that are programmatically hidden, but inclusive
|
|
3714
4012
|
* of rows that may be outside of the current scrolling window or viewport.
|
|
3715
4013
|
* @returns a `gint` indicating the number of rows in the table.
|
|
4014
|
+
* @throws GLib.Error
|
|
3716
4015
|
*/
|
|
3717
4016
|
get_n_rows(): number;
|
|
3718
4017
|
|
|
@@ -3720,6 +4019,7 @@ export namespace Atspi {
|
|
|
3720
4019
|
* Queries a table to find out how many columns are currently selected.
|
|
3721
4020
|
* Not all tables support column selection.
|
|
3722
4021
|
* @returns a `gint` indicating the number of columns currently selected.
|
|
4022
|
+
* @throws GLib.Error
|
|
3723
4023
|
*/
|
|
3724
4024
|
get_n_selected_columns(): number;
|
|
3725
4025
|
|
|
@@ -3727,6 +4027,7 @@ export namespace Atspi {
|
|
|
3727
4027
|
* Query a table to find out how many rows are currently selected.
|
|
3728
4028
|
* Not all tables support row selection.
|
|
3729
4029
|
* @returns a `gint` indicating the number of rows currently selected.
|
|
4030
|
+
* @throws GLib.Error
|
|
3730
4031
|
*/
|
|
3731
4032
|
get_n_selected_rows(): number;
|
|
3732
4033
|
|
|
@@ -3737,6 +4038,7 @@ export namespace Atspi {
|
|
|
3737
4038
|
* `see` `atspi_table_get_index_at`, `atspi_table_get_column_at_index`
|
|
3738
4039
|
* @param index the specified child index, zero-indexed.
|
|
3739
4040
|
* @returns a `gint` indicating the first row spanned by the child of a table, at the specified 1-D (zero-offset) `index`.
|
|
4041
|
+
* @throws GLib.Error
|
|
3740
4042
|
*/
|
|
3741
4043
|
get_row_at_index(index: number): number;
|
|
3742
4044
|
|
|
@@ -3764,6 +4066,7 @@ export namespace Atspi {
|
|
|
3764
4066
|
* `TRUE`, respectively.
|
|
3765
4067
|
* @param index the index of the {@link Atspi.Table} child whose row/column extents are requested.
|
|
3766
4068
|
* @returns `TRUE` if the index is associated with a valid table cell, `FALSE` if the index does not correspond to a cell. If `FALSE` is returned, the values of the out parameters are undefined.
|
|
4069
|
+
* @throws GLib.Error
|
|
3767
4070
|
*/
|
|
3768
4071
|
get_row_column_extents_at_index(index: number): [boolean, number, number, number, number, boolean];
|
|
3769
4072
|
|
|
@@ -3772,6 +4075,7 @@ export namespace Atspi {
|
|
|
3772
4075
|
* `atspi_table_get_row_header`, which returns an {@link Atspi.Accessible}.
|
|
3773
4076
|
* @param row the specified table row, zero-indexed.
|
|
3774
4077
|
* @returns a UTF-8 string describing the specified table row, if available.
|
|
4078
|
+
* @throws GLib.Error
|
|
3775
4079
|
*/
|
|
3776
4080
|
get_row_description(row: number): string;
|
|
3777
4081
|
|
|
@@ -3784,6 +4088,7 @@ export namespace Atspi {
|
|
|
3784
4088
|
* @param row the specified table row, zero-indexed.
|
|
3785
4089
|
* @param column the specified table column, zero-indexed.
|
|
3786
4090
|
* @returns a `gint` indicating the number of rows spanned by the specified cell.
|
|
4091
|
+
* @throws GLib.Error
|
|
3787
4092
|
*/
|
|
3788
4093
|
get_row_extent_at(row: number, column: number): number;
|
|
3789
4094
|
|
|
@@ -3792,6 +4097,7 @@ export namespace Atspi {
|
|
|
3792
4097
|
* `atspi_table_get_row_description`, which returns a string.
|
|
3793
4098
|
* @param row the specified table row, zero-indexed.
|
|
3794
4099
|
* @returns an {@link Atspi.Accessible} representation of the specified table row, if available.
|
|
4100
|
+
* @throws GLib.Error
|
|
3795
4101
|
*/
|
|
3796
4102
|
get_row_header(row: number): Accessible;
|
|
3797
4103
|
|
|
@@ -3799,18 +4105,21 @@ export namespace Atspi {
|
|
|
3799
4105
|
* Queries a table for a list of indices of columns which are currently
|
|
3800
4106
|
* selected.
|
|
3801
4107
|
* @returns an array of `gint` values, specifying which columns are currently selected.
|
|
4108
|
+
* @throws GLib.Error
|
|
3802
4109
|
*/
|
|
3803
4110
|
get_selected_columns(): number[];
|
|
3804
4111
|
|
|
3805
4112
|
/**
|
|
3806
4113
|
* Queries a table for a list of indices of rows which are currently selected.
|
|
3807
4114
|
* @returns an array of `gint` values, specifying which rows are currently selected.
|
|
4115
|
+
* @throws GLib.Error
|
|
3808
4116
|
*/
|
|
3809
4117
|
get_selected_rows(): number[];
|
|
3810
4118
|
|
|
3811
4119
|
/**
|
|
3812
4120
|
* Gets an accessible object which summarizes the contents of an {@link Atspi.Table}.
|
|
3813
4121
|
* @returns an {@link Atspi.Accessible} object that serves as the table's summary (often a reduced {@link Atspi.Table}).
|
|
4122
|
+
* @throws GLib.Error
|
|
3814
4123
|
*/
|
|
3815
4124
|
get_summary(): Accessible;
|
|
3816
4125
|
|
|
@@ -3819,6 +4128,7 @@ export namespace Atspi {
|
|
|
3819
4128
|
* Not all tables support column selection.
|
|
3820
4129
|
* @param column the zero-indexed column number of the column being queried.
|
|
3821
4130
|
* @returns `TRUE` if the specified column is currently selected, `FALSE` if not.
|
|
4131
|
+
* @throws GLib.Error
|
|
3822
4132
|
*/
|
|
3823
4133
|
is_column_selected(column: number): boolean;
|
|
3824
4134
|
|
|
@@ -3827,6 +4137,7 @@ export namespace Atspi {
|
|
|
3827
4137
|
* row selection.
|
|
3828
4138
|
* @param row the zero-indexed row number of the row being queried.
|
|
3829
4139
|
* @returns `TRUE` if the specified row is currently selected, `FALSE` if not.
|
|
4140
|
+
* @throws GLib.Error
|
|
3830
4141
|
*/
|
|
3831
4142
|
is_row_selected(row: number): boolean;
|
|
3832
4143
|
|
|
@@ -3835,6 +4146,7 @@ export namespace Atspi {
|
|
|
3835
4146
|
* @param row the zero-indexed row of the cell being queried.
|
|
3836
4147
|
* @param column the zero-indexed column of the cell being queried.
|
|
3837
4148
|
* @returns `TRUE` if the specified cell is currently selected, `FALSE` if not.
|
|
4149
|
+
* @throws GLib.Error
|
|
3838
4150
|
*/
|
|
3839
4151
|
is_selected(row: number, column: number): boolean;
|
|
3840
4152
|
|
|
@@ -3844,6 +4156,7 @@ export namespace Atspi {
|
|
|
3844
4156
|
* Not all tables support column selection.
|
|
3845
4157
|
* @param column the zero-indexed column number of the column being de-selected.
|
|
3846
4158
|
* @returns `TRUE` if the specified column was successfully de-selected, `FALSE` if not.
|
|
4159
|
+
* @throws GLib.Error
|
|
3847
4160
|
*/
|
|
3848
4161
|
remove_column_selection(column: number): boolean;
|
|
3849
4162
|
|
|
@@ -3852,15 +4165,20 @@ export namespace Atspi {
|
|
|
3852
4165
|
* Not all tables support row selection.
|
|
3853
4166
|
* @param row the zero-indexed number of the row being de-selected.
|
|
3854
4167
|
* @returns `TRUE` if the specified row was successfully de-selected, `FALSE` if not.
|
|
4168
|
+
* @throws GLib.Error
|
|
3855
4169
|
*/
|
|
3856
4170
|
remove_row_selection(row: number): boolean;
|
|
3857
4171
|
|
|
3858
4172
|
/**
|
|
3859
4173
|
* Returns the column headers as an array of cell accessibles.
|
|
3860
4174
|
* @returns a GPtrArray of AtspiAccessibles representing the column header cells.
|
|
4175
|
+
* @throws GLib.Error
|
|
3861
4176
|
*/
|
|
3862
4177
|
get_column_header_cells(): Accessible[];
|
|
3863
4178
|
|
|
4179
|
+
/**
|
|
4180
|
+
* @throws GLib.Error
|
|
4181
|
+
*/
|
|
3864
4182
|
get_column_index(): number;
|
|
3865
4183
|
|
|
3866
4184
|
/**
|
|
@@ -3868,6 +4186,7 @@ export namespace Atspi {
|
|
|
3868
4186
|
* The returned values are meaningful only if the table cell has both
|
|
3869
4187
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
3870
4188
|
* @returns a gint representing the number of columns occupied by this cell, or 0 if the cell does not implement this method.
|
|
4189
|
+
* @throws GLib.Error
|
|
3871
4190
|
*/
|
|
3872
4191
|
get_column_span(): number;
|
|
3873
4192
|
|
|
@@ -3875,12 +4194,14 @@ export namespace Atspi {
|
|
|
3875
4194
|
* Gets the row and column indexes and extents of this cell accessible.
|
|
3876
4195
|
* The returned values are meaningful only if the table cell has both
|
|
3877
4196
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
4197
|
+
* @throws GLib.Error
|
|
3878
4198
|
*/
|
|
3879
4199
|
get_row_column_span(): [number, number, number, number];
|
|
3880
4200
|
|
|
3881
4201
|
/**
|
|
3882
4202
|
* Returns the row headers as an array of cell accessibles.
|
|
3883
4203
|
* @returns a GPtrArray of AtspiAccessibles representing the row header cells.
|
|
4204
|
+
* @throws GLib.Error
|
|
3884
4205
|
*/
|
|
3885
4206
|
get_row_header_cells(): Accessible[];
|
|
3886
4207
|
|
|
@@ -3889,6 +4210,7 @@ export namespace Atspi {
|
|
|
3889
4210
|
* The returned values are meaningful only if the table cell has both
|
|
3890
4211
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
3891
4212
|
* @returns a gint representing the number of rows occupied by this cell, or 0 if the cell does not implement this method.
|
|
4213
|
+
* @throws GLib.Error
|
|
3892
4214
|
*/
|
|
3893
4215
|
get_row_span(): number;
|
|
3894
4216
|
|
|
@@ -3897,6 +4219,7 @@ export namespace Atspi {
|
|
|
3897
4219
|
* @param start_offset the starting offset of the desired new selection.
|
|
3898
4220
|
* @param end_offset the offset of the first character after the new selection.
|
|
3899
4221
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
4222
|
+
* @throws GLib.Error
|
|
3900
4223
|
*/
|
|
3901
4224
|
add_selection(start_offset: number, end_offset: number): boolean;
|
|
3902
4225
|
|
|
@@ -3906,6 +4229,7 @@ export namespace Atspi {
|
|
|
3906
4229
|
* @param offset a `gint` indicating the offset from which the attribute search is based.
|
|
3907
4230
|
* @param include_defaults a #bool that, when set as `FALSE`, indicates the call should only return those attributes which are explicitly set on the current attribute run, omitting any attributes which are inherited from the default values.
|
|
3908
4231
|
* @returns a {@link GLib.HashTable} with attributes defined at the indicated offset, optionally including the 'default' ones.
|
|
4232
|
+
* @throws GLib.Error
|
|
3909
4233
|
*/
|
|
3910
4234
|
get_attribute_run(offset: number, include_defaults: boolean): [{ [key: string]: string }, number, number];
|
|
3911
4235
|
|
|
@@ -3914,6 +4238,8 @@ export namespace Atspi {
|
|
|
3914
4238
|
* @param offset The character offset at which to query the attribute.
|
|
3915
4239
|
* @param attribute_name The attribute to query.
|
|
3916
4240
|
* @returns the value of a given attribute at the given offset, or `null` if not present.
|
|
4241
|
+
* @deprecated since 2.10: Use atspi_text_get_text_attribute_value instead.
|
|
4242
|
+
* @throws GLib.Error
|
|
3917
4243
|
*/
|
|
3918
4244
|
get_text_attribute_value(offset: number, attribute_name: string): string | null;
|
|
3919
4245
|
|
|
@@ -3923,6 +4249,8 @@ export namespace Atspi {
|
|
|
3923
4249
|
* where possible.
|
|
3924
4250
|
* @param offset a `gint` indicating the offset from which the attribute search is based.
|
|
3925
4251
|
* @returns a {@link GLib.HashTable} describing the attributes at the given character offset.
|
|
4252
|
+
* @deprecated since 2.10: Use atspi_text_get_text_attributes instead.
|
|
4253
|
+
* @throws GLib.Error
|
|
3926
4254
|
*/
|
|
3927
4255
|
get_text_attributes(offset: number): [{ [key: string]: string }, number, number];
|
|
3928
4256
|
|
|
@@ -3937,12 +4265,14 @@ export namespace Atspi {
|
|
|
3937
4265
|
* @param clipTypeX an {@link Atspi.TextClipType} indicating how to treat characters that intersect the bounding box's x extents.
|
|
3938
4266
|
* @param clipTypeY an {@link Atspi.TextClipType} indicating how to treat characters that intersect the bounding box's y extents.
|
|
3939
4267
|
* @returns a null-terminated list of pointers to {@link Atspi.TextRange} structs detailing the bounded text.
|
|
4268
|
+
* @throws GLib.Error
|
|
3940
4269
|
*/
|
|
3941
4270
|
get_bounded_ranges(x: number, y: number, width: number, height: number, type: CoordType, clipTypeX: TextClipType, clipTypeY: TextClipType): TextRange[];
|
|
3942
4271
|
|
|
3943
4272
|
/**
|
|
3944
4273
|
* Gets the current offset of the text caret in an {@link Atspi.Text} object.
|
|
3945
4274
|
* @returns a `gint` indicating the current position of the text caret.
|
|
4275
|
+
* @throws GLib.Error
|
|
3946
4276
|
*/
|
|
3947
4277
|
get_caret_offset(): number;
|
|
3948
4278
|
|
|
@@ -3950,12 +4280,14 @@ export namespace Atspi {
|
|
|
3950
4280
|
* Gets the character at a given offset for an {@link Atspi.Text} object.
|
|
3951
4281
|
* @param offset a `gint` indicating the text offset where the desired character is located.
|
|
3952
4282
|
* @returns a `guint` representing the UCS-4 unicode code point of the given character, or 0xFFFFFFFF if the character in question cannot be represented in the UCS-4 encoding.
|
|
4283
|
+
* @throws GLib.Error
|
|
3953
4284
|
*/
|
|
3954
4285
|
get_character_at_offset(offset: number): number;
|
|
3955
4286
|
|
|
3956
4287
|
/**
|
|
3957
4288
|
* Gets the character count of an `AccessibleText` object.
|
|
3958
4289
|
* @returns a `gint` indicating the total number of characters in the `AccessibleText` object.
|
|
4290
|
+
* @throws GLib.Error
|
|
3959
4291
|
*/
|
|
3960
4292
|
get_character_count(): number;
|
|
3961
4293
|
|
|
@@ -3967,6 +4299,7 @@ export namespace Atspi {
|
|
|
3967
4299
|
* @param offset a `gint` indicating the offset of the text character for whom boundary information is requested.
|
|
3968
4300
|
* @param type an `AccessibleCoordType` indicating the coordinate system to use for the returned values.
|
|
3969
4301
|
* @returns An {@link Atspi.Rect} specifying the position and size of the character.
|
|
4302
|
+
* @throws GLib.Error
|
|
3970
4303
|
*/
|
|
3971
4304
|
get_character_extents(offset: number, type: CoordType): Rect;
|
|
3972
4305
|
|
|
@@ -3977,6 +4310,7 @@ export namespace Atspi {
|
|
|
3977
4310
|
* the attributes reported by `atspi_text_get_attributes`
|
|
3978
4311
|
* describes the entire set of text attributes over a range.
|
|
3979
4312
|
* @returns a {@link GLib.HashTable} containing the default attributes applied to a text object, (exclusive of explicitly-set attributes), encoded as UTF-8.
|
|
4313
|
+
* @throws GLib.Error
|
|
3980
4314
|
*/
|
|
3981
4315
|
get_default_attributes(): { [key: string]: string };
|
|
3982
4316
|
|
|
@@ -3984,6 +4318,7 @@ export namespace Atspi {
|
|
|
3984
4318
|
* Gets the number of active non-contiguous selections for an
|
|
3985
4319
|
* {@link Atspi.Text} object.
|
|
3986
4320
|
* @returns a `gint` indicating the current number of non-contiguous text selections active within an {@link Atspi.Text} object.
|
|
4321
|
+
* @throws GLib.Error
|
|
3987
4322
|
*/
|
|
3988
4323
|
get_n_selections(): number;
|
|
3989
4324
|
|
|
@@ -3993,6 +4328,7 @@ export namespace Atspi {
|
|
|
3993
4328
|
* @param y the y coordinate of the point to be queried.
|
|
3994
4329
|
* @param type an {@link Atspi.CoordType} indicating the coordinate system in which the values should be returned.
|
|
3995
4330
|
* @returns the offset (as a `gint`) at the point (`x`, `y`) in the specified coordinate system.
|
|
4331
|
+
* @throws GLib.Error
|
|
3996
4332
|
*/
|
|
3997
4333
|
get_offset_at_point(x: number, y: number, type: CoordType): number;
|
|
3998
4334
|
|
|
@@ -4004,6 +4340,7 @@ export namespace Atspi {
|
|
|
4004
4340
|
* @param end_offset a `gint` indicating the offset of the text character after the last character for whom boundary information is requested.
|
|
4005
4341
|
* @param type an {@link Atspi.CoordType} indicating the coordinate system to use for the returned values.
|
|
4006
4342
|
* @returns An {@link Atspi.Rect} giving the position and size of the specified range of text.
|
|
4343
|
+
* @throws GLib.Error
|
|
4007
4344
|
*/
|
|
4008
4345
|
get_range_extents(start_offset: number, end_offset: number, type: CoordType): Rect;
|
|
4009
4346
|
|
|
@@ -4041,6 +4378,8 @@ export namespace Atspi {
|
|
|
4041
4378
|
* @param offset position
|
|
4042
4379
|
* @param granularity An {@link Atspi.TextGranularity}
|
|
4043
4380
|
* @returns a newly allocated string containing the text at the `offset` bounded by the specified `granularity`. Use `g_free()` to free the returned string. Returns `null` if the offset is invalid or no implementation is available.
|
|
4381
|
+
* @since 2.9.90
|
|
4382
|
+
* @throws GLib.Error
|
|
4044
4383
|
*/
|
|
4045
4384
|
get_string_at_offset(offset: number, granularity: TextGranularity): TextRange;
|
|
4046
4385
|
|
|
@@ -4050,6 +4389,7 @@ export namespace Atspi {
|
|
|
4050
4389
|
* @param offset a `gint` indicating the offset from which the delimiter search is based.
|
|
4051
4390
|
* @param type an {@link Atspi.TextBoundaryType} indicating whether the desired text string is a word, sentence, line, or attribute run.
|
|
4052
4391
|
* @returns an {@link Atspi.TextRange} containing a UTF-8 string representing the delimited text, both of whose delimiting boundaries are after or inclusive of the current offset, or an empty string if no such text exists.
|
|
4392
|
+
* @throws GLib.Error
|
|
4053
4393
|
*/
|
|
4054
4394
|
get_text_after_offset(offset: number, type: TextBoundaryType): TextRange;
|
|
4055
4395
|
|
|
@@ -4059,6 +4399,8 @@ export namespace Atspi {
|
|
|
4059
4399
|
* @param offset a `gint` indicating the offset from which the delimiter search is based.
|
|
4060
4400
|
* @param type an {@link Atspi.TextBoundaryType} indicating whether the desired text string is a word, sentence, line, or attribute run.
|
|
4061
4401
|
* @returns an {@link Atspi.TextRange} containing a UTF-8 string representing the delimited text, whose delimiting boundaries bracket the current offset, or an empty string if no such text exists.
|
|
4402
|
+
* @deprecated since 2.10: Use atspi_text_get_string_at_offset.
|
|
4403
|
+
* @throws GLib.Error
|
|
4062
4404
|
*/
|
|
4063
4405
|
get_text_at_offset(offset: number, type: TextBoundaryType): TextRange;
|
|
4064
4406
|
|
|
@@ -4068,6 +4410,7 @@ export namespace Atspi {
|
|
|
4068
4410
|
* @param offset a `gint` indicating the offset from which the delimiter search is based.
|
|
4069
4411
|
* @param type an {@link Atspi.TextBoundaryType} indicating whether the desired text string is a word, sentence, line, or attribute run.
|
|
4070
4412
|
* @returns an {@link Atspi.TextRange} containing a UTF-8 string representing the delimited text, both of whose delimiting boundaries are before the current offset, or an empty string if no such text exists.
|
|
4413
|
+
* @throws GLib.Error
|
|
4071
4414
|
*/
|
|
4072
4415
|
get_text_before_offset(offset: number, type: TextBoundaryType): TextRange;
|
|
4073
4416
|
|
|
@@ -4075,6 +4418,7 @@ export namespace Atspi {
|
|
|
4075
4418
|
* De-selects a text selection.
|
|
4076
4419
|
* @param selection_num a `gint` indicating which text selection to remove.
|
|
4077
4420
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
4421
|
+
* @throws GLib.Error
|
|
4078
4422
|
*/
|
|
4079
4423
|
remove_selection(selection_num: number): boolean;
|
|
4080
4424
|
|
|
@@ -4085,6 +4429,7 @@ export namespace Atspi {
|
|
|
4085
4429
|
* @param end_offset a `gint` indicating the first character past the desired range.
|
|
4086
4430
|
* @param type a {@link Atspi.ScrollType} indicating where the object should be placed on the screen.
|
|
4087
4431
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
4432
|
+
* @throws GLib.Error
|
|
4088
4433
|
*/
|
|
4089
4434
|
scroll_substring_to(start_offset: number, end_offset: number, type: ScrollType): boolean;
|
|
4090
4435
|
|
|
@@ -4097,6 +4442,7 @@ export namespace Atspi {
|
|
|
4097
4442
|
* @param x the x coordinate of the point to reach
|
|
4098
4443
|
* @param y the y coordinate of the point to reach
|
|
4099
4444
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
4445
|
+
* @throws GLib.Error
|
|
4100
4446
|
*/
|
|
4101
4447
|
scroll_substring_to_point(start_offset: number, end_offset: number, coords: CoordType, x: number, y: number): boolean;
|
|
4102
4448
|
|
|
@@ -4104,6 +4450,7 @@ export namespace Atspi {
|
|
|
4104
4450
|
* Moves the text caret to a given position.
|
|
4105
4451
|
* @param new_offset the offset to which the text caret is to be moved.
|
|
4106
4452
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
4453
|
+
* @throws GLib.Error
|
|
4107
4454
|
*/
|
|
4108
4455
|
set_caret_offset(new_offset: number): boolean;
|
|
4109
4456
|
|
|
@@ -4113,30 +4460,35 @@ export namespace Atspi {
|
|
|
4113
4460
|
* @param start_offset a `gint` indicating the new starting offset for the selection.
|
|
4114
4461
|
* @param end_offset a `gint` indicating the desired new offset of the first character after the selection.
|
|
4115
4462
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
4463
|
+
* @throws GLib.Error
|
|
4116
4464
|
*/
|
|
4117
4465
|
set_selection(selection_num: number, start_offset: number, end_offset: number): boolean;
|
|
4118
4466
|
|
|
4119
4467
|
/**
|
|
4120
4468
|
* Gets the current value for an {@link Atspi.Value}.
|
|
4121
4469
|
* @returns the current value for this object.
|
|
4470
|
+
* @throws GLib.Error
|
|
4122
4471
|
*/
|
|
4123
4472
|
get_current_value(): number;
|
|
4124
4473
|
|
|
4125
4474
|
/**
|
|
4126
4475
|
* Gets the maximum allowed value for an {@link Atspi.Value}.
|
|
4127
4476
|
* @returns the maximum allowed value for this object.
|
|
4477
|
+
* @throws GLib.Error
|
|
4128
4478
|
*/
|
|
4129
4479
|
get_maximum_value(): number;
|
|
4130
4480
|
|
|
4131
4481
|
/**
|
|
4132
4482
|
* Gets the minimum increment by which an {@link Atspi.Value} can be adjusted.
|
|
4133
4483
|
* @returns the minimum increment by which the value may be changed, or zero if the minimum increment cannot be determined.
|
|
4484
|
+
* @throws GLib.Error
|
|
4134
4485
|
*/
|
|
4135
4486
|
get_minimum_increment(): number;
|
|
4136
4487
|
|
|
4137
4488
|
/**
|
|
4138
4489
|
* Gets the minimum allowed value for an {@link Atspi.Value}.
|
|
4139
4490
|
* @returns the minimum allowed value for this object.
|
|
4491
|
+
* @throws GLib.Error
|
|
4140
4492
|
*/
|
|
4141
4493
|
get_minimum_value(): number;
|
|
4142
4494
|
|
|
@@ -4144,6 +4496,7 @@ export namespace Atspi {
|
|
|
4144
4496
|
* Sets the current value of an {@link Atspi.Value}.
|
|
4145
4497
|
* @param new_value a `gdouble` value which is the desired new value of the object.
|
|
4146
4498
|
* @returns `TRUE` if the value could be assigned the specified value, `FALSE` otherwise.
|
|
4499
|
+
* @throws GLib.Error
|
|
4147
4500
|
*/
|
|
4148
4501
|
set_current_value(new_value: number): boolean;
|
|
4149
4502
|
}
|
|
@@ -4221,18 +4574,18 @@ export namespace Atspi {
|
|
|
4221
4574
|
* @signal
|
|
4222
4575
|
* @run-last
|
|
4223
4576
|
*/
|
|
4224
|
-
"key-pressed": (
|
|
4577
|
+
"key-pressed": (object: number, p0: number, p1: ModifierType, p2: string) => void;
|
|
4225
4578
|
/**
|
|
4226
4579
|
* @signal
|
|
4227
4580
|
* @run-last
|
|
4228
4581
|
*/
|
|
4229
|
-
"key-released": (
|
|
4582
|
+
"key-released": (object: number, p0: number, p1: ModifierType, p2: string) => void;
|
|
4230
4583
|
/**
|
|
4231
4584
|
* Signals that the pointer has moved.
|
|
4232
4585
|
* @signal
|
|
4233
4586
|
* @run-last
|
|
4234
4587
|
*/
|
|
4235
|
-
"pointer-moved": (
|
|
4588
|
+
"pointer-moved": (accessible: Accessible, x: number, y: number) => void;
|
|
4236
4589
|
"notify::app-id": (pspec: GObject.ParamSpec) => void;
|
|
4237
4590
|
}
|
|
4238
4591
|
|
|
@@ -4311,12 +4664,14 @@ export namespace Atspi {
|
|
|
4311
4664
|
* @param x a `gint` indicating the x coordinate of the mouse event, relative to `obj`..
|
|
4312
4665
|
* @param y a `gint` indicating the y coordinate of the mouse event, relative to `obj`..
|
|
4313
4666
|
* @param name a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs").
|
|
4667
|
+
* @since 2.52
|
|
4314
4668
|
* @virtual
|
|
4315
4669
|
*/
|
|
4316
4670
|
vfunc_generate_mouse_event(obj: Accessible, x: number, y: number, name: string): void;
|
|
4317
4671
|
|
|
4318
4672
|
/**
|
|
4319
4673
|
* Returns the capabilities currently enabled for this device.
|
|
4674
|
+
* @since 2.60
|
|
4320
4675
|
* @virtual
|
|
4321
4676
|
*/
|
|
4322
4677
|
vfunc_get_capabilities(): DeviceCapability;
|
|
@@ -4327,6 +4682,7 @@ export namespace Atspi {
|
|
|
4327
4682
|
* locking modifier such as num lock via atspi_device_get_locked_modifiers,
|
|
4328
4683
|
* rather than to add key grabs.
|
|
4329
4684
|
* @param keysym the XKB keysym to map.
|
|
4685
|
+
* @since 2.55
|
|
4330
4686
|
* @virtual
|
|
4331
4687
|
*/
|
|
4332
4688
|
vfunc_get_keysym_modifier(keysym: number): number;
|
|
@@ -4366,6 +4722,7 @@ export namespace Atspi {
|
|
|
4366
4722
|
* that is not currently being used. If no unused modifier can be found,
|
|
4367
4723
|
* then it will use the first modifier by default.
|
|
4368
4724
|
* @param keysym the XKB keysym to map.
|
|
4725
|
+
* @since 2.55
|
|
4369
4726
|
* @virtual
|
|
4370
4727
|
*/
|
|
4371
4728
|
vfunc_map_keysym_modifier(keysym: number): number;
|
|
@@ -4393,6 +4750,7 @@ export namespace Atspi {
|
|
|
4393
4750
|
|
|
4394
4751
|
/**
|
|
4395
4752
|
* @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.
|
|
4753
|
+
* @since 2.60
|
|
4396
4754
|
* @virtual
|
|
4397
4755
|
*/
|
|
4398
4756
|
vfunc_set_capabilities(capabilities: DeviceCapability): DeviceCapability;
|
|
@@ -4406,6 +4764,7 @@ export namespace Atspi {
|
|
|
4406
4764
|
/**
|
|
4407
4765
|
* Removes a mapped modifier from the given keysym.
|
|
4408
4766
|
* @param keysym the XKB keysym to unmap.
|
|
4767
|
+
* @since 2.55
|
|
4409
4768
|
* @virtual
|
|
4410
4769
|
*/
|
|
4411
4770
|
vfunc_unmap_keysym_modifier(keysym: number): void;
|
|
@@ -4429,6 +4788,7 @@ export namespace Atspi {
|
|
|
4429
4788
|
* Add a callback that will receive a notification whenever a key is
|
|
4430
4789
|
* pressed or released.
|
|
4431
4790
|
* @param callback the function to call when the given key is pressed.
|
|
4791
|
+
* @deprecated since 2.60: Connect to the key-pressed and key-released signals instead of using this function.
|
|
4432
4792
|
*/
|
|
4433
4793
|
add_key_watcher(callback: KeyCallback): void;
|
|
4434
4794
|
|
|
@@ -4445,16 +4805,20 @@ export namespace Atspi {
|
|
|
4445
4805
|
* @param x a `gint` indicating the x coordinate of the mouse event, relative to `obj`..
|
|
4446
4806
|
* @param y a `gint` indicating the y coordinate of the mouse event, relative to `obj`..
|
|
4447
4807
|
* @param name a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs").
|
|
4808
|
+
* @since 2.52
|
|
4809
|
+
* @throws GLib.Error
|
|
4448
4810
|
*/
|
|
4449
4811
|
generate_mouse_event(obj: Accessible, x: number, y: number, name: string): void;
|
|
4450
4812
|
|
|
4451
4813
|
/**
|
|
4452
4814
|
* Returns the application ID of the device.
|
|
4815
|
+
* @since 2.55
|
|
4453
4816
|
*/
|
|
4454
4817
|
get_app_id(): string;
|
|
4455
4818
|
|
|
4456
4819
|
/**
|
|
4457
4820
|
* Returns the capabilities currently enabled for this device.
|
|
4821
|
+
* @since 2.60
|
|
4458
4822
|
*/
|
|
4459
4823
|
get_capabilities(): DeviceCapability;
|
|
4460
4824
|
|
|
@@ -4470,6 +4834,7 @@ export namespace Atspi {
|
|
|
4470
4834
|
* rather than to add key grabs.
|
|
4471
4835
|
* @param keysym the XKB keysym to map.
|
|
4472
4836
|
* @returns the modifier that is mapped to this keysym.
|
|
4837
|
+
* @since 2.55
|
|
4473
4838
|
*/
|
|
4474
4839
|
get_keysym_modifier(keysym: number): number;
|
|
4475
4840
|
|
|
@@ -4509,6 +4874,7 @@ export namespace Atspi {
|
|
|
4509
4874
|
* then it will use the first modifier by default.
|
|
4510
4875
|
* @param keysym the XKB keysym to map.
|
|
4511
4876
|
* @returns the modifier that is now mapped to this keysym. This return value can be passed to atspi_device_add_key_grab.
|
|
4877
|
+
* @since 2.55
|
|
4512
4878
|
*/
|
|
4513
4879
|
map_keysym_modifier(keysym: number): number;
|
|
4514
4880
|
|
|
@@ -4544,12 +4910,14 @@ export namespace Atspi {
|
|
|
4544
4910
|
/**
|
|
4545
4911
|
* Sets the application ID of the device.
|
|
4546
4912
|
* @param app_id the application ID.
|
|
4913
|
+
* @since 2.55
|
|
4547
4914
|
*/
|
|
4548
4915
|
set_app_id(app_id: string): void;
|
|
4549
4916
|
|
|
4550
4917
|
/**
|
|
4551
4918
|
* @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
4919
|
* @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.
|
|
4920
|
+
* @since 2.60
|
|
4553
4921
|
*/
|
|
4554
4922
|
set_capabilities(capabilities: DeviceCapability): DeviceCapability;
|
|
4555
4923
|
|
|
@@ -4561,6 +4929,7 @@ export namespace Atspi {
|
|
|
4561
4929
|
/**
|
|
4562
4930
|
* Removes a mapped modifier from the given keysym.
|
|
4563
4931
|
* @param keysym the XKB keysym to unmap.
|
|
4932
|
+
* @since 2.55
|
|
4564
4933
|
*/
|
|
4565
4934
|
unmap_keysym_modifier(keysym: number): void;
|
|
4566
4935
|
|
|
@@ -4884,6 +5253,7 @@ export namespace Atspi {
|
|
|
4884
5253
|
* event type.
|
|
4885
5254
|
* @param event_type a string specifying the event type for which this listener is to be deregistered.
|
|
4886
5255
|
* @returns `TRUE` if successful, otherwise `FALSE`.
|
|
5256
|
+
* @throws GLib.Error
|
|
4887
5257
|
*/
|
|
4888
5258
|
deregister(event_type: string): boolean;
|
|
4889
5259
|
|
|
@@ -4974,6 +5344,7 @@ export namespace Atspi {
|
|
|
4974
5344
|
* reader and is thus a special case internally.
|
|
4975
5345
|
* @param event_type a character string indicating the type of events for which notification is requested. Format is EventClass:major_type:minor_type:detail where all subfields other than EventClass are optional. EventClasses include "object", "window", "mouse", and toolkit events (e.g. "Gtk", "AWT"). Examples: "focus:", "Gtk:GtkWidget:button_press_event".
|
|
4976
5346
|
* @returns `TRUE` if successful, otherwise `FALSE`.
|
|
5347
|
+
* @throws GLib.Error
|
|
4977
5348
|
*/
|
|
4978
5349
|
register(event_type: string): boolean;
|
|
4979
5350
|
|
|
@@ -4982,6 +5353,7 @@ export namespace Atspi {
|
|
|
4982
5353
|
* @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 and legal event types.
|
|
4983
5354
|
* @param properties a list of properties that should be sent along with the event. The properties are valued for the duration of the event callback. TODO: Document.
|
|
4984
5355
|
* @returns `TRUE` if successful, otherwise `FALSE`.
|
|
5356
|
+
* @throws GLib.Error
|
|
4985
5357
|
*/
|
|
4986
5358
|
register_full(event_type: string, properties: string[] | null): boolean;
|
|
4987
5359
|
|
|
@@ -4991,6 +5363,7 @@ export namespace Atspi {
|
|
|
4991
5363
|
* @param properties a list of properties that should be sent along with the event. The properties are valued for the duration of the event callback.
|
|
4992
5364
|
* @param app the application whose events should be reported, or %null for all applications.
|
|
4993
5365
|
* @returns `TRUE` if successful, otherwise `FALSE`.
|
|
5366
|
+
* @throws GLib.Error
|
|
4994
5367
|
*/
|
|
4995
5368
|
register_with_app(event_type: string, properties: string[] | null, app: Accessible | null): boolean;
|
|
4996
5369
|
}
|
|
@@ -5051,12 +5424,14 @@ export namespace Atspi {
|
|
|
5051
5424
|
/**
|
|
5052
5425
|
* Gets the ending character offset of the text range associated with
|
|
5053
5426
|
* an {@link Atspi.Hyperlink}, in its originating {@link Atspi.Hypertext}.
|
|
5427
|
+
* @throws GLib.Error
|
|
5054
5428
|
*/
|
|
5055
5429
|
get_end_index(): number;
|
|
5056
5430
|
|
|
5057
5431
|
/**
|
|
5058
5432
|
* Gets the starting and ending character offsets of the text range
|
|
5059
5433
|
* associated with an {@link Atspi.Hyperlink}, in its originating {@link Atspi.Hypertext}.
|
|
5434
|
+
* @throws GLib.Error
|
|
5060
5435
|
*/
|
|
5061
5436
|
get_index_range(): Range;
|
|
5062
5437
|
|
|
@@ -5068,6 +5443,7 @@ export namespace Atspi {
|
|
|
5068
5443
|
*
|
|
5069
5444
|
* see: `atspi_hyperlink_get_uri` and `atspi_hyperlink_get_object`.
|
|
5070
5445
|
* @returns a `gint` indicating the number of anchors in this hyperlink.
|
|
5446
|
+
* @throws GLib.Error
|
|
5071
5447
|
*/
|
|
5072
5448
|
get_n_anchors(): number;
|
|
5073
5449
|
|
|
@@ -5076,12 +5452,14 @@ export namespace Atspi {
|
|
|
5076
5452
|
* {@link Atspi.Accessible}.
|
|
5077
5453
|
* @param i a (zero-index) `gint` indicating which hyperlink anchor to query.
|
|
5078
5454
|
* @returns an {@link Atspi.Accessible} that represents the object associated with the `ith` anchor of the specified {@link Atspi.Hyperlink}.
|
|
5455
|
+
* @throws GLib.Error
|
|
5079
5456
|
*/
|
|
5080
5457
|
get_object(i: number): Accessible;
|
|
5081
5458
|
|
|
5082
5459
|
/**
|
|
5083
5460
|
* Gets the starting character offset of the text range associated with
|
|
5084
5461
|
* an {@link Atspi.Hyperlink}, in its originating {@link Atspi.Hypertext}.
|
|
5462
|
+
* @throws GLib.Error
|
|
5085
5463
|
*/
|
|
5086
5464
|
get_start_index(): number;
|
|
5087
5465
|
|
|
@@ -5089,6 +5467,7 @@ export namespace Atspi {
|
|
|
5089
5467
|
* Gets the URI associated with a particular hyperlink anchor.
|
|
5090
5468
|
* @param i a (zero-index) integer indicating which hyperlink anchor to query.
|
|
5091
5469
|
* @returns a UTF-8 string giving the URI of the `ith` hyperlink anchor.
|
|
5470
|
+
* @throws GLib.Error
|
|
5092
5471
|
*/
|
|
5093
5472
|
get_uri(i: number): string;
|
|
5094
5473
|
|
|
@@ -5096,6 +5475,7 @@ export namespace Atspi {
|
|
|
5096
5475
|
* Tells whether an {@link Atspi.Hyperlink} object is still valid with respect to its
|
|
5097
5476
|
* originating hypertext object.
|
|
5098
5477
|
* @returns `TRUE` if the specified {@link Atspi.Hyperlink} is still valid with respect to its originating {@link Atspi.Hypertext} object, `FALSE` otherwise.
|
|
5478
|
+
* @throws GLib.Error
|
|
5099
5479
|
*/
|
|
5100
5480
|
is_valid(): boolean;
|
|
5101
5481
|
}
|
|
@@ -5770,6 +6150,7 @@ export namespace Atspi {
|
|
|
5770
6150
|
* Invoke the action indicated by #index.
|
|
5771
6151
|
* @param i an integer specifying which action to invoke.
|
|
5772
6152
|
* @returns `TRUE` if the action is successfully invoked, otherwise `FALSE`.
|
|
6153
|
+
* @throws GLib.Error
|
|
5773
6154
|
*/
|
|
5774
6155
|
do_action(i: number): boolean;
|
|
5775
6156
|
|
|
@@ -5778,6 +6159,8 @@ export namespace Atspi {
|
|
|
5778
6159
|
* object implementing {@link Atspi.Action}.
|
|
5779
6160
|
* @param i an integer indicating which action to query.
|
|
5780
6161
|
* @returns a UTF-8 string describing the '`i`-th' invocable action.
|
|
6162
|
+
* @deprecated since 2.10: Use atspi_action_get_action_description instead.
|
|
6163
|
+
* @throws GLib.Error
|
|
5781
6164
|
*/
|
|
5782
6165
|
get_action_description(i: number): string;
|
|
5783
6166
|
|
|
@@ -5805,6 +6188,7 @@ export namespace Atspi {
|
|
|
5805
6188
|
* gtk+-2.X.
|
|
5806
6189
|
* @param i an integer indicating which action to query.
|
|
5807
6190
|
* @returns a UTF-8 string which can be parsed to determine the `i`-th invocable action's keybindings.
|
|
6191
|
+
* @throws GLib.Error
|
|
5808
6192
|
*/
|
|
5809
6193
|
get_key_binding(i: number): string;
|
|
5810
6194
|
|
|
@@ -5813,12 +6197,14 @@ export namespace Atspi {
|
|
|
5813
6197
|
* object implementing {@link Atspi.Action}.
|
|
5814
6198
|
* @param i an integer indicating which action to query.
|
|
5815
6199
|
* @returns the name of the action, as a UTF-8 string.
|
|
6200
|
+
* @throws GLib.Error
|
|
5816
6201
|
*/
|
|
5817
6202
|
get_localized_name(i: number): string;
|
|
5818
6203
|
|
|
5819
6204
|
/**
|
|
5820
6205
|
* Get the number of actions invokable on an {@link Atspi.Action} implementor.
|
|
5821
6206
|
* @returns an integer indicating the number of invocable actions.
|
|
6207
|
+
* @throws GLib.Error
|
|
5822
6208
|
*/
|
|
5823
6209
|
get_n_actions(): number;
|
|
5824
6210
|
|
|
@@ -5827,6 +6213,8 @@ export namespace Atspi {
|
|
|
5827
6213
|
* object implementing {@link Atspi.Action}.
|
|
5828
6214
|
* @param i an integer indicating which action to query.
|
|
5829
6215
|
* @returns the non-localized name of the action, as a UTF-8 string.
|
|
6216
|
+
* @deprecated since 2.10: Use atspi_action_get_action_name instead.
|
|
6217
|
+
* @throws GLib.Error
|
|
5830
6218
|
*/
|
|
5831
6219
|
get_action_name(i: number): string;
|
|
5832
6220
|
}
|
|
@@ -5860,6 +6248,7 @@ export namespace Atspi {
|
|
|
5860
6248
|
// Methods
|
|
5861
6249
|
/**
|
|
5862
6250
|
* @returns The active descendant of the given object. Not yet implemented.
|
|
6251
|
+
* @throws GLib.Error
|
|
5863
6252
|
*/
|
|
5864
6253
|
get_active_descendant(): Accessible;
|
|
5865
6254
|
|
|
@@ -5871,6 +6260,7 @@ export namespace Atspi {
|
|
|
5871
6260
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
5872
6261
|
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
5873
6262
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule.
|
|
6263
|
+
* @throws GLib.Error
|
|
5874
6264
|
*/
|
|
5875
6265
|
get_matches(rule: MatchRule, sortby: CollectionSortOrder, count: number, traverse: boolean): Accessible[];
|
|
5876
6266
|
|
|
@@ -5884,6 +6274,7 @@ export namespace Atspi {
|
|
|
5884
6274
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
5885
6275
|
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
5886
6276
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule that preceed `current_object`.
|
|
6277
|
+
* @throws GLib.Error
|
|
5887
6278
|
*/
|
|
5888
6279
|
get_matches_from(current_object: Accessible, rule: MatchRule, sortby: CollectionSortOrder, tree: CollectionTreeTraversalType, count: number, traverse: boolean): Accessible[];
|
|
5889
6280
|
|
|
@@ -5898,12 +6289,14 @@ export namespace Atspi {
|
|
|
5898
6289
|
* @param count The maximum number of results to return, or 0 for no limit.
|
|
5899
6290
|
* @param traverse Whether to traverse the accessible subtree (in case of `TRUE`) or only the direct children (on case of `FALSE`).
|
|
5900
6291
|
* @returns All {@link Atspi.Accessible} objects matching the given match rule after `current_object`.
|
|
6292
|
+
* @throws GLib.Error
|
|
5901
6293
|
*/
|
|
5902
6294
|
get_matches_to(current_object: Accessible, rule: MatchRule, sortby: CollectionSortOrder, tree: CollectionTreeTraversalType, limit_scope: boolean, count: number, traverse: boolean): Accessible[];
|
|
5903
6295
|
|
|
5904
6296
|
/**
|
|
5905
6297
|
* Not yet implemented.
|
|
5906
6298
|
* @param test
|
|
6299
|
+
* @throws GLib.Error
|
|
5907
6300
|
*/
|
|
5908
6301
|
is_ancestor_of(test: Accessible): boolean;
|
|
5909
6302
|
}
|
|
@@ -5946,6 +6339,7 @@ export namespace Atspi {
|
|
|
5946
6339
|
* @param y a `gint` specifying the y coordinate in question.
|
|
5947
6340
|
* @param ctype the desired coordinate system of the point (`x`, `y`) (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
|
|
5948
6341
|
* @returns `TRUE` if the specified component contains the point (`x`, `y`), `FALSE` otherwise.
|
|
6342
|
+
* @throws GLib.Error
|
|
5949
6343
|
*/
|
|
5950
6344
|
contains(x: number, y: number, ctype: CoordType): boolean;
|
|
5951
6345
|
|
|
@@ -5955,12 +6349,14 @@ export namespace Atspi {
|
|
|
5955
6349
|
* @param y a `gint` specifying the y coordinate of the point in question.
|
|
5956
6350
|
* @param ctype the coordinate system of the point (`x`, `y`) (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
5957
6351
|
* @returns a pointer to an {@link Atspi.Accessible} child of the specified component which contains the point (`x`, `y`), or NULL if no child contains the point.
|
|
6352
|
+
* @throws GLib.Error
|
|
5958
6353
|
*/
|
|
5959
6354
|
get_accessible_at_point(x: number, y: number, ctype: CoordType): Accessible | null;
|
|
5960
6355
|
|
|
5961
6356
|
/**
|
|
5962
6357
|
* Gets the opacity/alpha value of a component, if alpha blending is in use.
|
|
5963
6358
|
* @returns the opacity value of a component, as a `gdouble` between 0.0 and 1.0.
|
|
6359
|
+
* @throws GLib.Error
|
|
5964
6360
|
*/
|
|
5965
6361
|
get_alpha(): number;
|
|
5966
6362
|
|
|
@@ -5970,6 +6366,7 @@ export namespace Atspi {
|
|
|
5970
6366
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
5971
6367
|
* @param ctype the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
5972
6368
|
* @returns An {@link Atspi.Rect} giving the accessible's extents.
|
|
6369
|
+
* @throws GLib.Error
|
|
5973
6370
|
*/
|
|
5974
6371
|
get_extents(ctype: CoordType): Rect;
|
|
5975
6372
|
|
|
@@ -5977,6 +6374,7 @@ export namespace Atspi {
|
|
|
5977
6374
|
* Queries which layer the component is painted into, to help determine its
|
|
5978
6375
|
* visibility in terms of stacking order.
|
|
5979
6376
|
* @returns the {@link Atspi.ComponentLayer} into which this component is painted.
|
|
6377
|
+
* @throws GLib.Error
|
|
5980
6378
|
*/
|
|
5981
6379
|
get_layer(): ComponentLayer;
|
|
5982
6380
|
|
|
@@ -5984,6 +6382,7 @@ export namespace Atspi {
|
|
|
5984
6382
|
* Queries the z stacking order of a component which is in the MDI or window
|
|
5985
6383
|
* layer. (Bigger z-order numbers mean nearer the top)
|
|
5986
6384
|
* @returns a `gshort` indicating the stacking order of the component in the MDI layer, or -1 if the component is not in the MDI layer.
|
|
6385
|
+
* @throws GLib.Error
|
|
5987
6386
|
*/
|
|
5988
6387
|
get_mdi_z_order(): number;
|
|
5989
6388
|
|
|
@@ -5993,6 +6392,7 @@ export namespace Atspi {
|
|
|
5993
6392
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
5994
6393
|
* @param ctype the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
5995
6394
|
* @returns An {@link Atspi.Point} giving the `obj`'s position.
|
|
6395
|
+
* @throws GLib.Error
|
|
5996
6396
|
*/
|
|
5997
6397
|
get_position(ctype: CoordType): Point;
|
|
5998
6398
|
|
|
@@ -6001,6 +6401,7 @@ export namespace Atspi {
|
|
|
6001
6401
|
* The returned values are meaningful only if the Component has both
|
|
6002
6402
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
6003
6403
|
* @returns An {@link Atspi.Point} giving the `obj`'s size.
|
|
6404
|
+
* @throws GLib.Error
|
|
6004
6405
|
*/
|
|
6005
6406
|
get_size(): Point;
|
|
6006
6407
|
|
|
@@ -6008,6 +6409,7 @@ export namespace Atspi {
|
|
|
6008
6409
|
* Attempts to set the keyboard input focus to the specified
|
|
6009
6410
|
* {@link Atspi.Component}.
|
|
6010
6411
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
6412
|
+
* @throws GLib.Error
|
|
6011
6413
|
*/
|
|
6012
6414
|
grab_focus(): boolean;
|
|
6013
6415
|
|
|
@@ -6016,6 +6418,7 @@ export namespace Atspi {
|
|
|
6016
6418
|
* visible on the screen.
|
|
6017
6419
|
* @param type a {@link Atspi.ScrollType} indicating where the object should be placed on the screen.
|
|
6018
6420
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
6421
|
+
* @throws GLib.Error
|
|
6019
6422
|
*/
|
|
6020
6423
|
scroll_to(type: ScrollType): boolean;
|
|
6021
6424
|
|
|
@@ -6026,6 +6429,7 @@ export namespace Atspi {
|
|
|
6026
6429
|
* @param x the x coordinate of the point to reach
|
|
6027
6430
|
* @param y the y coordinate of the point to reach
|
|
6028
6431
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
6432
|
+
* @throws GLib.Error
|
|
6029
6433
|
*/
|
|
6030
6434
|
scroll_to_point(coords: CoordType, x: number, y: number): boolean;
|
|
6031
6435
|
|
|
@@ -6037,6 +6441,7 @@ export namespace Atspi {
|
|
|
6037
6441
|
* @param height the height to which the component should be resized.
|
|
6038
6442
|
* @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
6039
6443
|
* @returns `TRUE` if successful; `FALSE` otherwise.
|
|
6444
|
+
* @throws GLib.Error
|
|
6040
6445
|
*/
|
|
6041
6446
|
set_extents(x: number, y: number, width: number, height: number, ctype: CoordType): boolean;
|
|
6042
6447
|
|
|
@@ -6046,6 +6451,7 @@ export namespace Atspi {
|
|
|
6046
6451
|
* @param y the new vertical position to which the component should be moved.
|
|
6047
6452
|
* @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
6048
6453
|
* @returns `TRUE` if successful; `FALSE` otherwise.
|
|
6454
|
+
* @throws GLib.Error
|
|
6049
6455
|
*/
|
|
6050
6456
|
set_position(x: number, y: number, ctype: CoordType): boolean;
|
|
6051
6457
|
|
|
@@ -6054,6 +6460,7 @@ export namespace Atspi {
|
|
|
6054
6460
|
* @param width the width to which the component should be resized.
|
|
6055
6461
|
* @param height the height to which the component should be resized.
|
|
6056
6462
|
* @returns `TRUE` if successful; `FALSE` otherwise.
|
|
6463
|
+
* @throws GLib.Error
|
|
6057
6464
|
*/
|
|
6058
6465
|
set_size(width: number, height: number): boolean;
|
|
6059
6466
|
}
|
|
@@ -6083,6 +6490,8 @@ export namespace Atspi {
|
|
|
6083
6490
|
* Gets the value of a single attribute, if specified for the document as a whole.
|
|
6084
6491
|
* @param attribute a string indicating the name of a specific attribute.
|
|
6085
6492
|
* @returns a string corresponding to the value of the specified attribute, or an empty string if the attribute is unspecified for the object.
|
|
6493
|
+
* @deprecated since 2.10: Use atspi_document_get_document_attribute_value instead.
|
|
6494
|
+
* @throws GLib.Error
|
|
6086
6495
|
*/
|
|
6087
6496
|
get_document_attribute_value(attribute: string): string;
|
|
6088
6497
|
|
|
@@ -6090,12 +6499,15 @@ export namespace Atspi {
|
|
|
6090
6499
|
* Gets all constant attributes for the document as a whole. For attributes
|
|
6091
6500
|
* that change within the document content, see `atspi_text_get_attribute_run` instead.
|
|
6092
6501
|
* @returns a {@link GLib.HashTable} containing the constant attributes of the document, as name-value pairs.
|
|
6502
|
+
* @deprecated since 2.10: Use atspi_document_get_document_attributes instead.
|
|
6503
|
+
* @throws GLib.Error
|
|
6093
6504
|
*/
|
|
6094
6505
|
get_document_attributes(): { [key: string]: string };
|
|
6095
6506
|
|
|
6096
6507
|
/**
|
|
6097
6508
|
* Gets the current page number of an `AccessibleDocument` object.
|
|
6098
6509
|
* @returns a `gint` indicating the current page number in the `AccessibleDocument` object.
|
|
6510
|
+
* @throws GLib.Error
|
|
6099
6511
|
*/
|
|
6100
6512
|
get_current_page_number(): number;
|
|
6101
6513
|
|
|
@@ -6103,18 +6515,22 @@ export namespace Atspi {
|
|
|
6103
6515
|
* Gets the locale associated with the document's content,
|
|
6104
6516
|
* e.g. the locale for LOCALE_TYPE_MESSAGES.
|
|
6105
6517
|
* @returns a string compliant with the POSIX standard for locale description.
|
|
6518
|
+
* @throws GLib.Error
|
|
6106
6519
|
*/
|
|
6107
6520
|
get_locale(): string;
|
|
6108
6521
|
|
|
6109
6522
|
/**
|
|
6110
6523
|
* Gets the page count of an `AccessibleDocument` object.
|
|
6111
6524
|
* @returns a `gint` indicating the page count of an `AccessibleDocument` object.
|
|
6525
|
+
* @throws GLib.Error
|
|
6112
6526
|
*/
|
|
6113
6527
|
get_page_count(): number;
|
|
6114
6528
|
|
|
6115
6529
|
/**
|
|
6116
6530
|
* Returns an array of AtspiTextSelections within this document.
|
|
6117
6531
|
* @returns a GArray of AtspiTextSelection structures representing the selection.
|
|
6532
|
+
* @since 2.52
|
|
6533
|
+
* @throws GLib.Error
|
|
6118
6534
|
*/
|
|
6119
6535
|
get_text_selections(): TextSelection[];
|
|
6120
6536
|
|
|
@@ -6126,6 +6542,8 @@ export namespace Atspi {
|
|
|
6126
6542
|
* FALSE will be returned.
|
|
6127
6543
|
* @param selections a GArray of AtspiTextSelections to be selected.
|
|
6128
6544
|
* @returns TRUE if the selection was made successfully; FALSE otherwise.
|
|
6545
|
+
* @since 2.52
|
|
6546
|
+
* @throws GLib.Error
|
|
6129
6547
|
*/
|
|
6130
6548
|
set_text_selections(selections: TextSelection[]): boolean;
|
|
6131
6549
|
}
|
|
@@ -6158,6 +6576,7 @@ export namespace Atspi {
|
|
|
6158
6576
|
* @param start_pos a `gint` indicating the starting character offset of the text to copy.
|
|
6159
6577
|
* @param end_pos a `gint` indicating the offset of the first character past the end of the text section to be copied.
|
|
6160
6578
|
* @returns `TRUE` if the operation was successful, otherwise `FALSE`.
|
|
6579
|
+
* @throws GLib.Error
|
|
6161
6580
|
*/
|
|
6162
6581
|
copy_text(start_pos: number, end_pos: number): boolean;
|
|
6163
6582
|
|
|
@@ -6169,6 +6588,7 @@ export namespace Atspi {
|
|
|
6169
6588
|
* @param start_pos a `gint` indicating the starting character offset of the text to cut.
|
|
6170
6589
|
* @param end_pos a `gint` indicating the offset of the first character past the end of the text section to be cut.
|
|
6171
6590
|
* @returns `TRUE` if operation was successful, `FALSE` otherwise.
|
|
6591
|
+
* @throws GLib.Error
|
|
6172
6592
|
*/
|
|
6173
6593
|
cut_text(start_pos: number, end_pos: number): boolean;
|
|
6174
6594
|
|
|
@@ -6180,6 +6600,7 @@ export namespace Atspi {
|
|
|
6180
6600
|
* @param start_pos a `gint` indicating the starting character offset of the text to delete.
|
|
6181
6601
|
* @param end_pos a `gint` indicating the offset of the first character past the end of the text section to be deleted.
|
|
6182
6602
|
* @returns `TRUE` if the operation was successful, otherwise `FALSE`.
|
|
6603
|
+
* @throws GLib.Error
|
|
6183
6604
|
*/
|
|
6184
6605
|
delete_text(start_pos: number, end_pos: number): boolean;
|
|
6185
6606
|
|
|
@@ -6192,6 +6613,7 @@ export namespace Atspi {
|
|
|
6192
6613
|
* @param text a string representing the text to insert, in UTF-8 encoding.
|
|
6193
6614
|
* @param length the number of characters of text to insert, in bytes. If the byte count of text is less than or equal to length, the entire contents of text will be inserted.
|
|
6194
6615
|
* @returns `TRUE` if the operation was successful, otherwise `FALSE`.
|
|
6616
|
+
* @throws GLib.Error
|
|
6195
6617
|
*/
|
|
6196
6618
|
insert_text(position: number, text: string, length: number): boolean;
|
|
6197
6619
|
|
|
@@ -6202,6 +6624,7 @@ export namespace Atspi {
|
|
|
6202
6624
|
* variable-width encoding.
|
|
6203
6625
|
* @param position a `gint` indicating the character offset at which to insert the new text.
|
|
6204
6626
|
* @returns `TRUE` if the operation was successful, otherwise `FALSE`.
|
|
6627
|
+
* @throws GLib.Error
|
|
6205
6628
|
*/
|
|
6206
6629
|
paste_text(position: number): boolean;
|
|
6207
6630
|
|
|
@@ -6209,6 +6632,7 @@ export namespace Atspi {
|
|
|
6209
6632
|
* Replace the entire text contents of an {@link Atspi.EditableText} object.
|
|
6210
6633
|
* @param new_contents a character string, encoded in UTF-8, which is to become the new text contents of the {@link Atspi.EditableText} object.
|
|
6211
6634
|
* @returns `TRUE` if the operation was successful, otherwise `FALSE`.
|
|
6635
|
+
* @throws GLib.Error
|
|
6212
6636
|
*/
|
|
6213
6637
|
set_text_contents(new_contents: string): boolean;
|
|
6214
6638
|
}
|
|
@@ -6246,6 +6670,7 @@ export namespace Atspi {
|
|
|
6246
6670
|
* Gets the {@link Atspi.Hyperlink} object at a specified index.
|
|
6247
6671
|
* @param link_index a (zero-index) `gint` indicating which hyperlink to query.
|
|
6248
6672
|
* @returns the {@link Atspi.Hyperlink} object specified by `link_index`.
|
|
6673
|
+
* @throws GLib.Error
|
|
6249
6674
|
*/
|
|
6250
6675
|
get_link(link_index: number): Hyperlink | null;
|
|
6251
6676
|
|
|
@@ -6254,6 +6679,7 @@ export namespace Atspi {
|
|
|
6254
6679
|
* character offset.
|
|
6255
6680
|
* @param character_offset a `gint` specifying the character offset to query.
|
|
6256
6681
|
* @returns the linkIndex of the {@link Atspi.Hyperlink} active at character offset `character_offset`, or -1 if there is no hyperlink at the specified character offset.
|
|
6682
|
+
* @throws GLib.Error
|
|
6257
6683
|
*/
|
|
6258
6684
|
get_link_index(character_offset: number): number;
|
|
6259
6685
|
|
|
@@ -6261,6 +6687,7 @@ export namespace Atspi {
|
|
|
6261
6687
|
* Gets the total number of {@link Atspi.Hyperlink} objects that an
|
|
6262
6688
|
* {@link Atspi.Hypertext} implementor has.
|
|
6263
6689
|
* @returns a `gint` indicating the number of {@link Atspi.Hyperlink} objects of the {@link Atspi.Hypertext} implementor, or -1 if the number cannot be determined (for example, if the {@link Atspi.Hypertext} object is so large that it is not all currently in the memory cache).
|
|
6690
|
+
* @throws GLib.Error
|
|
6264
6691
|
*/
|
|
6265
6692
|
get_n_links(): number;
|
|
6266
6693
|
}
|
|
@@ -6289,6 +6716,7 @@ export namespace Atspi {
|
|
|
6289
6716
|
/**
|
|
6290
6717
|
* Gets the description of the image displayed in an {@link Atspi.Image} object.
|
|
6291
6718
|
* @returns a UTF-8 string describing the image.
|
|
6719
|
+
* @throws GLib.Error
|
|
6292
6720
|
*/
|
|
6293
6721
|
get_image_description(): string;
|
|
6294
6722
|
|
|
@@ -6299,12 +6727,14 @@ export namespace Atspi {
|
|
|
6299
6727
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
6300
6728
|
* @param ctype the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
6301
6729
|
* @returns a pointer to an {@link Atspi.Rect} corresponding to the image's bounding box. The minimum x and y coordinates, width, and height are specified.
|
|
6730
|
+
* @throws GLib.Error
|
|
6302
6731
|
*/
|
|
6303
6732
|
get_image_extents(ctype: CoordType): Rect;
|
|
6304
6733
|
|
|
6305
6734
|
/**
|
|
6306
6735
|
* Gets the locale associated with an image and its textual representation.
|
|
6307
6736
|
* @returns A POSIX LC_MESSAGES-style locale value for image description and text.
|
|
6737
|
+
* @throws GLib.Error
|
|
6308
6738
|
*/
|
|
6309
6739
|
get_image_locale(): string;
|
|
6310
6740
|
|
|
@@ -6315,6 +6745,7 @@ export namespace Atspi {
|
|
|
6315
6745
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
6316
6746
|
* @param ctype the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
|
|
6317
6747
|
* @returns a pointer to an {@link Atspi.Point} where x and y correspond to the minimum coordinates of the displayed image.
|
|
6748
|
+
* @throws GLib.Error
|
|
6318
6749
|
*/
|
|
6319
6750
|
get_image_position(ctype: CoordType): Point;
|
|
6320
6751
|
|
|
@@ -6323,6 +6754,7 @@ export namespace Atspi {
|
|
|
6323
6754
|
* The returned values are meaningful only if the Image has both
|
|
6324
6755
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
6325
6756
|
* @returns a pointer to an {@link Atspi.Point} where x corresponds to the image's width and y corresponds to the image's height.
|
|
6757
|
+
* @throws GLib.Error
|
|
6326
6758
|
*/
|
|
6327
6759
|
get_image_size(): Point;
|
|
6328
6760
|
}
|
|
@@ -6360,6 +6792,7 @@ export namespace Atspi {
|
|
|
6360
6792
|
* Clears the current selection, removing all selected children from the
|
|
6361
6793
|
* specified {@link Atspi.Selection} implementor's selection list.
|
|
6362
6794
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
6795
|
+
* @throws GLib.Error
|
|
6363
6796
|
*/
|
|
6364
6797
|
clear_selection(): boolean;
|
|
6365
6798
|
|
|
@@ -6371,6 +6804,7 @@ export namespace Atspi {
|
|
|
6371
6804
|
* See `atspi_selection_deselect_selected_child`
|
|
6372
6805
|
* @param child_index a `gint` indicating which of the children of the {@link Atspi.Accessible} is to be de-selected.
|
|
6373
6806
|
* @returns `TRUE` if the child was successfully deselected, `FALSE` otherwise.
|
|
6807
|
+
* @throws GLib.Error
|
|
6374
6808
|
*/
|
|
6375
6809
|
deselect_child(child_index: number): boolean;
|
|
6376
6810
|
|
|
@@ -6382,6 +6816,7 @@ export namespace Atspi {
|
|
|
6382
6816
|
* `atspi_selection_select_child` are asymmetric.
|
|
6383
6817
|
* @param selected_child_index a `gint` indicating which of the selected children of the {@link Atspi.Accessible} is to be deselected.
|
|
6384
6818
|
* @returns `TRUE` if the child was successfully deselected, `FALSE` otherwise.
|
|
6819
|
+
* @throws GLib.Error
|
|
6385
6820
|
*/
|
|
6386
6821
|
deselect_selected_child(selected_child_index: number): boolean;
|
|
6387
6822
|
|
|
@@ -6389,6 +6824,7 @@ export namespace Atspi {
|
|
|
6389
6824
|
* Gets the number of children of an {@link Atspi.Selection} implementor which are
|
|
6390
6825
|
* currently selected.
|
|
6391
6826
|
* @returns a `gint` indicating the number of {@link Atspi.Accessible} children of the {@link Atspi.Selection} implementor which are currently selected.
|
|
6827
|
+
* @throws GLib.Error
|
|
6392
6828
|
*/
|
|
6393
6829
|
get_n_selected_children(): number;
|
|
6394
6830
|
|
|
@@ -6403,6 +6839,7 @@ export namespace Atspi {
|
|
|
6403
6839
|
* and `atspi_selection_get_n_selected_children` - 1, inclusive.
|
|
6404
6840
|
* @param selected_child_index a `gint` indicating which of the selected children is specified.
|
|
6405
6841
|
* @returns a pointer to a selected {@link Atspi.Accessible} child object, specified by `selected_child_index`.
|
|
6842
|
+
* @throws GLib.Error
|
|
6406
6843
|
*/
|
|
6407
6844
|
get_selected_child(selected_child_index: number): Accessible;
|
|
6408
6845
|
|
|
@@ -6412,6 +6849,7 @@ export namespace Atspi {
|
|
|
6412
6849
|
* standard {@link Atspi.Accessible} container's list of children.
|
|
6413
6850
|
* @param child_index an index into the {@link Atspi.Selection}'s list of children.
|
|
6414
6851
|
* @returns `TRUE` if the specified child is currently selected, `FALSE` otherwise.
|
|
6852
|
+
* @throws GLib.Error
|
|
6415
6853
|
*/
|
|
6416
6854
|
is_child_selected(child_index: number): boolean;
|
|
6417
6855
|
|
|
@@ -6419,6 +6857,7 @@ export namespace Atspi {
|
|
|
6419
6857
|
* Attempts to select all of the children of an {@link Atspi.Selection} implementor.
|
|
6420
6858
|
* Not all {@link Atspi.Selection} implementors support this operation.
|
|
6421
6859
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
6860
|
+
* @throws GLib.Error
|
|
6422
6861
|
*/
|
|
6423
6862
|
select_all(): boolean;
|
|
6424
6863
|
|
|
@@ -6429,6 +6868,7 @@ export namespace Atspi {
|
|
|
6429
6868
|
* selection.
|
|
6430
6869
|
* @param child_index a `gint` indicating which child of the {@link Atspi.Accessible} is to be selected.
|
|
6431
6870
|
* @returns `TRUE` if the child was successfully selected, `FALSE` otherwise.
|
|
6871
|
+
* @throws GLib.Error
|
|
6432
6872
|
*/
|
|
6433
6873
|
select_child(child_index: number): boolean;
|
|
6434
6874
|
}
|
|
@@ -6470,6 +6910,7 @@ export namespace Atspi {
|
|
|
6470
6910
|
* Not all tables support column selection.
|
|
6471
6911
|
* @param column the zero-indexed column number of the column being selected.
|
|
6472
6912
|
* @returns `TRUE` if the specified column was successfully selected, `FALSE` if not.
|
|
6913
|
+
* @throws GLib.Error
|
|
6473
6914
|
*/
|
|
6474
6915
|
add_column_selection(column: number): boolean;
|
|
6475
6916
|
|
|
@@ -6478,6 +6919,7 @@ export namespace Atspi {
|
|
|
6478
6919
|
* Not all tables support row selection.
|
|
6479
6920
|
* @param row the zero-indexed row number of the row being selected.
|
|
6480
6921
|
* @returns `TRUE` if the specified row was successfully selected, `FALSE` if not.
|
|
6922
|
+
* @throws GLib.Error
|
|
6481
6923
|
*/
|
|
6482
6924
|
add_row_selection(row: number): boolean;
|
|
6483
6925
|
|
|
@@ -6488,12 +6930,14 @@ export namespace Atspi {
|
|
|
6488
6930
|
* @param row the specified table row, zero-indexed.
|
|
6489
6931
|
* @param column the specified table column, zero-indexed.
|
|
6490
6932
|
* @returns an {@link Atspi.Accessible} object representing the specified table cell.
|
|
6933
|
+
* @throws GLib.Error
|
|
6491
6934
|
*/
|
|
6492
6935
|
get_accessible_at(row: number, column: number): Accessible;
|
|
6493
6936
|
|
|
6494
6937
|
/**
|
|
6495
6938
|
* Gets an accessible representation of the caption for an {@link Atspi.Table}.
|
|
6496
6939
|
* @returns an {@link Atspi.Accessible} object that serves as the table's caption.
|
|
6940
|
+
* @throws GLib.Error
|
|
6497
6941
|
*/
|
|
6498
6942
|
get_caption(): Accessible;
|
|
6499
6943
|
|
|
@@ -6504,6 +6948,7 @@ export namespace Atspi {
|
|
|
6504
6948
|
* `see` `atspi_table_get_index_at`, `atspi_table_get_row_at_index`
|
|
6505
6949
|
* @param index the specified child index, zero-indexed.
|
|
6506
6950
|
* @returns a `gint` indicating the first column spanned by the child of a table, at the specified 1-D (zero-offset) `index`.
|
|
6951
|
+
* @throws GLib.Error
|
|
6507
6952
|
*/
|
|
6508
6953
|
get_column_at_index(index: number): number;
|
|
6509
6954
|
|
|
@@ -6512,6 +6957,7 @@ export namespace Atspi {
|
|
|
6512
6957
|
* `atspi_table_get_column_header`, which returns an {@link Atspi.Accessible}.
|
|
6513
6958
|
* @param column the specified table column, zero-indexed.
|
|
6514
6959
|
* @returns a UTF-8 string describing the specified table column, if available.
|
|
6960
|
+
* @throws GLib.Error
|
|
6515
6961
|
*/
|
|
6516
6962
|
get_column_description(column: number): string;
|
|
6517
6963
|
|
|
@@ -6524,6 +6970,7 @@ export namespace Atspi {
|
|
|
6524
6970
|
* @param row the specified table row, zero-indexed.
|
|
6525
6971
|
* @param column the specified table column, zero-indexed.
|
|
6526
6972
|
* @returns a `gint` indicating the number of columns spanned by the specified cell.
|
|
6973
|
+
* @throws GLib.Error
|
|
6527
6974
|
*/
|
|
6528
6975
|
get_column_extent_at(row: number, column: number): number;
|
|
6529
6976
|
|
|
@@ -6533,6 +6980,7 @@ export namespace Atspi {
|
|
|
6533
6980
|
* returns a string.
|
|
6534
6981
|
* @param column the specified table column, zero-indexed.
|
|
6535
6982
|
* @returns an {@link Atspi.Accessible} representation of the specified table column, if available.
|
|
6983
|
+
* @throws GLib.Error
|
|
6536
6984
|
*/
|
|
6537
6985
|
get_column_header(column: number): Accessible;
|
|
6538
6986
|
|
|
@@ -6545,6 +6993,7 @@ export namespace Atspi {
|
|
|
6545
6993
|
* @param row the specified table row, zero-indexed.
|
|
6546
6994
|
* @param column the specified table column, zero-indexed.
|
|
6547
6995
|
* @returns a `gint` which serves as the index of a specified cell in the table, in a form usable by `atspi_get_child_at_index`.
|
|
6996
|
+
* @throws GLib.Error
|
|
6548
6997
|
*/
|
|
6549
6998
|
get_index_at(row: number, column: number): number;
|
|
6550
6999
|
|
|
@@ -6553,6 +7002,7 @@ export namespace Atspi {
|
|
|
6553
7002
|
* exclusive of any columns that are programmatically hidden, but inclusive
|
|
6554
7003
|
* of columns that may be outside of the current scrolling window or viewport.
|
|
6555
7004
|
* @returns a `gint` indicating the number of columns in the table.
|
|
7005
|
+
* @throws GLib.Error
|
|
6556
7006
|
*/
|
|
6557
7007
|
get_n_columns(): number;
|
|
6558
7008
|
|
|
@@ -6561,6 +7011,7 @@ export namespace Atspi {
|
|
|
6561
7011
|
* exclusive of any rows that are programmatically hidden, but inclusive
|
|
6562
7012
|
* of rows that may be outside of the current scrolling window or viewport.
|
|
6563
7013
|
* @returns a `gint` indicating the number of rows in the table.
|
|
7014
|
+
* @throws GLib.Error
|
|
6564
7015
|
*/
|
|
6565
7016
|
get_n_rows(): number;
|
|
6566
7017
|
|
|
@@ -6568,6 +7019,7 @@ export namespace Atspi {
|
|
|
6568
7019
|
* Queries a table to find out how many columns are currently selected.
|
|
6569
7020
|
* Not all tables support column selection.
|
|
6570
7021
|
* @returns a `gint` indicating the number of columns currently selected.
|
|
7022
|
+
* @throws GLib.Error
|
|
6571
7023
|
*/
|
|
6572
7024
|
get_n_selected_columns(): number;
|
|
6573
7025
|
|
|
@@ -6575,6 +7027,7 @@ export namespace Atspi {
|
|
|
6575
7027
|
* Query a table to find out how many rows are currently selected.
|
|
6576
7028
|
* Not all tables support row selection.
|
|
6577
7029
|
* @returns a `gint` indicating the number of rows currently selected.
|
|
7030
|
+
* @throws GLib.Error
|
|
6578
7031
|
*/
|
|
6579
7032
|
get_n_selected_rows(): number;
|
|
6580
7033
|
|
|
@@ -6585,6 +7038,7 @@ export namespace Atspi {
|
|
|
6585
7038
|
* `see` `atspi_table_get_index_at`, `atspi_table_get_column_at_index`
|
|
6586
7039
|
* @param index the specified child index, zero-indexed.
|
|
6587
7040
|
* @returns a `gint` indicating the first row spanned by the child of a table, at the specified 1-D (zero-offset) `index`.
|
|
7041
|
+
* @throws GLib.Error
|
|
6588
7042
|
*/
|
|
6589
7043
|
get_row_at_index(index: number): number;
|
|
6590
7044
|
|
|
@@ -6612,6 +7066,7 @@ export namespace Atspi {
|
|
|
6612
7066
|
* `TRUE`, respectively.
|
|
6613
7067
|
* @param index the index of the {@link Atspi.Table} child whose row/column extents are requested.
|
|
6614
7068
|
* @returns `TRUE` if the index is associated with a valid table cell, `FALSE` if the index does not correspond to a cell. If `FALSE` is returned, the values of the out parameters are undefined.
|
|
7069
|
+
* @throws GLib.Error
|
|
6615
7070
|
*/
|
|
6616
7071
|
get_row_column_extents_at_index(index: number): [boolean, number, number, number, number, boolean];
|
|
6617
7072
|
|
|
@@ -6620,6 +7075,7 @@ export namespace Atspi {
|
|
|
6620
7075
|
* `atspi_table_get_row_header`, which returns an {@link Atspi.Accessible}.
|
|
6621
7076
|
* @param row the specified table row, zero-indexed.
|
|
6622
7077
|
* @returns a UTF-8 string describing the specified table row, if available.
|
|
7078
|
+
* @throws GLib.Error
|
|
6623
7079
|
*/
|
|
6624
7080
|
get_row_description(row: number): string;
|
|
6625
7081
|
|
|
@@ -6632,6 +7088,7 @@ export namespace Atspi {
|
|
|
6632
7088
|
* @param row the specified table row, zero-indexed.
|
|
6633
7089
|
* @param column the specified table column, zero-indexed.
|
|
6634
7090
|
* @returns a `gint` indicating the number of rows spanned by the specified cell.
|
|
7091
|
+
* @throws GLib.Error
|
|
6635
7092
|
*/
|
|
6636
7093
|
get_row_extent_at(row: number, column: number): number;
|
|
6637
7094
|
|
|
@@ -6640,6 +7097,7 @@ export namespace Atspi {
|
|
|
6640
7097
|
* `atspi_table_get_row_description`, which returns a string.
|
|
6641
7098
|
* @param row the specified table row, zero-indexed.
|
|
6642
7099
|
* @returns an {@link Atspi.Accessible} representation of the specified table row, if available.
|
|
7100
|
+
* @throws GLib.Error
|
|
6643
7101
|
*/
|
|
6644
7102
|
get_row_header(row: number): Accessible;
|
|
6645
7103
|
|
|
@@ -6647,18 +7105,21 @@ export namespace Atspi {
|
|
|
6647
7105
|
* Queries a table for a list of indices of columns which are currently
|
|
6648
7106
|
* selected.
|
|
6649
7107
|
* @returns an array of `gint` values, specifying which columns are currently selected.
|
|
7108
|
+
* @throws GLib.Error
|
|
6650
7109
|
*/
|
|
6651
7110
|
get_selected_columns(): number[];
|
|
6652
7111
|
|
|
6653
7112
|
/**
|
|
6654
7113
|
* Queries a table for a list of indices of rows which are currently selected.
|
|
6655
7114
|
* @returns an array of `gint` values, specifying which rows are currently selected.
|
|
7115
|
+
* @throws GLib.Error
|
|
6656
7116
|
*/
|
|
6657
7117
|
get_selected_rows(): number[];
|
|
6658
7118
|
|
|
6659
7119
|
/**
|
|
6660
7120
|
* Gets an accessible object which summarizes the contents of an {@link Atspi.Table}.
|
|
6661
7121
|
* @returns an {@link Atspi.Accessible} object that serves as the table's summary (often a reduced {@link Atspi.Table}).
|
|
7122
|
+
* @throws GLib.Error
|
|
6662
7123
|
*/
|
|
6663
7124
|
get_summary(): Accessible;
|
|
6664
7125
|
|
|
@@ -6667,6 +7128,7 @@ export namespace Atspi {
|
|
|
6667
7128
|
* Not all tables support column selection.
|
|
6668
7129
|
* @param column the zero-indexed column number of the column being queried.
|
|
6669
7130
|
* @returns `TRUE` if the specified column is currently selected, `FALSE` if not.
|
|
7131
|
+
* @throws GLib.Error
|
|
6670
7132
|
*/
|
|
6671
7133
|
is_column_selected(column: number): boolean;
|
|
6672
7134
|
|
|
@@ -6675,6 +7137,7 @@ export namespace Atspi {
|
|
|
6675
7137
|
* row selection.
|
|
6676
7138
|
* @param row the zero-indexed row number of the row being queried.
|
|
6677
7139
|
* @returns `TRUE` if the specified row is currently selected, `FALSE` if not.
|
|
7140
|
+
* @throws GLib.Error
|
|
6678
7141
|
*/
|
|
6679
7142
|
is_row_selected(row: number): boolean;
|
|
6680
7143
|
|
|
@@ -6683,6 +7146,7 @@ export namespace Atspi {
|
|
|
6683
7146
|
* @param row the zero-indexed row of the cell being queried.
|
|
6684
7147
|
* @param column the zero-indexed column of the cell being queried.
|
|
6685
7148
|
* @returns `TRUE` if the specified cell is currently selected, `FALSE` if not.
|
|
7149
|
+
* @throws GLib.Error
|
|
6686
7150
|
*/
|
|
6687
7151
|
is_selected(row: number, column: number): boolean;
|
|
6688
7152
|
|
|
@@ -6692,6 +7156,7 @@ export namespace Atspi {
|
|
|
6692
7156
|
* Not all tables support column selection.
|
|
6693
7157
|
* @param column the zero-indexed column number of the column being de-selected.
|
|
6694
7158
|
* @returns `TRUE` if the specified column was successfully de-selected, `FALSE` if not.
|
|
7159
|
+
* @throws GLib.Error
|
|
6695
7160
|
*/
|
|
6696
7161
|
remove_column_selection(column: number): boolean;
|
|
6697
7162
|
|
|
@@ -6700,6 +7165,7 @@ export namespace Atspi {
|
|
|
6700
7165
|
* Not all tables support row selection.
|
|
6701
7166
|
* @param row the zero-indexed number of the row being de-selected.
|
|
6702
7167
|
* @returns `TRUE` if the specified row was successfully de-selected, `FALSE` if not.
|
|
7168
|
+
* @throws GLib.Error
|
|
6703
7169
|
*/
|
|
6704
7170
|
remove_row_selection(row: number): boolean;
|
|
6705
7171
|
}
|
|
@@ -6728,9 +7194,13 @@ export namespace Atspi {
|
|
|
6728
7194
|
/**
|
|
6729
7195
|
* Returns the column headers as an array of cell accessibles.
|
|
6730
7196
|
* @returns a GPtrArray of AtspiAccessibles representing the column header cells.
|
|
7197
|
+
* @throws GLib.Error
|
|
6731
7198
|
*/
|
|
6732
7199
|
get_column_header_cells(): Accessible[];
|
|
6733
7200
|
|
|
7201
|
+
/**
|
|
7202
|
+
* @throws GLib.Error
|
|
7203
|
+
*/
|
|
6734
7204
|
get_column_index(): number;
|
|
6735
7205
|
|
|
6736
7206
|
/**
|
|
@@ -6738,12 +7208,14 @@ export namespace Atspi {
|
|
|
6738
7208
|
* The returned values are meaningful only if the table cell has both
|
|
6739
7209
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
6740
7210
|
* @returns a gint representing the number of columns occupied by this cell, or 0 if the cell does not implement this method.
|
|
7211
|
+
* @throws GLib.Error
|
|
6741
7212
|
*/
|
|
6742
7213
|
get_column_span(): number;
|
|
6743
7214
|
|
|
6744
7215
|
/**
|
|
6745
7216
|
* Retrieves the tabular position of this cell.
|
|
6746
7217
|
* @returns TRUE if successful, FALSE otherwise.
|
|
7218
|
+
* @throws GLib.Error
|
|
6747
7219
|
*/
|
|
6748
7220
|
get_position(): [number, number, number];
|
|
6749
7221
|
|
|
@@ -6751,12 +7223,14 @@ export namespace Atspi {
|
|
|
6751
7223
|
* Gets the row and column indexes and extents of this cell accessible.
|
|
6752
7224
|
* The returned values are meaningful only if the table cell has both
|
|
6753
7225
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
7226
|
+
* @throws GLib.Error
|
|
6754
7227
|
*/
|
|
6755
7228
|
get_row_column_span(): [number, number, number, number];
|
|
6756
7229
|
|
|
6757
7230
|
/**
|
|
6758
7231
|
* Returns the row headers as an array of cell accessibles.
|
|
6759
7232
|
* @returns a GPtrArray of AtspiAccessibles representing the row header cells.
|
|
7233
|
+
* @throws GLib.Error
|
|
6760
7234
|
*/
|
|
6761
7235
|
get_row_header_cells(): Accessible[];
|
|
6762
7236
|
|
|
@@ -6765,12 +7239,14 @@ export namespace Atspi {
|
|
|
6765
7239
|
* The returned values are meaningful only if the table cell has both
|
|
6766
7240
|
* STATE_VISIBLE and STATE_SHOWING.
|
|
6767
7241
|
* @returns a gint representing the number of rows occupied by this cell, or 0 if the cell does not implement this method.
|
|
7242
|
+
* @throws GLib.Error
|
|
6768
7243
|
*/
|
|
6769
7244
|
get_row_span(): number;
|
|
6770
7245
|
|
|
6771
7246
|
/**
|
|
6772
7247
|
* Returns a reference to the accessible of the containing table.
|
|
6773
7248
|
* @returns the AtspiAccessible for the containing table.
|
|
7249
|
+
* @throws GLib.Error
|
|
6774
7250
|
*/
|
|
6775
7251
|
get_table(): Accessible;
|
|
6776
7252
|
}
|
|
@@ -6810,6 +7286,7 @@ export namespace Atspi {
|
|
|
6810
7286
|
* @param start_offset the starting offset of the desired new selection.
|
|
6811
7287
|
* @param end_offset the offset of the first character after the new selection.
|
|
6812
7288
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
7289
|
+
* @throws GLib.Error
|
|
6813
7290
|
*/
|
|
6814
7291
|
add_selection(start_offset: number, end_offset: number): boolean;
|
|
6815
7292
|
|
|
@@ -6819,6 +7296,7 @@ export namespace Atspi {
|
|
|
6819
7296
|
* @param offset a `gint` indicating the offset from which the attribute search is based.
|
|
6820
7297
|
* @param include_defaults a #bool that, when set as `FALSE`, indicates the call should only return those attributes which are explicitly set on the current attribute run, omitting any attributes which are inherited from the default values.
|
|
6821
7298
|
* @returns a {@link GLib.HashTable} with attributes defined at the indicated offset, optionally including the 'default' ones.
|
|
7299
|
+
* @throws GLib.Error
|
|
6822
7300
|
*/
|
|
6823
7301
|
get_attribute_run(offset: number, include_defaults: boolean): [{ [key: string]: string }, number, number];
|
|
6824
7302
|
|
|
@@ -6827,6 +7305,8 @@ export namespace Atspi {
|
|
|
6827
7305
|
* @param offset The character offset at which to query the attribute.
|
|
6828
7306
|
* @param attribute_name The attribute to query.
|
|
6829
7307
|
* @returns the value of a given attribute at the given offset, or `null` if not present.
|
|
7308
|
+
* @deprecated since 2.10: Use atspi_text_get_text_attribute_value instead.
|
|
7309
|
+
* @throws GLib.Error
|
|
6830
7310
|
*/
|
|
6831
7311
|
get_text_attribute_value(offset: number, attribute_name: string): string | null;
|
|
6832
7312
|
|
|
@@ -6836,6 +7316,8 @@ export namespace Atspi {
|
|
|
6836
7316
|
* where possible.
|
|
6837
7317
|
* @param offset a `gint` indicating the offset from which the attribute search is based.
|
|
6838
7318
|
* @returns a {@link GLib.HashTable} describing the attributes at the given character offset.
|
|
7319
|
+
* @deprecated since 2.10: Use atspi_text_get_text_attributes instead.
|
|
7320
|
+
* @throws GLib.Error
|
|
6839
7321
|
*/
|
|
6840
7322
|
get_text_attributes(offset: number): [{ [key: string]: string }, number, number];
|
|
6841
7323
|
|
|
@@ -6850,12 +7332,14 @@ export namespace Atspi {
|
|
|
6850
7332
|
* @param clipTypeX an {@link Atspi.TextClipType} indicating how to treat characters that intersect the bounding box's x extents.
|
|
6851
7333
|
* @param clipTypeY an {@link Atspi.TextClipType} indicating how to treat characters that intersect the bounding box's y extents.
|
|
6852
7334
|
* @returns a null-terminated list of pointers to {@link Atspi.TextRange} structs detailing the bounded text.
|
|
7335
|
+
* @throws GLib.Error
|
|
6853
7336
|
*/
|
|
6854
7337
|
get_bounded_ranges(x: number, y: number, width: number, height: number, type: CoordType, clipTypeX: TextClipType, clipTypeY: TextClipType): TextRange[];
|
|
6855
7338
|
|
|
6856
7339
|
/**
|
|
6857
7340
|
* Gets the current offset of the text caret in an {@link Atspi.Text} object.
|
|
6858
7341
|
* @returns a `gint` indicating the current position of the text caret.
|
|
7342
|
+
* @throws GLib.Error
|
|
6859
7343
|
*/
|
|
6860
7344
|
get_caret_offset(): number;
|
|
6861
7345
|
|
|
@@ -6863,12 +7347,14 @@ export namespace Atspi {
|
|
|
6863
7347
|
* Gets the character at a given offset for an {@link Atspi.Text} object.
|
|
6864
7348
|
* @param offset a `gint` indicating the text offset where the desired character is located.
|
|
6865
7349
|
* @returns a `guint` representing the UCS-4 unicode code point of the given character, or 0xFFFFFFFF if the character in question cannot be represented in the UCS-4 encoding.
|
|
7350
|
+
* @throws GLib.Error
|
|
6866
7351
|
*/
|
|
6867
7352
|
get_character_at_offset(offset: number): number;
|
|
6868
7353
|
|
|
6869
7354
|
/**
|
|
6870
7355
|
* Gets the character count of an `AccessibleText` object.
|
|
6871
7356
|
* @returns a `gint` indicating the total number of characters in the `AccessibleText` object.
|
|
7357
|
+
* @throws GLib.Error
|
|
6872
7358
|
*/
|
|
6873
7359
|
get_character_count(): number;
|
|
6874
7360
|
|
|
@@ -6880,6 +7366,7 @@ export namespace Atspi {
|
|
|
6880
7366
|
* @param offset a `gint` indicating the offset of the text character for whom boundary information is requested.
|
|
6881
7367
|
* @param type an `AccessibleCoordType` indicating the coordinate system to use for the returned values.
|
|
6882
7368
|
* @returns An {@link Atspi.Rect} specifying the position and size of the character.
|
|
7369
|
+
* @throws GLib.Error
|
|
6883
7370
|
*/
|
|
6884
7371
|
get_character_extents(offset: number, type: CoordType): Rect;
|
|
6885
7372
|
|
|
@@ -6890,6 +7377,7 @@ export namespace Atspi {
|
|
|
6890
7377
|
* the attributes reported by `atspi_text_get_attributes`
|
|
6891
7378
|
* describes the entire set of text attributes over a range.
|
|
6892
7379
|
* @returns a {@link GLib.HashTable} containing the default attributes applied to a text object, (exclusive of explicitly-set attributes), encoded as UTF-8.
|
|
7380
|
+
* @throws GLib.Error
|
|
6893
7381
|
*/
|
|
6894
7382
|
get_default_attributes(): { [key: string]: string };
|
|
6895
7383
|
|
|
@@ -6897,6 +7385,7 @@ export namespace Atspi {
|
|
|
6897
7385
|
* Gets the number of active non-contiguous selections for an
|
|
6898
7386
|
* {@link Atspi.Text} object.
|
|
6899
7387
|
* @returns a `gint` indicating the current number of non-contiguous text selections active within an {@link Atspi.Text} object.
|
|
7388
|
+
* @throws GLib.Error
|
|
6900
7389
|
*/
|
|
6901
7390
|
get_n_selections(): number;
|
|
6902
7391
|
|
|
@@ -6906,6 +7395,7 @@ export namespace Atspi {
|
|
|
6906
7395
|
* @param y the y coordinate of the point to be queried.
|
|
6907
7396
|
* @param type an {@link Atspi.CoordType} indicating the coordinate system in which the values should be returned.
|
|
6908
7397
|
* @returns the offset (as a `gint`) at the point (`x`, `y`) in the specified coordinate system.
|
|
7398
|
+
* @throws GLib.Error
|
|
6909
7399
|
*/
|
|
6910
7400
|
get_offset_at_point(x: number, y: number, type: CoordType): number;
|
|
6911
7401
|
|
|
@@ -6917,6 +7407,7 @@ export namespace Atspi {
|
|
|
6917
7407
|
* @param end_offset a `gint` indicating the offset of the text character after the last character for whom boundary information is requested.
|
|
6918
7408
|
* @param type an {@link Atspi.CoordType} indicating the coordinate system to use for the returned values.
|
|
6919
7409
|
* @returns An {@link Atspi.Rect} giving the position and size of the specified range of text.
|
|
7410
|
+
* @throws GLib.Error
|
|
6920
7411
|
*/
|
|
6921
7412
|
get_range_extents(start_offset: number, end_offset: number, type: CoordType): Rect;
|
|
6922
7413
|
|
|
@@ -6924,6 +7415,7 @@ export namespace Atspi {
|
|
|
6924
7415
|
* Gets the bounds of the `selection_num`-th active text selection for an
|
|
6925
7416
|
* {@link Atspi.Text} object.
|
|
6926
7417
|
* @param selection_num a `gint` indicating which selection to query.
|
|
7418
|
+
* @throws GLib.Error
|
|
6927
7419
|
*/
|
|
6928
7420
|
get_selection(selection_num: number): Range;
|
|
6929
7421
|
|
|
@@ -6961,6 +7453,8 @@ export namespace Atspi {
|
|
|
6961
7453
|
* @param offset position
|
|
6962
7454
|
* @param granularity An {@link Atspi.TextGranularity}
|
|
6963
7455
|
* @returns a newly allocated string containing the text at the `offset` bounded by the specified `granularity`. Use `g_free()` to free the returned string. Returns `null` if the offset is invalid or no implementation is available.
|
|
7456
|
+
* @since 2.9.90
|
|
7457
|
+
* @throws GLib.Error
|
|
6964
7458
|
*/
|
|
6965
7459
|
get_string_at_offset(offset: number, granularity: TextGranularity): TextRange;
|
|
6966
7460
|
|
|
@@ -6971,6 +7465,7 @@ export namespace Atspi {
|
|
|
6971
7465
|
* @param start_offset a `gint` indicating the start of the desired text range.
|
|
6972
7466
|
* @param end_offset a `gint` indicating the first character past the desired range.
|
|
6973
7467
|
* @returns a text string containing characters from `start_offset` to `end_offset`-1, inclusive, encoded as UTF-8.
|
|
7468
|
+
* @throws GLib.Error
|
|
6974
7469
|
*/
|
|
6975
7470
|
get_text(start_offset: number, end_offset: number): string;
|
|
6976
7471
|
|
|
@@ -6980,6 +7475,7 @@ export namespace Atspi {
|
|
|
6980
7475
|
* @param offset a `gint` indicating the offset from which the delimiter search is based.
|
|
6981
7476
|
* @param type an {@link Atspi.TextBoundaryType} indicating whether the desired text string is a word, sentence, line, or attribute run.
|
|
6982
7477
|
* @returns an {@link Atspi.TextRange} containing a UTF-8 string representing the delimited text, both of whose delimiting boundaries are after or inclusive of the current offset, or an empty string if no such text exists.
|
|
7478
|
+
* @throws GLib.Error
|
|
6983
7479
|
*/
|
|
6984
7480
|
get_text_after_offset(offset: number, type: TextBoundaryType): TextRange;
|
|
6985
7481
|
|
|
@@ -6989,6 +7485,8 @@ export namespace Atspi {
|
|
|
6989
7485
|
* @param offset a `gint` indicating the offset from which the delimiter search is based.
|
|
6990
7486
|
* @param type an {@link Atspi.TextBoundaryType} indicating whether the desired text string is a word, sentence, line, or attribute run.
|
|
6991
7487
|
* @returns an {@link Atspi.TextRange} containing a UTF-8 string representing the delimited text, whose delimiting boundaries bracket the current offset, or an empty string if no such text exists.
|
|
7488
|
+
* @deprecated since 2.10: Use atspi_text_get_string_at_offset.
|
|
7489
|
+
* @throws GLib.Error
|
|
6992
7490
|
*/
|
|
6993
7491
|
get_text_at_offset(offset: number, type: TextBoundaryType): TextRange;
|
|
6994
7492
|
|
|
@@ -6998,6 +7496,7 @@ export namespace Atspi {
|
|
|
6998
7496
|
* @param offset a `gint` indicating the offset from which the delimiter search is based.
|
|
6999
7497
|
* @param type an {@link Atspi.TextBoundaryType} indicating whether the desired text string is a word, sentence, line, or attribute run.
|
|
7000
7498
|
* @returns an {@link Atspi.TextRange} containing a UTF-8 string representing the delimited text, both of whose delimiting boundaries are before the current offset, or an empty string if no such text exists.
|
|
7499
|
+
* @throws GLib.Error
|
|
7001
7500
|
*/
|
|
7002
7501
|
get_text_before_offset(offset: number, type: TextBoundaryType): TextRange;
|
|
7003
7502
|
|
|
@@ -7005,6 +7504,7 @@ export namespace Atspi {
|
|
|
7005
7504
|
* De-selects a text selection.
|
|
7006
7505
|
* @param selection_num a `gint` indicating which text selection to remove.
|
|
7007
7506
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
7507
|
+
* @throws GLib.Error
|
|
7008
7508
|
*/
|
|
7009
7509
|
remove_selection(selection_num: number): boolean;
|
|
7010
7510
|
|
|
@@ -7015,6 +7515,7 @@ export namespace Atspi {
|
|
|
7015
7515
|
* @param end_offset a `gint` indicating the first character past the desired range.
|
|
7016
7516
|
* @param type a {@link Atspi.ScrollType} indicating where the object should be placed on the screen.
|
|
7017
7517
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
7518
|
+
* @throws GLib.Error
|
|
7018
7519
|
*/
|
|
7019
7520
|
scroll_substring_to(start_offset: number, end_offset: number, type: ScrollType): boolean;
|
|
7020
7521
|
|
|
@@ -7027,6 +7528,7 @@ export namespace Atspi {
|
|
|
7027
7528
|
* @param x the x coordinate of the point to reach
|
|
7028
7529
|
* @param y the y coordinate of the point to reach
|
|
7029
7530
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
7531
|
+
* @throws GLib.Error
|
|
7030
7532
|
*/
|
|
7031
7533
|
scroll_substring_to_point(start_offset: number, end_offset: number, coords: CoordType, x: number, y: number): boolean;
|
|
7032
7534
|
|
|
@@ -7034,6 +7536,7 @@ export namespace Atspi {
|
|
|
7034
7536
|
* Moves the text caret to a given position.
|
|
7035
7537
|
* @param new_offset the offset to which the text caret is to be moved.
|
|
7036
7538
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
7539
|
+
* @throws GLib.Error
|
|
7037
7540
|
*/
|
|
7038
7541
|
set_caret_offset(new_offset: number): boolean;
|
|
7039
7542
|
|
|
@@ -7043,6 +7546,7 @@ export namespace Atspi {
|
|
|
7043
7546
|
* @param start_offset a `gint` indicating the new starting offset for the selection.
|
|
7044
7547
|
* @param end_offset a `gint` indicating the desired new offset of the first character after the selection.
|
|
7045
7548
|
* @returns `TRUE` if successful, `FALSE` otherwise.
|
|
7549
|
+
* @throws GLib.Error
|
|
7046
7550
|
*/
|
|
7047
7551
|
set_selection(selection_num: number, start_offset: number, end_offset: number): boolean;
|
|
7048
7552
|
}
|
|
@@ -7078,24 +7582,28 @@ export namespace Atspi {
|
|
|
7078
7582
|
/**
|
|
7079
7583
|
* Gets the current value for an {@link Atspi.Value}.
|
|
7080
7584
|
* @returns the current value for this object.
|
|
7585
|
+
* @throws GLib.Error
|
|
7081
7586
|
*/
|
|
7082
7587
|
get_current_value(): number;
|
|
7083
7588
|
|
|
7084
7589
|
/**
|
|
7085
7590
|
* Gets the maximum allowed value for an {@link Atspi.Value}.
|
|
7086
7591
|
* @returns the maximum allowed value for this object.
|
|
7592
|
+
* @throws GLib.Error
|
|
7087
7593
|
*/
|
|
7088
7594
|
get_maximum_value(): number;
|
|
7089
7595
|
|
|
7090
7596
|
/**
|
|
7091
7597
|
* Gets the minimum increment by which an {@link Atspi.Value} can be adjusted.
|
|
7092
7598
|
* @returns the minimum increment by which the value may be changed, or zero if the minimum increment cannot be determined.
|
|
7599
|
+
* @throws GLib.Error
|
|
7093
7600
|
*/
|
|
7094
7601
|
get_minimum_increment(): number;
|
|
7095
7602
|
|
|
7096
7603
|
/**
|
|
7097
7604
|
* Gets the minimum allowed value for an {@link Atspi.Value}.
|
|
7098
7605
|
* @returns the minimum allowed value for this object.
|
|
7606
|
+
* @throws GLib.Error
|
|
7099
7607
|
*/
|
|
7100
7608
|
get_minimum_value(): number;
|
|
7101
7609
|
|
|
@@ -7103,6 +7611,8 @@ export namespace Atspi {
|
|
|
7103
7611
|
* Gets the human readable text alternative associated with the value.
|
|
7104
7612
|
* `text` is a newly created string, that must be freed by the
|
|
7105
7613
|
* caller. Can be NULL if no descriptor is available.
|
|
7614
|
+
* @since 2.46
|
|
7615
|
+
* @throws GLib.Error
|
|
7106
7616
|
*/
|
|
7107
7617
|
get_text(): string;
|
|
7108
7618
|
|
|
@@ -7110,6 +7620,7 @@ export namespace Atspi {
|
|
|
7110
7620
|
* Sets the current value of an {@link Atspi.Value}.
|
|
7111
7621
|
* @param new_value a `gdouble` value which is the desired new value of the object.
|
|
7112
7622
|
* @returns `TRUE` if the value could be assigned the specified value, `FALSE` otherwise.
|
|
7623
|
+
* @throws GLib.Error
|
|
7113
7624
|
*/
|
|
7114
7625
|
set_current_value(new_value: number): boolean;
|
|
7115
7626
|
}
|