Trees       Indices       Help   
Module braille :: Class BrailleHandler
[hide private]
[frames] | no frames]

Class BrailleHandler

source code

                   object --+    
                            |    
baseObject.AutoPropertyObject --+
                                |
                               BrailleHandler
Nested Classes [hide private]

Inherited from baseObject.AutoPropertyObject: __metaclass__

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
 
terminate(self) source code
 
_get_tether(self) source code
 
_set_tether(self, tether) source code
 
setDisplayByName(self, name) source code
 
_updateDisplay(self) source code
 
_displayWithCursor(self) source code
 
_blink(self) source code
 
update(self) source code
 
scrollForward(self) source code
 
scrollBack(self) source code
 
routeTo(self, windowPos) source code
 
message(self, text)
Display a message to the user which times out after a configured interval.		 source code
 
_resetMessageTimer(self)
Reset the message timeout.		 source code
 
_dismissMessage(self)
Dismiss the current message.		 source code
 
handleGainFocus(self, obj) source code
 
_doNewObject(self, regions) source code
 
handleCaretMove(self, obj) source code
 
_doCursorMove(self, region) source code
 
handleUpdate(self, obj) source code
 
handleReviewMove(self) source code

Inherited from baseObject.AutoPropertyObject: 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]
  TETHER_FOCUS = "focus"
  TETHER_REVIEW = "review"
  cursorShape = 0xc0

Inherited from baseObject.AutoPropertyObject: cachePropertiesByDefault

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

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

Overrides: object.__init__
(inherited documentation)

message(self, text)

source code 

Display a message to the user which times out after a configured interval. The timeout will be reset if the user scrolls the display. The message will be dismissed immediately if the user presses a cursor routing key. If a key is pressed the message will be dismissed by the next text being written to the display

Postcondition: The message is displayed.

_resetMessageTimer(self)

source code 

Reset the message timeout.

Precondition: A message is currently being displayed.

_dismissMessage(self)

source code 

Dismiss the current message.

Precondition: A message is currently being displayed.

Postcondition: The display returns to the main buffer.


   Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Nov 18 17:45:57 2011 http://epydoc.sourceforge.net