NVDAObjects.IAccessible package

NVDAObjects.IAccessible.getNVDAObjectFromEvent(hwnd, objectID, childID)
NVDAObjects.IAccessible.getNVDAObjectFromPoint(x, y)
NVDAObjects.IAccessible.normalizeIA2TextFormatField(formatField)
class NVDAObjects.IAccessible.IA2TextTextInfo(*args, **kwargs)

Bases: OffsetsTextInfo

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

detectFormattingAfterCursorMaybeSlow: bool = False

Honours documentFormatting config option if true - set to false if this is not at all slow.

_get_encoding()
_getOffsetFromPoint(x, y)
classmethod _getBoundingRectFromOffsetInObject(obj, offset)
_getBoundingRectFromOffset(offset)
_get_unit_mouseChunk()
expand(unit)

Expands the start and end of this text info object to a given unit @param unit: a unit constant @type unit: string

_getCaretOffset()
_setCaretOffset(offset: int) None
_getSelectionOffsets()
_setSelectionOffsets(start, end)
_getStoryLength()
_getLineCount()
_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

_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.

_getCharacterOffsets(offset)
_getWordOffsets(offset)
_getLineOffsets(offset)
_getSentenceOffsets(offset)
_getParagraphOffsets(offset)
_lineNumFromOffset(offset)
_iterTextWithEmbeddedObjects(withFields, formatConfig=None) Generator[FieldCommand | str | int, None, None]

Iterate through the text, splitting at embedded object characters. Where an embedded object character occurs, its offset is provided. @param withFields: Whether to output control/format fields. @type withFields: bool @param formatConfig: Document formatting configuration. @return: A generator of fields, text strings and numeric offsets of embedded object characters.

_abc_impl = <_abc._abc_data object>
encoding: str | None

The encoding internal to the underlying text info implementation.

unit_mouseChunk
class NVDAObjects.IAccessible.IAccessible(chooseBestAPI=True, **kwargs)

Bases: Window

the NVDAObject for IAccessible @ivar IAccessibleChildID: the IAccessible object’s child ID @type IAccessibleChildID: int

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

IAccessibleTableUsesTableCellIndexAttrib = False
classmethod getPossibleAPIClasses(kwargs, relation=None)

Provides a generator which can generate all the possible API classes (in priority order) that inherit directly from the class it was called on. @param relation: the relationship of a possible new object of this type to another object creating it (e.g. parent). @param type: string @param kwargs: the arguments necessary to construct an object of the class this method was called on. @type kwargs: dictionary @returns: a generator @rtype: generator

classmethod kwargsFromSuper(kwargs, relation=None)

Finds out if this class can be instanciated from the given super kwargs. If so it updates the kwargs to contain everything it will need to instanciate this class, and returns True. If this class can not be instanciated, it returns False and kwargs is not touched. @param relation: why is this class being instanciated? parent, focus, foreground etc… @type relation: string @param kwargs: the kwargs for constructing this class’s super class. @type kwargs: dict @rtype: boolean

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.

IA2UniqueID = None

The cached IAccessible2::uniqueID if its implemented

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

_get_shouldAllowIAccessibleMenuStartEvent() bool

Determine whether an IAccessible menu start or menu popup start event should be allowed for this object. @return: C{True} if the event should be allowed.

_get_TextInfo()
_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_value()

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

_get_actionCount()

Retrieves the number of actions supported by this object.

getActionName(index=None)

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(index=None)

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

_get_IAccessibleIdentity()
IAccessibleRole: int

Type definition for auto prop ‘_get_IAccessibleRole’

_get_IAccessibleRole() int
_get_role()

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

_cache_role = False
IAccessibleStates: int

Type info for auto property: _get_IAccessibleStates

_get_IAccessibleStates() int
states: Set[State]

Type info for auto property: _get_states

_get_states() Set[State]

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

re_positionInfoEncodedAccDescription = re.compile('L(?P<level>\\d+)(?:, (?P<indexInGroup>\\d+) of (?P<similarItemsInGroup>\\d+))?')
_get_decodedAccDescription()
hasEncodedAccDescription = False
_get_description()

The description or help text of this object.

_get_keyboardShortcut()

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

_get_childCount()

Retrieves the number of children this object contains. @rtype: int

_get_location()

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

isPointInObject(x, y)
_get_labeledBy()

Retrieves the object that this object is labeled by (example: the static text label beside an edit field). @return: the label object if it has one else None. @rtype: L{NVDAObject} or None

_get_parent()

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

_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_firstChild()

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

_get_lastChild()

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

_get_children()

Retrieves a list of all the objects directly contained by this object (who’s parent is this object). @rtype: list of L{NVDAObject}

getChild(index)

Retrieve a child by index. @note: Subclasses may override this if they have an efficient way to retrieve a single, arbitrary child.

The base implementation uses L{children}.

@param index: The 0-based index of the child to retrieve. @return: The child.

IA2Attributes: Dict[str, str]

Type definition for auto prop ‘_get_IA2Attributes’

_get_IA2Attributes() Dict[str, str]
event_IA2AttributeChange()
_get_rowNumber()

Retrieves the row number of this object if it is in a table. @rtype: int

_get_presentationalRowNumber()

An optional version of the rowNumber property used purely for speech and braille presentation if implemented. This is never used for navigational logic. This property should be implemented if the table has virtual content which may not all be loaded at one time. For example, a table with 1000 rows and 1000 columns, yet the table only shows perhaps 10 rows by 10 columns at a time. Although the rowNumber might be row 2 of 10, the user needs to be told it is perhaps row 500 (taking all virtual rows into account). If the underlying APIs do not distinguish between virtual and physical cell coordinates, then this property should not be implemented. @rtype: int

_get_rowSpan()

The number of rows spanned by this cell. @rtype: int

_get_columnNumber()

Retrieves the column number of this object if it is in a table. @rtype: int

_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.

_get_presentationalColumnNumber()

An optional version of the columnNumber property used purely for speech and braille presentation if implemented. This is never used for navigational logic. This property should be implemented if the table has virtual content which may not all be loaded at one time. For example, a table with 1000 rows and 1000 columns, yet the table only shows perhaps 10 rows by 10 columns at a time. Although the columnNumber might be column 2 of 10, the user needs to be told it is perhaps column 500 (taking all virtual columns into account). If the underlying APIs do not distinguish between virtual and physical cell coordinates, then this property should not be implemented. @rtype: int

_get_columnSpan()

The number of columns spanned by this cell. @rtype: int

_get_rowCount()

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

_get_presentationalRowCount()

An optional version of the rowCount property used purely for speech and braille presentation if implemented. This is never used for navigational logic. This property should be implemented if the table has virtual content which may not all be loaded at one time. For example, a table with 1000 rows and 1000 columns, yet the table only shows perhaps 10 rows by 10 columns at a time. Although the rowCount might be 10, the user needs to be told the table really has 1000 rows. If the underlying APIs do not distinguish between virtual and physical cell coordinates, then this property should not be implemented. @rtype: int

_get_columnCount()

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

_get_presentationalColumnCount()

An optional version of the columnCount property used purely for speech and braille presentation if implemented. This is never used for navigational logic. This property should be implemented if the table has virtual content which may not all be loaded at one time. For example, a table with 1000 rows and 1000 columns, yet the table only shows perhaps 10 rows by 10 columns at a time. Although the columnCount might be 10, the user needs to be told the table really has 1000 columns. If the underlying APIs do not distinguish between virtual and physical cell coordinates, then this property should not be implemented. @rtype: int

_get__IATableCell()
_tableHeaderTextHelper(axis)
_get_rowHeaderText()

The text of the row headers for this cell. @rtype: str

_get_columnHeaderText()

The text of the column headers for this cell. @rtype: str

_get_selectionContainer()

An ancestor NVDAObject which manages the selection for this object and other descendants.

_getSelectedItemsCount_accSelection(maxCount: int) int
getSelectedItemsCount(maxCount=2)

Fetches the number of descendants currently selected. For performance, this method will only count up to the given maxCount number, and if there is one more above that, then sys.maxint is returned stating that many items are selected.

_get_table()

Retrieves the object that represents the table that this object is contained in, if this object is a table cell. @rtype: L{NVDAObject}

_get_tableID()

The identifier of the table associated with this object if it is a table cell. This identifier must distinguish this table from other tables. If this is not implemented, table cell information will still be reported, but row and column information will always be reported even if the user moves to a cell in the same row/column.

_get_activeChild()

Retrieves the child of this object that currently has, or contains, the focus. @return: the active child if it has one else None @rtype: L{NVDAObject} or None

_get_hasFocus()

Whether this object has focus. @rtype: bool

setFocus()

Tries to force this object to take the focus.

scrollIntoView()

Scroll this object into view on the screen if possible.

_get_allowIAccessibleChildIDAndChildCountForPositionInfo()

if true position info should fall back to using the childID and the parent’s accChildCount for position information if there is nothing better available.

_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_indexInParent()

The index of this object in its parent object. @return: The 0 based index, C{None} if there is no parent. @raise NotImplementedError: If not supported by the underlying object.

_IA2Relations: List[IAccessibleRelation]

Type definition for auto prop ‘_get__IA2Relations’

_get__IA2Relations() List[IAccessibleRelation]
_getIA2TargetsForRelationsOfType(relationType: RelationType, maxRelations: int = 1) Generator[IUnknown, None, None]

Gets the target IAccessible (actually IUnknown; use QueryInterface or normalizeIAccessible to resolve) for the relations with given type. Allows escape of exception: COMError(-2147417836, ‘Requested object does not exist.’), callers should handle this, for this reason consider using _getIA2RelationFirstTarget if only the first target is required, and you wish the target to be converted to an IAccessible

_getIA2RelationFirstTarget(relationType: str | RelationType) IAccessible | None

Get the first target for the relation of type. @param relationType: The type of relation to fetch.

_getIA2RelationTargetsOfType(relationType: str | RelationType) Iterable[IAccessible]

