ui module
User interface functionality. This refers to the user interface presented by the screen reader alone, not the graphical user interface. See L{gui} for the graphical user interface.
- ui._warnBrowsableMessageNotAvailableOnSecureScreens(title: str | None) None
Warn the user that a browsable message could not be shown on a secure screen (sign-on screen / UAC prompt). @param title: If provided, the title of the browsable message to give the user more context.
- ui.browseableMessage(message: str, title: str | None = None, isHtml: bool = False) None
Present a message to the user that can be read in browse mode. The message will be presented in an HTML document. @param message: The message in either html or text. @param title: The title for the message. @param isHtml: Whether the message is html
- ui.message(text: str, speechPriority: SpeechPriority | None = None, brailleText: str | None = None)
Present a message to the user. The message will be presented in both speech and braille. @param text: The text of the message. @param speechPriority: The speech priority. @param brailleText: If specified, present this alternative text on the braille display.
- ui.reviewMessage(text: str, speechPriority: SpeechPriority | None = None)
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. @param text: The text of the message. @param speechPriority: The speech priority.
- ui.reportTextCopiedToClipboard(text: str | None = None)
Notify about the result of a “Copy to clipboard” operation. @param text: The text that has been copied. Set to
None
to notify of a failed operation. See:api.copyToClip