Package NVDAObjects :: Package window :: Class DisplayModelLiveText

Class DisplayModelLiveText

                   object --+                
                            |                
baseObject.AutoPropertyObject --+            
                                |            
      baseObject.ScriptableObject --+        
                                    |        
                           NVDAObject --+    
                                        |    
                       behaviors.LiveText --+
                                            |
                   object --+               |
                            |               |
baseObject.AutoPropertyObject --+           |
                                |           |
      baseObject.ScriptableObject --+       |
                                    |       |
                           NVDAObject --+   |
                                        |   |
                                   Window --+
                                            |
                                           DisplayModelLiveText

Nested Classes

[hide private]

TextInfo
A default TextInfo which is used to enable text review of information about widgets that don't support text content.

Inherited from NVDAObject: __metaclass__

Instance Methods

[hide private]

startMonitoring(self)
Start monitoring for new text.

source code

stopMonitoring(self)
Stop monitoring previously started with startMonitoring.

source code

list of str

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

source code

Inherited from behaviors.LiveText: event_textChange, initOverlayClass

Inherited from behaviors.LiveText (private): _calculateNewText, _monitor, _reportNewText

Inherited from Window: __init__, correctAPIForRelation, findOverlayClasses, redraw

Inherited from Window (private): _get_devInfo, _get_displayText, _get_firstChild, _get_isInForeground, _get_isWindowUnicode, _get_lastChild, _get_location, _get_name, _get_next, _get_parent, _get_previous, _get_processHandle, _get_processID, _get_role, _get_states, _get_windowClassName, _get_windowControlID, _get_windowStyle, _get_windowText, _get_windowThreadID, _isEqual

Inherited from NVDAObject: __eq__, __ne__, doAction, event_becomeNavigatorObject, event_caret, event_descriptionChange, event_focusEntered, event_foreground, event_gainFocus, event_mouseMove, event_nameChange, event_stateChange, event_typedCharacter, event_valueChange, 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_embeddingTextInfo, _get_flatReviewPosition, _get_flowsFrom, _get_flowsTo, _get_indexInParent, _get_isPresentableFocusAncestor, _get_isProtected, _get_keyboardShortcut, _get_labeledBy, _get_positionInfo, _get_presentationType, _get_recursiveDescendants, _get_rowCount, _get_rowNumber, _get_simpleFirstChild, _get_simpleLastChild, _get_simpleNext, _get_simpleParent, _get_simplePrevious, _get_statusBar, _get_table, _get_treeInterceptor, _get_treeInterceptorClass, _get_value, _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

[hide private]

Inherited from Window: getPossibleAPIClasses, kwargsFromSuper, normalizeWindowClassName

Inherited from NVDAObject: findBestAPIClass

Inherited from baseObject.AutoPropertyObject: invalidateCaches

Static Methods

[hide private]

Inherited from NVDAObject: objectFromPoint, objectInForeground, objectWithFocus

Class Variables

[hide private]

Inherited from behaviors.LiveText: STABILIZE_DELAY, presentationType

Inherited from Window: normalizedWindowClassNameCache

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

Instance Variables

[hide private]

Inherited from Window: windowClassName, windowControlID, windowHandle, windowProcessID, windowText

Inherited from NVDAObject: textRepresentationLineLength

Inherited from NVDAObject (private): _mouseEntered

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

startMonitoring(self)

source code

Start monitoring for new text. New text will be reported when it is detected.

Overrides: behaviors.LiveText.startMonitoring: (inherited documentation)

stopMonitoring(self)

source code

Stop monitoring previously started with startMonitoring.

Overrides: behaviors.LiveText.stopMonitoring: (inherited documentation)

_getTextLines(self)

source code

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.
Overrides: behaviors.LiveText._getTextLines: (inherited documentation)