CoCalc -- accessibility

GitHub Repository: godotengine/godot
Path: blob/master/servers/display/accessibility_server.h
⁴⁵⁹⁸⁷ views
1
/**************************************************************************/
2
/*  accessibility_server.h                                                */
3
/**************************************************************************/
4
/*                         This file is part of:                          */
5
/*                             GODOT ENGINE                               */
6
/*                        https://godotengine.org                         */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
10
/*                                                                        */
11
/* Permission is hereby granted, free of charge, to any person obtaining  */
12
/* a copy of this software and associated documentation files (the        */
13
/* "Software"), to deal in the Software without restriction, including    */
14
/* without limitation the rights to use, copy, modify, merge, publish,    */
15
/* distribute, sublicense, and/or sell copies of the Software, and to     */
16
/* permit persons to whom the Software is furnished to do so, subject to  */
17
/* the following conditions:                                              */
18
/*                                                                        */
19
/* The above copyright notice and this permission notice shall be         */
20
/* included in all copies or substantial portions of the Software.        */
21
/*                                                                        */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
29
/**************************************************************************/
30

31
#pragma once
32

33
#include "core/object/object.h"
34
#include "core/variant/type_info.h"
35
#include "servers/display/accessibility_server_enums.h"
36
#include "servers/display/display_server_enums.h"
37

38
class AccessibilityServer : public Object {
39
	GDCLASS(AccessibilityServer, Object)
40

41
public:
42
	typedef AccessibilityServer *(*CreateFunction)(Error &r_error);
43

44
protected:
45
	static inline AccessibilityServer *singleton = nullptr;
46
	static inline AccessibilityServerEnums::AccessibilityMode accessibility_mode = AccessibilityServerEnums::AccessibilityMode::ACCESSIBILITY_AUTO;
47

48
	static void _bind_methods();
49

50
	enum {
51
		MAX_SERVERS = 64
52
	};
53

54
	struct AccessibilityServerCreate {
55
		const char *name;
56
		CreateFunction create_function;
57
	};
58

59
	static AccessibilityServerCreate server_create_functions[MAX_SERVERS];
60
	static int server_create_count;
61

62
public:
63
	_FORCE_INLINE_ static AccessibilityServerEnums::AccessibilityMode get_mode() { return accessibility_mode; }
64
	static void set_mode(AccessibilityServerEnums::AccessibilityMode p_mode) { accessibility_mode = p_mode; }
65

66
	_FORCE_INLINE_ static AccessibilityServer *get_singleton() { return singleton; }
67

68
	virtual bool is_supported() const { return false; }
69

70
	virtual bool window_create(DisplayServerEnums::WindowID p_window_id, void *p_handle) = 0;
71
	virtual void window_destroy(DisplayServerEnums::WindowID p_window_id) = 0;
72

73
	virtual RID create_element(DisplayServerEnums::WindowID p_window_id, AccessibilityServerEnums::AccessibilityRole p_role) = 0;
74
	virtual RID create_sub_element(const RID &p_parent_rid, AccessibilityServerEnums::AccessibilityRole p_role, int p_insert_pos = -1) = 0;
75
	virtual 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) = 0;
76
	virtual bool has_element(const RID &p_id) const = 0;
77
	virtual void free_element(const RID &p_id) = 0;
78

79
	virtual void element_set_meta(const RID &p_id, const Variant &p_meta) = 0;
80
	virtual Variant element_get_meta(const RID &p_id) const = 0;
81

82
	virtual void update_if_active(const Callable &p_callable) = 0;
83

84
	virtual RID get_window_root(DisplayServerEnums::WindowID p_window_id) const = 0;
85
	virtual void update_set_focus(const RID &p_id) = 0;
86

87
	virtual void set_window_rect(DisplayServerEnums::WindowID p_window_id, const Rect2 &p_rect_out, const Rect2 &p_rect_in) = 0;
88
	virtual void set_window_focused(DisplayServerEnums::WindowID p_window_id, bool p_focused) = 0;
