Current File : //lib/python3/dist-packages/orca/scripts/toolkits/Chromium/script.py
# Orca
#
# Copyright 2018-2019 Igalia, S.L.
#
# Author: Joanmarie Diggs <jdiggs@igalia.com>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the
# Free Software Foundation, Inc., Franklin Street, Fifth Floor,
# Boston MA 02110-1301 USA.
"""Custom script for Chromium."""
__id__ = "$Id$"
__version__ = "$Revision$"
__date__ = "$Date$"
__copyright__ = "Copyright (c) 2018-2019 Igalia, S.L."
__license__ = "LGPL"
from orca import debug
from orca import focus_manager
from orca.ax_component import AXComponent
from orca.ax_document import AXDocument
from orca.ax_object import AXObject
from orca.ax_utilities import AXUtilities
from orca.scripts import default
from orca.scripts import web
from .braille_generator import BrailleGenerator
from .script_utilities import Utilities
from .speech_generator import SpeechGenerator
class Script(web.Script):
def __init__(self, app):
super().__init__(app)
self.presentIfInactive = False
def getBrailleGenerator(self):
"""Returns the braille generator for this script."""
return BrailleGenerator(self)
def getSpeechGenerator(self):
"""Returns the speech generator for this script."""
return SpeechGenerator(self)
def getUtilities(self):
"""Returns the utilities for this script."""
return Utilities(self)
def locusOfFocusChanged(self, event, oldFocus, newFocus):
"""Handles changes of focus of interest to the script."""
if super().locusOfFocusChanged(event, oldFocus, newFocus):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.locusOfFocusChanged(self, event, oldFocus, newFocus)
def onActiveChanged(self, event):
"""Callback for object:state-changed:active accessibility events."""
if super().onActiveChanged(event):
return
if event.detail1 and AXUtilities.is_frame(event.source) \
and not focus_manager.getManager().can_be_active_window(event.source):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onActiveChanged(self, event)
def onActiveDescendantChanged(self, event):
"""Callback for object:active-descendant-changed accessibility events."""
if super().onActiveDescendantChanged(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onActiveDescendantChanged(self, event)
def onBusyChanged(self, event):
"""Callback for object:state-changed:busy accessibility events."""
if AXComponent.has_no_size(event.source):
msg = "CHROMIUM: Ignoring event from page with no size."
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if not AXDocument.get_uri(event.source):
msg = "CHROMIUM: Ignoring event from page with no URI."
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if super().onBusyChanged(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onBusyChanged(self, event)
def onCaretMoved(self, event):
"""Callback for object:text-caret-moved accessibility events."""
if self.utilities.isStaticTextLeaf(event.source):
msg = "CHROMIUM: Ignoring event from static-text leaf"
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if self.utilities.isRedundantAutocompleteEvent(event):
msg = "CHROMIUM: Ignoring redundant autocomplete event"
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if super().onCaretMoved(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onCaretMoved(self, event)
def onCheckedChanged(self, event):
"""Callback for object:state-changed:checked accessibility events."""
if super().onCheckedChanged(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onCheckedChanged(self, event)
def onColumnReordered(self, event):
"""Callback for object:column-reordered accessibility events."""
if super().onColumnReordered(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onColumnReordered(self, event)
def onChildrenAdded(self, event):
"""Callback for object:children-changed:add accessibility events."""
if self.utilities.isStaticTextLeaf(event.any_data):
msg = "CHROMIUM: Ignoring because child is static text leaf"
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if super().onChildrenAdded(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onChildrenAdded(self, event)
def onChildrenRemoved(self, event):
"""Callback for object:children-changed:removed accessibility events."""
if self.utilities.isStaticTextLeaf(event.any_data):
msg = "CHROMIUM: Ignoring because child is static text leaf"
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if super().onChildrenRemoved(event):
return
msg = "Chromium: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onChildrenRemoved(self, event)
def onDocumentLoadComplete(self, event):
"""Callback for document:load-complete accessibility events."""
if not AXDocument.get_uri(event.source):
msg = "CHROMIUM: Ignoring event from page with no URI."
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if super().onDocumentLoadComplete(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onDocumentLoadComplete(self, event)
def onDocumentLoadStopped(self, event):
"""Callback for document:load-stopped accessibility events."""
if not AXDocument.get_uri(event.source):
msg = "CHROMIUM: Ignoring event from page with no URI."
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if super().onDocumentLoadStopped(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onDocumentLoadStopped(self, event)
def onDocumentReload(self, event):
"""Callback for document:reload accessibility events."""
if not AXDocument.get_uri(event.source):
msg = "CHROMIUM: Ignoring event from page with no URI."
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if super().onDocumentReload(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onDocumentReload(self, event)
def onExpandedChanged(self, event):
"""Callback for object:state-changed:expanded accessibility events."""
if super().onExpandedChanged(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onExpandedChanged(self, event)
def onFocus(self, event):
"""Callback for focus: accessibility events."""
# This event is deprecated. We should get object:state-changed:focused
# events instead.
if super().onFocus(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onFocus(self, event)
def onFocusedChanged(self, event):
"""Callback for object:state-changed:focused accessibility events."""
if self.utilities.isDocument(event.source) \
and not AXDocument.get_uri(event.source):
msg = "CHROMIUM: Ignoring event from document with no URI."
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if super().onFocusedChanged(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onFocusedChanged(self, event)
def onMouseButton(self, event):
"""Callback for mouse:button accessibility events."""
if super().onMouseButton(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onMouseButton(self, event)
def onNameChanged(self, event):
"""Callback for object:property-change:accessible-name events."""
if super().onNameChanged(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onNameChanged(self, event)
def onRowReordered(self, event):
"""Callback for object:row-reordered accessibility events."""
if super().onRowReordered(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onRowReordered(self, event)
def onSelectedChanged(self, event):
"""Callback for object:state-changed:selected accessibility events."""
if super().onSelectedChanged(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onSelectedChanged(self, event)
def onSelectionChanged(self, event):
"""Callback for object:selection-changed accessibility events."""
if super().onSelectionChanged(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onSelectionChanged(self, event)
def onShowingChanged(self, event):
"""Callback for object:state-changed:showing accessibility events."""
if super().onShowingChanged(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onShowingChanged(self, event)
def onTextAttributesChanged(self, event):
"""Callback for object:text-attributes-changed accessibility events."""
if super().onTextAttributesChanged(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onTextAttributesChanged(self, event)
def onTextDeleted(self, event):
"""Callback for object:text-changed:delete accessibility events."""
if super().onTextDeleted(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onTextDeleted(self, event)
def onTextInserted(self, event):
"""Callback for object:text-changed:insert accessibility events."""
if super().onTextInserted(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onTextInserted(self, event)
def onTextSelectionChanged(self, event):
"""Callback for object:text-selection-changed accessibility events."""
if self.utilities.isStaticTextLeaf(event.source):
msg = "CHROMIUM: Ignoring event from static-text leaf"
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if self.utilities.isListItemMarker(event.source):
msg = "CHROMIUM: Ignoring event from list item marker"
debug.printMessage(debug.LEVEL_INFO, msg, True)
return
if super().onTextSelectionChanged(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onTextSelectionChanged(self, event)
def onWindowActivated(self, event):
"""Callback for window:activate accessibility events."""
if not focus_manager.getManager().can_be_active_window(event.source):
return
# If this is a frame for a popup menu, we don't want to treat
# it like a proper window:activate event because it's not as
# far as the end-user experience is concerned.
menu = self.utilities.popupMenuForFrame(event.source)
if menu:
focus_manager.getManager().set_active_window(event.source)
activeItem = None
selected = self.utilities.selectedChildren(menu)
if len(selected) == 1:
activeItem = selected[0]
if activeItem:
# If this is the popup menu for the locusOfFocus, we don't want to
# present the popup menu as part of the new ancestry of activeItem.
if self.utilities.isPopupMenuForCurrentItem(menu):
focus_manager.getManager().set_locus_of_focus(event, menu, False)
tokens = ["CHROMIUM: Setting locusOfFocus to active item", activeItem]
debug.printTokens(debug.LEVEL_INFO, tokens, True)
focus_manager.getManager().set_locus_of_focus(event, activeItem)
return
tokens = ["CHROMIUM: Setting locusOfFocus to popup menu", menu]
debug.printTokens(debug.LEVEL_INFO, tokens, True)
focus_manager.getManager().set_locus_of_focus(event, menu)
if super().onWindowActivated(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onWindowActivated(self, event)
# Right now we don't get accessibility events for alerts which are
# already showing at the time of window activation. If that changes,
# we should store presented alerts so we don't double-present them.
for child in AXObject.iter_children(event.source):
if AXUtilities.is_alert(child):
self.presentObject(child)
def onWindowDeactivated(self, event):
"""Callback for window:deactivate accessibility events."""
if super().onWindowDeactivated(event):
return
msg = "CHROMIUM: Passing along event to default script"
debug.printMessage(debug.LEVEL_INFO, msg, True)
default.Script.onWindowDeactivated(self, event)
Mini Shell