Trees       Indices       Help   
SUE - Revision 232
Package AccessEngine :: Package AccessEngineAPI :: Module Input
[hide private]
[frames] | no frames]

Module Input

source code

Defines methods for getting input on any AEInput device.

Authors:
Peter Parente, Nicole Anacker, Ramona Bunk
Organizations: Copyright:

License: The BSD License All rights reserved. This program and the accompanying materials are made available under the terms of the BSD license which accompanies this distribution, and is available at http://www.opensource.org/licenses/bsd-license.php

Functions [hide private]
AEInput
getInputDevice(name=None, *capabilities)
Gets an AEInput device from the AEDeviceManager given its name or its capabilities.		 source code
 
addInputModifiers(script, dev, *codes)
Adds the given device code as a modifier on the named AEInput device.		 source code
 
removeInputModifiers(script, dev, *codes)
Removes the given device code as a modifier on the named AEInput device.		 source code
Function Details [hide private]

getInputDevice(name=None, *capabilities)

source code 

Gets an AEInput device from the AEDeviceManager given its name or its capabilities. The capabilities list may include strings naming AEInput interfaces ("braille" and/or "system input" at present).

If neither is specified, the first available output device in the AEDeviceManager is returned.
Parameters:
  • name (string) - Class (UIE) name of the AEInput device to get
  • capabilities (list of string) - Names of capabilities required on the device
Returns: AEInput
The named output device
Raises:

addInputModifiers(script, dev, *codes)

source code 
Adds the given device code as a modifier on the named AEInput device. If the device doesn't support modifiers, ignores the error since it's a non-critical operation.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • dev (AEInput) - Reference to an input device
  • codes (list of integer) - Action codes to add as modifiers

removeInputModifiers(script, dev, *codes)

source code 
Removes the given device code as a modifier on the named AEInput device. If the device doesn't support modifiers, ignores the error since it's a non-critical operation.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • dev (AEInput) - Reference to an input device
  • codes (list of integer) - Action codes to add as modifiers

   Trees       Indices       Help   
SUE - Revision 232
Generated by Epydoc 3.0beta1 on Mon Jun 30 13:05:47 2008 http://epydoc.sourceforge.net