89
	virtual void set_window_callbacks(DisplayServerEnums::WindowID p_window_id, const Callable &p_activate_callable, const Callable &p_deativate_callable) = 0;
90
	virtual void window_activation_completed(DisplayServerEnums::WindowID p_window_id) = 0;
91
	virtual void window_deactivation_completed(DisplayServerEnums::WindowID p_window_id) = 0;
92

93
	virtual void update_set_role(const RID &p_id, AccessibilityServerEnums::AccessibilityRole p_role) = 0;
94
	virtual void update_set_name(const RID &p_id, const String &p_name) = 0;
95
	virtual void update_set_braille_label(const RID &p_id, const String &p_name) = 0;
96
	virtual void update_set_braille_role_description(const RID &p_id, const String &p_description) = 0;
97
	virtual void update_set_extra_info(const RID &p_id, const String &p_name_extra_info) = 0;
98
	virtual void update_set_description(const RID &p_id, const String &p_description) = 0;
99
	virtual void update_set_value(const RID &p_id, const String &p_value) = 0;
100
	virtual void update_set_tooltip(const RID &p_id, const String &p_tooltip) = 0;
101
	virtual void update_set_bounds(const RID &p_id, const Rect2 &p_rect) = 0;
102
	virtual void update_set_transform(const RID &p_id, const Transform2D &p_transform) = 0;
103
	virtual void update_add_child(const RID &p_id, const RID &p_child_id) = 0;
104
	virtual void update_add_related_controls(const RID &p_id, const RID &p_related_id) = 0;
105
	virtual void update_add_related_details(const RID &p_id, const RID &p_related_id) = 0;
106
	virtual void update_add_related_described_by(const RID &p_id, const RID &p_related_id) = 0;
107
	virtual void update_add_related_flow_to(const RID &p_id, const RID &p_related_id) = 0;
108
	virtual void update_add_related_labeled_by(const RID &p_id, const RID &p_related_id) = 0;
109
	virtual void update_add_related_radio_group(const RID &p_id, const RID &p_related_id) = 0;
110
	virtual void update_set_active_descendant(const RID &p_id, const RID &p_other_id) = 0;
111
	virtual void update_set_next_on_line(const RID &p_id, const RID &p_other_id) = 0;
112
	virtual void update_set_previous_on_line(const RID &p_id, const RID &p_other_id) = 0;
113
	virtual void update_set_member_of(const RID &p_id, const RID &p_group_id) = 0;
114
	virtual void update_set_in_page_link_target(const RID &p_id, const RID &p_other_id) = 0;
115
	virtual void update_set_error_message(const RID &p_id, const RID &p_other_id) = 0;
116
	virtual void update_set_live(const RID &p_id, AccessibilityServerEnums::AccessibilityLiveMode p_live) = 0;
117
	virtual void update_add_action(const RID &p_id, AccessibilityServerEnums::AccessibilityAction p_action, const Callable &p_callable) = 0;
118
	virtual void update_add_custom_action(const RID &p_id, int p_action_id, const String &p_action_description) = 0;
119
	virtual void update_set_table_row_count(const RID &p_id, int p_count) = 0;
120
	virtual void update_set_table_column_count(const RID &p_id, int p_count) = 0;
121
	virtual void update_set_table_row_index(const RID &p_id, int p_index) = 0;
122
	virtual void update_set_table_column_index(const RID &p_id, int p_index) = 0;
123
	virtual void update_set_table_cell_position(const RID &p_id, int p_row_index, int p_column_index) = 0;
124
	virtual void update_set_table_cell_span(const RID &p_id, int p_row_span, int p_column_span) = 0;
125
	virtual void update_set_list_item_count(const RID &p_id, int p_size) = 0;
126
	virtual void update_set_list_item_index(const RID &p_id, int p_index) = 0;
127
	virtual void update_set_list_item_level(const RID &p_id, int p_level) = 0;
128
	virtual void update_set_list_item_selected(const RID &p_id, bool p_selected) = 0;
129
	virtual void update_set_list_item_expanded(const RID &p_id, bool p_expanded) = 0;
