Package NVDAObjects :: Package window :: Module scintilla :: Class ScintillaTextInfo
[hide private]
[frames] | no frames]

Class ScintillaTextInfo

source code

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

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]
 
_getOffsetFromPoint(self, x, y) source code
 
_getPointFromOffset(self, offset) source code
 
_getFormatFieldAndOffsets(self, offset, formatConfig, calculateOffsets=True)
Retrieve the formatting information for a given offset and the offsets spanned by that field.
source code
 
_getCaretOffset(self) source code
 
_setCaretOffset(self, offset) source code
 
_getSelectionOffsets(self) source code
 
_setSelectionOffsets(self, start, end) source code
unicode
_getStoryText(self)
Retrieve the entire text of the object.
source code
 
_getStoryLength(self) source code
 
_getLineCount(self) source code
unicode
_getTextRange(self, start, end)
Retrieve the text in a given offset range.
source code
 
_getWordOffsets(self, offset) source code
 
_getLineNumFromOffset(self, offset) source code
 
_getLineOffsets(self, offset) source code
 
_getParagraphOffsets(self, offset) source code
 
_getCharacterOffsets(self, offset) source code

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

Inherited from textInfos.offsets.OffsetsTextInfo (private): _getNVDAObjectFromOffset, _getOffsetsFromNVDAObject, _getReadingChunkOffsets, _getUnitOffsets, _get_NVDAObjectAtStart, _get_bookmark, _get_isCollapsed, _get_pointAtStart, _get_text

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

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

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 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]

_getOffsetFromPoint(self, x, y)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getOffsetFromPoint

_getPointFromOffset(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getPointFromOffset

_getFormatFieldAndOffsets(self, offset, formatConfig, calculateOffsets=True)

source code 

Retrieve the formatting information for a given offset and the offsets spanned by that field. Subclasses must override this if support for text formatting is desired. The base implementation associates text with line numbers if possible.

Overrides: textInfos.offsets.OffsetsTextInfo._getFormatFieldAndOffsets
(inherited documentation)

_getCaretOffset(self)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getCaretOffset

_setCaretOffset(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._setCaretOffset

_getSelectionOffsets(self)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getSelectionOffsets

_setSelectionOffsets(self, start, end)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._setSelectionOffsets

_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)

_getWordOffsets(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getWordOffsets

_getLineNumFromOffset(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getLineNumFromOffset

_getLineOffsets(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getLineOffsets

_getParagraphOffsets(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getParagraphOffsets

_getCharacterOffsets(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getCharacterOffsets