orca.scripts.self_voicing (version 1036, $Date$)
index
/usr/lib/python2.5/site-packages/orca/scripts/self_voicing.py

A script to do nothing.  This is for self-voicing apps.

 
Modules
       
orca

 
Classes
       
orca.script.Script
Script

 
class Script(orca.script.Script)
    A script to do nothing.  This is for self-voicing apps.
 
  Methods defined here:
__init__(self, app)
Creates a script for the given application, if necessary.
This method should not be called by anyone except the
focus_tracking_presenter.
 
Arguments:
- app: the Python Accessible application to create a script for
getBrailleGenerator(self)
Returns the braille generator for this script.
getSpeechGenerator(self)
Returns the speech generator for this script.
processBrailleEvent(self, brailleEvent)
Does nothing.
 
Arguments:
- brailleEvent: an instance of input_event.BrailleEvent
 
Returns False to indicate the event was not consumed.
processKeyboardEvent(self, keyboardEvent)
Does nothing.
 
Arguments:
- keyboardEvent: an instance of input_event.KeyboardEvent
 
Returns False to indicate the event was not consumed.
processObjectEvent(self, event)
Does nothing.
 
Arguments:
- event: the Event

Methods inherited from orca.script.Script:
consumesBrailleEvent(self, brailleEvent)
Called when a key is pressed on the braille display.
 
Arguments:
- brailleEvent: an instance of input_event.KeyboardEvent
 
Returns True if the event is of interest.
consumesKeyboardEvent(self, keyboardEvent)
Called when a key is pressed on the keyboard.
 
Arguments:
- keyboardEvent: an instance of input_event.KeyboardEvent
 
Returns True if the event is of interest.
getBrailleBindings(self)
Defines the braille bindings for this script.
 
Returns a dictionary where the keys are BrlTTY commands and the
values are InputEventHandler instances.
getBrailleCommandsForInputHandler(self, inputEventHandler)
Returns a list of BrlTTY commands (they're in braille.py) that
match the given inputEventHandler passed as argument.
 
Arguments:
- inputEventHandler: an instance of input_event.InputEventHandler
 
Returns a list (possibly empty) of BrlTTY commands (they're in
braille.py) that match the given inputEventHandler passed.
getKeyBindings(self)
Defines the key bindings for this script.
 
Returns an instance of keybindings.KeyBindings.
getKeyBindingsForInputHandler(self, inputEventHandler)
Returns a KeyBindings object with the list of KeyBindings that
matche the passed inputEventHandler as argument (at least the
inputEventHandler that has the same handler function)
 
Arguments:
- inputEventHandler: an instance of input_event.InputEventHandler
 
Returns an instance of keybindings.KeyBindings populated with
keybindings.KeyBinding instances that match the inputEventHandler.
getListeners(self)
Sets up the AT-SPI event listeners for this script.
 
Returns a dictionary where the keys are AT-SPI event names
and the values are script methods.
locusOfFocusChanged(self, event, oldLocusOfFocus, newLocusOfFocus)
Called when the visual object with focus changes.
 
The primary purpose of this method is to present locus of focus
information to the user.
 
NOTE: scripts should not call this method directly.  Instead,
a script should call orca.setLocusOfFocus, which will eventually
result in this method being called.
 
Arguments:
- event: if not None, the Event that caused the change
- oldLocusOfFocus: Accessible that is the old locus of focus
- newLocusOfFocus: Accessible that is the new locus of focus
setupInputEventHandlers(self)
Defines InputEventHandler fields for this script that can be
called by the key and braille bindings.
visualAppearanceChanged(self, event, obj)
Called when the visual appearance of an object changes.
This method should not be called for objects whose visual
appearance changes solely because of focus -- setLocusOfFocus
is used for that.  Instead, it is intended mostly for objects
whose notional 'value' has changed, such as a checkbox
changing state, a progress bar advancing, a slider moving,
text inserted, caret moved, etc.
 
The primary purpose of this method is to present the changed
information to the user.
 
NOTE: scripts should not call this method directly.  Instead,
a script should call orca.visualAppearanceChanged, which will
eventually result in this method being called.
 
Arguments:
- event: if not None, the Event that caused this to happen
- obj: the Accessible whose visual appearance changed.

 
Data
        __copyright__ = 'Copyright (c) 2005-2006 Sun Microsystems Inc.'
__date__ = '$Date$'
__id__ = '$Id$'
__license__ = 'LGPL'
__version__ = '$Revision$'