130
	virtual void update_set_popup_type(const RID &p_id, AccessibilityServerEnums::AccessibilityPopupType p_popup) = 0;
131
	virtual void update_set_checked(const RID &p_id, bool p_checekd) = 0;
132
	virtual void update_set_num_value(const RID &p_id, double p_position) = 0;
133
	virtual void update_set_num_range(const RID &p_id, double p_min, double p_max) = 0;
134
	virtual void update_set_num_step(const RID &p_id, double p_step) = 0;
135
	virtual void update_set_num_jump(const RID &p_id, double p_jump) = 0;
136
	virtual void update_set_scroll_x(const RID &p_id, double p_position) = 0;
137
	virtual void update_set_scroll_x_range(const RID &p_id, double p_min, double p_max) = 0;
138
	virtual void update_set_scroll_y(const RID &p_id, double p_position) = 0;
139
	virtual void update_set_scroll_y_range(const RID &p_id, double p_min, double p_max) = 0;
140
	virtual void update_set_text_decorations(const RID &p_id, bool p_underline, bool p_strikethrough, bool p_overline, const Color &p_color) = 0;
141
	virtual void update_set_text_align(const RID &p_id, HorizontalAlignment p_align) = 0;
142
	virtual void 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;
143
	virtual void update_set_flag(const RID &p_id, AccessibilityServerEnums::AccessibilityFlags p_flag, bool p_value) = 0;
144
	virtual void update_set_classname(const RID &p_id, const String &p_classname) = 0;
145
	virtual void update_set_placeholder(const RID &p_id, const String &p_placeholder) = 0;
146
	virtual void update_set_language(const RID &p_id, const String &p_language) = 0;
147
	virtual void update_set_text_orientation(const RID &p_id, bool p_vertical) = 0;
148
	virtual void update_set_list_orientation(const RID &p_id, bool p_vertical) = 0;
149
	virtual void update_set_shortcut(const RID &p_id, const String &p_shortcut) = 0;
150
	virtual void update_set_url(const RID &p_id, const String &p_url) = 0;
151
	virtual void update_set_role_description(const RID &p_id, const String &p_description) = 0;
152
	virtual void update_set_state_description(const RID &p_id, const String &p_description) = 0;
153
	virtual void update_set_color_value(const RID &p_id, const Color &p_color) = 0;
154
	virtual void update_set_background_color(const RID &p_id, const Color &p_color) = 0;
155
	virtual void update_set_foreground_color(const RID &p_id, const Color &p_color) = 0;
156

157
	static void register_create_function(const char *p_name, CreateFunction p_function);
158
	static int get_create_function_count();
159
	static const char *get_create_function_name(int p_index);
160
	static AccessibilityServer *create(int p_index, Error &r_error);
161

162
	AccessibilityServer();
163
	virtual ~AccessibilityServer();
164
};
165

166
VARIANT_ENUM_CAST_EXT(AccessibilityServerEnums::AccessibilityAction, AccessibilityServer::AccessibilityAction)
167
VARIANT_ENUM_CAST_EXT(AccessibilityServerEnums::AccessibilityFlags, AccessibilityServer::AccessibilityFlags)
168
VARIANT_ENUM_CAST_EXT(AccessibilityServerEnums::AccessibilityLiveMode, AccessibilityServer::AccessibilityLiveMode)
169
VARIANT_ENUM_CAST_EXT(AccessibilityServerEnums::AccessibilityPopupType, AccessibilityServer::AccessibilityPopupType)
170
VARIANT_ENUM_CAST_EXT(AccessibilityServerEnums::AccessibilityRole, AccessibilityServer::AccessibilityRole)
171
VARIANT_ENUM_CAST_EXT(AccessibilityServerEnums::AccessibilityScrollUnit, AccessibilityServer::AccessibilityScrollUnit)
172
VARIANT_ENUM_CAST_EXT(AccessibilityServerEnums::AccessibilityScrollHint, AccessibilityServer::AccessibilityScrollHint)
173

174
Product

Resources

Company
