Module compoundDocuments :: Class CompoundTextInfo

Class CompoundTextInfo

                   object --+        
                            |        
baseObject.AutoPropertyObject --+    
                                |    
               textInfos.TextInfo --+
                                    |
                                   CompoundTextInfo

Nested Classes

[hide private]

Inherited from baseObject.AutoPropertyObject: __metaclass__

Instance Methods

[hide private]

_getObjectPosition(self, obj)

source code

int

compareEndPoints(self, other, which)
compares one end of this range to one end of another range.

source code

_normalizeStartAndEnd(self)

source code

setEndPoint(self, other, which)
Sets one end of this range to one end of another range.

source code

collapse(self, end=False)
Collapses this text info object so that both endpoints are the same.

source code

copy(self)
duplicates this text info object so that changes can be made to either one with out afecting the other

source code

updateCaret(self)
Moves the system caret to the position of this text info object

source code

updateSelection(self)
Moves the selection (usually the system caret) to the position of this text info object

source code

_get_bookmark(self)

source code

_get_NVDAObjectAtStart(self)
retreaves the NVDAObject related to the start of the range.

source code

_get_pointAtStart(self)
Retrieves x and y coordinates corresponding with the textInfo start.

source code

_getControlFieldForObject(self, obj, ignoreEditableText=True)

source code

_iterTextWithEmbeddedObjects(self, text, ti, fieldStart, textLength=None)

source code

__eq__(self, other)

source code

__ne__(self, other)

source code

Inherited from textInfos.TextInfo: __init__, copyToClipboard, expand, find, getControlFieldBraille, getControlFieldSpeech, getEmbeddedObject, getTextInChunks, getTextWithFields, isOverlapping, move, unitCount, unitIndex

Inherited from textInfos.TextInfo (private): _get_clipboardText, _get_isCollapsed, _get_obj, _get_text, _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 baseObject.AutoPropertyObject: cachePropertiesByDefault

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

compareEndPoints(self, other, which)

source code

compares one end of this range to one end of another range. Subclasses must implement this.

Parameters:

other - the text range to compare with.
which - The ends to compare; one of "startToStart", "startToEnd", "endToStart", "endToEnd".

Returns: int

-1 if this end is before other end, 1 if this end is after other end or 0 if this end and other end are the same.

Overrides: textInfos.TextInfo.compareEndPoints

(inherited documentation)

setEndPoint(self, other, which)

source code

Sets one end of this range to one end of another range. Subclasses must implement this.

Parameters:

other - The range from which an end is being obtained.
which - The ends to use; one of "startToStart", "startToEnd", "endToStart", "endToEnd".

Overrides: textInfos.TextInfo.setEndPoint

(inherited documentation)

collapse(self, end=False)

source code

Collapses this text info object so that both endpoints are the same.

Parameters:

end - Whether to collapse to the end; True to collapse to the end, False to collapse to the start.

Overrides: textInfos.TextInfo.collapse

(inherited documentation)

copy(self)

source code

duplicates this text info object so that changes can be made to either one with out afecting the other

Overrides: textInfos.TextInfo.copy: (inherited documentation)

updateCaret(self)

source code

Moves the system caret to the position of this text info object

Overrides: textInfos.TextInfo.updateCaret: (inherited documentation)

updateSelection(self)

source code

Moves the selection (usually the system caret) to the position of this text info object

Overrides: textInfos.TextInfo.updateSelection: (inherited documentation)

_get_bookmark(self)

source code

Overrides: textInfos.TextInfo._get_bookmark

_get_NVDAObjectAtStart(self)

source code

retreaves the NVDAObject related to the start of the range. Usually it is just the owner NVDAObject, but in the case of virtualBuffers it may be a descendant object.

Returns:: the NVDAObject at the start
Overrides: textInfos.TextInfo._get_NVDAObjectAtStart: (inherited documentation)

_get_pointAtStart(self)

source code

Retrieves x and y coordinates corresponding with the textInfo start. It should return Point

Overrides: textInfos.TextInfo._get_pointAtStart: (inherited documentation)