Task :: CyclicInputTask :: CyclicInputTask :: Class CyclicInputTask

[frames] | no frames]

Class CyclicInputTask

          object --+                    
                   |                    
Tools.Base.TaskTools --+                
                       |                
     Tools.Output.Output --+            
                           |            
          object --+       |            
                   |       |            
Tools.Base.TaskTools --+   |            
                       |   |            
       Tools.Input.Input --+            
                           |            
          object --+       |            
                   |       |            
Tools.Base.TaskTools --+   |            
                       |   |            
         Tools.View.View --+            
                           |            
          object --+       |            
                   |       |            
Tools.Base.TaskTools --+   |            
                       |   |            
       Tools.Utils.Utils --+            
                           |            
          object --+       |            
                   |       |            
Tools.Base.TaskTools --+   |            
                       |   |            
     Tools.System.System --+            
                           |            
                   Tools.All --+        
                               |        
                  object --+   |        
                           |   |        
               UIElement.UIE --+        
                               |        
                       Base.Task --+    
                                   |    
                 InputTask.InputTask --+
                                       |
                                      CyclicInputTask

Executes when an input gesture occurs. In turn, this task will execute the next named Task.InputTasks stored in this object.

Unlike other Task classes, this one is unlikely to be subclassed. The common use is to instantiate it directly with names of other input tasks and bind it to an input command.

This class registers its name and whether it should be monitored by default in an AEMonitor using the Base.registerTaskType function when this module is first imported. The AEMonitor can use this information to build its menus.

Instance Methods

__init__(self, ident, *names)
Stores a sequence of named InputTasks to execute.

source code

boolean

execute(self, cycle_count, layer, **kwargs)
Executes the next named Task in the cycle in response to an input gesture.

source code

boolean

update(self, cycle_count, layer, **kwargs)
Executes the next named Task in the cycle in response to an input gesture.

source code

Inherited from Base.Task: getIdentity, getPath, getPerk

Inherited from Tools.Output.Output: getBrlEllipsisSizes, getBrlMissingCellCount, getClosestLang, getMagROI, getOutputDevice, getPerkIdealOutput, getStyle, getStyleSetting, getStyleVal, inhibitMayStop, mayStop, play, say, sayApp, sayChar, sayColor, sayConfirm, sayCount, sayDesc, sayError, sayFont, sayHotkey, sayIndex, sayInfo, sayItem, sayLabel, sayLevel, sayName, sayRole, saySection, sayState, sayStatus, sayTextAttrs, sayValue, sayValueExtents, sayWindow, sayWord, send, setBrlCaretPosition, setBrlTruncate, setMagGoto, setPerkIdealOutput, setStyleVal, stopAll, stopNow

Inherited from Tools.Input.Input: addInputModifiers, getInputDevice, registerCommand, removeInputModifiers, unregisterCommand

Inherited from Tools.View.View: compareAncestorRoles, copyAccText, cutAccText, deleteAccText, deselectAccText, doAction, findAccByName, findAccByObjId, findAccByPredicate, findAccByRole, getAccActionDescs, getAccActionKeys, getAccActionNames, getAccAllTextAttrs, getAccAnchorCount, getAccAppLocale, getAccAtRowColumn, getAccAttrs, getAccCaret, getAccClickKey, getAccColumn, getAccColumnHeader, getAccCount, getAccDefTextAttrs, getAccDesc, getAccFloatValue, getAccFloatValueExtents, getAccFocus, getAccFromPath, getAccIndex, getAccLabel, getAccLevel, getAccName, getAccPosInSet, getAccPosition, getAccRelations, getAccRole, getAccRoleName, getAccRow, getAccRowHeader, getAccSetSize, getAccTableExtents, getAccText, getAccTextAttr, getAccTextBetween, getAccTextLength, getAccTextSelection, getAccTextSelectionCount, getAccURI, getAccVisualExtents, getAccVisualPoint, getAllSelected, getAppName, getCharText, getChildAcc, getCurrItem, getCurrRow, getCurrWord, getEndAcc, getEndOfHardLine, getFirstPeerAcc, getFirstSelected, getItemText, getLastAccUnder, getLastChar, getLastKey, getLastPeerAcc, getLastWord, getNextAcc, getNextChar, getNextItem, getNextPeerAcc, getNextRow, getNextWord, getParentAcc, getPointerPOR, getPrevAcc, getPrevChar, getPrevItem, getPrevPeerAcc, getPrevRow, getPrevWord, getRootAcc, getStartOfHardLine, getStateText, getViewRootAcc, getWindowTitle, getWordText, hasAccRole, hasAccState, hasOneAccRole, hasOneAccState, inhibitAutoPointer, insertAccText, iterAncestorAccs, iterNextAccs, iterNextItems, iterPrevAccs, iterPrevItems, leftClickPOR, mouseEventPOR, moveToEnd, moveToItemStart, moveToPOR, moveToPointer, moveToRoot, pasteAccText, selectAccText, setAccCaret, setAccDeselected, setAccFocus, setAccPOR, setAccSelected, setAccText, setAccTextAttrs, setAllDeselected, setAllSelected, setPointerPOR

