appModules package

appModules.EXECUTABLE_NAMES_TO_APP_MODS: dict[str, str] = {'azardi-2.0': 'azardi20', 'azuredatastudio': 'code', 'azuredatastudio-insiders': 'code', 'calculatorapp': 'calculator', 'code - insiders': 'code', 'commsapps': 'hxmail', 'dbeaver': 'eclipse', 'digitaleditionspreview': 'digitaleditions', 'esybraille': 'esysuite', 'hxoutlook': 'hxmail', 'miranda64': 'miranda32', 'mpc-hc': 'mplayerc', 'mpc-hc64': 'mplayerc', 'notepad++': 'notepadPlusPlus', 'searchapp': 'searchui', 'searchhost': 'searchui', 'shellhost': 'shellexperiencehost', 'springtoolsuite4': 'eclipse', 'sts': 'eclipse', 'teamtalk3': 'teamtalk4classic', 'textinputhost': 'windowsinternal_composableshell_experiences_textinput_inputapp', 'totalcmd64': 'totalcmd', 'win32calc': 'calc', 'winmail': 'msimn', 'zend-eclipse-php': 'eclipse', 'zendstudio': 'eclipse'}

Maps names of the executables to the names of the appModule which should be loaded for the given program. Note that this map is used only for appModules included in NVDA and appModules registered by add-ons are placed in a different one. This mapping is needed since: - Names of some programs are incompatible with the Python’s import system (they contain a dot or a plus) - Sometimes it is necessary to map one module to multiple executables, this map saves us from adding multiple appModules in such cases.

Submodules

appModules.1password module

class appModules.1password.AppModule(*args, **kwargs)

Bases: AppModule

shouldProcessUIAPropertyChangedEvent(sender, propertyId)

Determines whether NVDA should process a UIA property changed event. Returning False will cause the event to be dropped completely. This can be used to work around UIA implementations which flood events and cause poor performance. Returning True means that the event will be processed, but it might still be rejected later; e.g. because it isn’t native UIA, because shouldAcceptEvent returns False, etc.

_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.aim module

class appModules.aim.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.audacity module

class appModules.audacity.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.azardi20 module

class appModules.azardi20.AzardiDocument(chooseBestAPI=True, **kwargs)

Bases: Document

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

role: controlTypes.Role = 52

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.azardi20.AzardiTreeViewItem(chooseBestAPI=True, **kwargs)

Bases: TreeViewItem

Scripts to perform common tasks for the selected book using the keyboard, so that mouse commands aren’t required.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

script_enter(gesture)
script_contextMenu(gesture)
__gestures = {'kb:applications': 'contextMenu', 'kb:enter': 'enter'}
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.azardi20.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.bookshelf module

appModules.bookshelf.getDocument()
class appModules.bookshelf.EnhancedPane(chooseBestAPI=True, **kwargs)

Bases: Window

Moves the focus to the current document. #7155: Panes are wrongly focused when dialogs or menus are closed from documents, for instance, when searching text in browse mode.

event_gainFocus()

This code is executed if a gain focus event is received by this object.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.bookshelf.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.calc module

App module for Windows Calculator (desktop version)

class appModules.calc.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]
class appModules.calc.Display(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

shouldAllowIAccessibleFocusEvent = True
_nextNameIsCalculationResult: bool = False

Set to True by the gestures which cause the calculator expression to be calculated.

calcCommandChars = ['!', '=', '@', '#']
calcCommandGestures = ('kb:backspace', 'kb:escape', 'kb:enter', 'kb:numpadEnter', 'kb:f2', 'kb:f3', 'kb:f4', 'kb:f5', 'kb:f6', 'kb:f7', 'kb:f8', 'kb:f9', 'kb:l', 'kb:n', 'kb:o', 'kb:p', 'kb:r', 'kb:s', 'kb:t')
_get_name()

The name or label of this object (example: the text of a button).

event_typedCharacter(ch)
script_executeAndRead(gesture)
initOverlayClass()
_abc_impl = <_abc._abc_data object>
event_nameChange()

If the name change is a result of an expression its value is announced.

name: str

Type definition for auto prop ‘_get_name’

appModules.calculator module

App module for Windows 10 Calculator. This is also the base app module for Windows 11 Calculator.

class appModules.calculator.AppModule(*args, **kwargs)

Bases: AppModule

_shouldAnnounceResult = False
_resultsCache = ''
_noCalculatorResultsGesturePressed = False
event_NVDAObject_init(obj)
event_nameChange(obj, nextHandler)
event_UIA_notification(obj, nextHandler, displayString=None, activityId=None, **kwargs)
_calculatorResultGestures = ('kb:enter', 'kb:numpadEnter', 'kb:escape', 'kb:delete', 'kb:numpadDelete')
script_calculatorResult(gesture)
script_doNotAnnounceCalculatorResults(gesture)
__gestures = {'kb:0': 'doNotAnnounceCalculatorResults', 'kb:1': 'doNotAnnounceCalculatorResults', 'kb:2': 'doNotAnnounceCalculatorResults', 'kb:3': 'doNotAnnounceCalculatorResults', 'kb:4': 'doNotAnnounceCalculatorResults', 'kb:5': 'doNotAnnounceCalculatorResults', 'kb:6': 'doNotAnnounceCalculatorResults', 'kb:7': 'doNotAnnounceCalculatorResults', 'kb:8': 'doNotAnnounceCalculatorResults', 'kb:9': 'doNotAnnounceCalculatorResults', 'kb:delete': 'calculatorResult', 'kb:enter': 'calculatorResult', 'kb:escape': 'calculatorResult', 'kb:numLockNumpad0': 'doNotAnnounceCalculatorResults', 'kb:numLockNumpad1': 'doNotAnnounceCalculatorResults', 'kb:numLockNumpad2': 'doNotAnnounceCalculatorResults', 'kb:numLockNumpad3': 'doNotAnnounceCalculatorResults', 'kb:numLockNumpad4': 'doNotAnnounceCalculatorResults', 'kb:numLockNumpad5': 'doNotAnnounceCalculatorResults', 'kb:numLockNumpad6': 'doNotAnnounceCalculatorResults', 'kb:numLockNumpad7': 'doNotAnnounceCalculatorResults', 'kb:numLockNumpad8': 'doNotAnnounceCalculatorResults', 'kb:numLockNumpad9': 'doNotAnnounceCalculatorResults', 'kb:numpadDelete': 'calculatorResult', 'kb:numpadEnter': 'calculatorResult'}
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.cicero module

App module to sleep for Dolphin Cicero

class appModules.cicero.AppModule(*args, **kwargs)

Bases: AppModule

sleepMode = True

Whether NVDA should sleep while in this application (e.g. the application is self-voicing). If C{True}, all events and script requests inside this application are silently dropped. @type: bool

_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.code module

App module for Visual Studio Code.

class appModules.code.VSCodeDocument(chooseBestAPI=True, **kwargs)

Bases: Document

The only content in the root document node of Visual Studio code is the application object. Creating a tree interceptor on this object causes a major slow down of Code. Therefore, forcefully block tree interceptor creation.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_treeInterceptorClass() Type[TreeInterceptor]

If this NVDAObject should use a treeInterceptor, then this property provides the L{treeInterceptorHandler.TreeInterceptor} class it should use. If not then it should be not implemented. @raises NotImplementedError when no TreeInterceptor class is available.

_abc_impl = <_abc._abc_data object>
treeInterceptorClass: Type[TreeInterceptor]

Type definition for auto prop ‘_get_treeInterceptorClass’

_propertyCache: Set[GetterMethodT]
class appModules.code.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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}

event_NVDAObject_init(obj: NVDAObject)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.devenv module

class appModules.devenv.VsWindowType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

ToolWindow = 15
Document = 16
Output = 17
class appModules.devenv.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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}

_getDTE()
_get_DTE()
DTE
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]
class appModules.devenv.VsWpfTextViewTextInfo(*args, **kwargs)

Bases: UIATextInfo

Constructor. Subclasses must extend this, calling the superclass method first. @param position: The initial position of this range; one of the POSITION_* constants or a position object supported by the implementation. @param obj: The object containing the range of text being represented.

_getLineNumberString(textRange)
_getFormatFieldAtRange(textRange, formatConfig, ignoreMixedValues=False)

Fetches formatting for the given UI Automation Text range. @param textRange: the text range whos formatting should be fetched. @param formatConfig: the types of formatting requested. @type formatConfig: a dictionary of NVDA document formatting configuration keys

with values set to true for those types that should be fetched.

@param ignoreMixedValues: If True, formatting that is mixed according to UI Automation will not be included.

If False, L{UIAHandler.utils.MixedAttributeError} will be raised if UI Automation gives back a mixed attribute value signifying that the caller may want to try again with a smaller range.

@return: The formatting for the given text range.

_getTextFromUIARange(textRange)

Fetches plain text from the given UI Automation text range. Just calls getText(-1). This only exists to be overridden for filtering.

_abc_impl = <_abc._abc_data object>
_rangeObj: IUIAutomationTextRangeT
_propertyCache: Set[GetterMethodT]
class appModules.devenv.VsWpfTextView(chooseBestAPI=True, **kwargs)

Bases: WpfTextView

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

TextInfo

alias of VsWpfTextViewTextInfo

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.devenv.VsTextEditPaneTextInfo(*args, **kwargs)

Bases: OffsetsTextInfo

Constructor. Subclasses may extend this to perform implementation specific initialisation, calling their superclass method afterwards.

_get__selectionObject()
_createEditPoint()
_getCaretOffset()
_setCaretOffset(offset)
_setSelectionOffsets(start, end)
_getSelectionOffsets()
_getTextRange(start, end)

Retrieve the text in a given offset range. @param start: The start offset. @type start: int @param end: The end offset (exclusive). @type end: int @return: The text contained in the requested range. @rtype: str

_getWordOffsets(offset)
_getLineOffsets(offset)
_getLineNumFromOffset(offset)
_getStoryLength()
_abc_impl = <_abc._abc_data object>
_selectionObject
class appModules.devenv.VsTextEditPane(chooseBestAPI=True, **kwargs)

Bases: EditableText, Window

_get_TextInfo()
initOverlayClass()
_get_location()

The location of this object on the screen. @return: left, top, width and height of the object. @rtype: tuple of int

event_valueChange()
TextInfo

The TextInfo class this object should use to provide access to text. @type: type; L{textInfos.TextInfo}

