A server interface for screen reader support.
Creates a new, empty accessibility element resource. [b]Note:[/b] An accessibility element is created and freed automatically for each [Node]. In general, this function should not be called manually.
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.
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. 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.
Returns the metadata of the accessibility element [param id].
Sets the metadata of the accessibility element [param id] to [param meta].
Frees the accessibility element [param id] created by [method create_element], [method create_sub_element], or [method create_sub_text_edit_elements].
Returns the main accessibility element of the OS native window.
Returns [code]true[/code] if [param id] is a valid accessibility element.
Returns [code]true[/code] if screen reader is support by this implementation.
Sets the window focused state for assistive apps. [b]Note:[/b] This method is implemented on Linux, macOS, and Windows. [b]Note:[/b] Advanced users only! [Window] objects call this method automatically.
Sets window outer (with decorations) and inner (without decorations) bounds for assistive apps. [b]Note:[/b] This method is implemented on Linux, macOS, and Windows. [b]Note:[/b] Advanced users only! [Window] objects call this method automatically.
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.
Adds a child accessibility element. [b]Note:[/b] [Node] children and sub-elements are added to the child list automatically.
Adds support for a custom accessibility action. [param action_id] is passed as an argument to the callback of [constant ACTION_CUSTOM] action.
Adds an element that is controlled by this element.
Adds an element that describes this element.
Adds an element that details this element.
Adds an element that this element flow into.
Adds an element that labels this element.
Adds an element that is part of the same radio group. [b]Note:[/b] This method should be called on each element of the group, using all other elements as [param related_id].
Adds an element that is an active descendant of this element.
Sets element background color.
Sets element bounding box, relative to the node position.
Sets element accessibility label for Braille display.
Sets element accessibility role description for Braille display.
Sets element checked state.
Sets element class name.
Sets element color value.
Sets element accessibility description.
Sets an element which contains an error message for this element.
Sets element accessibility extra information added to the element name.
Sets element flag.
Sets currently focused element.
Sets element foreground color.
Sets target element for the link.
Sets element text language.
Sets number of items in the list.
Sets list/tree item expanded status.
Sets the position of the element in the list.
Sets the hierarchical level of the element in the list.
Sets list/tree item selected status.
Sets the orientation of the list elements.
Sets the priority of the live region updates.
Sets the element to be a member of the group.
Sets element accessibility name.
Sets next element on the line.
Sets numeric value jump.
Sets numeric value range.
Sets numeric value step.
Sets numeric value.
Sets placeholder text.
Sets popup type for popup buttons.
Sets previous element on the line.
Sets element accessibility role.
Sets element accessibility role description text.
Sets scroll bar x position.
Sets scroll bar x range.
Sets scroll bar y position.
Sets scroll bar y range.
Sets the list of keyboard shortcuts used by element.
Sets human-readable description of the current checked state.
Sets cell position in the table.
Sets cell row/column span.
Sets number of columns in the table.
Sets position of the column.
Sets number of rows in the table.
Sets position of the row in the table.
Sets element text alignment.
Sets text underline/overline/strikethrough.
Sets text orientation.
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.
Sets tooltip text.
Sets element 2D transform.
Sets link URL.
Sets element text value.
Unknown or custom role.
Default dialog button element.
Audio player element.
Video player element.
Non-editable text label.
Container element. Elements with this role are used for internal structure and ignored by screen readers.
Panel container element.
Button element.
Link element.
Check box element.
Radio button element.
Check button element.
Scroll bar element.
Scroll container element.
Container splitter handle element.
Slider element.
Spin box element.
Progress indicator element.
Editable text field element.
Multiline editable text field element.
Color picker element.
Table element.
Table/tree cell element.
Table/tree row element.
Table/tree row group element.
Table/tree row header element.
Table/tree column header element.
Tree view element.
Tree view item element.
List element.
List item element.
List view element.
List view item element.
Tab bar element.
Tab bar item element.
Tab panel element.
Menu bar element.
Popup menu element.
Popup menu item element.
Popup menu check button item element.
Popup menu radio button item element.
Image element.
Window element.
Embedded window title bar element.
Dialog window element.
Tooltip element.
Region/landmark element. Screen readers can navigate between regions using landmark navigation.
Unifor text run. Note: This role is used for internal text elements, and should not be assigned to nodes.
Popup menu.
Popup list.
Popup tree view.
Popup dialog.
Element is hidden for accessibility tools.
Element supports multiple item selection.
Element require user input.
Element is a visited link.
Element content is not ready (e.g. loading).
Element is modal window.
Element allows touches to be passed through when a screen reader is in touch exploration mode.
Element is text field with selectable but read-only text.
Element is disabled.
Element clips children.
Single click action, callback argument is not set.
Focus action, callback argument is not set.
Blur action, callback argument is not set.
Collapse action, callback argument is not set.
Expand action, callback argument is not set.
Decrement action, callback argument is not set.
Increment action, callback argument is not set.
Hide tooltip action, callback argument is not set.
Show tooltip action, callback argument is not set.
Set text selection action, callback argument is set to [Dictionary] with the following keys: - [code]"start_element"[/code] accessibility element of the selection start. - [code]"start_char"[/code] character offset relative to the accessibility element of the selection start. - [code]"end_element"[/code] accessibility element of the selection end. - [code]"end_char"[/code] character offset relative to the accessibility element of the selection end.
Replace text action, callback argument is set to [String] with the replacement text.
Scroll backward action, callback argument is not set.
Scroll down action, callback argument is set to [enum AccessibilityScrollUnit].
Scroll forward action, callback argument is not set.
Scroll left action, callback argument is set to [enum AccessibilityScrollUnit].
Scroll right action, callback argument is set to [enum AccessibilityScrollUnit].
Scroll up action, callback argument is set to [enum AccessibilityScrollUnit].
Scroll into view action, callback argument is set to [enum AccessibilityScrollHint].
Scroll to point action, callback argument is set to [Vector2] with the relative point coordinates.
Set scroll offset action, callback argument is set to [Vector2] with the scroll offset.
Set value action, callback argument is set to [String] or number with the new value.
Show context menu action, callback argument is not set.
Custom action, callback argument is set to the integer action ID.
Indicates that updates to the live region should not be presented.
Indicates that updates to the live region should be presented at the next opportunity (for example at the end of speaking the current sentence).
Indicates that updates to the live region have the highest priority and should be presented immediately.
The amount by which to scroll. A single item of a list, line of text.
The amount by which to scroll. A single page.
A preferred position for the node scrolled into view. Top-left edge of the scroll container.
A preferred position for the node scrolled into view. Bottom-right edge of the scroll container.
A preferred position for the node scrolled into view. Top edge of the scroll container.
A preferred position for the node scrolled into view. Bottom edge of the scroll container.
A preferred position for the node scrolled into view. Left edge of the scroll container.
A preferred position for the node scrolled into view. Right edge of the scroll container.