Get the targets for the relation of type. Higher level function than _getIA2TargetsForRelationsOfType @param relationType: The type of relation to fetch.

detailsRelations: Tuple[IAccessible]

Type definition for auto prop ‘_get_detailsRelations’

_get_detailsRelations() Tuple[IAccessible]
_get_controllerFor() List[NVDAObject]

Retrieves the object/s that this object controls.

flowsTo: IAccessible | None

Type definition for auto prop ‘_get_flowsTo’

_get_flowsTo() IAccessible | None

The object to which content flows from this object. @return: The object to which this object flows, C{None} if none. @rtype: L{NVDAObject} @raise NotImplementedError: If not supported by the underlying object.

flowsFrom: IAccessible | None

Type definition for auto prop ‘_get_flowsFrom’

_get_flowsFrom() IAccessible | None

The object from which content flows to this object. @return: The object from which this object flows, C{None} if none. @rtype: L{NVDAObject} @raise NotImplementedError: If not supported by the underlying object.

_get_errorMessage() str | None

Retrieves the string that describes the error for this control, if one exists.

Returns:

A string describing the error, else None.

event_valueChange()
event_alert() None
event_caret()
_get_groupName()
event_selectionAdd()
event_selectionRemove()
event_selectionWithIn()
_get_isPresentableFocusAncestor()

Determine if this object should be presented to the user in the focus ancestry. @return: C{True} if it should be presented in the focus ancestry, C{False} if not. @rtype: bool

_get_devInfo()

Information about this object useful to developers. Subclasses may extend this, calling the superclass property first. @return: A list of text strings providing information about this object useful to developers.

_get_language()
_get_iaHypertext()
_get_IA2WindowHandle()
_cache_IA2WindowHandle = False
IA2States: int

Type info for auto property: _get_IA2States

_get_IA2States() int
summarizeInProcess() str

Uses nvdaInProcUtils to get the text for an IAccessible. Can be used without a virtual buffer loaded.

IA2WindowHandle
IAccessibleIdentity
TextInfo

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

_IATableCell
_abc_impl = <_abc._abc_data object>
actionCount
activeChild
allowIAccessibleChildIDAndChildCountForPositionInfo
cellCoordsText: Optional[str]

Typing information for auto-property: _get_cellCoordsText

childCount
children: List['NVDAObject']

Type definition for auto prop ‘_get_children’

columnCount
columnHeaderText
columnNumber
columnSpan
controllerFor
decodedAccDescription
description: str

Typing information for auto property _get_description

devInfo: List[str]

Information about this object useful to developers.

errorMessage: str | None

Type definition for auto prop “_get_errorMessage”

firstChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_firstChild’

groupName
hasFocus: bool

Type definition for auto prop ‘_get_hasFocus’

iaHypertext
indexInParent: int | None

Type definition for auto prop ‘_get_indexInParent’

isPresentableFocusAncestor
keyboardShortcut
labeledBy
language

The language/locale of this object. @type: str

lastChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_lastChild’

location
name: str

Type definition for auto prop ‘_get_name’

next: Optional['NVDAObject']

The object directly after this object with the same parent.

parent: Optional['NVDAObject']

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

positionInfo: Dict[str, int]

Type definition for auto prop ‘_get_positionInfo’

presentationalColumnCount
presentationalColumnNumber
presentationalRowCount
presentationalRowNumber
previous: Optional['NVDAObject']

The object directly before this object with the same parent.

role: controlTypes.Role

Type definition for auto prop ‘_get_role’

rowCount
rowHeaderText
rowNumber
rowSpan
selectionContainer
shouldAllowIAccessibleFocusEvent
shouldAllowIAccessibleMenuStartEvent
table
tableID
value: str

Typing information for auto property _get_value

