Module globalPluginHandler :: Class GlobalPlugin
[hide private]
[frames] | no frames]

Class GlobalPlugin

source code

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

Base global plugin. Global plugins facilitate the implementation of new global commands, support for objects which may be found across many applications, etc. Each global plugin should be a separate Python module in the globalPlugins package containing a GlobalPlugin class which inherits from this base class. Global plugins can implement and bind gestures to scripts which will take effect at all times. See ScriptableObject for details. Global plugins can also receive NVDAObject events for all NVDAObjects. 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]
 
terminate(self)
Terminate this global plugin.
source code
 
chooseNVDAObjectOverlayClasses(self, obj, clsList)
Choose NVDAObject overlay classes for a given NVDAObject.
source code

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

Inherited from baseObject.AutoPropertyObject: invalidateCache

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

Class Methods [hide private]

Inherited from baseObject.AutoPropertyObject: invalidateCaches

Class Variables [hide private]

Inherited from baseObject.AutoPropertyObject: cachePropertiesByDefault

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

terminate(self)

source code 

Terminate this global plugin. This will be called when NVDA is finished with this global plugin.

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 a global plugin to add or remove overlay classes. See NVDAObjects.NVDAObject.findOverlayClasses for details about overlay classes.

Parameters: