globalPluginHandler module

globalPluginHandler.runningPlugins = {}

All currently running global plugins.

globalPluginHandler.listPlugins()
globalPluginHandler.initialize()
globalPluginHandler.terminate()
globalPluginHandler.reloadGlobalPlugins()

Reloads running global plugins.

class globalPluginHandler.GlobalPlugin(*args, **kwargs)

Bases: ScriptableObject

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 C{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 L{ScriptableObject} for details. Global plugins can also receive NVDAObject events for all NVDAObjects. This is done by implementing methods called C{event_eventName}, where C{eventName} is the name of the event; e.g. C{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.

terminate()

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

chooseNVDAObjectOverlayClasses(obj, clsList)

Choose NVDAObject overlay classes for a given NVDAObject. This is called when an NVDAObject is being instantiated after L{NVDAObjects.NVDAObject.findOverlayClasses} has been called on the API-level class. This allows a global plugin to add or remove overlay classes. See L{NVDAObjects.NVDAObject.findOverlayClasses} for details about overlay classes. @param obj: The object being created. @type obj: L{NVDAObjects.NVDAObject} @param clsList: The list of classes, which will be modified by this method if appropriate. @type clsList: list of L{NVDAObjects.NVDAObject}

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[Callable[[AutoPropertyObject], Any]]