class NVDAObjects.IAccessible.ContentGenericClient(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

TextInfo

alias of DisplayModelTextInfo

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

Type definition for auto prop ‘_get_role’

_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 NVDAObjects.IAccessible.GenericWindow(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

TextInfo

alias of DisplayModelTextInfo

isPresentableFocusAncestor = False
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.WindowRoot(chooseBestAPI=True, **kwargs)

Bases: GenericWindow

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

parentUsesSuperOnWindowRootIAccessible = True
classmethod windowHasExtraIAccessibles(windowHandle)

Finds out whether this window has things such as a system menu / titleBar / scroll bars, which would be represented as extra IAccessibles

_get_presentationType()
_get_parent()

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

_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_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
next: Optional['NVDAObject']

The object directly after this object with the same parent.

parent: Optional['NVDAObject']

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

presentationType
previous: Optional['NVDAObject']

The object directly before this object with the same parent.

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.ShellDocObjectView(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 NVDAObjects.IAccessible.JavaVMRoot(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_firstChild()

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

_get_lastChild()

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

_get_children()

Retrieves a list of all the objects directly contained by this object (who’s parent is this object). @rtype: list of L{NVDAObject}

_abc_impl = <_abc._abc_data object>
children: List['NVDAObject']

Type definition for auto prop ‘_get_children’

firstChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_firstChild’

lastChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_lastChild’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.NUIDialogClient(chooseBestAPI=True, **kwargs)

Bases: Dialog

role: Role = 4

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.Groupbox(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

_getNextSkipWindows(obj)
_get_description()

The description or help text of this object.

_get_isPresentableFocusAncestor()

Determine if this object should be presented to the user in the focus ancestry. @return: C{True} if it should be presented in the focus ancestry, C{False} if not. @rtype: bool

_abc_impl = <_abc._abc_data object>
description: str

Typing information for auto property _get_description

isPresentableFocusAncestor
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.TrayClockWClass(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Based on NVDAObject but the role is changed to clock. Depending on the version of Windows name or value contains left-to-right or right-to-left characters, so remove them from both.

@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).

_get_name()

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

_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>
name: str

Type definition for auto prop ‘_get_name’

role: controlTypes.Role

Type definition for auto prop ‘_get_role’

value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.OutlineItem(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).

_abc_impl = <_abc._abc_data object>
value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.List(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_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 NVDAObjects.IAccessible.SysLinkClient(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

reportFocus()

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

_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]

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 NVDAObjects.IAccessible.TaskList(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

isPresentableFocusAncestor = False
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 NVDAObjects.IAccessible.TaskListIcon(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

allowIAccessibleChildIDAndChildCountForPositionInfo = True
_get_role()

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

reportFocus()

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

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

Type definition for auto prop ‘_get_role’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.MenuItem(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_description()

The description or help text of this object.

_get_name()

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

event_gainFocus()

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

_abc_impl = <_abc._abc_data object>
description: str

Typing information for auto property _get_description

name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.Taskbar(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

name: str = 'Taskbar'

Type definition for auto prop ‘_get_name’

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 NVDAObjects.IAccessible.Button(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 NVDAObjects.IAccessible.InaccessibleListBoxItem(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Used for list item IAccessibles in inaccessible owner drawn ListBox controls. Overrides name to use display model text as MSAA doesn’t provide a suitable name (it’s usually either empty or contains garbage).

@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 NVDAObjects.IAccessible.InaccessibleComboBox(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Used for inaccessible owner drawn ComboBox controls. Overrides value to use display model text as MSAA doesn’t provide a suitable vale (it’s usually either empty or contains garbage).

@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).

_abc_impl = <_abc._abc_data object>
value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.StaticText(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Support for owner-drawn staticText controls where accName is empty.

@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 NVDAObjects.IAccessible.Titlebar(chooseBestAPI=True, **kwargs)

Bases: IAccessible

A class for the standard MSAA titlebar, which shortcuts presentationType to be layout (for performance) and makes the description property empty, as the standard accDescription is rather annoying.

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

presentationType = 'layout'
_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 NVDAObjects.IAccessible.ReBarWindow32Client(chooseBestAPI=True, **kwargs)

Bases: IAccessible

The client IAccessible for a ReBarWindow32 window. Overrides firstChild/lastChild as accNavigate is not implemented, and IEnumVariant (children) gives back some strange buttons beside each child window with no accNavigate.

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

_get_firstChild()

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

_get_lastChild()

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

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

Type definition for auto prop ‘_get_firstChild’

lastChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_lastChild’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.ListviewPane(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

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

Type definition for auto prop ‘_get_role’

TextInfo

alias of DisplayModelTextInfo

name: str = ''

Type definition for auto prop ‘_get_name’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.IEFrameNotificationBar(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_show()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.IENotificationBar(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

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

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
role: Role = 138

Type definition for auto prop ‘_get_role’

event_alert()
class NVDAObjects.IAccessible.UIItem(chooseBestAPI=True, **kwargs)

Bases: IAccessible

List items in Windows Explorer repeat the name as the value

@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>
value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]
_get_value()

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

Submodules

NVDAObjects.IAccessible.MSHTML module

class NVDAObjects.IAccessible.MSHTML.UIAMSHTMLTextInfo(*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.

_atEndOfStory = False
copy()

duplicates this text info object so that changes can be made to either one with out afecting the other

expand(unit)

Expands the start and end of this text info object to a given unit @param unit: a unit constant @type unit: string

move(unit, direction, endPoint=None)

Moves one or both of the endpoints of this object by the given unit and direction. @param unit: the unit to move by; one of the UNIT_* constants. @param direction: a positive value moves forward by a number of units, a negative value moves back a number of units @type: int @param endPoint: Either None, “start” or “end”. If “start” then the start of the range is moved, if “end” then the end of the range is moved, if None - not specified then collapse to start and move both start and end. @return: The number of units moved;

negative indicates backward movement, positive indicates forward movement, 0 means no movement.

@rtype: int

_abc_impl = <_abc._abc_data object>
_rangeObj: IUIAutomationTextRangeT
class NVDAObjects.IAccessible.MSHTML.HTMLAttribCache(HTMLNode)

Bases: object

NVDAObjects.IAccessible.MSHTML.getZoomFactorsFromHTMLDocument(HTMLDocument)
NVDAObjects.IAccessible.MSHTML.IAccessibleFromHTMLNode(HTMLNode)
NVDAObjects.IAccessible.MSHTML.HTMLNodeFromIAccessible(IAccessibleObject)
NVDAObjects.IAccessible.MSHTML.locateHTMLElementByID(document, ID)
NVDAObjects.IAccessible.MSHTML.getChildHTMLNodeFromFrame(frame)
class NVDAObjects.IAccessible.MSHTML.MSHTMLTextInfo(*args, **kwargs)

Bases: TextInfo

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.

_expandToLine(textRange)
expand(unit)

Expands the start and end of this text info object to a given unit @param unit: a unit constant @type unit: string

_get_isCollapsed()

@return: C{True} if representing a collapsed range, C{False} if the range is expanded to cover one or more characters. @rtype: bool

collapse(end=False)

Collapses this text info object so that both endpoints are the same. @param end: Whether to collapse to the end; C{True} to collapse to the end, C{False} to collapse to the start. @type end: bool

copy()

duplicates this text info object so that changes can be made to either one with out afecting the other

compareEndPoints(other, which)

compares one end of this range to one end of another range. Subclasses must implement this. @param other: the text range to compare with. @type other: L{TextInfo} @param which: The ends to compare; one of “startToStart”, “startToEnd”, “endToStart”, “endToEnd”. @return: -1 if this end is before other end, 1 if this end is after other end or 0 if this end and other end are the same. @rtype: int

setEndPoint(other, which)

Sets one end of this range to one end of another range. Subclasses must implement this. @param other: The range from which an end is being obtained. @type other: L{TextInfo} @param which: The ends to use; one of “startToStart”, “startToEnd”, “endToStart”, “endToEnd”.

_get_text()

The text with in this range. Subclasses must implement this. @return: The text. @note: The text is not guaranteed to be the exact length of the range in offsets.

move(unit, direction, endPoint=None)

Moves one or both of the endpoints of this object by the given unit and direction. @param unit: the unit to move by; one of the UNIT_* constants. @param direction: a positive value moves forward by a number of units, a negative value moves back a number of units @type: int @param endPoint: Either None, “start” or “end”. If “start” then the start of the range is moved, if “end” then the end of the range is moved, if None - not specified then collapse to start and move both start and end. @return: The number of units moved;

negative indicates backward movement, positive indicates forward movement, 0 means no movement.

@rtype: int

updateCaret()

Moves the system caret to the position of this text info object

updateSelection()

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

_get_bookmark()
_abc_impl = <_abc._abc_data object>
bookmark
isCollapsed
text: str

Typing information for auto-property: _get_text

class NVDAObjects.IAccessible.MSHTML.MSHTML(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__UIAControl()
makeTextInfo(position)
HTMLNodeNameNavSkipList = ['#comment', 'SCRIPT', 'HEAD', 'HTML', 'PARAM', 'STYLE']
HTMLNodeNameEmbedList = ['OBJECT', 'EMBED', 'APPLET', 'FRAME', 'IFRAME']
_ignoreCaretEvents = False
suspendCaretEvents()

Suspends caret events while you need to move the caret to calculate things.

event_caret()
classmethod kwargsFromSuper(kwargs, relation=None)

Finds out if this class can be instanciated from the given super kwargs. If so it updates the kwargs to contain everything it will need to instanciate this class, and returns True. If this class can not be instanciated, it returns False and kwargs is not touched. @param relation: why is this class being instanciated? parent, focus, foreground etc… @type relation: string @param kwargs: the kwargs for constructing this class’s super class. @type kwargs: dict @rtype: boolean

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.

_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_isCurrent() IsCurrent

Gets the value that indicates whether this object is the current element in a set of related elements. This maps to aria-current.

HTMLAttributes: HTMLAttribCache

Typing for autoproperty _get_HTMLAttributes

_get_HTMLAttributes()
_get_placeholder()

If it exists for this object get the value of the placeholder text. For example this might be the aria-placeholder text for a field in a web page. @return: the placeholder text else None @rtype: String or None

_get_zoomFactors()
_get_location()

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

_get_TextInfo()
isDuplicateIAccessibleEvent(obj)

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

_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_presentationType()
_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_name()

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

_get_landmark()

If this object represents an ARIA landmark, fetches the ARIA landmark role. @return: ARIA landmark role else None

_get_value()

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

_get_description()

The description or help text of this object.

_get_basicText()
_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}.

_get_isContentEditable()
_get_parent()

Retrieves this object’s parent (the object that contains this object). @return: the parent 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_next()

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

_get_firstChild()

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

_get_lastChild()

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

_get_columnNumber()

Retrieves the column number of this object if it is in a table. @rtype: int

_get_rowNumber()

Retrieves the row number of this object if it is in a table. @rtype: int

_get_rowCount()

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

scrollIntoView()

Scroll this object into view on the screen if possible.

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.

_get_isFocusable()

Whether this object is focusable. @rtype: bool

setFocus()

Tries to force this object to take the focus.

_get_table()

Retrieves the object that represents the table that this object is contained in, if this object is a table cell. @rtype: L{NVDAObject}

_get_HTMLNodeUniqueNumber()
_get_HTMLNodeName()
_get_devInfo()

Information about this object useful to developers. Subclasses may extend this, calling the superclass property first. @return: A list of text strings providing information about this object useful to developers.

_get_language()
_get_liveRegionPoliteness() AriaLivePoliteness

Retrieves the priority with which updates to live regions should be treated. The base implementation returns C{aria.AriaLivePoliteness.OFF}, indicating that the object isn’t a live region. Subclasses supporting live region events must implement this.

event_liveRegionChange()

A base implementation for live region change events.

_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.

HTMLNodeName
HTMLNodeUniqueNumber
TextInfo

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

_UIAControl
_abc_impl = <_abc._abc_data object>
basicText
columnNumber
description: str

Typing information for auto property _get_description

devInfo: List[str]

Information about this object useful to developers.

firstChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_firstChild’

isContentEditable
isCurrent: controlTypes.IsCurrent

type info for auto property _get_isCurrent

isFocusable: bool

Type definition for auto prop ‘_get_isFocusable’

landmark: Optional[str]

Typing information for auto property _get_landmark

language

The language/locale of this object. @type: str

lastChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_lastChild’

liveRegionPoliteness
location
name: str

Type definition for auto prop ‘_get_name’

next: Optional['NVDAObject']

The object directly after this object with the same parent.

parent: Optional['NVDAObject']

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

placeholder
presentationType
previous: Optional['NVDAObject']

The object directly before this object with the same parent.

role: controlTypes.Role

Type definition for auto prop ‘_get_role’

roleText: Optional[str]

Type definition for auto prop ‘_get_roleText’

rowCount
rowNumber
shouldAllowIAccessibleFocusEvent
states: Set[controlTypes.State]

Type info for auto property: _get_states

table
treeInterceptorClass: Type[TreeInterceptor]

Type definition for auto prop ‘_get_treeInterceptorClass’

value: str

Typing information for auto property _get_value

zoomFactors
class NVDAObjects.IAccessible.MSHTML.V6ComboBox(chooseBestAPI=True, **kwargs)

Bases: IAccessible

The object which receives value change events for combo boxes in MSHTML/IE 6.

@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 NVDAObjects.IAccessible.MSHTML.Fieldset(chooseBestAPI=True, **kwargs)

Bases: MSHTML

@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 NVDAObjects.IAccessible.MSHTML.Body(chooseBestAPI=True, **kwargs)

Bases: MSHTML

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

_get_parent()

Retrieves this object’s parent (the object that contains this object). @return: the parent 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>
parent: Optional['NVDAObject']

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

shouldAllowIAccessibleFocusEvent
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.MSHTML.Object(chooseBestAPI=True, **kwargs)

Bases: MSHTML

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

_get_firstChild()

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

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

Type definition for auto prop ‘_get_firstChild’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.MSHTML.PluginWindow(chooseBestAPI=True, **kwargs)

Bases: IAccessible

A window for a plugin.

@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 NVDAObjects.IAccessible.MSHTML.PopupList(chooseBestAPI=True, **kwargs)

Bases: MSHTML

Temporary popup lists created when expanding a combo box have a correct accParent which points back to the combobox, so use that. The parentElement points to a temporary document fragment which is not useful.

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

_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: Optional['NVDAObject']

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

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.MSHTML.RootClient(chooseBestAPI=True, **kwargs)

Bases: IAccessible

The top level client of an MSHTML control.

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

name: str = None

Type definition for auto prop ‘_get_name’

description: str = None

Typing information for auto property _get_description

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.MSHTML.MSAATextLeaf(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

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

Type definition for auto prop ‘_get_role’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.MSHTML.Math(chooseBestAPI=True, **kwargs)

Bases: MSHTML

@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>
mathMl
_propertyCache: Set[GetterMethodT]
role: controlTypes.Role = 104

Type definition for auto prop ‘_get_role’

_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.

NVDAObjects.IAccessible.MSHTML.findExtraIAccessibleOverlayClasses(obj, clsList)

Determine the most appropriate class for MSHTML objects. This works similarly to L{NVDAObjects.NVDAObject.findOverlayClasses} except that it never calls any other findOverlayClasses method.

NVDAObjects.IAccessible.SysMonthCal32 module

class NVDAObjects.IAccessible.SysMonthCal32.SysMonthCal32(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_role()

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

_get_name()

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

_get_value()

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

script_valueChange(gesture)
__valueChangeGestures = ('kb:upArrow', 'kb:downArrow', 'kb:leftArrow', 'kb:rightArrow', 'kb:home', 'kb:end', 'kb:control+home', 'kb:control+end', 'kb:pageDown', 'kb:pageUp')
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’

value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]

NVDAObjects.IAccessible.adobeAcrobat module

NVDAObjects.IAccessible.adobeAcrobat.normalizeStdName(stdName: str) Tuple[Role, str | None]

@param stdName: @return: Tuple with the NVDA role and optionally the level number of the heading as a string, E.G.: “H5” produces “5”

class NVDAObjects.IAccessible.adobeAcrobat.AcrobatNode(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_role()

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

scrollIntoView()

Scroll this object into view on the screen if possible.

_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

_getNodeMathMl(node)
_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
role: controlTypes.Role

Type definition for auto prop ‘_get_role’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.adobeAcrobat.RootNode(chooseBestAPI=True, **kwargs)

Bases: AcrobatNode

@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
event_valueChange()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.adobeAcrobat.Document(chooseBestAPI=True, **kwargs)

Bases: RootNode

@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()

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_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
treeInterceptorClass: Type[TreeInterceptor]

Type definition for auto prop ‘_get_treeInterceptorClass’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.adobeAcrobat.RootTextNode(chooseBestAPI=True, **kwargs)

Bases: RootNode

The message text node that appears instead of the document when the document is not available.

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

_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: Optional['NVDAObject']

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

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.adobeAcrobat.AcrobatTextInfo(*args, **kwargs)

Bases: NVDAObjectTextInfo

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

_getCaretOffset()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.adobeAcrobat.EditableTextNode(chooseBestAPI=True, **kwargs)

Bases: EditableText, AcrobatNode

@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 AcrobatTextInfo

event_valueChange()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.adobeAcrobat.AcrobatSDIWindowClient(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()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.adobeAcrobat.BadFocusStates(chooseBestAPI=True, **kwargs)

Bases: AcrobatNode

An object which reports focus states when it shouldn’t.

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

_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]
NVDAObjects.IAccessible.adobeAcrobat.findExtraOverlayClasses(obj, clsList)

Determine the most appropriate class(es) for Acrobat objects. This works similarly to L{NVDAObjects.NVDAObject.findOverlayClasses} except that it never calls any other findOverlayClasses method.

NVDAObjects.IAccessible.akelEdit module

class NVDAObjects.IAccessible.akelEdit.AkelEdit(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

name: str = ''

Type definition for auto prop ‘_get_name’

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

NVDAObjects.IAccessible.chromium module

NVDAObjects for the Chromium browser project

NVDAObjects.IAccessible.chromium.supportedAriaDetailsRoles: Dict[str, Role | None] = {'comment': Role.COMMENT, 'definition': None, 'doc-endnote': None, 'doc-footnote': Role.FOOTNOTE, 'unknown': None}

details-roles attribute is only defined in Chrome as of May 2022. Refer to ComputeDetailsRoles: https://chromium.googlesource.com/chromium/src/+/main/ui/accessibility/platform/ax_platform_node_base.cc#2419

class NVDAObjects.IAccessible.chromium.ChromeVBufTextInfo(*args, **kwargs)

Bases: Gecko_ia2_TextInfo

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.

_calculateDescriptionFrom(attrs) DescriptionFrom

Overridable calculation of DescriptionFrom @param attrs: source attributes for the TextInfo @return: the origin for accDescription. @note: Chrome provides ‘IAccessible2::attribute_description-from’ which declares the origin used for

accDescription. Chrome also provides IAccessible2::attribute_description to maintain compatibility with FireFox.

_normalizeControlField(attrs)
_abc_impl = <_abc._abc_data object>
class NVDAObjects.IAccessible.chromium.ChromeVBuf(*args, **kwargs)

Bases: Gecko_ia2

TextInfo

alias of ChromeVBufTextInfo

_nativeAppSelectionModeSupported: bool = False

Whether native selection mode is available in this browse mode document

_abc_impl = <_abc._abc_data object>
class NVDAObjects.IAccessible.chromium.Document(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

_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’

class NVDAObjects.IAccessible.chromium.ComboboxListItem(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Represents a list item inside a combo box.

@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 NVDAObjects.IAccessible.chromium.ToggleButton(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

_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

class NVDAObjects.IAccessible.chromium.PresentationalList(chooseBestAPI=True, **kwargs)

Bases: Ia2Web

Ensures that lists like UL, DL and OL always have the readonly state. A work-around for issue #7562 allowing us to differentiate presentational lists from interactive lists (such as of size greater 1 and ARIA list boxes). In firefox, this is possible by the presence of a read-only state, even in a content editable.

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

_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

class NVDAObjects.IAccessible.chromium.Figure(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

_get_role() 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’

class NVDAObjects.IAccessible.chromium.EditorTextInfo(*args, **kwargs)

Bases: MozillaCompoundTextInfo

The TextInfo for edit areas such as edit fields and documents in Chromium.

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.

_isCaretAtEndOfLine(caretObj: IAccessible) bool
_abc_impl = <_abc._abc_data object>
class NVDAObjects.IAccessible.chromium.Editor(chooseBestAPI=True, **kwargs)

Bases: Editor

The NVDAObject for edit areas such as edit fields and documents in Chromium.

@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 EditorTextInfo

_abc_impl = <_abc._abc_data object>
NVDAObjects.IAccessible.chromium.findExtraOverlayClasses(obj, clsList)

Determine the most appropriate class(es) for Chromium objects. This works similarly to L{NVDAObjects.NVDAObject.findOverlayClasses} except that it never calls any other findOverlayClasses method.

NVDAObjects.IAccessible.delphi module

class NVDAObjects.IAccessible.delphi.TRichView(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).

_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]
class NVDAObjects.IAccessible.delphi.TRichViewEdit(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).

_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]
class NVDAObjects.IAccessible.delphi.TGroupBox(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_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 NVDAObjects.IAccessible.delphi.Form(chooseBestAPI=True, **kwargs)

Bases: Dialog

role: Role = 4

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.delphi.TabSheet(chooseBestAPI=True, **kwargs)

Bases: Dialog

role: Role = 57

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.delphi.TRxRichEdit(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]

NVDAObjects.IAccessible.hh module

NVDAObjects for Microsoft HTML Help.

class NVDAObjects.IAccessible.hh.KeywordList(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_parent()

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

_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_activeChild()

Retrieves the child of this object that currently has, or contains, the focus. @return: the active child if it has one else None @rtype: L{NVDAObject} or None

event_gainFocus()

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

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

The object directly after this object with the same parent.

parent: Optional['NVDAObject']

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

previous: Optional['NVDAObject']

The object directly before this object with the same parent.

_propertyCache: Set[GetterMethodT]

NVDAObjects.IAccessible.ia2TextMozilla module

Support for the IAccessible2 rich text model first implemented by Mozilla. This is now used by other applications as well.

class NVDAObjects.IAccessible.ia2TextMozilla.FakeEmbeddingTextInfo(*args, **kwargs)

Bases: OffsetsTextInfo

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

encoding: str | None = None

The encoding internal to the underlying text info implementation.

_getStoryLength()
_iterTextWithEmbeddedObjects(withFields, formatConfig=None) Generator[int, None, None]
_getUnitOffsets(unit, offset)
_abc_impl = <_abc._abc_data object>
NVDAObjects.IAccessible.ia2TextMozilla._getRawTextInfo(obj) AutoPropertyType
NVDAObjects.IAccessible.ia2TextMozilla._getEmbedded(obj, offset) IAccessible | None
class NVDAObjects.IAccessible.ia2TextMozilla.MozillaCompoundTextInfo(*args, **kwargs)

Bases: CompoundTextInfo

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.

_getControlFieldForObject(obj, ignoreEditableText=True)
_isCaretAtEndOfLine(caretObj: IAccessible) bool
NVDAObjectAtStart: NVDAObjects.NVDAObject

Typing information for auto-property: _get_NVDAObjectAtStart

_abc_impl = <_abc._abc_data object>
boundingRects
text: str

Typing information for auto-property: _get_text

_getSelectionBase()

Get an NVDAObject and TextInfo somewhere within the selection. This is just a base point to start from. It will often be necessary to expand outwards and/or descend to get the complete selection.

_makeRawTextInfo(obj, position) OffsetsTextInfo
_getEmbedding(obj)
POSITION_SELECTION_START = 3
POSITION_SELECTION_END = 4
FINDCONTENTDESCENDANT_POSITIONS = {'caret': 1, 'first': 0, 'last': 2}
_findContentDescendant(obj, position)
_iterRecursiveText(ti: OffsetsTextInfo, controlStack, formatConfig)
_getText(withFields, formatConfig=None)
_get_text()

The text with in this range. Subclasses must implement this. @return: The text. @note: The text is not guaranteed to be the exact length of the range in offsets.

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.

_adjustIfEndOfLine(expandTi: OffsetsTextInfo, unit: str, obj: IAccessible) None
_findUnitEndpoints(baseTi, unit, findStart=True, findEnd=True)
expand(unit)

Expands the start and end of this text info object to a given unit @param unit: a unit constant @type unit: string

_findNextContent(origin, moveBack=False, limitToInline=False)
move(unit: str, direction: int, endPoint: str | None = None) int

Moves one or both of the endpoints of this object by the given unit and direction. @param unit: the unit to move by; one of the UNIT_* constants. @param direction: a positive value moves forward by a number of units, a negative value moves back a number of units @type: int @param endPoint: Either None, “start” or “end”. If “start” then the start of the range is moved, if “end” then the end of the range is moved, if None - not specified then collapse to start and move both start and end. @return: The number of units moved;

negative indicates backward movement, positive indicates forward movement, 0 means no movement.

@rtype: int

_getAncestors(ti, obj)
compareEndPoints(other, which)

compares one end of this range to one end of another range. Subclasses must implement this. @param other: the text range to compare with. @type other: L{TextInfo} @param which: The ends to compare; one of “startToStart”, “startToEnd”, “endToStart”, “endToEnd”. @return: -1 if this end is before other end, 1 if this end is after other end or 0 if this end and other end are the same. @rtype: int

_get_NVDAObjectAtStart()

Get the NVDAObject related to the start of the range. Usually it is just the owner NVDAObject, but in the case of virtualBuffers it may be a descendant object. @returns: the NVDAObject at the start

_get_boundingRects()

Per line bounding rectangles for the visible text in this range. Implementations should ensure that the bounding rectangles don’t contain off screen coordinates. @rtype: [L{locationHelper.RectLTWH}] @raise NotImplementedError: If not supported. @raise LookupError: If not available (i.e. off screen, hidden, etc.)

setEndPoint(other, which)

Sets one end of this range to one end of another range. Subclasses must implement this. @param other: The range from which an end is being obtained. @type other: L{TextInfo} @param which: The ends to use; one of “startToStart”, “startToEnd”, “endToStart”, “endToEnd”.

NVDAObjects.IAccessible.ia2Web module

Base classes with common support for browsers exposing IAccessible2.

class NVDAObjects.IAccessible.ia2Web.IA2WebAnnotationTarget(target: IAccessible)

Bases: AnnotationTarget

property summary: str
property role: Role
property targetObject: IAccessible
class NVDAObjects.IAccessible.ia2Web.IA2WebAnnotation(originObj: NVDAObject)

Bases: AnnotationOrigin

_originObj: Ia2Web
property targets: Tuple[AnnotationTarget]
property roles: Tuple[Role | None]
property _rolesGenerator: Generator[Role | None, None, None]

Since Chromium exposes the roles via the “details-roles” IA2Attributes, an optimisation can be used to return them. @remarks: The order of “details-roles” IA2Attributes is expected to match the order of detailsRelations objects.

class NVDAObjects.IAccessible.ia2Web.Ia2Web(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

IAccessibleTableUsesTableCellIndexAttrib = True
isDescendantOf(obj: NVDAObject) bool

is this object a descendant of obj?

_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_descriptionFrom() DescriptionFrom
annotations: IA2WebAnnotation

Typing information for auto property _get_annotations

_get_annotations() AnnotationOrigin
_get_detailsSummary() str | None
property hasDetails: bool

Default implementation is based on the result of _get_detailsSummary In most instances this should be optimised.

_get_detailsRole() Role | None
_get_isCurrent() IsCurrent

Gets the value that indicates whether this object is the current element in a set of related elements. This maps to aria-current.

_get_placeholder()

If it exists for this object get the value of the placeholder text. For example this might be the aria-placeholder text for a field in a web page. @return: the placeholder text else None @rtype: String or None

_get_isPresentableFocusAncestor()

Determine if this object should be presented to the user in the focus ancestry. @return: C{True} if it should be presented in the focus ancestry, C{False} if not. @rtype: bool

_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_roleTextBraille() str

A custom role string for this object, which is used for braille presentation, which will override the standard label for this object’s role property as well as the value of roleText. By default, NVDA falls back to using roleText.

_get_states()

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

_get_landmark()

If this object represents an ARIA landmark, fetches the ARIA landmark role. @return: ARIA landmark role else None

event_IA2AttributeChange()
_get_liveRegionPoliteness() AriaLivePoliteness

Retrieves the priority with which updates to live regions should be treated. The base implementation returns C{aria.AriaLivePoliteness.OFF}, indicating that the object isn’t a live region. Subclasses supporting live region events must implement this.

_abc_impl = <_abc._abc_data object>
descriptionFrom: controlTypes.DescriptionFrom

Typing information for auto property _get_descriptionFrom

detailsRole: Optional[controlTypes.Role]

Typing information for auto property _get_detailsRole Deprecated, use self.annotations.roles instead.

detailsSummary: Optional[str]

Typing information for auto property _get_detailsSummary Deprecated, use self.annotations.targets instead.

isCurrent: controlTypes.IsCurrent

type info for auto property _get_isCurrent

isPresentableFocusAncestor
landmark: Optional[str]

Typing information for auto property _get_landmark

liveRegionPoliteness
placeholder
positionInfo: Dict[str, int]

Type definition for auto prop ‘_get_positionInfo’

roleText: Optional[str]

Type definition for auto prop ‘_get_roleText’

roleTextBraille
states: Set[controlTypes.State]

Type info for auto property: _get_states

class NVDAObjects.IAccessible.ia2Web.Document(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

value: str = None

Typing information for auto property _get_value

_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 NVDAObjects.IAccessible.ia2Web.Application(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

shouldCreateTreeInterceptor = False

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

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.ia2Web.BlockQuote(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

role: controlTypes.Role = 48

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.ia2Web.Treegrid(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

role: controlTypes.Role = 28

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.ia2Web.Article(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

role: controlTypes.Role = 150

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.ia2Web.Region(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

role: controlTypes.Role = 151

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.ia2Web.Figure(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

role: controlTypes.Role = 152

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.ia2Web.Editor(chooseBestAPI=True, **kwargs)

Bases: Ia2Web, DocumentWithTableNavigation

@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 MozillaCompoundTextInfo

_getTableCellAt(tableID, startPos, destRow, destCol)

Starting from the given start position, Locates the table cell with the given row and column coordinates and table ID. @param startPos: the position to start searching from. @type startPos: L{textInfos.TextInfo} @param tableID: the ID of the table. @param row: the row number of the cell @type row: int @param column: the column number of the table cell @type column: int @returns: the table cell’s position in the document @rtype: L{textInfos.TextInfo} @raises: LookupError if the cell does not exist

event_loseFocus()
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.ia2Web.EditorChunk(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

beTransparentToMouse = True

If true then NVDA will never consider the mouse to be on this object, rather it will be on an ancestor.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.ia2Web.Math(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

_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 NVDAObjects.IAccessible.ia2Web.Switch(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

role: controlTypes.Role = 158

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]
NVDAObjects.IAccessible.ia2Web.findExtraOverlayClasses(obj, clsList, baseClass=<class 'NVDAObjects.IAccessible.ia2Web.Ia2Web'>, documentClass=None)

Determine the most appropriate class if this is an IA2 web object. This should be called after finding any classes for the specific web implementation. @param baseClass: The base class for all web objects. @param documentClass: The class to use for document roots, including ARIA applications.

NVDAObjects.IAccessible.mozilla module

class NVDAObjects.IAccessible.mozilla.MozAnnotationTarget(target: IAccessible)

Bases: AnnotationTarget

property summary: str
property role: Role | None
property targetObject: IAccessible
class NVDAObjects.IAccessible.mozilla.MozAnnotation(originObj: NVDAObject)

Bases: AnnotationOrigin

Unlike base Ia2Web implementation, the details-roles IA2 attribute is not exposed in Firefox.

_originObj: Mozilla
property targets: Tuple[MozAnnotationTarget]
property roles: Tuple[Role | None]
property _rolesGenerator: Generator[Role | None, None, None]
class NVDAObjects.IAccessible.mozilla.Mozilla(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

_get_states()

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

_get_descriptionFrom() DescriptionFrom

Firefox does not yet support ‘description-from’ attribute (which informs NVDA of the source of accDescription after the name/description computation is complete. However, a primary use-case can be supported via the IA2attribute ‘description’ which is exposed by Firefox and tells us the value of the “aria-description” attribute. If the value of accDescription matches, we can infer that the source of accDescription is ‘aria-description’. Note:

At the time of development some ‘generic HTML elements’ (E.G. ‘span’) may not be exposed by Firefox, even if the element has an aria-description attribute. Other more significant ARIA attributes such as role may cause the element to be exposed.

_get_presentationType()
annotations: MozAnnotation

Typing information for auto property _get_annotations

_get_annotations() MozAnnotation
_get_detailsSummary() str | None
_get_detailsRole() Role | None
property hasDetails: bool

Default implementation is based on the result of _get_detailsSummary In most instances this should be optimised.

_abc_impl = <_abc._abc_data object>
descriptionFrom: controlTypes.DescriptionFrom

Typing information for auto property _get_descriptionFrom

detailsRole: Optional[controlTypes.Role]

Typing information for auto property _get_detailsRole Deprecated, use self.annotations.roles instead.

detailsSummary: Optional[str]

Typing information for auto property _get_detailsSummary Deprecated, use self.annotations.targets instead.

presentationType
states: Set[controlTypes.State]

Type info for auto property: _get_states

class NVDAObjects.IAccessible.mozilla.Document(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

_get_parent()

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

_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>
parent: Optional['NVDAObject']

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

treeInterceptorClass: Type[TreeInterceptor]

Type definition for auto prop ‘_get_treeInterceptorClass’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.mozilla.EmbeddedObject(chooseBestAPI=True, **kwargs)

Bases: Mozilla

@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 NVDAObjects.IAccessible.mozilla.GeckoPluginWindowRoot(chooseBestAPI=True, **kwargs)

Bases: WindowRoot

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

parentUsesSuperOnWindowRootIAccessible = False
_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: Optional['NVDAObject']

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

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.mozilla.TextLeaf(chooseBestAPI=True, **kwargs)

Bases: Mozilla

@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 = 7

Type definition for auto prop ‘_get_role’

beTransparentToMouse = True

If true then NVDA will never consider the mouse to be on this object, rather it will be on an ancestor.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
NVDAObjects.IAccessible.mozilla.findExtraOverlayClasses(obj, clsList)

Determine the most appropriate class if this is a Mozilla object. This works similarly to L{NVDAObjects.NVDAObject.findOverlayClasses} except that it never calls any other findOverlayClasses method.

NVDAObjects.IAccessible.mozilla._IAccessibleRolesToOverlayClasses = {'embed': <class 'NVDAObjects.IAccessible.mozilla.EmbeddedObject'>, 'object': <class 'NVDAObjects.IAccessible.mozilla.EmbeddedObject'>, 1034: <class 'NVDAObjects.IAccessible.mozilla.EmbeddedObject'>}

Maps IAccessible roles to NVDAObject overlay classes.

NVDAObjects.IAccessible.msOffice module

class NVDAObjects.IAccessible.msOffice.SDM(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_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.

_get_parent()

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

_get_presentationType()
_get_firstChild()

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

_get_lastChild()

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

_get_SDMChild()
SDMChild
_abc_impl = <_abc._abc_data object>
firstChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_firstChild’

lastChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_lastChild’

name: str

Type definition for auto prop ‘_get_name’

parent: Optional['NVDAObject']

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

positionInfo: Dict[str, int]

Type definition for auto prop ‘_get_positionInfo’

presentationType
shouldAllowIAccessibleFocusEvent
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.msOffice.MSOUNISTAT(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_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 NVDAObjects.IAccessible.msOffice.MsoCommandBarToolBar(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_isPresentableFocusAncestor()

Determine if this object should be presented to the user in the focus ancestry. @return: C{True} if it should be presented in the focus ancestry, C{False} if not. @rtype: bool

_get_name()

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

description: str = None

Typing information for auto property _get_description

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

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.msOffice.BrokenMsoCommandBar(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Work around broken IAccessible implementation for Microsoft Office XP-2003 toolbars. For these IAccessibles, accNavigate is rather broken and retrieving only the first child with AccessibleChildren causes a crash.

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

classmethod appliesTo(obj)
_get_firstChild()

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

next: Optional['NVDAObject'] = None

The object directly after this object with the same parent.

description: str = None

Typing information for auto property _get_description

_get_name()

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

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

Type definition for auto prop ‘_get_firstChild’

name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.msOffice.CommandBarListItem(chooseBestAPI=True, **kwargs)

Bases: IAccessible

A list item in an MSO commandbar, that may be part of a color palet.

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

COMPILED_RE = re.compile('RGB\\(\\d+, \\d+, \\d+\\)', re.IGNORECASE)
_get_rgbNameAndMatch()
_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.

_abc_impl = <_abc._abc_data object>
description: str

Typing information for auto property _get_description

name: str

Type definition for auto prop ‘_get_name’

rgbNameAndMatch
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.msOffice.SDMSymbols(chooseBestAPI=True, **kwargs)

Bases: SDM

@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).

script_selectGraphic(gesture)
__gestures = {'kb:downArrow': 'selectGraphic', 'kb:end': 'selectGraphic', 'kb:home': 'selectGraphic', 'kb:leftArrow': 'selectGraphic', 'kb:rightArrow': 'selectGraphic', 'kb:upArrow': 'selectGraphic'}
_abc_impl = <_abc._abc_data object>
value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.msOffice.StatusBar(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_role()

#4257: Status bar in Office applications does not expose proper role via IAccessible. We cannot acces it via UIA because it does not fire focus events when focused for the first time. Fortunately accValue contains “status bar” and is not localized.

_get_description()

The description or help text of this object.

_get_isPresentableFocusAncestor()

Determine if this object should be presented to the user in the focus ancestry. @return: C{True} if it should be presented in the focus ancestry, C{False} if not. @rtype: bool

_abc_impl = <_abc._abc_data object>
description: str

Typing information for auto property _get_description

isPresentableFocusAncestor
role: controlTypes.Role

Type definition for auto prop ‘_get_role’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.msOffice.RibbonSection(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_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]

NVDAObjects.IAccessible.mscandui module

NVDAObjects.IAccessible.mscandui.reportSelectedCandidate(candidateObject, allowDuplicate=False, newList=False)
class NVDAObjects.IAccessible.mscandui.BaseCandidateItem(chooseBestAPI=True, **kwargs)

Bases: CandidateItem, IAccessible

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

role: Role = 15

Type definition for auto prop ‘_get_role’

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()
_abc_impl = <_abc._abc_data object>
basicText
candidateNumber
description: str

Typing information for auto property _get_description

name: str

Type definition for auto prop ‘_get_name’

parent: NVDAObject | None

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

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.mscandui.MSCandUI_candidateListItem(chooseBestAPI=True, **kwargs)

Bases: BaseCandidateItem

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

_get_states()

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

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

Type info for auto property: _get_states

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.mscandui.MSCandUI21_candidateMenuItem(chooseBestAPI=True, **kwargs)

Bases: BaseCandidateItem

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

_get_previous()

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

_get_next()

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

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.

script_nextItem(gesture)
script_previousItem(gesture)
script_changePage(gesture)
script_activate(gesture)
__gestures = {'kb:downArrow': 'nextItem', 'kb:enter': 'activate', 'kb:leftArrow': 'changePage', 'kb:pageDown': 'changePage', 'kb:pageUp': 'changePage', 'kb:rightArrow': 'changePage', 'kb:space': 'activate', 'kb:upArrow': 'previousItem'}
_abc_impl = <_abc._abc_data object>
next: NVDAObject | None

The object directly after this object with the same parent.

previous: NVDAObject | None

The object directly before this object with the same parent.

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.mscandui.MSCandUI21(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_isPresentableFocusAncestor()

Determine if this object should be presented to the user in the focus ancestry. @return: C{True} if it should be presented in the focus ancestry, C{False} if not. @rtype: bool

event_show()
_abc_impl = <_abc._abc_data object>
isPresentableFocusAncestor
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.mscandui.MSCandUIWindow_candidateListItem(chooseBestAPI=True, **kwargs)

Bases: MSCandUI_candidateListItem

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

_get_isValidCandidate()
_get_candidateNumber()
_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.

_abc_impl = <_abc._abc_data object>
candidateNumber
isValidCandidate
next: NVDAObject | None

The object directly after this object with the same parent.

previous: NVDAObject | None

The object directly before this object with the same parent.

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.mscandui.MSCandUIWindow(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

name: str = 'Candidate'

Type definition for auto prop ‘_get_name’

role: controlTypes.Role = 14

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}.

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

Type info for auto property: _get_states

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.mscandui.ModernCandidateUICandidateItem(chooseBestAPI=True, **kwargs)

Bases: BaseCandidateItem

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

_get_parent()

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

_get_candidateCharacters()
_candidateNumber = ''
_visibleCandidateItemsText = ''
refreshCandidateList()
_get_candidateNumber()
_get_visibleCandidateItemsText()
event_stateChange()
_abc_impl = <_abc._abc_data object>
candidateCharacters
candidateNumber
parent: NVDAObject | None

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

visibleCandidateItemsText
_propertyCache: Set[GetterMethodT]
NVDAObjects.IAccessible.mscandui.findExtraOverlayClasses(obj, clsList)

NVDAObjects.IAccessible.qt module

NVDAObjects.IAccessible.qt._getActiveChild(obj)
class NVDAObjects.IAccessible.qt.Client(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__containedWidget()
_get_focusRedirect()
_abc_impl = <_abc._abc_data object>
_containedWidget
focusRedirect
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.qt.Container(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_activeChild()

Retrieves the child of this object that currently has, or contains, the focus. @return: the active child if it has one else None @rtype: L{NVDAObject} or 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

_get_focusRedirect()
_abc_impl = <_abc._abc_data object>
activeChild
focusRedirect
shouldAllowIAccessibleFocusEvent
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.qt.TableRow(chooseBestAPI=True, **kwargs)

Bases: Container

@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

_get_activeChild()

Retrieves the child of this object that currently has, or contains, the focus. @return: the active child if it has one else None @rtype: L{NVDAObject} or None

_abc_impl = <_abc._abc_data object>
activeChild
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.qt.TableCell(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

script_nextColumn(gesture)
script_previousColumn(gesture)
__gestures = {'kb:leftArrow': 'previousColumn', 'kb:rightArrow': 'nextColumn', 'kb:shift+tab': 'previousColumn', 'kb:tab': 'nextColumn'}
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.qt.TreeViewItem(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

hasEncodedAccDescription = True
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.qt.Menu(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 NVDAObjects.IAccessible.qt.LayeredPane(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

role: controlTypes.Role = 77

Type definition for auto prop ‘_get_role’

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.qt.Application(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

description: str = None

Typing information for auto property _get_description

_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]

NVDAObjects.IAccessible.scintilla module

class NVDAObjects.IAccessible.scintilla.Scintilla(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).

shouldAcceptShowHideCaretEvent = False
_abc_impl = <_abc._abc_data object>
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]

NVDAObjects.IAccessible.sysListView32 module

class NVDAObjects.IAccessible.sysListView32.LVITEM

Bases: Structure

_fields_ = [('mask', <class 'ctypes.c_ulong'>), ('iItem', <class 'ctypes.c_long'>), ('iSubItem', <class 'ctypes.c_long'>), ('state', <class 'ctypes.c_ulong'>), ('stateMask', <class 'ctypes.c_ulong'>), ('pszText', <class 'ctypes.c_void_p'>), ('cchTextMax', <class 'ctypes.c_long'>), ('iImage', <class 'ctypes.c_long'>), ('lParam', <class 'ctypes.c_long'>), ('iIndent', <class 'ctypes.c_long'>), ('iGroupID', <class 'ctypes.c_long'>), ('cColumns', <class 'ctypes.c_ulong'>), ('puColumns', <class 'ctypes.c_ulong'>), ('piColFmt', <class 'ctypes.wintypes.LP_c_long'>), ('iGroup', <class 'ctypes.c_long'>)]
cColumns

Structure/Union member

cchTextMax

Structure/Union member

iGroup

Structure/Union member

iGroupID

Structure/Union member

iImage

Structure/Union member

iIndent

Structure/Union member

iItem

Structure/Union member

iSubItem

Structure/Union member

lParam

Structure/Union member

mask

Structure/Union member

piColFmt

Structure/Union member

pszText

Structure/Union member

puColumns

Structure/Union member

state

Structure/Union member

stateMask

Structure/Union member

class NVDAObjects.IAccessible.sysListView32.LVITEM64

Bases: Structure

_fields_ = [('mask', <class 'ctypes.c_ulong'>), ('iItem', <class 'ctypes.c_long'>), ('iSubItem', <class 'ctypes.c_long'>), ('state', <class 'ctypes.c_ulong'>), ('stateMask', <class 'ctypes.c_ulong'>), ('pszText', <class 'ctypes.c_ulonglong'>), ('cchTextMax', <class 'ctypes.c_long'>), ('iImage', <class 'ctypes.c_long'>), ('lParam', <class 'ctypes.c_ulonglong'>), ('iIndent', <class 'ctypes.c_long'>), ('iGroupID', <class 'ctypes.c_long'>), ('cColumns', <class 'ctypes.c_ulong'>), ('puColumns', <class 'ctypes.c_ulong'>), ('piColFmt', <class 'ctypes.c_ulonglong'>), ('iGroup', <class 'ctypes.c_long'>)]
cColumns

Structure/Union member

cchTextMax

Structure/Union member

iGroup

Structure/Union member

iGroupID

Structure/Union member

iImage

Structure/Union member

iIndent

Structure/Union member

iItem

Structure/Union member

iSubItem

Structure/Union member

lParam

Structure/Union member

mask

Structure/Union member

piColFmt

Structure/Union member

pszText

Structure/Union member

puColumns

Structure/Union member

state

Structure/Union member

stateMask

Structure/Union member

class NVDAObjects.IAccessible.sysListView32.LVCOLUMN

Bases: Structure

_fields_ = [('mask', <class 'ctypes.c_ulong'>), ('fmt', <class 'ctypes.c_long'>), ('cx', <class 'ctypes.c_long'>), ('pszText', <class 'ctypes.c_void_p'>), ('cchTextMax', <class 'ctypes.c_long'>), ('iSubItem', <class 'ctypes.c_long'>), ('iImage', <class 'ctypes.c_long'>), ('iOrder', <class 'ctypes.c_long'>), ('cxMin', <class 'ctypes.c_long'>), ('cxDefault', <class 'ctypes.c_long'>), ('cxIdeal', <class 'ctypes.c_long'>)]
cchTextMax

Structure/Union member

cx

Structure/Union member

cxDefault

Structure/Union member

cxIdeal

Structure/Union member

cxMin

Structure/Union member

fmt

Structure/Union member

iImage

Structure/Union member

iOrder

Structure/Union member

iSubItem

Structure/Union member

mask

Structure/Union member

pszText

Structure/Union member

class NVDAObjects.IAccessible.sysListView32.LVCOLUMN64

Bases: Structure

_fields_ = [('mask', <class 'ctypes.c_ulong'>), ('fmt', <class 'ctypes.c_long'>), ('cx', <class 'ctypes.c_long'>), ('pszText', <class 'ctypes.c_ulonglong'>), ('cchTextMax', <class 'ctypes.c_long'>), ('iSubItem', <class 'ctypes.c_long'>), ('iImage', <class 'ctypes.c_long'>), ('iOrder', <class 'ctypes.c_long'>), ('cxMin', <class 'ctypes.c_long'>), ('cxDefault', <class 'ctypes.c_long'>), ('cxIdeal', <class 'ctypes.c_long'>)]
cchTextMax

Structure/Union member

cx

Structure/Union member

cxDefault

Structure/Union member

cxIdeal

Structure/Union member

cxMin

Structure/Union member

fmt

Structure/Union member

iImage

Structure/Union member

iOrder

Structure/Union member

iSubItem

Structure/Union member

mask

Structure/Union member

pszText

Structure/Union member

class NVDAObjects.IAccessible.sysListView32.AutoFreeBSTR

Bases: BSTR

A BSTR that always frees itself on deletion. A BSTR (Basic string or binary string) is a string data type that is used by COM, Automation, and Interop functions.

AutoFreeBSTR is useful where another library allocates (SysAllocString/SysAllocStringLen) and you want to ensure that it will be deallocated (SysFreeString). @note The conditions requiring the use of this class are not clear.

The current usage is considered legacy.

@note The BSTR (base class) from comtypes will free the string when it

is from an outparam (indicating that memory was allocated in the library).

@warning Don’t use this unless you are certain about taking ownership of the memory. @warning Deprecated, may be removed in future versions.

_needsfree = True
class NVDAObjects.IAccessible.sysListView32.List(chooseBestAPI=True, **kwargs)

Bases: List

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

getListGroupInfo(groupIndex)
_get_name()

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

event_gainFocus()

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

_get_isMultiColumn()
_get_rowCount()

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

columnCount: int

Typing information for auto-property: _get_columnCount

_get_columnCount() int

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

_getColumnOrderArrayRawInProc(columnCount: int) Array | None

Retrieves a list of column indexes for a given list control. See _getColumnOrderArrayRaw for more comments. Note that this method operates in process and cannot be used in situations where NVDA cannot inject i.e when running as a Windows Store application or when no focus event was received on startup.

_getColumnOrderArrayRawOutProc(columnCount: int) Array | None

Retrieves a list of column indexes for a given list control. See _getColumnOrderArrayRaw for more comments. Note that this method operates out of process and has to reserve memory inside a given application. As a consequence it may fail when reserved memory is above the range available for 32-bit processes. Use only when in process injection is not possible.

_getColumnOrderArrayRaw(columnCount: int) Array | None

Retrieves an array of column indexes for a given list. The indexes are placed in order in which columns are displayed on screen from left to right. Note that when columns are reordered the indexes remain the same - only their order differs.

_getMappedColumn(presentationIndex: int) int | None

Multi-column SysListViews can have their columns re-ordered. To keep a consistent internal mapping, a column order array is used to map a presentation index to a consistent internal index. For single-column SysListViews, the mapping is not necessary. If the column order array cannot be fetched from a multi-column SysListView, this returns None.

@param presentationIndex: One based index for the column as presented to the user. @return: The internal / logical column zero based index for the column. None if the mapped column cannot be determined.

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

Type definition for auto prop ‘_get_name’

rowCount
class NVDAObjects.IAccessible.sysListView32.GroupingItem(chooseBestAPI=True, **kwargs)

Bases: Window

property groupInfo
_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

_set_groupInfo(info)
_get_groupInfo()
_get_name()

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

role: controlTypes.Role = 56

Type definition for auto prop ‘_get_role’

_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}.

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

Type definition for auto prop ‘_get_name’

states: Set[controlTypes.State]
value: str

Typing information for auto property _get_value

class NVDAObjects.IAccessible.sysListView32.ListItemWithoutColumnSupport(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()
description: str = None

Typing information for auto property _get_description

_get_value()

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

_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.

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

Type definition for auto prop ‘_get_positionInfo’

value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.sysListView32.ListItem(chooseBestAPI=True, **kwargs)

Bases: RowWithFakeNavigation, RowWithoutCellObjects, ListItemWithoutColumnSupport

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

_getColumnLocationRawInProc(index: int) RECT

Retrieves rectangle containing coordinates for a given column. Note that this method operates in process and cannot be used in situations where NVDA cannot inject i.e when running as a Windows Store application or when no focus event was received on startup.

_getColumnLocationRawOutProc(index: int) RECT

Retrieves rectangle containing coordinates for a given column. Note that this method operates out of process and has to reserve memory inside a given application. As a consequence it may fail when reserved memory is above the range available for 32-bit processes. Use only when in process injection is not possible.

_getColumnLocationRaw(index: int) RectLTRB | None
_getColumnLocation(column: int) RectLTRB | None

Get the screen location for the given column. Subclasses may optionally override this method. @param column: The index of the column, starting at 1. @type column: int @rtype: tuple

_getColumnContentRawInProc(index: int) str | None

Retrieves text for a given column. Note that this method operates in process and cannot be used in situations where NVDA cannot inject i.e when running as a Windows Store application or when no focus event was received on startup.

_getColumnContentRawOutProc(index: int) str | None

Retrieves text for a given column. Note that this method operates out of process and has to reserve memory inside a given application. As a consequence it may fail when reserved memory is above the range available for 32-bit processes. Use only when in process injection is not possible.

_getColumnContentRaw(index: int) str | None
_getColumnContent(column: int) str | None

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

_getColumnImageIDRaw(index)
_getColumnImageID(column)
_getColumnHeaderRawOutProc(index: int) str | None

Retrieves text of the header for the given column. Note that this method operates out of process and has to reserve memory inside a given application. As a consequence it may fail when reserved memory is above the range available for 32-bit processes. Use only when in process injection is not possible.

_getColumnHeaderRawInProc(index: int) str | None

Retrieves text of the header for the given column. Note that this method operates in process and cannot be used in situations where NVDA cannot inject i.e when running as a Windows Store application or when no focus event was received on startup.

_getColumnHeaderRaw(index: int) str | None
_getColumnHeader(column: int) str | None

Get the header text for this column. @param column: The index of the column, starting at 1. @type column: int @rtype: str

_abc_impl = <_abc._abc_data object>
_get_name()

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

_shouldDisableMultiColumn
name: str

Type definition for auto prop ‘_get_name’

value: str = None

Typing information for auto property _get_value

_get__shouldDisableMultiColumn()

NVDAObjects.IAccessible.sysTreeView32 module

class NVDAObjects.IAccessible.sysTreeView32.TreeView(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_firstChild()

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

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

Type definition for auto prop ‘_get_firstChild’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.sysTreeView32.TreeViewItem(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_role()

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

_get_treeview_hItem()
_get_treeview_level()
_get_states()

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

_get_value()

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

_get_parent()

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

_get_firstChild()

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

_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_children()

Retrieves a list of all the objects directly contained by this object (who’s parent is this object). @rtype: list of L{NVDAObject}

_get_childCount()

Retrieves the number of children this object contains. @rtype: int

_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.

event_stateChange()
_abc_impl = <_abc._abc_data object>
childCount
children: List['NVDAObject']

Type definition for auto prop ‘_get_children’

firstChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_firstChild’

next: Optional['NVDAObject']

The object directly after this object with the same parent.

parent: Optional['NVDAObject']

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

positionInfo: Dict[str, int]

Type definition for auto prop ‘_get_positionInfo’

previous: Optional['NVDAObject']

The object directly before this object with the same parent.

role: controlTypes.Role

Type definition for auto prop ‘_get_role’

states: Set[State]

Type info for auto property: _get_states

treeview_hItem
treeview_level
value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.sysTreeView32.BrokenCommctrl5Item(chooseBestAPI=True, **kwargs)

Bases: IAccessible

Handle broken CommCtrl v5 SysTreeView32 items in 64 bit applications. In these controls, IAccessible fails to retrieve any info, so we must retrieve it using UIA. We do this by obtaining a UIA NVDAObject and redirecting properties to it. We can’t simply use UIA objects alone for these controls because UIA events are also broken.

@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_role()

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

_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_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_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_location()

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

_makeRelatedObj(uiaObj)
_get_parent()

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

_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_firstChild()

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

_get_lastChild()

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

_get_children()

Retrieves a list of all the objects directly contained by this object (who’s parent is this object). @rtype: list of L{NVDAObject}

classmethod getFirstItem(treeObj)

Get an instance for the first item in a given tree view.

_abc_impl = <_abc._abc_data object>
children: List['NVDAObject']

Type definition for auto prop ‘_get_children’

description: str

Typing information for auto property _get_description

firstChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_firstChild’

lastChild: Optional['NVDAObject']

Type definition for auto prop ‘_get_lastChild’

location
name: str

Type definition for auto prop ‘_get_name’

next: Optional['NVDAObject']

The object directly after this object with the same parent.

parent: Optional['NVDAObject']

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

positionInfo: Dict[str, int]

Type definition for auto prop ‘_get_positionInfo’

previous: Optional['NVDAObject']

The object directly before this object with the same parent.

role: controlTypes.Role

Type definition for auto prop ‘_get_role’

states: Set[State]

Type info for auto property: _get_states

value: str

Typing information for auto property _get_value

_propertyCache: Set[GetterMethodT]

NVDAObjects.IAccessible.webKit module

class NVDAObjects.IAccessible.webKit.Node(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_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: Optional['NVDAObject']

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

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.webKit.Document(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_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>
treeInterceptorClass: Type[TreeInterceptor]

Type definition for auto prop ‘_get_treeInterceptorClass’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.webKit.EditableText(chooseBestAPI=True, **kwargs)

Bases: Node

@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]
NVDAObjects.IAccessible.webKit.findExtraOverlayClasses(obj, clsList)

Determine the most appropriate class(es) for WebKit objects. This works similarly to L{NVDAObjects.NVDAObject.findOverlayClasses} except that it never calls any other findOverlayClasses method.

NVDAObjects.IAccessible.winConsole module

class NVDAObjects.IAccessible.winConsole.EnhancedLegacyWinConsole(chooseBestAPI=True, **kwargs)

Bases: KeyboardHandlerBasedTypedCharSupport, WinConsole, IAccessible

A hybrid approach to console access, using legacy APIs to read output and KeyboardHandlerBasedTypedCharSupport for input.

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

_supportsTextChange = False

Legacy consoles take quite a while to send textChange events. This significantly impacts typing performance, so don’t queue chars.

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.winConsole.LegacyWinConsole(chooseBestAPI=True, **kwargs)

Bases: WinConsole, IAccessible

NVDA’s original console support, used by default on Windows versions before 1607.

@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>
_propertyCache: Set[GetterMethodT]
NVDAObjects.IAccessible.winConsole.findExtraOverlayClasses(obj, clsList)

NVDAObjects.IAccessible.winword module

class NVDAObjects.IAccessible.winword.WordDocument(chooseBestAPI=True, **kwargs)

Bases: IAccessible, EditableTextWithoutAutoSelectDetection, WordDocument

@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 WordDocumentTreeInterceptor

shouldCreateTreeInterceptor = False

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

TextInfo

alias of WordDocumentTextInfo

_fromUpdateBrailleAndReviewPosition = False
_get_ignoreEditorRevisions()
ignorePageNumbers = False

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

ignoreFormatting = False

True if formatting should be ignored (text only) such as for spellCheck error field

event_caret() None
_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}.

populateHeaderCellTrackerFromHeaderRows(headerCellTracker, table)
populateHeaderCellTrackerFromBookmarks(headerCellTracker, bookmarks)
_curHeaderCellTrackerTable = None
_curHeaderCellTracker = None
getHeaderCellTrackerForTable(table)
setAsHeaderCell(cell, isColumnHeader=False, isRowHeader=False)
forgetHeaderCell(cell, isColumnHeader=False, isRowHeader=False)
fetchAssociatedHeaderCellText(cell, columnHeader=False)
script_setColumnHeader(gesture)

Set column header. Pressing once will set this cell as the first column header for any cell lower and to the right of it within this table. Pressing twice will forget the current column header for this cell.

script_setRowHeader(gesture)

Set row header. Pressing once will set this cell as the first row header for any cell lower and to the right of it within this table. Pressing twice will forget the current row header for this cell.

script_caret_moveByCell(gesture: InputGesture) None
script_reportCurrentComment(gesture: InputGesture) None

Reports the text of the comment where the system caret is located.If pressed twice, presents the information in browse mode.

_moveInTable(row=True, forward=True)
script_nextRow(gesture)
script_previousRow(gesture)
script_nextColumn(gesture)
script_previousColumn(gesture)
script_nextParagraph(gesture)
script_previousParagraph(gesture)
script_updateBrailleAndReviewPosition(gesture: InputGesture) None
_backspaceScriptHelper(unit: str, gesture: InputGesture) None

Helper function to update braille and review position.

focusOnActiveDocument(officeChartObject)
__gestures = {'kb:NVDA+alt+c': 'reportCurrentComment', 'kb:NVDA+shift+c': 'setColumnHeader', 'kb:NVDA+shift+r': 'setRowHeader', 'kb:alt+backspace': 'updateBrailleAndReviewPosition', 'kb:alt+end': 'caret_moveByCell', 'kb:alt+home': 'caret_moveByCell', 'kb:alt+pageDown': 'caret_moveByCell', 'kb:alt+pageUp': 'caret_moveByCell', 'kb:alt+shift+downArrow': 'moveParagraphDown', 'kb:alt+shift+leftArrow': 'increaseDecreaseOutlineLevel', 'kb:alt+shift+rightArrow': 'increaseDecreaseOutlineLevel', 'kb:alt+shift+upArrow': 'moveParagraphUp', 'kb:control+0': 'changeParagraphSpacing', 'kb:control+1': 'changeLineSpacing', 'kb:control+2': 'changeLineSpacing', 'kb:control+5': 'changeLineSpacing', 'kb:control+=': 'toggleSuperscriptSubscript', 'kb:control+[': 'increaseDecreaseFontSize', 'kb:control+]': 'increaseDecreaseFontSize', 'kb:control+alt+1': 'increaseDecreaseOutlineLevel', 'kb:control+alt+2': 'increaseDecreaseOutlineLevel', 'kb:control+alt+3': 'increaseDecreaseOutlineLevel', 'kb:control+alt+downArrow': 'nextRow', 'kb:control+alt+leftArrow': 'previousColumn', 'kb:control+alt+rightArrow': 'nextColumn', 'kb:control+alt+upArrow': 'previousRow', 'kb:control+b': 'toggleBold', 'kb:control+downArrow': 'nextParagraph', 'kb:control+e': 'toggleAlignment', 'kb:control+i': 'toggleItalic', 'kb:control+j': 'toggleAlignment', 'kb:control+l': 'toggleAlignment', 'kb:control+m': 'changeParagraphLeftIndent', 'kb:control+pageDown': 'caret_moveByLine', 'kb:control+pageUp': 'caret_moveByLine', 'kb:control+r': 'toggleAlignment', 'kb:control+shift+,': 'increaseDecreaseFontSize', 'kb:control+shift+.': 'increaseDecreaseFontSize', 'kb:control+shift+8': 'toggleDisplayNonprintingCharacters', 'kb:control+shift+=': 'toggleSuperscriptSubscript', 'kb:control+shift+m': 'changeParagraphLeftIndent', 'kb:control+shift+n': 'increaseDecreaseOutlineLevel', 'kb:control+shift+t': 'changeParagraphLeftIndent', 'kb:control+t': 'changeParagraphLeftIndent', 'kb:control+u': 'toggleUnderline', 'kb:control+upArrow': 'previousParagraph', 'kb:control+v': 'updateBrailleAndReviewPosition', 'kb:control+x': 'updateBrailleAndReviewPosition', 'kb:control+y': 'updateBrailleAndReviewPosition', 'kb:control+z': 'updateBrailleAndReviewPosition', 'kb:shift+tab': 'tab', 'kb:tab': 'tab'}
_abc_impl = <_abc._abc_data object>
ignoreEditorRevisions
role: controlTypes.Role

Type definition for auto prop ‘_get_role’

states: Set[State]

Type info for auto property: _get_states

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.winword.SpellCheckErrorField(chooseBestAPI=True, **kwargs)

Bases: IAccessible, WordDocument_WwN

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

parentSDMCanOverrideName = False
ignoreFormatting = True
_get_location()

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

_get_errorText()
_get_name()

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

description: str = None

Typing information for auto property _get_description

reportFocus()

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

isDuplicateIAccessibleEvent(obj)

We return false here because the spell checker window raises the focus event every time the value changes instead of the value changed event regardless of the fact that this window already has the focus.

_abc_impl = <_abc._abc_data object>
errorText
location
name: str

Type definition for auto prop ‘_get_name’

_propertyCache: Set[GetterMethodT]
class NVDAObjects.IAccessible.winword.ProtectedDocumentPane(chooseBestAPI=True, **kwargs)

Bases: IAccessible

The pane that directly contains a Word document control. This pane exists no matter if the document is protected or not, but specifically gets focus when a document is opened in protected mode, and therefore handles moving focus back to the actual document. This class also suppresses this pane from being presented in the focus ancestry as it contains redundant information. This is mapped to the window class _WWB and role oleacc.ROLE_SYSTEM_CLIENT

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

isPresentableFocusAncestor = False
event_gainFocus()

On gaining focus, simply set the focus on a child of type word document. This is just a container window.

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