| Trees | Indices | Help |
|
|---|
|
|
object --+
|
AEUserInterface.AEUserInterface --+
|
AEScript
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
| AEState |
|
||
|
|||
| list of string |
|
||
|
|||
| def_out |
|
||
| AETier |
|
||
| AEPor |
|
||
|
|||
| AEPor |
|
||
|
|||
| 3-tuple of integer, string, integer |
|
||
| object |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
| tuple of string ('task name', 'script name') |
|
||
| tuple of string ('task name', 'script name') |
|
||
| list |
|
||
| list of tuple ('task name', 'script name') |
|
||
| list of string |
|
||
| tuple of string ('task name', 'script name') |
|
||
|
|||
|
|||
| list of tuple ('task name', 'script name') |
|
||
|
|||
|
|||
|
|||
|
|||
| object |
|
||
| object |
|
||
|
|||
|
|||
|
|||
|
Inherited from Inherited from |
|||
|
|||
| AEState class |
STATE = ScriptStateClass to instantiate and use to store state information across all instances of this AEScript. |
||
|
|||
| dictionary |
after_chains Mapping from target task name to a list of task names which should be executed after the target : |
||
| dictionary |
around_chains Mapping from target task name to one task name which should be executed instead of the target : |
||
| dictionary |
around_tasks additional informations for an event task that is chained around another task : |
||
| dictionary |
before_chains Mapping from target task name to a list of task names which should be executed before the target : |
||
| dictionary |
chooser_tasks Connects a task to respond to a change in a AEChooser : |
||
| dictionary |
command_descriptions Description of the task to be shown in command chooser : |
||
| weakref.WeakValueDictionary of (AEInput.GestureList : tuple) |
commands Connects a task to a AEInput.GestureList sequence on some AEInput device. |
||
| dictionary |
cyclic_input_tasks Connects more than one task to a AEInput.GestureList sequence on some AEInput device. |
||
| dictionary |
def_out Default output device to use for all Output.say calls in a AEScript module : |
||
| dictionary |
event_tasks Notes which tasks are bind to which event type on which event layer : |
||
| list of string |
out_caps Capabilities set by setIdealOutput as ideal for output from this AEScript. |
||
| weakref.WeakKeyDictionary |
registered_modifiers Mapping from device to a registered modifier for that device |
||
| dictionary |
registered_tasks All task wich are registered with the registerTask method in this AEScript. |
||
| ScriptState |
state Settings for this AEScript. |
||
| AETier |
tier The tier for the application this script belongs to. |
||
|
|||
|
Inherited from |
|||
|
|||
Note: Script writers should override init to do initialization, not this method. |
Note: Script writers should override init to do initialization, not this method. |
|
Note: Script writers should override close to do finialization, not this method. |
|
|
|
|
|
|
|
|
|
|
|
Note: The values returned by this event are platform specific. This may change in the future. Are you sure you don't want to use a task to response to an AEInput.Gesture? |
Gets the value previously stored under the given name using AETier.setTempVal. See that method for details. If no value has been stored under the given name,None is
returned.
|
Stores the given value under the given name. The data will be available via AETier.getTempVal to all tasks executing or updating in response to the current AEEvent. Once the event has been handled by all tasks, all stored information is discarded automatically. The name must be an immutable object. The value can be an arbitrary object. Only the value from the most recent call with a given name is stored.
|
Registers a new AEScript task under the given name if no task is already registered with that name in this AEScript. Only one task can be registered under a name in a AEScript. If a task is already registered under the given name, any other registration with that name is ignored. Tasks that will also be bind to an event can specify an update function. This function will be called when another task forbids the execution of other tasks. The update function allows a task to do necessary actions like state changes.
|
|
Registeres a cyclic_input_task and/or links another task to it. A cyclic input task links several tasks together. Every time the cyclic input task is executed it calls the next linked task. This is usefull, to connect more than one task to a keyboard command. This method links one task to the end of a list of tasks, that are already linked to the cyclic input task.
Note: The task with the task_name must already be registered as a task, before it can be linked to a cyclic input task. |
Note: If you use this method all tasks must be implemented in the same script. Otherwise use the registerCyclicInputTask directly and specify a script name. |
|
|
Bindes a script task to an event type. The type determines which kind of AEEvent will trigger the execution of the registered_tasks. If one or more tasks are already registered for this type, the given task will be inserted at the top of the registered stack of tasks (i.e. it will be executed first for the appropriate event). The focus, tier, and background parameters
specify on which layer the task will handle events. If focus is
True to register the given
task on each selected layer in one call. If all three parameters are
False, the registration defaults to the focus layer.
|
|
|
|
|
|
|
See Also: bindToEvent |
Gets the task registered in this AEScript only to execute in response to the given AEInput.GestureList. Called by AETier.AETier.getCommandTask during a search through all AEScripts in the owning AETier for the given key list.
|
Gets a chooser_tasks registered to respond to a certain
chooser.
|
Gets the execute and update functions for the task if it is registered
in this AEScript only. If no task is registered under the
given key in this AEScript, returns
|
Get all tasks registered to handle the given AEEvent type in this AEScript only. Called by AETier.getEventTasks during a search through all AEScripts in the owning AETier for the given task type.
|
|
|
Links a task to the one named in target. The task will be added either before, after, or around depending on the value of link. Does not allow a task to link to itself (i.e. name cannot equal target). Invokes AETier.addChainRef to add a reference to this AEScript to the AETier which will later have to traverse the chain across AEScripts. Chains the task with the given name to the target task. If link is CHAIN_BEFORE, the linked task will execute before the target. If link is CHAIN_AFTER, the linked task will execute after. If link is CHAIN_AROUND, the linked task will execute in lieu of the target, but can execute the target manually using doTask.
|
Unlinks a task from the one named in target. The task will be unlinked
either before, after, or around depending on the value of link. If link
is Invokes AETier.removeChainRef to delete a reference to this AEScript to the AETier which will later have to traverse the chain across AEScripts. Unchains the task with the given name to the target task. The link parameter has the same meaning as in chainTask. If link is set toNone, one
reference to the named task is removed from the before, after, and around
chains.
Note: The target task must be registered at the time of invocation. |
|
|
|
Immediately executes a task registered under the given name in this AETier. Keyword arguments for task execution may be provided. The AEPor of this task is always provided to the task being executed and this task's AEPor is updated with the value of the pointer after the other task has finished execution. The chain parameter dictates whether only the registered_tasks is executed (False), or if
all other tasks chained to it are as well (True). The
propagate parameter determines whether the execute or update method is
called on the task. This param is not typically specified by a task or AEScript. It is used internally by a cyclic_input_tasks to handle the propagation flag in
task chains.
|
Note: KeyError inherits LookupError |
Gets the AEScript AEState.Setting variable with the given name. This method should be used when a script wants to access its own settings. If a script needs to access the settings of another script use the System.getScriptSetting method.
|
Gets the value of the AEScript AEState.Setting state variable with the given name. This method should be used when a script wants to access its own settings. If a script needs to access the settings of another script use the System.getScriptSettingVal method.
|
Sets the value of the AEScript AEState.Setting state variable with the given name. This method should be used when a script wants to set its own settings. If a script needs to set the settings of another script use the System.setScriptSettingVal method.
|
|
|||
STATEClass to instantiate and use to store state information across all instances of this AEScript. Defaults to the AEState base class, but can be overridden with a subclass of AEState.
|
|
|||
after_chainsMapping from target task name to a list of task names which should be executed after the target :
Dictionary {
key: ('task name', 'script name'),
value: list of [('task name', 'script name')]
}
|
around_chainsMapping from target task name to one task name which should be executed instead of the target :
Dictionary {
key: ('task name', 'script name'),
value: ('task name', 'script name')
}
|
around_tasksadditional informations for an event task that is chained around another task :
Dictionary {
key: 'new task name',
value: ['replaced task name', 'replaced task script', AEScript,
execute_function, update_function, ['functions_to_replace']]
}
|
before_chainsMapping from target task name to a list of task names which should be executed before the target :
Dictionary {
key: ('task name', 'script name'),
value: list of [('task name', 'script name')]
}
|
chooser_tasksConnects a task to respond to a change in a AEChooser :
Dictionary {
key: id(AEChooser),
value: ('task name', 'script name')
}
|
command_descriptionsDescription of the task to be shown in command chooser :
Dictionary {
key: 'task name',
value: string
}
|
commandsConnects a task to a AEInput.GestureList sequence on some AEInput device. The task name needs to be hashed into the registered_tasks dictionary to fully resolve the task. :
WeakValueDictionary {
key: AEInput.GestureList,
value: ('task name', 'script name')
}
|
cyclic_input_tasksConnects more than one task to a AEInput.GestureList sequence on some AEInput device. When the action code of the AEInput.GestureList is activated once the first task will be executed. The second time the action code is activated the second task will be executed, and so on...:
Dictionary {
key: ('cycle name', 'script name'),
value: [ ('task name', 'script name') ]
}
|
def_outDefault output device to use for all Output.say calls in a AEScript module :
Dictionary {
key: Script
value: weakref.proxy to AEOutput
}
|
event_tasksNotes which tasks are bind to which event type on which event layer :
Dictionary {
key: (AEEvent-Type-Class, layer),
value: [ ('task name', 'script name') ]
}
|
out_capsCapabilities set by setIdealOutput as ideal for output from this AEScript. These are used to "late bind" a device for use during execution of this AEScript and its tasks. Defaults to audio.
|
registered_tasksAll task wich are registered with the registerTask method in this AEScript. This dictionary connects the name of the task to the associated execute and update functions. Furthermore it notes to which cyclic input task this task belongs :
Dictionary {
key: ('task name', 'script name'),
value: [execute_function, update_function, [ ('cycle name', 'script name') ]]
}
|
stateSettings for this AEScript. Defaults to an empty ScriptState object that can be used to store state information that is not configurable or persistable unless STATE is specified.
|
| Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0beta1 on Mon Jun 30 13:05:56 2008 | http://epydoc.sourceforge.net |