Task :: CaretTask :: CaretTask :: Class CaretTask

Class CaretTask

          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 --+
                                       |
                                      CaretTask

Executed when a caret change occurs.

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

[hide private]

class

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

source code

update(self, por, text, text_offset, added, layer, **kwargs)
Updates this Task in response to a consumed caret change event.

source code

boolean

execute(self, por, text, text_offset, added, layer, **kwargs)
Executes this Task in response to a caret change event.

source code

boolean

executeInserted(self, por, text, text_offset, layer, **kwargs)
Executes this Task in response to a caret insert event.

source code

boolean

executeMoved(self, por, text, text_offset, layer, **kwargs)
Executes this Task in response to a caret movement event.

source code

boolean

executeDeleted(self, por, text, text_offset, layer, **kwargs)
Executes this Task in response to a caret delete event.

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

[hide private]

Inherited from Tools.Output.Output: may_stop

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

Instance Variables

[hide private]

Inherited from EventTask.EventTask: layers

Inherited from Base.Task: ident

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

getEventType(self)

source code

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

update(self, por, text, text_offset, added, layer, **kwargs)

source code

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

Parameters:

por (POR) - Point of regard for the related accessible
text (string) - The text inserted, deleted or the line of the caret
text_offset (integer) - The offset of the inserted/deleted text or the absolute offset when movement only
added (boolean) - True when text added, False when text deleted, and None (the default) when event is for caret movement only
layer (integer) - Layer on which the event occurred

Overrides: Base.Task.update

execute(self, por, text, text_offset, added, layer, **kwargs)

source code

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

Parameters:

por (POR) - Point of regard for the related accessible
text (string) - The text inserted, deleted or the line of the caret
text_offset (integer) - The offset of the inserted/deleted text or the absolute offset when movement only
added (boolean) - True when text added, False when text deleted, and None (the default) when event is for caret movement only
layer (integer) - Layer on which the event occurred

Returns: boolean

True to allow other Tasks to process this event

Overrides: Base.Task.execute

executeInserted(self, por, text, text_offset, layer, **kwargs)

source code

Executes this Task in response to a caret insert event. Called by execute.

Parameters:

por (POR) - Point of regard for the related accessible
text (string) - The text inserted, deleted or the line of the caret
text_offset (integer) - The offset of the inserted/deleted text or the absolute offset when movement only
layer (integer) - Layer on which the event occurred

Returns: boolean

True to allow other Tasks to process this event

executeMoved(self, por, text, text_offset, layer, **kwargs)

source code

Executes this Task in response to a caret movement event. Called by execute.

Parameters:

por (POR) - Point of regard for the related accessible
text (string) - The text inserted, deleted or the line of the caret
text_offset (integer) - The offset of the inserted/deleted text or the absolute offset when movement only
layer (integer) - Layer on which the event occurred

Returns: boolean

True to allow other Tasks to process this event

executeDeleted(self, por, text, text_offset, layer, **kwargs)

source code

Executes this Task in response to a caret delete event. Called by execute.

Parameters:

por (POR) - Point of regard for the related accessible
text (string) - The text inserted, deleted or the line of the caret
text_offset (integer) - The offset of the inserted/deleted text or the absolute offset when movement only
layer (integer) - Layer on which the event occurred

Returns: boolean

True to allow other Tasks to process this event