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

Utilities for obtaining braille strings for objects.  In general,
there probably should be a singleton instance of the BrailleGenerator
class.  For those wishing to override the braille generators, however,
one can create a new instance and replace/extend the braille
generators as they see fit.

 
Modules
       
orca.atspi
orca.braille
orca.debug
math
orca.orca_state
orca.rolenames
orca.settings
orca.util

 
Classes
       
BrailleGenerator

 
class BrailleGenerator
    Takes accessible objects and produces a list of braille Regions
for those objects.  See the getBrailleRegions method, which is the
primary entry point.  Subclasses can feel free to override/extend
the brailleGenerators instance field as they see fit.
 
  Methods defined here:
__init__(self, script)
getBrailleContext(self, obj)
Get the braille regions that describe the context (i.e.,
names/roles of the container hierarchy) of the object.
 
Arguments:
- obj: the object
 
Returns a list of Regions to display.
getBrailleRegions(self, obj, groupChildren=True)
Get the braille regions for an Accessible object.  This
will look first to the specific braille generators and then to
the default braille generator.  This method is the primary
method that external callers of this class should use.
 
Arguments:
- obj: the object
- groupChildren: if True, children of an object should be displayed
                 together with their parent, where each child is
                 separated by _ and the selected child is the Region
                 that should get focus.  The default here is True,
                 but this also is used in conjunction with
                 settings.enableBrailleGrouping.
 
Returns a list where the first element is a list of Regions to
display and the second element is the Region which should get
focus.

 
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.braillegenerator.html 5086 2007-03-12 20:23:35Z wwalker $'
__license__ = 'LGPL'
__version__ = '$Revision: 5086 $'