Module ui
[hide private]

Module ui

source code

User interface functionality. This refers to the user interface presented by the screen reader alone, not the graphical user interface. See gui for the graphical user interface.

Functions [hide private]
 
browseableMessage(message, title=None, isHtml=False)
Present a message to the user that can be read in browse mode.
source code
 
message(text)
Present a message to the user.
source code
 
reviewMessage(text)
Present a message from review or object navigation to the user.
source code
Variables [hide private]
  URL_MK_UNIFORM = 1
  DIALOG_OPTIONS = "dialogWidth:350px;dialogHeight:140px;resizab...
  HTMLDLG_NOUI = 0x0010
  HTMLDLG_MODAL = 0x0020
  HTMLDLG_MODELESS = 0x0040
  HTMLDLG_PRINT_TEMPLATE = 0x0080
  HTMLDLG_VERIFY = 0x0100
Function Details [hide private]

browseableMessage(message, title=None, isHtml=False)

source code 

Present a message to the user that can be read in browse mode. The message will be presented in an HTML document.

Parameters:
  • message (unicode) - The message in either html or text.
  • title (unicode) - The title for the message.
  • isHtml (boolean) - Whether the message is html

message(text)

source code 

Present a message to the user. The message will be presented in both speech and braille.

Parameters:
  • text (str) - The text of the message.

reviewMessage(text)

source code 

Present a message from review or object navigation to the user. The message will always be presented in speech, and also in braille if it is tethered to review or when auto tethering is on.

Parameters:
  • text (str) - The text of the message.

Variables Details [hide private]

DIALOG_OPTIONS

Value:
"dialogWidth:350px;dialogHeight:140px;resizable:yes;center:yes;help:no\
"