Module EvolutionScript :: Class EvolutionScript

Class EvolutionScript

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

The customized script for the Evolution E-Mail client.

Nested Classes

[hide private]

AEState class

STATE
Class to instantiate and use to store state information across all instances of this AEScript.

Instance Methods

[hide private]

init(self)
Initialization of the EvolutionScript.

source code

_readNewTreeTableName(self, **kwargs)
Reads the name of the current tree table if it has changed.

source code

boolean

onViewGained(self, **kwargs)
Replaces the BasicSpeechScript when Evolution gets a ViewChange Event.

source code

boolean

onViewLost(self, **kwargs)
Reset the evolution states.

source code

boolean

onFocusGained(self, **kwargs)
Replaces the BasicSpeechScript when Evolution gets a FocusChange Event.

source code

boolean

onSelectorActive(self, **kwargs)
Replaces the BasicSpeechScript when Evolution gets a SelectorChange Event.

source code

boolean

onStateChange(self, **kwargs)
React to a StateChange event in Evolution.

source code

boolean

onCaretMoved(self, **kwargs)
Don't execute the caret move, when in the list with the e-mails.

source code

boolean

_isSetupAssistant(self, por)
Test whether the given por is an element in the Evolution Setup Assistant

source code

_findSAActivePanel(self)
Find the active panel in the Evolution Setup Assistant.

source code

AEPor or None

_getLabel(self, rootPor, *path)
Checks whether the AEPor at the given path is a label.

source code

_readSALabels(self, **kwargs)
Read the header label and the description label of the active panel in the Evolution Setup Assitant.

source code

__workaroundSALabeledBy(self, **kwargs)

source code

getNumberOfMails(self)
Finds out, how many mails are shown in the message tree.

source code

_readTableCellFromMailList(self, columnHeader, cellPOR, **kwargs)
Read one cell of the table tree that contains the list of E-Mails.

source code

_readTableRowFromMailList(self, **kwargs)
Read the current row of the table tree that contains the list of E-Mails.

source code

_isMailWindow(self, **kwargs)
Test whether we are in a window that shows the contents of one mail.

source code

readMailHeader(self, **kwargs)
Reads the header of an e-mail.

source code

readMailBody(self, **kwargs)
Reads the text of the whole e-mail.

source code

_readAllText(self, ePor, **kwargs)
Reads all text accessibles under the given por.

source code

_quote(self, text, **kwargs)
Reads quotation in an e-mail.

source code

readEMail(self, **kwargs)
Read a row in a mail.

source code

Inherited from AccessEngine.AEScript.EventScript: chainNewEventTaskAround, executeAroundTask, onCaretChange, onCaretDeleted, onCaretInserted, onChildAdded, onChildRemoved, onChildrenChange, onChooserChange, onChooserEnd, onChooserSignal, onChooserStart, onFocusChange, onFocusLost, onMouseChange, onMouseMoved, onMousePressed, onMouseReleased, onPropertyChange, onScreenChange, onScreenReflowed, onScreenRefreshed, onScreenResized, onSelectorAdded, onSelectorChange, onSelectorRemoved, onSelectorText, onTableChange, onTableColumnDeleted, onTableColumnInserted, onTableColumnReordered, onTableRowDeleted, onTableRowInserted, onTableRowReordered, onViewChange, onViewFirstGained, 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, getDescription, getName, getPath

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

Instance Variables

[hide private]

AEPor htmlPanel
the HTML Container of the open mail

integer lastQuotationLevel
the depth of quotation in an e-mail

AEPor saActiveChild
the active panel in the evolution setup assistant; a direct child of saRootPOR

AEPor saRootPOR
the first common Ancestor for all sites in the evolution setup assistant (accessible path: 0,0)

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

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self)

source code

Initialization of the EvolutionScript.

Overrides: AccessEngine.AEScript.AEScript.init

onViewGained(self, **kwargs)

source code

Replaces the BasicSpeechScript when Evolution gets a ViewChange Event.

Returns: boolean: True; more tasks can execute for this event.
Overrides: AccessEngine.AEScript.EventScript.onViewGained

onViewLost(self, **kwargs)

source code

Reset the evolution states.

Returns: boolean: True to allow other tasks to process this event.
Overrides: AccessEngine.AEScript.EventScript.onViewLost

onFocusGained(self, **kwargs)

source code

Replaces the BasicSpeechScript when Evolution gets a FocusChange Event.

Returns: boolean: True; more tasks can execute for this event.
Overrides: AccessEngine.AEScript.EventScript.onFocusGained

onSelectorActive(self, **kwargs)

source code

Replaces the BasicSpeechScript when Evolution gets a SelectorChange Event.

Returns: boolean: True; more tasks can execute for this event.
Overrides: AccessEngine.AEScript.EventScript.onSelectorActive

onStateChange(self, **kwargs)

source code

React to a StateChange event in Evolution.

We are interested in state changes in the Evolution Setup Assistant, where the state will be set to 'showing'. This should indicate that a new panel in the dialog was activated.

Returns: boolean: True; more tasks can execute for this event.
Overrides: AccessEngine.AEScript.EventScript.onStateChange

onCaretMoved(self, **kwargs)

source code

Don't execute the caret move, when in the list with the e-mails.

Returns: boolean: True to allow other tasks to process this event
Overrides: AccessEngine.AEScript.EventScript.onCaretMoved

_isSetupAssistant(self, por)

source code

Test whether the given por is an element in the Evolution Setup Assistant

Parameters:

por (AEPor) - The AEPor that should be in the Evolution Setup Assistant

Returns: boolean

whether the por is in the Evolution Setup Assitant

_findSAActivePanel(self)

source code

Find the active panel in the Evolution Setup Assistant.

The active panel has the state 'showing' and is a dircet child of the saRootPOR instance variable. Sets the saActiveChild instance variable.

_getLabel(self, rootPor, *path)

source code

Checks whether the AEPor at the given path is a label.

Returns: AEPor or None: The AEPor if it is a label; False otherwise.

getNumberOfMails(self)

source code

Finds out, how many mails are shown in the message tree.

To Do: RB: must still be implemented

_readTableCellFromMailList(self, columnHeader, cellPOR, **kwargs)

source code

Read one cell of the table tree that contains the list of E-Mails.

Parameters:

columnHeader (string) - the name of the column that contains the table cell
cellPOR (AEPor) - the table cell that shall be read
kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

_readAllText(self, ePor, **kwargs)

source code

Reads all text accessibles under the given por.

This method works recursivly.

Parameters:

ePor (AEPor) - the por which is used to find text accessibles.