Module winConsoleHandler :: Class WinConsoleTextInfo
[hide private]
[frames] | no frames]

Class WinConsoleTextInfo

source code

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

Nested Classes [hide private]

Inherited from baseObject.AutoPropertyObject: __metaclass__

Instance Methods [hide private]
 
_get_consoleScreenBufferInfo(self) source code
 
_offsetFromConsoleCoord(self, x, y) source code
 
_consoleCoordFromOffset(self, offset) source code
 
_getOffsetFromPoint(self, x, y) source code
 
_getPointFromOffset(self, offset) source code
 
_getCaretOffset(self) source code
 
_getSelectionOffsets(self) 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
unicode
_getTextRange(self, start, end)
Retrieve the text in a given offset range.
source code
 
_getLineOffsets(self, offset) source code
 
_getLineNumFromOffset(self, offset) source code
 
_getStoryLength(self) source code
 
_get_clipboardText(self)
Text suitably formatted for copying to the clipboard.
source code

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

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

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

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]
  _cache_consoleScreenBufferInfo = True

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

_getCaretOffset(self)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getCaretOffset

_getSelectionOffsets(self)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getSelectionOffsets

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)

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

_getLineOffsets(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getLineOffsets

_getLineNumFromOffset(self, offset)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getLineNumFromOffset

_getStoryLength(self)

source code 
Overrides: textInfos.offsets.OffsetsTextInfo._getStoryLength

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