Inherited from Tools.Utils.Utils: convertPOSIXToIANA, getColorString

Inherited from Tools.System.System: associateDevice, associateMonitor, associatePerk, blockNTasks, chainTask, disassociateDevice, disassociateMonitor, disassociatePerk, doTask, getAnchorPerkClassName, getAnchorTaskId, getChooserClassNames, getChooserDescriptions, getChooserMetadata, getChooserNames, getDeviceClassNames, getDeviceDescriptions, getDeviceMetadata, getDeviceNames, getDeviceState, getEventTasks, getHistory, getMonitorClassNames, getMonitorDescriptions, getMonitorMetadata, getMonitorNames, getNamedTask, getPerkByName, getPerkClassNames, getPerkDescriptions, getPerkHistory, getPerkMetadata, getPerkNames, getPerkSetting, getPerkSettingVal, getPerkState, getPerkTaskNames, getPerkVar, getProfileName, getTaskHistory, getTempVal, getTierEventTasks, getTierNamedTask, getTierTaskNames, insertPerk, loadAllMonitors, loadChooser, loadMonitor, popPerk, popThisPerk, pushPerk, refreshDevices, registerConstants, registerTask, reloadPerks, setPerkSettingVal, setPerkVar, setTempVal, unchainTask, unloadAllMonitors, unloadChooser, unloadMonitor, unregisterTask

Inherited from Tools.System.System (private): _getClassNames, _getDescriptions, _getNames, _getUIEInstances

Inherited from Tools.Base.TaskTools: close, init, postClose, postExecute, preExecute, preInit

Inherited from Tools.Base.TaskTools (private): _changeDefaultOutput

Inherited from UIElement.UIE: getClassName, getDescription, getName

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

Class Variables

Inherited from Tools.Output.Output: may_stop

Inherited from Tools.View.View (private): _state_descriptions

Instance Variables

Inherited from Base.Task: ident

Properties

Inherited from object: __class__

Method Details

init(self, ident, names)
(Constructor)*

Stores a sequence of named InputTasks to execute.

Parameters:

ident (string) - Programmatic identifier
names (list of string) - Names of Tasks that should be executed

Overrides: Base.Task.__init__

execute(self, cycle_count, layer, **kwargs)

Executes the next named Task in the cycle in response to an input gesture. Called by Tier.Tier._executeTask.

Parameters:

cycle_count (integer) - Task index in sequence to execute
layer (integer) - Layer on which the event occurred, ignored here but pulled out of kwargs so kwargs can be passed directly to doTask
kwargs (dictionary) - Dictionary containing parameters passed to a task.

Returns: boolean

Should processing continue? Defaults to the return value from the invoked Task.

Overrides: Base.Task.execute

update(self, cycle_count, layer, **kwargs)

Executes the next named Task in the cycle in response to an input gesture. Called by Tier.Tier._executeTask.

Parameters:

cycle_count (integer) - Task index in sequence to execute
layer (integer) - Layer on which the event occurred, ignored here but pulled out of kwargs so kwargs can be passed directly to doTask
kwargs (dictionary) - Dictionary containing parameters passed to a task.

Returns: boolean

Should processing continue? Defaults to the return value from the invoked Task.

Overrides: Base.Task.update