Trees       Indices       Help   
Task :: Tools :: Output :: Output :: Class Output
[hide private]
[frames] | no frames]

Class Output

source code

    object --+    
             |    
Base.TaskTools --+
                 |
                Output

Provides methods for doing output on any AEOutput device.

Instance Methods [hide private]
 
setPerkIdealOutput(self, *capabilities)
Sets the ideal device capabilities to be used to locate a device for all output methods invoked from the caller's Perk module, including the Perk class itself and all of its registered Tasks.		 source code
list of string
getPerkIdealOutput(self)
Gets the ideal device capabilities to locate a device to be used by all output methods invoked from the caller's Perk module, including the Perk class itself and all of its registered Tasks.		 source code
AEOutput
getOutputDevice(self, name=None, *capabilities)
Gets an AEOutput device from the DeviceManager given its name or its capabilities.		 source code
 
stopNow(self, dev=None, sem=None, layer=None, reset=True)
Tells the referenced output device to interrupt current output and clear buffered data.		 source code
boolean
mayStop(self, dev=None, sem=None, layer=None)
Stops the device if may_stop is zero.		 source code
 
inhibitMayStop(self)
Prevents the next call to mayStop from stopping the device provided to that call.		 source code
 
stopAll(self, dev=None)
Tells the referenced output device to interrupt current output and clear buffered data.		 source code
 
play(self, filename, sem=None, layer=None, dev=None, talk=True)
Outputs the contents of a file.		 source code
 
say(self, text, por=None, sem=None, layer=None, dev=None, talk=True)
Sends a string of text to a device that supports string display.		 source code
object
send(self, name, value, sem=None, layer=None, dev=None)
Sends arbitrary data to a device.		 source code
AEOutput.Style
getStyle(self, dev=None, sem=None, layer=None)
Gets the AEOutput.Style object for the given device, semantic tag, and event layer.		 source code
AEState.Setting
getStyleSetting(self, name, dev=None, sem=None, layer=None)
Gets the AEOutput.Style object for the given device, semantic tag, and event layer, then immediately fetches the AEState.Setting object with the given name.		 source code
object
getStyleVal(self, name, dev=None, sem=None, layer=None)
Gets the AEOutput.Style object for the given device, semantic tag, and event layer, then immediately fetches the value of the AEState.Setting object with the given name.		 source code
 
