NVDAObjects package
Module that contains the base NVDA object type with dynamic class creation support, as well as the associated TextInfo class.
- class NVDAObjects.NVDAObjectTextInfo(*args, **kwargs)
Bases:
OffsetsTextInfo
A default TextInfo which is used to enable text review of information about widgets that don’t support text content. The L{NVDAObject.basicText} attribute is used as the text to expose.
Constructor. Subclasses may extend this to perform implementation specific initialisation, calling their superclass method afterwards.
- locationText = None
- encoding: str | None = None
The encoding internal to the underlying text info implementation.
- _get_unit_mouseChunk()
- _getStoryText()
Retrieve the entire text of the object. @return: The entire text of the object. @rtype: str
- _getStoryLength()
- _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.)
- _abc_impl = <_abc._abc_data object>
- boundingRects
- unit_mouseChunk
- exception NVDAObjects.InvalidNVDAObject
Bases:
RuntimeError
Raised by NVDAObjects during construction to inform that this object is invalid. In this case, for the purposes of NVDA, the object should be considered non-existent. Therefore, L{DynamicNVDAObjectType} will return C{None} if this exception is raised.
- class NVDAObjects.DynamicNVDAObjectType(name, bases, dict)
Bases:
ScriptableType
- _dynamicClassCache = {}
- classmethod clearDynamicClassCache()
Clear the dynamic class cache. This should be called when a plugin is unloaded so that any used overlay classes in the unloaded plugin can be garbage collected.
- _insertLockScreenObject(clsList: List[NVDAObject]) None
Inserts LockScreenObject to the start of the clsList if Windows is locked.
- class NVDAObjects.NVDAObject(chooseBestAPI=True, **kwargs)
Bases:
TextContainerObject
,ScriptableObject
NVDA’s representation of a single control/widget. Every widget, regardless of how it is exposed by an application or the operating system, is represented by a single NVDAObject instance. This allows NVDA to work with all widgets in a uniform way. An NVDAObject provides information about the widget (e.g. its name, role and value), as well as functionality to manipulate it (e.g. perform an action or set focus). Events for the widget are handled by special event methods on the object. Commands triggered by input from the user can also be handled by special methods called scripts. See L{ScriptableObject} for more details.
The only attribute that absolutely must be provided is L{processID}. However, subclasses should provide at least the L{name} and L{role} attributes in order for the object to be meaningful to the user. Attributes such as L{parent}, L{firstChild}, L{next} and L{previous} link an instance to other NVDAObjects in the hierarchy. In order to facilitate access to text exposed by a widget which supports text content (e.g. an editable text control), a L{textInfos.TextInfo} should be implemented and the L{TextInfo} attribute should specify this class.
- There are two main types of NVDAObject classes:
API classes, which provide the core functionality to work with objects exposed using a particular API (e.g. MSAA/IAccessible).
Overlay classes, which supplement the core functionality provided by an API class to handle a specific widget or type of widget.
Most developers need only be concerned with overlay classes. The overlay classes to be used for an instance are determined using the L{findOverlayClasses} method on the API class. An L{AppModule} can also choose overlay classes for an instance using the L{AppModule.chooseNVDAObjectOverlayClasses} method.
- cachePropertiesByDefault = True
Specifies whether properties are cached by default; can be overridden for individual properties by setting _cache_propertyName. @type: bool
- TextInfo
The TextInfo class this object should use to provide access to text. @type: type; L{textInfos.TextInfo}
alias of
NVDAObjectTextInfo
- isTextSelectionAnchoredAtStart = True
Indicates if the text selection is anchored at the start. The anchored position is the end that doesn’t move when extending or shrinking the selection. For example, if you have no selection and you press shift+rightArrow to select the next character, this will be True. In contrast, if you have no selection and you press shift+leftArrow to select the previous character, this will be False. If the selection is anchored at the end or there is no information this is C{False}. @type: bool
- classmethod findBestAPIClass(kwargs, relation=None)
Finds out the highest-level APIClass this object can get to given these kwargs, and updates the kwargs and returns the APIClass. @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: the new APIClass @rtype: DynamicNVDAObjectType
- 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: List[Type[NVDAObject]]) None
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.
- beTransparentToMouse = False
If true then NVDA will never consider the mouse to be on this object, rather it will be on an ancestor.
- objectFromPointRedirect(x: int, y: int) NVDAObject | None
Redirects NVDA to another object if this object is retrieved from on-screen coordinates. :param x: the x coordinate. :param y: the y coordinate. :return: The object that NVDA should be redirected to.
- static objectFromPoint(x: int, y: int) NVDAObject
Retrieves an NVDAObject instance representing a control in the Operating System at the given x and y coordinates. :param x: the x coordinate. :param y: the y coordinate. :return: The object at the given x and y coordinates.
- static objectWithFocus()
Retrieves the object representing the control currently with focus in the Operating System. This differens from NVDA’s focus object as this focus object is the real focus object according to the Operating System, not according to NVDA. @return: the object with focus. @rtype: L{NVDAObject}
- static objectInForeground()
Retrieves the object representing the current foreground control according to the Operating System. This may differ from NVDA’s cached foreground object. @return: the foreground object @rtype: L{NVDAObject}
- _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
- focusRedirect = None
- treeInterceptorClass: Type[TreeInterceptor]
Type definition for auto prop ‘_get_treeInterceptorClass’
- _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.
- shouldCreateTreeInterceptor = True
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
- property treeInterceptor: TreeInterceptor | None
Type definition for auto prop ‘_get_treeInterceptor’
- _get_treeInterceptor() TreeInterceptor | None
Retrieves the treeInterceptor associated with this object. If a treeInterceptor has not been specifically set, the L{treeInterceptorHandler} is asked if it can find a treeInterceptor containing this object. @return: the treeInterceptor
- _set_treeInterceptor(obj: TreeInterceptor | None)
Specifically sets a treeInterceptor to be associated with this object.
- appModule: appModuleHandler.AppModule
Type definition for auto prop ‘_get_appModule’
- _get_appModule() AppModule
Retrieves the appModule representing the application this object is a part of by asking L{appModuleHandler}. @return: the appModule
- name: str
Type definition for auto prop ‘_get_name’
- _get_name() str
The name or label of this object (example: the text of a button).
- _get_role() Role
The role or type of control this object represents (example: button, list, dialog).
- roleText: str | None
Type definition for auto prop ‘_get_roleText’
- _get_roleText() str | None
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()
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.
- value: str
Typing information for auto property _get_value
- _get_value() str
The value of this object (example: the current percentage of a scrollbar, the selected option in a combo box).
- description: str
Typing information for auto property _get_description
- _get_description() str
The description or help text of this object.
- descriptionFrom: DescriptionFrom
Typing information for auto property _get_descriptionFrom
- _get_descriptionFrom() DescriptionFrom
- annotations: AnnotationOrigin
Typing information for auto property _get_annotations
- _get_annotations() AnnotationOrigin | None
- detailsSummary: str | None
Typing information for auto property _get_detailsSummary Deprecated, use self.annotations.targets instead.
- _get_detailsSummary() str | None
- property hasDetails: bool
Default implementation is based on the result of _get_detailsSummary In most instances this should be optimised.
- detailsRole: Role | None
Typing information for auto property _get_detailsRole Deprecated, use self.annotations.roles instead.
- _get_controllerFor()
Retrieves the object/s that this object controls.
- _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_defaultActionIndex()
Retrieves the index of the action that is the default.
- _get_keyboardShortcut()
The shortcut key that activates this object(example: alt+t). @rtype: str
- _get_isInForeground()
Finds out if this object is currently within the foreground.
- _get_states() Set[State]
Retrieves the current states of this object (example: selected, focused). @return: a set of State constants from L{controlTypes}.
- _get_location()
The location of this object on the screen. @return: left, top, width and height of the object. @rtype: tuple of int
- _get_locationText()
A message that explains the location of the object in friendly terms.
- parent: NVDAObject | None
This object’s parent (the object that contains this object).
- _get_parent() NVDAObject | None
Retrieves this object’s parent (the object that contains this object). @return: the parent 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.
- next: NVDAObject | None
The object directly after this object with the same parent.
- _get_next() NVDAObject | None
Retrieves the object directly after this object with the same parent. @return: the next object if it exists else None.
- previous: NVDAObject | None
The object directly before this object with the same parent.
- _get_previous() NVDAObject | None
Retrieves the object directly before this object with the same parent. @return: the previous object if it exists else None.
- firstChild: NVDAObject | None
Type definition for auto prop ‘_get_firstChild’
- _get_firstChild() NVDAObject | None
Retrieves the first object that this object contains. @return: the first child object if it exists else None.
- lastChild: NVDAObject | None
Type definition for auto prop ‘_get_lastChild’
- _get_lastChild() NVDAObject | None
Retrieves the last object that this object contains. @return: the last child object if it exists else None.
- children: List[NVDAObject]
Type definition for auto prop ‘_get_children’
- _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: int) NVDAObject
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.
- _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_columnNumber()
Retrieves the column number of this object if it is in a table. @rtype: int
- _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
- cellCoordsText: str | None
Typing information for auto-property: _get_cellCoordsText
- _get_cellCoordsText() str | None
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_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_rowSpan()
The number of rows spanned by this cell. @rtype: int
- _get_rowHeaderText()
The text of the row headers for this cell. @rtype: str
- _get_columnSpan()
The number of columns spanned by this cell. @rtype: int
- _get_columnHeaderText()
The text of the column headers for this cell. @rtype: str
- _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_recursiveDescendants()
Recursively traverse and return the descendants of this object. This is a depth-first forward traversal. @return: The recursive descendants of this object. @rtype: generator of L{NVDAObject}
- presType_layout = 'layout'
- presType_content = 'content'
- _get_presentationType()
- _get_simpleParent()
- _findSimpleNext(useChild=False, useParent=True, goPrevious=False)
- _get_simpleNext()
- _get_simplePrevious()
- _get_simpleFirstChild()
- _get_simpleLastChild()
- _get_childCount()
Retrieves the number of children this object contains. @rtype: int
- _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
- isFocusable: bool
Type definition for auto prop ‘_get_isFocusable’
- _get_isFocusable()
Whether this object is focusable. @rtype: bool
- hasFocus: bool
Type definition for auto prop ‘_get_hasFocus’
- _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_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
- errorMessage: str | None
Type definition for auto prop “_get_errorMessage”
- _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.
- positionInfo: Dict[str, int]
Type definition for auto prop ‘_get_positionInfo’
- _get_positionInfo() Dict[str, int]
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.
- processID: int
Type definition for auto prop ‘_get_processID’
- _get_processID() int
Retrieves an identifier of the process this object is a part of.
- _get_isProtected()
@return: True if this object is protected (hides its input for passwords), or false otherwise @rtype: boolean
- indexInParent: int | None
Type definition for auto prop ‘_get_indexInParent’
- _get_indexInParent() int | None
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.
- _get_flowsTo()
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.
- _get_flowsFrom()
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_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
- statusBar: NVDAObject | None
Type definition for auto prop ‘_get_statusBar’
- _get_statusBar() NVDAObject | None
Finds the closest status bar in relation to this object. @return: the found status bar else 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_shouldAcceptShowHideCaretEvent()
Some objects/applications send show/hide caret events when we don’t expect it, such as when the cursor is blinking. @return: if show/hide caret events should be accepted for this object. @rtype: Boolean
- reportFocus()
Announces this object in a way suitable such that it gained focus.
- isDescendantOf(obj: NVDAObject) bool
is this object a descendant of obj?
- _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
- landmark: str | None
Typing information for auto property _get_landmark
- _get_landmark() str | None
If this object represents an ARIA landmark, fetches the ARIA landmark role. @return: ARIA landmark role else None
- _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.
- event_typedCharacter(ch)
- event_mouseMove(x: int, y: int) None
- event_selection()
- event_stateChange()
- event_focusEntered()
- event_gainFocus()
This code is executed if a gain focus event is received by this object.
- event_loseFocus()
- event_focusExited()
- event_foreground()
Called when the foreground window changes. This method should only perform tasks specific to the foreground window changing. L{event_focusEntered} or L{event_gainFocus} will be called for this object, so this method should not speak/braille the object, etc.
Called when this object becomes the navigator object. @param isFocus: true if the navigator object was set due to a focus change. @type isFocus: bool
- event_valueChange()
- event_nameChange()
- event_descriptionChange()
- event_controllerForChange()
- event_caret()
- _get_flatReviewPosition()
Locates a TextInfo positioned at this object, in the closest flat review.
- _get_basicText()
- _get__isTextEmpty()
@return C{True} if the text contained in the object is considered empty by the underlying implementation. In most cases this will match {isCollapsed}, however some implementations may consider a single space or line feed as an empty range.
- static _formatLongDevInfoString(string, truncateLen=250)
Format a potentially long string value for inclusion in devInfo. This should be used for arbitrary string values which aren’t usually useful in debugging past a certain length. If the string is too long to be useful, it will be truncated. This string should be included as returned. There is no need to call repr. @param string: The string to format. @type string: str @param truncateLen: The length at which to truncate the string. @type truncateLen: int @return: The formatted string. @rtype: str
- devInfo: List[str]
Information about this object useful to developers.
- _get_devInfo() List[str]
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.
- sleepMode: bool
- _abc_impl = <_abc._abc_data object>
- _cache_sleepMode = False
- _isTextEmpty
- actionCount
- activeChild
- basicText
- childCount
- columnCount
- columnHeaderText
- columnNumber
- columnSpan
- container
- controllerFor
- defaultActionIndex
- flatReviewPosition
- flowsFrom
- flowsTo
- hasIrrelevantLocation
- isInForeground
- isPresentableFocusAncestor
- isProtected
- keyboardShortcut
- labeledBy
- liveRegionPoliteness
- location
- locationText
- mathMl
- placeholder
- presentationType
- presentationalColumnCount
- presentationalColumnNumber
- presentationalRowCount
- presentationalRowNumber
- recursiveDescendants
- roleTextBraille
- rowCount
- rowHeaderText
- rowNumber
- rowSpan
- selectionContainer
- shouldAcceptShowHideCaretEvent
- simpleFirstChild
- simpleLastChild
- simpleNext
- simpleParent
- simplePrevious
- table
- tableID
- _get_sleepMode() bool
Whether NVDA should sleep for this object (e.g. it is self-voicing). If C{True}, all events and script requests for this object are silently dropped.
- _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.
- language = None
The language/locale of this object. @type: str
- _get_hasIrrelevantLocation()
Returns whether the location of this object is irrelevant for mouse or magnification tracking or highlighting, either because it is programatically hidden (State.INVISIBLE), off screen or the object has no location.
- _get_selectionContainer()
An ancestor NVDAObject which manages the selection for this object and other descendants.
- 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.
- isBelowLockScreen: bool
Type definition for auto prop ‘_get_isBelowLockScreen’
- _get_isBelowLockScreen() bool
Subpackages
- NVDAObjects.IAccessible package
getNVDAObjectFromEvent()
getNVDAObjectFromPoint()
normalizeIA2TextFormatField()
IA2TextTextInfo
IA2TextTextInfo.detectFormattingAfterCursorMaybeSlow
IA2TextTextInfo._get_encoding()
IA2TextTextInfo._getOffsetFromPoint()
IA2TextTextInfo._getBoundingRectFromOffsetInObject()
IA2TextTextInfo._getBoundingRectFromOffset()
IA2TextTextInfo._get_unit_mouseChunk()
IA2TextTextInfo.expand()
IA2TextTextInfo._getCaretOffset()
IA2TextTextInfo._setCaretOffset()
IA2TextTextInfo._getSelectionOffsets()
IA2TextTextInfo._setSelectionOffsets()
IA2TextTextInfo._getStoryLength()
IA2TextTextInfo._getLineCount()
IA2TextTextInfo._getTextRange()
IA2TextTextInfo._getFormatFieldAndOffsets()
IA2TextTextInfo._getCharacterOffsets()
IA2TextTextInfo._getWordOffsets()
IA2TextTextInfo._getLineOffsets()
IA2TextTextInfo._getSentenceOffsets()
IA2TextTextInfo._getParagraphOffsets()
IA2TextTextInfo._lineNumFromOffset()
IA2TextTextInfo._iterTextWithEmbeddedObjects()
IA2TextTextInfo._abc_impl
IA2TextTextInfo.encoding
IA2TextTextInfo.unit_mouseChunk
IAccessible
IAccessible.IAccessibleTableUsesTableCellIndexAttrib
IAccessible.getPossibleAPIClasses()
IAccessible.kwargsFromSuper()
IAccessible.findOverlayClasses()
IAccessible.IA2UniqueID
IAccessible.isDuplicateIAccessibleEvent()
IAccessible._get_shouldAllowIAccessibleFocusEvent()
IAccessible._get_shouldAllowIAccessibleMenuStartEvent()
IAccessible._get_TextInfo()
IAccessible._isEqual()
IAccessible._get_name()
IAccessible._get_value()
IAccessible._get_actionCount()
IAccessible.getActionName()
IAccessible.doAction()
IAccessible._get_IAccessibleIdentity()
IAccessible.IAccessibleRole
IAccessible._get_IAccessibleRole()
IAccessible._get_role()
IAccessible._cache_role
IAccessible.IAccessibleStates
IAccessible._get_IAccessibleStates()
IAccessible.states
IAccessible._get_states()
IAccessible.re_positionInfoEncodedAccDescription
IAccessible._get_decodedAccDescription()
IAccessible.hasEncodedAccDescription
IAccessible._get_description()
IAccessible._get_keyboardShortcut()
IAccessible._get_childCount()
IAccessible._get_location()
IAccessible.isPointInObject()
IAccessible._get_labeledBy()
IAccessible._get_parent()
IAccessible._get_next()
IAccessible._get_previous()
IAccessible._get_firstChild()
IAccessible._get_lastChild()
IAccessible._get_children()
IAccessible.getChild()
IAccessible.IA2Attributes
IAccessible._get_IA2Attributes()
IAccessible.event_IA2AttributeChange()
IAccessible._get_rowNumber()
IAccessible._get_presentationalRowNumber()
IAccessible._get_rowSpan()
IAccessible._get_columnNumber()
IAccessible._get_cellCoordsText()
IAccessible._get_presentationalColumnNumber()
IAccessible._get_columnSpan()
IAccessible._get_rowCount()
IAccessible._get_presentationalRowCount()
IAccessible._get_columnCount()
IAccessible._get_presentationalColumnCount()
IAccessible._get__IATableCell()
IAccessible._tableHeaderTextHelper()
IAccessible._get_rowHeaderText()
IAccessible._get_columnHeaderText()
IAccessible._get_selectionContainer()
IAccessible._getSelectedItemsCount_accSelection()
IAccessible.getSelectedItemsCount()
IAccessible._get_table()
IAccessible._get_tableID()
IAccessible._get_activeChild()
IAccessible._get_hasFocus()
IAccessible.setFocus()
IAccessible.scrollIntoView()
IAccessible._get_allowIAccessibleChildIDAndChildCountForPositionInfo()
IAccessible._get_positionInfo()
IAccessible._get_indexInParent()
IAccessible._IA2Relations
IAccessible._get__IA2Relations()
IAccessible._getIA2TargetsForRelationsOfType()
IAccessible._getIA2RelationFirstTarget()
IAccessible._getIA2RelationTargetsOfType()
IAccessible.detailsRelations
IAccessible._get_detailsRelations()
IAccessible._get_controllerFor()
IAccessible.flowsTo
IAccessible._get_flowsTo()
IAccessible.flowsFrom
IAccessible._get_flowsFrom()
IAccessible._get_errorMessage()
IAccessible.event_valueChange()
IAccessible.event_alert()
IAccessible.event_caret()
IAccessible._get_groupName()
IAccessible.event_selectionAdd()
IAccessible.event_selectionRemove()
IAccessible.event_selectionWithIn()
IAccessible._get_isPresentableFocusAncestor()
IAccessible._get_devInfo()
IAccessible._get_language()
IAccessible._get_iaHypertext()
IAccessible._get_IA2WindowHandle()
IAccessible._cache_IA2WindowHandle
IAccessible.IA2States
IAccessible._get_IA2States()
IAccessible.summarizeInProcess()
IAccessible.IA2WindowHandle
IAccessible.IAccessibleIdentity
IAccessible.TextInfo
IAccessible._IATableCell
IAccessible._abc_impl
IAccessible.actionCount
IAccessible.activeChild
IAccessible.allowIAccessibleChildIDAndChildCountForPositionInfo
IAccessible.cellCoordsText
IAccessible.childCount
IAccessible.children
IAccessible.columnCount
IAccessible.columnHeaderText
IAccessible.columnNumber
IAccessible.columnSpan
IAccessible.controllerFor
IAccessible.decodedAccDescription
IAccessible.description
IAccessible.devInfo
IAccessible.errorMessage
IAccessible.firstChild
IAccessible.groupName
IAccessible.hasFocus
IAccessible.iaHypertext
IAccessible.indexInParent
IAccessible.isPresentableFocusAncestor
IAccessible.keyboardShortcut
IAccessible.labeledBy
IAccessible.language
IAccessible.lastChild
IAccessible.location
IAccessible.name
IAccessible.next
IAccessible.parent
IAccessible.positionInfo
IAccessible.presentationalColumnCount
IAccessible.presentationalColumnNumber
IAccessible.presentationalRowCount
IAccessible.presentationalRowNumber
IAccessible.previous
IAccessible.role
IAccessible.rowCount
IAccessible.rowHeaderText
IAccessible.rowNumber
IAccessible.rowSpan
IAccessible.selectionContainer
IAccessible.shouldAllowIAccessibleFocusEvent
IAccessible.shouldAllowIAccessibleMenuStartEvent
IAccessible.table
IAccessible.tableID
IAccessible.value
ContentGenericClient
GenericWindow
WindowRoot
WindowRoot.parentUsesSuperOnWindowRootIAccessible
WindowRoot.windowHasExtraIAccessibles()
WindowRoot._get_presentationType()
WindowRoot._get_parent()
WindowRoot._get_next()
WindowRoot._get_previous()
WindowRoot._get_container()
WindowRoot._abc_impl
WindowRoot.container
WindowRoot.next
WindowRoot.parent
WindowRoot.presentationType
WindowRoot.previous
WindowRoot._propertyCache
ShellDocObjectView
JavaVMRoot
NUIDialogClient
Groupbox
TrayClockWClass
OutlineItem
List
SysLinkClient
SysLink
TaskList
TaskListIcon
MenuItem
Taskbar
Button
InaccessibleListBoxItem
InaccessibleComboBox
StaticText
Titlebar
ReBarWindow32Client
ListviewPane
IEFrameNotificationBar
IENotificationBar
UIItem
- Submodules
- NVDAObjects.IAccessible.MSHTML module
UIAMSHTMLTextInfo
HTMLAttribCache
getZoomFactorsFromHTMLDocument()
IAccessibleFromHTMLNode()
HTMLNodeFromIAccessible()
locateHTMLElementByID()
getChildHTMLNodeFromFrame()
MSHTMLTextInfo
MSHTMLTextInfo._expandToLine()
MSHTMLTextInfo.expand()
MSHTMLTextInfo._get_isCollapsed()
MSHTMLTextInfo.collapse()
MSHTMLTextInfo.copy()
MSHTMLTextInfo.compareEndPoints()
MSHTMLTextInfo.setEndPoint()
MSHTMLTextInfo._get_text()
MSHTMLTextInfo.move()
MSHTMLTextInfo.updateCaret()
MSHTMLTextInfo.updateSelection()
MSHTMLTextInfo._get_bookmark()
MSHTMLTextInfo._abc_impl
MSHTMLTextInfo.bookmark
MSHTMLTextInfo.isCollapsed
MSHTMLTextInfo.text
MSHTML
MSHTML._get__UIAControl()
MSHTML.makeTextInfo()
MSHTML.HTMLNodeNameNavSkipList
MSHTML.HTMLNodeNameEmbedList
MSHTML._ignoreCaretEvents
MSHTML.suspendCaretEvents()
MSHTML.event_caret()
MSHTML.kwargsFromSuper()
MSHTML.findOverlayClasses()
MSHTML._get_treeInterceptorClass()
MSHTML._get_isCurrent()
MSHTML.HTMLAttributes
MSHTML._get_HTMLAttributes()
MSHTML._get_placeholder()
MSHTML._get_zoomFactors()
MSHTML._get_location()
MSHTML._get_TextInfo()
MSHTML.isDuplicateIAccessibleEvent()
MSHTML._isEqual()
MSHTML._get_presentationType()
MSHTML._get_shouldAllowIAccessibleFocusEvent()
MSHTML._get_name()
MSHTML._get_landmark()
MSHTML._get_value()
MSHTML._get_description()
MSHTML._get_basicText()
MSHTML._get_role()
MSHTML._get_states()
MSHTML._get_isContentEditable()
MSHTML._get_parent()
MSHTML._get_previous()
MSHTML._get_next()
MSHTML._get_firstChild()
MSHTML._get_lastChild()
MSHTML._get_columnNumber()
MSHTML._get_rowNumber()
MSHTML._get_rowCount()
MSHTML.scrollIntoView()
MSHTML.doAction()
MSHTML._get_isFocusable()
MSHTML.setFocus()
MSHTML._get_table()
MSHTML._get_HTMLNodeUniqueNumber()
MSHTML._get_HTMLNodeName()
MSHTML._get_devInfo()
MSHTML._get_language()
MSHTML._get_liveRegionPoliteness()
MSHTML.event_liveRegionChange()
MSHTML._get_roleText()
MSHTML.HTMLNodeName
MSHTML.HTMLNodeUniqueNumber
MSHTML.TextInfo
MSHTML._UIAControl
MSHTML._abc_impl
MSHTML.basicText
MSHTML.columnNumber
MSHTML.description
MSHTML.devInfo
MSHTML.firstChild
MSHTML.isContentEditable
MSHTML.isCurrent
MSHTML.isFocusable
MSHTML.landmark
MSHTML.language
MSHTML.lastChild
MSHTML.liveRegionPoliteness
MSHTML.location
MSHTML.name
MSHTML.next
MSHTML.parent
MSHTML.placeholder
MSHTML.presentationType
MSHTML.previous
MSHTML.role
MSHTML.roleText
MSHTML.rowCount
MSHTML.rowNumber
MSHTML.shouldAllowIAccessibleFocusEvent
MSHTML.states
MSHTML.table
MSHTML.treeInterceptorClass
MSHTML.value
MSHTML.zoomFactors
V6ComboBox
Fieldset
Body
Object
PluginWindow
PopupList
RootClient
MSAATextLeaf
Math
findExtraIAccessibleOverlayClasses()
- NVDAObjects.IAccessible.SysMonthCal32 module
- NVDAObjects.IAccessible.adobeAcrobat module
- NVDAObjects.IAccessible.akelEdit module
- NVDAObjects.IAccessible.chromium module
- NVDAObjects.IAccessible.delphi module
- NVDAObjects.IAccessible.hh module
- NVDAObjects.IAccessible.ia2TextMozilla module
FakeEmbeddingTextInfo
_getRawTextInfo()
_getEmbedded()
MozillaCompoundTextInfo
MozillaCompoundTextInfo._getControlFieldForObject()
MozillaCompoundTextInfo._isCaretAtEndOfLine()
MozillaCompoundTextInfo.NVDAObjectAtStart
MozillaCompoundTextInfo._abc_impl
MozillaCompoundTextInfo.boundingRects
MozillaCompoundTextInfo.text
MozillaCompoundTextInfo._getSelectionBase()
MozillaCompoundTextInfo._makeRawTextInfo()
MozillaCompoundTextInfo._getEmbedding()
MozillaCompoundTextInfo.POSITION_SELECTION_START
MozillaCompoundTextInfo.POSITION_SELECTION_END
MozillaCompoundTextInfo.FINDCONTENTDESCENDANT_POSITIONS
MozillaCompoundTextInfo._findContentDescendant()
MozillaCompoundTextInfo._iterRecursiveText()
MozillaCompoundTextInfo._getText()
MozillaCompoundTextInfo._get_text()
MozillaCompoundTextInfo.getTextWithFields()
MozillaCompoundTextInfo._adjustIfEndOfLine()
MozillaCompoundTextInfo._findUnitEndpoints()
MozillaCompoundTextInfo.expand()
MozillaCompoundTextInfo._findNextContent()
MozillaCompoundTextInfo.move()
MozillaCompoundTextInfo._getAncestors()
MozillaCompoundTextInfo.compareEndPoints()
MozillaCompoundTextInfo._get_NVDAObjectAtStart()
MozillaCompoundTextInfo._get_boundingRects()
MozillaCompoundTextInfo.setEndPoint()
- NVDAObjects.IAccessible.ia2Web module
IA2WebAnnotationTarget
IA2WebAnnotation
Ia2Web
Ia2Web.IAccessibleTableUsesTableCellIndexAttrib
Ia2Web.isDescendantOf()
Ia2Web._get_positionInfo()
Ia2Web._get_descriptionFrom()
Ia2Web.annotations
Ia2Web._get_annotations()
Ia2Web._get_detailsSummary()
Ia2Web.hasDetails
Ia2Web._get_detailsRole()
Ia2Web._get_isCurrent()
Ia2Web._get_placeholder()
Ia2Web._get_isPresentableFocusAncestor()
Ia2Web._get_roleText()
Ia2Web._get_roleTextBraille()
Ia2Web._get_states()
Ia2Web._get_landmark()
Ia2Web.event_IA2AttributeChange()
Ia2Web._get_liveRegionPoliteness()
Ia2Web._abc_impl
Ia2Web.descriptionFrom
Ia2Web.detailsRole
Ia2Web.detailsSummary
Ia2Web.isCurrent
Ia2Web.isPresentableFocusAncestor
Ia2Web.landmark
Ia2Web.liveRegionPoliteness
Ia2Web.placeholder
Ia2Web.positionInfo
Ia2Web.roleText
Ia2Web.roleTextBraille
Ia2Web.states
Document
Application
BlockQuote
Treegrid
Article
Region
Figure
Editor
EditorChunk
Math
Switch
findExtraOverlayClasses()
- NVDAObjects.IAccessible.mozilla module
MozAnnotationTarget
MozAnnotation
Mozilla
Mozilla._get_states()
Mozilla._get_descriptionFrom()
Mozilla._get_presentationType()
Mozilla.annotations
Mozilla._get_annotations()
Mozilla._get_detailsSummary()
Mozilla._get_detailsRole()
Mozilla.hasDetails
Mozilla._abc_impl
Mozilla.descriptionFrom
Mozilla.detailsRole
Mozilla.detailsSummary
Mozilla.presentationType
Mozilla.states
Document
EmbeddedObject
GeckoPluginWindowRoot
TextLeaf
findExtraOverlayClasses()
_IAccessibleRolesToOverlayClasses
- NVDAObjects.IAccessible.msOffice module
SDM
SDM._get_shouldAllowIAccessibleFocusEvent()
SDM._get_name()
SDM._get_positionInfo()
SDM._get_parent()
SDM._get_presentationType()
SDM._get_firstChild()
SDM._get_lastChild()
SDM._get_SDMChild()
SDM.SDMChild
SDM._abc_impl
SDM.firstChild
SDM.lastChild
SDM.name
SDM.parent
SDM.positionInfo
SDM.presentationType
SDM.shouldAllowIAccessibleFocusEvent
SDM._propertyCache
MSOUNISTAT
MsoCommandBarToolBar
BrokenMsoCommandBar
CommandBarListItem
SDMSymbols
StatusBar
RibbonSection
- NVDAObjects.IAccessible.mscandui module
reportSelectedCandidate()
BaseCandidateItem
BaseCandidateItem.role
BaseCandidateItem.keyboardShortcut
BaseCandidateItem._get_candidateNumber()
BaseCandidateItem._get_parent()
BaseCandidateItem._get_name()
BaseCandidateItem._get_description()
BaseCandidateItem._get_basicText()
BaseCandidateItem._abc_impl
BaseCandidateItem.basicText
BaseCandidateItem.candidateNumber
BaseCandidateItem.description
BaseCandidateItem.name
BaseCandidateItem.parent
BaseCandidateItem._propertyCache
MSCandUI_candidateListItem
MSCandUI21_candidateMenuItem
MSCandUI21_candidateMenuItem._get_previous()
MSCandUI21_candidateMenuItem._get_next()
MSCandUI21_candidateMenuItem.doAction()
MSCandUI21_candidateMenuItem.script_nextItem()
MSCandUI21_candidateMenuItem.script_previousItem()
MSCandUI21_candidateMenuItem.script_changePage()
MSCandUI21_candidateMenuItem.script_activate()
MSCandUI21_candidateMenuItem.__gestures
MSCandUI21_candidateMenuItem._abc_impl
MSCandUI21_candidateMenuItem.next
MSCandUI21_candidateMenuItem.previous
MSCandUI21_candidateMenuItem._propertyCache
MSCandUI21
MSCandUIWindow_candidateListItem
MSCandUIWindow_candidateListItem._get_isValidCandidate()
MSCandUIWindow_candidateListItem._get_candidateNumber()
MSCandUIWindow_candidateListItem._get_next()
MSCandUIWindow_candidateListItem._get_previous()
MSCandUIWindow_candidateListItem._abc_impl
MSCandUIWindow_candidateListItem.candidateNumber
MSCandUIWindow_candidateListItem.isValidCandidate
MSCandUIWindow_candidateListItem.next
MSCandUIWindow_candidateListItem.previous
MSCandUIWindow_candidateListItem._propertyCache
MSCandUIWindow
ModernCandidateUICandidateItem
ModernCandidateUICandidateItem._get_parent()
ModernCandidateUICandidateItem._get_candidateCharacters()
ModernCandidateUICandidateItem._candidateNumber
ModernCandidateUICandidateItem._visibleCandidateItemsText
ModernCandidateUICandidateItem.refreshCandidateList()
ModernCandidateUICandidateItem._get_candidateNumber()
ModernCandidateUICandidateItem._get_visibleCandidateItemsText()
ModernCandidateUICandidateItem.event_stateChange()
ModernCandidateUICandidateItem._abc_impl
ModernCandidateUICandidateItem.candidateCharacters
ModernCandidateUICandidateItem.candidateNumber
ModernCandidateUICandidateItem.parent
ModernCandidateUICandidateItem.visibleCandidateItemsText
ModernCandidateUICandidateItem._propertyCache
findExtraOverlayClasses()
- NVDAObjects.IAccessible.qt module
- NVDAObjects.IAccessible.scintilla module
- NVDAObjects.IAccessible.sysListView32 module
LVITEM
LVITEM64
LVCOLUMN
LVCOLUMN64
AutoFreeBSTR
List
List.getListGroupInfo()
List._get_name()
List.event_gainFocus()
List._get_isMultiColumn()
List._get_rowCount()
List.columnCount
List._get_columnCount()
List._getColumnOrderArrayRawInProc()
List._getColumnOrderArrayRawOutProc()
List._getColumnOrderArrayRaw()
List._getMappedColumn()
List._abc_impl
List.isMultiColumn
List.name
List.rowCount
GroupingItem
GroupingItem.groupInfo
GroupingItem._isEqual()
GroupingItem._set_groupInfo()
GroupingItem._get_groupInfo()
GroupingItem._get_name()
GroupingItem.role
GroupingItem._get_value()
GroupingItem._get_states()
GroupingItem.script_collapseOrExpand()
GroupingItem._abc_impl
GroupingItem.name
GroupingItem.states
GroupingItem.value
ListItemWithoutColumnSupport
ListItemWithoutColumnSupport.initOverlayClass()
ListItemWithoutColumnSupport.description
ListItemWithoutColumnSupport._get_value()
ListItemWithoutColumnSupport._get_positionInfo()
ListItemWithoutColumnSupport.event_stateChange()
ListItemWithoutColumnSupport._abc_impl
ListItemWithoutColumnSupport.positionInfo
ListItemWithoutColumnSupport.value
ListItemWithoutColumnSupport._propertyCache
ListItem
ListItem._getColumnLocationRawInProc()
ListItem._getColumnLocationRawOutProc()
ListItem._getColumnLocationRaw()
ListItem._getColumnLocation()
ListItem._getColumnContentRawInProc()
ListItem._getColumnContentRawOutProc()
ListItem._getColumnContentRaw()
ListItem._getColumnContent()
ListItem._getColumnImageIDRaw()
ListItem._getColumnImageID()
ListItem._getColumnHeaderRawOutProc()
ListItem._getColumnHeaderRawInProc()
ListItem._getColumnHeaderRaw()
ListItem._getColumnHeader()
ListItem._abc_impl
ListItem._get_name()
ListItem._shouldDisableMultiColumn
ListItem.name
ListItem.value
ListItem._get__shouldDisableMultiColumn()
- NVDAObjects.IAccessible.sysTreeView32 module
TreeView
TreeViewItem
TreeViewItem._get_role()
TreeViewItem._get_treeview_hItem()
TreeViewItem._get_treeview_level()
TreeViewItem._get_states()
TreeViewItem._get_value()
TreeViewItem._get_parent()
TreeViewItem._get_firstChild()
TreeViewItem._get_next()
TreeViewItem._get_previous()
TreeViewItem._get_children()
TreeViewItem._get_childCount()
TreeViewItem._get_positionInfo()
TreeViewItem.event_stateChange()
TreeViewItem._abc_impl
TreeViewItem.childCount
TreeViewItem.children
TreeViewItem.firstChild
TreeViewItem.next
TreeViewItem.parent
TreeViewItem.positionInfo
TreeViewItem.previous
TreeViewItem.role
TreeViewItem.states
TreeViewItem.treeview_hItem
TreeViewItem.treeview_level
TreeViewItem.value
TreeViewItem._propertyCache
BrokenCommctrl5Item
BrokenCommctrl5Item.initOverlayClass()
BrokenCommctrl5Item._get_role()
BrokenCommctrl5Item._get_name()
BrokenCommctrl5Item._get_description()
BrokenCommctrl5Item._get_value()
BrokenCommctrl5Item._get_states()
BrokenCommctrl5Item._get_positionInfo()
BrokenCommctrl5Item._get_location()
BrokenCommctrl5Item._makeRelatedObj()
BrokenCommctrl5Item._get_parent()
BrokenCommctrl5Item._get_next()
BrokenCommctrl5Item._get_previous()
BrokenCommctrl5Item._get_firstChild()
BrokenCommctrl5Item._get_lastChild()
BrokenCommctrl5Item._get_children()
BrokenCommctrl5Item.getFirstItem()
BrokenCommctrl5Item._abc_impl
BrokenCommctrl5Item.children
BrokenCommctrl5Item.description
BrokenCommctrl5Item.firstChild
BrokenCommctrl5Item.lastChild
BrokenCommctrl5Item.location
BrokenCommctrl5Item.name
BrokenCommctrl5Item.next
BrokenCommctrl5Item.parent
BrokenCommctrl5Item.positionInfo
BrokenCommctrl5Item.previous
BrokenCommctrl5Item.role
BrokenCommctrl5Item.states
BrokenCommctrl5Item.value
BrokenCommctrl5Item._propertyCache
- NVDAObjects.IAccessible.webKit module
- NVDAObjects.IAccessible.winConsole module
- NVDAObjects.IAccessible.winword module
WordDocument
WordDocument.treeInterceptorClass
WordDocument.shouldCreateTreeInterceptor
WordDocument.TextInfo
WordDocument._fromUpdateBrailleAndReviewPosition
WordDocument._get_ignoreEditorRevisions()
WordDocument.ignorePageNumbers
WordDocument.ignoreFormatting
WordDocument.event_caret()
WordDocument._get_role()
WordDocument._get_states()
WordDocument.populateHeaderCellTrackerFromHeaderRows()
WordDocument.populateHeaderCellTrackerFromBookmarks()
WordDocument._curHeaderCellTrackerTable
WordDocument._curHeaderCellTracker
WordDocument.getHeaderCellTrackerForTable()
WordDocument.setAsHeaderCell()
WordDocument.forgetHeaderCell()
WordDocument.fetchAssociatedHeaderCellText()
WordDocument.script_setColumnHeader()
WordDocument.script_setRowHeader()
WordDocument.script_caret_moveByCell()
WordDocument.script_reportCurrentComment()
WordDocument._moveInTable()
WordDocument.script_nextRow()
WordDocument.script_previousRow()
WordDocument.script_nextColumn()
WordDocument.script_previousColumn()
WordDocument.script_nextParagraph()
WordDocument.script_previousParagraph()
WordDocument.script_updateBrailleAndReviewPosition()
WordDocument._backspaceScriptHelper()
WordDocument.focusOnActiveDocument()
WordDocument.__gestures
WordDocument._abc_impl
WordDocument.ignoreEditorRevisions
WordDocument.role
WordDocument.states
WordDocument._propertyCache
SpellCheckErrorField
SpellCheckErrorField.parentSDMCanOverrideName
SpellCheckErrorField.ignoreFormatting
SpellCheckErrorField._get_location()
SpellCheckErrorField._get_errorText()
SpellCheckErrorField._get_name()
SpellCheckErrorField.description
SpellCheckErrorField.reportFocus()
SpellCheckErrorField.isDuplicateIAccessibleEvent()
SpellCheckErrorField._abc_impl
SpellCheckErrorField.errorText
SpellCheckErrorField.location
SpellCheckErrorField.name
SpellCheckErrorField._propertyCache
ProtectedDocumentPane
- NVDAObjects.JAB package
_subHtmlTag()
_processHtml()
JABTextInfo
JABTextInfo._getOffsetFromPoint()
JABTextInfo._getBoundingRectFromOffset()
JABTextInfo._getCaretOffset()
JABTextInfo._setCaretOffset()
JABTextInfo._getSelectionOffsets()
JABTextInfo._setSelectionOffsets()
JABTextInfo._getStoryLength()
JABTextInfo._getTextRange()
JABTextInfo._getLineNumFromOffset()
JABTextInfo._getLineOffsets()
JABTextInfo._getParagraphOffsets()
JABTextInfo._getFormatFieldAndOffsets()
JABTextInfo.getEmbeddedObject()
JABTextInfo._abc_impl
JAB
JAB.findOverlayClasses()
JAB.kwargsFromSuper()
JAB._get__JABAccContextInfo()
JAB._get_TextInfo()
JAB._isEqual()
JAB._get_keyboardShortcut()
JAB._get_name()
JAB._get_JABRole()
JAB._get_role()
JAB._get_JABStates()
JAB._get_states()
JAB._get_value()
JAB._get_description()
JAB._get_location()
JAB._get_hasFocus()
JAB._get_positionInfo()
JAB._get_activeChild()
JAB._get_parent()
JAB._get_next()
JAB._get_previous()
JAB._get_firstChild()
JAB._get_lastChild()
JAB._get_childCount()
JAB._get_children()
JAB._get_indexInParent()
JAB._getJABRelationTargets()
JAB._get_flowsTo()
JAB._get_flowsFrom()
JAB.reportFocus()
JAB._get__actions()
JAB._get_actionCount()
JAB.getActionName()
JAB.doAction()
JAB._get_activeDescendant()
JAB.event_gainFocus()
JAB.JABRole
JAB.JABStates
JAB.TextInfo
JAB._JABAccContextInfo
JAB._abc_impl
JAB._actions
JAB.actionCount
JAB.activeChild
JAB.activeDescendant
JAB.childCount
JAB.children
JAB.description
JAB.firstChild
JAB.flowsFrom
JAB.flowsTo
JAB.hasFocus
JAB.indexInParent
JAB.keyboardShortcut
JAB.lastChild
JAB.location
JAB.name
JAB.next
JAB.parent
JAB.positionInfo
JAB.previous
JAB.role
JAB.states
JAB.value
ComboBox
Table
TableCell
TableCell._get_table()
TableCell._get_tableID()
TableCell._get_rowNumber()
TableCell._get_columnNumber()
TableCell._get_rowHeaderText()
TableCell._get_columnHeaderText()
TableCell._abc_impl
TableCell.columnHeaderText
TableCell.columnNumber
TableCell.rowHeaderText
TableCell.rowNumber
TableCell.table
TableCell.tableID
TableCell._propertyCache
- NVDAObjects.UIA package
UIATextInfo
UIATextInfo._cache_controlFieldNVDAObjectClass
UIATextInfo._get_controlFieldNVDAObjectClass()
UIATextInfo._controlFieldUIACachedPropertyIDs
UIATextInfo._get__controlFieldUIACacheRequest()
UIATextInfo.UIAFormatUnits
UIATextInfo.find()
UIATextInfo._getFormatFieldFontName()
UIATextInfo._getFormatFieldFontSize()
UIATextInfo._getFormatFieldFontAttributes()
UIATextInfo._getFormatFieldSuperscriptsAndSubscripts()
UIATextInfo._getFormatFieldStyle()
UIATextInfo._getFormatFieldIndent()
UIATextInfo._getFormatFieldAlignment()
UIATextInfo._getFormatFieldColor()
UIATextInfo._getFormatFieldLineSpacing()
UIATextInfo._getFormatFieldLinks()
UIATextInfo._getFormatFieldHeadings()
UIATextInfo._getFormatFieldAnnotationTypes()
UIATextInfo._getFormatFieldCulture()
UIATextInfo._getFormatFieldAtRange()
UIATextInfo._getIndentValueDisplayString()
UIATextInfo._rangeObj
UIATextInfo._get_NVDAObjectAtStart()
UIATextInfo._get_UIAElementAtStart()
UIATextInfo._get_bookmark()
UIATextInfo.UIAControlTypesWhereNameIsContent
UIATextInfo._getControlFieldForUIAObject()
UIATextInfo._getTextFromUIARange()
UIATextInfo._getTextWithFields_text()
UIATextInfo._getTextWithFieldsForUIARange()
UIATextInfo.getTextWithFields()
UIATextInfo._get_text()
UIATextInfo._getBoundingRectsFromUIARange()
UIATextInfo._get_boundingRects()
UIATextInfo.expand()
UIATextInfo.move()
UIATextInfo.copy()
UIATextInfo.collapse()
UIATextInfo.compareEndPoints()
UIATextInfo.setEndPoint()
UIATextInfo.updateSelection()
UIATextInfo.updateCaret()
UIATextInfo.NVDAObjectAtStart
UIATextInfo.UIAElementAtStart
UIATextInfo._abc_impl
UIATextInfo._controlFieldUIACacheRequest
UIATextInfo.bookmark
UIATextInfo.boundingRects
UIATextInfo.controlFieldNVDAObjectClass
UIATextInfo.text
UIA
UIA._UIACustomProps
UIA._UIACustomAnnotationTypes
UIA.shouldAllowDuplicateUIAFocusEvent
UIA._get__coreCycleUIAPropertyCacheElementCache()
UIA._getUIACacheablePropertyValue()
UIA._prefetchUIACacheForPropertyIDs()
UIA.findOverlayClasses()
UIA.kwargsFromSuper()
UIA.getNormalizedUIATextRangeFromElement()
UIA._isEqual()
UIA.event_gainFocus()
UIA.event_loseFocus()
UIA._get_shouldAllowUIAFocusEvent()
UIA._lastLiveRegionChangeInfo
UIA._get__shouldAllowUIALiveRegionChangeEvent()
UIA._getUIAPattern()
UIA._get_UIAInvokePattern()
UIA._get_UIAGridPattern()
UIA._get_UIARangeValuePattern()
UIA._get_UIAValuePattern()
UIA._get_UIATogglePattern()
UIA._get_UIASelectionItemPattern()
UIA._get_UIASelectionPattern()
UIA._get_UIASelectionPattern2()
UIA.getSelectedItemsCount()
UIA.selectionContainer
UIA._get_selectionContainer()
UIA.UIAAnnotationObjects
UIA._get_UIAAnnotationObjects()
UIA._get_UIATextPattern()
UIA._get_UIATableItemPattern()
UIA._get_UIATextEditPattern()
UIA._get_UIALegacyIAccessiblePattern()
UIA._TextInfo
UIA._cache_TextInfo
UIA._get_TextInfo()
UIA.setFocus()
UIA._get_devInfo()
UIA._get_UIAAutomationId()
UIA._get_UIAFrameworkId()
UIA.name
UIA._get_name()
UIA._get_liveRegionPoliteness()
UIA._get_role()
UIA._get_UIAFullDescription()
UIA._get_UIAHelpText()
UIA._get_description()
UIA._get_keyboardShortcut()
UIA._UIAStatesPropertyIDs
UIA._get_states()
UIA._getReadOnlyState()
UIA._get_presentationType()
UIA.correctAPIForRelation()
UIA._get_parent()
UIA._get_previous()
UIA.next
UIA._get_next()
UIA._get_firstChild()
UIA._get_lastChild()
UIA._get_UIAChildren()
UIA._get_children()
UIA._get_childCount()
UIA._get_rowNumber()
UIA._get_rowSpan()
UIA._getTextFromHeaderElement()
UIA._get_rowHeaderText()
UIA._get_columnNumber()
UIA._get_columnSpan()
UIA._get_columnHeaderText()
UIA._get_rowCount()
UIA._get_columnCount()
UIA._get_table()
UIA._get_tableID()
UIA._get_processID()
UIA._get_location()
UIA._get_UIAValue()
UIA._get_UIARangeValue()
UIA._get_value()
UIA._get_actionCount()
UIA.getActionName()
UIA.doAction()
UIA._get_hasFocus()
UIA._get_hasIrrelevantLocation()
UIA._get_positionInfo()
UIA.scrollIntoView()
UIA.isDescendantOf()
UIA._get_controllerFor()
UIA.event_UIA_controllerFor()
UIA.event_UIA_elementSelected()
UIA.event_valueChange()
UIA.event_UIA_systemAlert()
UIA.event_UIA_notification()
UIA.event_UIA_dragDropEffect()
UIA.event_UIA_dropTargetEffect()
UIA.TextInfo
UIA.UIAAutomationId
UIA.UIAChildren
UIA.UIAFrameworkId
UIA.UIAFullDescription
UIA.UIAGridPattern
UIA.UIAHelpText
UIA.UIAInvokePattern
UIA.UIALegacyIAccessiblePattern
UIA.UIARangeValue
UIA.UIARangeValuePattern
UIA.UIASelectionItemPattern
UIA.UIASelectionPattern
UIA.UIASelectionPattern2
UIA.UIATableItemPattern
UIA.UIATextEditPattern
UIA.UIATextPattern
UIA.UIATogglePattern
UIA.UIAValue
UIA.UIAValuePattern
UIA._abc_impl
UIA._coreCycleUIAPropertyCacheElementCache
UIA._shouldAllowUIALiveRegionChangeEvent
UIA.actionCount
UIA.childCount
UIA.children
UIA.columnCount
UIA.columnHeaderText
UIA.columnNumber
UIA.columnSpan
UIA.controllerFor
UIA.description
UIA.devInfo
UIA.firstChild
UIA.hasFocus
UIA.hasIrrelevantLocation
UIA.keyboardShortcut
UIA.lastChild
UIA.liveRegionPoliteness
UIA.location
UIA.parent
UIA.positionInfo
UIA.presentationType
UIA.previous
UIA.processID
UIA.role
UIA.rowCount
UIA.rowHeaderText
UIA.rowNumber
UIA.rowSpan
UIA.shouldAllowUIAFocusEvent
UIA.states
UIA.table
UIA.tableID
UIA.value
InaccurateTextChangeEventEmittingEditableText
XamlEditableText
TreeviewItem
MenuItem
UIColumnHeader
UIItem
SensitiveSlider
ControlPanelLink
ComboBoxWithoutValuePattern
ListItem
Dialog
Toast_win8
Toast_win10
ToolTip
WpfTextView
SearchField
SuggestionsList
SuggestionListItem
NetUIDropdownAnchor
PlaceholderNetUITWMenuItem
DevExpressXtraRichEdit
ProgressBar
- Submodules
- NVDAObjects.UIA.VisualStudio module
- NVDAObjects.UIA.anaheimEdge module
- NVDAObjects.UIA.chromium module
- NVDAObjects.UIA.excel module
ExcelCustomProperties
ExcelCustomAnnotationTypes
ExcelObject
ExcelCell
ExcelCell._coordinateRegEx
ExcelCell.shouldAllowDuplicateUIAFocusEvent
ExcelCell.name
ExcelCell.role
ExcelCell.areGridlinesVisible
ExcelCell._get_areGridlinesVisible()
ExcelCell.outlineColor
ExcelCell._get_outlineColor()
ExcelCell.outlineThickness
ExcelCell._get_outlineThickness()
ExcelCell.fillColor
ExcelCell._get_fillColor()
ExcelCell.fillType
ExcelCell._get_fillType()
ExcelCell.rotation
ExcelCell._get_rotation()
ExcelCell.cellSize
ExcelCell._get_cellSize()
ExcelCell.script_showCellAppearanceInfo()
ExcelCell._hasSelection()
ExcelCell._get_value()
ExcelCell._get_errorText()
ExcelCell._get_description()
ExcelCell._isContentTooLargeForCell
ExcelCell._get__isContentTooLargeForCell()
ExcelCell._nextCellHasContent
ExcelCell._get__nextCellHasContent()
ExcelCell._get_states()
ExcelCell._getColumnRepresentationForNumber()
ExcelCell._getNumberRepresentationForColumn()
ExcelCell._get_cellCoordsText()
ExcelCell.script_reportComment()
ExcelCell.__gestures
ExcelCell._abc_impl
ExcelCell.cellCoordsText
ExcelCell.description
ExcelCell.errorText
ExcelCell.states
ExcelCell.value
ExcelWorksheet
CellEdit
BadExcelFormulaEdit
ExcelTable
- NVDAObjects.UIA.spartanEdge module
- NVDAObjects.UIA.sysListView32 module
- NVDAObjects.UIA.web module
splitUIAElementAttribs()
UIAWebTextInfo
UIAWebTextInfo._get_UIAElementAtStartWithReplacedContent()
UIAWebTextInfo._moveToEdgeOfReplacedContent()
UIAWebTextInfo._collapsedMove()
UIAWebTextInfo.move()
UIAWebTextInfo._getControlFieldForUIAObject()
UIAWebTextInfo.getTextWithFields()
UIAWebTextInfo.UIAElementAtStartWithReplacedContent
UIAWebTextInfo._abc_impl
UIAWebTextInfo._rangeObj
UIAWebTextInfo._propertyCache
UIAWeb
UIAWeb._TextInfo
UIAWeb._isIframe()
UIAWeb._get_role()
UIAWeb._get_states()
UIAWeb._get_ariaProperties()
UIAWeb.RE_ARIA_CURRENT_PROP_VALUE
UIAWeb._get_isCurrent()
UIAWeb._get_roleText()
UIAWeb._get_placeholder()
UIAWeb._get_landmark()
UIAWeb._abc_impl
UIAWeb.ariaProperties
UIAWeb.isCurrent
UIAWeb.landmark
UIAWeb.placeholder
UIAWeb.role
UIAWeb.roleText
UIAWeb.states
UIAWeb._propertyCache
List
HeadingControlQuickNavItem
HeadingControlQuicknavIterator()
UIAWebTreeInterceptor
- NVDAObjects.UIA.winConsoleUIA module
ConsoleUIATextInfo
ConsoleUIATextInfoWorkaroundEndInclusive
ConsoleUIATextInfoWorkaroundEndInclusive._getBoundingRange()
ConsoleUIATextInfoWorkaroundEndInclusive.collapse()
ConsoleUIATextInfoWorkaroundEndInclusive.compareEndPoints()
ConsoleUIATextInfoWorkaroundEndInclusive.setEndPoint()
ConsoleUIATextInfoWorkaroundEndInclusive.expand()
ConsoleUIATextInfoWorkaroundEndInclusive._move()
ConsoleUIATextInfoWorkaroundEndInclusive._getCurrentOffsetInThisLine()
ConsoleUIATextInfoWorkaroundEndInclusive._getWordOffsetsInThisLine()
ConsoleUIATextInfoWorkaroundEndInclusive._isCollapsed()
ConsoleUIATextInfoWorkaroundEndInclusive._get_isCollapsed()
ConsoleUIATextInfoWorkaroundEndInclusive._get_text()
ConsoleUIATextInfoWorkaroundEndInclusive._abc_impl
ConsoleUIATextInfoWorkaroundEndInclusive.isCollapsed
ConsoleUIATextInfoWorkaroundEndInclusive.text
ConsoleUIATextInfoWorkaroundEndInclusive._rangeObj
ConsoleUIATextInfoWorkaroundEndInclusive._propertyCache
consoleUIAWindow
WinConsoleUIA
WinConsoleUIA.name
WinConsoleUIA._get_apiLevel()
WinConsoleUIA._get__caretMovementTimeoutMultiplier()
WinConsoleUIA._get_windowThreadID()
WinConsoleUIA._get_TextInfo()
WinConsoleUIA._get_devInfo()
WinConsoleUIA._get_diffAlgo()
WinConsoleUIA.detectPossibleSelectionChange()
WinConsoleUIA.event_UIA_notification()
WinConsoleUIA.TextInfo
WinConsoleUIA._abc_impl
WinConsoleUIA._caretMovementTimeoutMultiplier
WinConsoleUIA.apiLevel
WinConsoleUIA.devInfo
WinConsoleUIA.diffAlgo
WinConsoleUIA.windowThreadID
WinConsoleUIA._propertyCache
findExtraOverlayClasses()
_DiffBasedWinTerminalUIA
_NotificationsBasedWinTerminalUIA
- NVDAObjects.UIA.wordDocument module
UIACustomAttributeID
END_OF_ROW_MARK
ElementsListDialog
RevisionUIATextInfoQuickNavItem
getCommentInfoFromPosition()
getPresentableCommentInfoFromPosition()
CommentUIATextInfoQuickNavItem
WordDocumentTextInfo
WordDocumentTextInfo.getMathMl()
WordDocumentTextInfo._ensureRangeVisibility()
WordDocumentTextInfo.updateSelection()
WordDocumentTextInfo.updateCaret()
WordDocumentTextInfo._get_locationText()
WordDocumentTextInfo._getTextWithFields_text()
WordDocumentTextInfo._get_controlFieldNVDAObjectClass()
WordDocumentTextInfo._getControlFieldForUIAObject()
WordDocumentTextInfo._getTextFromUIARange()
WordDocumentTextInfo._getTextForCodepointMovement()
WordDocumentTextInfo._isEndOfRow()
WordDocumentTextInfo.move()
WordDocumentTextInfo.expand()
WordDocumentTextInfo.getTextWithFields()
WordDocumentTextInfo._getFormatFieldAtRange()
WordDocumentTextInfo._getIndentValueDisplayString()
WordDocumentTextInfo._abc_impl
WordDocumentTextInfo.controlFieldNVDAObjectClass
WordDocumentTextInfo.locationText
WordDocumentTextInfo._rangeObj
WordDocumentTextInfo._propertyCache
WordBrowseModeDocument
WordBrowseModeDocument._shouldSetFocusToObj()
WordBrowseModeDocument.shouldPassThrough()
WordBrowseModeDocument.script_tab()
WordBrowseModeDocument.script_shiftTab()
WordBrowseModeDocument._iterNodesByType()
WordBrowseModeDocument.ElementsListDialog
WordBrowseModeDocument._iterTextStyle()
WordBrowseModeDocument._abc_impl
WordDocumentNode
WordDocument
WordDocument.treeInterceptorClass
WordDocument.shouldCreateTreeInterceptor
WordDocument.announceEntireNewLine
WordDocument.name
WordDocument.event_textChange()
WordDocument.event_UIA_notification()
WordDocument._caretMoveBySentenceHelper()
WordDocument.script_reportCurrentComment()
WordDocument.script_setColumnHeader()
WordDocument.script_setRowHeader()
WordDocument.__gestures
WordDocument._abc_impl
- NVDAObjects.window package
isUsableWindow()
WindowProcessHandleContainer
Window
Window.getPossibleAPIClasses()
Window.findOverlayClasses()
Window.kwargsFromSuper()
Window._isEqual()
Window._get_name()
Window._get_role()
Window.windowClassName
Window._get_windowClassName()
Window._get_windowControlID()
Window._get_location()
Window._get_displayText()
Window.redraw()
Window._get_windowText()
Window._get_windowTextLineCount()
Window._get_processID()
Window._get_windowThreadID()
Window._get_next()
Window._get_previous()
Window._get_firstChild()
Window._get_lastChild()
Window._get_parent()
Window._get_isInForeground()
Window._get_states()
Window._get_windowStyle()
Window._get_extendedWindowStyle()
Window._get_isWindowUnicode()
Window.correctAPIForRelation()
Window._get_processHandle()
Window.normalizeWindowClassName()
Window.normalizedWindowClassNameCache
Window._get_devInfo()
Window._abc_impl
Window.devInfo
Window.displayText
Window.extendedWindowStyle
Window.firstChild
Window.isInForeground
Window.isWindowUnicode
Window.lastChild
Window.location
Window.name
Window.next
Window.parent
Window.previous
Window.processHandle
Window.processID
Window.role
Window.states
Window.windowControlID
Window.windowStyle
Window.windowText
Window.windowTextLineCount
Window.windowThreadID
Desktop
DisplayModelEditableText
DisplayModelLiveText
- Submodules
- NVDAObjects.window._msOfficeChart module
OfficeChartElementBase
OfficeChartElementBase.reportExtraInfo
OfficeChartElementBase.GetChartSegment()
OfficeChartElementBase._get_role()
OfficeChartElementBase._get_name()
OfficeChartElementBase.select()
OfficeChartElementBase.script_reportCurrentChartElementWithExtraInfo()
OfficeChartElementBase.script_reportCurrentChartElementColor()
OfficeChartElementBase.ELEMENT_IDS
OfficeChartElementBase._getChartElementText()
OfficeChartElementBase.__gestures
OfficeChartElementBase._abc_impl
OfficeChartElementBase.name
OfficeChartElementBase.role
OfficeChartElementBase._propertyCache
OfficeChartElementList
OfficeChart
OfficeChartElementCollection
OfficeChartElementSeries
OfficeChartElementSeries.description
OfficeChartElementSeries.role
OfficeChartElementSeries._get_name()
OfficeChartElementSeries.select()
OfficeChartElementSeries.script_reportColor()
OfficeChartElementSeries.__gestures
OfficeChartElementSeries._abc_impl
OfficeChartElementSeries.name
OfficeChartElementSeries._propertyCache
OfficeChartElementPoint
OfficeChartElementAxis
OfficeChartElementAxisTitle
OfficeChartElementTrendline
OfficeChartElementChartTitle
OfficeChartElementChartArea
OfficeChartElementPlotArea
OfficeChartElementLegend
OfficeChartElementLegendEntry
OfficeChartElementLegendKey
OfficeChartElementDataTable
- NVDAObjects.window.akelEdit module
- NVDAObjects.window.edit module
PointLStruct
CharRangeStruct
TextRangeStruct
CharFormat2WStruct
CharFormat2WStruct._fields_
CharFormat2WStruct.bAnimation
CharFormat2WStruct.bCharSet
CharFormat2WStruct.bPitchAndFamily
CharFormat2WStruct.bReserved1
CharFormat2WStruct.bRevAuthor
CharFormat2WStruct.bUnderlineType
CharFormat2WStruct.cbSize
CharFormat2WStruct.crBackColor
CharFormat2WStruct.crTextColor
CharFormat2WStruct.dwEffects
CharFormat2WStruct.dwMask
CharFormat2WStruct.dwReserved
CharFormat2WStruct.lcid
CharFormat2WStruct.sSpacing
CharFormat2WStruct.sStyle
CharFormat2WStruct.szFaceName
CharFormat2WStruct.wKerning
CharFormat2WStruct.wWeight
CharFormat2WStruct.yHeight
CharFormat2WStruct.yOffset
CharFormat2AStruct
CharFormat2AStruct._fields_
CharFormat2AStruct.bAnimation
CharFormat2AStruct.bCharSet
CharFormat2AStruct.bPitchAndFamily
CharFormat2AStruct.bReserved1
CharFormat2AStruct.bRevAuthor
CharFormat2AStruct.bUnderlineType
CharFormat2AStruct.cbSize
CharFormat2AStruct.crBackColor
CharFormat2AStruct.crTextColor
CharFormat2AStruct.dwEffects
CharFormat2AStruct.dwMask
CharFormat2AStruct.dwReserved
CharFormat2AStruct.lcid
CharFormat2AStruct.sSpacing
CharFormat2AStruct.sStyle
CharFormat2AStruct.szFaceName
CharFormat2AStruct.wKerning
CharFormat2AStruct.wWeight
CharFormat2AStruct.yHeight
CharFormat2AStruct.yOffset
getTextExStruct
getTextLengthExStruct
EditTextInfo
EditTextInfo._getPointFromOffset()
EditTextInfo._getOffsetFromPoint()
EditTextInfo._getCharFormat()
EditTextInfo._getFormatFieldAndOffsets()
EditTextInfo._setFormatFieldColor()
EditTextInfo._getSelectionOffsets()
EditTextInfo._setSelectionOffsets()
EditTextInfo._getCaretOffset()
EditTextInfo._setCaretOffset()
EditTextInfo._getStoryText()
EditTextInfo._getStoryLength()
EditTextInfo._getLineCount()
EditTextInfo._getTextRange()
EditTextInfo._getWordOffsets()
EditTextInfo._getLineNumFromOffset()
EditTextInfo._getLineOffsets()
EditTextInfo._getParagraphOffsets()
EditTextInfo._abc_impl
ITextDocumentTextInfo
ITextDocumentTextInfo._get_pointAtStart()
ITextDocumentTextInfo._getFormatFieldAtRange()
ITextDocumentTextInfo._setFormatFieldColor()
ITextDocumentTextInfo._expandFormatRange()
ITextDocumentTextInfo._getEmbeddedObjectLabel()
ITextDocumentTextInfo._getTextAtRange()
ITextDocumentTextInfo.getTextWithFields()
ITextDocumentTextInfo.expand()
ITextDocumentTextInfo.compareEndPoints()
ITextDocumentTextInfo.setEndPoint()
ITextDocumentTextInfo._get_isCollapsed()
ITextDocumentTextInfo.collapse()
ITextDocumentTextInfo.copy()
ITextDocumentTextInfo._get_text()
ITextDocumentTextInfo.move()
ITextDocumentTextInfo._get_bookmark()
ITextDocumentTextInfo.updateCaret()
ITextDocumentTextInfo.updateSelection()
ITextDocumentTextInfo._abc_impl
ITextDocumentTextInfo.bookmark
ITextDocumentTextInfo.isCollapsed
ITextDocumentTextInfo.pointAtStart
ITextDocumentTextInfo.text
EditBase
Edit
RichEdit
RichEdit20
RichEdit30
RichEdit50
UnidentifiedEdit
- NVDAObjects.window.excel module
XlHAlign
XlVAlign
ExcelQuickNavItem
ExcelChartQuickNavItem
ExcelRangeBasedQuickNavItem
ExcelCommentQuickNavItem
ExcelFormulaQuickNavItem
ExcelQuicknavIterator
ChartExcelCollectionQuicknavIterator
CommentExcelCollectionQuicknavIterator
FormulaExcelCollectionQuicknavIterator
ExcelSheetQuickNavItem
SheetsExcelCollectionQuicknavIterator
ExcelBrowseModeTreeInterceptor
ExcelBrowseModeTreeInterceptor.disableAutoPassThrough
ExcelBrowseModeTreeInterceptor._get_currentNVDAObject()
ExcelBrowseModeTreeInterceptor._get_isAlive()
ExcelBrowseModeTreeInterceptor.navigationHelper()
ExcelBrowseModeTreeInterceptor.script_moveLeft()
ExcelBrowseModeTreeInterceptor.script_moveRight()
ExcelBrowseModeTreeInterceptor.script_moveUp()
ExcelBrowseModeTreeInterceptor.script_moveDown()
ExcelBrowseModeTreeInterceptor.script_startOfColumn()
ExcelBrowseModeTreeInterceptor.script_startOfRow()
ExcelBrowseModeTreeInterceptor.script_endOfRow()
ExcelBrowseModeTreeInterceptor.script_endOfColumn()
ExcelBrowseModeTreeInterceptor._get_selection()
ExcelBrowseModeTreeInterceptor._set_selection()
ExcelBrowseModeTreeInterceptor._get_ElementsListDialog()
ExcelBrowseModeTreeInterceptor._iterNodesByType()
ExcelBrowseModeTreeInterceptor.script_elementsList()
ExcelBrowseModeTreeInterceptor.ElementsListDialog
ExcelBrowseModeTreeInterceptor.__gestures
ExcelBrowseModeTreeInterceptor._abc_impl
ExcelBrowseModeTreeInterceptor.currentNVDAObject
ExcelBrowseModeTreeInterceptor.isAlive
ExcelBrowseModeTreeInterceptor.selection
ElementsListDialog
EditCommentDialog
ExcelBase
Excel7Window
ExcelWorksheet
ExcelWorksheet.treeInterceptorClass
ExcelWorksheet.role
ExcelWorksheet._get_excelApplicationObject()
ExcelWorksheet.re_definedName
ExcelWorksheet.populateHeaderCellTrackerFromNames()
ExcelWorksheet._get_headerCellTracker()
ExcelWorksheet.setAsHeaderCell()
ExcelWorksheet._getMaxColumnNumberForHeaderCell()
ExcelWorksheet.forgetHeaderCell()
ExcelWorksheet.fetchAssociatedHeaderCellText()
ExcelWorksheet._get_name()
ExcelWorksheet._isEqual()
ExcelWorksheet._get_firstChild()
ExcelWorksheet._get_states()
ExcelWorksheet.script_changeSelection()
ExcelWorksheet._WaitForValueChangeForAction()
ExcelWorksheet._toggleBooleanAttribute()
ExcelWorksheet.script_toggleBold()
ExcelWorksheet.script_toggleItalic()
ExcelWorksheet.script_toggleUnderline()
ExcelWorksheet.script_toggleStrikethrough()
ExcelWorksheet.__gestures
ExcelWorksheet._abc_impl
ExcelWorksheet.excelApplicationObject
ExcelWorksheet.firstChild
ExcelWorksheet.headerCellTracker
ExcelWorksheet.name
ExcelWorksheet.states
ExcelWorksheet._propertyCache
ExcelCellTextInfo
NvCellState
ExcelCellInfo
ExcelCellInfo._fields_
ExcelCellInfo.address
ExcelCellInfo.columnNumber
ExcelCellInfo.columnSpan
ExcelCellInfo.comments
ExcelCellInfo.formula
ExcelCellInfo.inputMessage
ExcelCellInfo.inputTitle
ExcelCellInfo.nvCellStates
ExcelCellInfo.outlineLevel
ExcelCellInfo.rowNumber
ExcelCellInfo.rowSpan
ExcelCellInfo.text
ExcelCellInfoQuickNavItem
CommentExcelCellInfoQuickNavItem
FormulaExcelCellInfoQuickNavItem
ExcelCellInfoQuicknavIterator
CommentExcelCellInfoQuicknavIterator
FormulaExcelCellInfoQuicknavIterator
ExcelCell
ExcelCell.excelCellInfo
ExcelCell._get_excelCellInfo()
ExcelCell.doAction()
ExcelCell._get_columnHeaderText()
ExcelCell._get_rowHeaderText()
ExcelCell.script_openDropdown()
ExcelCell.script_setColumnHeader()
ExcelCell.script_setRowHeader()
ExcelCell.kwargsFromSuper()
ExcelCell._get_excelRangeObject()
ExcelCell._get_role()
ExcelCell.TextInfo
ExcelCell._isEqual()
ExcelCell._get_cellCoordsText()
ExcelCell._get_rowNumber()
ExcelCell._get_rowSpan()
ExcelCell._get_columnNumber()
ExcelCell._get_colSpan()
ExcelCell.getCellPosition()
ExcelCell._get_tableID()
ExcelCell._get_name()
ExcelCell._get_states()
ExcelCell.event_typedCharacter()
ExcelCell._get_parent()
ExcelCell._get_next()
ExcelCell._get_previous()
ExcelCell._get_description()
ExcelCell._get_positionInfo()
ExcelCell.script_reportComment()
ExcelCell.script_editComment()
ExcelCell.reportFocus()
ExcelCell.__gestures
ExcelCell._abc_impl
ExcelCell.cellCoordsText
ExcelCell.colSpan
ExcelCell.columnHeaderText
ExcelCell.columnNumber
ExcelCell.description
ExcelCell.excelRangeObject
ExcelCell.name
ExcelCell.next
ExcelCell.parent
ExcelCell.positionInfo
ExcelCell.previous
ExcelCell.role
ExcelCell.rowHeaderText
ExcelCell.rowNumber
ExcelCell.rowSpan
ExcelCell.states
ExcelCell.tableID
ExcelSelection
ExcelSelection.role
ExcelSelection._get_states()
ExcelSelection._get_name()
ExcelSelection._get_parent()
ExcelSelection._get_rowNumber()
ExcelSelection._get_rowSpan()
ExcelSelection._get_columnNumber()
ExcelSelection._get_colSpan()
ExcelSelection.makeTextInfo()
ExcelSelection._abc_impl
ExcelSelection.colSpan
ExcelSelection.columnNumber
ExcelSelection.name
ExcelSelection.parent
ExcelSelection.rowNumber
ExcelSelection.rowSpan
ExcelSelection.states
ExcelSelection._propertyCache
ExcelDropdownItem
ExcelDropdownItem.firstChild
ExcelDropdownItem.lastChild
ExcelDropdownItem.children
ExcelDropdownItem.role
ExcelDropdownItem._get_previous()
ExcelDropdownItem._get_next()
ExcelDropdownItem._get_treeInterceptor()
ExcelDropdownItem._get_positionInfo()
ExcelDropdownItem._abc_impl
ExcelDropdownItem.next
ExcelDropdownItem.positionInfo
ExcelDropdownItem.previous
ExcelDropdownItem.treeInterceptor
ExcelDropdownItem._propertyCache
ExcelDropdown
ExcelDropdown.kwargsFromSuper()
ExcelDropdown.role
ExcelDropdown.excelCell
ExcelDropdown._get__highlightColors()
ExcelDropdown._get_children()
ExcelDropdown.getChildAtIndex()
ExcelDropdown._get_childCount()
ExcelDropdown._get_firstChild()
ExcelDropdown._get_selection()
ExcelDropdown.script_selectionChange()
ExcelDropdown.script_closeDropdown()
ExcelDropdown.event_gainFocus()
ExcelDropdown.__gestures
ExcelDropdown._abc_impl
ExcelDropdown._highlightColors
ExcelDropdown.childCount
ExcelDropdown.children
ExcelDropdown.firstChild
ExcelDropdown.selection
ExcelDropdown._propertyCache
ExcelMergedCell
ExcelFormControl
ExcelFormControl.isFocusable
ExcelFormControl._roleMap
ExcelFormControl._get_excelControlFormatObject()
ExcelFormControl._get_excelOLEFormatObject()
ExcelFormControl._get_role()
ExcelFormControl._get_states()
ExcelFormControl._get_name()
ExcelFormControl._get_index()
ExcelFormControl._get_topLeftCell()
ExcelFormControl._get_bottomRightCell()
ExcelFormControl._getFormControlScreenCoordinates()
ExcelFormControl.script_doAction()
ExcelFormControl.doAction()
ExcelFormControl.__gestures
ExcelFormControl._abc_impl
ExcelFormControl.bottomRightCell
ExcelFormControl.excelControlFormatObject
ExcelFormControl.excelOLEFormatObject
ExcelFormControl.index
ExcelFormControl.name
ExcelFormControl.role
ExcelFormControl.states
ExcelFormControl.topLeftCell
ExcelFormControl._propertyCache
ExcelFormControlQuickNavItem
ExcelFormControlQuicknavIterator
ExcelFormControlListBox
ExcelFormControlListBox.getChildAtIndex()
ExcelFormControlListBox._get_childCount()
ExcelFormControlListBox._get_firstChild()
ExcelFormControlListBox._get_lastChild()
ExcelFormControlListBox.script_moveUp()
ExcelFormControlListBox.script_moveDown()
ExcelFormControlListBox.doAction()
ExcelFormControlListBox.__gestures
ExcelFormControlListBox._abc_impl
ExcelFormControlListBox.childCount
ExcelFormControlListBox.firstChild
ExcelFormControlListBox.lastChild
ExcelFormControlListBox._propertyCache
ExcelFormControlDropDown
ExcelFormControlScrollBar
ExcelFormControlScrollBar._get_value()
ExcelFormControlScrollBar.moveValue()
ExcelFormControlScrollBar.script_moveUpSmall()
ExcelFormControlScrollBar.script_moveDownSmall()
ExcelFormControlScrollBar.script_moveUpLarge()
ExcelFormControlScrollBar.__gestures
ExcelFormControlScrollBar._abc_impl
ExcelFormControlScrollBar.script_moveDownLarge()
ExcelFormControlScrollBar.value
ExcelFormControlScrollBar._propertyCache
- NVDAObjects.window.excelCellBorder module
- NVDAObjects.window.scintilla module
INVALID_POSITION
CharacterRangeStruct
ScintillaTextInfo
ScintillaTextInfo.TextRangeStruct
ScintillaTextInfo._get_encoding()
ScintillaTextInfo._getOffsetFromPoint()
ScintillaTextInfo._getPointFromOffset()
ScintillaTextInfo._getFormatFieldAndOffsets()
ScintillaTextInfo._getCaretOffset()
ScintillaTextInfo._setCaretOffset()
ScintillaTextInfo._getSelectionOffsets()
ScintillaTextInfo._setSelectionOffsets()
ScintillaTextInfo._getStoryText()
ScintillaTextInfo._getStoryLength()
ScintillaTextInfo._getLineCount()
ScintillaTextInfo._getTextRange()
ScintillaTextInfo._getWordOffsets()
ScintillaTextInfo._getLineNumFromOffset()
ScintillaTextInfo._getLineOffsets()
ScintillaTextInfo._getParagraphOffsets()
ScintillaTextInfo._getCharacterOffsets()
ScintillaTextInfo._abc_impl
ScintillaTextInfo.encoding
Scintilla
- NVDAObjects.window.winConsole module
WinConsole
WinConsole.STABILIZE_DELAY
WinConsole._get_windowThreadID()
WinConsole._get_TextInfo()
WinConsole._get_diffAlgo()
WinConsole.event_becomeNavigatorObject()
WinConsole.event_gainFocus()
WinConsole.event_loseFocus()
WinConsole.event_nameChange()
WinConsole._getText()
WinConsole.script_caret_backspaceCharacter()
WinConsole.script_close()
WinConsole.script_flush_queuedChars()
WinConsole.__gestures
WinConsole.TextInfo
WinConsole._abc_impl
WinConsole.diffAlgo
WinConsole.windowThreadID
WinConsole._propertyCache
- NVDAObjects.window.winword module
WinWordColorIndex
WinWordColorIndex.wdBlack
WinWordColorIndex.wdBlue
WinWordColorIndex.wdBrightGreen
WinWordColorIndex.wdDarkBlue
WinWordColorIndex.wdDarkRed
WinWordColorIndex.wdDarkYellow
WinWordColorIndex.wdGray25
WinWordColorIndex.wdGray50
WinWordColorIndex.wdGreen
WinWordColorIndex.wdPink
WinWordColorIndex.wdRed
WinWordColorIndex.wdTeal
WinWordColorIndex.wdTurquoise
WinWordColorIndex.wdViolet
WinWordColorIndex.wdWhite
WinWordColorIndex.wdYellow
WinWordColor
WinWordColor.wdBlack
WinWordColor.wdBlue
WinWordColor.wdBrightGreen
WinWordColor.wdDarkBlue
WinWordColor.wdDarkRed
WinWordColor.wdDarkYellow
WinWordColor.wdGray25
WinWordColor.wdGray50
WinWordColor.wdGreen
WinWordColor.wdPink
WinWordColor.wdRed
WinWordColor.wdTeal
WinWordColor.wdTurquoise
WinWordColor.wdViolet
WinWordColor.wdWhite
WinWordColor.wdYellow
WordDocumentHeadingQuickNavItem
WordDocumentCollectionQuickNavItem
WordDocumentCommentQuickNavItem
WordDocumentFieldQuickNavItem
WordDocumentRevisionQuickNavItem
WordDocumentChartQuickNavItem
WordDocumentSpellingErrorQuickNavItem
WinWordCollectionQuicknavIterator
LinkWinWordCollectionQuicknavIterator
CommentWinWordCollectionQuicknavIterator
RevisionWinWordCollectionQuicknavIterator
SpellingErrorWinWordCollectionQuicknavIterator
GraphicWinWordCollectionQuicknavIterator
TableWinWordCollectionQuicknavIterator
ChartWinWordCollectionQuicknavIterator
LazyControlField_RowAndColumnHeaderText
WordDocumentTextInfo
WordDocumentTextInfo._get_unit_mouseChunk()
WordDocumentTextInfo._get_locationText()
WordDocumentTextInfo.copyToClipboard()
WordDocumentTextInfo.find()
WordDocumentTextInfo.shouldIncludeLayoutTables
WordDocumentTextInfo.activate()
WordDocumentTextInfo._expandToLineAtCaret()
WordDocumentTextInfo.getTextWithFields()
WordDocumentTextInfo._normalizeControlField()
WordDocumentTextInfo._normalizeFormatField()
WordDocumentTextInfo.expand()
WordDocumentTextInfo.compareEndPoints()
WordDocumentTextInfo.setEndPoint()
WordDocumentTextInfo._get_isCollapsed()
WordDocumentTextInfo.collapse()
WordDocumentTextInfo.copy()
WordDocumentTextInfo._get_text()
WordDocumentTextInfo._move()
WordDocumentTextInfo.move()
WordDocumentTextInfo._get_bookmark()
WordDocumentTextInfo._get_pointAtStart()
WordDocumentTextInfo.updateCaret()
WordDocumentTextInfo.updateSelection()
WordDocumentTextInfo.getMathMl()
WordDocumentTextInfo._abc_impl
WordDocumentTextInfo.bookmark
WordDocumentTextInfo.isCollapsed
WordDocumentTextInfo.locationText
WordDocumentTextInfo.pointAtStart
WordDocumentTextInfo.text
WordDocumentTextInfo.unit_mouseChunk
BrowseModeWordDocumentTextInfo
WordDocumentTreeInterceptor
WordDocumentTreeInterceptor.TextInfo
WordDocumentTreeInterceptor._nativeAppSelectionMode
WordDocumentTreeInterceptor._activateLongDesc()
WordDocumentTreeInterceptor._get_isAlive()
WordDocumentTreeInterceptor._get_ElementsListDialog()
WordDocumentTreeInterceptor._iterHeadings()
WordDocumentTreeInterceptor._iterNodesByType()
WordDocumentTreeInterceptor._activatePosition()
WordDocumentTreeInterceptor.script_nextRow()
WordDocumentTreeInterceptor.script_previousRow()
WordDocumentTreeInterceptor.script_nextColumn()
WordDocumentTreeInterceptor.script_previousColumn()
WordDocumentTreeInterceptor._iterTextStyle()
WordDocumentTreeInterceptor.__gestures
WordDocumentTreeInterceptor.ElementsListDialog
WordDocumentTreeInterceptor._abc_impl
WordDocumentTreeInterceptor.isAlive
WordDocument
WordDocument.winwordColorToNVDAColor()
WordDocument._get_WinwordVersion()
WordDocument._get_documentWindowHandle()
WordDocument._get_WinwordWindowObject()
WordDocument._get_WinwordDocumentObject()
WordDocument._get_WinwordApplicationObject()
WordDocument._get_WinwordSelectionObject()
WordDocument._WaitForValueChangeForAction()
WordDocument.script_toggleBold()
WordDocument.script_toggleItalic()
WordDocument.script_toggleUnderline()
WordDocument.script_toggleAlignment()
WordDocument.script_changeParagraphLeftIndent()
WordDocument.script_toggleSuperscriptSubscript()
WordDocument.script_moveParagraphDown()
WordDocument.script_moveParagraphUp()
WordDocument.script_increaseDecreaseOutlineLevel()
WordDocument.script_increaseDecreaseFontSize()
WordDocument.script_toggleDisplayNonprintingCharacters()
WordDocument.script_tab()
WordDocument.reportTab()
WordDocument.getLocalizedMeasurementTextForPointSize()
WordDocument.script_changeLineSpacing()
WordDocument.script_changeParagraphSpacing()
WordDocument.WinwordApplicationObject
WordDocument.WinwordDocumentObject
WordDocument.WinwordSelectionObject
WordDocument.WinwordVersion
WordDocument.WinwordWindowObject
WordDocument._abc_impl
WordDocument.documentWindowHandle
WordDocument.initOverlayClass()
WordDocument._propertyCache
WordDocument.__gestures
WordDocument_WwN
ElementsListDialog
Submodules
NVDAObjects.behaviors module
Mix-in classes which provide common behaviour for particular types of controls across different APIs. Behaviors described in this mix-in include providing table navigation commands for certain table rows, terminal input and output support, announcing notifications and suggestion items and so on.
- class NVDAObjects.behaviors.ProgressBar(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
- progressValueCache = {}
- event_valueChange()
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.Dialog(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
Overrides the description property to obtain dialog text.
- classmethod getDialogText(obj, allowFocusedDescendants=True)
This classmethod walks through the children of the given object, and collects up and returns any text that seems to be part of a dialog’s message text. @param obj: the object who’s children you want to collect the text from @type obj: L{IAccessible} @param allowFocusedDescendants: if false no text will be returned at all if one of the descendants is focused. @type allowFocusedDescendants: boolean
- _get_description()
The description or help text of this object.
- value: str = None
Typing information for auto property _get_value
- _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
- class NVDAObjects.behaviors.InputFieldWithSuggestions(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
Allows NVDA to announce appearance/disappearance of suggestions as content is entered. This is used in various places, including Windows 10 search edit fields and others. Subclasses should provide L{event_suggestionsOpened} and can optionally override L{event_suggestionsClosed}. These events are fired when suggestions appear and disappear, respectively.
- event_suggestionsOpened()
Called when suggestions appear when text is entered e.g. search suggestions. Subclasses should provide custom implementations if possible. By default NVDA will announce appearance of suggestions using speech, braille or a sound will be played.
- event_suggestionsClosed()
Called when suggestions list or container is closed. Subclasses should provide custom implementations if possible. By default NVDA will announce this via speech, braille or via a sound.
- event_controllerForChange()
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.EditableTextBase(chooseBestAPI=True, **kwargs)
Bases:
EditableText
,NVDAObject
Provides scripts to report appropriately when moving the caret in editable text fields. This does not handle selection changes. To handle selection changes, use either L{EditableTextWithAutoSelectDetection} or L{EditableTextWithoutAutoSelectDetection}.
- shouldFireCaretMovementFailedEvents = True
Whether to fire caretMovementFailed events when the caret doesn’t move in response to a caret movement key.
- initOverlayClass()
- _caretScriptPostMovedHelper(speakUnit, gesture, info=None)
- _reportErrorInPreviousWord()
- event_typedCharacter(ch: str)
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.EditableTextWithSuggestions(chooseBestAPI=True, **kwargs)
Bases:
InputFieldWithSuggestions
,EditableTextBase
Represents an editable text field that shows suggestions as you type. This is an empty class as functionality has been moved to the base InputFieldWithSuggestions class.
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.EditableText(chooseBestAPI=True, **kwargs)
Bases:
EditableTextWithSuggestions
,EditableTextBase
Represents an editable text field. This is an empty class as functionality has been moved to the base EditableTextBase class. This class also supports reporting of the appearance and disappearance of suggestions by inheriting from the EditableTextWithSuggestions class.
- __gestures = {'kb:alt+downArrow': 'caret_nextSentence', 'kb:alt+upArrow': 'caret_previousSentence', 'kb:backspace': 'caret_backspaceCharacter', 'kb:control+backspace': 'caret_backspaceWord', 'kb:control+delete': 'caret_deleteWord', 'kb:control+downArrow': 'caret_nextParagraph', 'kb:control+end': 'caret_moveByLine', 'kb:control+home': 'caret_moveByLine', 'kb:control+leftArrow': 'caret_moveByWord', 'kb:control+numpadDelete': 'caret_deleteWord', 'kb:control+rightArrow': 'caret_moveByWord', 'kb:control+upArrow': 'caret_previousParagraph', 'kb:delete': 'caret_deleteCharacter', 'kb:downArrow': 'caret_moveByLine', 'kb:end': 'caret_moveByCharacter', 'kb:home': 'caret_moveByCharacter', 'kb:leftArrow': 'caret_moveByCharacter', 'kb:numpadDelete': 'caret_deleteCharacter', 'kb:pageDown': 'caret_moveByLine', 'kb:pageUp': 'caret_moveByLine', 'kb:rightArrow': 'caret_moveByCharacter', 'kb:shift+backspace': 'caret_backspaceCharacter', 'kb:shift+delete': 'caret_deleteCharacter', 'kb:shift+numpadDelete': 'caret_deleteCharacter', 'kb:upArrow': 'caret_moveByLine'}
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.EditableTextWithAutoSelectDetection(chooseBestAPI=True, **kwargs)
Bases:
EditableText
In addition to L{EditableText}, handles reporting of selection changes for objects which notify of them. To have selection changes reported, the object must notify of selection changes via the caret event. Optionally, it may notify of changes to content via the textChange, textInsert and textRemove events. If the object supports selection but does not notify of selection changes, L{EditableTextWithoutAutoSelectDetection} should be used instead.
- event_gainFocus()
This code is executed if a gain focus event is received by this object.
- event_loseFocus()
- event_caret()
- event_textChange()
- event_textInsert()
- event_textRemove()
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.EditableTextWithoutAutoSelectDetection(chooseBestAPI=True, **kwargs)
Bases:
EditableTextWithoutAutoSelectDetection
,EditableText
In addition to L{EditableText}, provides scripts to report appropriately when the selection changes. This should be used when an object does not notify of selection changes.
- initOverlayClass()
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.LiveText(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
An object for which new text should be reported automatically. These objects present text as a single chunk and only fire an event indicating that some part of the text has changed; i.e. they don’t provide the new text. Monitoring must be explicitly started and stopped using the L{startMonitoring} and L{stopMonitoring} methods. The object should notify of text changes using the textChange event.
- STABILIZE_DELAY = 0
The time to wait before fetching text after a change event.
- presentationType = 'content'
- announceNewLineText = False
- initOverlayClass()
- startMonitoring()
Start monitoring for new text. New text will be reported when it is detected. @note: If monitoring has already been started, this will have no effect. @see: L{stopMonitoring}
- stopMonitoring()
Stop monitoring previously started with L{startMonitoring}. @note: If monitoring has not been started, this will have no effect. @see: L{startMonitoring}
- event_textChange()
Fired when the text changes. @note: It is safe to call this directly from threads other than the main thread.
- _get_diffAlgo() prefer_difflib | prefer_dmp
This property controls which diffing algorithm should be used by this object. If the object contains a strictly contiguous span of text (i.e. textInfos.POSITION_ALL refers to the entire contents of the object and not just one visible screen of text), then diffHandler.prefer_dmp (character-based diffing) is suitable. Otherwise, use diffHandler.prefer_difflib.
@Note: Return either diffHandler.prefer_dmp() or diffHandler.prefer_difflib() so that the diffAlgo user preference can override this choice.
- _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.
- _getText() str
Retrieve the text of this object. This will be used to determine the new text to speak. The base implementation uses the L{TextInfo}. However, subclasses should override this if there is a better way to retrieve the text.
- _reportNewLines(lines)
Reports new lines of text using _reportNewText for each new line. Subclasses may override this method to provide custom filtering of new text, where logic depends on multiple lines.
- _reportNewText(line)
Report a line of new text.
- _monitor()
- _calculateNewText(newText: str, oldText: str) List[str]
- _abc_impl = <_abc._abc_data object>
- devInfo: List[str]
Information about this object useful to developers.
- diffAlgo
- class NVDAObjects.behaviors.Terminal(chooseBestAPI=True, **kwargs)
Bases:
LiveText
,EditableText
An object which both accepts text input and outputs text which should be reported automatically. This is an L{EditableText} object, as well as a L{liveText} object for which monitoring is automatically enabled and disabled based on whether it has focus.
- event_gainFocus()
This code is executed if a gain focus event is received by this object.
- event_loseFocus()
- _get_caretMovementDetectionUsesEvents()
Using caret events in consoles sometimes causes the last character of the prompt to be read when quickly deleting text.
- event_textChange() None
Fired when the text changes. @note: Updates also braille.
- _abc_impl = <_abc._abc_data object>
- caretMovementDetectionUsesEvents
- class NVDAObjects.behaviors.EnhancedTermTypedCharSupport(chooseBestAPI=True, **kwargs)
Bases:
Terminal
A Terminal object with keyboard support enhancements for console applications. Notably, it suppresses duplicate typed character announcements and can hold typed characters in a queue and only dispatch once the screen updates. This is useful for suppression of passwords, etc.
- _supportsTextChange = True
Whether this object quickly and reliably sends textChange events when its contents update. Timely and reliable textChange events are required to support password suppression.
- _queuedChars = []
A queue of typed characters, to be dispatched on C{textChange}. This queue allows NVDA to suppress typed passwords when needed.
- _hasTab = False
Whether the last typed character is a tab. If so, we should temporarily disable filtering as completions may be short.
- _reportNewLines(lines)
Reports new lines of text using _reportNewText for each new line. Subclasses may override this method to provide custom filtering of new text, where logic depends on multiple lines.
- event_typedCharacter(ch)
- event_textChange()
Fired when the text changes. @note: Updates also braille.
- script_flush_queuedChars(gesture)
- _dispatchQueue()
Sends queued typedCharacter events through to NVDA.
- __gestures = {'kb:control+c': 'flush_queuedChars', 'kb:control+d': 'flush_queuedChars', 'kb:control+pause': 'flush_queuedChars', 'kb:enter': 'flush_queuedChars', 'kb:numpadEnter': 'flush_queuedChars', 'kb:tab': 'flush_queuedChars'}
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.KeyboardHandlerBasedTypedCharSupport(chooseBestAPI=True, **kwargs)
Bases:
EnhancedTermTypedCharSupport
An EnhancedTermTypedCharSupport object that provides typed character support for console applications via keyboardHandler events. These events are queued from NVDA’s global keyboard hook. Therefore, an event is fired for every single character that is being typed, even when a character is not written to the console (e.g. in read only console applications). This approach is an alternative to monitoring the console output for characters close to the caret, or injecting in-process with NVDAHelper. This class does not implement any specific functionality by itself. Rather, it instructs keyboardHandler to use the toUnicodeEx Windows function, in particular the flag to preserve keyboard state available in Windows 10 1607 and later.
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.CandidateItem(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
- getFormattedCandidateName(number, candidate)
- getFormattedCandidateDescription(candidate)
- reportFocus()
Announces this object in a way suitable such that it gained focus.
- _get_visibleCandidateItemsText()
- _abc_impl = <_abc._abc_data object>
- visibleCandidateItemsText
Bases:
NVDAObject
Provides table navigation commands for a row which doesn’t support them natively. The cells must be exposed as children and they must support the table cell properties.
Moves the navigator object to the next column
Moves the navigator object to the previous column
Announces this object in a way suitable such that it gained focus.
Moves the navigator object and focus to the next row
Moves the navigator object and focus to the previous row
Moves the navigator object to the first column
Moves the navigator object to the last column
Moves the navigator object and focus to the first row
Moves the navigator object and focus to the last row
- class NVDAObjects.behaviors.RowWithoutCellObjects(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
An abstract class which creates cell objects for table rows which don’t natively expose them. Subclasses must override L{_getColumnContent} and can optionally override L{_getColumnHeader} to retrieve information about individual columns and L{_getColumnLocation} to support mouse or magnification tracking or highlighting. The parent (table) must support the L{columnCount} property.
- _get_childCount()
Retrieves the number of children this object contains. @rtype: int
- _getColumnLocation(column)
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
- _getColumnContent(column)
Get the text content for a given column of this row. Subclasses must override this method. @param column: The index of the column, starting at 1. @type column: int @rtype: str
- _getColumnHeader(column)
Get the header text for this column. @param column: The index of the column, starting at 1. @type column: int @rtype: str
- _makeCell(column)
- _get_firstChild()
Retrieves the first object that this object contains. @return: the first 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.
- _abc_impl = <_abc._abc_data object>
- childCount
- children: List[NVDAObject]
Type definition for auto prop ‘_get_children’
- firstChild: NVDAObject | None
Type definition for auto prop ‘_get_firstChild’
- class NVDAObjects.behaviors._FakeTableCell(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
- _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.
- firstChild: NVDAObject | None = None
Type definition for auto prop ‘_get_firstChild’
- _get_location()
The location of this object on the screen. @return: left, top, width and height of the object. @rtype: tuple of int
- _get_name()
The name or label of this object (example: the text of a button).
- _get_columnHeaderText()
The text of the column headers for this cell. @rtype: str
- _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_states()
Retrieves the current states of this object (example: selected, focused). @return: a set of State constants from L{controlTypes}.
- _isEqual(other: _FakeTableCell) bool
Calculates if this object is equal to another object. Used by L{NVDAObject.__eq__}. @param other: the other object to compare with. @type other: L{NVDAObject} @return: True if equal, false otherwise. @rtype: boolean
- _abc_impl = <_abc._abc_data object>
- columnHeaderText
- location
- name: str
Type definition for auto prop ‘_get_name’
- 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.
- tableID
- class NVDAObjects.behaviors.FocusableUnfocusableContainer(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
Makes an unfocusable container focusable using its first focusable descendant. One instance where this is useful is ARIA applications on the web where the author hasn’t set a tabIndex.
- isFocusable: bool = True
Type definition for auto prop ‘_get_isFocusable’
- setFocus()
Tries to force this object to take the focus.
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.ToolTip(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
Provides information about an item over which the user is hovering a cursor. The object should fire a show event when it appears.
- event_show()
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.Notification(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
Informs the user of non-critical information that does not require immediate action. This is primarily for notifications displayed in the system notification area, and for Windows 8 and later, toasts. The object should fire a alert or show event when the user should be notified.
- event_alert()
- event_show()
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.behaviors.WebDialog(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
A dialog that will use a treeInterceptor if its parent currently does. This can be used to ensure that dialogs on the web get browseMode by default, unless inside an ARIA application
- _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
NVDAObjects.inputComposition module
- NVDAObjects.inputComposition.calculateInsertedChars(oldComp, newComp)
- class NVDAObjects.inputComposition.InputCompositionTextInfo(*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.
- _getSelectionOffsets()
- _getCaretOffset()
- _getStoryText()
Retrieve the entire text of the object. @return: The entire text of the object. @rtype: str
- _getStoryLength()
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.inputComposition.InputComposition(chooseBestAPI=True, **kwargs)
Bases:
EditableTextWithAutoSelectDetection
,Window
- TextInfo
alias of
InputCompositionTextInfo
- name: str = 'Composition'
Type definition for auto prop ‘_get_name’
- next: NVDAObject | None = None
The object directly after this object with the same parent.
- previous: NVDAObject | None = None
The object directly before this object with the same parent.
- firstChild: NVDAObject | None = None
Type definition for auto prop ‘_get_firstChild’
- lastChild: NVDAObject | None = None
Type definition for auto prop ‘_get_lastChild’
- location = None
- compositionString = ''
- readingString = ''
- compositionSelectionOffsets = (0, 0)
- readingSelectionOffsets = (0, 0)
- isReading = False
- 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.
- reportNewText(oldString, newString)
- compositionUpdate(compositionString, selectionStart, selectionEnd, isReading, announce=True)
- reportFocus()
Announces this object in a way suitable such that it gained focus.
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.inputComposition.CandidateList(chooseBestAPI=True, **kwargs)
Bases:
Window
- name: str = 'Candidate'
Type definition for auto prop ‘_get_name’
- role: controlTypes.Role = 14
Type definition for auto prop ‘_get_role’
- next: Optional['NVDAObject'] = None
The object directly after this object with the same parent.
- previous: Optional['NVDAObject'] = None
The object directly before this object with the same parent.
- firstChild: Optional['NVDAObject'] = None
Type definition for auto prop ‘_get_firstChild’
- lastChild: Optional['NVDAObject'] = None
Type definition for auto prop ‘_get_lastChild’
- states: Set[controlTypes.State] = {}
- 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.
- _abc_impl = <_abc._abc_data object>
- class NVDAObjects.inputComposition.CandidateItem(chooseBestAPI=True, **kwargs)
Bases:
CandidateItem
,Window
- firstChild: NVDAObject | None = None
Type definition for auto prop ‘_get_firstChild’
- lastChild: NVDAObject | None = None
Type definition for auto prop ‘_get_lastChild’
- 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_candidateNumber()
- _get_name()
The name or label of this object (example: the text of a button).
- _get_basicText()
- _get_description()
The description or help text of this object.
- _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>
- basicText
- candidateNumber
- description: str
Typing information for auto property _get_description
- name: str
Type definition for auto prop ‘_get_name’
- 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.
NVDAObjects.lockscreen module
- class NVDAObjects.lockscreen.LockScreenObject(chooseBestAPI=True, **kwargs)
Bases:
NVDAObject
Prevent users from object navigating outside of the lock screen. While usages of
api.objectBelowLockScreenAndWindowsIsLocked
prevent the user from moving to the object, this overlay class prevents reading neighbouring objects.- _get_next() NVDAObject | None
Retrieves the object directly after this object with the same parent. @return: the next object if it exists else None.
- _get_previous() NVDAObject | None
Retrieves the object directly before this object with the same parent. @return: the previous object if it exists else None.
- _get_parent() NVDAObject | None
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>
- next: NVDAObject | None
The object directly after this object with the same parent.
- parent: NVDAObject | None
This object’s parent (the object that contains this object).
- previous: NVDAObject | None
The object directly before this object with the same parent.