Package NVDAObjects :: Module behaviors :: Class LiveText

[frames] | no frames]

Class LiveText

                   object --+            
                            |            
baseObject.AutoPropertyObject --+        
                                |        
      baseObject.ScriptableObject --+    
                                    |    
                           NVDAObject --+
                                        |
                                       LiveText

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 startMonitoring and stopMonitoring methods. The object should notify of text changes using the textChange event.

Nested Classes

Inherited from NVDAObject: TextInfo, __metaclass__

Instance Methods

initOverlayClass(self)

source code

startMonitoring(self)
Start monitoring for new text.

source code

stopMonitoring(self)
Stop monitoring previously started with startMonitoring.

source code

event_textChange(self)
Fired when the text changes.

source code

list of str

_getTextLines(self)
Retrieve the text of this object in lines.

source code

_reportNewText(self, line)
Report a line of new text.

source code

_monitor(self)

source code

_calculateNewText(self, newLines, oldLines)

source code

Inherited from NVDAObject: __eq__, __init__, __ne__, doAction, event_becomeNavigatorObject, event_caret, event_descriptionChange, event_focusEntered, event_foreground, event_gainFocus, event_mouseMove, event_nameChange, event_stateChange, event_typedCharacter, event_valueChange, findOverlayClasses, getActionName, makeTextInfo, reportFocus, scrollIntoView, setFocus

Inherited from NVDAObject (private): _findSimpleNext, _get_actionCount, _get_activeChild, _get_appModule, _get_basicText, _get_childCount, _get_children, _get_columnCount, _get_columnNumber, _get_container, _get_defaultActionIndex, _get_description, _get_devInfo, _get_embeddingTextInfo, _get_firstChild, _get_flatReviewPosition, _get_flowsFrom, _get_flowsTo, _get_indexInParent, _get_isInForeground, _get_isPresentableFocusAncestor, _get_isProtected, _get_keyboardShortcut, _get_labeledBy, _get_lastChild, _get_location, _get_name, _get_next, _get_parent, _get_positionInfo, _get_presentationType, _get_previous, _get_processID, _get_recursiveDescendants, _get_role, _get_rowCount, _get_rowNumber, _get_simpleFirstChild, _get_simpleLastChild, _get_simpleNext, _get_simpleParent, _get_simplePrevious, _get_states, _get_statusBar, _get_table, _get_treeInterceptor, _get_treeInterceptorClass, _get_value, _isEqual, _set_treeInterceptor

Inherited from baseObject.ScriptableObject: bindGesture, bindGestures, clearGestureBindings, getScript

Inherited from baseObject.AutoPropertyObject: invalidateCache

Inherited from baseObject.AutoPropertyObject (private): _getPropertyViaCache

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods

Inherited from NVDAObject: findBestAPIClass, getPossibleAPIClasses, kwargsFromSuper

Inherited from baseObject.AutoPropertyObject: invalidateCaches

Static Methods

Inherited from NVDAObject: objectFromPoint, objectInForeground, objectWithFocus

Class Variables

STABILIZE_DELAY = 0

presentationType = "content"

Inherited from NVDAObject: beTransparentToMouse, cachePropertiesByDefault, presType_content, presType_layout, presType_unavailable, tableCellCoordsInName

Instance Variables

Inherited from NVDAObject: textRepresentationLineLength

Inherited from NVDAObject (private): _mouseEntered

Properties

Inherited from object: __class__

Method Details

startMonitoring(self)

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 Also: stopMonitoring

stopMonitoring(self)

Stop monitoring previously started with startMonitoring.

Note: If monitoring has not been started, this will have no effect.

See Also: startMonitoring

event_textChange(self)

Fired when the text changes.

Note: It is safe to call this directly from threads other than the main thread.

_getTextLines(self)

Retrieve the text of this object in lines. This will be used to determine the new text to speak. The base implementation uses the TextInfo. However, subclasses should override this if there is a better way to retrieve the text.

Returns: list of str: The current lines of text.