Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/doc/classes/AccessibilityServer.xml
45997 views
1
<?xml version="1.0" encoding="UTF-8" ?>
2
<class name="AccessibilityServer" inherits="Object" api_type="core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
3
<brief_description>
4
A server interface for screen reader support.
5
</brief_description>
6
<description>
7
</description>
8
<tutorials>
9
</tutorials>
10
<methods>
11
<method name="create_element">
12
<return type="RID" />
13
<param index="0" name="window_id" type="int" />
14
<param index="1" name="role" type="int" enum="AccessibilityServer.AccessibilityRole" />
15
<description>
16
Creates a new, empty accessibility element resource.
17
[b]Note:[/b] An accessibility element is created and freed automatically for each [Node]. In general, this function should not be called manually.
18
</description>
19
</method>
20
<method name="create_sub_element">
21
<return type="RID" />
22
<param index="0" name="parent_rid" type="RID" />
23
<param index="1" name="role" type="int" enum="AccessibilityServer.AccessibilityRole" />
24
<param index="2" name="insert_pos" type="int" default="-1" />
25
<description>
26
Creates a new, empty accessibility sub-element resource. Sub-elements can be used to provide accessibility information for objects which are not [Node]s, such as list items, table cells, or menu items. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the [method free_element] method.
27
</description>
28
</method>
29
<method name="create_sub_text_edit_elements">
30
<return type="RID" />
31
<param index="0" name="parent_rid" type="RID" />
32
<param index="1" name="shaped_text" type="RID" />
33
<param index="2" name="min_height" type="float" />
34
<param index="3" name="insert_pos" type="int" default="-1" />
35
<param index="4" name="is_last_line" type="bool" default="false" />
36
<description>
37
Creates a new, empty accessibility sub-element from the shaped text buffer. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the [method free_element] method.
38
If [param is_last_line] is [code]true[/code], no trailing newline is appended to the text content. Set to [code]true[/code] for the last line in multi-line text fields and for single-line text fields.
39
</description>
40
</method>
41
<method name="element_get_meta" qualifiers="const">
42
<return type="Variant" />
43
<param index="0" name="id" type="RID" />
44
<description>
45
Returns the metadata of the accessibility element [param id].
46
</description>
47
</method>
48
<method name="element_set_meta">
49
<return type="void" />
50
<param index="0" name="id" type="RID" />
51
<param index="1" name="meta" type="Variant" />
52
<description>
53
Sets the metadata of the accessibility element [param id] to [param meta].
54
</description>
55
</method>
56
<method name="free_element">
57
<return type="void" />
58
<param index="0" name="id" type="RID" />
59
<description>
60
Frees the accessibility element [param id] created by [method create_element], [method create_sub_element], or [method create_sub_text_edit_elements].
61
</description>
62
</method>
63
<method name="get_window_root" qualifiers="const">
64
<return type="RID" />
65
<param index="0" name="window_id" type="int" />
66
<description>
67
Returns the main accessibility element of the OS native window.
68
</description>
69
</method>
70
<method name="has_element" qualifiers="const">
71
<return type="bool" />
72
<param index="0" name="id" type="RID" />
73
<description>
74
Returns [code]true[/code] if [param id] is a valid accessibility element.
75
</description>
76
</method>
77
<method name="is_supported" qualifiers="const">
78
<return type="bool" />
79
<description>
80
Returns [code]true[/code] if screen reader is support by this implementation.
81
</description>
82
</method>
83
<method name="set_window_focused">
84
<return type="void" />
85
<param index="0" name="window_id" type="int" />
86
<param index="1" name="focused" type="bool" />
87
<description>
88
Sets the window focused state for assistive apps.
89
[b]Note:[/b] This method is implemented on Linux, macOS, and Windows.
90
[b]Note:[/b] Advanced users only! [Window] objects call this method automatically.
91
</description>
92
</method>
93
<method name="set_window_rect">
94
<return type="void" />
95
<param index="0" name="window_id" type="int" />
96
<param index="1" name="rect_out" type="Rect2" />
97
<param index="2" name="rect_in" type="Rect2" />
98
<description>
99
Sets window outer (with decorations) and inner (without decorations) bounds for assistive apps.
100
[b]Note:[/b] This method is implemented on Linux, macOS, and Windows.
101
[b]Note:[/b] Advanced users only! [Window] objects call this method automatically.
102
</description>
103
</method>
104
<method name="update_add_action">
105
<return type="void" />
106
<param index="0" name="id" type="RID" />
107
<param index="1" name="action" type="int" enum="AccessibilityServer.AccessibilityAction" />
108
<param index="2" name="callable" type="Callable" />
109
<description>
110
Adds a callback for the accessibility action (action which can be performed by using a special screen reader command or buttons on the Braille display), and marks this action as supported. The action callback receives one [Variant] argument, which value depends on action type.
111
</description>
112
</method>
113
<method name="update_add_child">
114
<return type="void" />
115
<param index="0" name="id" type="RID" />
116
<param index="1" name="child_id" type="RID" />
117
<description>
118
Adds a child accessibility element.
119
[b]Note:[/b] [Node] children and sub-elements are added to the child list automatically.
120
</description>
121
</method>
122
<method name="update_add_custom_action">
123
<return type="void" />
124
<param index="0" name="id" type="RID" />
125
<param index="1" name="action_id" type="int" />
126
<param index="2" name="action_description" type="String" />
127
<description>
128
Adds support for a custom accessibility action. [param action_id] is passed as an argument to the callback of [constant ACTION_CUSTOM] action.
129
</description>
130
</method>
131
<method name="update_add_related_controls">
132
<return type="void" />
133
<param index="0" name="id" type="RID" />
134
<param index="1" name="related_id" type="RID" />
135
<description>
136
Adds an element that is controlled by this element.
137
</description>
138
</method>
139
<method name="update_add_related_described_by">
140
<return type="void" />
141
<param index="0" name="id" type="RID" />
142
<param index="1" name="related_id" type="RID" />
143
<description>
144
Adds an element that describes this element.
145
</description>
146
</method>
147
<method name="update_add_related_details">
148
<return type="void" />
149
<param index="0" name="id" type="RID" />
150
<param index="1" name="related_id" type="RID" />
151
<description>
152
Adds an element that details this element.
153
</description>
154
</method>
155
<method name="update_add_related_flow_to">
156
<return type="void" />
157
<param index="0" name="id" type="RID" />
158
<param index="1" name="related_id" type="RID" />
159
<description>
160
Adds an element that this element flow into.
161
</description>
162
</method>
163
<method name="update_add_related_labeled_by">
164
<return type="void" />
165
<param index="0" name="id" type="RID" />
166
<param index="1" name="related_id" type="RID" />
167
<description>
168
Adds an element that labels this element.
169
</description>
170
</method>
171
<method name="update_add_related_radio_group">
172
<return type="void" />
173
<param index="0" name="id" type="RID" />
174
<param index="1" name="related_id" type="RID" />
175
<description>
176
Adds an element that is part of the same radio group.
177
[b]Note:[/b] This method should be called on each element of the group, using all other elements as [param related_id].
178
</description>
179
</method>
180
<method name="update_set_active_descendant">
181
<return type="void" />
182
<param index="0" name="id" type="RID" />
183
<param index="1" name="other_id" type="RID" />
184
<description>
185
Adds an element that is an active descendant of this element.
186
</description>
187
</method>
188
<method name="update_set_background_color">
189
<return type="void" />
190
<param index="0" name="id" type="RID" />
191
<param index="1" name="color" type="Color" />
192
<description>
193
Sets element background color.
194
</description>
195
</method>
196
<method name="update_set_bounds">
197
<return type="void" />
198
<param index="0" name="id" type="RID" />
199
<param index="1" name="p_rect" type="Rect2" />
200
<description>
201
Sets element bounding box, relative to the node position.
202
</description>
203
</method>
204
<method name="update_set_braille_label">
205
<return type="void" />
206
<param index="0" name="id" type="RID" />
207
<param index="1" name="name" type="String" />
208
<description>
209
Sets element accessibility label for Braille display.
210
</description>
211
</method>
212
<method name="update_set_braille_role_description">
213
<return type="void" />
214
<param index="0" name="id" type="RID" />
215
<param index="1" name="description" type="String" />
216
<description>
217
Sets element accessibility role description for Braille display.
218
</description>
219
</method>
220
<method name="update_set_checked">
221
<return type="void" />
222
<param index="0" name="id" type="RID" />
223
<param index="1" name="checekd" type="bool" />
224
<description>
225
Sets element checked state.
226
</description>
227
</method>
228
<method name="update_set_classname">
229
<return type="void" />
230
<param index="0" name="id" type="RID" />
231
<param index="1" name="classname" type="String" />
232
<description>
233
Sets element class name.
234
</description>
235
</method>
236
<method name="update_set_color_value">
237
<return type="void" />
238
<param index="0" name="id" type="RID" />
239
<param index="1" name="color" type="Color" />
240
<description>
241
Sets element color value.
242
</description>
243
</method>
244
<method name="update_set_description">
245
<return type="void" />
246
<param index="0" name="id" type="RID" />
247
<param index="1" name="description" type="String" />
248
<description>
249
Sets element accessibility description.
250
</description>
251
</method>
252
<method name="update_set_error_message">
253
<return type="void" />
254
<param index="0" name="id" type="RID" />
255
<param index="1" name="other_id" type="RID" />
256
<description>
257
Sets an element which contains an error message for this element.
258
</description>
259
</method>
260
<method name="update_set_extra_info">
261
<return type="void" />
262
<param index="0" name="id" type="RID" />
263
<param index="1" name="name" type="String" />
264
<description>
265
Sets element accessibility extra information added to the element name.
266
</description>
267
</method>
268
<method name="update_set_flag">
269
<return type="void" />
270
<param index="0" name="id" type="RID" />
271
<param index="1" name="flag" type="int" enum="AccessibilityServer.AccessibilityFlags" />
272
<param index="2" name="value" type="bool" />
273
<description>
274
Sets element flag.
275
</description>
276
</method>
277
<method name="update_set_focus">
278
<return type="void" />
279
<param index="0" name="id" type="RID" />
280
<description>
281
Sets currently focused element.
282
</description>
283
</method>
284
<method name="update_set_foreground_color">
285
<return type="void" />
286
<param index="0" name="id" type="RID" />
287
<param index="1" name="color" type="Color" />
288
<description>
289
Sets element foreground color.
290
</description>
291
</method>
292
<method name="update_set_in_page_link_target">
293
<return type="void" />
294
<param index="0" name="id" type="RID" />
295
<param index="1" name="other_id" type="RID" />
296
<description>
297
Sets target element for the link.
298
</description>
299
</method>
300
<method name="update_set_language">
301
<return type="void" />
302
<param index="0" name="id" type="RID" />
303
<param index="1" name="language" type="String" />
304
<description>
305
Sets element text language.
306
</description>
307
</method>
308
<method name="update_set_list_item_count">
309
<return type="void" />
310
<param index="0" name="id" type="RID" />
311
<param index="1" name="size" type="int" />
312
<description>
313
Sets number of items in the list.
314
</description>
315
</method>
316
<method name="update_set_list_item_expanded">
317
<return type="void" />
318
<param index="0" name="id" type="RID" />
319
<param index="1" name="expanded" type="bool" />
320
<description>
321
Sets list/tree item expanded status.
322
</description>
323
</method>
324
<method name="update_set_list_item_index">
325
<return type="void" />
326
<param index="0" name="id" type="RID" />
327
<param index="1" name="index" type="int" />
328
<description>
329
Sets the position of the element in the list.
330
</description>
331
</method>
332
<method name="update_set_list_item_level">
333
<return type="void" />
334
<param index="0" name="id" type="RID" />
335
<param index="1" name="level" type="int" />
336
<description>
337
Sets the hierarchical level of the element in the list.
338
</description>
339
</method>
340
<method name="update_set_list_item_selected">
341
<return type="void" />
342
<param index="0" name="id" type="RID" />
343
<param index="1" name="selected" type="bool" />
344
<description>
345
Sets list/tree item selected status.
346
</description>
347
</method>
348
<method name="update_set_list_orientation">
349
<return type="void" />
350
<param index="0" name="id" type="RID" />
351
<param index="1" name="vertical" type="bool" />
352
<description>
353
Sets the orientation of the list elements.
354
</description>
355
</method>
356
<method name="update_set_live">
357
<return type="void" />
358
<param index="0" name="id" type="RID" />
359
<param index="1" name="live" type="int" enum="AccessibilityServer.AccessibilityLiveMode" />
360
<description>
361
Sets the priority of the live region updates.
362
</description>
363
</method>
364
<method name="update_set_member_of">
365
<return type="void" />
366
<param index="0" name="id" type="RID" />
367
<param index="1" name="group_id" type="RID" />
368
<description>
369
Sets the element to be a member of the group.
370
</description>
371
</method>
372
<method name="update_set_name">
373
<return type="void" />
374
<param index="0" name="id" type="RID" />
375
<param index="1" name="name" type="String" />
376
<description>
377
Sets element accessibility name.
378
</description>
379
</method>
380
<method name="update_set_next_on_line">
381
<return type="void" />
382
<param index="0" name="id" type="RID" />
383
<param index="1" name="other_id" type="RID" />
384
<description>
385
Sets next element on the line.
386
</description>
387
</method>
388
<method name="update_set_num_jump">
389
<return type="void" />
390
<param index="0" name="id" type="RID" />
391
<param index="1" name="jump" type="float" />
392
<description>
393
Sets numeric value jump.
394
</description>
395
</method>
396
<method name="update_set_num_range">
397
<return type="void" />
398
<param index="0" name="id" type="RID" />
399
<param index="1" name="min" type="float" />
400
<param index="2" name="max" type="float" />
401
<description>
402
Sets numeric value range.
403
</description>
404
</method>
405
<method name="update_set_num_step">
406
<return type="void" />
407
<param index="0" name="id" type="RID" />
408
<param index="1" name="step" type="float" />
409
<description>
410
Sets numeric value step.
411
</description>
412
</method>
413
<method name="update_set_num_value">
414
<return type="void" />
415
<param index="0" name="id" type="RID" />
416
<param index="1" name="position" type="float" />
417
<description>
418
Sets numeric value.
419
</description>
420
</method>
421
<method name="update_set_placeholder">
422
<return type="void" />
423
<param index="0" name="id" type="RID" />
424
<param index="1" name="placeholder" type="String" />
425
<description>
426
Sets placeholder text.
427
</description>
428
</method>
429
<method name="update_set_popup_type">
430
<return type="void" />
431
<param index="0" name="id" type="RID" />
432
<param index="1" name="popup" type="int" enum="AccessibilityServer.AccessibilityPopupType" />
433
<description>
434
Sets popup type for popup buttons.
435
</description>
436
</method>
437
<method name="update_set_previous_on_line">
438
<return type="void" />
439
<param index="0" name="id" type="RID" />
440
<param index="1" name="other_id" type="RID" />
441
<description>
442
Sets previous element on the line.
443
</description>
444
</method>
445
<method name="update_set_role">
446
<return type="void" />
447
<param index="0" name="id" type="RID" />
448
<param index="1" name="role" type="int" enum="AccessibilityServer.AccessibilityRole" />
449
<description>
450
Sets element accessibility role.
451
</description>
452
</method>
453
<method name="update_set_role_description">
454
<return type="void" />
455
<param index="0" name="id" type="RID" />
456
<param index="1" name="description" type="String" />
457
<description>
458
Sets element accessibility role description text.
459
</description>
460
</method>
461
<method name="update_set_scroll_x">
462
<return type="void" />
463
<param index="0" name="id" type="RID" />
464
<param index="1" name="position" type="float" />
465
<description>
466
Sets scroll bar x position.
467
</description>
468
</method>
469
<method name="update_set_scroll_x_range">
470
<return type="void" />
471
<param index="0" name="id" type="RID" />
472
<param index="1" name="min" type="float" />
473
<param index="2" name="max" type="float" />
474
<description>
475
Sets scroll bar x range.
476
</description>
477
</method>
478
<method name="update_set_scroll_y">
479
<return type="void" />
480
<param index="0" name="id" type="RID" />
481
<param index="1" name="position" type="float" />
482
<description>
483
Sets scroll bar y position.
484
</description>
485
</method>
486
<method name="update_set_scroll_y_range">
487
<return type="void" />
488
<param index="0" name="id" type="RID" />
489
<param index="1" name="min" type="float" />
490
<param index="2" name="max" type="float" />
491
<description>
492
Sets scroll bar y range.
493
</description>
494
</method>
495
<method name="update_set_shortcut">
496
<return type="void" />
497
<param index="0" name="id" type="RID" />
498
<param index="1" name="shortcut" type="String" />
499
<description>
500
Sets the list of keyboard shortcuts used by element.
501
</description>
502
</method>
503
<method name="update_set_state_description">
504
<return type="void" />
505
<param index="0" name="id" type="RID" />
506
<param index="1" name="description" type="String" />
507
<description>
508
Sets human-readable description of the current checked state.
509
</description>
510
</method>
511
<method name="update_set_table_cell_position">
512
<return type="void" />
513
<param index="0" name="id" type="RID" />
514
<param index="1" name="row_index" type="int" />
515
<param index="2" name="column_index" type="int" />
516
<description>
517
Sets cell position in the table.
518
</description>
519
</method>
520
<method name="update_set_table_cell_span">
521
<return type="void" />
522
<param index="0" name="id" type="RID" />
523
<param index="1" name="row_span" type="int" />
524
<param index="2" name="column_span" type="int" />
525
<description>
526
Sets cell row/column span.
527
</description>
528
</method>
529
<method name="update_set_table_column_count">
530
<return type="void" />
531
<param index="0" name="id" type="RID" />
532
<param index="1" name="count" type="int" />
533
<description>
534
Sets number of columns in the table.
535
</description>
536
</method>
537
<method name="update_set_table_column_index">
538
<return type="void" />
539
<param index="0" name="id" type="RID" />
540
<param index="1" name="index" type="int" />
541
<description>
542
Sets position of the column.
543
</description>
544
</method>
545
<method name="update_set_table_row_count">
546
<return type="void" />
547
<param index="0" name="id" type="RID" />
548
<param index="1" name="count" type="int" />
549
<description>
550
Sets number of rows in the table.
551
</description>
552
</method>
553
<method name="update_set_table_row_index">
554
<return type="void" />
555
<param index="0" name="id" type="RID" />
556
<param index="1" name="index" type="int" />
557
<description>
558
Sets position of the row in the table.
559
</description>
560
</method>
561
<method name="update_set_text_align">
562
<return type="void" />
563
<param index="0" name="id" type="RID" />
564
<param index="1" name="align" type="int" enum="HorizontalAlignment" />
565
<description>
566
Sets element text alignment.
567
</description>
568
</method>
569
<method name="update_set_text_decorations">
570
<return type="void" />
571
<param index="0" name="id" type="RID" />
572
<param index="1" name="underline" type="bool" />
573
<param index="2" name="strikethrough" type="bool" />
574
<param index="3" name="overline" type="bool" />
575
<param index="4" name="color" type="Color" default="Color(0, 0, 0, 1)" />
576
<description>
577
Sets text underline/overline/strikethrough.
578
</description>
579
</method>
580
<method name="update_set_text_orientation">
581
<return type="void" />
582
<param index="0" name="id" type="RID" />
583
<param index="1" name="vertical" type="bool" />
584
<description>
585
Sets text orientation.
586
</description>
587
</method>
588
<method name="update_set_text_selection">
589
<return type="void" />
590
<param index="0" name="id" type="RID" />
591
<param index="1" name="text_start_id" type="RID" />
592
<param index="2" name="start_char" type="int" />
593
<param index="3" name="text_end_id" type="RID" />
594
<param index="4" name="end_char" type="int" />
595
<description>
596
Sets text selection to the text field. [param text_start_id] and [param text_end_id] should be elements created by [method create_sub_text_edit_elements]. Character offsets are relative to the corresponding element.
597
</description>
598
</method>
599
<method name="update_set_tooltip">
600
<return type="void" />
601
<param index="0" name="id" type="RID" />
602
<param index="1" name="tooltip" type="String" />
603
<description>
604
Sets tooltip text.
605
</description>
606
</method>
607
<method name="update_set_transform">
608
<return type="void" />
609
<param index="0" name="id" type="RID" />
610
<param index="1" name="transform" type="Transform2D" />
611
<description>
612
Sets element 2D transform.
613
</description>
614
</method>
615
<method name="update_set_url">
616
<return type="void" />
617
<param index="0" name="id" type="RID" />
618
<param index="1" name="url" type="String" />
619
<description>
620
Sets link URL.
621
</description>
622
</method>
623
<method name="update_set_value">
624
<return type="void" />
625
<param index="0" name="id" type="RID" />
626
<param index="1" name="value" type="String" />
627
<description>
628
Sets element text value.
629
</description>
630
</method>
631
</methods>
632
<constants>
633
<constant name="ROLE_UNKNOWN" value="0" enum="AccessibilityRole">
634
Unknown or custom role.
635
</constant>
636
<constant name="ROLE_DEFAULT_BUTTON" value="1" enum="AccessibilityRole">
637
Default dialog button element.
638
</constant>
639
<constant name="ROLE_AUDIO" value="2" enum="AccessibilityRole">
640
Audio player element.
641
</constant>
642
<constant name="ROLE_VIDEO" value="3" enum="AccessibilityRole">
643
Video player element.
644
</constant>
645
<constant name="ROLE_STATIC_TEXT" value="4" enum="AccessibilityRole">
646
Non-editable text label.
647
</constant>
648
<constant name="ROLE_CONTAINER" value="5" enum="AccessibilityRole">
649
Container element. Elements with this role are used for internal structure and ignored by screen readers.
650
</constant>
651
<constant name="ROLE_PANEL" value="6" enum="AccessibilityRole">
652
Panel container element.
653
</constant>
654
<constant name="ROLE_BUTTON" value="7" enum="AccessibilityRole">
655
Button element.
656
</constant>
657
<constant name="ROLE_LINK" value="8" enum="AccessibilityRole">
658
Link element.
659
</constant>
660
<constant name="ROLE_CHECK_BOX" value="9" enum="AccessibilityRole">
661
Check box element.
662
</constant>
663
<constant name="ROLE_RADIO_BUTTON" value="10" enum="AccessibilityRole">
664
Radio button element.
665
</constant>
666
<constant name="ROLE_CHECK_BUTTON" value="11" enum="AccessibilityRole">
667
Check button element.
668
</constant>
669
<constant name="ROLE_SCROLL_BAR" value="12" enum="AccessibilityRole">
670
Scroll bar element.
671
</constant>
672
<constant name="ROLE_SCROLL_VIEW" value="13" enum="AccessibilityRole">
673
Scroll container element.
674
</constant>
675
<constant name="ROLE_SPLITTER" value="14" enum="AccessibilityRole">
676
Container splitter handle element.
677
</constant>
678
<constant name="ROLE_SLIDER" value="15" enum="AccessibilityRole">
679
Slider element.
680
</constant>
681
<constant name="ROLE_SPIN_BUTTON" value="16" enum="AccessibilityRole">
682
Spin box element.
683
</constant>
684
<constant name="ROLE_PROGRESS_INDICATOR" value="17" enum="AccessibilityRole">
685
Progress indicator element.
686
</constant>
687
<constant name="ROLE_TEXT_FIELD" value="18" enum="AccessibilityRole">
688
Editable text field element.
689
</constant>
690
<constant name="ROLE_MULTILINE_TEXT_FIELD" value="19" enum="AccessibilityRole">
691
Multiline editable text field element.
692
</constant>
693
<constant name="ROLE_COLOR_PICKER" value="20" enum="AccessibilityRole">
694
Color picker element.
695
</constant>
696
<constant name="ROLE_TABLE" value="21" enum="AccessibilityRole">
697
Table element.
698
</constant>
699
<constant name="ROLE_CELL" value="22" enum="AccessibilityRole">
700
Table/tree cell element.
701
</constant>
702
<constant name="ROLE_ROW" value="23" enum="AccessibilityRole">
703
Table/tree row element.
704
</constant>
705
<constant name="ROLE_ROW_GROUP" value="24" enum="AccessibilityRole">
706
Table/tree row group element.
707
</constant>
708
<constant name="ROLE_ROW_HEADER" value="25" enum="AccessibilityRole">
709
Table/tree row header element.
710
</constant>
711
<constant name="ROLE_COLUMN_HEADER" value="26" enum="AccessibilityRole">
712
Table/tree column header element.
713
</constant>
714
<constant name="ROLE_TREE" value="27" enum="AccessibilityRole">
715
Tree view element.
716
</constant>
717
<constant name="ROLE_TREE_ITEM" value="28" enum="AccessibilityRole">
718
Tree view item element.
719
</constant>
720
<constant name="ROLE_LIST" value="29" enum="AccessibilityRole">
721
List element.
722
</constant>
723
<constant name="ROLE_LIST_ITEM" value="30" enum="AccessibilityRole">
724
List item element.
725
</constant>
726
<constant name="ROLE_LIST_BOX" value="31" enum="AccessibilityRole">
727
List view element.
728
</constant>
729
<constant name="ROLE_LIST_BOX_OPTION" value="32" enum="AccessibilityRole">
730
List view item element.
731
</constant>
732
<constant name="ROLE_TAB_BAR" value="33" enum="AccessibilityRole">
733
Tab bar element.
734
</constant>
735
<constant name="ROLE_TAB" value="34" enum="AccessibilityRole">
736
Tab bar item element.
737
</constant>
738
<constant name="ROLE_TAB_PANEL" value="35" enum="AccessibilityRole">
739
Tab panel element.
740
</constant>
741
<constant name="ROLE_MENU_BAR" value="36" enum="AccessibilityRole">
742
Menu bar element.
743
</constant>
744
<constant name="ROLE_MENU" value="37" enum="AccessibilityRole">
745
Popup menu element.
746
</constant>
747
<constant name="ROLE_MENU_ITEM" value="38" enum="AccessibilityRole">
748
Popup menu item element.
749
</constant>
750
<constant name="ROLE_MENU_ITEM_CHECK_BOX" value="39" enum="AccessibilityRole">
751
Popup menu check button item element.
752
</constant>
753
<constant name="ROLE_MENU_ITEM_RADIO" value="40" enum="AccessibilityRole">
754
Popup menu radio button item element.
755
</constant>
756
<constant name="ROLE_IMAGE" value="41" enum="AccessibilityRole">
757
Image element.
758
</constant>
759
<constant name="ROLE_WINDOW" value="42" enum="AccessibilityRole">
760
Window element.
761
</constant>
762
<constant name="ROLE_TITLE_BAR" value="43" enum="AccessibilityRole">
763
Embedded window title bar element.
764
</constant>
765
<constant name="ROLE_DIALOG" value="44" enum="AccessibilityRole">
766
Dialog window element.
767
</constant>
768
<constant name="ROLE_TOOLTIP" value="45" enum="AccessibilityRole">
769
Tooltip element.
770
</constant>
771
<constant name="ROLE_REGION" value="46" enum="AccessibilityRole">
772
Region/landmark element. Screen readers can navigate between regions using landmark navigation.
773
</constant>
774
<constant name="ROLE_TEXT_RUN" value="47" enum="AccessibilityRole">
775
Unifor text run.
776
Note: This role is used for internal text elements, and should not be assigned to nodes.
777
</constant>
778
<constant name="POPUP_MENU" value="0" enum="AccessibilityPopupType">
779
Popup menu.
780
</constant>
781
<constant name="POPUP_LIST" value="1" enum="AccessibilityPopupType">
782
Popup list.
783
</constant>
784
<constant name="POPUP_TREE" value="2" enum="AccessibilityPopupType">
785
Popup tree view.
786
</constant>
787
<constant name="POPUP_DIALOG" value="3" enum="AccessibilityPopupType">
788
Popup dialog.
789
</constant>
790
<constant name="FLAG_HIDDEN" value="0" enum="AccessibilityFlags">
791
Element is hidden for accessibility tools.
792
</constant>
793
<constant name="FLAG_MULTISELECTABLE" value="1" enum="AccessibilityFlags">
794
Element supports multiple item selection.
795
</constant>
796
<constant name="FLAG_REQUIRED" value="2" enum="AccessibilityFlags">
797
Element require user input.
798
</constant>
799
<constant name="FLAG_VISITED" value="3" enum="AccessibilityFlags">
800
Element is a visited link.
801
</constant>
802
<constant name="FLAG_BUSY" value="4" enum="AccessibilityFlags">
803
Element content is not ready (e.g. loading).
804
</constant>
805
<constant name="FLAG_MODAL" value="5" enum="AccessibilityFlags">
806
Element is modal window.
807
</constant>
808
<constant name="FLAG_TOUCH_PASSTHROUGH" value="6" enum="AccessibilityFlags">
809
Element allows touches to be passed through when a screen reader is in touch exploration mode.
810
</constant>
811
<constant name="FLAG_READONLY" value="7" enum="AccessibilityFlags">
812
Element is text field with selectable but read-only text.
813
</constant>
814
<constant name="FLAG_DISABLED" value="8" enum="AccessibilityFlags">
815
Element is disabled.
816
</constant>
817
<constant name="FLAG_CLIPS_CHILDREN" value="9" enum="AccessibilityFlags">
818
Element clips children.
819
</constant>
820
<constant name="ACTION_CLICK" value="0" enum="AccessibilityAction">
821
Single click action, callback argument is not set.
822
</constant>
823
<constant name="ACTION_FOCUS" value="1" enum="AccessibilityAction">
824
Focus action, callback argument is not set.
825
</constant>
826
<constant name="ACTION_BLUR" value="2" enum="AccessibilityAction">
827
Blur action, callback argument is not set.
828
</constant>
829
<constant name="ACTION_COLLAPSE" value="3" enum="AccessibilityAction">
830
Collapse action, callback argument is not set.
831
</constant>
832
<constant name="ACTION_EXPAND" value="4" enum="AccessibilityAction">
833
Expand action, callback argument is not set.
834
</constant>
835
<constant name="ACTION_DECREMENT" value="5" enum="AccessibilityAction">
836
Decrement action, callback argument is not set.
837
</constant>
838
<constant name="ACTION_INCREMENT" value="6" enum="AccessibilityAction">
839
Increment action, callback argument is not set.
840
</constant>
841
<constant name="ACTION_HIDE_TOOLTIP" value="7" enum="AccessibilityAction">
842
Hide tooltip action, callback argument is not set.
843
</constant>
844
<constant name="ACTION_SHOW_TOOLTIP" value="8" enum="AccessibilityAction">
845
Show tooltip action, callback argument is not set.
846
</constant>
847
<constant name="ACTION_SET_TEXT_SELECTION" value="9" enum="AccessibilityAction">
848
Set text selection action, callback argument is set to [Dictionary] with the following keys:
849
- [code]"start_element"[/code] accessibility element of the selection start.
850
- [code]"start_char"[/code] character offset relative to the accessibility element of the selection start.
851
- [code]"end_element"[/code] accessibility element of the selection end.
852
- [code]"end_char"[/code] character offset relative to the accessibility element of the selection end.
853
</constant>
854
<constant name="ACTION_REPLACE_SELECTED_TEXT" value="10" enum="AccessibilityAction">
855
Replace text action, callback argument is set to [String] with the replacement text.
856
</constant>
857
<constant name="ACTION_SCROLL_BACKWARD" value="11" enum="AccessibilityAction">
858
Scroll backward action, callback argument is not set.
859
</constant>
860
<constant name="ACTION_SCROLL_DOWN" value="12" enum="AccessibilityAction">
861
Scroll down action, callback argument is set to [enum AccessibilityScrollUnit].
862
</constant>
863
<constant name="ACTION_SCROLL_FORWARD" value="13" enum="AccessibilityAction">
864
Scroll forward action, callback argument is not set.
865
</constant>
866
<constant name="ACTION_SCROLL_LEFT" value="14" enum="AccessibilityAction">
867
Scroll left action, callback argument is set to [enum AccessibilityScrollUnit].
868
</constant>
869
<constant name="ACTION_SCROLL_RIGHT" value="15" enum="AccessibilityAction">
870
Scroll right action, callback argument is set to [enum AccessibilityScrollUnit].
871
</constant>
872
<constant name="ACTION_SCROLL_UP" value="16" enum="AccessibilityAction">
873
Scroll up action, callback argument is set to [enum AccessibilityScrollUnit].
874
</constant>
875
<constant name="ACTION_SCROLL_INTO_VIEW" value="17" enum="AccessibilityAction">
876
Scroll into view action, callback argument is set to [enum AccessibilityScrollHint].
877
</constant>
878
<constant name="ACTION_SCROLL_TO_POINT" value="18" enum="AccessibilityAction">
879
Scroll to point action, callback argument is set to [Vector2] with the relative point coordinates.
880
</constant>
881
<constant name="ACTION_SET_SCROLL_OFFSET" value="19" enum="AccessibilityAction">
882
Set scroll offset action, callback argument is set to [Vector2] with the scroll offset.
883
</constant>
884
<constant name="ACTION_SET_VALUE" value="20" enum="AccessibilityAction">
885
Set value action, callback argument is set to [String] or number with the new value.
886
</constant>
887
<constant name="ACTION_SHOW_CONTEXT_MENU" value="21" enum="AccessibilityAction">
888
Show context menu action, callback argument is not set.
889
</constant>
890
<constant name="ACTION_CUSTOM" value="22" enum="AccessibilityAction">
891
Custom action, callback argument is set to the integer action ID.
892
</constant>
893
<constant name="LIVE_OFF" value="0" enum="AccessibilityLiveMode">
894
Indicates that updates to the live region should not be presented.
895
</constant>
896
<constant name="LIVE_POLITE" value="1" enum="AccessibilityLiveMode">
897
Indicates that updates to the live region should be presented at the next opportunity (for example at the end of speaking the current sentence).
898
</constant>
899
<constant name="LIVE_ASSERTIVE" value="2" enum="AccessibilityLiveMode">
900
Indicates that updates to the live region have the highest priority and should be presented immediately.
901
</constant>
902
<constant name="SCROLL_UNIT_ITEM" value="0" enum="AccessibilityScrollUnit">
903
The amount by which to scroll. A single item of a list, line of text.
904
</constant>
905
<constant name="SCROLL_UNIT_PAGE" value="1" enum="AccessibilityScrollUnit">
906
The amount by which to scroll. A single page.
907
</constant>
908
<constant name="SCROLL_HINT_TOP_LEFT" value="0" enum="AccessibilityScrollHint">
909
A preferred position for the node scrolled into view. Top-left edge of the scroll container.
910
</constant>
911
<constant name="SCROLL_HINT_BOTTOM_RIGHT" value="1" enum="AccessibilityScrollHint">
912
A preferred position for the node scrolled into view. Bottom-right edge of the scroll container.
913
</constant>
914
<constant name="SCROLL_HINT_TOP_EDGE" value="2" enum="AccessibilityScrollHint">
915
A preferred position for the node scrolled into view. Top edge of the scroll container.
916
</constant>
917
<constant name="SCROLL_HINT_BOTTOM_EDGE" value="3" enum="AccessibilityScrollHint">
918
A preferred position for the node scrolled into view. Bottom edge of the scroll container.
919
</constant>
920
<constant name="SCROLL_HINT_LEFT_EDGE" value="4" enum="AccessibilityScrollHint">
921
A preferred position for the node scrolled into view. Left edge of the scroll container.
922
</constant>
923
<constant name="SCROLL_HINT_RIGHT_EDGE" value="5" enum="AccessibilityScrollHint">
924
A preferred position for the node scrolled into view. Right edge of the scroll container.
925
</constant>
926
</constants>
927
</class>
928
929