godot-accessibility/Accessible.gd

571 lines
19 KiB
GDScript3
Raw Normal View History

extends Object
var node
2018-07-19 20:12:01 +00:00
var position_in_children = 0
var column_in_row = 0
func get_siblings():
var parent = node.get_parent()
if parent:
return parent.get_children()
return null
func click(item := node, button_index = BUTTON_LEFT):
var click = InputEventMouseButton.new()
click.button_index = button_index
click.pressed = true
if item is Node:
click.position = item.rect_global_position
else:
click.position = node.get_tree().root.get_mouse_position()
node.get_tree().input_event(click)
click.pressed = false
node.get_tree().input_event(click)
2018-06-10 21:14:43 +00:00
func guess_label():
var tokens = PoolStringArray([])
var to_check = node
while to_check:
if to_check is EditorProperty and to_check.label:
tokens.append(to_check.label)
if (to_check is EditorProperty or to_check.get_class() == "EditorInspectorCategory") and to_check.get_tooltip_text():
tokens.append(to_check.get_tooltip_text())
var label = tokens.join(": ")
if label:
return label
to_check = to_check.get_parent()
func accept_dialog_focused():
yield(node.get_tree().create_timer(5), "timeout")
node.get_ok().emit_signal("pressed")
func checkbox_focused():
var tokens = PoolStringArray([])
if node.pressed:
tokens.append("checked")
else:
tokens.append("unchecked")
tokens.append(" checkbox")
TTS.speak(tokens.join(" "), false)
func checkbox_toggled(checked):
if node.has_focus():
if checked:
TTS.speak("checked", true)
else:
TTS.speak("unchecked", true)
var spoke_hint_tooltip
func button_focused():
var tokens = PoolStringArray([])
2018-06-10 20:32:27 +00:00
if node.text:
tokens.append(node.text)
elif node.hint_tooltip:
spoke_hint_tooltip = true
tokens.append(node.hint_tooltip)
tokens.append("button")
TTS.speak(tokens.join(": "), false)
2018-06-10 20:32:27 +00:00
func texturebutton_focused():
var texture = node.texture_normal
print(texture.resource_name)
print(texture.resource_path)
var rid = texture.get_rid()
print(rid)
print(rid.get_id())
TTS.speak("button", false)
func item_list_item_focused(idx):
var tokens = PoolStringArray([])
var text = node.get_item_text(idx)
if text:
tokens.append(text)
text = node.get_item_tooltip(idx)
if text:
tokens.append(text)
tokens.append("%s of %s" % [idx + 1, node.get_item_count()])
TTS.speak(tokens.join(": "))
func item_list_focused():
2018-07-03 17:01:00 +00:00
var count = node.get_item_count()
var selected = node.get_selected_items()[0]
position_in_children = selected
TTS.speak("list, %s %s" % [count, TTS.singular_or_plural(count, "item", "items")], false)
item_list_item_focused(selected)
2018-07-03 17:01:00 +00:00
2019-09-02 12:04:45 +00:00
func item_list_item_selected(index):
TTS.speak("Selected", true)
2018-07-03 17:01:00 +00:00
2019-09-02 12:04:45 +00:00
func item_list_multi_selected(index, selected):
TTS.speak("Multiselect", false)
2018-07-03 17:01:00 +00:00
2019-09-02 12:04:45 +00:00
func item_list_nothing_selected():
TTS.speak("Nothing selected", true)
2018-07-03 17:01:00 +00:00
func item_list_input(event):
if event.is_action_pressed("ui_right") or event.is_action_pressed("ui_left"):
return node.accept_event()
var old_count = node.get_item_count()
var old_pos = position_in_children
if event.is_action_pressed("ui_up"):
node.accept_event()
2018-07-19 20:12:01 +00:00
if position_in_children == 0:
return
2018-07-19 20:12:01 +00:00
position_in_children -= 1
elif event.is_action_pressed("ui_down"):
node.accept_event()
2018-07-19 20:12:01 +00:00
if position_in_children >= node.get_item_count()-1:
return
2018-07-19 20:12:01 +00:00
position_in_children += 1
elif event.is_action_pressed("ui_home"):
node.accept_event()
2018-07-19 20:12:01 +00:00
position_in_children = 0
elif event.is_action_pressed("ui_end"):
node.accept_event()
2018-07-19 20:12:01 +00:00
position_in_children = node.get_item_count()-1
if old_pos != position_in_children:
if position_in_children >= node.get_item_count():
position_in_children = 0
node.unselect_all()
node.select(position_in_children)
item_list_item_focused(position_in_children)
2018-06-10 21:14:43 +00:00
func label_focused():
2019-09-02 12:04:45 +00:00
var text = node.text
if text == "":
text = "blank"
TTS.speak(text, false)
func line_edit_focused():
2018-06-10 20:32:27 +00:00
var text = "blank"
if node.secret:
text = "password"
elif node.text != "":
text = node.text
elif node.placeholder_text != "":
text = node.placeholder_text
var type = "editable text"
if not node.editable:
type = "text"
TTS.speak("%s: %s" % [text, type], false)
2018-06-10 20:32:27 +00:00
var old_text
2018-06-18 20:33:03 +00:00
var old_pos
func line_edit_text_changed(text):
if len(text) > len(old_text):
for i in range(len(text)):
if text.substr(i, 1) != old_text.substr(i, 1):
TTS.speak(text.substr(i, 1))
return
else:
for i in range(len(old_text)):
if old_text.substr(i, 1) != text.substr(i, 1):
TTS.speak(old_text.substr(i, 1))
return
func line_edit_input(event):
var pos = node.caret_position
if old_pos != null and old_pos != pos:
2018-06-18 20:33:03 +00:00
var text = node.text
if old_text == text:
if pos > len(text)-1:
TTS.speak("blank", true)
else:
TTS.speak(text[pos], true)
2018-06-18 20:33:03 +00:00
old_pos = pos
elif old_pos == null:
old_pos = pos
old_text = node.text
func menu_button_focused():
var tokens = PoolStringArray([])
if node.text:
tokens.append(node.text)
if node.hint_tooltip:
tokens.append(node.hint_tooltip)
spoke_hint_tooltip = true
tokens.append("menu")
TTS.speak(tokens.join(": "), false)
2019-09-02 12:04:45 +00:00
func popup_menu_focused():
TTS.speak("menu", false)
2018-07-19 20:12:01 +00:00
func popup_menu_item_id_focused(index):
2019-09-30 20:15:00 +00:00
print("item id focus %s" % index)
var tokens = PoolStringArray([])
2019-09-30 20:15:00 +00:00
var shortcut = node.get_item_shortcut(index)
if shortcut:
var name = shortcut.resource_name
if name:
tokens.append(name)
var text = shortcut.get_as_text()
if text != "None":
tokens.append(text)
var item = node.get_item_text(index)
if item:
tokens.append(item)
var submenu = node.get_item_submenu(index)
if submenu:
tokens.append(submenu)
tokens.append("menu")
2019-09-30 20:15:00 +00:00
if node.is_item_checkable(index):
if node.is_item_checked(index):
tokens.append("checked")
else:
tokens.append("unchecked")
var tooltip = node.get_item_tooltip(index)
if tooltip:
tokens.append(tooltip)
var disabled = node.is_item_disabled(index)
if disabled:
tokens.append("disabled")
tokens.append(str(index + 1) + " of " + str(node.get_item_count()))
TTS.speak(tokens.join(": "), true)
2018-07-19 20:12:01 +00:00
2019-09-30 20:15:00 +00:00
func popup_menu_item_id_pressed(index):
if node.is_item_checkable(index):
if node.is_item_checked(index):
TTS.speak("checked", true)
2019-09-30 20:15:00 +00:00
else:
TTS.speak("unchecked", true)
2019-09-30 20:15:00 +00:00
func tree_item_render():
var focused_tree_item = node.get_selected()
var tokens = PoolStringArray([])
for i in range(node.columns):
tokens.append(focused_tree_item.get_text(i))
if focused_tree_item.get_children():
if focused_tree_item.collapsed:
tokens.append("collapsed")
else:
tokens.append("expanded")
tokens.append("tree item")
if focused_tree_item.is_selected(0):
tokens.append("selected")
TTS.speak(tokens.join(": "), true)
2018-07-19 17:02:40 +00:00
func tree_item_deselect_all(item: TreeItem):
for i in range(node.columns):
item.deselect(i)
func tree_deselect_all_but(target: TreeItem, item: TreeItem):
var next = item.get_next_visible()
while next and next != item:
tree_item_deselect_all(item)
next = next.get_next_visible()
2019-09-03 22:22:02 +00:00
var prev_selected_cell
var button_index
2019-09-03 22:22:02 +00:00
func tree_item_selected():
button_index = null
2019-09-03 22:22:02 +00:00
var cell = node.get_selected()
if cell != prev_selected_cell:
if node.select_mode == Tree.SELECT_MULTI:
cell.select(0)
tree_deselect_all_but(cell, node.get_root())
if node.has_focus():
tree_item_render()
2019-09-03 22:22:02 +00:00
prev_selected_cell = cell
else:
var tokens = PoolStringArray([])
2019-09-03 22:22:02 +00:00
for i in range(node.columns):
if cell.is_selected(i):
var title = node.get_column_title(i)
if title:
tokens.append(title)
var column_text = cell.get_text(i)
if column_text:
tokens.append(column_text)
var button_count = cell.get_button_count(i)
if button_count != 0:
button_index = 0
tokens.append(str(button_count) + " " + TTS.singular_or_plural(button_count, "button", "buttons"))
if cell.has_method("get_button_tooltip"):
var button_tooltip = cell.get_button_tooltip(i, button_index)
if button_tooltip:
tokens.append(button_tooltip)
tokens.append("button")
if button_count > 1:
tokens.append("Use Home and End to switch focus.")
TTS.speak(tokens.join(": "), true)
2019-09-03 22:22:02 +00:00
func tree_item_multi_select(item, column, selected):
if selected:
TTS.speak("selected", true)
2019-09-03 22:22:02 +00:00
else:
TTS.speak("unselected", true)
func tree_input(event):
var item = node.get_selected()
var column
if item:
for i in range(node.columns):
if item.is_selected(i):
column = i
break
if item and event is InputEventKey and event.pressed and not event.echo:
var area
if column:
area = node.get_item_area_rect(item, column)
else:
area = node.get_item_area_rect(item)
var position = Vector2(node.rect_global_position.x + area.position.x + area.size.x / 2, node.rect_global_position.y + area.position.y + area.size.y / 2)
node.get_tree().root.warp_mouse(position)
if item and column and button_index != null:
if event.is_action_pressed("ui_accept"):
node.accept_event()
return node.emit_signal("button_pressed", item, column, button_index + 1)
var new_button_index = button_index
if event.is_action_pressed("ui_home"):
node.accept_event()
new_button_index += 1
if new_button_index >= item.get_button_count(column):
new_button_index = 0
elif event.is_action_pressed("ui_end"):
node.accept_event()
new_button_index -= 1
if new_button_index < 0:
new_button_index = item.get_button_count(column) - 1
if new_button_index != button_index and item.has_method("get_button_tooltip"):
button_index = new_button_index
var tokens = PoolStringArray([])
var tooltip = item.get_button_tooltip(column, button_index)
if tooltip:
tokens.append(tooltip)
tokens.append("button")
TTS.speak(tokens.join(": "), true)
func tree_focused():
if node.get_selected():
tree_item_render()
else:
TTS.speak("tree", true)
func tree_item_collapsed(item):
if node.has_focus():
if item.collapsed:
TTS.speak("collapsed", true)
else:
TTS.speak("expanded", true)
func progress_bar_focused():
var percentage = int(node.ratio * 100)
TTS.speak("%s percent" % percentage, false)
TTS.speak("progress bar", false)
var last_percentage_spoken
var last_percentage_spoken_at = 0
func progress_bar_value_changed(value):
var percentage = node.value / (node.max_value - node.min_value) * 100
percentage = int(percentage)
if percentage != last_percentage_spoken and OS.get_ticks_msec() - last_percentage_spoken_at >= 10000:
TTS.speak("%s percent" % percentage)
last_percentage_spoken_at = OS.get_ticks_msec()
last_percentage_spoken = percentage
func tab_container_focused():
2019-09-02 14:55:51 +00:00
var text = node.get_tab_title(node.current_tab)
text += ": tab: " + str(node.current_tab + 1) + " of " + str(node.get_tab_count())
TTS.speak(text, false)
2019-09-02 14:55:51 +00:00
func tab_container_tab_changed(tab):
if node.has_focus():
TTS.stop()
tab_container_focused()
func tab_container_input(event):
var new_tab = node.current_tab
if event.is_action_pressed("ui_right"):
node.accept_event()
2019-09-02 14:55:51 +00:00
new_tab += 1
elif event.is_action_pressed("ui_left"):
node.accept_event()
2019-09-02 14:55:51 +00:00
new_tab -= 1
if new_tab < 0:
new_tab = node.get_tab_count() - 1
elif new_tab >= node.get_tab_count():
new_tab = 0
if node.current_tab != new_tab:
node.current_tab = new_tab
2018-06-10 21:02:45 +00:00
func focused():
2019-09-02 12:04:45 +00:00
print("Focus: %s" % node)
TTS.stop()
var label = guess_label()
if label:
TTS.speak(label, false)
2018-07-19 20:12:01 +00:00
if node is MenuButton:
menu_button_focused()
elif node is AcceptDialog:
accept_dialog_focused()
elif node is CheckBox:
checkbox_focused()
2018-07-19 20:12:01 +00:00
elif node is Button:
button_focused()
elif node.get_class() == "EditorInspectorSection":
editor_inspector_section_focused()
2018-06-10 21:14:43 +00:00
elif node is ItemList:
item_list_focused()
elif node is Label:
label_focused()
2018-06-10 20:32:27 +00:00
elif node is LineEdit:
line_edit_focused()
elif node is LinkButton:
button_focused()
2018-07-19 20:12:01 +00:00
elif node is PopupMenu:
popup_menu_focused()
elif node is ProgressBar:
progress_bar_focused()
2019-09-02 14:55:51 +00:00
elif node is TabContainer:
tab_container_focused()
elif node is TextureButton:
texturebutton_focused()
2018-06-10 21:02:45 +00:00
elif node is Tree:
tree_focused()
2018-06-10 20:18:00 +00:00
else:
TTS.speak(node.get_class(), true)
2019-09-02 12:04:45 +00:00
print("No handler")
if node.hint_tooltip and not spoke_hint_tooltip:
TTS.speak(node.hint_tooltip, false)
spoke_hint_tooltip = false
func unfocused():
print("Unfocused")
2018-07-19 20:12:01 +00:00
position_in_children = 0
yield(node.get_tree().create_timer(1), "timeout")
if not node.get_focus_owner():
node.get_tree().root.warp_mouse(node.rect_global_position)
func click_focused():
if node.has_focus():
return
if node.focus_mode == Control.FOCUS_ALL:
print("Grabbing focus: %s" % node)
node.grab_focus()
func gui_input(event):
2019-09-30 20:15:00 +00:00
if event is InputEventKey and Input.is_action_just_pressed("ui_accept") and event.control and event.alt:
TTS.speak("click", false)
2019-09-30 20:15:00 +00:00
click()
elif event is InputEventKey and event.pressed and not event.echo and event.scancode == KEY_MENU:
node.get_tree().root.warp_mouse(node.rect_global_position)
return click(null, BUTTON_RIGHT)
2019-09-02 14:55:51 +00:00
if node is TabContainer:
return tab_container_input(event)
elif node is ItemList:
return item_list_input(event)
2018-07-19 20:12:01 +00:00
elif node is LineEdit:
return line_edit_input(event)
elif node is Tree:
if event.is_action_pressed("ui_up") or event.is_action_pressed("ui_down") or event.is_action_pressed("ui_left") or event.is_action_pressed("ui_right"):
node.accept_event()
return tree_input(event)
elif node.get_class() == "EditorInspectorSection":
return editor_inspector_section_input(event)
elif event.is_action_pressed("ui_left"):
return node.accept_event()
elif event.is_action_pressed("ui_right"):
return node.accept_event()
elif event.is_action_pressed("ui_up"):
return node.accept_event()
elif event.is_action_pressed("ui_down"):
return node.accept_event()
func is_in_bar():
var parent = node.get_parent()
if parent and parent is Container:
for child in parent.get_children():
if child and not is_focusable(child):
return false
return true
return false
func is_focusable(node):
if node.get_class() == "SceneTreeEditor":
return false
if node.get_class() == "MultiMeshEditor":
return false
if node.get_class() == "MeshInstanceEditor":
return false
if node.get_class() == "SpriteEditor":
return false
if node.get_class() == "Skeleton2DEditor":
return false
if node.get_class() == "CollisionShape2DEditor":
return false
if node is Panel:
return false
2019-09-03 22:43:20 +00:00
if node is TabContainer:
return true
if node.get_class() == "EditorInspectorSection":
return true
if node is Container or node is Separator or node is ScrollBar or node is Popup or node.get_class() == "Control":
2019-09-03 22:43:20 +00:00
return false
return true
func editor_inspector_section_focused():
var child = node.get_children()[0]
var expanded = child.is_visible_in_tree()
var tokens = PoolStringArray(["editor inspector section"])
if expanded:
tokens.append("expanded")
else:
tokens.append("collapsed")
TTS.speak(tokens.join(": "), false)
func editor_inspector_section_input(event):
if event.is_action_pressed("ui_accept"):
click()
var child = node.get_children()[0]
var expanded = child.is_visible_in_tree()
if expanded:
TTS.speak("expanded", true)
else:
TTS.speak("collapsed", true)
func _init(node):
if node.is_in_group("accessible"):
return
node.add_to_group("accessible")
self.node = node
if is_focusable(node):
2019-09-02 14:55:51 +00:00
node.set_focus_mode(Control.FOCUS_ALL)
node.connect("focus_entered", self, "focused")
node.connect("mouse_entered", self, "click_focused")
node.connect("focus_exited", self, "unfocused")
node.connect("mouse_exited", self, "unfocused")
2018-07-03 16:42:00 +00:00
node.connect("gui_input", self, "gui_input")
if node is CheckBox:
node.connect("toggled", self, "checkbox_toggled")
elif node is ItemList:
2019-09-02 12:04:45 +00:00
node.connect("item_selected", self, "item_list_item_selected")
node.connect("multi_selected", self, "item_list_multi_selected")
node.connect("nothing_selected", self, "item_list_nothing_selected")
elif node is LineEdit:
node.connect("text_changed", self, "line_edit_text_changed")
2018-07-19 20:12:01 +00:00
elif node is PopupMenu:
node.connect("id_focused", self, "popup_menu_item_id_focused")
2019-09-30 20:15:00 +00:00
node.connect("id_pressed", self, "popup_menu_item_id_pressed")
elif node is ProgressBar:
node.connect("value_changed", self, "progress_bar_value_changed")
elif node is TabContainer:
node.connect("tab_changed", self, "tab_container_tab_changed")
2018-07-19 17:02:40 +00:00
elif node is Tree:
node.connect("item_collapsed", self, "tree_item_collapsed")
node.connect("multi_selected", self, "tree_item_multi_selected")
2019-09-03 22:22:02 +00:00
if node.select_mode == Tree.SELECT_MULTI:
node.connect("cell_selected", self, "tree_item_selected")
else:
node.connect("item_selected", self, "tree_item_selected")
node.connect("tree_exiting", self, "free")