Module Braille :: Class BrailleStyle

Class BrailleStyle

AccessEngine.AEDevice.AEOutput.Style --+
                                       |
                                      BrailleStyle

Defines the basic style attributes for all AEOutput.Braille devices.

DisplayColumns (integer) Number of cells in each display row.

DisplayRows (integer) Number of row in display.

TotalCells (integer) Total cells in display.

CaretStyle (enum): Current caret style

EllipsisRight (bool): Does user want right ellipsis shown?

EllipsisLeft (bool): Does user want left ellipsis shown?

EllipsisStyle (enum): Current ellipsis style

CellMask (string): Missing cell string. 0=bad cell; 1=good cell.

Instance Methods

[hide private]

_initDefault(self)
Called automatically by the Style base class when this style is a default.

source code

_setMissingCells(self, style, setting)
Updates the missing cell count instance variable whenever the CellMask setting changes value.

source code

AEState.Setting.Group

_newBrailleGroup(self, root)
Builds groups of standard Braille settings that should be available for all Braille devices.

source code

Class Variables

[hide private]

integer missingcellcnt = 0
Count of missing cells in CellMask.

Method Details

[hide private]

_initDefault(self)

source code

Called automatically by the Style base class when this style is a default. Initializes all default braille options. If you want these settings created, be sure to call this base class implementation if you override in a subclass.

_setMissingCells(self, style, setting)

source code

Updates the missing cell count instance variable whenever the CellMask setting changes value.

Parameters:

style (BrailleStyle) - This style object
setting (AEState.Setting) - Setting that change value, namely CellMask

_newBrailleGroup(self, root)

source code

Builds groups of standard Braille settings that should be available for all Braille devices. The groups are added directly to the root group provided.

Parameters:

root (AEState.Setting.Group) - Parent group for the word settings group

Returns: AEState.Setting.Group

The root group again

Class Variable Details

[hide private]

missingcellcnt

Count of missing cells in CellMask. Initialized as a class variable for convienced, but used as an instance variable.

Type:: integer

Value: