AccessEngine

Package AccessEngine

Author: Ramona Bunk

Organization: IT Science Center Ruegen gGmbH, Germany

License: The BSD License All rights reserved. This program and the accompanying materials are made available under the terms of the BSD license which accompanies this distribution, and is available at http://www.opensource.org/licenses/bsd-license.php

Submodules

[hide private]

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.

Variables

[hide private]

AEMain

AEMain = AEMain._AEMain()
Singleton of AEMain

AESettingsManager

AESettingsManager = AESettingsManager._AESettingsManager()
Singleton of AESettingsManager

AEEventManager

AEEventManager = AEEventManager._AEEventManager()
Singleton of AEEventManager

AEDeviceManager

AEDeviceManager = AEDeviceManager._AEDeviceManager()
Singleton of AEDeviceManager

AETierManager

AETierManager = AETierManager._AETierManager()
Singleton of AETierManager

AEViewManager

AEViewManager = AEViewManager._AEViewManager()
Singleton of AEViewManager