Module appModuleHandler :: Class AppModule
[hide private]
[frames] | no frames]

Class AppModule

source code

                   object --+        
                            |        
baseObject.AutoPropertyObject --+    
                                |    
      baseObject.ScriptableObject --+
                                    |
                                   AppModule

Base app module. App modules provide specific support for a single application. Each app module should be a Python module in the appModules package named according to the executable it supports; e.g. explorer.py for the explorer.exe application. It should containa AppModule class which inherits from this base class. App modules can implement and bind gestures to scripts. These bindings will only take effect while an object in the associated application has focus. See ScriptableObject for details. App modules can also receive NVDAObject events for objects within the associated application. This is done by implementing methods called event_eventName, where eventName is the name of the event; e.g. event_gainFocus. These event methods take two arguments: the NVDAObject on which the event was fired and a callable taking no arguments which calls the next event handler.

Nested Classes [hide private]

Inherited from baseObject.AutoPropertyObject: __metaclass__

Instance Methods [hide private]
 
__init__(self, processID, appName=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__repr__(self)
repr(x)
source code
 
_get_appModuleName(self) source code
 
_get_isAlive(self) source code
 
terminate(self)
Terminate this app module.
source code
 
chooseNVDAObjectOverlayClasses(self, obj, clsList)
Choose NVDAObject overlay classes for a given NVDAObject.
source code

Inherited from baseObject.ScriptableObject: bindGesture, bindGestures, clearGestureBindings, getScript

Inherited from baseObject.AutoPropertyObject: invalidateCache

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]

Inherited from baseObject.AutoPropertyObject: invalidateCaches

Class Variables [hide private]
  sleepMode = False

Inherited from baseObject.AutoPropertyObject: cachePropertiesByDefault

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, processID, appName=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

terminate(self)

source code 

Terminate this app module. This is called to perform any clean up when this app module is being destroyed. Subclasses should call the superclass method first.

chooseNVDAObjectOverlayClasses(self, obj, clsList)

source code 

Choose NVDAObject overlay classes for a given NVDAObject. This is called when an NVDAObject is being instantiated after NVDAObjects.NVDAObject.findOverlayClasses has been called on the API-level class. This allows an AppModule to add or remove overlay classes. See NVDAObjects.NVDAObject.findOverlayClasses for details about overlay classes.

Parameters: