gui

Package gui

Submodules

[hide private]

gui.logViewer: Provides functionality to view the NVDA log.
gui.settingsDialogs

Functions

[hide private]

getDocFilePath(fileName, localized=True)

source code

initialize()

source code

terminate()

source code

showGui()

source code

quit()

source code

int

messageBox(message, caption=wx.MessageBoxCaptionStr, style=wx.OK | wx.CENTER, parent=None)
Display a message dialog.

source code

runScriptModalDialog(dialog, callback=None)
Run a modal dialog from a script.

source code

Variables

[hide private]

NVDA_PATH = os.getcwdu()

ICON_PATH = os.path.join(NVDA_PATH, "images", "nvda.ico")

mainFrame = None
hash(x)

isInMessageBox = False

Function Details

[hide private]

messageBox(message, caption=wx.MessageBoxCaptionStr, style=wx.OK | wx.CENTER, parent=None)

source code

Display a message dialog. This should be used for all message dialogs rather than using wx.MessageDialog and wx.MessageBox directly.

Parameters:

message (str) - The message text.
caption (str) - The caption (title) of the dialog.
style (int) - Same as for wx.MessageBox.
parent (wx.Window) - The parent window (optional).

Returns: int

Same as for wx.MessageBox.

runScriptModalDialog(dialog, callback=None)

source code

Run a modal dialog from a script. This will not block the caller, but will instead call callback (if provided) with the result from the dialog. The dialog will be destroyed once the callback has returned.

Parameters:

dialog (wx.Dialog) - The dialog to show.
callback (callable) - The optional callable to call with the result from the dialog.