Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
AccessibilityServer
Наследует: Object
Серверный интерфейс для поддержки программ чтения с экрана.
Методы
Перечисления
enum AccessibilityRole: 🔗
AccessibilityRole ROLE_UNKNOWN = 0
Неизвестная или пользовательская роль.
AccessibilityRole ROLE_DEFAULT_BUTTON = 1
Элемент кнопки диалога по умолчанию.
AccessibilityRole ROLE_AUDIO = 2
Элемент аудиоплеера.
AccessibilityRole ROLE_VIDEO = 3
Элемент видеоплеера.
AccessibilityRole ROLE_STATIC_TEXT = 4
Нередактируемая текстовая метка.
AccessibilityRole ROLE_CONTAINER = 5
Элемент контейнера. Элементы с этой ролью используются для внутренней структуры и игнорируются программами чтения с экрана.
AccessibilityRole ROLE_PANEL = 6
Элемент панельного контейнера.
AccessibilityRole ROLE_BUTTON = 7
Элемент кнопки.
AccessibilityRole ROLE_LINK = 8
Элемент ссылки.
AccessibilityRole ROLE_CHECK_BOX = 9
Элемент флажка.
AccessibilityRole ROLE_RADIO_BUTTON = 10
Элемент радиокнопки.
AccessibilityRole ROLE_CHECK_BUTTON = 11
Элемент check кнопки.
AccessibilityRole ROLE_SCROLL_BAR = 12
Элемент полосы прокрутки.
AccessibilityRole ROLE_SCROLL_VIEW = 13
Элемент контейнера прокрутки.
AccessibilityRole ROLE_SPLITTER = 14
Элемент ручки разделителя контейнера.
AccessibilityRole ROLE_SLIDER = 15
Элемент слайдера.
AccessibilityRole ROLE_SPIN_BUTTON = 16
Элемент спин-бокса.
AccessibilityRole ROLE_PROGRESS_INDICATOR = 17
Элемент индикатора прогресса.
AccessibilityRole ROLE_TEXT_FIELD = 18
Редактируемый элемент текстового поля.
AccessibilityRole ROLE_MULTILINE_TEXT_FIELD = 19
Многострочный редактируемый элемент текстового поля.
AccessibilityRole ROLE_COLOR_PICKER = 20
Элемент выбора цвета.
AccessibilityRole ROLE_TABLE = 21
Элемент таблицы.
AccessibilityRole ROLE_CELL = 22
Элемент ячейки таблицы/дерева.
AccessibilityRole ROLE_ROW = 23
Элемент строки таблицы/дерева.
AccessibilityRole ROLE_ROW_GROUP = 24
Элемент группы строк таблицы/дерева.
AccessibilityRole ROLE_ROW_HEADER = 25
Элемент заголовка строки таблицы/дерева.
AccessibilityRole ROLE_COLUMN_HEADER = 26
Элемент заголовка столбца таблицы/дерева.
AccessibilityRole ROLE_TREE = 27
Элемент древовидной структуры (Tree view).
AccessibilityRole ROLE_TREE_ITEM = 28
Элемент древовидной структуры (Tree view item).
AccessibilityRole ROLE_LIST = 29
Элемент списка.
AccessibilityRole ROLE_LIST_ITEM = 30
Элемент списка Item.
AccessibilityRole ROLE_LIST_BOX = 31
Элемент представления списка.
AccessibilityRole ROLE_LIST_BOX_OPTION = 32
Элемент списка представлений Item.
AccessibilityRole ROLE_TAB_BAR = 33
Элемент панели вкладок Bar.
AccessibilityRole ROLE_TAB = 34
Элемент панели вкладок Item.
AccessibilityRole ROLE_TAB_PANEL = 35
Элемент панели вкладок.
Элемент строки меню.
Элемент всплывающего меню.
Элемент всплывающего меню Item.
Элемент кнопки проверки всплывающего меню.
Элемент переключателя всплывающего меню.
AccessibilityRole ROLE_IMAGE = 41
Элемент изображения.
AccessibilityRole ROLE_WINDOW = 42
Элемент окна.
AccessibilityRole ROLE_TITLE_BAR = 43
Встроенный элемент заголовка окна.
AccessibilityRole ROLE_DIALOG = 44
Элемент диалогового окна.
AccessibilityRole ROLE_TOOLTIP = 45
Элемент подсказки.
AccessibilityRole ROLE_REGION = 46
Региональный/ориентиральный элемент. Программы чтения с экрана могут перемещаться между регионами, используя навигацию по ориентирам.
AccessibilityRole ROLE_TEXT_RUN = 47
Unifor text run.
Примечание: Эта роль используется для внутренних текстовых элементов и не должна назначаться узлам.
enum AccessibilityPopupType: 🔗
Всплывающее меню.
AccessibilityPopupType POPUP_LIST = 1
Всплывающий список.
AccessibilityPopupType POPUP_TREE = 2
Всплывающее древовидное представление.
AccessibilityPopupType POPUP_DIALOG = 3
Всплывающий диалог.
enum AccessibilityFlags: 🔗
Элемент скрыт для инструментов специальных возможностей.
AccessibilityFlags FLAG_MULTISELECTABLE = 1
Элемент поддерживает выбор нескольких элементов.
AccessibilityFlags FLAG_REQUIRED = 2
Элемент требует ввода данных пользователем.
AccessibilityFlags FLAG_VISITED = 3
Элемент — посещенная ссылка.
AccessibilityFlags FLAG_BUSY = 4
Содержимое элемента не готово (например, загрузка).
AccessibilityFlags FLAG_MODAL = 5
Элемент представляет собой модальное окно.
AccessibilityFlags FLAG_TOUCH_PASSTHROUGH = 6
Элемент позволяет передавать касания, когда программа чтения с экрана находится в режиме сенсорного исследования.
AccessibilityFlags FLAG_READONLY = 7
Элемент представляет собой текстовое поле с выбираемым, но доступным только для чтения текстом.
AccessibilityFlags FLAG_DISABLED = 8
Элемент отключен.
AccessibilityFlags FLAG_CLIPS_CHILDREN = 9
Элемент обрезает потомков.
enum AccessibilityAction: 🔗
AccessibilityAction ACTION_CLICK = 0
Действие одинарного щелчка, аргумент обратного вызова не задан.
AccessibilityAction ACTION_FOCUS = 1
Действие фокуса, аргумент обратного вызова не задан.
AccessibilityAction ACTION_BLUR = 2
Действие размытия, аргумент обратного вызова не задан.
AccessibilityAction ACTION_COLLAPSE = 3
Свернуть действие, аргумент обратного вызова не задан.
AccessibilityAction ACTION_EXPAND = 4
Действие Развернуть, аргумент обратного вызова не задан.
AccessibilityAction ACTION_DECREMENT = 5
Действие уменьшения, аргумент обратного вызова не задан.
AccessibilityAction ACTION_INCREMENT = 6
Действие приращения/увеличения, аргумент обратного вызова не задан.
AccessibilityAction ACTION_HIDE_TOOLTIP = 7
Действие скрыть подсказки, аргумент обратного вызова не задан.
AccessibilityAction ACTION_SHOW_TOOLTIP = 8
Действие показать подсказки, аргумент обратного вызова не задан.
AccessibilityAction ACTION_SET_TEXT_SELECTION = 9
Установить действие выделения текста, аргумент обратного вызова установлен на Dictionary со следующими ключами:
"start_element"элемент доступности начала выделения."start_char"смещение символа относительно элемента доступности начала выделения."end_element"элемент доступности конца выделения."end_char"смещение символа относительно элемента доступности конца выделения.
AccessibilityAction ACTION_REPLACE_SELECTED_TEXT = 10
Действие «Заменить текст», аргументу обратного вызова присваивается значение String с заменяющим текстом.
AccessibilityAction ACTION_SCROLL_BACKWARD = 11
Действие прокрутки назад, аргумент обратного вызова не задан.
AccessibilityAction ACTION_SCROLL_DOWN = 12
Действие прокрутки вниз, аргументу обратного вызова присваивается значение AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_FORWARD = 13
Действие прокрутки вперед, аргумент обратного вызова не задан.
AccessibilityAction ACTION_SCROLL_LEFT = 14
Действие прокрутки влево, аргументу обратного вызова присвоено значение AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_RIGHT = 15
Действие прокрутки вправо, аргументу обратного вызова присвоено значение AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_UP = 16
Действие прокрутки вверх, аргумент обратного вызова установлен на AccessibilityScrollUnit.
AccessibilityAction ACTION_SCROLL_INTO_VIEW = 17
Прокрутка в действие представления, аргументу обратного вызова присвоено значение AccessibilityScrollHint.
AccessibilityAction ACTION_SCROLL_TO_POINT = 18
Прокрутите до действия, аргумент обратного вызова устанавливается на Vector2 с относительными координатами точек.
AccessibilityAction ACTION_SET_SCROLL_OFFSET = 19
Задайте действие смещения прокрутки, аргументу обратного вызова присваивается значение Vector2 со смещением прокрутки.
AccessibilityAction ACTION_SET_VALUE = 20
Действие «Установить значение», аргументу обратного вызова присваивается значение String или число с новым значением.
Действие показать контекстного меню, аргумент обратного вызова не задан.
AccessibilityAction ACTION_CUSTOM = 22
Пользовательское действие, аргумент обратного вызова задается равным целочисленному идентификатору действия.
enum AccessibilityLiveMode: 🔗
AccessibilityLiveMode LIVE_OFF = 0
Указывает, что обновления для текущего региона не должны отображаться.
AccessibilityLiveMode LIVE_POLITE = 1
Указывает, что обновления активной области должны быть представлены при следующей возможности (например, в конце произнесения текущего предложения).
AccessibilityLiveMode LIVE_ASSERTIVE = 2
Указывает, что обновления в активном регионе имеют наивысший приоритет и должны быть представлены немедленно.
enum AccessibilityScrollUnit: 🔗
AccessibilityScrollUnit SCROLL_UNIT_ITEM = 0
Величина прокрутки. Отдельный элемент списка, строка текста.
AccessibilityScrollUnit SCROLL_UNIT_PAGE = 1
Величина прокрутки. Одна страница.
enum AccessibilityScrollHint: 🔗
AccessibilityScrollHint SCROLL_HINT_TOP_LEFT = 0
Предпочтительное положение прокручиваемого узла. Верхний левый край контейнера прокрутки.
AccessibilityScrollHint SCROLL_HINT_BOTTOM_RIGHT = 1
Предпочтительное положение прокручиваемого узла. Нижний правый край контейнера прокрутки.
AccessibilityScrollHint SCROLL_HINT_TOP_EDGE = 2
Предпочтительное положение прокручиваемого узла. Верхний край контейнера прокрутки.
AccessibilityScrollHint SCROLL_HINT_BOTTOM_EDGE = 3
Предпочтительное положение прокручиваемого узла. Нижний край контейнера прокрутки.
AccessibilityScrollHint SCROLL_HINT_LEFT_EDGE = 4
Предпочтительное положение прокручиваемого узла. Левый край контейнера прокрутки.
AccessibilityScrollHint SCROLL_HINT_RIGHT_EDGE = 5
Предпочтительное положение прокручиваемого узла. Правый край контейнера прокрутки.
Описания метода
RID create_element(window_id: int, role: AccessibilityRole) 🔗
Создает новый, пустой ресурс элемента доступности.
Примечание: Элемент доступности создается и освобождается автоматически для каждого Node. В общем случае эту функцию не следует вызывать вручную.
RID create_sub_element(parent_rid: RID, role: AccessibilityRole, insert_pos: int = -1) 🔗
Создает новый пустой ресурс подэлемента доступности. Подэлементы могут использоваться для предоставления информации о доступности для объектов, которые не являются Node, таких как элементы списков, ячейки таблиц или пункты меню. Подэлементы автоматически освобождаются при освобождении родительского элемента или могут быть освобождены досрочно с помощью метода free_element().
RID create_sub_text_edit_elements(parent_rid: RID, shaped_text: RID, min_height: float, insert_pos: int = -1, is_last_line: bool = false) 🔗
Создает новый пустой подэлемент доступности из буфера текста определенной формы. Подэлементы освобождаются автоматически при освобождении родительского элемента или могут быть освобождены досрочно с помощью метода free_element().
Если is_last_line имеет значение true, к содержимому текста не добавляется завершающая новая строка. Установите значение true для последней строки в многострочных текстовых полях и для однострочных текстовых полей.
Variant element_get_meta(id: RID) const 🔗
Возвращает метаданные элемента доступности id.
void element_set_meta(id: RID, meta: Variant) 🔗
Устанавливает метаданные элемента доступности id равными meta.
Освобождает элемент доступности id, созданный методами create_element(), create_sub_element() или create_sub_text_edit_elements().
RID get_window_root(window_id: int) const 🔗
Возвращает основной элемент доступности собственного окна ОС.
bool has_element(id: RID) const 🔗
Возвращает true, если id является допустимым элементом доступности.
Возвращает true, если данная реализация поддерживает программу чтения с экрана.
void set_window_focused(window_id: int, focused: bool) 🔗
Устанавливает состояние фокуса окна для вспомогательных приложений.
Примечание: Этот метод реализован в Linux, macOS и Windows.
Примечание: Только для опытных пользователей! Объекты Window вызывают этот метод автоматически.
void set_window_rect(window_id: int, rect_out: Rect2, rect_in: Rect2) 🔗
Устанавливает внешние (с украшениями) и внутренние (без украшений) границы окна для вспомогательных приложений.
Примечание: Этот метод реализован в Linux, macOS и Windows.
Примечание: Только для опытных пользователей! Объекты Window вызывают этот метод автоматически.
void update_add_action(id: RID, action: AccessibilityAction, callable: Callable) 🔗
Добавляет обратный вызов для действия доступности (действие, которое может быть выполнено с помощью специальной команды экранного диктора или кнопок на дисплее Брайля) и отмечает это действие как поддерживаемое. Обратный вызов действия получает один аргумент Variant, значение которого зависит от типа действия.
void update_add_child(id: RID, child_id: RID) 🔗
Добавляет дочерний элемент доступности.
Примечание: Дочерние и подэлементы Node добавляются в список дочерних элементов автоматически.
void update_add_custom_action(id: RID, action_id: int, action_description: String) 🔗
Добавляет поддержку для настраиваемого действия специальных возможностей. action_id передается как аргумент обратному вызову действия ACTION_CUSTOM.
Добавляет элемент, который контролируется данным элементом.
Добавляет элемент, описывающий этот элемент.
Добавляет элемент, детализирующий этот элемент.
Добавляет элемент, в который вливается данный элемент.
Добавляет элемент, маркирующий этот элемент.
Добавляет элемент, который является частью той же радиогруппы.
Примечание: Этот метод следует вызывать для каждого элемента группы, используя все остальные элементы как related_id.
void update_set_active_descendant(id: RID, other_id: RID) 🔗
Добавляет элемент, который является активным потомком данного элемента.
void update_set_background_color(id: RID, color: Color) 🔗
Устанавливает цвет фона элемента.
void update_set_bounds(id: RID, rect: Rect2) 🔗
Устанавливает ограничивающую рамку элемента относительно положения узла.
void update_set_braille_label(id: RID, name: String) 🔗
Устанавливает метку доступности элемента для брайлевского дисплея.
void update_set_braille_role_description(id: RID, description: String) 🔗
Задает описание роли доступности элемента для дисплея Брайля.
void update_set_checked(id: RID, checekd: bool) 🔗
Устанавливает состояние проверки элемента.
void update_set_classname(id: RID, classname: String) 🔗
Задает имя класса элемента.
void update_set_color_value(id: RID, color: Color) 🔗
Устанавливает значение цвета элемента.
void update_set_description(id: RID, description: String) 🔗
Устанавливает описание доступности элемента.
void update_set_error_message(id: RID, other_id: RID) 🔗
Устанавливает элемент, содержащий сообщение об ошибке для этого элемента.
void update_set_extra_info(id: RID, name: String) 🔗
Устанавливает дополнительную информацию о доступности элемента, добавляемую к имени элемента.
void update_set_flag(id: RID, flag: AccessibilityFlags, value: bool) 🔗
Устанавливает флаг элемента.
void update_set_focus(id: RID) 🔗
Устанавливает текущий элемент, находящийся в фокусе.
void update_set_foreground_color(id: RID, color: Color) 🔗
Устанавливает цвет переднего плана элемента.
void update_set_in_page_link_target(id: RID, other_id: RID) 🔗
Устанавливает цель элемента для ссылки.
void update_set_language(id: RID, language: String) 🔗
Устанавливает язык текста элемента.
void update_set_list_item_count(id: RID, size: int) 🔗
Устанавливает количество элементов в списке.
void update_set_list_item_expanded(id: RID, expanded: bool) 🔗
Устанавливает развернутый статус элемента списка/дерева.
void update_set_list_item_index(id: RID, index: int) 🔗
Устанавливает позицию элемента в списке.
void update_set_list_item_level(id: RID, level: int) 🔗
Устанавливает иерархический уровень элемента в списке.
void update_set_list_item_selected(id: RID, selected: bool) 🔗
Устанавливает статус выбранного элемента списка/дерева.
void update_set_list_orientation(id: RID, vertical: bool) 🔗
Задает ориентацию элементов списка.
void update_set_live(id: RID, live: AccessibilityLiveMode) 🔗
Устанавливает приоритет обновлений региона в реальном времени.
void update_set_member_of(id: RID, group_id: RID) 🔗
Устанавливает элемент как член группы.
void update_set_name(id: RID, name: String) 🔗
Устанавливает имя доступности элемента.
void update_set_next_on_line(id: RID, other_id: RID) 🔗
Устанавливает следующий элемент в строке.
void update_set_num_jump(id: RID, jump: float) 🔗
Устанавливает скачок числового значения.
void update_set_num_range(id: RID, min: float, max: float) 🔗
Устанавливает диапазон числовых значений.
void update_set_num_step(id: RID, step: float) 🔗
Устанавливает шаг числового значения.
void update_set_num_value(id: RID, position: float) 🔗
Устанавливает числовое значение.
void update_set_placeholder(id: RID, placeholder: String) 🔗
Устанавливает текст-заполнитель.
void update_set_popup_type(id: RID, popup: AccessibilityPopupType) 🔗
Устанавливает тип всплывающего окна для всплывающих кнопок.
void update_set_previous_on_line(id: RID, other_id: RID) 🔗
Устанавливает предыдущий элемент в строке.
void update_set_role(id: RID, role: AccessibilityRole) 🔗
Устанавливает роль доступности элемента.
void update_set_role_description(id: RID, description: String) 🔗
Устанавливает текст описания роли доступности элемента.
void update_set_scroll_x(id: RID, position: float) 🔗
Устанавливает положение полосы прокрутки по оси x.
void update_set_scroll_x_range(id: RID, min: float, max: float) 🔗
Устанавливает диапазон полосы прокрутки x.
void update_set_scroll_y(id: RID, position: float) 🔗
Устанавливает положение полосы прокрутки по оси Y.
void update_set_scroll_y_range(id: RID, min: float, max: float) 🔗
Устанавливает диапазон прокрутки по оси Y.
void update_set_shortcut(id: RID, shortcut: String) 🔗
Задает список сочетаний клавиш, используемых элементом.
void update_set_state_description(id: RID, description: String) 🔗
Устанавливает понятное человеку описание текущего отмеченного состояния.
void update_set_table_cell_position(id: RID, row_index: int, column_index: int) 🔗
Устанавливает положение ячейки в таблице.
void update_set_table_cell_span(id: RID, row_span: int, column_span: int) 🔗
Устанавливает диапазон строк/столбцов ячеек.
void update_set_table_column_count(id: RID, count: int) 🔗
Задает количество столбцов в таблице.
void update_set_table_column_index(id: RID, index: int) 🔗
Устанавливает положение столбца.
void update_set_table_row_count(id: RID, count: int) 🔗
Устанавливает количество строк в таблице.
void update_set_table_row_index(id: RID, index: int) 🔗
Устанавливает положение строки в таблице.
void update_set_text_align(id: RID, align: HorizontalAlignment) 🔗
Устанавливает выравнивание текста элемента.
void update_set_text_decorations(id: RID, underline: bool, strikethrough: bool, overline: bool, color: Color = Color(0, 0, 0, 1)) 🔗
Устанавливает подчеркивание/надчеркивание/зачеркивание текста.
void update_set_text_orientation(id: RID, vertical: bool) 🔗
Устанавливает ориентацию текста.
void update_set_text_selection(id: RID, text_start_id: RID, start_char: int, text_end_id: RID, end_char: int) 🔗
Устанавливает выделение текста в текстовом поле. text_start_id и text_end_id должны быть элементами, созданными методом create_sub_text_edit_elements(). Смещения символов указываются относительно соответствующего элемента.
void update_set_tooltip(id: RID, tooltip: String) 🔗
Устанавливает текст подсказки.
void update_set_transform(id: RID, transform: Transform2D) 🔗
Устанавливает 2D-преобразование элемента.
void update_set_url(id: RID, url: String) 🔗
Устанавливает URL-адрес ссылки.
void update_set_value(id: RID, value: String) 🔗
Устанавливает текстовое значение элемента.