def _printBrailleEvent(level, command):
"""Prints out a Braille event. The given level may be overridden
if the eventDebugLevel (see debug.setEventDebugLevel) is greater in
debug.py.
Arguments:
- command: the BrlAPI command for the key that was pressed.
"""
debug.printInputEvent(
level,
"BRAILLE EVENT: %x" % command)
def _processKeyboardEvent(event):
"""The primary key event handler for Orca. Keeps track of various
attributes, such as the lastInputEvent. Also calls keyEcho as well
as any local keybindings before passing the event on to the active
presentation manager. This method is called synchronously from the
AT-SPI registry and should be performant. In addition, it
must return True if it has consumed the event (and False if not).
Arguments:
- event: an AT-SPI DeviceEvent
Returns True if the event should be consumed.
"""
global _orcaModifierPressed
orca_state.lastInputEventTimestamp = event.timestamp
# Log the keyboard event for future playback, if desired.
# Note here that the key event_string being output is
# exactly what we received. The KeyboardEvent object,
# however, will translate the event_string for control
# characters to their upper case ASCII equivalent.
#
string = atspi.KeystrokeListener.keyEventToString(event)
if _recordingKeystrokes and _keystrokesFile \
and (event.event_string != "Pause") \
and (event.event_string != "F21"):
_keystrokesFile.write(string + "\n")
debug.printInputEvent(debug.LEVEL_FINE, string)
keyboardEvent = KeyboardEvent(event)
# See if this is one of our special Orca modifier keys.
#
# [[[TODO: WDW - Note that just looking at the keycode should
# suffice, but there is a "feature" in the Java Access Bridge
# where it chooses to emit Java platform-independent keycodes
# instead of the keycodes for the base platform:
#
# http://bugzilla.gnome.org/show_bug.cgi?id=106004
# http://bugzilla.gnome.org/show_bug.cgi?id=318615
#
# So...we need to workaround this problem.
#
# If you make the following expression True we will get a positive
# match for all keysyms associated with a given keysym specified
# as an Orca modifier key.
#
# For example, assume the Orca modifier is set to \ for some
# reason. The key that has \ on it produces \ without the Shift
# key and | with the Shift key. If the following expression is
# True, both the \ and | will be viewed as the Orca modifier. If
# the following expression is False, only the \ will be viewed as
# the Orca modifier (i.e., Shift+\ will still function as the |
# character). In general, I think we want to avoid sucking in all
# possible keysyms because it can have unexpected results.]]]
#
if False:
allPossibleKeysyms = []
for keysym in settings.orcaModifierKeys:
allPossibleKeysyms.extend(keybindings.getAllKeysyms(keysym))
else:
allPossibleKeysyms = settings.orcaModifierKeys
isOrcaModifier = allPossibleKeysyms.count(keyboardEvent.event_string) > 0
if event.type == atspi.Accessibility.KEY_PRESSED_EVENT:
# Key presses always interrupt speech.
#
speech.stop()
# If learn mode is enabled, it will echo the keys.
#
if not settings.learnModeEnabled:
_keyEcho(keyboardEvent)
# We treat the Insert key as a modifier - so just swallow it and
# set our internal state.
#
if isOrcaModifier:
_orcaModifierPressed = True
elif isOrcaModifier \
and (keyboardEvent.type == atspi.Accessibility.KEY_RELEASED_EVENT):
_orcaModifierPressed = False
if _orcaModifierPressed:
keyboardEvent.modifiers = keyboardEvent.modifiers \
| (1 << settings.MODIFIER_ORCA)
# Orca gets first stab at the event. Then, the presenter gets
# a shot. [[[TODO: WDW - might want to let the presenter try first?
# The main reason this is staying as is is that we may not want
# scripts to override fundamental Orca key bindings.]]]
#
consumed = False
try:
if orca_state.capturingKeys:
_processKeyCaptured(keyboardEvent)
else:
consumed = _keyBindings.consumeKeyboardEvent(None, keyboardEvent)
if (not consumed) and (_currentPresentationManager >= 0):
consumed = _PRESENTATION_MANAGERS[_currentPresentationManager].\
processKeyboardEvent(keyboardEvent)
if (not consumed) and settings.learnModeEnabled:
if keyboardEvent.type \
== atspi.Accessibility.KEY_PRESSED_EVENT:
clickCount = orca_state.activeScript.getClickCount(\
orca_state.lastInputEvent,
keyboardEvent)
if clickCount == 2:
orca_state.activeScript.phoneticSpellCurrentItem(\
keyboardEvent.event_string)
else:
# Check to see if there are localized words to be
# spoken for this key event.
#
braille.displayMessage(keyboardEvent.event_string)
event_string = keyboardEvent.event_string
event_string = keynames.getKeyName(event_string)
speech.speak(event_string)
consumed = True
except:
debug.printException(debug.LEVEL_SEVERE)
orca_state.lastInputEvent = keyboardEvent
# If this is a key event for a non-modifier key, save a handle to it.
# This is needed to help determine user actions when a multi-key chord
# has been pressed, and we might get the key events in different orders.
# See comment #15 of bug #435201 for more details.
#
if not _isModifierKey(keyboardEvent.event_string):
orca_state.lastNonModifierKeyEvent = keyboardEvent
return consumed or isOrcaModifier
def _processKeyboardEvent(event):
"""The primary key event handler for Orca. Keeps track of various
attributes, such as the lastInputEvent. Also calls keyEcho as well
as any local keybindings before passing the event on to the active
presentation manager. This method is called synchronously from the
AT-SPI registry and should be performant. In addition, it
must return True if it has consumed the event (and False if not).
Arguments:
- event: an AT-SPI DeviceEvent
Returns True if the event should be consumed.
"""
global _orcaModifierPressed
orca_state.lastInputEventTimestamp = event.timestamp
# Log the keyboard event for future playback, if desired.
# Note here that the key event_string being output is
# exactly what we received. The KeyboardEvent object,
# however, will translate the event_string for control
# characters to their upper case ASCII equivalent.
#
string = atspi.KeystrokeListener.keyEventToString(event)
if _recordingKeystrokes and _keystrokesFile \
and (event.event_string != "Pause") \
and (event.event_string != "F21"):
_keystrokesFile.write(string + "\n")
debug.printInputEvent(debug.LEVEL_FINE, string)
keyboardEvent = KeyboardEvent(event)
# See if this is one of our special Orca modifier keys.
#
# [[[TODO: WDW - Note that just looking at the keycode should
# suffice, but there is a "feature" in the Java Access Bridge
# where it chooses to emit Java platform-independent keycodes
# instead of the keycodes for the base platform:
#
# http://bugzilla.gnome.org/show_bug.cgi?id=106004
# http://bugzilla.gnome.org/show_bug.cgi?id=318615
#
# So...we need to workaround this problem.
#
# If you make the following expression True we will get a positive
# match for all keysyms associated with a given keysym specified
# as an Orca modifier key.
#
# For example, assume the Orca modifier is set to \ for some
# reason. The key that has \ on it produces \ without the Shift
# key and | with the Shift key. If the following expression is
# True, both the \ and | will be viewed as the Orca modifier. If
# the following expression is False, only the \ will be viewed as
# the Orca modifier (i.e., Shift+\ will still function as the |
# character). In general, I think we want to avoid sucking in all
# possible keysyms because it can have unexpected results.]]]
#
if False:
allPossibleKeysyms = []
for keysym in settings.orcaModifierKeys:
allPossibleKeysyms.extend(keybindings.getAllKeysyms(keysym))
else:
allPossibleKeysyms = settings.orcaModifierKeys
isOrcaModifier = allPossibleKeysyms.count(keyboardEvent.event_string) > 0
if event.type == atspi.Accessibility.KEY_PRESSED_EVENT:
# Key presses always interrupt speech.
#
speech.stop()
# If learn mode is enabled, it will echo the keys.
#
if not settings.learnModeEnabled:
_keyEcho(keyboardEvent)
# We treat the Insert key as a modifier - so just swallow it and
# set our internal state.
#
if isOrcaModifier:
_orcaModifierPressed = True
elif isOrcaModifier \
and (keyboardEvent.type == atspi.Accessibility.KEY_RELEASED_EVENT):
_orcaModifierPressed = False
if _orcaModifierPressed:
keyboardEvent.modifiers = keyboardEvent.modifiers \
| (1 << settings.MODIFIER_ORCA)
# Orca gets first stab at the event. Then, the presenter gets
# a shot. [[[TODO: WDW - might want to let the presenter try first?
# The main reason this is staying as is is that we may not want
# scripts to override fundamental Orca key bindings.]]]
#
consumed = False
try:
if orca_state.capturingKeys:
_processKeyCaptured(keyboardEvent)
else:
consumed = _keyBindings.consumeKeyboardEvent(None, keyboardEvent)
if (not consumed) and (_currentPresentationManager >= 0):
consumed = _PRESENTATION_MANAGERS[_currentPresentationManager].\
processKeyboardEvent(keyboardEvent)
if (not consumed) and settings.learnModeEnabled:
if keyboardEvent.type \
== atspi.Accessibility.KEY_PRESSED_EVENT:
clickCount = orca_state.activeScript.getClickCount(\
orca_state.lastInputEvent,
keyboardEvent)
if clickCount == 2:
orca_state.activeScript.phoneticSpellCurrentItem(\
keyboardEvent.event_string)
else:
# Check to see if there are localized words to be
# spoken for this key event.
#
braille.displayMessage(keyboardEvent.event_string)
event_string = keyboardEvent.event_string
event_string = keynames.getKeyName(event_string)
speech.speak(event_string)
consumed = True
except:
debug.printException(debug.LEVEL_SEVERE)
orca_state.lastInputEvent = keyboardEvent
# If this is a key event for a non-modifier key, save a handle to it.
# This is needed to help determine user actions when a multi-key chord
# has been pressed, and we might get the key events in different orders.
# See comment #15 of bug #435201 for more details.
#
if not _isModifierKey(keyboardEvent.event_string):
orca_state.lastNonModifierKeyEvent = keyboardEvent
return consumed or isOrcaModifier
