Merge pull request #76829 from bruvzg/ac_kit_direct
Implement screen reader support using AccessKit library.
This commit is contained in:
Thaddeus Crews
commit
e6a61b1ecc
305 changed files with 32447 additions and 300 deletions
|
|
@ -39,6 +39,7 @@
|
|||
#include "display/native_menu.h"
|
||||
|
||||
class Texture2D;
|
||||
class AccessibilityDriver;
|
||||
|
||||
class DisplayServer : public Object {
|
||||
GDCLASS(DisplayServer, Object)
|
||||
|
|
@ -167,6 +168,7 @@ public:
|
|||
FEATURE_EMOJI_AND_SYMBOL_PICKER,
|
||||
FEATURE_NATIVE_COLOR_PICKER,
|
||||
FEATURE_SELF_FITTING_WINDOWS,
|
||||
FEATURE_ACCESSIBILITY_SCREEN_READER,
|
||||
};
|
||||
|
||||
virtual bool has_feature(Feature p_feature) const = 0;
|
||||
|
|
@ -536,6 +538,209 @@ public:
|
|||
|
||||
virtual void window_start_resize(WindowResizeEdge p_edge, WindowID p_window = MAIN_WINDOW_ID) {}
|
||||
|
||||
// Accessibility.
|
||||
|
||||
enum AccessibilityMode {
|
||||
ACCESSIBILITY_AUTO,
|
||||
ACCESSIBILITY_ALWAYS,
|
||||
ACCESSIBILITY_DISABLED,
|
||||
};
|
||||
|
||||
protected:
|
||||
AccessibilityDriver *accessibility_driver = nullptr;
|
||||
static AccessibilityMode accessibility_mode;
|
||||
|
||||
public:
|
||||
enum AccessibilityRole {
|
||||
ROLE_UNKNOWN,
|
||||
ROLE_DEFAULT_BUTTON,
|
||||
ROLE_AUDIO,
|
||||
ROLE_VIDEO,
|
||||
ROLE_STATIC_TEXT,
|
||||
ROLE_CONTAINER,
|
||||
ROLE_PANEL,
|
||||
ROLE_BUTTON,
|
||||
ROLE_LINK,
|
||||
ROLE_CHECK_BOX,
|
||||
ROLE_RADIO_BUTTON,
|
||||
ROLE_CHECK_BUTTON,
|
||||
ROLE_SCROLL_BAR,
|
||||
ROLE_SCROLL_VIEW,
|
||||
ROLE_SPLITTER,
|
||||
ROLE_SLIDER,
|
||||
ROLE_SPIN_BUTTON,
|
||||
ROLE_PROGRESS_INDICATOR,
|
||||
ROLE_TEXT_FIELD,
|
||||
ROLE_MULTILINE_TEXT_FIELD,
|
||||
ROLE_COLOR_PICKER,
|
||||
ROLE_TABLE,
|
||||
ROLE_CELL,
|
||||
ROLE_ROW,
|
||||
ROLE_ROW_GROUP,
|
||||
ROLE_ROW_HEADER,
|
||||
ROLE_COLUMN_HEADER,
|
||||
ROLE_TREE,
|
||||
ROLE_TREE_ITEM,
|
||||
ROLE_LIST,
|
||||
ROLE_LIST_ITEM,
|
||||
ROLE_LIST_BOX,
|
||||
ROLE_LIST_BOX_OPTION,
|
||||
ROLE_TAB_BAR,
|
||||
ROLE_TAB,
|
||||
ROLE_TAB_PANEL,
|
||||
ROLE_MENU_BAR,
|
||||
ROLE_MENU,
|
||||
ROLE_MENU_ITEM,
|
||||
ROLE_MENU_ITEM_CHECK_BOX,
|
||||
ROLE_MENU_ITEM_RADIO,
|
||||
ROLE_IMAGE,
|
||||
ROLE_WINDOW,
|
||||
ROLE_TITLE_BAR,
|
||||
ROLE_DIALOG,
|
||||
ROLE_TOOLTIP,
|
||||
};
|
||||
|
||||
enum AccessibilityPopupType {
|
||||
POPUP_UNKNOWN,
|
||||
POPUP_MENU,
|
||||
POPUP_LIST,
|
||||
POPUP_TREE,
|
||||
POPUP_DIALOG,
|
||||
};
|
||||
|
||||
enum AccessibilityFlags {
|
||||
FLAG_HIDDEN,
|
||||
FLAG_LINKED,
|
||||
FLAG_MULTISELECTABLE,
|
||||
FLAG_REQUIRED,
|
||||
FLAG_VISITED,
|
||||
FLAG_BUSY,
|
||||
FLAG_MODAL,
|
||||
FLAG_TOUCH_PASSTHROUGH,
|
||||
FLAG_READONLY,
|
||||
FLAG_DISABLED,
|
||||
FLAG_CLIPS_CHILDREN,
|
||||
};
|
||||
|
||||
enum AccessibilityAction {
|
||||
ACTION_CLICK,
|
||||
ACTION_FOCUS,
|
||||
ACTION_BLUR,
|
||||
ACTION_COLLAPSE,
|
||||
ACTION_EXPAND,
|
||||
ACTION_DECREMENT,
|
||||
ACTION_INCREMENT,
|
||||
ACTION_HIDE_TOOLTIP,
|
||||
ACTION_SHOW_TOOLTIP,
|
||||
ACTION_SET_TEXT_SELECTION,
|
||||
ACTION_REPLACE_SELECTED_TEXT,
|
||||
ACTION_SCROLL_BACKWARD,
|
||||
ACTION_SCROLL_DOWN,
|
||||
ACTION_SCROLL_FORWARD,
|
||||
ACTION_SCROLL_LEFT,
|
||||
ACTION_SCROLL_RIGHT,
|
||||
ACTION_SCROLL_UP,
|
||||
ACTION_SCROLL_INTO_VIEW,
|
||||
ACTION_SCROLL_TO_POINT,
|
||||
ACTION_SET_SCROLL_OFFSET,
|
||||
ACTION_SET_VALUE,
|
||||
ACTION_SHOW_CONTEXT_MENU,
|
||||
ACTION_CUSTOM,
|
||||
};
|
||||
|
||||
enum AccessibilityLiveMode {
|
||||
LIVE_OFF,
|
||||
LIVE_POLITE,
|
||||
LIVE_ASSERTIVE,
|
||||
};
|
||||
|
||||
static AccessibilityMode accessibility_get_mode() { return accessibility_mode; }
|
||||
static void accessibility_set_mode(AccessibilityMode p_mode) { accessibility_mode = p_mode; }
|
||||
|
||||
virtual int accessibility_should_increase_contrast() const { return -1; }
|
||||
virtual int accessibility_should_reduce_animation() const { return -1; }
|
||||
virtual int accessibility_should_reduce_transparency() const { return -1; }
|
||||
virtual int accessibility_screen_reader_active() const { return -1; }
|
||||
|
||||
virtual RID accessibility_create_element(WindowID p_window_id, DisplayServer::AccessibilityRole p_role);
|
||||
virtual RID accessibility_create_sub_element(const RID &p_parent_rid, DisplayServer::AccessibilityRole p_role, int p_insert_pos = -1);
|
||||
virtual RID accessibility_create_sub_text_edit_elements(const RID &p_parent_rid, const RID &p_shaped_text, float p_min_height, int p_insert_pos = -1);
|
||||
virtual bool accessibility_has_element(const RID &p_id) const;
|
||||
virtual void accessibility_free_element(const RID &p_id);
|
||||
|
||||
virtual void accessibility_element_set_meta(const RID &p_id, const Variant &p_meta);
|
||||
virtual Variant accessibility_element_get_meta(const RID &p_id) const;
|
||||
|
||||
virtual void accessibility_update_if_active(const Callable &p_callable);
|
||||
|
||||
virtual void accessibility_update_set_focus(const RID &p_id);
|
||||
virtual RID accessibility_get_window_root(DisplayServer::WindowID p_window_id) const;
|
||||
|
||||
virtual void accessibility_set_window_rect(DisplayServer::WindowID p_window_id, const Rect2 &p_rect_out, const Rect2 &p_rect_in);
|
||||
virtual void accessibility_set_window_focused(DisplayServer::WindowID p_window_id, bool p_focused);
|
||||
|
||||
virtual void accessibility_update_set_role(const RID &p_id, DisplayServer::AccessibilityRole p_role);
|
||||
virtual void accessibility_update_set_name(const RID &p_id, const String &p_name);
|
||||
virtual void accessibility_update_set_extra_info(const RID &p_id, const String &p_name_extra_info);
|
||||
virtual void accessibility_update_set_description(const RID &p_id, const String &p_description);
|
||||
virtual void accessibility_update_set_value(const RID &p_id, const String &p_value);
|
||||
virtual void accessibility_update_set_tooltip(const RID &p_id, const String &p_tooltip);
|
||||
virtual void accessibility_update_set_bounds(const RID &p_id, const Rect2 &p_rect);
|
||||
virtual void accessibility_update_set_transform(const RID &p_id, const Transform2D &p_transform);
|
||||
virtual void accessibility_update_add_child(const RID &p_id, const RID &p_child_id);
|
||||
virtual void accessibility_update_add_related_controls(const RID &p_id, const RID &p_related_id);
|
||||
virtual void accessibility_update_add_related_details(const RID &p_id, const RID &p_related_id);
|
||||
virtual void accessibility_update_add_related_described_by(const RID &p_id, const RID &p_related_id);
|
||||
virtual void accessibility_update_add_related_flow_to(const RID &p_id, const RID &p_related_id);
|
||||
virtual void accessibility_update_add_related_labeled_by(const RID &p_id, const RID &p_related_id);
|
||||
virtual void accessibility_update_add_related_radio_group(const RID &p_id, const RID &p_related_id);
|
||||
virtual void accessibility_update_set_active_descendant(const RID &p_id, const RID &p_other_id);
|
||||
virtual void accessibility_update_set_next_on_line(const RID &p_id, const RID &p_other_id);
|
||||
virtual void accessibility_update_set_previous_on_line(const RID &p_id, const RID &p_other_id);
|
||||
virtual void accessibility_update_set_member_of(const RID &p_id, const RID &p_group_id);
|
||||
virtual void accessibility_update_set_in_page_link_target(const RID &p_id, const RID &p_other_id);
|
||||
virtual void accessibility_update_set_error_message(const RID &p_id, const RID &p_other_id);
|
||||
virtual void accessibility_update_set_live(const RID &p_id, DisplayServer::AccessibilityLiveMode p_live);
|
||||
virtual void accessibility_update_add_action(const RID &p_id, DisplayServer::AccessibilityAction p_action, const Callable &p_callable);
|
||||
virtual void accessibility_update_add_custom_action(const RID &p_id, int p_action_id, const String &p_action_description);
|
||||
virtual void accessibility_update_set_table_row_count(const RID &p_id, int p_count);
|
||||
virtual void accessibility_update_set_table_column_count(const RID &p_id, int p_count);
|
||||
virtual void accessibility_update_set_table_row_index(const RID &p_id, int p_index);
|
||||
virtual void accessibility_update_set_table_column_index(const RID &p_id, int p_index);
|
||||
virtual void accessibility_update_set_table_cell_position(const RID &p_id, int p_row_index, int p_column_index);
|
||||
virtual void accessibility_update_set_table_cell_span(const RID &p_id, int p_row_span, int p_column_span);
|
||||
virtual void accessibility_update_set_list_item_count(const RID &p_id, int p_size);
|
||||
virtual void accessibility_update_set_list_item_index(const RID &p_id, int p_index);
|
||||
virtual void accessibility_update_set_list_item_level(const RID &p_id, int p_level);
|
||||
virtual void accessibility_update_set_list_item_selected(const RID &p_id, bool p_selected);
|
||||
virtual void accessibility_update_set_list_item_expanded(const RID &p_id, bool p_expanded);
|
||||
virtual void accessibility_update_set_popup_type(const RID &p_id, DisplayServer::AccessibilityPopupType p_popup);
|
||||
virtual void accessibility_update_set_checked(const RID &p_id, bool p_checekd);
|
||||
virtual void accessibility_update_set_num_value(const RID &p_id, double p_position);
|
||||
virtual void accessibility_update_set_num_range(const RID &p_id, double p_min, double p_max);
|
||||
virtual void accessibility_update_set_num_step(const RID &p_id, double p_step);
|
||||
virtual void accessibility_update_set_num_jump(const RID &p_id, double p_jump);
|
||||
virtual void accessibility_update_set_scroll_x(const RID &p_id, double p_position);
|
||||
virtual void accessibility_update_set_scroll_x_range(const RID &p_id, double p_min, double p_max);
|
||||
virtual void accessibility_update_set_scroll_y(const RID &p_id, double p_position);
|
||||
virtual void accessibility_update_set_scroll_y_range(const RID &p_id, double p_min, double p_max);
|
||||
virtual void accessibility_update_set_text_decorations(const RID &p_id, bool p_underline, bool p_strikethrough, bool p_overline);
|
||||
virtual void accessibility_update_set_text_align(const RID &p_id, HorizontalAlignment p_align);
|
||||
virtual void accessibility_update_set_text_selection(const RID &p_id, const RID &p_text_start_id, int p_start_char, const RID &p_text_end_id, int p_end_char);
|
||||
virtual void accessibility_update_set_flag(const RID &p_id, DisplayServer::AccessibilityFlags p_flag, bool p_value);
|
||||
virtual void accessibility_update_set_classname(const RID &p_id, const String &p_classname);
|
||||
virtual void accessibility_update_set_placeholder(const RID &p_id, const String &p_placeholder);
|
||||
virtual void accessibility_update_set_language(const RID &p_id, const String &p_language);
|
||||
virtual void accessibility_update_set_text_orientation(const RID &p_id, bool p_vertical);
|
||||
virtual void accessibility_update_set_list_orientation(const RID &p_id, bool p_vertical);
|
||||
virtual void accessibility_update_set_shortcut(const RID &p_id, const String &p_shortcut);
|
||||
virtual void accessibility_update_set_url(const RID &p_id, const String &p_url);
|
||||
virtual void accessibility_update_set_role_description(const RID &p_id, const String &p_description);
|
||||
virtual void accessibility_update_set_state_description(const RID &p_id, const String &p_description);
|
||||
virtual void accessibility_update_set_color_value(const RID &p_id, const Color &p_color);
|
||||
virtual void accessibility_update_set_background_color(const RID &p_id, const Color &p_color);
|
||||
virtual void accessibility_update_set_foreground_color(const RID &p_id, const Color &p_color);
|
||||
|
||||
// necessary for GL focus, may be able to use one of the existing functions for this, not sure yet
|
||||
virtual void gl_window_make_current(DisplayServer::WindowID p_window_id);
|
||||
|
||||
|
|
@ -680,6 +885,104 @@ public:
|
|||
~DisplayServer();
|
||||
};
|
||||
|
||||
/**************************************************************************/
|
||||
|
||||
class AccessibilityDriver {
|
||||
public:
|
||||
virtual Error init() = 0;
|
||||
|
||||
virtual bool window_create(DisplayServer::WindowID p_window_id, void *p_handle) = 0;
|
||||
virtual void window_destroy(DisplayServer::WindowID p_window_id) = 0;
|
||||
|
||||
virtual RID accessibility_create_element(DisplayServer::WindowID p_window_id, DisplayServer::AccessibilityRole p_role) = 0;
|
||||
virtual RID accessibility_create_sub_element(const RID &p_parent_rid, DisplayServer::AccessibilityRole p_role, int p_insert_pos = -1) = 0;
|
||||
virtual RID accessibility_create_sub_text_edit_elements(const RID &p_parent_rid, const RID &p_shaped_text, float p_min_height, int p_insert_pos = -1) = 0;
|
||||
virtual bool accessibility_has_element(const RID &p_id) const = 0;
|
||||
virtual void accessibility_free_element(const RID &p_id) = 0;
|
||||
|
||||
virtual void accessibility_element_set_meta(const RID &p_id, const Variant &p_meta) = 0;
|
||||
virtual Variant accessibility_element_get_meta(const RID &p_id) const = 0;
|
||||
|
||||
virtual void accessibility_update_if_active(const Callable &p_callable) = 0;
|
||||
|
||||
virtual RID accessibility_get_window_root(DisplayServer::WindowID p_window_id) const = 0;
|
||||
virtual void accessibility_update_set_focus(const RID &p_id) = 0;
|
||||
|
||||
virtual void accessibility_set_window_rect(DisplayServer::WindowID p_window_id, const Rect2 &p_rect_out, const Rect2 &p_rect_in) = 0;
|
||||
virtual void accessibility_set_window_focused(DisplayServer::WindowID p_window_id, bool p_focused) = 0;
|
||||
|
||||
virtual void accessibility_update_set_role(const RID &p_id, DisplayServer::AccessibilityRole p_role) = 0;
|
||||
virtual void accessibility_update_set_name(const RID &p_id, const String &p_name) = 0;
|
||||
virtual void accessibility_update_set_extra_info(const RID &p_id, const String &p_name_extra_info) = 0;
|
||||
virtual void accessibility_update_set_description(const RID &p_id, const String &p_description) = 0;
|
||||
virtual void accessibility_update_set_value(const RID &p_id, const String &p_value) = 0;
|
||||
virtual void accessibility_update_set_tooltip(const RID &p_id, const String &p_tooltip) = 0;
|
||||
virtual void accessibility_update_set_bounds(const RID &p_id, const Rect2 &p_rect) = 0;
|
||||
virtual void accessibility_update_set_transform(const RID &p_id, const Transform2D &p_transform) = 0;
|
||||
virtual void accessibility_update_add_child(const RID &p_id, const RID &p_child_id) = 0;
|
||||
virtual void accessibility_update_add_related_controls(const RID &p_id, const RID &p_related_id) = 0;
|
||||
virtual void accessibility_update_add_related_details(const RID &p_id, const RID &p_related_id) = 0;
|
||||
virtual void accessibility_update_add_related_described_by(const RID &p_id, const RID &p_related_id) = 0;
|
||||
virtual void accessibility_update_add_related_flow_to(const RID &p_id, const RID &p_related_id) = 0;
|
||||
virtual void accessibility_update_add_related_labeled_by(const RID &p_id, const RID &p_related_id) = 0;
|
||||
virtual void accessibility_update_add_related_radio_group(const RID &p_id, const RID &p_related_id) = 0;
|
||||
virtual void accessibility_update_set_active_descendant(const RID &p_id, const RID &p_other_id) = 0;
|
||||
virtual void accessibility_update_set_next_on_line(const RID &p_id, const RID &p_other_id) = 0;
|
||||
virtual void accessibility_update_set_previous_on_line(const RID &p_id, const RID &p_other_id) = 0;
|
||||
virtual void accessibility_update_set_member_of(const RID &p_id, const RID &p_group_id) = 0;
|
||||
virtual void accessibility_update_set_in_page_link_target(const RID &p_id, const RID &p_other_id) = 0;
|
||||
virtual void accessibility_update_set_error_message(const RID &p_id, const RID &p_other_id) = 0;
|
||||
virtual void accessibility_update_set_live(const RID &p_id, DisplayServer::AccessibilityLiveMode p_live) = 0;
|
||||
virtual void accessibility_update_add_action(const RID &p_id, DisplayServer::AccessibilityAction p_action, const Callable &p_callable) = 0;
|
||||
virtual void accessibility_update_add_custom_action(const RID &p_id, int p_action_id, const String &p_action_description) = 0;
|
||||
virtual void accessibility_update_set_table_row_count(const RID &p_id, int p_count) = 0;
|
||||
virtual void accessibility_update_set_table_column_count(const RID &p_id, int p_count) = 0;
|
||||
virtual void accessibility_update_set_table_row_index(const RID &p_id, int p_index) = 0;
|
||||
virtual void accessibility_update_set_table_column_index(const RID &p_id, int p_index) = 0;
|
||||
virtual void accessibility_update_set_table_cell_position(const RID &p_id, int p_row_index, int p_column_index) = 0;
|
||||
virtual void accessibility_update_set_table_cell_span(const RID &p_id, int p_row_span, int p_column_span) = 0;
|
||||
virtual void accessibility_update_set_list_item_count(const RID &p_id, int p_size) = 0;
|
||||
virtual void accessibility_update_set_list_item_index(const RID &p_id, int p_index) = 0;
|
||||
virtual void accessibility_update_set_list_item_level(const RID &p_id, int p_level) = 0;
|
||||
virtual void accessibility_update_set_list_item_selected(const RID &p_id, bool p_selected) = 0;
|
||||
virtual void accessibility_update_set_list_item_expanded(const RID &p_id, bool p_expanded) = 0;
|
||||
virtual void accessibility_update_set_popup_type(const RID &p_id, DisplayServer::AccessibilityPopupType p_popup) = 0;
|
||||
virtual void accessibility_update_set_checked(const RID &p_id, bool p_checekd) = 0;
|
||||
virtual void accessibility_update_set_num_value(const RID &p_id, double p_position) = 0;
|
||||
virtual void accessibility_update_set_num_range(const RID &p_id, double p_min, double p_max) = 0;
|
||||
virtual void accessibility_update_set_num_step(const RID &p_id, double p_step) = 0;
|
||||
virtual void accessibility_update_set_num_jump(const RID &p_id, double p_jump) = 0;
|
||||
virtual void accessibility_update_set_scroll_x(const RID &p_id, double p_position) = 0;
|
||||
virtual void accessibility_update_set_scroll_x_range(const RID &p_id, double p_min, double p_max) = 0;
|
||||
virtual void accessibility_update_set_scroll_y(const RID &p_id, double p_position) = 0;
|
||||
virtual void accessibility_update_set_scroll_y_range(const RID &p_id, double p_min, double p_max) = 0;
|
||||
virtual void accessibility_update_set_text_decorations(const RID &p_id, bool p_underline, bool p_strikethrough, bool p_overline) = 0;
|
||||
virtual void accessibility_update_set_text_align(const RID &p_id, HorizontalAlignment p_align) = 0;
|
||||
virtual void accessibility_update_set_text_selection(const RID &p_id, const RID &p_text_start_id, int p_start_char, const RID &p_text_end_id, int p_end_char) = 0;
|
||||
virtual void accessibility_update_set_flag(const RID &p_id, DisplayServer::AccessibilityFlags p_flag, bool p_value) = 0;
|
||||
virtual void accessibility_update_set_classname(const RID &p_id, const String &p_classname) = 0;
|
||||
virtual void accessibility_update_set_placeholder(const RID &p_id, const String &p_placeholder) = 0;
|
||||
virtual void accessibility_update_set_language(const RID &p_id, const String &p_language) = 0;
|
||||
virtual void accessibility_update_set_text_orientation(const RID &p_id, bool p_vertical) = 0;
|
||||
virtual void accessibility_update_set_list_orientation(const RID &p_id, bool p_vertical) = 0;
|
||||
virtual void accessibility_update_set_shortcut(const RID &p_id, const String &p_shortcut) = 0;
|
||||
virtual void accessibility_update_set_url(const RID &p_id, const String &p_url) = 0;
|
||||
virtual void accessibility_update_set_role_description(const RID &p_id, const String &p_description) = 0;
|
||||
virtual void accessibility_update_set_state_description(const RID &p_id, const String &p_description) = 0;
|
||||
virtual void accessibility_update_set_color_value(const RID &p_id, const Color &p_color) = 0;
|
||||
virtual void accessibility_update_set_background_color(const RID &p_id, const Color &p_color) = 0;
|
||||
virtual void accessibility_update_set_foreground_color(const RID &p_id, const Color &p_color) = 0;
|
||||
|
||||
AccessibilityDriver() {}
|
||||
virtual ~AccessibilityDriver() {}
|
||||
};
|
||||
|
||||
VARIANT_ENUM_CAST(DisplayServer::AccessibilityAction)
|
||||
VARIANT_ENUM_CAST(DisplayServer::AccessibilityFlags)
|
||||
VARIANT_ENUM_CAST(DisplayServer::AccessibilityLiveMode)
|
||||
VARIANT_ENUM_CAST(DisplayServer::AccessibilityPopupType)
|
||||
VARIANT_ENUM_CAST(DisplayServer::AccessibilityRole)
|
||||
|
||||
VARIANT_ENUM_CAST(DisplayServer::WindowEvent)
|
||||
VARIANT_ENUM_CAST(DisplayServer::Feature)
|
||||
VARIANT_ENUM_CAST(DisplayServer::MouseMode)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue