Module SearchScript :: Class SearchScript

Class SearchScript

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

Manages the search dialog and performs search through accessible tree using query input by the user. It defines special hotkeys.

(Alt+Shift+S) - Open the search chooser.
(Alt+Shift+W) - Find previous element to be searched.
(Alt+Shift+E) - Find next element to be searched.

Instance Methods

[hide private]

init(self)
Registers event task to handle chooser change events.

source code

string

getName(self)
Provides the localized name of this AEScript.

source code

string

getDescription(self)
Describe what this AEScript do.

source code

findSearchNext(self, **kwargs)
Search through the accessible tree in the forward (down the tree) direction.

source code

findSearchPrev(self, **kwargs)
Search through the accessible tree in the backward (up the tree) direction.

source code

boolean

onChooserStart(self, timestamp=None, **kwargs)
Shows the Search chooser which allows a user to search the current view for a given accessible.

source code

boolean

onChooserEnd(self, **kwargs)
Runs when the chooser is closed by a repeat search key press, or the dialog is closed.

source code

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

Inherited from AccessEngine.AEScript.EventScript (private): _doReplacedTask

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.AEScript.AEScript (private): _changeDefaultOutput

Inherited from AccessEngine.AEUserInterface.AEUserInterface: getClassName, 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]

AEChooser chooser
Chooser when exists or None.

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 task to handle chooser 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

getDescription(self)

source code

Describe what this AEScript do.

Returns: string: Human readable translated description of this script.
Overrides: AccessEngine.AEUserInterface.AEUserInterface.getDescription

findSearchNext(self, **kwargs)

source code

Search through the accessible tree in the forward (down the tree) direction.

Parameters:

kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

findSearchPrev(self, **kwargs)

source code

Search through the accessible tree in the backward (up the tree) direction.

Parameters:

kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

onChooserStart(self, timestamp=None, **kwargs)

source code

Shows the Search chooser which allows a user to search the current view for a given accessible. Runs when an input gesture is given to start the chooser.

Parameters:

timestamp (float) - Time at which the event occurred
kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

Returns: boolean

Should processing continue? Always returns True by default.

Overrides: AccessEngine.AEScript.EventScript.onChooserStart

onChooserEnd(self, **kwargs)

source code

Runs when the chooser is closed by a repeat search key press, or the dialog is closed.

Parameters:

kwargs (dictionary) - Arbitrary keyword arguments to pass to the task

Returns: boolean

Should processing continue? Always returns True by default.

Overrides: AccessEngine.AEScript.EventScript.onChooserEnd