Package NVDAObjects :: Class NVDAObjectTextInfo
[hide private]
[frames] | no frames]

Class NVDAObjectTextInfo

source code

                   object --+            
                            |            
baseObject.AutoPropertyObject --+        
                                |        
               textInfos.TextInfo --+    
                                    |    
    textInfos.offsets.OffsetsTextInfo --+
                                        |
                                       NVDAObjectTextInfo

A default TextInfo which is used to enable text review of information about widgets that don't support text content. The NVDAObject.basicText attribute is used as the text to expose.

Nested Classes [hide private]

Inherited from baseObject.AutoPropertyObject: __metaclass__

Instance Methods [hide private]
 
_get_unit_mouseChunk(self) source code
unicode
_getStoryText(self)
Retrieve the entire text of the object.
source code
 
_getStoryLength(self) source code
unicode
_getTextRange(self, start, end)
Retrieve the text in a given offset range.
source code

Inherited from textInfos.offsets.OffsetsTextInfo: __eq__, __init__, collapse, compareEndPoints, copy, expand, find, getTextWithFields, move, setEndPoint, unitCount, unitIndex, updateCaret, updateSelection

Inherited from textInfos.TextInfo: copyToClipboard, getControlFieldBraille, getControlFieldSpeech, getEmbeddedObject, getTextInChunks, isOverlapping

Inherited from textInfos.TextInfo (private): _get_clipboardText, _get_obj

Inherited from baseObject.AutoPropertyObject: invalidateCache

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

Class Methods [hide private]

Inherited from baseObject.AutoPropertyObject: invalidateCaches

Class Variables [hide private]

Inherited from textInfos.offsets.OffsetsTextInfo: detectFormattingAfterCursorMaybeSlow, useUniscribe

Inherited from baseObject.AutoPropertyObject: cachePropertiesByDefault

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

_get_unit_mouseChunk(self)

source code 
Overrides: textInfos.TextInfo._get_unit_mouseChunk

_getStoryText(self)

source code 

Retrieve the entire text of the object.

Returns: unicode
The entire text of the object.
Overrides: textInfos.offsets.OffsetsTextInfo._getStoryText
(inherited documentation)

_getStoryLength(self)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getStoryLength

_getTextRange(self, start, end)

source code 

Retrieve the text in a given offset range.

Parameters:
  • start - The start offset.
  • end - The end offset (exclusive).
Returns: unicode
The text contained in the requested range.
Overrides: textInfos.offsets.OffsetsTextInfo._getTextRange
(inherited documentation)