Package NVDAObjects :: Package IAccessible :: Class IA2TextTextInfo
[hide private]
[frames] | no frames]

Class IA2TextTextInfo

source code

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

Nested Classes [hide private]

Inherited from baseObject.AutoPropertyObject: __metaclass__

Instance Methods [hide private]
 
_getOffsetFromPoint(self, x, y) source code
 
_getPointFromOffset(self, offset) source code
 
_get_unit_mouseChunk(self) source code
 
expand(self, unit)
Expands the start and end of this text info object to a given unit
source code
 
_getCaretOffset(self) source code
 
_setCaretOffset(self, offset) source code
 
_getSelectionOffsets(self) source code
 
_setSelectionOffsets(self, start, end) 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
 
_getFormatFieldAndOffsets(self, offset, formatConfig, calculateOffsets=True)
Retrieve the formatting information for a given offset and the offsets spanned by that field.
source code
 
_getCharacterOffsets(self, offset) source code
 
_getWordOffsets(self, offset) source code
 
_getLineOffsets(self, offset) source code
 
_getSentenceOffsets(self, offset) source code
 
_getParagraphOffsets(self, offset) source code
 
_lineNumFromOffset(self, offset) source code
NVDAObjects.NVDAObject
getEmbeddedObject(self, offset=0)
Retrieve the embedded object associated with a particular embedded object character.
source code

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

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

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

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

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]
  detectFormattingAfterCursorMaybeSlow = False
honours documentFormatting config option if true - set to false if this is not at all slow.

Inherited from textInfos.offsets.OffsetsTextInfo: 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

_get_unit_mouseChunk(self)

source code 
Overrides: textInfos.TextInfo._get_unit_mouseChunk

expand(self, unit)

source code 

Expands the start and end of this text info object to a given unit

Parameters:
  • unit - a unit constant
Overrides: textInfos.TextInfo.expand
(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

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

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

_getCharacterOffsets(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getCharacterOffsets

_getWordOffsets(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getWordOffsets

_getLineOffsets(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getLineOffsets

_getParagraphOffsets(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getParagraphOffsets

getEmbeddedObject(self, offset=0)

source code 

Retrieve the embedded object associated with a particular embedded object character. Where a text implementation allows other objects to be embedded in the text, embedded objects are represented by an embedded object character (\uFFFC). When these characters are encountered, this method can be used to retrieve the associated embedded object.

Parameters:
  • offset - The offset of the embedded object character in question relative to the start of this instance.
Returns: NVDAObjects.NVDAObject
The embedded object.
Overrides: textInfos.TextInfo.getEmbeddedObject
(inherited documentation)