Path: blob/master/drivers/accesskit/accessibility_server_accesskit.h
45997 views
/**************************************************************************/1/* accessibility_server_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/accessibility_server.h"3637#include <accesskit.h>3839class AccessibilityServerAccessKit : public AccessibilityServer {40GDSOFTCLASS(AccessibilityServerAccessKit, AccessibilityServer);4142static AccessibilityServer *create_func(Error &r_error);4344struct AccessibilityElement {45HashMap<accesskit_action, Callable> actions;4647DisplayServerEnums::WindowID window_id = DisplayServerEnums::INVALID_WINDOW_ID;48RID parent;49LocalVector<RID> children;50Vector3i run;51Variant meta;52String name;53String name_extra_info;54Variant value;55int64_t flags = 0;5657accesskit_role role = ACCESSKIT_ROLE_UNKNOWN;58accesskit_node *node = nullptr;59};60mutable RID_PtrOwner<AccessibilityElement> rid_owner;6162struct WindowData {63// Adapter.64#ifdef WINDOWS_ENABLED65accesskit_windows_subclassing_adapter *adapter = nullptr;66#endif67#ifdef MACOS_ENABLED68accesskit_macos_subclassing_adapter *adapter = nullptr;69#endif70#ifdef LINUXBSD_ENABLED71accesskit_unix_adapter *adapter = nullptr;72#endif7374RID root_id;75bool initial_update_completed = false;76HashSet<RID> update;77Callable activate;78Callable deactivate;79bool activated = false;80};8182RID focus;8384HashMap<DisplayServerEnums::WindowID, WindowData> windows;8586HashMap<AccessibilityServerEnums::AccessibilityRole, accesskit_role> role_map;87HashMap<AccessibilityServerEnums::AccessibilityAction, accesskit_action> action_map;8889_FORCE_INLINE_ accesskit_role _accessibility_role(AccessibilityServerEnums::AccessibilityRole p_role) const;90_FORCE_INLINE_ accesskit_action _accessibility_action(AccessibilityServerEnums::AccessibilityAction p_action) const;9192void _free_recursive(WindowData *p_wd, const RID &p_id);93_FORCE_INLINE_ void _ensure_node(const RID &p_id, AccessibilityElement *p_ae);9495static void _accessibility_action_callback(struct accesskit_action_request *p_request, void *p_user_data);96static accesskit_tree_update *_accessibility_initial_tree_update_callback(void *p_user_data);97static void _accessibility_deactivation_callback(void *p_user_data);98static accesskit_tree_update *_accessibility_build_tree_update(void *p_user_data);99100bool in_accessibility_update = false;101Callable update_cb;102103public:104bool is_supported() const override { return true; }105106bool window_create(DisplayServerEnums::WindowID p_window_id, void *p_handle) override;107void window_destroy(DisplayServerEnums::WindowID p_window_id) override;108109RID create_element(DisplayServerEnums::WindowID p_window_id, AccessibilityServerEnums::AccessibilityRole p_role) override;110RID create_sub_element(const RID &p_parent_rid, AccessibilityServerEnums::AccessibilityRole p_role, int p_insert_pos = -1) override;111virtual RID create_sub_text_edit_elements(const RID &p_parent_rid, const RID &p_shaped_text, float p_min_height, int p_insert_pos = -1, bool p_is_last_line = false) override;112bool has_element(const RID &p_id) const override;113void free_element(const RID &p_id) override;114115void element_set_meta(const RID &p_id, const Variant &p_meta) override;116Variant element_get_meta(const RID &p_id) const override;117118void update_if_active(const Callable &p_callable) override;119120void update_set_focus(const RID &p_id) override;121RID get_window_root(DisplayServerEnums::WindowID p_window_id) const override;122123void set_window_rect(DisplayServerEnums::WindowID p_window_id, const Rect2 &p_rect_out, const Rect2 &p_rect_in) override;124void set_window_focused(DisplayServerEnums::WindowID p_window_id, bool p_focused) override;125void set_window_callbacks(DisplayServerEnums::WindowID p_window_id, const Callable &p_activate_callable, const Callable &p_deativate_callable) override;126void window_activation_completed(DisplayServerEnums::WindowID p_window_id) override;127void window_deactivation_completed(DisplayServerEnums::WindowID p_window_id) override;128129void update_set_role(const RID &p_id, AccessibilityServerEnums::AccessibilityRole p_role) override;130void update_set_name(const RID &p_id, const String &p_name) override;131void update_set_braille_label(const RID &p_id, const String &p_name) override;132void update_set_braille_role_description(const RID &p_id, const String &p_description) override;133void update_set_extra_info(const RID &p_id, const String &p_name_extra_info) override;134void update_set_description(const RID &p_id, const String &p_description) override;135void update_set_value(const RID &p_id, const String &p_value) override;136void update_set_tooltip(const RID &p_id, const String &p_tooltip) override;137void update_set_bounds(const RID &p_id, const Rect2 &p_rect) override;138void update_set_transform(const RID &p_id, const Transform2D &p_transform) override;139void update_add_child(const RID &p_id, const RID &p_child_id) override;140void update_add_related_controls(const RID &p_id, const RID &p_related_id) override;141void update_add_related_details(const RID &p_id, const RID &p_related_id) override;142void update_add_related_described_by(const RID &p_id, const RID &p_related_id) override;143void update_add_related_flow_to(const RID &p_id, const RID &p_related_id) override;144void update_add_related_labeled_by(const RID &p_id, const RID &p_related_id) override;145void update_add_related_radio_group(const RID &p_id, const RID &p_related_id) override;146void update_set_active_descendant(const RID &p_id, const RID &p_other_id) override;147void update_set_next_on_line(const RID &p_id, const RID &p_other_id) override;148void update_set_previous_on_line(const RID &p_id, const RID &p_other_id) override;149void update_set_member_of(const RID &p_id, const RID &p_group_id) override;150void update_set_in_page_link_target(const RID &p_id, const RID &p_other_id) override;151void update_set_error_message(const RID &p_id, const RID &p_other_id) override;152void update_set_live(const RID &p_id, AccessibilityServerEnums::AccessibilityLiveMode p_live) override;153void update_add_action(const RID &p_id, AccessibilityServerEnums::AccessibilityAction p_action, const Callable &p_callable) override;154void update_add_custom_action(const RID &p_id, int p_action_id, const String &p_action_description) override;155void update_set_table_row_count(const RID &p_id, int p_count) override;156void update_set_table_column_count(const RID &p_id, int p_count) override;157void update_set_table_row_index(const RID &p_id, int p_index) override;158void update_set_table_column_index(const RID &p_id, int p_index) override;159void update_set_table_cell_position(const RID &p_id, int p_row_index, int p_column_index) override;160void update_set_table_cell_span(const RID &p_id, int p_row_span, int p_column_span) override;161void update_set_list_item_count(const RID &p_id, int p_size) override;162void update_set_list_item_index(const RID &p_id, int p_index) override;163void update_set_list_item_level(const RID &p_id, int p_level) override;164void update_set_list_item_selected(const RID &p_id, bool p_selected) override;165void update_set_list_item_expanded(const RID &p_id, bool p_expanded) override;166void update_set_popup_type(const RID &p_id, AccessibilityServerEnums::AccessibilityPopupType p_popup) override;167void update_set_checked(const RID &p_id, bool p_checekd) override;168void update_set_num_value(const RID &p_id, double p_position) override;169void update_set_num_range(const RID &p_id, double p_min, double p_max) override;170void update_set_num_step(const RID &p_id, double p_step) override;171void update_set_num_jump(const RID &p_id, double p_jump) override;172void update_set_scroll_x(const RID &p_id, double p_position) override;173void update_set_scroll_x_range(const RID &p_id, double p_min, double p_max) override;174void update_set_scroll_y(const RID &p_id, double p_position) override;175void update_set_scroll_y_range(const RID &p_id, double p_min, double p_max) override;176void update_set_text_decorations(const RID &p_id, bool p_underline, bool p_strikethrough, bool p_overline, const Color &p_color) override;177void update_set_text_align(const RID &p_id, HorizontalAlignment p_align) override;178void 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;179void update_set_flag(const RID &p_id, AccessibilityServerEnums::AccessibilityFlags p_flag, bool p_value) override;180void update_set_classname(const RID &p_id, const String &p_classname) override;181void update_set_placeholder(const RID &p_id, const String &p_placeholder) override;182void update_set_language(const RID &p_id, const String &p_language) override;183void update_set_text_orientation(const RID &p_id, bool p_vertical) override;184void update_set_list_orientation(const RID &p_id, bool p_vertical) override;185void update_set_shortcut(const RID &p_id, const String &p_shortcut) override;186void update_set_url(const RID &p_id, const String &p_url) override;187void update_set_role_description(const RID &p_id, const String &p_description) override;188void update_set_state_description(const RID &p_id, const String &p_description) override;189void update_set_color_value(const RID &p_id, const Color &p_color) override;190void update_set_background_color(const RID &p_id, const Color &p_color) override;191void update_set_foreground_color(const RID &p_id, const Color &p_color) override;192193static void register_create_func();194195AccessibilityServerAccessKit();196~AccessibilityServerAccessKit();197};198199#endif // ACCESSKIT_ENABLED200201202