orca.rolenames (version 1831, $Date: 2007-03-12 16:23:35 -0400 (Mon, 12 Mar 2007) $)
index
/usr/lib/python2.5/site-packages/orca/rolenames.py

Provides a methods that converts the role name of an Accessible
object into localized strings for speech and braille.

 
Modules
       
orca.debug
orca.settings

 
Classes
       
Rolename

 
class Rolename
    Provides localized forms of rolenames for speech and Braille.
 
  Methods defined here:
__init__(self, rolename, brailleShort, brailleLong, speech)
Created a new rolename with the given parameters.
 
Arguments:
- rolename:     the internationalized (e.g., machine) name for the role
- brailleShort: the localized short string for Braille display
- brailleLong:  the localized long string for Braille display
- speech:       the localized string to speak for speech

 
Functions
       
getBrailleForRoleName(obj)
Returns the localized name of the given Accessible object; the name is
a string suitable for a Braille display.  If a localized name cannot
be discovered, this will return the string as defined by the at-spi.
 
Arguments:
- obj: an Accessible object
 
Returns a string containing the localized name of the object suitable for
a Braille display.  The actual string will depend upon the value of
the 'brailleRolenameStyle' setting.
getLongBrailleForRoleName(obj)
Returns the localized name of the given Accessible object; the name is
a long string suitable for a Braille display.  If a localized name cannot
be discovered, this will return the string as defined by the at-spi.
 
Arguments:
- obj: an Accessible object
 
Returns a string containing the localized name of the object suitable for
a Braille display.
getShortBrailleForRoleName(obj)
Returns the localized name of the given Accessible object; the name is
a short string suitable for a Braille display.  If a localized name cannot
be discovered, this will return the string as defined by the at-spi.
 
Arguments:
- obj: an Accessible object
 
Returns a short string containing the localized name of the object
suitable for a Braille display.
getSpeechForRoleName(obj)
Returns the localized name of the given Accessible object; the name is
suitable to be spoken.  If a localized name cannot be discovered, this
will return the string as defined by the at-spi.
 
Arguments:
- obj: an Accessible object
 
Returns a string containing the localized name of the object suitable
to be spoken.

 
Data
        ROLE_ACCEL_LABEL = 'accelerator label'