_abc_impl = <_abc._abc_data object>
location
_propertyCache: Set[GetterMethodT]
class appModules.devenv.ObjectsTreeItem(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_focusRedirect()

Returns the correct focused item in the object explorer trees

_get_positionInfo()

Retrieves position information for this object such as its level, its index with in a group, and the number of items in that group. @return: a dictionary containing any of level, groupIndex and similarItemsInGroup.

_abc_impl = <_abc._abc_data object>
focusRedirect
positionInfo: Dict[str, int]

Type definition for auto prop ‘_get_positionInfo’

_propertyCache: Set[GetterMethodT]

appModules.digitaleditions module

App module for Adobe Digital Editions

class appModules.digitaleditions.BookContentTextInfo(*args, **kwargs)

Bases: UIATextInfo

Constructor. Subclasses must extend this, calling the superclass method first. @param position: The initial position of this range; one of the POSITION_* constants or a position object supported by the implementation. @param obj: The object containing the range of text being represented.

allowGetFormatFieldsAndTextOnDegenerateUIARanges = True
_abc_impl = <_abc._abc_data object>
_rangeObj: IUIAutomationTextRangeT
_propertyCache: Set[GetterMethodT]
class appModules.digitaleditions.BookContent(chooseBestAPI=True, **kwargs)

Bases: DocumentWithPageTurns, UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

_get_TextInfo()
turnPage(previous=False)

Switch to the next/previous page of text. @param previous: C{True} to turn to the previous page, C{False} to turn to the next. @type previous: bool @raise RuntimeError: If there are no further pages.

TextInfo

The TextInfo class this object should use to provide access to text. @type: type; L{textInfos.TextInfo}

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.digitaleditions.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.dllhost module

Under older builds of Windows 10 (from RTM release to Creators Update) dllhost is used to display a properties window. Read-Only edit boxes in it can contain dates that include unwanted left-to-right and right-to-left indicator characters. This simply imports a proper class from the explorer app module, and maps it to a edit control.

class appModules.dllhost.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.doctts module

class appModules.doctts.AppModule(*args, **kwargs)

Bases: AppModule

sleepMode = True

Whether NVDA should sleep while in this application (e.g. the application is self-voicing). If C{True}, all events and script requests inside this application are silently dropped. @type: bool

_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.dosvox module

class appModules.dosvox.AppModule(*args, **kwargs)

Bases: AppModule

sleepMode = True

Whether NVDA should sleep while in this application (e.g. the application is self-voicing). If C{True}, all events and script requests inside this application are silently dropped. @type: bool

_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.eclipse module

class appModules.eclipse.EclipseTextArea(chooseBestAPI=True, **kwargs)

Bases: EditableTextWithSuggestions, IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

event_suggestionsClosed()

Called when suggestions list or container is closed. Subclasses should provide custom implementations if possible. By default NVDA will announce this via speech, braille or via a sound.

event_valueChange()
event_caret()
script_closeAutocompleter(gesture)
script_readDocumentation(gesture)

Tries to read documentation for the selected autocompletion item.

script_completeInstruction(gesture)
__gestures = {'kb:enter': 'closeAutocompleter', 'kb:escape': 'closeAutocompleter', 'kb:nvda+d': 'readDocumentation', 'kb:tab': 'completeInstruction'}
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.eclipse.AutocompletionListItem(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

event_selection()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.eclipse.AppModule(*args, **kwargs)

Bases: AppModule

LIST_VIEW_CLASS = 'SysListView32'
selectedItem = None
selectedItemName = None
event_NVDAObject_init(obj)
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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.egui module

class appModules.egui.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.esysuite module

App module for Esysuite

Esysuite is a self braille/voice application. NVDA should sleep during Esysuite activity.

class appModules.esysuite.AppModule(*args, **kwargs)

Bases: AppModule

sleepMode = True

Whether NVDA should sleep while in this application (e.g. the application is self-voicing). If C{True}, all events and script requests inside this application are silently dropped. @type: bool

_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.excel module

class appModules.excel.Excel6(chooseBestAPI=True, **kwargs)

Bases: Window

The Excel cell edit window. If it is not accessible (no displayModel) then wait for the CellEdit UIA element to get focus and redirect to that.

_get_focusRedirect()
_abc_impl = <_abc._abc_data object>
focusRedirect
_propertyCache: Set[GetterMethodT]
class appModules.excel.Excel6_WhenUIAEnabled(chooseBestAPI=True, **kwargs)

Bases: IAccessible

#12303: When accessing Microsoft Excel via UI Automation MSAA focus events on the old formula edit window should be completely ignored. UI Automation will fire its own ones.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

shouldAllowIAccessibleFocusEvent = False
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.excel.BrokenDataValidationSysListView32(chooseBestAPI=True, **kwargs)

Bases: UIA

#15138: Broken data validation SysListView32 control in Excel. If a cell has a data validation type of list, the dropdown list shown when pressing alt+down arrow is not accessible. IAccessibleObjectFromEvent fails for all focus winEvents (most likely proxied from a broken UIA implementation). Even when this appModule treats this window as native UIA, the parent chain loops between the SysListView32 and the __XLACOOUTER window causing a never ending focus ancestry. Therefore, this class is used to override the parent of the SysListView32 control to go straight to the desktop.

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

classmethod windowMatches(hwnd: int) bool

Identifies if the given window is a broken data validation SysListView32 control.

classmethod matchesNVDAObject(obj: NVDAObject) bool

Identifies if the given NVDAObject is a broken data validation SysListView32 control.

_get_parent() NVDAObject

Retrieves this object’s parent (the object that contains this object). @return: the parent object if it exists else None.

_correctFocus()
script_close(gesture)
__gestures = {'kb:enter': 'close', 'kb:escape': 'close', 'kb:space': 'close'}
_abc_impl = <_abc._abc_data object>
parent: Optional['NVDAObject']

This object’s parent (the object that contains this object).

_propertyCache: Set[GetterMethodT]
class appModules.excel.AppModule(*args, **kwargs)

Bases: AppModule

isGoodUIAWindow(hwnd: int) bool

returns C{True} if the UIA implementation of the given window must be used, regardless whether native or not. This function is the counterpart of and takes precedence over L{isBadUIAWindow}. If both functions return C{False}, the decision of whether to use UIA for the window is left to core. Warning: this may be called outside of NVDA’s main thread, therefore do not try accessing NVDAObjects and such, rather just check window class names.

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.explorer module

App module for Windows Explorer (aka Windows shell and renamed to File Explorer in Windows 8). Provides workarounds for controls such as identifying Start button, notification area and others.

class appModules.explorer.MultitaskingViewFrameWindow(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

shouldAllowUIAFocusEvent = False
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.explorer.MultitaskingViewFrameListItem(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

_get_container()

Exactly like parent, however another object at this same sibling level may be retreaved first (e.g. a groupbox). Mostly used when presenting context such as focus ancestry.

_abc_impl = <_abc._abc_data object>
container
_propertyCache: Set[GetterMethodT]
class appModules.explorer.SuggestionListItem(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

event_UIA_elementSelected()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.explorer.SearchBoxClient(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

shouldAllowIAccessibleFocusEvent = False
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.explorer.SysListView32EmittingDuplicateFocusEvents(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_shouldAllowIAccessibleFocusEvent()

Determine whether a focus event should be allowed for this object. Normally, this checks for the focused state to help eliminate redundant or invalid focus events. However, some implementations do not correctly set the focused state, so this must be overridden. @return: C{True} if the focus event should be allowed. @rtype: bool

_abc_impl = <_abc._abc_data object>
shouldAllowIAccessibleFocusEvent
_propertyCache: Set[GetterMethodT]
class appModules.explorer.NotificationArea(chooseBestAPI=True, **kwargs)

Bases: IAccessible

The Windows notification area, a.k.a. system tray.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

lastKnownLocation = None
event_gainFocus()

This code is executed if a gain focus event is received by this object.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.explorer.ExplorerToolTip(chooseBestAPI=True, **kwargs)

Bases: ToolTip

shouldReport()
event_show()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.explorer.GridTileElement(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

role: controlTypes.Role = 29

Type definition for auto prop ‘_get_role’

_get_description()

The description or help text of this object.

_abc_impl = <_abc._abc_data object>
description: str

Typing information for auto property _get_description

_propertyCache: Set[GetterMethodT]
class appModules.explorer.GridListTileElement(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

role: controlTypes.Role = 29

Type definition for auto prop ‘_get_role’

description: str = None

Typing information for auto property _get_description

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.explorer.GridGroup(chooseBestAPI=True, **kwargs)

Bases: UIA

A group in the Windows 8 Start Menu.

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

presentationType = 'content'
_get_name()

The name or label of this object (example: the text of a button).

_abc_impl = <_abc._abc_data object>
name: str

Typing info for auto property _get_name()

_propertyCache: Set[GetterMethodT]
class appModules.explorer.ImmersiveLauncher(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

shouldAllowUIAFocusEvent = False
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.explorer.StartButton(chooseBestAPI=True, **kwargs)

Bases: IAccessible

For Windows 8.1 and 10 Start buttons to be recognized as proper buttons and to suppress selection announcement.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

role: controlTypes.Role = 9

Type definition for auto prop ‘_get_role’

_get_states()

Retrieves the current states of this object (example: selected, focused). @return: a set of State constants from L{controlTypes}.

_abc_impl = <_abc._abc_data object>
states: Set[State]

Type info for auto property: _get_states

_propertyCache: Set[GetterMethodT]
class appModules.explorer.UIProperty(chooseBestAPI=True, **kwargs)

Bases: UIA

Used for columns in Windows Explorer Details view. These can contain dates that include unwanted left-to-right and right-to-left indicator characters.

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

_get_value()

The value of this object (example: the current percentage of a scrollbar, the selected option in a combo box).

_abc_impl = <_abc._abc_data object>
value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]
class appModules.explorer.ReadOnlyEditBox(chooseBestAPI=True, **kwargs)

Bases: Edit

Used for read-only edit boxes in a properties window. These can contain dates that include unwanted left-to-right and right-to-left indicator characters.

_get_windowText()
_abc_impl = <_abc._abc_data object>
windowText
_propertyCache: Set[GetterMethodT]
class appModules.explorer.MetadataEditField(chooseBestAPI=True, **kwargs)

Bases: RichEdit50

classmethod _get_TextInfo()
TextInfo

The TextInfo class this object should use to provide access to text. @type: type; L{textInfos.TextInfo}

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.explorer.WorkerW(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

event_gainFocus()

This code is executed if a gain focus event is received by this object.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.explorer.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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}

_get_statusBar()

Retrieve the status bar object of the application. If C{NotImplementedError} is raised, L{api.getStatusBar} will resort to perform a lookup by position. If C{None} is returned, L{GlobalCommands.script_reportStatusLine} will in turn resort to reading the bottom line of text written to the display. @rtype: NVDAObject

static _getStatusBarText(obj: NVDAObject) str
getStatusBarText(obj: NVDAObject) str

Get the text from the given status bar. If C{NotImplementedError} is raised, L{api.getStatusBarText} will resort to retrieve the name of the status bar and the names and values of all of its children.

event_NVDAObject_init(obj: NVDAObject) None
event_gainFocus(obj, nextHandler)
isGoodUIAWindow(hwnd: int) bool

returns C{True} if the UIA implementation of the given window must be used, regardless whether native or not. This function is the counterpart of and takes precedence over L{isBadUIAWindow}. If both functions return C{False}, the decision of whether to use UIA for the window is left to core. Warning: this may be called outside of NVDA’s main thread, therefore do not try accessing NVDAObjects and such, rather just check window class names.

event_UIA_window_windowOpen(obj, nextHandler)
event_UIA_elementSelected(obj: NVDAObject, nextHandler: Callable[[], None])
_abc_impl = <_abc._abc_data object>
statusBar
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.fastlogentry module

class appModules.fastlogentry.TSynMemo(chooseBestAPI=True, **kwargs)

Bases: DisplayModelEditableText

name: str = None

Type definition for auto prop ‘_get_name’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.fastlogentry.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.foobar2000 module

appModules.foobar2000._getTimeOutputFormat(timeStr: str) TimeOutputFormat | None

Attempts to find a suitable output format for a D HH:MM:SS, HH:MM:SS, MM:SS or SS -style interval.

appModules.foobar2000._parseTimeStrToTimeDelta(timeStr: str) timedelta | None

Attempts to convert a time string to a timedelta for a D HH:MM:SS, HH:MM:SS, MM:SS or SS -style interval.

Note days D must be less than or equal to 31.

appModules.foobar2000._parseTimeStrToOutputFormatted(timeStr: str) str | None
class appModules.foobar2000._StatusBarTimes(elapsed: str | None, total: str | None)

Bases: NamedTuple

A named tuple for holding the elapsed and total playing times from Foobar2000’s status bar

Create new instance of _StatusBarTimes(elapsed, total)

elapsed: str | None

Alias for field number 0

total: str | None

Alias for field number 1

_asdict()

Return a new dict which maps field names to their values.

_field_defaults = {}
_fields = ('elapsed', 'total')
classmethod _make(iterable)

Make a new _StatusBarTimes object from a sequence or iterable

_replace(**kwds)

Return a new _StatusBarTimes object replacing specified fields with new values

class appModules.foobar2000.AppModule(*args, **kwargs)

Bases: AppModule

_statusBar: NVDAObject | None = None
event_gainFocus(obj, nextHandler)
getElapsedAndTotal() _StatusBarTimes
getElapsedAndTotalIfPlaying() _StatusBarTimes
script_reportRemainingTime(gesture: InputGesture)

Reports the remaining time of the currently playing track, if any

script_reportElapsedTime(gesture: InputGesture)

Reports the elapsed time of the currently playing track, if any

script_reportTotalTime(gesture: InputGesture)

Reports the length of the currently playing track, if any

__gestures = {'kb:control+shift+e': 'reportElapsedTime', 'kb:control+shift+r': 'reportRemainingTime', 'kb:control+shift+t': 'reportTotalTime'}
_abc_impl = <_abc._abc_data object>

appModules.hxmail module

An appModule for the Windows Mail app, for Windows 10 and 11.

class appModules.hxmail.MailWordDocumentTreeInterceptor(*args, **kwargs)

Bases: WordBrowseModeDocument

_get_isAlive()

Whether this interceptor is alive. If it is not alive, it will be removed.

_abc_impl = <_abc._abc_data object>
isAlive
_lastCachedDocumentConstantIdentifier: str | None
rootNVDAObject: NVDAObjects.NVDAObject

The root object of the tree wherein events and scripts are intercepted.

_propertyCache: Set[GetterMethodT]
class appModules.hxmail.MailWordDocument(chooseBestAPI=True, **kwargs)

Bases: WordDocument

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

treeInterceptorClass

alias of MailWordDocumentTreeInterceptor

_get_shouldCreateTreeInterceptor()
_abc_impl = <_abc._abc_data object>
shouldCreateTreeInterceptor

Whether to create a tree interceptor for this object. This is only relevant if L{treeInterceptorClass} is valid. Normally, this should be C{True}. However, for some objects (e.g. ARIA applications), a tree interceptor shouldn’t be used by default, but the user may wish to override this. In this case, this can be set to C{False} and updated later. @type: bool

_propertyCache: Set[GetterMethodT]
class appModules.hxmail.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.instantbird module

App module for Instantbird

class appModules.instantbird.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.itunes module

App module for iTunes

class appModules.itunes.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]
class appModules.itunes.ITunesItem(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Retreaves position information encoded in the accDescription

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

hasEncodedAccDescription = True
value: str = None

Typing information for auto property _get_value

_get_next()

Retrieves the object directly after this object with the same parent. @return: the next object if it exists else None.

_get_previous()

Retrieves the object directly before this object with the same parent. @return: the previous object if it exists else None.

_get_shouldAllowIAccessibleFocusEvent()

Determine whether a focus event should be allowed for this object. Normally, this checks for the focused state to help eliminate redundant or invalid focus events. However, some implementations do not correctly set the focused state, so this must be overridden. @return: C{True} if the focus event should be allowed. @rtype: bool

_abc_impl = <_abc._abc_data object>
next: Optional['NVDAObject']

The object directly after this object with the same parent.

previous: Optional['NVDAObject']

The object directly before this object with the same parent.

shouldAllowIAccessibleFocusEvent
_propertyCache: Set[GetterMethodT]
class appModules.itunes.WebKitDocument(chooseBestAPI=True, **kwargs)

Bases: Document

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

event_stateChange()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.itunes.TopLevelClient(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_isEqual(other)

Calculates if this object is equal to another object. Used by L{NVDAObject.__eq__}. @param other: the other object to compare with. @type other: L{NVDAObject} @return: True if equal, false otherwise. @rtype: boolean

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]

appModules.javaw module

Support for app specific modules for Java apps hosted by javaw.exe.

appModules.javaw._getEntryPoint(cmd)
appModules.javaw.getAppNameFromHost(processId)

appModules.kindle module

class appModules.kindle.ElementsListDialog(document)

Bases: ElementsListDialog

ELEMENT_TYPES = (('link', 'Lin&ks'),)
class appModules.kindle.BookPageViewTreeInterceptor(*args, **kwargs)

Bases: DocumentWithPageTurns, ReviewCursorManager, BrowseModeDocumentTreeInterceptor

class ElementsListDialog(document)

Bases: ElementsListDialog

ELEMENT_TYPES = (('link', 'Lin&ks'),)
filterTimer: wx.CallLater | None
TextInfo

alias of RootProxyTextInfo

pageChangeAlreadyHandled = False
turnPage(previous=False)

Switch to the next/previous page of text. @param previous: C{True} to turn to the previous page, C{False} to turn to the next. @type previous: bool @raise RuntimeError: If there are no further pages.

event_pageChange(obj, nextHandler)
isAlive()
_getTableCellAt(tableID, startPos, destRow, destCol)

Override of documentBase.DocumentWithTableNavigation._getTableCellAt.

_changePageScriptHelper(gesture, previous=False)
script_moveByPage_forward(gesture)
script_moveByPage_back(gesture)
_tabOverride(direction)

Override the tab order if the virtual caret is not within the currently focused node. This is done because many nodes are not focusable and it is thus possible for the virtual caret to be unsynchronised with the focus. In this case, we want tab/shift+tab to move to the next/previous focusable node relative to the virtual caret. If the virtual caret is within the focused node, the tab/shift+tab key should be passed through to allow normal tab order navigation. Note that this method does not pass the key through itself if it is not overridden. This should be done by the calling script if C{False} is returned. @param direction: The direction in which to move. @type direction: str @return: C{True} if the tab order was overridden, C{False} if not. @rtype: bool

script_showSelectionOptions(gesture)

Shows options related to selected text or text at the cursor

__gestures = {'kb:applications': 'showSelectionOptions', 'kb:control+c': 'showSelectionOptions', 'kb:shift+f10': 'showSelectionOptions'}
_iterEmbeddedObjs(hypertext, startIndex, direction)

Recursively iterate through all embedded objects in a given direction starting at a given hyperlink index.

NODE_TYPES_TO_ROLES = {'graphic': {Role.GRAPHIC}, 'link': {Role.LINK, Role.FOOTNOTE}, 'table': {Role.TABLE}}
_iterNodesByType(nodeType, direction='next', pos=None)

Yields L{QuickNavItem} objects representing the ordered positions in this document according to the type being searched for (e.g. link, heading, table etc). @param itemType: the type being searched for (e.g. link, heading, table etc) @type itemType: string @param direction: the direction in which to search (next, previous, up) @type direction: string @param pos: the position in the document from where to start the search. @type pos: Usually an L{textInfos.TextInfo} @raise NotImplementedError: This type is not supported by this BrowseMode implementation

script_find(gesture)

find a text string from the current cursor position

script_findNext(gesture)

find the next occurrence of the previously entered text string from the current cursor’s position

script_findPrevious(gesture)

find the previous occurrence of the previously entered text string from the current cursor’s position

_abc_impl = <_abc._abc_data object>
class appModules.kindle.BookPageViewTextInfo(*args, **kwargs)

Bases: MozillaCompoundTextInfo

Constructor. Subclasses must extend this, calling the superclass method first. @param position: The initial position of this range; one of the POSITION_* constants or a position object supported by the implementation. @param obj: The object containing the range of text being represented.

_get_locationText()

A message that explains the location of the text position in friendly terms.

getTextWithFields(formatConfig: Dict | None = None) List[str | FieldCommand]

Retrieves the text in this range, as well as any control/format fields associated therewith. Subclasses may override this. The base implementation just returns the text. @param formatConfig: Document formatting configuration, useful if you wish to force a particular

configuration for a particular task.

@return: A sequence of text strings interspersed with associated field commands.

getFormatFieldSpeech(attrs: Field, attrsCache: Field | None = None, formatConfig: Dict[str, bool] | None = None, reason: OutputReason | None = None, unit: str | None = None, extraDetail: bool = False, initialFormat: bool = False) list[SpeechCommand | str]

Get the spoken representation for given format information. The base implementation just calls L{speech.getFormatFieldSpeech}. This can be extended in order to support implementation specific attributes. If extended, the superclass should be called first.

updateSelection()

Moves the selection (usually the system caret) to the position of this text info object

_getControlFieldForObject(obj, ignoreEditableText=True)
getMathMl(field)

Get MathML for a math control field. This will only be called for control fields with a role of L{controlTypes.Role.MATH}. @raise LookupError: If MathML can’t be retrieved for this field.

_abc_impl = <_abc._abc_data object>
locationText
_propertyCache: Set[GetterMethodT]
class appModules.kindle.BookPageView(chooseBestAPI=True, **kwargs)

Bases: DocumentWithPageTurns, IAccessible

Allows navigating page text content with the arrow keys.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

treeInterceptorClass

alias of BookPageViewTreeInterceptor

TextInfo

alias of BookPageViewTextInfo

_get_pageNumber()
turnPage(previous=False)

Switch to the next/previous page of text. @param previous: C{True} to turn to the previous page, C{False} to turn to the next. @type previous: bool @raise RuntimeError: If there are no further pages.

_abc_impl = <_abc._abc_data object>
pageNumber
_propertyCache: Set[GetterMethodT]
class appModules.kindle.PageTurnFocusIgnorer(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_shouldAllowIAccessibleFocusEvent()

Determine whether a focus event should be allowed for this object. Normally, this checks for the focused state to help eliminate redundant or invalid focus events. However, some implementations do not correctly set the focused state, so this must be overridden. @return: C{True} if the focus event should be allowed. @rtype: bool

_abc_impl = <_abc._abc_data object>
shouldAllowIAccessibleFocusEvent
_propertyCache: Set[GetterMethodT]
class appModules.kindle.Math(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_mathMl()

Obtain the MathML markup for an object containing math content. This will only be called (and thus only needs to be implemented) for objects with a role of L{controlTypes.Role.MATH}. @raise LookupError: If MathML can’t be retrieved for this object.

_abc_impl = <_abc._abc_data object>
mathMl
_propertyCache: Set[GetterMethodT]
class appModules.kindle.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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}

event_NVDAObject_init(obj)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.lockapp module

class appModules.lockapp.LockAppContainer(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

presentationType = 'content'
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.lockapp.AppModule(*args, **kwargs)

Bases: AppModule

SAFE_SCRIPTS = {<bound method GlobalCommands.script_braille_nextLine of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_braille_previousLine of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_braille_routeTo of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_braille_scrollBack of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_braille_scrollForward of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_dateTime of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_leftMouseClick of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_moveMouseToNavigatorObject of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_moveNavigatorObjectToMouse of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_navigatorObject_current of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_navigatorObject_currentDimensions of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_navigatorObject_firstChild of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_navigatorObject_moveFocus of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_navigatorObject_next of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_navigatorObject_nextInFlow of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_navigatorObject_parent of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_navigatorObject_previous of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_navigatorObject_previousInFlow of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_navigatorObject_toFocus of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_reportCurrentFocus of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_activate of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_bottom of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_currentCharacter of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_currentLine of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_currentWord of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_endOfLine of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_nextCharacter of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_nextLine of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_nextWord of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_previousCharacter of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_previousLine of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_previousWord of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_sayAll of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_startOfLine of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_review_top of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_rightMouseClick of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_say_battery_status of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_title of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_touch_changeMode of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_touch_explore of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_touch_hoverUp of <globalCommands.GlobalCommands object>>, <bound method GlobalCommands.script_touch_newExplore of <globalCommands.GlobalCommands object>>}

Deprecated, use utils.security.getSafeScripts() instead.

chooseNVDAObjectOverlayClasses(obj: NVDAObject, clsList: List[NVDAObject]) None

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 an AppModule 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}

event_foreground(obj: NVDAObject, nextHandler: Callable[[], None])

Set mouse object explicitly before continuing to the next handler. This is to prevent the mouse focus remaining on the desktop when locking the screen.

_inputCaptor(gesture: InputGesture) bool
event_appModule_gainFocus()
_abc_impl = <_abc._abc_data object>
event_appModule_loseFocus()
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.lockapphost module

class appModules.lockapphost.AppModule(*args, **kwargs)

Bases: AppModule

event_gainFocus(obj, nextHandler)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.logonui module

class appModules.logonui.LogonDialog(chooseBestAPI=True, **kwargs)

Bases: Dialog

role: Role = 4

Type definition for auto prop ‘_get_role’

isPresentableFocusAncestor = True
event_gainFocus()

This code is executed if a gain focus event is received by this object.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.logonui.Win8PasswordField(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

doAction(index=None)

Performs an action supported by this object. If index is not given then the default action will be used if it exists.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.logonui.XPPasswordField(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

initOverlayClass()
_get_name()

The name or label of this object (example: the text of a button).

script_changeUser(gesture)
_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class appModules.logonui.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
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 an AppModule 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}

event_gainFocus(obj, nextHandler)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.loudtalks module

Bases: Window

value: str = None

Typing information for auto property _get_value

role: controlTypes.Role = 19

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.loudtalks.loudTalksContactListItem(chooseBestAPI=True, **kwargs)

Bases: ListItem

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

shouldAllowIAccessibleFocusEvent = True
_get_keyboardShortcut()

The shortcut key that activates this object(example: alt+t). @rtype: str

_abc_impl = <_abc._abc_data object>
keyboardShortcut
_propertyCache: Set[GetterMethodT]
class appModules.loudtalks.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.lync module

appModule for Microsoft Skype for business.

class appModules.lync.NetUIRicherLabel(chooseBestAPI=True, **kwargs)

Bases: UIA

A label sometimes found within list items that can fire live region changes, such as for chat messages.

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

event_liveRegionChange()

A base implementation for live region change events.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.lync.AppModule(*args, **kwargs)

Bases: AppModule

_lastLiveChatMessageData = ([], '', [])
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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.microsoftedge module

appModule for Microsoft Edge main process

class appModules.microsoftedge.AppModule(*args, **kwargs)

Bases: AppModule

event_UIA_notification(obj, nextHandler, displayString=None, **kwargs)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.microsoftedgecp module

appModule for Microsoft Edge content processes

class appModules.microsoftedgecp.CoreComponentInputSourcePane(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

shouldAllowIAccessibleFocusEvent = False
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.microsoftedgecp.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.mintty module

App module for mintty

class appModules.mintty.AppModule(*args, **kwargs)

Bases: AppModule

TERMINAL_WINDOW_CLASS = 'mintty'
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.miranda32 module

class appModules.miranda32.AppModule(*args, **kwargs)

Bases: AppModule

lastTextLengths = {}
lastMessages = []
MessageHistoryLength = 3
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 an AppModule 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}

event_NVDAObject_init(obj)
script_readMessage(gesture)

Displays one of the recent messages

__gestures = {'kb:NVDA+control+1': 'readMessage', 'kb:NVDA+control+2': 'readMessage', 'kb:NVDA+control+3': 'readMessage'}
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]
class appModules.miranda32.mirandaIMContactList(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_name()

The name or label of this object (example: the text of a button).

_get_role()

The role or type of control this object represents (example: button, list, dialog).

_get_states()

Retrieves the current states of this object (example: selected, focused). @return: a set of State constants from L{controlTypes}.

script_changeItem(gesture)
__changeItemGestures = ('kb:downArrow', 'kb:upArrow', 'kb:leftArrow', 'kb:rightArrow', 'kb:home', 'kb:end', 'kb:pageUp', 'kb:pageDown')
initOverlayClass()
_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

role: controlTypes.Role

Type definition for auto prop ‘_get_role’

states: Set[State]

Type info for auto property: _get_states

_propertyCache: Set[GetterMethodT]
class appModules.miranda32.mirandaIMButton(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_name()

The name or label of this object (example: the text of a button).

_get_role()

The role or type of control this object represents (example: button, list, dialog).

getActionName()

Retrieves the name of an action supported by this object. If index is not given then the default action will be used if it exists. @param index: the optional 0-based index of the wanted action. @type index: int @return: the action’s name @rtype: str

doAction()

Performs an action supported by this object. If index is not given then the default action will be used if it exists.

script_doDefaultAction(gesture)
initOverlayClass()
_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

role: controlTypes.Role

Type definition for auto prop ‘_get_role’

_propertyCache: Set[GetterMethodT]

Bases: mirandaIMButton

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_role()

The role or type of control this object represents (example: button, list, dialog).

_abc_impl = <_abc._abc_data object>
role: controlTypes.Role

Type definition for auto prop ‘_get_role’

_propertyCache: Set[GetterMethodT]
class appModules.miranda32.MPropertyPage(chooseBestAPI=True, **kwargs)

Bases: Dialog, IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_name()

The name or label of this object (example: the text of a button).

_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class appModules.miranda32.MirandaMessageViewerScrollbar(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

event_valueChange()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.miranda32.DuplicateFocusListBox(chooseBestAPI=True, **kwargs)

Bases: IAccessible

A list box which annoyingly fires focus events every second, even when a menu is open.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_abc_impl = <_abc._abc_data object>
_get_shouldAllowIAccessibleFocusEvent()

Determine whether a focus event should be allowed for this object. Normally, this checks for the focused state to help eliminate redundant or invalid focus events. However, some implementations do not correctly set the focused state, so this must be overridden. @return: C{True} if the focus event should be allowed. @rtype: bool

shouldAllowIAccessibleFocusEvent
_propertyCache: Set[GetterMethodT]

appModules.mirc module

App module for mIRC

class appModules.mirc.Input(chooseBestAPI=True, **kwargs)

Bases: Window

event_gainFocus()

This code is executed if a gain focus event is received by this object.

event_loseFocus()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.mirc.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.mmc module

class appModules.mmc.MMCTable(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_focusRedirect()
_abc_impl = <_abc._abc_data object>
focusRedirect
_propertyCache: Set[GetterMethodT]
class appModules.mmc.MMCTableCell(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Cell and rowheader makes no sense for these controls. Mapping them to list items has added benefit of suppressing selected.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

role: controlTypes.Role = 15

Type definition for auto prop ‘_get_role’

event_selection()
_get_positionInfo()

When ‘Guess object position info when unavailable’ is enabled these controls report very strange information such as 65537 of 12, especially in braille. Disable reporting of position info all together.

_abc_impl = <_abc._abc_data object>
positionInfo: Dict[str, int]

Type definition for auto prop ‘_get_positionInfo’

_propertyCache: Set[GetterMethodT]
class appModules.mmc.toolTipWithEmptyName(chooseBestAPI=True, **kwargs)

Bases: ToolTip

previousToolTipText = ''
_get_name()

ToolTips appearing when hovering mouse over graphical view have empty name, but it can be retrieved via display model.

event_show()
_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class appModules.mmc.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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}

isBadUIAWindow(hwnd)

returns C{True} if the UIA implementation of the given window must be ignored due to it being broken in some way. This function is the counterpart of L{isGoodUIAWindow}. When both functions return C{True}, L{isGoodUIAWindow} takes precedence. If both functions return C{False}, the decision of whether to use UIA for the window is left to core. Warning: this may be called outside of NVDA’s main thread, therefore do not try accessing NVDAObjects and such, rather just check window class names.

_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.mplayerc module

class appModules.mplayerc.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.msedgewebview2 module

Support for apps employing Edge WebView2 runtime interface.

appModules.msedgewebview2.getAppNameFromHost(processId: int) str

appModules.msimn module

class appModules.msimn.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
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 an AppModule 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}

event_gainFocus(obj, nextHandler)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]
class appModules.msimn.MessageRuleListItem(chooseBestAPI=True, **kwargs)

Bases: ListItem

Used for the checkbox list items used to select message rule types in in message filters

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

role: controlTypes.Role = 5

Type definition for auto prop ‘_get_role’

_get_states()

Retrieves the current states of this object (example: selected, focused). @return: a set of State constants from L{controlTypes}.

_abc_impl = <_abc._abc_data object>
states: Set[controlTypes.State]

Type info for auto property: _get_states

_propertyCache: Set[GetterMethodT]
class appModules.msimn.MessageListItem(chooseBestAPI=True, **kwargs)

Bases: ListItem

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_getColumnContent(column)

Get the text content for a given column of this row. Subclasses must override this method. @param column: The index of the column, starting at 1. @type column: int @rtype: str

_get_isUnread()
_get_name()

The name or label of this object (example: the text of a button).

_abc_impl = <_abc._abc_data object>
isUnread
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]

appModules.msnmsgr module

class appModules.msnmsgr.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]
class appModules.msnmsgr.OldMSNHistory(chooseBestAPI=True, **kwargs)

Bases: ReviewCursorManager, IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_basicText()
_get_value()

The value of this object (example: the current percentage of a scrollbar, the selected option in a combo box).

event_valueChange()
event_gainFocus()

This code is executed if a gain focus event is received by this object.

reportFocus()

Announces this object in a way suitable such that it gained focus.

_abc_impl = <_abc._abc_data object>
basicText
value: str

Typing information for auto property _get_value

class appModules.msnmsgr.MSNHistory(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_value()

The value of this object (example: the current percentage of a scrollbar, the selected option in a combo box).

event_valueChange()
_abc_impl = <_abc._abc_data object>
value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]

appModules.nlnotes module

class appModules.nlnotes.IrisTedit(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_name()

The name or label of this object (example: the text of a button).

_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class appModules.nlnotes.NotesRichText(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_shouldAllowIAccessibleFocusEvent()

Determine whether a focus event should be allowed for this object. Normally, this checks for the focused state to help eliminate redundant or invalid focus events. However, some implementations do not correctly set the focused state, so this must be overridden. @return: C{True} if the focus event should be allowed. @rtype: bool

_get_treeInterceptorClass()

If this NVDAObject should use a treeInterceptor, then this property provides the L{treeInterceptorHandler.TreeInterceptor} class it should use. If not then it should be not implemented. @raises NotImplementedError when no TreeInterceptor class is available.

_abc_impl = <_abc._abc_data object>
shouldAllowIAccessibleFocusEvent
treeInterceptorClass: Type[TreeInterceptor]

Type definition for auto prop ‘_get_treeInterceptorClass’

_propertyCache: Set[GetterMethodT]
class appModules.nlnotes.NotesSubprog(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

shouldAllowIAccessibleFocusEvent = False
presentationType = 'layout'
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.nlnotes.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.notepad module

App module for Windows Notepad. While this app module also covers older Notepad releases, this module provides workarounds for Windows 11 Notepad.

class appModules.notepad.AppModule(*args, **kwargs)

Bases: AppModule

event_UIA_elementSelected(obj: NVDAObject, nextHandler: Callable[[], None])
_get_statusBar() NVDAObject

Retrieves Windows 11 Notepad status bar. In Windows 10 and earlier, status bar can be obtained by looking at the bottom of the screen. Windows 11 Notepad uses Windows 11 UI design (top-level window is labeled “DesktopWindowXamlSource”, therefore status bar cannot be obtained by position alone. If visible, a child of the foreground window hosts the status bar elements. Status bar child position must be checked whenever Notepad is updated on stable Windows 11 releases as Notepad is updated through Microsoft Store as opposed to tied to specific Windows releases. L{api.getStatusBar} will resort to position lookup if C{NotImplementedError} is raised.

_abc_impl = <_abc._abc_data object>
statusBar
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.notepadPlusPlus module

AppModule for Notepad++. Do not rename! The executable file for Notepad++ is named notepad++ and + is not a valid character in Python’s import statements. This module is mapped to the right binary separately and the current name makes it possible to expose it from nvdaBuiltin for add-on developers.

class appModules.notepadPlusPlus.CharacterRangeStructLongLong

Bases: Structure

By default character ranges in Scintilla are represented by longs. However long is not big enough for files over 2 GB, therefore in 64-bit builds of Notepad++ 8.3 and later these ranges are represented by longlong.

_fields_ = [('cpMin', <class 'ctypes.c_longlong'>), ('cpMax', <class 'ctypes.c_longlong'>)]
cpMax

Structure/Union member

cpMin

Structure/Union member

class appModules.notepadPlusPlus.ScintillaTextInfoNpp83(*args, **kwargs)

Bases: ScintillaTextInfo

Text info for 64-bit builds of Notepad++ 8.3 and later.

Constructor. Subclasses may extend this to perform implementation specific initialisation, calling their superclass method afterwards.

class TextRangeStruct

Bases: Structure

_fields_ = [('chrg', <class 'appModules.notepadPlusPlus.CharacterRangeStructLongLong'>), ('lpstrText', <class 'ctypes.c_char_p'>)]
chrg

Structure/Union member

lpstrText

Structure/Union member

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.notepadPlusPlus.NppEdit(chooseBestAPI=True, **kwargs)

Bases: Scintilla

name: str = None

Type definition for auto prop ‘_get_name’

_get_TextInfo()
TextInfo

The TextInfo class this object should use to provide access to text. @type: type; L{textInfos.TextInfo}

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.notepadPlusPlus.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.nvda module

class appModules.nvda.NvdaDialog(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Fix to ensure NVDA message dialogs get reported when they pop up.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_presentationType()
_abc_impl = <_abc._abc_data object>
presentationType
_propertyCache: Set[GetterMethodT]
class appModules.nvda.NvdaDialogEmptyDescription(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Fix to ensure the NVDA settings dialog does not run getDialogText including panel descriptions when alt+tabbing back to a focused control on a panel with a description. This would result in the description being spoken twice.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_description()

Override the description property (because we can’t override the classmethod getDialogText) However this will do to ensure that the dialog is described as we wish.

_abc_impl = <_abc._abc_data object>
description: str

Typing information for auto property _get_description

_propertyCache: Set[GetterMethodT]
class appModules.nvda.NvdaPythonConsoleUIOutputClear(*args, **kwargs)

Bases: ScriptableObject

isPrevFocusOnNvdaPopup = True
script_clearOutput(gesture: inputCore.InputGesture)

Clear the output pane

__gestures = {'kb:control+l': 'clearOutput'}
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[Callable[[AutoPropertyObject], Any]]
class appModules.nvda.NvdaPythonConsoleUIOutputCtrl(*args, **kwargs)

Bases: ScriptableObject

isPrevFocusOnNvdaPopup = True
script_moveToNextResult(gesture: inputCore.InputGesture)

Move to the next result

script_moveToPrevResult(gesture: inputCore.InputGesture)

Move to the previous result

script_selectToResultEnd(gesture: inputCore.InputGesture)

Select until the end of the current result

script_selectToResultStart(gesture: inputCore.InputGesture)

Select until the start of the current result

_resultNavHelper(direction: str = 'next', select: bool = False)
__gestures = {'kb:alt+downArrow': 'moveToNextResult', 'kb:alt+downArrow+shift': 'selectToResultEnd', 'kb:alt+shift+upArrow': 'selectToResultStart', 'kb:alt+upArrow': 'moveToPrevResult'}
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[Callable[[AutoPropertyObject], Any]]
class appModules.nvda.AppModule(*args, **kwargs)

Bases: AppModule

oldProfile = None
classmethod handlePossibleProfileSwitch()
event_appModule_loseFocus()
isNvdaMenu(obj)
event_NVDAObject_init(obj)
event_gainFocus(obj, nextHandler)
event_stateChange(obj, nextHandler)
event_foreground(obj, nextHandler)
event_nameChange(obj, nextHandler)
isNvdaSettingsDialog(obj)
isNvdaPythonConsoleUIInputCtrl(obj)
isNvdaPythonConsoleUIOutputCtrl(obj)
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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.obu module

App module for OpenBook

class appModules.obu.AppModule(*args, **kwargs)

Bases: AppModule

sleepMode = True

Whether NVDA should sleep while in this application (e.g. the application is self-voicing). If C{True}, all events and script requests inside this application are silently dropped. @type: bool

_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.openwith module

class appModules.openwith.NonDefaultAppTile(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

_get_name()

The name or label of this object (example: the text of a button).

_abc_impl = <_abc._abc_data object>
name: str

Typing info for auto property _get_name()

_propertyCache: Set[GetterMethodT]
class appModules.openwith.ImmersiveOpenWithFlyout(chooseBestAPI=True, **kwargs)

Bases: Dialog, UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

role: Role = 4

Type definition for auto prop ‘_get_role’

event_focusEntered()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.openwith.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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}

isGoodUIAWindow(hwnd: int) bool

returns C{True} if the UIA implementation of the given window must be used, regardless whether native or not. This function is the counterpart of and takes precedence over L{isBadUIAWindow}. If both functions return C{False}, the decision of whether to use UIA for the window is left to core. Warning: this may be called outside of NVDA’s main thread, therefore do not try accessing NVDAObjects and such, rather just check window class names.

_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.outlook module

appModules.outlook.SECONDS_PER_DAY = 86400.0

The number of seconds in a day, used to make all day appointments and selections less verbose. Type: float

appModules.outlook.getContactString(obj)
appModules.outlook.getReceivedMessageString(obj)
appModules.outlook.getSentMessageString(obj)
class appModules.outlook.AppModule(*args, **kwargs)

Bases: AppModule

isGoodUIAWindow(hwnd: int) bool

returns C{True} if the UIA implementation of the given window must be used, regardless whether native or not. This function is the counterpart of and takes precedence over L{isBadUIAWindow}. If both functions return C{False}, the decision of whether to use UIA for the window is left to core. Warning: this may be called outside of NVDA’s main thread, therefore do not try accessing NVDAObjects and such, rather just check window class names.

_hasTriedoutlookAppSwitch = False
_registerCOMWithFocusJuggle()
_get_nativeOm()
_get_outlookVersion()
isBadUIAWindow(hwnd)

returns C{True} if the UIA implementation of the given window must be ignored due to it being broken in some way. This function is the counterpart of L{isGoodUIAWindow}. When both functions return C{True}, L{isGoodUIAWindow} takes precedence. If both functions return C{False}, the decision of whether to use UIA for the window is left to core. Warning: this may be called outside of NVDA’s main thread, therefore do not try accessing NVDAObjects and such, rather just check window class names.

event_NVDAObject_init(obj)
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 an AppModule 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>
nativeOm
outlookVersion
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]
class appModules.outlook.REListBox20W_CheckBox(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

script_checkbox(gesture)
__gestures = {'kb:space': 'checkbox'}
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.outlook.SuperGridClient2010(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

isDuplicateIAccessibleEvent(obj)

Compaires the object of an event to self to see if the event should be treeted as duplicate.

_get_shouldAllowIAccessibleFocusEvent()

Determine whether a focus event should be allowed for this object. Normally, this checks for the focused state to help eliminate redundant or invalid focus events. However, some implementations do not correctly set the focused state, so this must be overridden. @return: C{True} if the focus event should be allowed. @rtype: bool

event_gainFocus()

This code is executed if a gain focus event is received by this object.

_abc_impl = <_abc._abc_data object>
shouldAllowIAccessibleFocusEvent
_propertyCache: Set[GetterMethodT]
class appModules.outlook.AddressBookEntry(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

script_moveByEntry(gesture)
__moveByEntryGestures = ('kb:downArrow', 'kb:upArrow', 'kb:home', 'kb:end', 'kb:delete')
initOverlayClass()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.outlook.AutoCompleteListItem(chooseBestAPI=True, **kwargs)

Bases: Window

event_stateChange()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.outlook.CalendarView(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Support for announcing time slots and appointments in Outlook Calendar.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_lastStartDate = None
_generateTimeRangeText(startTime, endTime)
static _generateCategoriesText(appointment)
isDuplicateIAccessibleEvent(obj)

Compaires the object of an event to self to see if the event should be treeted as duplicate.

event_nameChange()
event_stateChange()
reportFocus()

Announces this object in a way suitable such that it gained focus.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.outlook.UIAGridRow(chooseBestAPI=True, **kwargs)

Bases: RowWithFakeNavigation, UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

rowHeaderText = None
columnHeaderText = None
_get_name()

The name or label of this object (example: the text of a button).

value: str = None

Typing information for auto property _get_value

_get_positionInfo()

Retrieves position information for this object such as its level, its index with in a group, and the number of items in that group. @return: a dictionary containing any of level, groupIndex and similarItemsInGroup.

_get_role()

The role or type of control this object represents (example: button, list, dialog).

setFocus()

Tries to force this object to take the focus.

_abc_impl = <_abc._abc_data object>
name: str

Typing info for auto property _get_name()

positionInfo: Dict[str, int]

Type definition for auto prop ‘_get_positionInfo’

role: Role

Type definition for auto prop ‘_get_role’

_propertyCache: Set[GetterMethodT]
class appModules.outlook.MailViewerTextInfoForTreeInterceptor(*args, **kwargs)

Bases: WordDocumentTextInfo

Constructor. Subclasses must extend this, calling the superclass method first. @param position: The initial position of this range; one of the POSITION_* constants or a position object supported by the implementation. @param obj: The object containing the range of text being represented.

_get_shouldIncludeLayoutTables()
_abc_impl = <_abc._abc_data object>
shouldIncludeLayoutTables
_propertyCache: Set[GetterMethodT]
class appModules.outlook.MailViewerTreeInterceptorTextInfo(*args, **kwargs)

Bases: BrowseModeWordDocumentTextInfo

Constructor. Subclasses must extend this, calling the superclass method first. @param position: The initial position of this range; one of the POSITION_* constants or a position object supported by the implementation. @param obj: The object containing the range of text being represented.

InnerTextInfoClass

alias of MailViewerTextInfoForTreeInterceptor

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.outlook.MailViewerTreeInterceptor(*args, **kwargs)

Bases: WordDocumentTreeInterceptor

A BrowseMode treeInterceptor specifically for readonly emails, where tab and shift+tab are safe and we know will not edit the document.

TextInfo

alias of MailViewerTreeInterceptorTextInfo

script_tab(gesture)
_iterTextStyle(kind: str, direction: _Movement = _Movement.NEXT, pos: TextInfo | None = None) Generator[TextInfoQuickNavItem, None, None]
__gestures = {'kb:shift+tab': 'tab', 'kb:tab': 'tab'}
_abc_impl = <_abc._abc_data object>
_lastCachedDocumentConstantIdentifier: str | None
rootNVDAObject: NVDAObjects.NVDAObject

The root object of the tree wherein events and scripts are intercepted.

_propertyCache: Set[GetterMethodT]
class appModules.outlook.BaseOutlookWordDocument(chooseBestAPI=True, **kwargs)

Bases: WordDocument

script_tab(gesture)
__gestures = {'kb:shift+tab': 'tab', 'kb:tab': 'tab'}
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.outlook.OutlookWordDocument(chooseBestAPI=True, **kwargs)

Bases: WordDocument, BaseOutlookWordDocument

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_isReadonlyViewer()
_get_treeInterceptorClass()

If this NVDAObject should use a treeInterceptor, then this property provides the L{treeInterceptorHandler.TreeInterceptor} class it should use. If not then it should be not implemented. @raises NotImplementedError when no TreeInterceptor class is available.

_get_shouldCreateTreeInterceptor()
_get_role()

The role or type of control this object represents (example: button, list, dialog).

ignoreEditorRevisions = True
ignorePageNumbers = True

True if page numbers (as well as section numbers and column numbers) should be ignored. Such as in outlook.

_abc_impl = <_abc._abc_data object>
isReadonlyViewer
role: controlTypes.Role

Type definition for auto prop ‘_get_role’

shouldCreateTreeInterceptor

Whether to create a tree interceptor for this object. This is only relevant if L{treeInterceptorClass} is valid. Normally, this should be C{True}. However, for some objects (e.g. ARIA applications), a tree interceptor shouldn’t be used by default, but the user may wish to override this. In this case, this can be set to C{False} and updated later. @type: bool

treeInterceptorClass: Type[TreeInterceptor]

Type definition for auto prop ‘_get_treeInterceptorClass’

_propertyCache: Set[GetterMethodT]
class appModules.outlook.OutlookUIAWordDocument(chooseBestAPI=True, **kwargs)

Bases: WordDocument, BaseOutlookWordDocument

Forces browse mode to be used on the UI Automation Outlook message viewer if the message is being read).

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

_get_isReadonlyViewer()
_get_shouldCreateTreeInterceptor()
_abc_impl = <_abc._abc_data object>
isReadonlyViewer
shouldCreateTreeInterceptor

Whether to create a tree interceptor for this object. This is only relevant if L{treeInterceptorClass} is valid. Normally, this should be C{True}. However, for some objects (e.g. ARIA applications), a tree interceptor shouldn’t be used by default, but the user may wish to override this. In this case, this can be set to C{False} and updated later. @type: bool

_propertyCache: Set[GetterMethodT]
class appModules.outlook.DatePickerButton(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

value: str = None

Typing information for auto property _get_value

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.outlook.DatePickerCell(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

value: str = None

Typing information for auto property _get_value

isDuplicateIAccessibleEvent(obj)

Compaires the object of an event to self to see if the event should be treeted as duplicate.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]

appModules.poedit module

App module for Poedit 3.4+.

appModules.poedit.LEFT_TO_RIGHT_EMBEDDING = '\u202a'

Character often found in translator comments.

class appModules.poedit._WindowControlId(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Static window control ID’s as defined in poedit src/static_ids.h.

NEEDS_WORK_SWITCH = 10101

The “Needs work” toggle in editing area at the bottom

TRANSLATION_ISSUE_TEXT = 10102

The error or warning line above translation field (hidden when there’s no issue; ID is of the static text child window with issue’s text)

PREVIOUS_SOURCE_TEXT = 10103

Text of previous source text (msgid) for current item (shown in sidebar, may be hidden, is static control with the text)

NOTES_FOR_TRANSLATOR = 10104

Text of notes for translators (extracted from source code) for current item (shown in sidebar, may be hidden, is static control with the text)

TRANSLATOR_COMMENT = 10105

Text of translator’s comment for current item (shown in sidebar, may be hidden, is static control with the text)

appModules.poedit._findDescendantObject(parentWindowHandle: int, controlId: int | None = None, className: str | None = None) Window | None

Finds a window with the given controlId or class name, starting from the window belonging to the given parentWindowHandle, and returns the object belonging to it.

class appModules.poedit.AppModule(*args, **kwargs)

Bases: AppModule

cachePropertiesByDefault = True

Specifies whether properties are cached by default; can be overridden for individual properties by setting _cache_propertyName. @type: bool

_getNVDAObjectForWindowControlId(windowControlId: _WindowControlId) Window | None
_translatorNotesObj: Window | None

Type definition for auto prop ‘_get__translatorNotesObj’

_get__translatorNotesObj() Window | None
_reportControlScriptHelper(obj: Window, description: str)
script_reportAutoCommentsWindow(gesture)

Reports any notes for translators. If pressed twice, presents the notes in browse mode

_commentObj: Window | None

Type definition for auto prop ‘_get__commentObj’

_get__commentObj() Window | None
script_reportCommentsWindow(gesture)

Reports any comment in the comments window. If pressed twice, presents the comment in browse mode

_previousSourceTextObj: Window | None

Type definition for auto prop ‘_get__previousSourceTextObj’

_get__previousSourceTextObj() Window | None
script_reportOldSourceText(gesture)

Reports the previous source text, if any. If pressed twice, presents the text in browse mode

_translationIssueObj: Window | None

Type definition for auto prop ‘_get__translationIssueObj’

_get__translationIssueObj() Window | None
script_reportTranslationWarning(gesture)

Reports a translation issue, if any. If pressed twice, presents the warning in browse mode

__gestures = {'kb:control+shift+a': 'reportAutoCommentsWindow', 'kb:control+shift+c': 'reportCommentsWindow', 'kb:control+shift+o': 'reportOldSourceText', 'kb:control+shift+w': 'reportTranslationWarning'}
_abc_impl = <_abc._abc_data object>
_needsWorkObj: Window | None

Type definition for auto prop ‘_get__needsWorkObj’

_get__needsWorkObj() Window | None
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 an AppModule 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}

class appModules.poedit.PoeditRichEdit(chooseBestAPI=True, **kwargs)

Bases: NVDAObject

_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
_get_name() str

The name or label of this object (example: the text of a button).

class appModules.poedit.PoeditListItem(chooseBestAPI=True, **kwargs)

Bases: NVDAObject

_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

_warningControlToReport: _WindowControlId | None
_get__warningControlToReport() int | None
_get_name()

The name or label of this object (example: the text of a button).

reportFocus()

Announces this object in a way suitable such that it gained focus.

appModules.powerpnt module

class appModules.powerpnt.EApplication

Bases: IDispatch

_iid_: ClassVar[GUID] = GUID("{914934C2-5A91-11CF-8700-00AA0060263B}")
_methods_: ClassVar[List[_ComMemberSpec]] = []
_disp_methods_: ClassVar[List[comtypes._DispMemberSpec]] = [<comtypes._memberspec._DispMemberSpec object>, <comtypes._memberspec._DispMemberSpec object>]
SlideShowNextSlide(*args, **kw)
WindowSelectionChange(*args, **kw)
class appModules.powerpnt.ppEApplicationSink(*args, **kw)

Bases: COMObject

_com_interfaces_ = [<class 'appModules.powerpnt.EApplication'>, <class 'comtypes.automation.IDispatch'>]
SlideShowNextSlide(slideShowWindow=None)
WindowSelectionChange(sel)
appModules.powerpnt.getBulletText(ppBulletFormat)
appModules.powerpnt.walkPpShapeRange(ppShapeRange)
class appModules.powerpnt.PaneClassDC(chooseBestAPI=True, **kwargs)

Bases: Window

Handles fetching of the Powerpoint object model.

presentationType = 'content'
role: controlTypes.Role = 3

Type definition for auto prop ‘_get_role’

value: str = None

Typing information for auto property _get_value

TextInfo

alias of DisplayModelTextInfo

_cache_currentSlide = False
_get_currentSlide()
_get_ppVersionMajor()
_abc_impl = <_abc._abc_data object>
currentSlide
ppVersionMajor
_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.DocumentWindow(chooseBestAPI=True, **kwargs)

Bases: PaneClassDC

Represents the document window for a presentation. Bounces focus to the currently selected slide, shape or text frame.

_get_ppDocumentViewType()
_get_ppActivePaneViewType()
_isEqual(other)

Calculates if this object is equal to another object. Used by L{NVDAObject.__eq__}. @param other: the other object to compare with. @type other: L{NVDAObject} @return: True if equal, false otherwise. @rtype: boolean

_get_name()

The name or label of this object (example: the text of a button).

_get_currentSlide()
_get_ppSelection()

Fetches and caches the current Powerpoint Selection object for the current presentation.

_get_selection()

Fetches an NVDAObject representing the current presentation’s selected slide, shape or text frame.

_get_focusRedirect()
_get_firstChild()

Retrieves the first object that this object contains. @return: the first child object if it exists else None.

handleSelectionChange()

Pushes focus to the newly selected object.

script_selectionChange(gesture)
__gestures = {'kb:backspace': 'selectionChange', 'kb:control+end': 'selectionChange', 'kb:control+home': 'selectionChange', 'kb:delete': 'selectionChange', 'kb:downArrow': 'selectionChange', 'kb:end': 'selectionChange', 'kb:home': 'selectionChange', 'kb:leftArrow': 'selectionChange', 'kb:pageDown': 'selectionChange', 'kb:pageUp': 'selectionChange', 'kb:rightArrow': 'selectionChange', 'kb:shift+control+end': 'selectionChange', 'kb:shift+control+home': 'selectionChange', 'kb:shift+downArrow': 'selectionChange', 'kb:shift+end': 'selectionChange', 'kb:shift+home': 'selectionChange', 'kb:shift+leftArrow': 'selectionChange', 'kb:shift+rightArrow': 'selectionChange', 'kb:shift+tab': 'selectionChange', 'kb:shift+upArrow': 'selectionChange', 'kb:tab': 'selectionChange', 'kb:upArrow': 'selectionChange'}
_abc_impl = <_abc._abc_data object>
currentSlide
firstChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_firstChild’

focusRedirect
name: str

Type definition for auto prop ‘_get_name’

ppActivePaneViewType
ppDocumentViewType
ppSelection
selection: textInfos.TextInfo
_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.OutlinePane(chooseBestAPI=True, **kwargs)

Bases: EditableTextWithoutAutoSelectDetection, PaneClassDC

TextInfo

alias of EditableTextDisplayModelTextInfo

role: Role = 8

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.PpObject(chooseBestAPI=True, **kwargs)

Bases: Window

The base NVDAObject for slides, shapes and text frames. Accepts and holds references to the original Document window, and the current object’s Powerpoint object. Also has some utility functions and scripts for managing selection changes. Note No events are used to detect selection changes, its all keyboard commands for now.

next: Optional['NVDAObject'] = None

The object directly after this object with the same parent.

previous: Optional['NVDAObject'] = None

The object directly before this object with the same parent.

_get_parent()

Retrieves this object’s parent (the object that contains this object). @return: the parent object if it exists else None.

script_selectionChange(gesture)
__gestures = {'kb:escape': 'selectionChange'}
_abc_impl = <_abc._abc_data object>
parent: Optional['NVDAObject']

This object’s parent (the object that contains this object).

_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.SlideBase(chooseBestAPI=True, **kwargs)

Bases: PpObject

presentationType = 'content'
findOverlayClasses(clsList)

Chooses overlay classes which should be added to this object’s class structure, after the object has been initially instantiated. After an NVDAObject class (normally an API-level class) is instantiated, this method is called on the instance to choose appropriate overlay classes.

This method may use properties, etc. on the instance to make this choice. The object’s class structure is then mutated to contain these classes.

L{initOverlayClass} is then called for each class which was not part of the initially instantiated object. This process allows an NVDAObject to be dynamically created using the most appropriate NVDAObject subclass at each API level. Classes should be listed with subclasses first. That is, subclasses should generally call super and then append their own classes to the list.

For example: Called on an IAccessible NVDAObject, the list might contain: “DialogIAccessible (a subclass of IAccessible), Edit (a subclass of Window)”.

@param clsList: The list of classes, which will be modified by this method if appropriate.

_isEqual(other)

Calculates if this object is equal to another object. Used by L{NVDAObject.__eq__}. @param other: the other object to compare with. @type other: L{NVDAObject} @return: True if equal, false otherwise. @rtype: boolean

role: controlTypes.Role = 3

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.Slide(chooseBestAPI=True, **kwargs)

Bases: SlideBase

Represents a single slide in Powerpoint.

_get_name()

The name or label of this object (example: the text of a button).

_get_positionInfo()

Retrieves position information for this object such as its level, its index with in a group, and the number of items in that group. @return: a dictionary containing any of level, groupIndex and similarItemsInGroup.

_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

positionInfo: Dict[str, int]

Type definition for auto prop ‘_get_positionInfo’

_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.Master(chooseBestAPI=True, **kwargs)

Bases: SlideBase

_get_name()

The name or label of this object (example: the text of a button).

_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.Shape(chooseBestAPI=True, **kwargs)

Bases: PpObject

Represents a single shape (rectangle, group, picture, Text bos etc in Powerpoint.

presentationType = 'content'
role: controlTypes.Role

Type definition for auto prop ‘_get_role’

_get__overlapInfo()
_getOverlapText()
_get__edgeDistances()
_getShapeLocationText(left=False, top=False, right=False, bottom=False)
_get_locationText()

A message that explains the location of the object in friendly terms.

_clearLocationCache()
script_moveHorizontal(gesture)
script_moveVertical(gesture)
_get_ppPlaceholderType()
_get_location()

The location of this object on the screen. @return: left, top, width and height of the object. @rtype: tuple of int

_get_ppShapeType()

Fetches and caches the type of this shape.

_get_ppAutoShapeType()

Fetches and caches the auto type of this shape.

_get_ppMediaType()

Fetches and caches the media type of this shape.

_get_name()

The name is calculated firstly from the object’s title, otherwize if its a generic shape, then part of its programmatic name is used.

_isEqual(other)

Calculates if this object is equal to another object. Used by L{NVDAObject.__eq__}. @param other: the other object to compare with. @type other: L{NVDAObject} @return: True if equal, false otherwise. @rtype: boolean

_get_description()

The description or help text of this object.

_get_role()

The role or type of control this object represents (example: button, list, dialog).

_get_roleText()

A custom role string for this object, which is used for braille and speech presentation, which will override the standard label for this object’s role property. No string is provided by default, meaning that NVDA will fall back to using role. Examples of where this property might be overridden are shapes in Powerpoint, or ARIA role descriptions.

_get_value()

The value of this object (example: the current percentage of a scrollbar, the selected option in a combo box).

_get_states()

Retrieves the current states of this object (example: selected, focused). @return: a set of State constants from L{controlTypes}.

_get_mathMl()

Obtain the MathML markup for an object containing math content. This will only be called (and thus only needs to be implemented) for objects with a role of L{controlTypes.Role.MATH}. @raise LookupError: If MathML can’t be retrieved for this object.

__gestures = {'kb:downArrow': 'moveVertical', 'kb:enter': 'selectionChange', 'kb:f2': 'selectionChange', 'kb:leftArrow': 'moveHorizontal', 'kb:rightArrow': 'moveHorizontal', 'kb:shift+downArrow': 'moveVertical', 'kb:shift+leftArrow': 'moveHorizontal', 'kb:shift+rightArrow': 'moveHorizontal', 'kb:shift+upArrow': 'moveVertical', 'kb:upArrow': 'moveVertical'}
_abc_impl = <_abc._abc_data object>
_edgeDistances
_overlapInfo
description: str

Typing information for auto property _get_description

location
locationText
mathMl
name: str

Type definition for auto prop ‘_get_name’

ppAutoShapeType
ppMediaType
ppPlaceholderType
ppShapeType
roleText: Optional[str]

Type definition for auto prop ‘_get_roleText’

states: Set[controlTypes.State]
value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.ChartShape(chooseBestAPI=True, **kwargs)

Bases: Shape

A PowerPoint Shape that holds an MS Office Chart. When focused, press enter to interact with the actual chart.

_get_name()

The name is calculated firstly from the object’s title, otherwize if its a generic shape, then part of its programmatic name is used.

role: controlTypes.Role = 96

Type definition for auto prop ‘_get_role’

_get_chart()
focusOnActiveDocument(chart)
script_enterChart(gesture)
__gestures = {'kb:enter': 'enterChart', 'kb:space': 'enterChart'}
_abc_impl = <_abc._abc_data object>
chart
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.TextFrameTextInfo(*args, **kwargs)

Bases: OffsetsTextInfo

Constructor. Subclasses may extend this to perform implementation specific initialisation, calling their superclass method afterwards.

_getCaretOffset()
_getSelectionOffsets()
_getTextRange(start, end)

Retrieve the text in a given offset range. @param start: The start offset. @type start: int @param end: The end offset (exclusive). @type end: int @return: The text contained in the requested range. @rtype: str

_getStoryLength()
_getLineOffsets(offset)
_getFormatFieldAndOffsets(offset, formatConfig, calculateOffsets=True)

Retrieve the formatting information for a given offset and the offsets spanned by that field. Subclasses must override this if support for text formatting is desired. The base implementation associates text with line numbers if possible.

_setCaretOffset(offset: int)
_setSelectionOffsets(start: int, end: int)
_abc_impl = <_abc._abc_data object>
class appModules.powerpnt.Table(chooseBestAPI=True, **kwargs)

Bases: Shape

Represents the table shape in Powerpoint. Provides row and column counts.

_get_ppTable()
_get_columnCount()

Retrieves the number of columns this object contains if its a table. @rtype: int

_get_rowCount()

Retrieves the number of rows this object contains if its a table. @rtype: int

_abc_impl = <_abc._abc_data object>
columnCount
ppTable
rowCount
_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.TableCell(chooseBestAPI=True, **kwargs)

Bases: PpObject

Represents a table cell in Powerpoint. Accepts a table and a row and column number as this cannot be calculated directly.

name: str = None

Type definition for auto prop ‘_get_name’

role: controlTypes.Role = 29

Type definition for auto prop ‘_get_role’

_isEqual(other)

Calculates if this object is equal to another object. Used by L{NVDAObject.__eq__}. @param other: the other object to compare with. @type other: L{NVDAObject} @return: True if equal, false otherwise. @rtype: boolean

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.TextFrame(chooseBestAPI=True, **kwargs)

Bases: EditableTextWithoutAutoSelectDetection, PpObject

Represents a Text frame in Powerpoint. Provides a suitable TextInfo.

TextInfo

alias of TextFrameTextInfo

_isEqual(other)

Calculates if this object is equal to another object. Used by L{NVDAObject.__eq__}. @param other: the other object to compare with. @type other: L{NVDAObject} @return: True if equal, false otherwise. @rtype: boolean

name: str = None

Type definition for auto prop ‘_get_name’

role: Role = 8

Type definition for auto prop ‘_get_role’

states: Set[State] = {State.MULTILINE}
_get_parent()

Retrieves this object’s parent (the object that contains this object). @return: the parent object if it exists else None.

script_caret_backspaceCharacter(gesture)
_abc_impl = <_abc._abc_data object>
parent: NVDAObject | None

This object’s parent (the object that contains this object).

_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.TableCellTextFrame(chooseBestAPI=True, **kwargs)

Bases: TextFrame

Represents a text frame inside a table cell in Powerpoint. Specifially supports the caret jumping into another cell with tab or arrows.

_isEqual(other)

Calculates if this object is equal to another object. Used by L{NVDAObject.__eq__}. @param other: the other object to compare with. @type other: L{NVDAObject} @return: True if equal, false otherwise. @rtype: boolean

__gestures = {'kb:shift+tab': 'selectionChange', 'kb:tab': 'selectionChange'}
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.NotesTextFrame(chooseBestAPI=True, **kwargs)

Bases: TextFrame

_get_parent()

Retrieves this object’s parent (the object that contains this object). @return: the parent object if it exists else None.

_abc_impl = <_abc._abc_data object>
parent: NVDAObject | None

This object’s parent (the object that contains this object).

_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.SlideShowTreeInterceptorTextInfo(*args, **kwargs)

Bases: NVDAObjectTextInfo

The TextInfo for Slide Show treeInterceptors. Based on NVDAObjectTextInfo but tweeked to work with TreeInterceptors by using basicText on the treeInterceptor’s rootNVDAObject.

Constructor. Subclasses may extend this to perform implementation specific initialisation, calling their superclass method afterwards.

_getStoryText()

Retrieve the entire text of the object. @return: The entire text of the object. @rtype: str

_getOffsetsFromNVDAObject(obj)
getTextWithFields(formatConfig: Dict | None = None) List[str | FieldCommand]

Retrieves the text in this range, as well as any control/format fields associated therewith. Subclasses may override this. The base implementation just returns the text. @param formatConfig: Document formatting configuration, useful if you wish to force a particular

configuration for a particular task.

@return: A sequence of text strings interspersed with associated field commands.

getMathMl(field)

Get MathML for a math control field. This will only be called for control fields with a role of L{controlTypes.Role.MATH}. @raise LookupError: If MathML can’t be retrieved for this field.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.SlideShowTreeInterceptor(*args, **kwargs)

Bases: DocumentTreeInterceptor

A TreeInterceptor for showing Slide show content. Has no caret navigation, a CursorManager must be used on top.

_get_isAlive()

Whether this interceptor is alive. If it is not alive, it will be removed.

hadFocusOnce = False
event_treeInterceptor_gainFocus()
event_gainFocus(obj, nextHandler)
TextInfo

alias of SlideShowTreeInterceptorTextInfo

makeTextInfo(position)
reportNewSlide()
script_toggleNotesMode(gesture)

Toggles between reporting the speaker notes or the actual slide content. This does not change what is visible on-screen, but only what the user can read with NVDA

script_slideChange(gesture)
_abc_impl = <_abc._abc_data object>
isAlive
class appModules.powerpnt.ReviewableSlideshowTreeInterceptor(*args, **kwargs)

Bases: ReviewCursorManager, SlideShowTreeInterceptor

A TreeInterceptor for Slide show content but with caret navigation via ReviewCursorManager.

__gestures = {'kb:backspace': 'slideChange', 'kb:control+shift+s': 'toggleNotesMode', 'kb:enter': 'slideChange', 'kb:pageDown': 'slideChange', 'kb:pageUp': 'slideChange', 'kb:space': 'slideChange'}
_abc_impl = <_abc._abc_data object>
class appModules.powerpnt.SlideShowWindow(chooseBestAPI=True, **kwargs)

Bases: PaneClassDC

_lastSlideChangeID = None
treeInterceptorClass

alias of ReviewableSlideshowTreeInterceptor

notesMode = False

If true then speaker notes will be exposed as this object’s basicText, rather than the actual slide content.

_get_name()

The name or label of this object (example: the text of a button).

value: str = None

Typing information for auto property _get_value

_getShapeText(shape, cellShape=False)
_get_basicText()
handleSlideChange()
_abc_impl = <_abc._abc_data object>
basicText
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class appModules.powerpnt.AppModule(*args, **kwargs)

Bases: AppModule

scriptCategory = 'PowerPoint'
hasTriedPpAppSwitch = False
_ppApplicationWindow = None
_ppApplication = None
_ppEApplicationConnectionPoint = None
isBadUIAWindow(hwnd)

returns C{True} if the UIA implementation of the given window must be ignored due to it being broken in some way. This function is the counterpart of L{isGoodUIAWindow}. When both functions return C{True}, L{isGoodUIAWindow} takes precedence. If both functions return C{False}, the decision of whether to use UIA for the window is left to core. Warning: this may be called outside of NVDA’s main thread, therefore do not try accessing NVDAObjects and such, rather just check window class names.

_registerCOMWithFocusJuggle()
_getPpObjectModelFromWindow(windowHandle)

Fetches the Powerpoint object model from a given window.

_ppApplicationFromROT = None
_getPpObjectModelFromROT(useRPC=False)
_fetchPpObjectModelHelper(windowHandle=None)
fetchPpObjectModel(windowHandle=None)
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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.putty module

App module for PuTTY

class appModules.putty.AppModule(*args, **kwargs)

Bases: AppModule

TERMINAL_WINDOW_CLASS = 'PuTTY'
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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.searchui module

App module for Start menu/Windows Search/Cortana user interface in Windows 10 Version 1909 and earlier. This app module also serves as the basis for Start menu in Windows 10 Version 2004 and later as well as Windows 11, represented by alias app modules.

class appModules.searchui.StartMenuSearchField(chooseBestAPI=True, **kwargs)

Bases: SearchField

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

announceNewLineText = False

Whether or not to announce text found before the caret on a new line (e.g. auto numbering)

_get_description() str

The description or help text of this object.

_abc_impl = <_abc._abc_data object>
description: str

Typing information for auto property _get_description

_propertyCache: Set[GetterMethodT]
class appModules.searchui.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.securecrt module

App module for SecureCRT

class appModules.securecrt.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.shellexperiencehost module

App module for Shell Experience Host, part of Windows 10 and later. Shell Experience Host is home to a number of things, including Action Center and other shell features. In Windows 11 24H2 (2024 Update and Server 2025), quick settings component is part of ShellHost.exe.

class appModules.shellexperiencehost.CalendarViewDayItem(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

_getTextFromHeaderElement(element: IUIAutomationElement) str | None
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.shellexperiencehost.ActionCenterToggleButton(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

_itemStatusMessageCache = None
_get_value()

The value of this object (example: the current percentage of a scrollbar, the selected option in a combo box).

event_UIA_itemStatus()
event_valueChange()
_abc_impl = <_abc._abc_data object>
value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]
class appModules.shellexperiencehost.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
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 an AppModule 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}

isGoodUIAWindow(hwnd: int) bool

returns C{True} if the UIA implementation of the given window must be used, regardless whether native or not. This function is the counterpart of and takes precedence over L{isBadUIAWindow}. If both functions return C{False}, the decision of whether to use UIA for the window is left to core. Warning: this may be called outside of NVDA’s main thread, therefore do not try accessing NVDAObjects and such, rather just check window class names.

_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.skype module

class appModules.skype.AppModule(*args, **kwargs)

Bases: AppModule

disableBrowseModeByDefault = True
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.soffice module

class appModules.soffice.SymphonyTextInfo(*args, **kwargs)

Bases: IA2TextTextInfo

Constructor. Subclasses may extend this to perform implementation specific initialisation, calling their superclass method afterwards.

_getFormatFieldFromLegacyAttributesString(attribsString: str, offset: int) FormatField

Get format field with information retrieved from a text attributes string containing LibreOffice’s legacy custom text attributes (used by LibreOffice <= 7.6), instead of attributes according to the IAccessible2 text attributes specification (used by LibreOffice >= 24.2).

Parameters:
  • attribsString – Legacy text attributes string.

  • offset – Character offset for which to retrieve the attributes.

Returns:

Format field containing the text attribute information.

_getFormatFieldAndOffsetsFromAttributes(offset: int, formatConfig: dict | None, calculateOffsets: bool) tuple[FormatField, tuple[int, int]]

Get format field and offset information from either attributes according to the IAccessible2 specification (for LibreOffice >= 24.2) or from legacy custom text attributes (used by LibreOffice <= 7.6 and Apache OpenOffice). :param offset: Character offset for which to retrieve the

attributes.

Parameters:
  • formatConfig – Format configuration.

  • calculateOffsets – Whether to calculate offsets.

Returns:

Format field containing the text attribute information and start and end offset of the attribute run.

_getFormatFieldAndOffsets(offset: int, formatConfig: dict | None, calculateOffsets: bool = True) tuple[FormatField, tuple[int, int]]

Retrieve the formatting information for a given offset and the offsets spanned by that field. Subclasses must override this if support for text formatting is desired. The base implementation associates text with line numbers if possible.

_getLineOffsets(offset)
_getStoryLength()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.soffice.SymphonyText(chooseBestAPI=True, **kwargs)

Bases: IAccessible, EditableText

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

TextInfo

alias of SymphonyTextInfo

_get_positionInfo()

Retrieves position information for this object such as its level, its index with in a group, and the number of items in that group. @return: a dictionary containing any of level, groupIndex and similarItemsInGroup.

_abc_impl = <_abc._abc_data object>
positionInfo: Dict[str, int]

Type definition for auto prop ‘_get_positionInfo’

_propertyCache: Set[GetterMethodT]
class appModules.soffice.SymphonyTableCell(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Silences particular states, and redundant column/row numbers

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

TextInfo

alias of SymphonyTextInfo

_get_cellCoordsText()

An alternative text representation of cell coordinates e.g. “a1”. Will override presentation of rowNumber and columnNumber. Only implement if the representation is really different.

name: str = None

Type definition for auto prop ‘_get_name’

_get_hasSelection()
_get_states()

Retrieves the current states of this object (example: selected, focused). @return: a set of State constants from L{controlTypes}.

_abc_impl = <_abc._abc_data object>
cellCoordsText: Optional[str]

Typing information for auto-property: _get_cellCoordsText

hasSelection
states: Set[State]

Type info for auto property: _get_states

_propertyCache: Set[GetterMethodT]
class appModules.soffice.SymphonyIATableCell(chooseBestAPI=True, **kwargs)

Bases: SymphonyTableCell

An overlay class for cells implementing IAccessibleTableCell

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

event_selectionAdd()
event_selectionRemove()
announceSelectionChange()
_get_cellCoordsText()

An alternative text representation of cell coordinates e.g. “a1”. Will override presentation of rowNumber and columnNumber. Only implement if the representation is really different.

_abc_impl = <_abc._abc_data object>
cellCoordsText: Optional[str]

Typing information for auto-property: _get_cellCoordsText

_propertyCache: Set[GetterMethodT]
class appModules.soffice.SymphonyTable(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

event_selectionWithIn()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.soffice.SymphonyButton(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

event_stateChange() None
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.soffice.SymphonyParagraph(chooseBestAPI=True, **kwargs)

Bases: SymphonyText

Removes redundant information that can be retreaved in other ways.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

value: str = None

Typing information for auto property _get_value

description: str = None

Typing information for auto property _get_description

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
appModules.soffice.getDistanceTextForTwips(twips)

Returns a text representation of the distance given in twips, converted to the local measurement unit.

class appModules.soffice.SymphonyDocumentTextInfo(*args, **kwargs)

Bases: TreeCompoundTextInfo

Constructor. Subclasses must extend this, calling the superclass method first. @param position: The initial position of this range; one of the POSITION_* constants or a position object supported by the implementation. @param obj: The object containing the range of text being represented.

_get_locationText()

A message that explains the location of the text position in friendly terms.

_abc_impl = <_abc._abc_data object>
locationText
class appModules.soffice.SymphonyDocument(*args, **kwargs)

Bases: CompoundDocument

TextInfo

alias of SymphonyDocumentTextInfo

GESTURE_ANNOUNCEMENT_TIMEOUT = 0.15
announceToolbarButtonToggle = False
lastFormattingGestureEventTime = 0
_backspaceScriptHelper(unit: str, gesture: InputGesture)
script_toggleTextAttribute(gesture: InputGesture)
__gestures = {'kb:control+b': 'toggleTextAttribute', 'kb:control+e': 'toggleTextAttribute', 'kb:control+i': 'toggleTextAttribute', 'kb:control+j': 'toggleTextAttribute', 'kb:control+l': 'toggleTextAttribute', 'kb:control+r': 'toggleTextAttribute', 'kb:control+shift+b': 'toggleTextAttribute', 'kb:control+shift+p': 'toggleTextAttribute', 'kb:control+u': 'toggleTextAttribute'}
_abc_impl = <_abc._abc_data object>
class appModules.soffice.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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}

event_NVDAObject_init(obj)
searchStatusBar(obj: NVDAObject, max_depth: int = 5) NVDAObject | None

Searches for and returns the status bar object if either the object itself or one of its recursive children (up to the given depth) has the corresponding role.

_get_statusBar() NVDAObject | None

Retrieve the status bar object of the application. If C{NotImplementedError} is raised, L{api.getStatusBar} will resort to perform a lookup by position. If C{None} is returned, L{GlobalCommands.script_reportStatusLine} will in turn resort to reading the bottom line of text written to the display. @rtype: NVDAObject

getStatusBarText(obj: NVDAObject) str

Get the text from the given status bar. If C{NotImplementedError} is raised, L{api.getStatusBarText} will resort to retrieve the name of the status bar and the names and values of all of its children.

_abc_impl = <_abc._abc_data object>
statusBar
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.spotify module

App module for Spotify

class appModules.spotify.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
event_gainFocus(obj, nextHandler)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.symphony module

class appModules.symphony.AppModule(*args, **kwargs)

Bases: AppModule

event_valueChange(obj, nextHandler)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.systemsettings module

App module for Settings app on Windows 10 and later (aka Immersive Control Panel).

class appModules.systemsettings.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.taskmgr module

appModules.taskmgr.isChildOfRow(obj)

calculates obj’s ancestors , discovering if this is a child of a row. If obj is a child of a row, this returns true.

class appModules.taskmgr.BrokenUIAChild(chooseBestAPI=True, **kwargs)

Bases: UIA

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

presentationType = 'content'
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.taskmgr.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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}

isBadUIAWindow(hwnd: int)

returns C{True} if the UIA implementation of the given window must be ignored due to it being broken in some way. This function is the counterpart of L{isGoodUIAWindow}. When both functions return C{True}, L{isGoodUIAWindow} takes precedence. If both functions return C{False}, the decision of whether to use UIA for the window is left to core. Warning: this may be called outside of NVDA’s main thread, therefore do not try accessing NVDAObjects and such, rather just check window class names.

_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.teams module

App module for Microsoft Teams.

class appModules.teams.PopOverMenu(chooseBestAPI=True, **kwargs)

Bases: Ia2Web

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

shouldAllowIAccessibleMenuStartEvent = False
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.teams.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.teamtalk4classic module

class appModules.teamtalk4classic.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.thunderbird module

App module for Thunderbird email client.

class appModules.thunderbird.AppModule(*args, **kwargs)

Bases: AppModule

event_gainFocus(obj, nextHandler)
event_nameChange(obj: NVDAObject, nextHandler: Callable[[], None]) None
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.totalcmd module

class appModules.totalcmd.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]
class appModules.totalcmd.TCList(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

event_gainFocus()

This code is executed if a gain focus event is received by this object.

reportFocus()

Announces this object in a way suitable such that it gained focus.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]

appModules.ttermpro module

App module for Tera Term

class appModules.ttermpro.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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}

event_nameChange(obj, nextHandler)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.tween module

App module for Tween

class appModules.tween.TweetListItem(chooseBestAPI=True, **kwargs)

Bases: ListItem

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

initOverlayClass()
_get_name()

The name or label of this object (example: the text of a button).

_getColumnHeaderRaw(index: int) str | None
_getColumnContentRaw(index: int) str | None
_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class appModules.tween.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.utorrent module

App module for µTorrent

class appModules.utorrent.DuplicateFocusListView(chooseBestAPI=True, **kwargs)

Bases: IAccessible

A list view which annoyingly fires focus events every second, even when a menu is open.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_shouldAllowIAccessibleFocusEvent()

Determine whether a focus event should be allowed for this object. Normally, this checks for the focused state to help eliminate redundant or invalid focus events. However, some implementations do not correctly set the focused state, so this must be overridden. @return: C{True} if the focus event should be allowed. @rtype: bool

_abc_impl = <_abc._abc_data object>
shouldAllowIAccessibleFocusEvent
_propertyCache: Set[GetterMethodT]
class appModules.utorrent.TorrentContentsListItem(chooseBestAPI=True, **kwargs)

Bases: ListItem

Items of the Torrent Contents list in the Add Torrent dialog. The file names aren’t exposed via APIs, though the other column (size) is.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_getColumnContent(column)

Get the text content for a given column of this row. Subclasses must override this method. @param column: The index of the column, starting at 1. @type column: int @rtype: str

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.utorrent.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.vipmud module

class appModules.vipmud.AppModule(*args, **kwargs)

Bases: AppModule

lastLength = 0
msgs = []
historyLength = 9
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 an AppModule 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}

script_readMessage(gesture)

Displays one of the recent messages

__gestures = {'kb:control+1': 'readMessage', 'kb:control+2': 'readMessage', 'kb:control+3': 'readMessage', 'kb:control+4': 'readMessage', 'kb:control+5': 'readMessage', 'kb:control+6': 'readMessage', 'kb:control+7': 'readMessage', 'kb:control+8': 'readMessage', 'kb:control+9': 'readMessage'}
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]
class appModules.vipmud.MudText(chooseBestAPI=True, **kwargs)

Bases: Edit

event_valueChange()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]

appModules.webconferenceplugin module

AppModule to remove redundant progressbar announcement from the web conference plugin.

class appModules.webconferenceplugin.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.winamp module

class appModules.winamp.fileinfo2

Bases: Structure

_fields_ = [('fileindex', <class 'ctypes.c_long'>), ('filetitle', <class 'appModules.winamp.c_char_Array_256'>), ('filelength', <class 'appModules.winamp.c_char_Array_16'>)]
fileindex

Structure/Union member

filelength

Structure/Union member

filetitle

Structure/Union member

appModules.winamp.getShuffle()
appModules.winamp.getRepeat()
class appModules.winamp.AppModule(*args, **kwargs)

Bases: AppModule

event_NVDAObject_init(obj)
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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]
class appModules.winamp.winampMainWindow(chooseBestAPI=True, **kwargs)

Bases: IAccessible

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

event_nameChange()
script_shuffleToggle(gesture)
script_repeatToggle(gesture)
__gestures = {'kb:r': 'repeatToggle', 'kb:s': 'shuffleToggle'}
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.winamp.winampPlaylistEditor(chooseBestAPI=True, **kwargs)

Bases: winampMainWindow

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

_get_name()

The name or label of this object (example: the text of a button).

_get_role()

The role or type of control this object represents (example: button, list, dialog).

script_changeItem(gesture)
event_nameChange()
__changeItemGestures = ('kb:upArrow', 'kb:downArrow', 'kb:pageUp', 'kb:pageDown')
_abc_impl = <_abc._abc_data object>
initOverlayClass()
name: str

Type definition for auto prop ‘_get_name’

role: controlTypes.Role

Type definition for auto prop ‘_get_role’

_propertyCache: Set[GetterMethodT]

appModules.windowsinternal_composableshell_experiences_textinput_inputapp module

App module for Windows 10/11 Modern Keyboard aka new touch keyboard panel. The chief feature is allowing NVDA to announce selected emoji when using the keyboard to search for and select one. Other features include reporting candidates for misspellings if suggestions for hardware keyboard is selected, and managing cloud clipboard paste. This is applicable on Windows 10 Fall Creators Update and later.

class appModules.windowsinternal_composableshell_experiences_textinput_inputapp.ImeCandidateUI(chooseBestAPI=True, **kwargs)

Bases: UIA

The UIAutomation-based IME candidate UI (such as for the modern Chinese Microsoft Quick input). This class ensures NVDA is notified of the first selected item when the UI is shown.

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

event_show()
event_focusEntered()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.windowsinternal_composableshell_experiences_textinput_inputapp.ImeCandidateItem(chooseBestAPI=True, **kwargs)

Bases: CandidateItem, UIA

A UIAutomation-based IME candidate Item (such as for the modern Chinese Microsoft Quick input). This class presents Ime candidate items in the standard way NVDA does for all other IMEs. E.g. reports entire candidate page content if it is new or has changed pages, And reports the currently selected item, including symbol descriptions.

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

keyboardShortcut = ''
_get_candidateNumber()
_get_parent()

Retrieves this object’s parent (the object that contains this object). @return: the parent object if it exists else None.

_get_name()

The name or label of this object (example: the text of a button).

_get_description()

The description or help text of this object.

_get_basicText()
event_UIA_elementSelected()
_abc_impl = <_abc._abc_data object>
basicText
candidateNumber
description: str

Typing information for auto property _get_description

name: str

Typing info for auto property _get_name()

parent: NVDAObject | None

This object’s parent (the object that contains this object).

_propertyCache: Set[GetterMethodT]
class appModules.windowsinternal_composableshell_experiences_textinput_inputapp.NavigationMenuItem(chooseBestAPI=True, **kwargs)

Bases: ListItem

A Windows 11 emoji panel navigation menu item. In Windows 10 Version 1903 and later, emoji panel can be used to insert emojis, kaomojis, and symbols. System focus cannot move to these choices in Windows 10 but can do so in Windows 11. In addition to the choices above, Windows 11 adds GIF and clipboard history to navigation menu.

An NVDAObject for a UI Automation element. @param windowHandle: if a UIAElement is not specifically given, then this windowHandle is used to fetch its root UIAElement @type windowHandle: int @param UIAElement: the UI Automation element that should be represented by this NVDAObject The UI Automation element must have been created with a L{UIAHandler.handler.baseCacheRequest} @type UIAElement: L{UIAHandler.IUIAutomationElement} @param initialUIACachedPropertyIDs: Extra UI Automation properties the given UIAElement has already had cached with a UIA cache request that inherits from L{UIAHandler.handler.baseCacheRequest}. Cached values of these properties will be available for the remainder of the current core cycle. After that, new values will be fetched. @type initialUIACachedPropertyIDs: L{UIAHandler.IUIAutomationCacheRequest}

event_UIA_elementSelected() None
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.windowsinternal_composableshell_experiences_textinput_inputapp.AppModule(*args, **kwargs)

Bases: AppModule

_recentlySelected = None
disableBrowseModeByDefault: bool = True
event_UIA_elementSelected(obj, nextHandler)
_classicEmojiPanelAutomationIds = ('TEMPLATE_PART_ExpressiveInputFullViewFuntionBarItemControl', 'TEMPLATE_PART_ExpressiveInputFullViewFuntionBarCloseButton')
event_UIA_window_windowOpen(obj, nextHandler)
_emojiPanelJustOpened = False
event_nameChange(obj, nextHandler)
event_UIA_notification(obj: NVDAObject, nextHandler: Callable[[], None], displayString: str | None = None, activityId: str | None = None, **kwargs)
event_gainFocus(obj: NVDAObject, nextHandler: Callable[[], None])
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 an AppModule 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>

appModules.winword module

App module for Microsoft Word. Word and Outlook share a lot of code and components. This app module gathers the code that is relevant for Microsoft Word only.

class appModules.winword.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]
class appModules.winword.WinwordWordDocument(chooseBestAPI=True, **kwargs)

Bases: WordDocument

script_toggleChangeTracking(gesture)
__gestures = {'kb:control+shift+e': 'toggleChangeTracking'}
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]

appModules.wlmail module

class appModules.wlmail.AboutBlankDocument(chooseBestAPI=True, **kwargs)

Bases: MSHTML

A document called about:blank which hosts the HTML message composer document using viewlink. Unfortunately, there doesn’t seem to be any way to access the real (editable) viewlink document. Therefore, we need to ignore this about:blank document so the user can access the editable document.

@param windowHandle: the window handle, if known @param IAccessibleChildID: A child ID that will be used on all methods of the IAccessible pointer

role: controlTypes.Role = 0

Type definition for auto prop ‘_get_role’

event_gainFocus()

This code is executed if a gain focus event is received by this object.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class appModules.wlmail.AppModule(*args, **kwargs)

Bases: AppModule

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 an AppModule 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}

event_gainFocus(obj, nextHandler)
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.wwahost module

App module host for Windows 8.x and 10 apps hosted by wwahost.exe. In Windows 8, apps written in Javascript are executed inside WWAHost, including some WinRT apps. In Windows 10, progressive web apps (PWA) and friends are hosted inside this process. App modules wishing to support apps hosted inside this process must subclass the AppModule class.

appModules.wwahost.getAppNameFromHost(processId)
class appModules.wwahost.AppModule(*args, **kwargs)

Bases: AppModule

disableBrowseModeByDefault = True
_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]

appModules.zoom module

class appModules.zoom.AppModule(*args, **kwargs)

Bases: AppModule

_abc_impl = <_abc._abc_data object>
processID: int

The ID of the process this appModule is for

appName: str

The application name

helperLocalBindingHandle: ctypes.c_long | None

RPC binding handle pointing to the RPC server for this process

_propertyCache: Set[GetterMethodT]