:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AccessibilityServer.xml. .. _class_AccessibilityServer: AccessibilityServer =================== **Inherits:** :ref:`Object` A server interface for screen reader support. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`create_element`\ (\ window_id\: :ref:`int`, role\: :ref:`AccessibilityRole`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`create_sub_element`\ (\ parent_rid\: :ref:`RID`, role\: :ref:`AccessibilityRole`, insert_pos\: :ref:`int` = -1\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`create_sub_text_edit_elements`\ (\ parent_rid\: :ref:`RID`, shaped_text\: :ref:`RID`, min_height\: :ref:`float`, insert_pos\: :ref:`int` = -1, is_last_line\: :ref:`bool` = false\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`element_get_meta`\ (\ id\: :ref:`RID`\ ) |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`element_set_meta`\ (\ id\: :ref:`RID`, meta\: :ref:`Variant`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`free_element`\ (\ id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_window_root`\ (\ window_id\: :ref:`int`\ ) |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_element`\ (\ id\: :ref:`RID`\ ) |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_supported`\ (\ ) |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_window_focused`\ (\ window_id\: :ref:`int`, focused\: :ref:`bool`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_window_rect`\ (\ window_id\: :ref:`int`, rect_out\: :ref:`Rect2`, rect_in\: :ref:`Rect2`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_add_action`\ (\ id\: :ref:`RID`, action\: :ref:`AccessibilityAction`, callable\: :ref:`Callable`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_add_child`\ (\ id\: :ref:`RID`, child_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_add_custom_action`\ (\ id\: :ref:`RID`, action_id\: :ref:`int`, action_description\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_add_related_controls`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_add_related_described_by`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_add_related_details`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_add_related_flow_to`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_add_related_labeled_by`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_add_related_radio_group`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_active_descendant`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_background_color`\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_bounds`\ (\ id\: :ref:`RID`, rect\: :ref:`Rect2`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_braille_label`\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_braille_role_description`\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_checked`\ (\ id\: :ref:`RID`, checekd\: :ref:`bool`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_classname`\ (\ id\: :ref:`RID`, classname\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_color_value`\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_description`\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_error_message`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_extra_info`\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_flag`\ (\ id\: :ref:`RID`, flag\: :ref:`AccessibilityFlags`, value\: :ref:`bool`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_focus`\ (\ id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_foreground_color`\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_in_page_link_target`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_language`\ (\ id\: :ref:`RID`, language\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_list_item_count`\ (\ id\: :ref:`RID`, size\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_list_item_expanded`\ (\ id\: :ref:`RID`, expanded\: :ref:`bool`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_list_item_index`\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_list_item_level`\ (\ id\: :ref:`RID`, level\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_list_item_selected`\ (\ id\: :ref:`RID`, selected\: :ref:`bool`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_list_orientation`\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_live`\ (\ id\: :ref:`RID`, live\: :ref:`AccessibilityLiveMode`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_member_of`\ (\ id\: :ref:`RID`, group_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_name`\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_next_on_line`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_num_jump`\ (\ id\: :ref:`RID`, jump\: :ref:`float`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_num_range`\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_num_step`\ (\ id\: :ref:`RID`, step\: :ref:`float`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_num_value`\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_placeholder`\ (\ id\: :ref:`RID`, placeholder\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_popup_type`\ (\ id\: :ref:`RID`, popup\: :ref:`AccessibilityPopupType`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_previous_on_line`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_role`\ (\ id\: :ref:`RID`, role\: :ref:`AccessibilityRole`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_role_description`\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_scroll_x`\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_scroll_x_range`\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_scroll_y`\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_scroll_y_range`\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_shortcut`\ (\ id\: :ref:`RID`, shortcut\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_state_description`\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_table_cell_position`\ (\ id\: :ref:`RID`, row_index\: :ref:`int`, column_index\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_table_cell_span`\ (\ id\: :ref:`RID`, row_span\: :ref:`int`, column_span\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_table_column_count`\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_table_column_index`\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_table_row_count`\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_table_row_index`\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_text_align`\ (\ id\: :ref:`RID`, align\: :ref:`HorizontalAlignment`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_text_decorations`\ (\ id\: :ref:`RID`, underline\: :ref:`bool`, strikethrough\: :ref:`bool`, overline\: :ref:`bool`, color\: :ref:`Color` = Color(0, 0, 0, 1)\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_text_orientation`\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_text_selection`\ (\ id\: :ref:`RID`, text_start_id\: :ref:`RID`, start_char\: :ref:`int`, text_end_id\: :ref:`RID`, end_char\: :ref:`int`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_tooltip`\ (\ id\: :ref:`RID`, tooltip\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_transform`\ (\ id\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_url`\ (\ id\: :ref:`RID`, url\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_set_value`\ (\ id\: :ref:`RID`, value\: :ref:`String`\ ) | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_AccessibilityServer_AccessibilityRole: .. rst-class:: classref-enumeration enum **AccessibilityRole**: :ref:`🔗` .. _class_AccessibilityServer_constant_ROLE_UNKNOWN: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_UNKNOWN** = ``0`` Unknown or custom role. .. _class_AccessibilityServer_constant_ROLE_DEFAULT_BUTTON: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_DEFAULT_BUTTON** = ``1`` Default dialog button element. .. _class_AccessibilityServer_constant_ROLE_AUDIO: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_AUDIO** = ``2`` Audio player element. .. _class_AccessibilityServer_constant_ROLE_VIDEO: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_VIDEO** = ``3`` Video player element. .. _class_AccessibilityServer_constant_ROLE_STATIC_TEXT: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_STATIC_TEXT** = ``4`` Non-editable text label. .. _class_AccessibilityServer_constant_ROLE_CONTAINER: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_CONTAINER** = ``5`` Container element. Elements with this role are used for internal structure and ignored by screen readers. .. _class_AccessibilityServer_constant_ROLE_PANEL: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_PANEL** = ``6`` Panel container element. .. _class_AccessibilityServer_constant_ROLE_BUTTON: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_BUTTON** = ``7`` Button element. .. _class_AccessibilityServer_constant_ROLE_LINK: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_LINK** = ``8`` Link element. .. _class_AccessibilityServer_constant_ROLE_CHECK_BOX: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_CHECK_BOX** = ``9`` Check box element. .. _class_AccessibilityServer_constant_ROLE_RADIO_BUTTON: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_RADIO_BUTTON** = ``10`` Radio button element. .. _class_AccessibilityServer_constant_ROLE_CHECK_BUTTON: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_CHECK_BUTTON** = ``11`` Check button element. .. _class_AccessibilityServer_constant_ROLE_SCROLL_BAR: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_SCROLL_BAR** = ``12`` Scroll bar element. .. _class_AccessibilityServer_constant_ROLE_SCROLL_VIEW: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_SCROLL_VIEW** = ``13`` Scroll container element. .. _class_AccessibilityServer_constant_ROLE_SPLITTER: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_SPLITTER** = ``14`` Container splitter handle element. .. _class_AccessibilityServer_constant_ROLE_SLIDER: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_SLIDER** = ``15`` Slider element. .. _class_AccessibilityServer_constant_ROLE_SPIN_BUTTON: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_SPIN_BUTTON** = ``16`` Spin box element. .. _class_AccessibilityServer_constant_ROLE_PROGRESS_INDICATOR: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_PROGRESS_INDICATOR** = ``17`` Progress indicator element. .. _class_AccessibilityServer_constant_ROLE_TEXT_FIELD: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_TEXT_FIELD** = ``18`` Editable text field element. .. _class_AccessibilityServer_constant_ROLE_MULTILINE_TEXT_FIELD: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_MULTILINE_TEXT_FIELD** = ``19`` Multiline editable text field element. .. _class_AccessibilityServer_constant_ROLE_COLOR_PICKER: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_COLOR_PICKER** = ``20`` Color picker element. .. _class_AccessibilityServer_constant_ROLE_TABLE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_TABLE** = ``21`` Table element. .. _class_AccessibilityServer_constant_ROLE_CELL: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_CELL** = ``22`` Table/tree cell element. .. _class_AccessibilityServer_constant_ROLE_ROW: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_ROW** = ``23`` Table/tree row element. .. _class_AccessibilityServer_constant_ROLE_ROW_GROUP: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_ROW_GROUP** = ``24`` Table/tree row group element. .. _class_AccessibilityServer_constant_ROLE_ROW_HEADER: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_ROW_HEADER** = ``25`` Table/tree row header element. .. _class_AccessibilityServer_constant_ROLE_COLUMN_HEADER: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_COLUMN_HEADER** = ``26`` Table/tree column header element. .. _class_AccessibilityServer_constant_ROLE_TREE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_TREE** = ``27`` Tree view element. .. _class_AccessibilityServer_constant_ROLE_TREE_ITEM: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_TREE_ITEM** = ``28`` Tree view item element. .. _class_AccessibilityServer_constant_ROLE_LIST: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_LIST** = ``29`` List element. .. _class_AccessibilityServer_constant_ROLE_LIST_ITEM: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_LIST_ITEM** = ``30`` List item element. .. _class_AccessibilityServer_constant_ROLE_LIST_BOX: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_LIST_BOX** = ``31`` List view element. .. _class_AccessibilityServer_constant_ROLE_LIST_BOX_OPTION: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_LIST_BOX_OPTION** = ``32`` List view item element. .. _class_AccessibilityServer_constant_ROLE_TAB_BAR: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_TAB_BAR** = ``33`` Tab bar element. .. _class_AccessibilityServer_constant_ROLE_TAB: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_TAB** = ``34`` Tab bar item element. .. _class_AccessibilityServer_constant_ROLE_TAB_PANEL: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_TAB_PANEL** = ``35`` Tab panel element. .. _class_AccessibilityServer_constant_ROLE_MENU_BAR: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_MENU_BAR** = ``36`` Menu bar element. .. _class_AccessibilityServer_constant_ROLE_MENU: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_MENU** = ``37`` Popup menu element. .. _class_AccessibilityServer_constant_ROLE_MENU_ITEM: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_MENU_ITEM** = ``38`` Popup menu item element. .. _class_AccessibilityServer_constant_ROLE_MENU_ITEM_CHECK_BOX: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_MENU_ITEM_CHECK_BOX** = ``39`` Popup menu check button item element. .. _class_AccessibilityServer_constant_ROLE_MENU_ITEM_RADIO: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_MENU_ITEM_RADIO** = ``40`` Popup menu radio button item element. .. _class_AccessibilityServer_constant_ROLE_IMAGE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_IMAGE** = ``41`` Image element. .. _class_AccessibilityServer_constant_ROLE_WINDOW: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_WINDOW** = ``42`` Window element. .. _class_AccessibilityServer_constant_ROLE_TITLE_BAR: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_TITLE_BAR** = ``43`` Embedded window title bar element. .. _class_AccessibilityServer_constant_ROLE_DIALOG: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_DIALOG** = ``44`` Dialog window element. .. _class_AccessibilityServer_constant_ROLE_TOOLTIP: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_TOOLTIP** = ``45`` Tooltip element. .. _class_AccessibilityServer_constant_ROLE_REGION: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_REGION** = ``46`` Region/landmark element. Screen readers can navigate between regions using landmark navigation. .. _class_AccessibilityServer_constant_ROLE_TEXT_RUN: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityRole` **ROLE_TEXT_RUN** = ``47`` Unifor text run. Note: This role is used for internal text elements, and should not be assigned to nodes. .. rst-class:: classref-item-separator ---- .. _enum_AccessibilityServer_AccessibilityPopupType: .. rst-class:: classref-enumeration enum **AccessibilityPopupType**: :ref:`🔗` .. _class_AccessibilityServer_constant_POPUP_MENU: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityPopupType` **POPUP_MENU** = ``0`` Popup menu. .. _class_AccessibilityServer_constant_POPUP_LIST: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityPopupType` **POPUP_LIST** = ``1`` Popup list. .. _class_AccessibilityServer_constant_POPUP_TREE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityPopupType` **POPUP_TREE** = ``2`` Popup tree view. .. _class_AccessibilityServer_constant_POPUP_DIALOG: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityPopupType` **POPUP_DIALOG** = ``3`` Popup dialog. .. rst-class:: classref-item-separator ---- .. _enum_AccessibilityServer_AccessibilityFlags: .. rst-class:: classref-enumeration enum **AccessibilityFlags**: :ref:`🔗` .. _class_AccessibilityServer_constant_FLAG_HIDDEN: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityFlags` **FLAG_HIDDEN** = ``0`` Element is hidden for accessibility tools. .. _class_AccessibilityServer_constant_FLAG_MULTISELECTABLE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityFlags` **FLAG_MULTISELECTABLE** = ``1`` Element supports multiple item selection. .. _class_AccessibilityServer_constant_FLAG_REQUIRED: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityFlags` **FLAG_REQUIRED** = ``2`` Element require user input. .. _class_AccessibilityServer_constant_FLAG_VISITED: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityFlags` **FLAG_VISITED** = ``3`` Element is a visited link. .. _class_AccessibilityServer_constant_FLAG_BUSY: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityFlags` **FLAG_BUSY** = ``4`` Element content is not ready (e.g. loading). .. _class_AccessibilityServer_constant_FLAG_MODAL: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityFlags` **FLAG_MODAL** = ``5`` Element is modal window. .. _class_AccessibilityServer_constant_FLAG_TOUCH_PASSTHROUGH: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityFlags` **FLAG_TOUCH_PASSTHROUGH** = ``6`` Element allows touches to be passed through when a screen reader is in touch exploration mode. .. _class_AccessibilityServer_constant_FLAG_READONLY: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityFlags` **FLAG_READONLY** = ``7`` Element is text field with selectable but read-only text. .. _class_AccessibilityServer_constant_FLAG_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityFlags` **FLAG_DISABLED** = ``8`` Element is disabled. .. _class_AccessibilityServer_constant_FLAG_CLIPS_CHILDREN: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityFlags` **FLAG_CLIPS_CHILDREN** = ``9`` Element clips children. .. rst-class:: classref-item-separator ---- .. _enum_AccessibilityServer_AccessibilityAction: .. rst-class:: classref-enumeration enum **AccessibilityAction**: :ref:`🔗` .. _class_AccessibilityServer_constant_ACTION_CLICK: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_CLICK** = ``0`` Single click action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_FOCUS: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_FOCUS** = ``1`` Focus action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_BLUR: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_BLUR** = ``2`` Blur action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_COLLAPSE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_COLLAPSE** = ``3`` Collapse action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_EXPAND: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_EXPAND** = ``4`` Expand action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_DECREMENT: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_DECREMENT** = ``5`` Decrement action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_INCREMENT: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_INCREMENT** = ``6`` Increment action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_HIDE_TOOLTIP: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_HIDE_TOOLTIP** = ``7`` Hide tooltip action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_SHOW_TOOLTIP: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SHOW_TOOLTIP** = ``8`` Show tooltip action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_SET_TEXT_SELECTION: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SET_TEXT_SELECTION** = ``9`` Set text selection action, callback argument is set to :ref:`Dictionary` with the following keys: - ``"start_element"`` accessibility element of the selection start. - ``"start_char"`` character offset relative to the accessibility element of the selection start. - ``"end_element"`` accessibility element of the selection end. - ``"end_char"`` character offset relative to the accessibility element of the selection end. .. _class_AccessibilityServer_constant_ACTION_REPLACE_SELECTED_TEXT: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_REPLACE_SELECTED_TEXT** = ``10`` Replace text action, callback argument is set to :ref:`String` with the replacement text. .. _class_AccessibilityServer_constant_ACTION_SCROLL_BACKWARD: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SCROLL_BACKWARD** = ``11`` Scroll backward action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_SCROLL_DOWN: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SCROLL_DOWN** = ``12`` Scroll down action, callback argument is set to :ref:`AccessibilityScrollUnit`. .. _class_AccessibilityServer_constant_ACTION_SCROLL_FORWARD: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SCROLL_FORWARD** = ``13`` Scroll forward action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_SCROLL_LEFT: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SCROLL_LEFT** = ``14`` Scroll left action, callback argument is set to :ref:`AccessibilityScrollUnit`. .. _class_AccessibilityServer_constant_ACTION_SCROLL_RIGHT: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SCROLL_RIGHT** = ``15`` Scroll right action, callback argument is set to :ref:`AccessibilityScrollUnit`. .. _class_AccessibilityServer_constant_ACTION_SCROLL_UP: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SCROLL_UP** = ``16`` Scroll up action, callback argument is set to :ref:`AccessibilityScrollUnit`. .. _class_AccessibilityServer_constant_ACTION_SCROLL_INTO_VIEW: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SCROLL_INTO_VIEW** = ``17`` Scroll into view action, callback argument is set to :ref:`AccessibilityScrollHint`. .. _class_AccessibilityServer_constant_ACTION_SCROLL_TO_POINT: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SCROLL_TO_POINT** = ``18`` Scroll to point action, callback argument is set to :ref:`Vector2` with the relative point coordinates. .. _class_AccessibilityServer_constant_ACTION_SET_SCROLL_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SET_SCROLL_OFFSET** = ``19`` Set scroll offset action, callback argument is set to :ref:`Vector2` with the scroll offset. .. _class_AccessibilityServer_constant_ACTION_SET_VALUE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SET_VALUE** = ``20`` Set value action, callback argument is set to :ref:`String` or number with the new value. .. _class_AccessibilityServer_constant_ACTION_SHOW_CONTEXT_MENU: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_SHOW_CONTEXT_MENU** = ``21`` Show context menu action, callback argument is not set. .. _class_AccessibilityServer_constant_ACTION_CUSTOM: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityAction` **ACTION_CUSTOM** = ``22`` Custom action, callback argument is set to the integer action ID. .. rst-class:: classref-item-separator ---- .. _enum_AccessibilityServer_AccessibilityLiveMode: .. rst-class:: classref-enumeration enum **AccessibilityLiveMode**: :ref:`🔗` .. _class_AccessibilityServer_constant_LIVE_OFF: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityLiveMode` **LIVE_OFF** = ``0`` Indicates that updates to the live region should not be presented. .. _class_AccessibilityServer_constant_LIVE_POLITE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityLiveMode` **LIVE_POLITE** = ``1`` Indicates that updates to the live region should be presented at the next opportunity (for example at the end of speaking the current sentence). .. _class_AccessibilityServer_constant_LIVE_ASSERTIVE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityLiveMode` **LIVE_ASSERTIVE** = ``2`` Indicates that updates to the live region have the highest priority and should be presented immediately. .. rst-class:: classref-item-separator ---- .. _enum_AccessibilityServer_AccessibilityScrollUnit: .. rst-class:: classref-enumeration enum **AccessibilityScrollUnit**: :ref:`🔗` .. _class_AccessibilityServer_constant_SCROLL_UNIT_ITEM: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityScrollUnit` **SCROLL_UNIT_ITEM** = ``0`` The amount by which to scroll. A single item of a list, line of text. .. _class_AccessibilityServer_constant_SCROLL_UNIT_PAGE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityScrollUnit` **SCROLL_UNIT_PAGE** = ``1`` The amount by which to scroll. A single page. .. rst-class:: classref-item-separator ---- .. _enum_AccessibilityServer_AccessibilityScrollHint: .. rst-class:: classref-enumeration enum **AccessibilityScrollHint**: :ref:`🔗` .. _class_AccessibilityServer_constant_SCROLL_HINT_TOP_LEFT: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityScrollHint` **SCROLL_HINT_TOP_LEFT** = ``0`` A preferred position for the node scrolled into view. Top-left edge of the scroll container. .. _class_AccessibilityServer_constant_SCROLL_HINT_BOTTOM_RIGHT: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityScrollHint` **SCROLL_HINT_BOTTOM_RIGHT** = ``1`` A preferred position for the node scrolled into view. Bottom-right edge of the scroll container. .. _class_AccessibilityServer_constant_SCROLL_HINT_TOP_EDGE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityScrollHint` **SCROLL_HINT_TOP_EDGE** = ``2`` A preferred position for the node scrolled into view. Top edge of the scroll container. .. _class_AccessibilityServer_constant_SCROLL_HINT_BOTTOM_EDGE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityScrollHint` **SCROLL_HINT_BOTTOM_EDGE** = ``3`` A preferred position for the node scrolled into view. Bottom edge of the scroll container. .. _class_AccessibilityServer_constant_SCROLL_HINT_LEFT_EDGE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityScrollHint` **SCROLL_HINT_LEFT_EDGE** = ``4`` A preferred position for the node scrolled into view. Left edge of the scroll container. .. _class_AccessibilityServer_constant_SCROLL_HINT_RIGHT_EDGE: .. rst-class:: classref-enumeration-constant :ref:`AccessibilityScrollHint` **SCROLL_HINT_RIGHT_EDGE** = ``5`` A preferred position for the node scrolled into view. Right edge of the scroll container. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AccessibilityServer_method_create_element: .. rst-class:: classref-method :ref:`RID` **create_element**\ (\ window_id\: :ref:`int`, role\: :ref:`AccessibilityRole`\ ) :ref:`🔗` Creates a new, empty accessibility element resource. \ **Note:** An accessibility element is created and freed automatically for each :ref:`Node`. In general, this function should not be called manually. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_create_sub_element: .. rst-class:: classref-method :ref:`RID` **create_sub_element**\ (\ parent_rid\: :ref:`RID`, role\: :ref:`AccessibilityRole`, insert_pos\: :ref:`int` = -1\ ) :ref:`🔗` Creates a new, empty accessibility sub-element resource. Sub-elements can be used to provide accessibility information for objects which are not :ref:`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 :ref:`free_element()` method. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_create_sub_text_edit_elements: .. rst-class:: classref-method :ref:`RID` **create_sub_text_edit_elements**\ (\ parent_rid\: :ref:`RID`, shaped_text\: :ref:`RID`, min_height\: :ref:`float`, insert_pos\: :ref:`int` = -1, is_last_line\: :ref:`bool` = false\ ) :ref:`🔗` 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 :ref:`free_element()` method. If ``is_last_line`` is ``true``, no trailing newline is appended to the text content. Set to ``true`` for the last line in multi-line text fields and for single-line text fields. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_element_get_meta: .. rst-class:: classref-method :ref:`Variant` **element_get_meta**\ (\ id\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the metadata of the accessibility element ``id``. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_element_set_meta: .. rst-class:: classref-method |void| **element_set_meta**\ (\ id\: :ref:`RID`, meta\: :ref:`Variant`\ ) :ref:`🔗` Sets the metadata of the accessibility element ``id`` to ``meta``. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_free_element: .. rst-class:: classref-method |void| **free_element**\ (\ id\: :ref:`RID`\ ) :ref:`🔗` Frees the accessibility element ``id`` created by :ref:`create_element()`, :ref:`create_sub_element()`, or :ref:`create_sub_text_edit_elements()`. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_get_window_root: .. rst-class:: classref-method :ref:`RID` **get_window_root**\ (\ window_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the main accessibility element of the OS native window. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_has_element: .. rst-class:: classref-method :ref:`bool` **has_element**\ (\ id\: :ref:`RID`\ ) |const| :ref:`🔗` Returns ``true`` if ``id`` is a valid accessibility element. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_is_supported: .. rst-class:: classref-method :ref:`bool` **is_supported**\ (\ ) |const| :ref:`🔗` Returns ``true`` if screen reader is support by this implementation. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_set_window_focused: .. rst-class:: classref-method |void| **set_window_focused**\ (\ window_id\: :ref:`int`, focused\: :ref:`bool`\ ) :ref:`🔗` Sets the window focused state for assistive apps. \ **Note:** This method is implemented on Linux, macOS, and Windows. \ **Note:** Advanced users only! :ref:`Window` objects call this method automatically. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_set_window_rect: .. rst-class:: classref-method |void| **set_window_rect**\ (\ window_id\: :ref:`int`, rect_out\: :ref:`Rect2`, rect_in\: :ref:`Rect2`\ ) :ref:`🔗` Sets window outer (with decorations) and inner (without decorations) bounds for assistive apps. \ **Note:** This method is implemented on Linux, macOS, and Windows. \ **Note:** Advanced users only! :ref:`Window` objects call this method automatically. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_add_action: .. rst-class:: classref-method |void| **update_add_action**\ (\ id\: :ref:`RID`, action\: :ref:`AccessibilityAction`, callable\: :ref:`Callable`\ ) :ref:`🔗` 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 :ref:`Variant` argument, which value depends on action type. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_add_child: .. rst-class:: classref-method |void| **update_add_child**\ (\ id\: :ref:`RID`, child_id\: :ref:`RID`\ ) :ref:`🔗` Adds a child accessibility element. \ **Note:** :ref:`Node` children and sub-elements are added to the child list automatically. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_add_custom_action: .. rst-class:: classref-method |void| **update_add_custom_action**\ (\ id\: :ref:`RID`, action_id\: :ref:`int`, action_description\: :ref:`String`\ ) :ref:`🔗` Adds support for a custom accessibility action. ``action_id`` is passed as an argument to the callback of :ref:`ACTION_CUSTOM` action. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_add_related_controls: .. rst-class:: classref-method |void| **update_add_related_controls**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` Adds an element that is controlled by this element. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_add_related_described_by: .. rst-class:: classref-method |void| **update_add_related_described_by**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` Adds an element that describes this element. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_add_related_details: .. rst-class:: classref-method |void| **update_add_related_details**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` Adds an element that details this element. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_add_related_flow_to: .. rst-class:: classref-method |void| **update_add_related_flow_to**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` Adds an element that this element flow into. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_add_related_labeled_by: .. rst-class:: classref-method |void| **update_add_related_labeled_by**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` Adds an element that labels this element. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_add_related_radio_group: .. rst-class:: classref-method |void| **update_add_related_radio_group**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` Adds an element that is part of the same radio group. \ **Note:** This method should be called on each element of the group, using all other elements as ``related_id``. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_active_descendant: .. rst-class:: classref-method |void| **update_set_active_descendant**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` Adds an element that is an active descendant of this element. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_background_color: .. rst-class:: classref-method |void| **update_set_background_color**\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Sets element background color. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_bounds: .. rst-class:: classref-method |void| **update_set_bounds**\ (\ id\: :ref:`RID`, rect\: :ref:`Rect2`\ ) :ref:`🔗` Sets element bounding box, relative to the node position. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_braille_label: .. rst-class:: classref-method |void| **update_set_braille_label**\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) :ref:`🔗` Sets element accessibility label for Braille display. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_braille_role_description: .. rst-class:: classref-method |void| **update_set_braille_role_description**\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) :ref:`🔗` Sets element accessibility role description for Braille display. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_checked: .. rst-class:: classref-method |void| **update_set_checked**\ (\ id\: :ref:`RID`, checekd\: :ref:`bool`\ ) :ref:`🔗` Sets element checked state. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_classname: .. rst-class:: classref-method |void| **update_set_classname**\ (\ id\: :ref:`RID`, classname\: :ref:`String`\ ) :ref:`🔗` Sets element class name. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_color_value: .. rst-class:: classref-method |void| **update_set_color_value**\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Sets element color value. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_description: .. rst-class:: classref-method |void| **update_set_description**\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) :ref:`🔗` Sets element accessibility description. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_error_message: .. rst-class:: classref-method |void| **update_set_error_message**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` Sets an element which contains an error message for this element. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_extra_info: .. rst-class:: classref-method |void| **update_set_extra_info**\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) :ref:`🔗` Sets element accessibility extra information added to the element name. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_flag: .. rst-class:: classref-method |void| **update_set_flag**\ (\ id\: :ref:`RID`, flag\: :ref:`AccessibilityFlags`, value\: :ref:`bool`\ ) :ref:`🔗` Sets element flag. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_focus: .. rst-class:: classref-method |void| **update_set_focus**\ (\ id\: :ref:`RID`\ ) :ref:`🔗` Sets currently focused element. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_foreground_color: .. rst-class:: classref-method |void| **update_set_foreground_color**\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` Sets element foreground color. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_in_page_link_target: .. rst-class:: classref-method |void| **update_set_in_page_link_target**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` Sets target element for the link. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_language: .. rst-class:: classref-method |void| **update_set_language**\ (\ id\: :ref:`RID`, language\: :ref:`String`\ ) :ref:`🔗` Sets element text language. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_list_item_count: .. rst-class:: classref-method |void| **update_set_list_item_count**\ (\ id\: :ref:`RID`, size\: :ref:`int`\ ) :ref:`🔗` Sets number of items in the list. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_list_item_expanded: .. rst-class:: classref-method |void| **update_set_list_item_expanded**\ (\ id\: :ref:`RID`, expanded\: :ref:`bool`\ ) :ref:`🔗` Sets list/tree item expanded status. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_list_item_index: .. rst-class:: classref-method |void| **update_set_list_item_index**\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` Sets the position of the element in the list. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_list_item_level: .. rst-class:: classref-method |void| **update_set_list_item_level**\ (\ id\: :ref:`RID`, level\: :ref:`int`\ ) :ref:`🔗` Sets the hierarchical level of the element in the list. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_list_item_selected: .. rst-class:: classref-method |void| **update_set_list_item_selected**\ (\ id\: :ref:`RID`, selected\: :ref:`bool`\ ) :ref:`🔗` Sets list/tree item selected status. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_list_orientation: .. rst-class:: classref-method |void| **update_set_list_orientation**\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) :ref:`🔗` Sets the orientation of the list elements. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_live: .. rst-class:: classref-method |void| **update_set_live**\ (\ id\: :ref:`RID`, live\: :ref:`AccessibilityLiveMode`\ ) :ref:`🔗` Sets the priority of the live region updates. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_member_of: .. rst-class:: classref-method |void| **update_set_member_of**\ (\ id\: :ref:`RID`, group_id\: :ref:`RID`\ ) :ref:`🔗` Sets the element to be a member of the group. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_name: .. rst-class:: classref-method |void| **update_set_name**\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) :ref:`🔗` Sets element accessibility name. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_next_on_line: .. rst-class:: classref-method |void| **update_set_next_on_line**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` Sets next element on the line. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_num_jump: .. rst-class:: classref-method |void| **update_set_num_jump**\ (\ id\: :ref:`RID`, jump\: :ref:`float`\ ) :ref:`🔗` Sets numeric value jump. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_num_range: .. rst-class:: classref-method |void| **update_set_num_range**\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` Sets numeric value range. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_num_step: .. rst-class:: classref-method |void| **update_set_num_step**\ (\ id\: :ref:`RID`, step\: :ref:`float`\ ) :ref:`🔗` Sets numeric value step. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_num_value: .. rst-class:: classref-method |void| **update_set_num_value**\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) :ref:`🔗` Sets numeric value. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_placeholder: .. rst-class:: classref-method |void| **update_set_placeholder**\ (\ id\: :ref:`RID`, placeholder\: :ref:`String`\ ) :ref:`🔗` Sets placeholder text. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_popup_type: .. rst-class:: classref-method |void| **update_set_popup_type**\ (\ id\: :ref:`RID`, popup\: :ref:`AccessibilityPopupType`\ ) :ref:`🔗` Sets popup type for popup buttons. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_previous_on_line: .. rst-class:: classref-method |void| **update_set_previous_on_line**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` Sets previous element on the line. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_role: .. rst-class:: classref-method |void| **update_set_role**\ (\ id\: :ref:`RID`, role\: :ref:`AccessibilityRole`\ ) :ref:`🔗` Sets element accessibility role. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_role_description: .. rst-class:: classref-method |void| **update_set_role_description**\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) :ref:`🔗` Sets element accessibility role description text. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_scroll_x: .. rst-class:: classref-method |void| **update_set_scroll_x**\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) :ref:`🔗` Sets scroll bar x position. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_scroll_x_range: .. rst-class:: classref-method |void| **update_set_scroll_x_range**\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` Sets scroll bar x range. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_scroll_y: .. rst-class:: classref-method |void| **update_set_scroll_y**\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) :ref:`🔗` Sets scroll bar y position. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_scroll_y_range: .. rst-class:: classref-method |void| **update_set_scroll_y_range**\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` Sets scroll bar y range. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_shortcut: .. rst-class:: classref-method |void| **update_set_shortcut**\ (\ id\: :ref:`RID`, shortcut\: :ref:`String`\ ) :ref:`🔗` Sets the list of keyboard shortcuts used by element. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_state_description: .. rst-class:: classref-method |void| **update_set_state_description**\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) :ref:`🔗` Sets human-readable description of the current checked state. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_table_cell_position: .. rst-class:: classref-method |void| **update_set_table_cell_position**\ (\ id\: :ref:`RID`, row_index\: :ref:`int`, column_index\: :ref:`int`\ ) :ref:`🔗` Sets cell position in the table. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_table_cell_span: .. rst-class:: classref-method |void| **update_set_table_cell_span**\ (\ id\: :ref:`RID`, row_span\: :ref:`int`, column_span\: :ref:`int`\ ) :ref:`🔗` Sets cell row/column span. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_table_column_count: .. rst-class:: classref-method |void| **update_set_table_column_count**\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) :ref:`🔗` Sets number of columns in the table. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_table_column_index: .. rst-class:: classref-method |void| **update_set_table_column_index**\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` Sets position of the column. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_table_row_count: .. rst-class:: classref-method |void| **update_set_table_row_count**\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) :ref:`🔗` Sets number of rows in the table. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_table_row_index: .. rst-class:: classref-method |void| **update_set_table_row_index**\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` Sets position of the row in the table. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_text_align: .. rst-class:: classref-method |void| **update_set_text_align**\ (\ id\: :ref:`RID`, align\: :ref:`HorizontalAlignment`\ ) :ref:`🔗` Sets element text alignment. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_text_decorations: .. rst-class:: classref-method |void| **update_set_text_decorations**\ (\ id\: :ref:`RID`, underline\: :ref:`bool`, strikethrough\: :ref:`bool`, overline\: :ref:`bool`, color\: :ref:`Color` = Color(0, 0, 0, 1)\ ) :ref:`🔗` Sets text underline/overline/strikethrough. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_text_orientation: .. rst-class:: classref-method |void| **update_set_text_orientation**\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) :ref:`🔗` Sets text orientation. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_text_selection: .. rst-class:: classref-method |void| **update_set_text_selection**\ (\ id\: :ref:`RID`, text_start_id\: :ref:`RID`, start_char\: :ref:`int`, text_end_id\: :ref:`RID`, end_char\: :ref:`int`\ ) :ref:`🔗` Sets text selection to the text field. ``text_start_id`` and ``text_end_id`` should be elements created by :ref:`create_sub_text_edit_elements()`. Character offsets are relative to the corresponding element. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_tooltip: .. rst-class:: classref-method |void| **update_set_tooltip**\ (\ id\: :ref:`RID`, tooltip\: :ref:`String`\ ) :ref:`🔗` Sets tooltip text. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_transform: .. rst-class:: classref-method |void| **update_set_transform**\ (\ id\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` Sets element 2D transform. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_url: .. rst-class:: classref-method |void| **update_set_url**\ (\ id\: :ref:`RID`, url\: :ref:`String`\ ) :ref:`🔗` Sets link URL. .. rst-class:: classref-item-separator ---- .. _class_AccessibilityServer_method_update_set_value: .. rst-class:: classref-method |void| **update_set_value**\ (\ id\: :ref:`RID`, value\: :ref:`String`\ ) :ref:`🔗` Sets element text value. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`