Task :: MouseTask :: MouseTask :: Class MouseTask

[frames] | no frames]

Class MouseTask

          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 --+    
                                   |    
                 EventTask.EventTask --+
                                       |
                                      MouseTask

Executed when a mouse moves or mouse buttons are pressed.

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

class

getEventType(self)
Returns: Type of AEEvent this Task wants to handle

source code

update(self, kind, button, pos, **kwargs)
Updates this Task in response to a consumed mouse event.

source code

boolean

execute(self, kind, pos, button, **kwargs)
Executes this Task in response to a mouse event.

source code

boolean

executeMoved(self, pos, **kwargs)
Executes this Task in response to a mouse movement.

source code

boolean

executePressed(self, button, **kwargs)
Executes this Task in response to a mouse button press.

source code

boolean

executeReleased(self, button, **kwargs)
Executes this Task in response to a mouse button release.

source code

Inherited from EventTask.EventTask: __init__, getEventLayers

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 EventTask.EventTask: layers

Inherited from Base.Task: ident

Properties

Inherited from object: __class__

Method Details

getEventType(self)

Returns: class: Type of AEEvent this Task wants to handle
Overrides: EventTask.EventTask.getEventType

update(self, kind, button, pos, **kwargs)

Updates this Task in response to a consumed mouse event. Called by Tier.Tier._executeTask.

Parameters:

kind (integer) - Kind of event
pos (2-tuple of integer) - Absolute position of the mouse pointer
button (integer) - Number of the button pressed

Overrides: Base.Task.update

execute(self, kind, pos, button, **kwargs)

Executes this Task in response to a mouse event. Called by Tier.Tier._executeTask.

Parameters:

kind (integer) - Kind of event
pos (2-tuple of integer) - Absolute position of the mouse pointer
button (integer) - Number of the button pressed or released

Returns: boolean

True to allow other Tasks to process this event

Overrides: Base.Task.execute

executeMoved(self, pos, **kwargs)

Executes this Task in response to a mouse movement.

Parameters:

pos (2-tuple of integer) - Absolute position of the mouse pointer

Returns: boolean

True to allow other Tasks to process this event

executePressed(self, button, **kwargs)

Executes this Task in response to a mouse button press.

Parameters:

button (integer) - Number of the button pressed

Returns: boolean

True to allow other Tasks to process this event

executeReleased(self, button, **kwargs)

Executes this Task in response to a mouse button release.

Parameters:

button (integer) - Number of the button released

Returns: boolean

True to allow other Tasks to process this event