Path: blob/master/drivers/accesskit/accessibility_driver_accesskit.h
9973 views
/**************************************************************************/1/* accessibility_driver_accesskit.h */2/**************************************************************************/3/* This file is part of: */4/* GODOT ENGINE */5/* https://godotengine.org */6/**************************************************************************/7/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */8/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */9/* */10/* Permission is hereby granted, free of charge, to any person obtaining */11/* a copy of this software and associated documentation files (the */12/* "Software"), to deal in the Software without restriction, including */13/* without limitation the rights to use, copy, modify, merge, publish, */14/* distribute, sublicense, and/or sell copies of the Software, and to */15/* permit persons to whom the Software is furnished to do so, subject to */16/* the following conditions: */17/* */18/* The above copyright notice and this permission notice shall be */19/* included in all copies or substantial portions of the Software. */20/* */21/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */22/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */23/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */24/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */25/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */26/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */27/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */28/**************************************************************************/2930#pragma once3132#ifdef ACCESSKIT_ENABLED3334#include "core/templates/rid_owner.h"35#include "servers/display_server.h"3637#ifdef ACCESSKIT_DYNAMIC38#ifdef LINUXBSD_ENABLED39#include "drivers/accesskit/dynwrappers/accesskit-so_wrap.h"40#endif41#ifdef MACOS_ENABLED42#include "drivers/accesskit/dynwrappers/accesskit-dylib_wrap.h"43#endif44#ifdef WINDOWS_ENABLED45#include "drivers/accesskit/dynwrappers/accesskit-dll_wrap.h"46#endif47#else48#include <accesskit.h>49#endif5051class AccessibilityDriverAccessKit : public AccessibilityDriver {52static AccessibilityDriverAccessKit *singleton;5354struct AccessibilityElement {55HashMap<accesskit_action, Callable> actions;5657DisplayServer::WindowID window_id = DisplayServer::INVALID_WINDOW_ID;58RID parent;59LocalVector<RID> children;60Vector3i run;61Variant meta;62String name;63String name_extra_info;6465accesskit_role role = ACCESSKIT_ROLE_UNKNOWN;66accesskit_node *node = nullptr;67};68mutable RID_PtrOwner<AccessibilityElement> rid_owner;6970struct WindowData {71// Adapter.72#ifdef WINDOWS_ENABLED73accesskit_windows_subclassing_adapter *adapter = nullptr;74#endif75#ifdef MACOS_ENABLED76accesskit_macos_subclassing_adapter *adapter = nullptr;77#endif78#ifdef LINUXBSD_ENABLED79accesskit_unix_adapter *adapter = nullptr;80#endif8182RID root_id;83HashSet<RID> update;84};8586RID focus;8788HashMap<DisplayServer::WindowID, WindowData> windows;8990HashMap<DisplayServer::AccessibilityRole, accesskit_role> role_map;91HashMap<DisplayServer::AccessibilityAction, accesskit_action> action_map;9293_FORCE_INLINE_ accesskit_role _accessibility_role(DisplayServer::AccessibilityRole p_role) const;94_FORCE_INLINE_ accesskit_action _accessibility_action(DisplayServer::AccessibilityAction p_action) const;9596void _free_recursive(WindowData *p_wd, const RID &p_id);97_FORCE_INLINE_ void _ensure_node(const RID &p_id, AccessibilityElement *p_ae);9899static void _accessibility_action_callback(struct accesskit_action_request *p_request, void *p_user_data);100static accesskit_tree_update *_accessibility_initial_tree_update_callback(void *p_user_data);101static void _accessibility_deactivation_callback(void *p_user_data);102static accesskit_tree_update *_accessibility_build_tree_update(void *p_user_data);103104bool in_accessibility_update = false;105Callable update_cb;106107public:108Error init() override;109110bool window_create(DisplayServer::WindowID p_window_id, void *p_handle) override;111void window_destroy(DisplayServer::WindowID p_window_id) override;112113RID accessibility_create_element(DisplayServer::WindowID p_window_id, DisplayServer::AccessibilityRole p_role) override;114RID accessibility_create_sub_element(const RID &p_parent_rid, DisplayServer::AccessibilityRole p_role, int p_insert_pos = -1) override;115virtual 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) override;116bool accessibility_has_element(const RID &p_id) const override;117void accessibility_free_element(const RID &p_id) override;118119void accessibility_element_set_meta(const RID &p_id, const Variant &p_meta) override;120Variant accessibility_element_get_meta(const RID &p_id) const override;121122void accessibility_update_if_active(const Callable &p_callable) override;123124void accessibility_update_set_focus(const RID &p_id) override;125RID accessibility_get_window_root(DisplayServer::WindowID p_window_id) const override;126127void accessibility_set_window_rect(DisplayServer::WindowID p_window_id, const Rect2 &p_rect_out, const Rect2 &p_rect_in) override;128void accessibility_set_window_focused(DisplayServer::WindowID p_window_id, bool p_focused) override;129130void accessibility_update_set_role(const RID &p_id, DisplayServer::AccessibilityRole p_role) override;131void accessibility_update_set_name(const RID &p_id, const String &p_name) override;132void accessibility_update_set_extra_info(const RID &p_id, const String &p_name_extra_info) override;133void accessibility_update_set_description(const RID &p_id, const String &p_description) override;134void accessibility_update_set_value(const RID &p_id, const String &p_value) override;135void accessibility_update_set_tooltip(const RID &p_id, const String &p_tooltip) override;136void accessibility_update_set_bounds(const RID &p_id, const Rect2 &p_rect) override;137void accessibility_update_set_transform(const RID &p_id, const Transform2D &p_transform) override;138void accessibility_update_add_child(const RID &p_id, const RID &p_child_id) override;139void accessibility_update_add_related_controls(const RID &p_id, const RID &p_related_id) override;140void accessibility_update_add_related_details(const RID &p_id, const RID &p_related_id) override;141void accessibility_update_add_related_described_by(const RID &p_id, const RID &p_related_id) override;142void accessibility_update_add_related_flow_to(const RID &p_id, const RID &p_related_id) override;143void accessibility_update_add_related_labeled_by(const RID &p_id, const RID &p_related_id) override;144void accessibility_update_add_related_radio_group(const RID &p_id, const RID &p_related_id) override;145void accessibility_update_set_active_descendant(const RID &p_id, const RID &p_other_id) override;146void accessibility_update_set_next_on_line(const RID &p_id, const RID &p_other_id) override;147void accessibility_update_set_previous_on_line(const RID &p_id, const RID &p_other_id) override;148void accessibility_update_set_member_of(const RID &p_id, const RID &p_group_id) override;149void accessibility_update_set_in_page_link_target(const RID &p_id, const RID &p_other_id) override;150void accessibility_update_set_error_message(const RID &p_id, const RID &p_other_id) override;151void accessibility_update_set_live(const RID &p_id, DisplayServer::AccessibilityLiveMode p_live) override;152void accessibility_update_add_action(const RID &p_id, DisplayServer::AccessibilityAction p_action, const Callable &p_callable) override;153void accessibility_update_add_custom_action(const RID &p_id, int p_action_id, const String &p_action_description) override;154void accessibility_update_set_table_row_count(const RID &p_id, int p_count) override;155void accessibility_update_set_table_column_count(const RID &p_id, int p_count) override;156void accessibility_update_set_table_row_index(const RID &p_id, int p_index) override;157void accessibility_update_set_table_column_index(const RID &p_id, int p_index) override;158void accessibility_update_set_table_cell_position(const RID &p_id, int p_row_index, int p_column_index) override;159void accessibility_update_set_table_cell_span(const RID &p_id, int p_row_span, int p_column_span) override;160void accessibility_update_set_list_item_count(const RID &p_id, int p_size) override;161void accessibility_update_set_list_item_index(const RID &p_id, int p_index) override;162void accessibility_update_set_list_item_level(const RID &p_id, int p_level) override;163void accessibility_update_set_list_item_selected(const RID &p_id, bool p_selected) override;164void accessibility_update_set_list_item_expanded(const RID &p_id, bool p_expanded) override;165void accessibility_update_set_popup_type(const RID &p_id, DisplayServer::AccessibilityPopupType p_popup) override;166void accessibility_update_set_checked(const RID &p_id, bool p_checekd) override;167void accessibility_update_set_num_value(const RID &p_id, double p_position) override;168void accessibility_update_set_num_range(const RID &p_id, double p_min, double p_max) override;169void accessibility_update_set_num_step(const RID &p_id, double p_step) override;170void accessibility_update_set_num_jump(const RID &p_id, double p_jump) override;171void accessibility_update_set_scroll_x(const RID &p_id, double p_position) override;172void accessibility_update_set_scroll_x_range(const RID &p_id, double p_min, double p_max) override;173void accessibility_update_set_scroll_y(const RID &p_id, double p_position) override;174void accessibility_update_set_scroll_y_range(const RID &p_id, double p_min, double p_max) override;175void accessibility_update_set_text_decorations(const RID &p_id, bool p_underline, bool p_strikethrough, bool p_overline) override;176void accessibility_update_set_text_align(const RID &p_id, HorizontalAlignment p_align) override;177void 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) override;178void accessibility_update_set_flag(const RID &p_id, DisplayServer::AccessibilityFlags p_flag, bool p_value) override;179void accessibility_update_set_classname(const RID &p_id, const String &p_classname) override;180void accessibility_update_set_placeholder(const RID &p_id, const String &p_placeholder) override;181void accessibility_update_set_language(const RID &p_id, const String &p_language) override;182void accessibility_update_set_text_orientation(const RID &p_id, bool p_vertical) override;183void accessibility_update_set_list_orientation(const RID &p_id, bool p_vertical) override;184void accessibility_update_set_shortcut(const RID &p_id, const String &p_shortcut) override;185void accessibility_update_set_url(const RID &p_id, const String &p_url) override;186void accessibility_update_set_role_description(const RID &p_id, const String &p_description) override;187void accessibility_update_set_state_description(const RID &p_id, const String &p_description) override;188void accessibility_update_set_color_value(const RID &p_id, const Color &p_color) override;189void accessibility_update_set_background_color(const RID &p_id, const Color &p_color) override;190void accessibility_update_set_foreground_color(const RID &p_id, const Color &p_color) override;191192AccessibilityDriverAccessKit();193~AccessibilityDriverAccessKit();194};195196#endif // ACCESSKIT_ENABLED197198199