Package virtualBuffers :: Class VirtualBufferTextInfo
[hide private]
[frames] | no frames]

Class VirtualBufferTextInfo

source code

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

Nested Classes [hide private]

Inherited from baseObject.AutoPropertyObject: __metaclass__

Instance Methods [hide private]
 
_getFieldIdentifierFromOffset(self, offset) source code
 
_getOffsetsFromFieldIdentifier(self, docHandle, ID) source code
 
_getPointFromOffset(self, offset) source code
 
_getNVDAObjectFromOffset(self, offset) source code
 
_getOffsetsFromNVDAObjectInBuffer(self, obj) source code
 
_getOffsetsFromNVDAObject(self, obj) source code
 
__init__(self, obj, position)
Constructor.
source code
 
_getSelectionOffsets(self) source code
 
_setSelectionOffsets(self, start, end) source code
 
_getCaretOffset(self) source code
 
_setCaretOffset(self, offset) source code
 
_getStoryLength(self) source code
unicode
_getTextRange(self, start, end)
Retrieve the text in a given offset range.
source code
list of unicode and FieldCommand
getTextWithFields(self, formatConfig=None)
Retreaves the text in this range, as well as any control/format fields associated therewith.
source code
 
_getWordOffsets(self, offset) source code
 
_getLineOffsets(self, offset) source code
 
_getParagraphOffsets(self, offset) source code
 
_normalizeControlField(self, attrs) source code
 
_normalizeFormatField(self, attrs) source code
 
_getLineNumFromOffset(self, offset) source code
 
_get_fieldIdentifierAtStart(self) source code
 
_getUnitOffsets(self, unit, offset) source code
 
_get_clipboardText(self)
Text suitably formatted for copying to the clipboard.
source code
 
getControlFieldSpeech(self, attrs, ancestorAttrs, fieldType, formatConfig=None, extraDetail=False, reason=None) source code
 
getControlFieldBraille(self, field, ancestors, reportStart, formatConfig) source code
 
_get_focusableNVDAObjectAtStart(self) source code

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

Inherited from textInfos.offsets.OffsetsTextInfo (private): _getCharacterOffsets, _getFormatFieldAndOffsets, _getOffsetFromPoint, _getReadingChunkOffsets, _getStoryText, _get_NVDAObjectAtStart, _get_bookmark, _get_isCollapsed, _get_pointAtStart, _get_text

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

Inherited from textInfos.TextInfo (private): _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]
  UNIT_CONTROLFIELD = "controlField"

Inherited from textInfos.offsets.OffsetsTextInfo: detectFormattingAfterCursorMaybeSlow, useUniscribe

Inherited from baseObject.AutoPropertyObject: cachePropertiesByDefault

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

_getPointFromOffset(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getPointFromOffset

_getNVDAObjectFromOffset(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getNVDAObjectFromOffset

_getOffsetsFromNVDAObject(self, obj)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getOffsetsFromNVDAObject

__init__(self, obj, position)
(Constructor)

source code 

Constructor. Subclasses may extend this to perform implementation specific initialisation, calling their superclass method afterwards.

Parameters:
  • position - The initial position of this range; one of the POSITION_* constants or a position object supported by the implementation.
  • obj - The object containing the range of text being represented.
Overrides: object.__init__
(inherited documentation)

_getSelectionOffsets(self)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getSelectionOffsets

_setSelectionOffsets(self, start, end)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._setSelectionOffsets

_getCaretOffset(self)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getCaretOffset

_setCaretOffset(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._setCaretOffset

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

getTextWithFields(self, formatConfig=None)

source code 

Retreaves the text in this range, as well as any control/format fields associated therewith. Subclasses may override this. The base implementation just returns the text.

Parameters:
  • formatConfig - Document formatting configuration, useful if you wish to force a particular configuration for a particular task.
Returns: list of unicode and FieldCommand
A sequence of text strings interspersed with associated field commands.
Overrides: textInfos.TextInfo.getTextWithFields
(inherited documentation)

_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

_getLineNumFromOffset(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getLineNumFromOffset

_getUnitOffsets(self, unit, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getUnitOffsets

_get_clipboardText(self)

source code 

Text suitably formatted for copying to the clipboard. E.g. crlf characters inserted between lines.

Overrides: textInfos.TextInfo._get_clipboardText
(inherited documentation)

getControlFieldSpeech(self, attrs, ancestorAttrs, fieldType, formatConfig=None, extraDetail=False, reason=None)

source code 
Overrides: textInfos.TextInfo.getControlFieldSpeech

getControlFieldBraille(self, field, ancestors, reportStart, formatConfig)

source code 
Overrides: textInfos.TextInfo.getControlFieldBraille