Changeset 2023

Timestamp:

05/07/08 09:04:04 (8 months ago)

Author:

jteh

Message:

Merging guiFixes branch.
This fixes #65 (Freeze when launching NVDA dialogs).
I'm also hoping it will fix #41 (NVDA menu sometimes does not correctly obtain focus), but I can't reproduce this issue on my system, so I can't test it.

In addition, this fixes the issue wherein the tray menu would not appear when the right mouse button was clicked on the tray icon.

Aside from this, there is quite a bit of code cleanup and simplification.

Location:

trunk

Files:

• . (modified) (3 props)
• source/gui/__init__.py (modified) (8 diffs)
• source/gui/logViewer.py (modified) (3 diffs)
• source/gui/scriptUI.py (modified) (5 diffs)
• source/pythonConsole.py (modified) (2 diffs)

trunk

@@ -87 +87 @@
 1813 jamie@jantrid.net-20080502122842-u2xfo1in3euux4ci
 1825 jamie@jantrid.net-20080506061049-3qk3r33c6a8dc4jo
+1828 jamie@jantrid.net-20080507090220-y1fjk3t08rbcx18z
-timestamp: 2008-05-06 16:10:49.217000008 +1000
+timestamp: 2008-05-07 19:02:20.607000113 +1000
 committer: James Teh <jamie@jantrid.net>
 properties: 
 jamie@jantrid.net-20080212104116-78n366kl7diwve24
 jamie@jantrid.net-20080229050825-20q1xhb2t4c0zcza
+jamie@jantrid.net-20080507074841-cxoldzwvz389fete

@@ -87 +87 @@
 1813 jamie@jantrid.net-20080502122842-u2xfo1in3euux4ci
 1825 jamie@jantrid.net-20080506061049-3qk3r33c6a8dc4jo
+1828 jamie@jantrid.net-20080507090220-y1fjk3t08rbcx18z

@@ -1 @@
-timestamp: 2008-05-06 16:10:49.217000008 +1000
+timestamp: 2008-05-07 19:02:20.607000113 +1000
 committer: James Teh <jamie@jantrid.net>
 properties: 

@@ -3 +3 @@
 jamie@jantrid.net-20080212104116-78n366kl7diwve24
 jamie@jantrid.net-20080229050825-20q1xhb2t4c0zcza
+jamie@jantrid.net-20080507074841-cxoldzwvz389fete

trunk/source/gui/__init__.py

@@ -20 +20 @@
 import languageHandler
 import logViewer
+import winUser
 
 ### Constants
@@ -29 +30 @@
 id_showGuiCommand=wx.NewId()
 id_abortCommand=wx.NewId()
-evt_externalExecute = wx.NewEventType()
+evtid_externalExecute = wx.NewEventType()
+evt_externalExecute = wx.PyEventBinder(evtid_externalExecute, 1)
 
 ### Globals
 mainFrame = None
 #: A list of top level windows excluding L{mainFrame} which are currently instantiated and which should be destroyed on exit.
-#: @type: list
-topLevelWindows = []
 
 class ExternalExecuteEvent(wx.PyCommandEvent):
         def __init__(self, func, args, kwargs, callback):
-                super(ExternalExecuteEvent, self).__init__(evt_externalExecute, wx.ID_ANY)
+                super(ExternalExecuteEvent, self).__init__(evtid_externalExecute, wx.ID_ANY)
                 self._func = func
                 self._args = args
@@ -97 +97 @@
         def __init__(self):
                 style = wx.DEFAULT_FRAME_STYLE ^ wx.MAXIMIZE_BOX ^ wx.MINIMIZE_BOX | wx.FRAME_NO_TASKBAR
-                super(MainFrame, self).__init__(None, wx.ID_ANY, appTitle, size=(500,500), style=style)
+                super(MainFrame, self).__init__(None, wx.ID_ANY, appTitle, size=(1,1), style=style)
                 self.Bind(evt_externalCommand, self.onAbortCommand, id=id_abortCommand)
                 self.Bind(evt_externalCommand, self.onExitCommand, id=wx.ID_EXIT)
                 self.Bind(evt_externalCommand, self.onShowGuiCommand, id=id_showGuiCommand)
