Module DeveloperScript :: Class DeveloperScript
[hide private]
[frames] | no frames]

Class DeveloperScript

source code

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

A special AEScript for assisting Script developers.

It defines special hotkeys.

Instance Methods [hide private]
 
init(self)
Registers event tasks to handle focus and view change events.
source code
string
getName(self)
Provides the localized name of this AEScript.
source code
 
onMute(self, **kwargs)
Task to mute output indefinitely or unmute it if it has already been muted.
source code
 
sayScripts(self, **kwargs)
Says the number of AEScripts loaded on the active AETier followed by their names.
source code
 
reloadScripts(self, **kwargs)
Reloads all AEScripts in the current AETier.
source code
 
showHideMonitors(self, **kwargs)
Shows all monitors associated with the current profile if all are hidden.
source code
boolean
onFocusGained(self, **kwargs)
Prints the focus AEPor.
source code
boolean
onFocusLost(self, **kwargs)
Prints the lost focus AEPor.
source code
boolean
onViewChange(self, **kwargs)
Prints the view AEPor.
source code

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

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.AEUserInterface.AEUserInterface: getClassName, getDescription, getPath

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

Class Variables [hide private]

Inherited from AccessEngine.AEScript.AEScript: STATE

Instance Variables [hide private]

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 
Registers event tasks to handle focus and view change events. Registers tasks that can be mapped to AEInput.Gestures.
Overrides: AccessEngine.AEScript.AEScript.init

getName(self)

source code 
Provides the localized name of this AEScript.
Returns: string
Human readable name of this script.
Overrides: AccessEngine.AEUserInterface.AEUserInterface.getName

onMute(self, **kwargs)

source code 
Task to mute output indefinitely or unmute it if it has already been muted.
Parameters:
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

sayScripts(self, **kwargs)

source code 
Says the number of AEScripts loaded on the active AETier followed by their names.
Parameters:
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

reloadScripts(self, **kwargs)

source code 
Reloads all AEScripts in the current AETier. Useful during Script development when changes have been made to a Script and those changes should be tested without restarting SUE.
Parameters:
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

showHideMonitors(self, **kwargs)

source code 
Shows all monitors associated with the current profile if all are hidden. Hides all monitors associated with the current profile if any one is shown.
Parameters:
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

onFocusGained(self, **kwargs)

source code 
Prints the focus AEPor.
Parameters:
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task
Returns: boolean
True to allow other tasks to process this event.
Overrides: AccessEngine.AEScript.EventScript.onFocusGained

onFocusLost(self, **kwargs)

source code 
Prints the lost focus AEPor.
Parameters:
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task
Returns: boolean
True to allow other tasks to process this event.
Overrides: AccessEngine.AEScript.EventScript.onFocusLost

onViewChange(self, **kwargs)

source code 
Prints the view AEPor.
Parameters:
  • kwargs (dictionary) - Arbitrary keyword arguments to pass to the task
Returns: boolean
True to allow other tasks to process this event.
Overrides: AccessEngine.AEScript.EventScript.onViewChange