setStyleVal(self, name, val, dev=None, sem=None, layer=None)
Gets the AEOutput.Style object for the given device, semantic tag, and event layer, then immediately sets the value of the AEState.Setting object with the given name.		 source code
boolean
sayTextAttrs(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccAllTextAttrs and outputs the result.		 source code
boolean
sayWord(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getWordText and outputs the result.		 source code
boolean
sayChar(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getCharText and outputs the result.		 source code
boolean
sayName(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccName and outputs the result.		 source code
boolean
sayLabel(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccLabel and outputs the result.		 source code
boolean
sayItem(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getItemText and outputs the result.		 source code
boolean
sayWindow(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getWindowTitle and outputs the result.		 source code
boolean
saySection(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccLabel and outputs the result.		 source code
boolean
sayApp(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAppName and outputs the result.		 source code
boolean
sayFont(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccTextAttr and outputs the value associated with the "family-name" property.		 source code
boolean
sayCount(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccCount and outputs the result.		 source code
boolean
sayIndex(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccIndex and outputs the result.		 source code
boolean
sayColor(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccTextAttr and outputs the value associated with the "fg-color" property.		 source code
boolean
sayRole(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccRoleName and outputs the result.		 source code
boolean
sayLevel(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccLevel and outputs the result.		 source code
boolean
sayStatus(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getItemText and outputs the result.		 source code
boolean
sayState(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getStateText and outputs the result.		 source code
boolean
sayDesc(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccDesc and outputs the result.		 source code
boolean
sayHotkey(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccClickKey and outputs the result after replacing <> characters.		 source code
boolean
sayError(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Outputs an LSR system error message.		 source code
boolean
sayInfo(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Outputs an informational LSR system message.		 source code
boolean
sayConfirm(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Outputs a confirmation message for a user action.		 source code
boolean
sayValue(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccFloatValue and outputs the result.		 source code
boolean
sayValueExtents(self, por=None, text=None, template=u'%s', dev=None, talk=True)
Calls Task.Tools.View.View.getAccFloatValueExtents and outputs the result.		 source code
 
setBrlCaretPosition(self, value, sem=None, layer=None, dev=None)
Sets caret location on the device.		 source code
object
setBrlTruncate(self, value, sem=None, layer=None, dev=None)
Sets a two-item tuple (left, right) to the device indicating if a line of text has been truncated either on the left or right side.		 source code
tuple
getBrlEllipsisSizes(self, sem=None, layer=None, dev=None)
Gets a two-item tuple (left and right) containing the ellipsis length.		 source code
integer
getBrlMissingCellCount(self, sem=None, layer=None, dev=None)
Gets the number of missing/broken cells defined by the "missing cell string" user setting.		 source code
 
setMagGoto(self, value, sem=None, layer=None, dev=None)
Sets the viewport of the magnifier		 source code
tuple
getMagROI(self, sem=None, layer=None, dev=None)
Get the region of interest from magnifier device		 source code
string
getClosestLang(self, tag, sem=None, layer=None, dev=None)
Get the closest language supported by the device to the one given by the IANA tag.		 source code

Inherited from Base.TaskTools: __init__, close, init, postClose, postExecute, preExecute, preInit

Inherited from Base.TaskTools (private): _changeDefaultOutput

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables [hide private]
integer may_stop = 0
Count of the number of calls to inhibitMayStop.
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

setPerkIdealOutput(self, *capabilities)

source code 

Sets the ideal device capabilities to be used to locate a device for all output methods invoked from the caller's Perk module, including the Perk class itself and all of its registered Tasks. The capabilities list should include strings naming AEOutput interfaces ("audio" and/or "braille") at present.

Parameters:
  • capabilities (list of string) - Names of capabilities required on the device

getPerkIdealOutput(self)

source code 

Gets the ideal device capabilities to locate a device to be used by all output methods invoked from the caller's Perk module, including the Perk class itself and all of its registered Tasks.

Returns: list of string
Names of capabilities set as ideal for a default output device

getOutputDevice(self, name=None, *capabilities)

source code 

Gets an AEOutput device from the DeviceManager given its name or its capabilities. The capabilities list may include strings naming AEOutput interfaces ("audio" and/or "braille" at present).

If neither is specified, the first available output device in the DeviceManager is returned.

Parameters:
  • name (string) - Class (UIE) name of the AEOutput device to get
  • capabilities (list of string) - Names of capabilities required on the device
Returns: AEOutput
The named output device
Raises:

stopNow(self, dev=None, sem=None, layer=None, reset=True)

source code 

Tells the referenced output device to interrupt current output and clear buffered data.

Parameters:
  • dev (AEOutput.Base) - The device to send the stop to; defaults to None for the default output device
  • sem (integer) - The semantic information to stop; defaults to None for the default semantic
  • layer (integer) - Layer on which the event occurred
  • reset (boolean) - Reset the may_stop count (True) or leave it as-is when sending the stop?

mayStop(self, dev=None, sem=None, layer=None)

source code 

Stops the device if may_stop is zero. When non-zero, decrements the count.

Parameters:
  • dev (AEOutput.Base) - The device to send the stop to; defaults to None for the default output device
  • sem (integer) - The semantic information to stop; defaults to None for the default semantic
  • layer (integer) - Layer on which the event occurred
Returns: boolean
Was the stop processed (True) or inhibited (False)?

inhibitMayStop(self)

source code 

Prevents the next call to mayStop from stopping the device provided to that call. Adds one to the may_stop flag.

stopAll(self, dev=None)

source code 

Tells the referenced output device to interrupt current output and clear buffered data. Unlike stopNow, this ignores the layer on which the method was called and any semantic information. Everything on the device is stopped, even when TierManager.LSRState stopping setting is False.

Parameters:
  • dev (AEOutput.Base) - The device to send the stop to; defaults to None for the default output device

play(self, filename, sem=None, layer=None, dev=None, talk=True)

source code 

Outputs the contents of a file. The device used to do the output gets to decide what to do with the file based on its contents and the semantic tag and event layer information given.

Parameters:
  • filename (string) - Name of the file to be output
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • layer (integer) - Layer on which the event occurred
  • dev (AEOutput.Base) - The device to send the filename to; defaults to None for the default output device
  • talk (boolean) - Send a talk command immediately following the filename?

say(self, text, por=None, sem=None, layer=None, dev=None, talk=True)

source code 

Sends a string of text to a device that supports string display. If talk is False, the device should buffer the text until another method call occurs which sends a Talk to the device.

Parameters:
  • text (string) - Text to output
  • por (POR) - The point of regard of the start of text, or None when the text is not from the screen
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • layer (integer) - Layer on which the event occurred
  • dev (AEOutput.Base) - The device to send the text to; defaults to None for the default output device
  • talk (boolean) - Send a talk command immediately following the string?

send(self, name, value, sem=None, layer=None, dev=None)

source code 

Sends arbitrary data to a device. The device must recognize the name in order to decide what to do with the value data.

This is a generic method which receives all content and commands to be rendered and executed on a device. Standard name identifiers should be used whenever possible. For instance, AEConstants.Output.CMD_STOP and AEConstants.Output.CMD_TALK. However, device specific names and values are certainly possible.

Only use this method if no other output method is suitable for your purposes.

Parameters:
  • name (object) - Descriptor of the data value sent
  • value (object) - Content value
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • layer (integer) - Layer on which the event occurred
  • dev (AEOutput) - Device that should receive the command
Returns: object
Return value specific to the given command

getStyle(self, dev=None, sem=None, layer=None)

source code 

Gets the AEOutput.Style object for the given device, semantic tag, and event layer. This is a low level method that allows direct access to AEOutput.Style style objects.

Parameters:
  • dev (AEOutput.Base) - The device on which to get the value; defaults to None for the default output device.
  • sem (integer) - The semantic on which to get the value.
  • layer (integer) - Layer on which to get the value, focus, tier, or background
Returns: AEOutput.Style
The style object or None if one does not exist

See Also: getStyleSetting

getStyleSetting(self, name, dev=None, sem=None, layer=None)

source code 

Gets the AEOutput.Style object for the given device, semantic tag, and event layer, then immediately fetches the AEState.Setting object with the given name. This is a low level method that allows direct access to AEState.Settings on the style. It is permissible to read/write the value property of settings fields and register for change notifications.

Parameters:
  • name (string) - Name of the setting object to fetch
  • dev (AEOutput.Base) - The device on which this setting should be changed. Defaults to the default output device established by setPerkIdealOutput.
  • sem (integer) - The semantic on which to change the value. Defaults to None meaning the default style
  • layer (integer) - Layer on which to set the value: focus, tier, or background. Defaults to the event layer that triggered this Task.
Returns: AEState.Setting
The setting object
Raises:

Attention: If a method attached to a Perk or Task is used as a callback for a style value change notification, be aware that the Perk or Task will NOT be pre-executed when the callback runs with all references needed by the Task.Tools.

getStyleVal(self, name, dev=None, sem=None, layer=None)

source code 

Gets the AEOutput.Style object for the given device, semantic tag, and event layer, then immediately fetches the value of the AEState.Setting object with the given name.

Parameters:
  • name (string) - Name of the setting value to fetch
  • dev (AEOutput.Base) - The device on which this setting should be changed. Defaults to the default output device established by setPerkIdealOutput.
  • sem (integer) - The semantic on which to change the value. Defaults to None meaning the default style
  • layer (integer) - Layer on which to set the value: focus, tier, or background. Defaults to the event layer that triggered this Task.
Returns: object
The setting value
Raises:

setStyleVal(self, name, val, dev=None, sem=None, layer=None)

source code 

Gets the AEOutput.Style object for the given device, semantic tag, and event layer, then immediately sets the value of the AEState.Setting object with the given name.

Parameters:
  • name (string) - Name of the setting value to fetch
  • val (object) - The setting value
  • dev (AEOutput.Base) - The device on which this setting should be changed. Defaults to the default output device established by setPerkIdealOutput.
  • sem (integer) - The semantic on which to change the value. Defaults to None meaning the default style
  • layer (integer) - Layer on which to set the value: focus, tier, or background. Defaults to the event layer that triggered this Task.
Raises:

sayTextAttrs(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccAllTextAttrs and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayWord(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getWordText and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayChar(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getCharText and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayName(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccName and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayLabel(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccLabel and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayItem(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getItemText and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayWindow(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getWindowTitle and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

saySection(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccLabel and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayApp(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAppName and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayFont(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccTextAttr and outputs the value associated with the "family-name" property.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayCount(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccCount and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayIndex(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccIndex and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayColor(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccTextAttr and outputs the value associated with the "fg-color" property.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayRole(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccRoleName and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayLevel(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccLevel and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayStatus(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getItemText and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayState(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getStateText and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayDesc(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccDesc and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayHotkey(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccClickKey and outputs the result after replacing <> characters.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayError(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Outputs an LSR system error message. POR ignored.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayInfo(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Outputs an informational LSR system message. POR ignored.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayConfirm(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Outputs a confirmation message for a user action. POR ignored.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayValue(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccFloatValue and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

sayValueExtents(self, por=None, text=None, template=u'%s', dev=None, talk=True)

source code 

Calls Task.Tools.View.View.getAccFloatValueExtents and outputs the result.

Parameters:
  • por (POR) - POR pointing at an accessible whose value will be read or None when the task_por should be used. The value is read only if the text parameter is None.
  • text (string) - Manually provided text fetched from the POR
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the POR is spoken by itself.
  • dev (AEOutput.Base) - The device to use for output. Defaults to the default output device established by setPerkIdealOutput.
  • talk (boolean) - Send a AEConstants.Output.CMD_TALK immediately after this string is sent?
Returns: boolean
Was anything sent for output (True) or was text None (False)?

setBrlCaretPosition(self, value, sem=None, layer=None, dev=None)

source code 

Sets caret location on the device.

Parameters:
  • value (integer) - Caret position
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • layer (integer) - Layer on which the event occurred
  • dev (AEOutput) - Device that should receive the command

setBrlTruncate(self, value, sem=None, layer=None, dev=None)

source code 

Sets a two-item tuple (left, right) to the device indicating if a line of text has been truncated either on the left or right side.

Parameters:
  • value (tuple) - Two-item tuple of booleans (left, right) indicating trucation
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • layer (integer) - Layer on which the event occurred
  • dev (AEOutput) - Device that should receive the command
Returns: object
Return value specific to the given command

getBrlEllipsisSizes(self, sem=None, layer=None, dev=None)

source code 

Gets a two-item tuple (left and right) containing the ellipsis length.

Parameters:
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • layer (integer) - Layer on which the event occurred
  • dev (AEOutput) - Device that should receive the command
Returns: tuple
(left, right) ellipsis length

getBrlMissingCellCount(self, sem=None, layer=None, dev=None)

source code 

Gets the number of missing/broken cells defined by the "missing cell string" user setting.

Parameters:
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • layer (integer) - Layer on which the event occurred
  • dev (AEOutput) - Device that should receive the command
Returns: integer
Number of missing/broken cells

setMagGoto(self, value, sem=None, layer=None, dev=None)

source code 

Sets the viewport of the magnifier

Parameters:
  • value (tuple) - viewport settings in the form (x1, y1, x2, y2)
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • layer (integer) - Layer on which the event occurred
  • dev (AEOutput) - Device that should receive the command

getMagROI(self, sem=None, layer=None, dev=None)

source code 

Get the region of interest from magnifier device

Parameters:
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • layer (integer) - Layer on which the event occurred
  • dev (AEOutput) - Device that should receive the command
Returns: tuple
ROI as a four-item tuple in the form (x1, y1, x2, y2)

getClosestLang(self, tag, sem=None, layer=None, dev=None)

source code 

Get the closest language supported by the device to the one given by the IANA tag. See the AEOutput.Style.AudioStyle comment about languages for help on formatting a proper IANA tag.

Parameters:
  • tag (string) - IANA tag name
  • sem (integer) - Semantic tag indicating the kind of output; defaults to None for the default semantic.
  • layer (integer) - Layer on which the event occurred
  • dev (AEOutput) - Device that should receive the command
Returns: string
IANA tag name closest to the one given or None meaning no supported language makes sense

Class Variable Details [hide private]

may_stop

Count of the number of calls to inhibitMayStop. When greater than zero, the next call to mayStop will decrement the count. When zero, mayStop will send a stop to the output device.
Type:
integer
Value:
0

   Trees       Indices       Help   
Generated by Epydoc 3.0beta1 on Mon Jun 4 15:33:23 2007 http://epydoc.sourceforge.net