Package AccessEngine :: Package AEConstants :: Module Output
[hide private]
[frames] | no frames]

Module Output

source code

Output related constants.


Authors:
Peter Parente, Scott Haeger

Organization: IBM Corporation

Copyright: Copyright (c) 2005, 2007 IBM Corporation

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

Variables [hide private]
integer CMD_NOOP = 0
No-op command for all devices.
integer CMD_STOP = 1
Instruct the output device to stop.
integer CMD_TALK = 2
Instruct the output device to send buffered data.
integer CMD_STRING = 3
Instruction indicating that a string is being sent to an output device.
integer CMD_FILENAME = 5
Instruction indicating that a file name is being sent to an output device.
integer CMD_GET_CLOSEST_LANG = 8
Instruction indicating that an output device should output the closest language possible.
  BRAILLE_CMD = 0x0010
integer CMD_CARET = BRAILLE_CMD | 0x0001
Braille command used to retrieve current caret position.
integer CMD_TRUNCATE = BRAILLE_CMD | 0x0002
Braille command used to retrieve right and left text trucation indicators.
integer CMD_GET_ELLIPSIS_SIZE = BRAILLE_CMD | 0x0003
Braille command to retrieve both left and right ellipsis sizes as number of cells.
integer CMD_GET_MISSINGCELL_COUNT = BRAILLE_CMD | 0x0004
Braille command to retrieve the number of missing or broken cells.
integer CMD_INDEX = 7
Instruction indicating that an output device is receiving an index marker.
integer CMD_STRING_SYNC = 4
Instruction indicating that an output device should buffer the given string.
integer CMD_GOTO = 9
Magnifier command instructing magnifier to goto a specified screen position.
integer CMD_GET_ROI = 10
Magnifier command used to retrieve the region of interest from the magnifier device.
integer CARET_NONE = 0
Braille command indicating no caret will be used.
integer CARET_TWO_BOTTOM = 1
Braille command indicating the bottom two pins will be used to represent the caret.
integer CARET_BOTTOM_RIGHT = 2
Braille command indicating the bottom right pin will be used to represent the caret.
  CARET_ALL = 3
integer CARET_LAST = 3
Constant representing last caret type.
integer ELLIPSIS_CONTINUATION = 0
Braille command indicating that the continuation symbol will be used for the ellipsis.
integer ELLIPSIS_ELLIPSIS = 1
Braille command indicating that the ellipsis symbol will be used for the ellipsis.
integer ELLIPSIS_LAST = 1
Constant representing last ellipsis type.
dictionary OUTPUT_COMMAND_NAMES = dict([(value, name.lower() [4:].replace...
Dictionary containing all output commands.
Variables Details [hide private]

CARET_LAST

Constant representing last caret type. Used for iterating through caret types.
Type:
integer
Value:
3

ELLIPSIS_LAST

Constant representing last ellipsis type. Used for iterating through ellipsis types.
Type:
integer
Value:
1

OUTPUT_COMMAND_NAMES

Dictionary containing all output commands.
Type:
dictionary
Value:
dict([(value, name.lower() [4:].replace('_', ' ')) for name, value in \
locals().items() if name.startswith('CMD_')])