-                wx.EVT_COMMAND(self,wx.ID_ANY,evt_externalExecute,lambda evt: evt.run())
+                self.Bind(evt_externalExecute,lambda evt: evt.run())
                 self.sysTrayIcon = SysTrayIcon(self)
-                self.Show(True)
-                self.Show(False)
+                # This makes Windows return to the previous foreground window and also seems to allow NVDA to be brought to the foreground.
+                self.Show()
+                self.Hide()
 
         def Destroy(self):
-                global topLevelWindows
                 self.sysTrayIcon.Destroy()
-                for window in list(topLevelWindows):
-                        window.Destroy()
                 super(MainFrame, self).Destroy()
+
+        def prePopup(self):
+                """Prepare for a popup.
+                This should be called before any dialog or menu which should pop up for the user.
+                L{postPopup} should be called after the dialog or menu has been shown.
+                @postcondition: A dialog or menu may be shown.
+                """
+                if winUser.getWindowThreadProcessID(winUser.getForegroundWindow())[0] != os.getpid():
+                        # This process is not the foreground process, so bring it to the foreground.
+                        self.Raise()
+
+        def postPopup(self):
+                """Clean up after a popup dialog or menu.
+                This should be called after a dialog or menu was popped up for the user.
+                """
+                if not winUser.isWindowVisible(winUser.getForegroundWindow()):
+                        # The current foreground window is invisible, so we want to return to the previous foreground window.
+                        # Showing and hiding our main window seems to achieve this.
+                        self.Show()
+                        self.Hide()
 
         def onAbortCommand(self,evt):
@@ -129 +147 @@
                         speech.speakMessage(_("Could not save configuration - probably read only file system"),wait=True)
 
+        def _popupSettingsDialog(self, dialog, *args, **kwargs):
+                self.prePopup()
+                dialog(self, *args, **kwargs).Show()
+                self.postPopup()
+
         def onDefaultDictionaryCommand(self,evt):
-                d=DictionaryDialog(None,_("Default dictionary"),speechDictHandler.dictionaries["default"])
-                d.Show(True)
+                self._popupSettingsDialog(DictionaryDialog,_("Default dictionary"),speechDictHandler.dictionaries["default"])
 
         def onVoiceDictionaryCommand(self,evt):
-                d=DictionaryDialog(None,_("Voice dictionary (%s)")%speechDictHandler.dictionaries["voice"].fileName,speechDictHandler.dictionaries["voice"])
-                d.Show(True)
+                self._popupSettingsDialog(DictionaryDialog,_("Voice dictionary (%s)")%speechDictHandler.dictionaries["voice"].fileName,speechDictHandler.dictionaries["voice"])
 
         def onTemporaryDictionaryCommand(self,evt):
-                d=DictionaryDialog(None,_("Temporary dictionary"),speechDictHandler.dictionaries["temp"])
-                d.Show(True)
+                self._popupSettingsDialog(DictionaryDialog,_("Temporary dictionary"),speechDictHandler.dictionaries["temp"])
 
         def onExitCommand(self, evt):
                 canExit=False
                 if config.conf["general"]["askToExit"]:
-                        d = wx.MessageDialog(None, _("Are you sure you want to quit NVDA?"), _("Exit NVDA"), wx.YES|wx.NO|wx.ICON_WARNING)
+                        self.prePopup()
+                        d = wx.MessageDialog(self, _("Are you sure you want to quit NVDA?"), _("Exit NVDA"), wx.YES|wx.NO|wx.ICON_WARNING)
                         if d.ShowModal() == wx.ID_YES:
                                 canExit=True
+                        self.postPopup()
                 else:
                         canExit=True
@@ -158 +180 @@
 
         def onGeneralSettingsCommand(self,evt):
-                d=GeneralSettingsDialog(None)
-                d.Show(True)
+                self._popupSettingsDialog(GeneralSettingsDialog)
 
         def onSynthesizerCommand(self,evt):
-                d=SynthesizerDialog(None)
-                d.Show(True)
+                self._popupSettingsDialog(SynthesizerDialog)
 
         def onVoiceCommand(self,evt):
