review module

review.getObjectPosition(obj)

Fetches a TextInfo instance suitable for reviewing the text in the given object. @param obj: the NVDAObject to review @type obj: L{NVDAObject} @return: the TextInfo instance and the Scriptable object the TextInfo instance is referencing, or None on error. @rtype: (L{TextInfo},L{ScriptableObject})

review.getDocumentPosition(obj)

Fetches a TextInfo instance suitable for reviewing the text in the given object’s L{TreeInterceptor}, positioned at the object. @param obj: the NVDAObject to review @type obj: L{NVDAObject} @return: the TextInfo instance and the Scriptable object the TextInfo instance is referencing, or None on error. @rtype: (L{TextInfo},L{ScriptableObject})

review.getScreenPosition(obj)

Fetches a TextInfo instance suitable for reviewing the screen, positioned at the given object’s coordinates. @param obj: the NVDAObject to review @type obj: L{NVDAObject} @return: the TextInfo instance and the Scriptable object the TextInfo instance is referencing, or None on error. @rtype: (L{TextInfo},L{ScriptableObject})

review.getPositionForCurrentMode(obj: NVDAObject) TextInfo | ScriptableObject

Fetches a TextInfo instance suitable for reviewing the text in or around the given object, according to the current review mode. @param obj: the NVDAObject to review @return: the TextInfo instance and the Scriptable object the TextInfo instance is referencing, or None on error.

review.getCurrentMode()

Fetches the ID of the current mode

review.setCurrentMode(mode: int | str, updateReviewPosition: bool = True) str | None

Sets the current review mode to the given mode ID or index and updates the review position. @param mode: either a 0-based index into the modes list, or one of the mode IDs (first item of a tuple in the modes list). @return: a presentable label for the new current mode (suitable for speaking or braille)

review.nextMode(prev=False, startMode=None)

Sets the current review mode to the next available mode and updates the review position. @param prev: if true then switch to the previous mode. If false, switch to the next mode. @type prev: bool @return: a presentable label for the new current mode (suitable for speaking or brailleing) @rtype: string

review.handleCaretMove(pos)

Instructs the review position to be updated due to caret movement. @param pos: Either a TextInfo instance at the caret position, or an NVDAObject or TeeInterceptor who’s caret position should be retreaved. @type pos: L{textInfos.TextInfo} or L{NVDAObject} or L{TreeInterceptor}