Module braille :: Class BrailleDisplayGesture

Class BrailleDisplayGesture

                   object --+        
                            |        
baseObject.AutoPropertyObject --+    
                                |    
           inputCore.InputGesture --+
                                    |
                                   BrailleDisplayGesture

A button, wheel or other control pressed on a braille display. Subclasses must provide source and id. routingIndex should be provided for routing buttons. If the braille display driver is a baseObject.ScriptableObject, it can provide scripts specific to input gestures from this display.

Nested Classes

[hide private]

Inherited from baseObject.AutoPropertyObject: __metaclass__

Instance Methods

[hide private]

str

_get_source(self)
The string used to identify all gestures from this display.

source code

str

_get_id(self)
The unique, display specific id for this gesture.

source code

list or tuple of str

_get_identifiers(self)
The identifier(s) which will be used in input gesture maps to represent this gesture.

source code

str

_get_displayName(self)
The name of this gesture as presented to the user.

source code

baseObject.ScriptableObject

_get_scriptableObject(self)
An object which contains scripts specific to this gesture or type of gesture.

source code

Inherited from inputCore.InputGesture: reportExtra, send

Inherited from inputCore.InputGesture (private): _get_logIdentifier, _get_script

Inherited from baseObject.AutoPropertyObject: __init__, 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]

routingIndex = None
hash(x)

Inherited from inputCore.InputGesture: SPEECHEFFECT_CANCEL, SPEECHEFFECT_PAUSE, SPEECHEFFECT_RESUME, cachePropertiesByDefault, isModifier, shouldReportAsCommand, speechEffectWhenExecuted

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

_get_source(self)

source code

The string used to identify all gestures from this display. This should generally be the driver name. This string will be included in the source portion of gesture identifiers. For example, if this was alvaBC6, a display specific gesture identifier might be br(alvaBC6):etouch1.

Returns: str

_get_identifiers(self)

source code

The identifier(s) which will be used in input gesture maps to represent this gesture. These identifiers will be looked up in order until a match is found. A single identifier should take the form: source:id where source is a few characters representing the source of this gesture and id is the specific gesture. If id consists of multiple items with indeterminate order, they should be separated by a + sign and they should be in Python set order. Also, the entire identifier should be in lower case. An example identifier is: kb(desktop):nvda+1 Subclasses must implement this method.

Returns: list or tuple of str: One or more identifiers which uniquely identify this gesture.
Overrides: inputCore.InputGesture._get_identifiers: (inherited documentation)

_get_displayName(self)

source code

The name of this gesture as presented to the user. Subclasses must implement this method.

Returns: str: The display name.
Overrides: inputCore.InputGesture._get_displayName: (inherited documentation)

_get_scriptableObject(self)

source code

An object which contains scripts specific to this gesture or type of gesture. This object will be searched for scripts before any other object when handling this gesture.

Returns: baseObject.ScriptableObject: The gesture specific scriptable object or None if there is none.
Overrides: inputCore.InputGesture._get_scriptableObject: (inherited documentation)