ROLE_ALERT = 'alert'
ROLE_ANIMATION = 'animation'
ROLE_APPLICATION = 'application'
ROLE_ARROW = 'arrow'
ROLE_AUTOCOMPLETE = 'autocomplete'
ROLE_CALENDAR = 'calendar'
ROLE_CANVAS = 'canvas'
ROLE_CAPTION = 'caption'
ROLE_CHECK_BOX = 'check box'
ROLE_CHECK_MENU = 'check menu'
ROLE_CHECK_MENU_ITEM = 'check menu item'
ROLE_COLOR_CHOOSER = 'color chooser'
ROLE_COLUMN_HEADER = 'column header'
ROLE_COMBO_BOX = 'combo box'
ROLE_DATE_EDITOR = 'dateeditor'
ROLE_DESKTOP_FRAME = 'desktop frame'
ROLE_DESKTOP_ICON = 'desktop icon'
ROLE_DIAL = 'dial'
ROLE_DIALOG = 'dialog'
ROLE_DIRECTORY_PANE = 'directory pane'
ROLE_DOCUMENT_FRAME = 'document frame'
ROLE_DRAWING_AREA = 'drawing area'
ROLE_EDITBAR = 'edit bar'
ROLE_EMBEDDED = 'embedded component'
ROLE_ENTRY = 'entry'
ROLE_FILE_CHOOSER = 'file chooser'
ROLE_FILLER = 'filler'
ROLE_FONT_CHOOSER = 'fontchooser'
ROLE_FOOTER = 'footer'
ROLE_FORM = 'form'
ROLE_FRAME = 'frame'
ROLE_GLASS_PANE = 'glass pane'
ROLE_HEADER = 'header'
ROLE_HEADING = 'heading'
ROLE_HTML_CONTAINER = 'html container'
ROLE_ICON = 'icon'
ROLE_IMAGE = 'image'
ROLE_INPUT_METHOD_WINDOW = 'input method window'
ROLE_INTERNAL_FRAME = 'internal frame'
ROLE_INVALID = 'invalid'
ROLE_LABEL = 'label'
ROLE_LAYERED_PANE = 'layered pane'
ROLE_LINK = 'link'
ROLE_LIST = 'list'
ROLE_LIST_ITEM = 'list item'
ROLE_MENU = 'menu'
ROLE_MENU_BAR = 'menu bar'
ROLE_MENU_ITEM = 'menu item'
ROLE_OPTION_PANE = 'option pane'
ROLE_PAGE_TAB = 'page tab'
ROLE_PAGE_TAB_LIST = 'page tab list'
ROLE_PANEL = 'panel'
ROLE_PARAGRAPH = 'paragraph'
ROLE_PASSWORD_TEXT = 'password text'
ROLE_POPUP_MENU = 'popup menu'
ROLE_PROGRESS_BAR = 'progress bar'
ROLE_PUSH_BUTTON = 'push button'
ROLE_RADIO_BUTTON = 'radio button'
ROLE_RADIO_MENU = 'radio menu'
ROLE_RADIO_MENU_ITEM = 'radio menu item'
ROLE_ROOT_PANE = 'root pane'
ROLE_ROW_HEADER = 'row header'
ROLE_SCROLL_BAR = 'scroll bar'
ROLE_SCROLL_PANE = 'scroll pane'
ROLE_SECTION = 'section'
ROLE_SEPARATOR = 'separator'
ROLE_SLIDER = 'slider'
ROLE_SPIN_BUTTON = 'spin button'
ROLE_SPLIT_PANE = 'split pane'
ROLE_STATUSBAR = 'statusbar'
ROLE_TABLE = 'table'
ROLE_TABLE_CELL = 'table cell'
ROLE_TABLE_COLUMN_HEADER = 'table column header'
ROLE_TABLE_ROW_HEADER = 'table row header'
ROLE_TEAR_OFF_MENU_ITEM = 'tear off menu item'
ROLE_TERMINAL = 'terminal'
ROLE_TEXT = 'text'
ROLE_TOGGLE_BUTTON = 'toggle button'
ROLE_TOOL_BAR = 'tool bar'
ROLE_TOOL_TIP = 'tool tip'
ROLE_TREE = 'tree'
ROLE_TREE_TABLE = 'tree table'
ROLE_UNKNOWN = 'unknown'
ROLE_VIEWPORT = 'viewport'
ROLE_WINDOW = 'window'
__copyright__ = 'Copyright (c) 2005-2006 Sun Microsystems Inc.'
__date__ = '$Date: 2007-03-12 16:23:35 -0400 (Mon, 12 Mar 2007) $'
__id__ = '$Id: orca.rolenames.html 5086 2007-03-12 20:23:35Z wwalker $'
__license__ = 'LGPL'
__version__ = '$Revision: 5086 $'
rolenames = {'accelerator label': <orca.rolenames.Rolename instance at 0x4060bf6c>, 'alert': <orca.rolenames.Rolename instance at 0x836a4ec>, 'animation': <orca.rolenames.Rolename instance at 0x836a5cc>, 'application': <orca.rolenames.Rolename instance at 0x836af6c>, 'arrow': <orca.rolenames.Rolename instance at 0x836a5ec>, 'autocomplete': <orca.rolenames.Rolename instance at 0x836af8c>, 'calendar': <orca.rolenames.Rolename instance at 0x836a60c>, 'canvas': <orca.rolenames.Rolename instance at 0x836a62c>, 'caption': <orca.rolenames.Rolename instance at 0x836a64c>, 'check box': <orca.rolenames.Rolename instance at 0x836a66c>, ...}