Module braille :: Class NVDAObjectRegion

Class NVDAObjectRegion

object --+    
         |    
    Region --+
             |
            NVDAObjectRegion

A region to provide a braille representation of an NVDAObject. This region will update based on the current state of the associated NVDAObject. A cursor routing request will activate the object's default action.

Instance Methods

[hide private]

__init__(self, obj, appendText="")
Constructor.

source code

update(self)
Update this region.

source code

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

source code

Inherited from Region: nextLine, previousLine

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, appendText="")
(Constructor)

source code

Constructor.

Parameters:

obj (NVDAObjects.NVDAObject) - The associated NVDAObject.
appendText (str) - Text which should always be appended to the NVDAObject text, useful if this region will always precede other regions.

Overrides: object.__init__

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.

Overrides: Region.update: (inherited documentation)

routeTo(self, braillePos)

source code

Handle a cursor routing request. For example, this might activate an object or move the cursor to the requested position.

Parameters:

braillePos - The routing position in brailleCells.

Overrides: Region.routeTo

(inherited documentation)

Class NVDAObjectRegion

__init__(self, obj, appendText="") (Constructor)

update(self)

routeTo(self, braillePos)

init(self, obj, appendText="")
(Constructor)