-                d=VoiceSettingsDialog(None)
-                d.Show(True)
+                self._popupSettingsDialog(VoiceSettingsDialog)
 
         def onKeyboardSettingsCommand(self,evt):
-                d=KeyboardSettingsDialog(None)
-                d.Show(True)
+                self._popupSettingsDialog(KeyboardSettingsDialog)
 
         def onMouseSettingsCommand(self,evt):
-                d=MouseSettingsDialog(None)
-                d.Show(True)
+                self._popupSettingsDialog(MouseSettingsDialog)
 
         def onObjectPresentationCommand(self,evt):
-                d=ObjectPresentationDialog(None)
-                d.Show(True)
+                self._popupSettingsDialog(ObjectPresentationDialog)
 
         def onVirtualBuffersCommand(self,evt):
-                d=VirtualBuffersDialog(None)
-                d.Show(True)
+                self._popupSettingsDialog(VirtualBuffersDialog)
 
         def onDocumentFormattingCommand(self,evt):
-                d=DocumentFormattingDialog(None)
-                d.Show(True)
+                self._popupSettingsDialog(DocumentFormattingDialog)
 
         def onAboutCommand(self,evt):
@@ -195 +209 @@
 %s: %s
 %s: %s"""%(versionInfo.longName,_("version"),versionInfo.version,_("url"),versionInfo.url,_("copyright"),versionInfo.copyrightInfo)
-                        d = wx.MessageDialog(None, aboutInfo, _("About NVDA"), wx.OK)
+                        self.prePopup()
+                        d = wx.MessageDialog(self, aboutInfo, _("About NVDA"), wx.OK)
                         d.ShowModal()
+                        self.postPopup()
                 except:
                         globalVars.log.error("gui.mainFrame.onAbout", exc_info=True)
 
         def onViewLogCommand(self, evt):
-                logViewer.LogViewer().Show()
+                logViewer.activate()
 
         def onPythonConsoleCommand(self, evt):
@@ -280 +296 @@
                 self.Bind(wx.EVT_MENU, frame.onExitCommand, item)
 
-                self.Bind(wx.EVT_TASKBAR_RIGHT_UP, self.onActivate)
+                self.Bind(wx.EVT_TASKBAR_RIGHT_DOWN, self.onActivate)
 
         def Destroy(self):
@@ -287 +303 @@
 
         def onActivate(self, evt):
+                mainFrame.prePopup()
                 self.PopupMenu(self.menu)
-                # Showing and hiding our main frame seems to cause Windows to switch to the previous foreground window.
-                # If we don't do this and no dialog was displayed, the user will be dumped in the invisible system tray window, which is bad.
-                # It is even worse than expected because the user can close the system tray window, breaking the system tray icon.
-                # Even if a dialog is displayed, this does no harm.
-                mainFrame.Show()
-                mainFrame.Hide()
+                mainFrame.postPopup()
 
 def initialize(app):

trunk/source/gui/logViewer.py

@@ -7 +7 @@
 import gui
 
+#: The singleton instance of the log viewer UI.
+logViewer = None
+
 class LogViewer(wx.Frame):
         """The NVDA log viewer GUI.
         """
 
-        def __init__(self):
-                super(LogViewer, self).__init__(None, wx.ID_ANY, _("NVDA Log Viewer"))
-                gui.topLevelWindows.append(self)
+        def __init__(self, parent):
+                super(LogViewer, self).__init__(parent, wx.ID_ANY, _("NVDA Log Viewer"))
                 self.Bind(wx.EVT_ACTIVATE, self.onActivate)
                 self.Bind(wx.EVT_CLOSE, self.onClose)
@@ -47 +49 @@
 
         def onActivate(self, evt):
-                self.refresh()
+                if evt.GetActive():
+                        self.refresh()
                 evt.Skip()
 
@@ -64 +67 @@
                         wx.MessageBox(_("Error saving log: %s") % e.strerror, _("Error"), style=wx.OK | wx.ICON_ERROR)
 
-        def Destroy(self):
-                gui.topLevelWindows.remove(self)
-                super(LogViewer, self).Destroy()
+def activate():
+        """Activate the log viewer.
+        If the log viewer has not already been created and opened, this will create and open it.
+        Otherwise, it will be brought to the foreground if possible.
+        """
+        global logViewer
+        if not logViewer:
+                logViewer = LogViewer(gui.mainFrame)
+        logViewer.Raise()
+        logViewer.Show()

trunk/source/gui/scriptUI.py

@@ -36 +36 @@
 
         def _run_gui(self):
+                gui.mainFrame.prePopup()
                 dialog = self.dialog = self.makeDialog()
-                dialog.Raise()
                 ret = self.getResponse(dialog.ShowModal())
+                gui.mainFrame.postPopup()
                 dialog.Destroy()
                 return ret
@@ -51 +52 @@
 
         def __init__(self, message, title = _("NVDA"), style=wx.OK, callback=None):
-                self.makeDialog = lambda: wx.MessageDialog(None, message, title, style)
+                self.makeDialog = lambda: wx.MessageDialog(gui.mainFrame, message, title, style)
                 super(MessageDialog, self).__init__(callback)
 
@@ -60 +61 @@
 
         def __init__(self, message, title=_("NVDA"), default="", style=wx.OK | wx.CANCEL, callback=None):
-                self.makeDialog = lambda: wx.TextEntryDialog(None, message, title, defaultValue=default, style=style)
+                self.makeDialog = lambda: wx.TextEntryDialog(gui.mainFrame, message, title, defaultValue=default, style=style)
                 super(TextEntryDialog, self).__init__(callback)
 
@@ -73 +74 @@
         def __init__(self, message, title=_("NVDA"), choices=(), default=0, style=wx.OK|wx.CANCEL, callback=None):
                 def makeDialog():
-                        dialog = wx.Dialog(None, wx.ID_ANY, title)
+                        dialog = wx.Dialog(gui.mainFrame, wx.ID_ANY, title)
                         mainSizer = wx.BoxSizer(wx.VERTICAL)
                         mainSizer.Add(wx.StaticText(dialogD_ANY, label=message))
@@ -106 +107 @@
         def __init__(self, choices, default=0, callback=None):
                 def makeDialog():
-                        dialog = wx.Dialog(None, wx.ID_ANY, _("Links List"))
+                        dialog = wx.Dialog(gui.mainFrame, wx.ID_ANY, _("Links List"))
                         mainSizer = wx.BoxSizer(wx.VERTICAL)
                         self.list = wx.ListView(dialog, wx.ID_ANY, style=wx.LC_LIST | wx.LC_SINGLE_SEL)

trunk/source/pythonConsole.py

@@ -58 +58 @@
         """
 
