Create a MessageDialog API

source/gui/__init__.py

@@ -31,6 +31,7 @@
 	# be cautious when removing
 	messageBox,
 )
+from .messageDialog import MessageDialog
 from . import blockAction
 from .speechDict import (
 	DefaultDictionaryDialog,
@@ -70,6 +71,7 @@
 import winUser
 import api
 import NVDAState
+from gui.messageDialog import MessageDialog as NMD
 
 
 if NVDAState._allowDeprecatedAPI():
@@ -367,7 +369,7 @@ def onInputGesturesCommand(self, evt):
 
 	def onAboutCommand(self, evt):
 		# Translators: The title of the dialog to show about info for NVDA.
-		messageBox(versionInfo.aboutMessage, _("About NVDA"), wx.OK)
+		MessageDialog(None, versionInfo.aboutMessage, _("About NVDA")).Show()
 
 	@blockAction.when(blockAction.Context.SECURE_MODE)
 	def onCheckForUpdateCommand(self, evt):
@@ -575,6 +577,29 @@ def onConfigProfilesCommand(self, evt):
 		ProfilesDialog(mainFrame).Show()
 		self.postPopup()
 
+	def onModelessOkCancelDialog(self, evt):
+		self.prePopup()
+		dlg = (
+			NMD(
+				self,
+				"This is a modeless dialog with OK and Cancel buttons. Test that:\n"
+				"- The dialog appears correctly both visually and to NVDA\n"
+				"- The dialog has the expected buttons\n"
+				"- Pressing the Ok or Cancel button has the intended effect\n"
+				"- Pressing Esc has the intended effect\n"
+				"- Pressing Alt+F4 has the intended effect\n"
+				"- Using the close icon/system menu close item has the intended effect\n"
+				"- You are still able to interact with NVDA's GUI\n"
+				"- Exiting NVDA does not cause errors",
+				"Non-modal OK/Cancel Dialog",
+			)
+			.addOkButton(callback=lambda: messageBox("You pressed OK!"))
+			.addCancelButton(callback=lambda: messageBox("You pressed Cancel!"))
+		)
+
+		dlg.ShowModal()
+		self.postPopup()
+
 
 class SysTrayIcon(wx.adv.TaskBarIcon):
 	def __init__(self, frame: MainFrame):
@@ -681,6 +706,15 @@ def __init__(self, frame: MainFrame):
 		)
 		self.Bind(wx.EVT_MENU, frame.onExitCommand, item)
 
+		dialogMenu = wx.Menu()
+		item = dialogMenu.Append(wx.ID_ANY, "Ok")
+		item = dialogMenu.Append(wx.ID_ANY, "Ok and Cancel")
+		self.Bind(wx.EVT_MENU, frame.onModelessOkCancelDialog, item)
+		item = dialogMenu.Append(wx.ID_ANY, "Yes and No")
+		item = dialogMenu.Append(wx.ID_ANY, "Yes, No and Cancel")
+
+		self.menu.AppendSubMenu(dialogMenu, "&Dialog")
+
 		self.Bind(wx.adv.EVT_TASKBAR_LEFT_DOWN, self.onActivate)
 		self.Bind(wx.adv.EVT_TASKBAR_RIGHT_DOWN, self.onActivate)
 

source/gui/blockAction.py

@@ -10,10 +10,11 @@
 from functools import wraps
 import globalVars
 from typing import Callable
+from speech.priorities import SpeechPriority
 import ui
 from utils.security import isLockScreenModeActive, isRunningOnSecureDesktop
 from gui.message import isModalMessageBoxActive
-import queueHandler
+import core
 
 
 @dataclass
@@ -74,7 +75,15 @@ def _wrap(func):
 		def funcWrapper(*args, **kwargs):
 			for context in contexts:
 				if context.blockActionIf():
-					queueHandler.queueFunction(queueHandler.eventQueue, ui.message, context.translatedMessage)
+					if context == Context.MODAL_DIALOG_OPEN:
+						# Import late to avoid circular import
+						from gui.messageDialog import MessageDialog
+
+						if MessageDialog.BlockingInstancesExist():
+							MessageDialog.FocusBlockingInstances()
+					# We need to delay this message so that, if a dialog is to be focused, the appearance of the dialog doesn't interrupt it.
+					# 1ms is a magic number. It can be increased if it is found to be too short, but it should be kept to a minimum.
+					core.callLater(1, ui.message, context.translatedMessage, SpeechPriority.NOW)
 					return
 			return func(*args, **kwargs)
 

source/gui/message.py

@@ -9,6 +9,7 @@
 from typing import Optional
 
 import wx
+import warnings
 
 import extensionPoints
 
@@ -97,6 +98,11 @@ def messageBox(
 	Because an answer is required to continue after a modal messageBox is opened,
 	some actions such as shutting down are prevented while NVDA is in a possibly uncertain state.
 	"""
+	warnings.warn(
+		DeprecationWarning(
+			"gui.message.messageBox is deprecated. Use gui.message.MessageDialog instead.",
+		),
+	)
 	from gui import mainFrame
 	import core
 	from logHandler import log