Module MetacityScript :: Class MetacityScript

[frames] | no frames]

Class MetacityScript

                                  object --+            
                                           |            
AccessEngine.AEUserInterface.AEUserInterface --+        
                                               |        
                  AccessEngine.AEScript.AEScript --+    
                                                   |    
                   AccessEngine.AEScript.EventScript --+
                                                       |
                                                      MetacityScript

Defines a special AEScript to announce information in the metacity desktop and application switcher windows.

Instance Methods

init(self)
Registers event tasks to handle state and property events.

source code

_sayStatusBar(self, text=None, **kwargs)
Read the accessible name of the status text.

source code

string

getName(self)
Provides the localized name of this AEScript.

source code

string

getDescription(self)
Describe which AETier this script applies to by default.

source code

boolean

onPropertyChange(self, **kwargs)
Announces Alt+Tab application switching by reading the accessible name of the status text when it changes.

source code

boolean

onStateChange(self, **kwargs)
Announces the Alt+Tab application by reading the accessible name of the status text when it open the metacity window.

source code

boolean

onViewFirstGained(self, **kwargs)
When the Metacity window opens, the BasicSpeechScript.onViewFirstGained-method cuts off the reading of the accessible name of the status bar.

source code

Inherited from AccessEngine.AEScript.EventScript: chainNewEventTaskAround, executeAroundTask, onCaretChange, onCaretDeleted, onCaretInserted, onCaretMoved, onChildAdded, onChildRemoved, onChildrenChange, onChooserChange, onChooserEnd, onChooserSignal, onChooserStart, onFocusChange, onFocusGained, onFocusLost, onMouseChange, onMouseMoved, onMousePressed, onMouseReleased, onScreenChange, onScreenReflowed, onScreenRefreshed, onScreenResized, onSelectorActive, onSelectorAdded, onSelectorChange, onSelectorRemoved, onSelectorText, onTableChange, onTableColumnDeleted, onTableColumnInserted, onTableColumnReordered, onTableRowDeleted, onTableRowInserted, onTableRowReordered, onViewChange, onViewGained, onViewLost, onViewStartup, registerEventTask, unregisterEventTask, updateAroundTask, updateOnCaretChange, updateOnChildrenChange, updateOnFocusChange, updateOnMouseChange, updateOnPropertyChange, updateOnScreenChange, updateOnSelectorChange, updateOnStateChange, updateOnTableChange, updateOnViewChange

Inherited from AccessEngine.AEScript.EventScript (private): _doReplacedTask

Inherited from AccessEngine.AEScript.AEScript: __init__, bindToEvent, chainTask, close, doCyclicInputTask, doTask, getAETier, getAnchorScriptClassName, getAnchorTaskId, getChainSegment, getChooserTask, getCommandTask, getEventTasks, getIdealOutput, getLastKey, getOutputDevices, getPointerPOR, getRegisteredTask, getScriptSetting, getScriptSettingVal, getState, getTaskKeys, getTempData, getVirtualPOR, mergeChain, postClose, preInit, registerChooserTask, registerCommand, registerCyclicInputTask, registerCyclicInputTasks, registerModifiers, registerTask, registerTimerTask, setIdealOutput, setPointerPOR, setScriptSettingVal, setTempData, setVirtualPOR, unbindFromEvent, unchainTask, unregisterChooserTask, unregisterCommand, unregisterCyclicInputTask, unregisterModifiers, unregisterTask, unregisterTaskFromCyclicInputTask, unregisterTimerTask

Inherited from AccessEngine.AEScript.AEScript (private): _changeDefaultOutput

Inherited from AccessEngine.AEUserInterface.AEUserInterface: getClassName, getPath

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

Class Variables

Inherited from AccessEngine.AEScript.AEScript: STATE

Instance Variables

Inherited from AccessEngine.AEScript.AEScript: after_chains, around_chains, around_tasks, before_chains, chooser_tasks, command_descriptions, commands, cyclic_input_tasks, def_out, event_tasks, out_caps, registered_modifiers, registered_tasks, state, tier

Properties

Inherited from object: __class__

Method Details

init(self)

Registers event tasks to handle state and property events.

Overrides: AccessEngine.AEScript.AEScript.init

_sayStatusBar(self, text=None, **kwargs)

Read the accessible name of the status text.

Parameters:

text (string) - Text to speech
kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

getName(self)

Provides the localized name of this AEScript.

Returns: string: Human readable translated name of this script.
Overrides: AccessEngine.AEUserInterface.AEUserInterface.getName

getDescription(self)

Describe which AETier this script applies to by default.

Returns: string: Human readable translated description of this script.
Overrides: AccessEngine.AEUserInterface.AEUserInterface.getDescription

onPropertyChange(self, **kwargs)

Announces Alt+Tab application switching by reading the accessible name of the status text when it changes.

Parameters:

kwargs (dictionary) - Arbitrary data given by the observer.

Returns: boolean

True to allow other tasks to process this event

Overrides: AccessEngine.AEScript.EventScript.onPropertyChange

onStateChange(self, **kwargs)

Announces the Alt+Tab application by reading the accessible name of the status text when it open the metacity window.

Parameters:

kwargs (dictionary) - Arbitrary data given by the observer.

Returns: boolean

True to allow other tasks to process this event

Overrides: AccessEngine.AEScript.EventScript.onStateChange

onViewFirstGained(self, **kwargs)

When the Metacity window opens, the BasicSpeechScript.onViewFirstGained-method cuts off the reading of the accessible name of the status bar. There is no window-title in metacity, so we make a chain around to stop the BasicSpeechScript and get the full name of the status bar.

Parameters:

kwargs (dictionary) - Arbitrary data given by the observer.

Returns: boolean

True to allow other tasks to process this event.

Overrides: AccessEngine.AEScript.EventScript.onViewFirstGained