orca.hierarchical_presenter (version 1036, $Date: 2007-03-12 16:23:35 -0400 (Mon, 12 Mar 2007) $)
index
/usr/lib/python2.5/site-packages/orca/hierarchical_presenter.py

Provides an experimental hierarchical navigation presentation
manager for Orca.  This is mostly for exploratory purposes.

 
Modules
       
orca.atspi
orca.braille
orca.debug
orca.presentation_manager
orca.speech
orca.util

 
Classes
       
orca.presentation_manager.PresentationManager
HierarchicalPresenter

 
class HierarchicalPresenter(orca.presentation_manager.PresentationManager)
    When activated, this module consumes all keyboard events (or at
least those not already consumed by the main orca module) and uses the
arrow and tab keys for navigation.  The main concepts for navigation
include:
 
  Perceive the component hierarchy as being displayed in a list,
  much like a tree view.
 
  Use the up/down arrow keys to go between the children of a
  parent.  When the first/last child is reached, the navigation
  will not wrap.
 
  Use the left/right arrow keys to go to the parent of a child or
  to the first child of a parent.
 
  Use the Tab key to explore the AT-SPI specializations (e.g.,
  action, component, text, etc.) of a child.  The up/down arrow
  keys will take you between the specializations that the child
  implements.  If the child does not implement any specializations,
  Tab will not do anything.
 
  To go back to hierarchical navigation from specialization
  exploration mode, press Shift+Tab.
 
Again, this is very experimental and is designed more for script
writers than end users.
 
  Methods defined here:
__init__(self)
activate(self)
Called when this presentation manager is activated.
deactivate(self)
Called when this presentation manager is deactivated.
processKeyboardEvent(self, keyboardEvent)
Processes the given keyboard event based on the keybinding from the
currently active script. 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:
- keyboardEvent: an instance of input_event.KeyboardEvent
 
Returns True if the event should be consumed.

Methods inherited from orca.presentation_manager.PresentationManager:
locusOfFocusChanged(self, event, oldLocusOfFocus, newLocusOfFocus)
Called when the visual object with focus changes.
 
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
processBrailleEvent(self, brailleEvent)
Called when keys or buttons are pressed on the Braille display.
 
Arguments:
- brailleEvent: an instance of input_event.BrailleEvent
 
Returns True if the command was consumed; otherwise False
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 -- locusOfFocusChanged
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.
 
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: 2007-03-12 16:23:35 -0400 (Mon, 12 Mar 2007) $'
__id__ = '$Id: orca.hierarchical_presenter.html 5086 2007-03-12 20:23:35Z wwalker $'
__license__ = 'LGPL'
__version__ = '$Revision: 5086 $'