Module Hierarchy

• A11yChooser: Defines a gtk dialog with a yes/no option for enabling desktop accessibility.
• AccessEngine
  • AccessEngine.AEAccAdapter: Defines machinery for stating interfaces and adapting objects to those interfaces on demand.
  • AccessEngine.AEAccAdapters: Defines AEAccAdapters for objects in accessibility toolkits to the AEAccAdapter.Interfaces declared in AEAccInterfaces.
    • AccessEngine.AEAccAdapters.ATSPI
      • AccessEngine.AEAccAdapters.ATSPI.ComboboxAdapter: Defines AEAccAdapter.AEAccAdapters for combo boxes that receive the focus but have children that fire events.
      • AccessEngine.AEAccAdapters.ATSPI.ContainerAdapter: Defines AEAccAdapter.AEAccAdapters for AT-SPI accessibles that manage their descendants.
      • AccessEngine.AEAccAdapters.ATSPI.DefaultAction: Defines default AEAccAdapter.AEAccAdapters for the AEAccInterfaces.IAccessibleAction interface on pyatspi.Accessibility.Accessible objects.
      • AccessEngine.AEAccAdapters.ATSPI.DefaultEventHandler: Defines default AEAccAdapter.AEAccAdapters for the AEAccInterfaces.IEventHandler interface on pyatspi.Accessibility.Accessible objects.
      • AccessEngine.AEAccAdapters.ATSPI.DefaultInfo: Defines default AEAccAdapters for the AEAccInterfaces.IAccessibleInfo interface on pyatspi.Accessibility.Accessible objects.
      • AccessEngine.AEAccAdapters.ATSPI.DefaultNav: Defines default AEAccAdapter.AEAccAdapters for the AEAccInterfaces.IAccessibleNav and AEAccInterfaces.IItemNav interfaces on AEPor.AEPor objects.
      • AccessEngine.AEAccAdapters.ATSPI.HypertextAdapter: Defines AEAccAdapter.AEAccAdapters for AT-SPI hypertext accessibles potentially containing embedded objects.
      • AccessEngine.AEAccAdapters.ATSPI.ImageAdapter: Defines an AEAccAdapter.AEAccAdapters for the AEAccInterfaces.IAccessibleInfo interface to report text information about images.
      • AccessEngine.AEAccAdapters.ATSPI.PopupAdapter: Defines an AEAccAdapter.AEAccAdapters for the AEAccInterfaces.IAccessibleInfo interface to correct for the problem of pop-up items (e.g menus) always having states visible and showing after having been activated once.
      • AccessEngine.AEAccAdapters.ATSPI.TableAdapter: Defines AEAccAdapter.AEAccAdapters for AT-SPI table accessibles.
      • AccessEngine.AEAccAdapters.ATSPI.TreeAdapter: Defines AEAccAdapter.AEAccAdapters for AT-SPI tree accessibles.
  • AccessEngine.AEAccInterfaces: Defines standard interfaces for inspecting, manipulating, and navigating accessibles and handling their events.
  • AccessEngine.AEChooser: Defines the base class for all choosers in SUE.
  • AccessEngine.AEConstants: Wraps all global constants in a convenient package.
    • AccessEngine.AEConstants.API: AccessEngineAPI related constants.
    • AccessEngine.AEConstants.Color: Color related constants.
    • AccessEngine.AEConstants.Event: AEEvent related constants.
    • AccessEngine.AEConstants.Input: Input related constants.
    • AccessEngine.AEConstants.Output: Output related constants.
    • AccessEngine.AEConstants.Parsing: Word parsing related constants.
    • AccessEngine.AEConstants.Semantic: Semantic tag constants.
    • AccessEngine.AEConstants.Spelling: Spelling constants.
  • AccessEngine.AEDevice
    • AccessEngine.AEDevice.AEDeviceEvent
    • AccessEngine.AEDevice.AEInput: Defines abstract classes representing the interfaces that must be implemented by an input device for SUE.
      • AccessEngine.AEDevice.AEInput.AEInputError: Defines a hierarchy of AEInput exceptions that are raised when some device operation fails.
      • AccessEngine.AEDevice.AEInput.Base: Defines the abstract base class for all AEInput subclasses.
      • AccessEngine.AEDevice.AEInput.Gesture: Defines a class representing an input Gesture, one or more device specific input actions (e.g.
      • AccessEngine.AEDevice.AEInput.GestureList: Defines a class representing a collection of Gestures performed in sequence on an AEInput device.
      • AccessEngine.AEDevice.AEInput.SystemInput: Defines an abstract base class for all input devices that serve double duty as sources of input for SUE and for the rest of the operating system.
    • AccessEngine.AEDevice.AEOutput: Defines abstract classes representing the interfaces that must be implemented by an output device for SUE.
      • AccessEngine.AEDevice.AEOutput.AEOutputError: Defines a hierarchy of AEOutput exceptions that are raised when some device operation fails.
      • AccessEngine.AEDevice.AEOutput.Base: Defines the base class for all AEOutput devices.
      • AccessEngine.AEDevice.AEOutput.Style: Defines classes for representing device capabilities and styles.
      • AccessEngine.AEDevice.AEOutput.Word: Defines classes and functions for parsing bodies of text to find words and prepare them for output to the user.
  • AccessEngine.AEDeviceManager': Defines a class responsible for managing all input and output devices and monitors.
  • AccessEngine.AEEvent: Defines internal AEEvents and their execution logic.
    • AccessEngine.AEEvent.Base: Defines the base class for all AccessEngine events (AEEvents).
    • AccessEngine.AEEvent.CaretChange: Defines an AEEvent indicating that the caret has moved.
    • AccessEngine.AEEvent.ChildrenChange: Defines an AEEvent indicating that a child has been added/removed to an accessible.
    • AccessEngine.AEEvent.ChooserChange: Defines an AEEvent indicating an event of interest occurred in an AEChooser.
    • AccessEngine.AEEvent.FocusChange: Defines an AEEvent indicating that the focus has changed.
    • AccessEngine.AEEvent.InputGesture: Defines an AEEvent indicating a gesture has been performed on an AEInput device.
    • AccessEngine.AEEvent.MouseChange: Defines an AEEvent indicating that a mouse event occurred.
    • AccessEngine.AEEvent.PrivateChange: Defines an AEEvent encapsulating arbitrary private data intended to be consumed by the AETierManager or AETier, but not passed on to AEScripts or Tasks.
    • AccessEngine.AEEvent.PropertyChange: Defines an AEEvent indicating that a simple property (text, numeric) of an accessible changed.
    • AccessEngine.AEEvent.ScreenChange: Defines an AEEvent indicating that the selector has moved.
    • AccessEngine.AEEvent.SelectorChange: Defines an AEEvent indicating that the selector has moved.
    • AccessEngine.AEEvent.StateChange: Defines an AEEvent indicating that the state of an accessible or an item changed.
    • AccessEngine.AEEvent.TableChange: Defines an AEEvent indicating that a table has had a row or column added or deleted, or has been reordered.
    • AccessEngine.AEEvent.TimerAlert: Defines an AEEvent indicating a timer event occurred.
    • AccessEngine.AEEvent.ViewChange: Defines an AEEvent indicating the view has been updated by the AEViewManager.
  • AccessEngine.AEEventManager': Defines a class that uses a binding to the accessible platform and supports AEEvents.
  • AccessEngine.AELog: Defines a function for configuring the standard Python logging module, a class that redirects print statements through the configured logging system, and a class that defines a logging handler using XML-RPC as the transport.
  • AccessEngine.AEMain': Defines AEMain which runs the main program loop.
  • AccessEngine.AEMonitor: Defines abstract classes representing the interfaces that must be implemented by a monitor for SUE.
    • AccessEngine.AEMonitor.Base: Defines the abstract base class for all AEMonitor subclasses.
    • AccessEngine.AEMonitor.MonitorCollection: Defines a convenience collection that can be used to notify all AEMonitors of a certain event.
  • AccessEngine.AEPor: Defines a class for storing point-of-regard information.
  • AccessEngine.AERegistrar: Defines the registrar functions responsible for managing an on-disk repository of User Interface Elements (UIEs) that define the AEScripts, Devices, Choosers, and Monitors available to the user and the system.
  • AccessEngine.AEScript: Defines an AEScript class that can register tasks which will be executed in response to AEEvents and AEInput.Gestures.
  • AccessEngine.AESettingsManager': Defines a class responsible for managing the saving and loading of settings from disk.
  • AccessEngine.AEState: Defines abstract classes representing the interfaces that must be implemented by objects that need to be configurable by the user and/or persisted on disk.
    • AccessEngine.AEState.Base: Defines an abstract base class for all persistent and/or configurable setting classes.
    • AccessEngine.AEState.Setting: Defines a class representing a configurable setting in a AEState object.
  • AccessEngine.AETier: Defines a class for managing the AEScripts loaded for a single instance of an application.
  • AccessEngine.AETierManager': Defines a class responsible for managing all AETiers.
  • AccessEngine.AEUserInterface: Defines the base class for all user interface elements (UIEs).
  • AccessEngine.AEViewManager': Defines a class responsible for handling events in the currently focused view.
  • AccessEngine.AEWalkers: Defines classes for navigating over the accessible hierarchy in various orders.
    • AccessEngine.AEWalkers.AccessibleItemWalker: Defines a class unifying navigation over all accessibles and their items.
    • AccessEngine.AEWalkers.AccessibleWalker: Defines a class that provides a "raw" walk of all accessibles in the hiearchy.
    • AccessEngine.AEWalkers.Base: Defines an abstract base class acting as an interface for all walkers.
  • AccessEngine.AccessEngineAPI: Defines the AccessEngineAPI available to tasks and AEScripts at runtime.
    • AccessEngine.AccessEngineAPI.AEApiError: Defines a hierarchy of AccessEngineAPI exceptions that are raised in tools methods.
    • AccessEngine.AccessEngineAPI.Input: Defines methods for getting input on any AEInput device.
    • AccessEngine.AccessEngineAPI.Output: Defines AccessEngineAPI for doing output.
    • AccessEngine.AccessEngineAPI.System: Defines AccessEngineAPI for manging AETiers and AEScripts.
    • AccessEngine.AccessEngineAPI.Utils: Provides utility methods that assist AEScript developers in processing accessibility information, but do not touch accessible objects, do output, handle input, manage the SUE system, etc.
    • AccessEngine.AccessEngineAPI.View: Defines AccessEngineAPI for navigating within an application and inspecting and manipulating its accessible objects.
• AccessEngine.AEAccAdapters.ATSPI.ComboboxAdapter: Defines AEAccAdapter.AEAccAdapters for combo boxes that receive the focus but have children that fire events.
• AccessEngine.AEAccAdapters.ATSPI.ContainerAdapter: Defines AEAccAdapter.AEAccAdapters for AT-SPI accessibles that manage their descendants.
• AccessEngine.AEAccAdapters.ATSPI.DefaultAction: Defines default AEAccAdapter.AEAccAdapters for the AEAccInterfaces.IAccessibleAction interface on pyatspi.Accessibility.Accessible objects.
• AccessEngine.AEAccAdapters.ATSPI.DefaultEventHandler: Defines default AEAccAdapter.AEAccAdapters for the AEAccInterfaces.IEventHandler interface on pyatspi.Accessibility.Accessible objects.
• AccessEngine.AEAccAdapters.ATSPI.DefaultInfo: Defines default AEAccAdapters for the AEAccInterfaces.IAccessibleInfo interface on pyatspi.Accessibility.Accessible objects.
• AccessEngine.AEAccAdapters.ATSPI.DefaultNav: Defines default AEAccAdapter.AEAccAdapters for the AEAccInterfaces.IAccessibleNav and AEAccInterfaces.IItemNav interfaces on AEPor.AEPor objects.
• AccessEngine.AEAccAdapters.ATSPI.HypertextAdapter: Defines AEAccAdapter.AEAccAdapters for AT-SPI hypertext accessibles potentially containing embedded objects.
• AccessEngine.AEAccAdapters.ATSPI.ImageAdapter: Defines an AEAccAdapter.AEAccAdapters for the AEAccInterfaces.IAccessibleInfo interface to report text information about images.
• AccessEngine.AEAccAdapters.ATSPI.PopupAdapter: Defines an AEAccAdapter.AEAccAdapters for the AEAccInterfaces.IAccessibleInfo interface to correct for the problem of pop-up items (e.g menus) always having states visible and showing after having been activated once.
• AccessEngine.AEAccAdapters.ATSPI.TableAdapter: Defines AEAccAdapter.AEAccAdapters for AT-SPI table accessibles.
• AccessEngine.AEAccAdapters.ATSPI.TreeAdapter: Defines AEAccAdapter.AEAccAdapters for AT-SPI tree accessibles.
• Audio: Defines the base class for all audio output devices.
• BasicBrailleScript: Provides basic Braille services.
• BasicMagScript: Provides basic magnification services.
• BasicSpeechScript: Provides basic speech services and speech reports common to a screen reader.
• BookmarkScript: Defines a AEScript that keeps track of user assigned bookmarks to AEPors in an application.
• Braille: Defines the base class for all Braille output devices.
• BrailleMonitor: This device provides a little Gtk window to monitor braille output onscreen.
• BrlAPIDevice: This device provides the braille interface to brlapi (brltty)
• CommandChooser: Defines a gtk window AEChooser showing a list of all available key commands.
• DefaultDialogScript: Defines tasks for managing the chooser dialogs packaged with the SUE core.
• DeveloperScript: Defines tools for assisting AEScript developers.
• EspeakSpeech: Defines a class that subclasses GSpeech to support the Espeak speech engine via gnome-speech.
• EvolutionScript: A customize script for the Evolution E-Mail client.
• FirefoxScript: Defines a AEScript for the Firefox web browser.
• GCalcScript: Defines a special AEScript for the Calculator GCalc.
• GEditScript: Defines a special AEScript for the text editor gedit.
• GKeybindingScript: A special AEScript for handling GKeybinding.
• GPanelScript: Defines a special AEScript for the GNOME-Panel.
• GSpeech: Contains the GSpeech abstract base class which provides support for all gnome-speech devices.
• GTKEventDialog: Defines a gtk dialog for buffering AEMonitor data.
• GTKUIEView: Defines reusable gtk widgets for ordering AEUserInterfaces and setting them to load or not load at runtime.
• GTerminalScript: Defines a special AEScript for the GNOME Terminal.
• GaimScript: Defines a user interface for gaim.
• GdmScript: Defines a special AEScript for the gdm login screen.
• GnomeMagDevice: This device drives the Gnome Magnifier (magnifier).
• IOMonitor: Defines a GTK dialog for buffering AEEvents and how AEScripts and tasks handle them.
• Keyboard: Defines a class representing a standard Keyboard input device and action code constants used to register filters on that device.
• LanguageScript: Allows a user to switch between up to three languages of their choosing as supported by the current speech engine.
• MetacityScript: Defines a special AEScript for the metacity desktop and app switcher.
• NotificationScript
• PidginScript: Defines a user interface for pidgin.
• RawEventMonitor: Defines a GTK dialog for buffering pyatspi events.
• ReviewScript: Provides review commands for traversing items, words, and characters.
• SUEConstants: Wraps all SUE specific constants in a convenient package.
  • SUEConstants.Help: Help message constants.
  • SUEConstants.Platform: Platform specific constants.
  • SUEConstants.Profile: Profile constants.
• SUEMain: Defines the main function which parses command line arguments and acts on them.
• SUEState: Defines the possible settings for SUE.
• ScriptChooser: Defines a gtk dialog AEChooser for loading/unloading AccessEngine.AEScripts from a single AETier at runtime.
• SearchChooser: Defines a gtk dialog AEChooser for searching for a given accessible in the current view.
• SearchScript: Defines a AEScript for searching through accessible tree.
• SettingsChooser: Defines a gtk dialog AEChooser for configuring SUE scripts, devices, profiles, and system settings.
• SueScript: General SUE script.
• TaskMonitor: Defines a GTK dialog for buffering AEEvents and how AEScripts and tasks handle them.
• TestLogMonitor: Defines the abstract base class for all AEMonitor subclasses.
• ThreadProxy: Defines a threaded proxy for Devices.Audio devices.
• Tools
  • Tools.Atk: Defines convenience methods for using Gnome ATK/GAIL accessibility platform, using the atk.py bindings.
  • Tools.i18n: Provides support for the internationalization of SUE using the python gettext module.
• UpdateNotifierScript: Defines a AEScript for the Update Notifier.