-        def __init__(self):
-                super(ConsoleUI, self).__init__(None, wx.ID_ANY, _("NVDA Python Console"))
+        def __init__(self, parent):
+                super(ConsoleUI, self).__init__(parent, wx.ID_ANY, _("NVDA Python Console"))
                 self.Bind(wx.EVT_ACTIVATE, self.onActivate)
                 self.Bind(wx.EVT_CLOSE, self.onClose)
@@ -160 +160 @@
         """
         global consoleUI
-        consoleUI = ConsoleUI()
-        gui.topLevelWindows.append(consoleUI)
+        consoleUI = ConsoleUI(gui.mainFrame)
 
 def activate():

@@ -87 +87 @@
 1813 jamie@jantrid.net-20080502122842-u2xfo1in3euux4ci
 1825 jamie@jantrid.net-20080506061049-3qk3r33c6a8dc4jo
+1828 jamie@jantrid.net-20080507090220-y1fjk3t08rbcx18z

@@ -1 @@
-timestamp: 2008-05-06 16:10:49.217000008 +1000
+timestamp: 2008-05-07 19:02:20.607000113 +1000
 committer: James Teh <jamie@jantrid.net>
 properties: 

@@ -3 +3 @@
 jamie@jantrid.net-20080212104116-78n366kl7diwve24
 jamie@jantrid.net-20080229050825-20q1xhb2t4c0zcza
+jamie@jantrid.net-20080507074841-cxoldzwvz389fete