Module braille :: Class TextInfoRegion

Class TextInfoRegion

object --+    
         |    
    Region --+
             |
            TextInfoRegion

Instance Methods

[hide private]

__init__(self, obj)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

_isMultiline(self)

source code

_getCursor(self)
Retrieve the collapsed cursor.

source code

textInfos.TextInfo

_getSelection(self)
Retrieve the selection.

source code

_setCursor(self, info)
Set the cursor.

source code

_getTypeformFromFormatField(self, field)

source code

_addFieldText(self, text)

source code

_addTextWithFields(self, info, formatConfig, isSelection=False)

source code

update(self)
Update this region.

source code

routeTo(self, braillePos)
Handle a cursor routing request.

source code

nextLine(self)
Move to the next line if possible.

source code

previousLine(self, start=False)
Move to the previous line if possible.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, obj)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

_getCursor(self)

source code

Retrieve the collapsed cursor. This should be the start or end of the selection returned by _getSelection.

Returns:: The cursor.

_getSelection(self)

source code

Retrieve the selection. The start or end of this should be the cursor returned by _getCursor.

Returns: textInfos.TextInfo: The selection.

_setCursor(self, info)

source code

Set the cursor.

Parameters:

info (textInfos.TextInfo) - The range to which the cursor should be moved.

update(self)

source code

Update this region. Subclasses should extend this to update rawText and cursorPos if necessary. The base class method handles translation of rawText into braille, placing the result in brailleCells. Typeform information from rawTextTypeforms is used, if any. rawToBraillePos and brailleToRawPos are updated according to the translation. brailleCursorPos is similarly updated based on cursorPos.