Module GdmScript :: Class GdmScript

[frames] | no frames]

Class GdmScript

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

A special AEScript for the gdm login screen. Registers tasks to announce the focused control on startup, typically the username field.

To Do: NA: test functions

Instance Methods

init(self)
Registers event tasks to handle view and caret change events.

source code

string

getName(self)
Return the name of the supported application.

source code

string

getDescription(self)
Describe which AETier this script applies to by default.

source code

boolean

onViewFirstGained(self, **kwargs)
Announces the control that has the focus on startup.

source code

boolean

onCaretChange(self, **kwargs)
Announces the changing label of the text box as it serves dual duty as the username and password field.

source code

Inherited from AccessEngine.AEScript.EventScript: chainNewEventTaskAround, executeAroundTask, onCaretDeleted, onCaretInserted, onCaretMoved, onChildAdded, onChildRemoved, onChildrenChange, onChooserChange, onChooserEnd, onChooserSignal, onChooserStart, 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, 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

Inherited from AccessEngine.AEScript.AEScript: STATE

Instance Variables

boolean first
If True then the text box requires the input of the username.

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

Inherited from object: __class__

Method Details

init(self)

Registers event tasks to handle view and caret change events.

Overrides: AccessEngine.AEScript.AEScript.init

getName(self)

Return the name of the supported application.

Returns: string: Translated name of the supported application.
Overrides: AccessEngine.AEUserInterface.AEUserInterface.getName

getDescription(self)

Describe which AETier this script applies to by default.

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

onViewFirstGained(self, **kwargs)

Announces the control that has the focus on startup.

Parameters:

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

Returns: boolean

True to allow other tasks to process this event.

Overrides: AccessEngine.AEScript.EventScript.onViewFirstGained

onCaretChange(self, **kwargs)

Announces the changing label of the text box as it serves dual duty as the username and password field.

Parameters:

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

Returns: boolean

True to allow other tasks to process this event.

Overrides: AccessEngine.AEScript.EventScript.onCaretChange

Instance Variable Details

first

If True then the text box requires the input of the username. If False then the text box requires the input of the password.

Type:: boolean