Improve dialog memory handling (#1899)

novelwriter/dialogs/about.py

@@ -33,14 +33,14 @@
 from novelwriter import CONFIG, SHARED
 from novelwriter.common import cssCol, readTextFile
 from novelwriter.extensions.configlayout import NColourLabel
-from novelwriter.extensions.modified import NNonBlockingDialog
+from novelwriter.extensions.modified import NDialog
 from novelwriter.extensions.versioninfo import VersionInfoWidget
 from novelwriter.types import QtAlignRightTop, QtDialogClose
 
 logger = logging.getLogger(__name__)
 
 
-class GuiAbout(NNonBlockingDialog):
+class GuiAbout(NDialog):
 
     def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
@@ -106,7 +106,9 @@ def __init__(self, parent: QWidget) -> None:
 
         self.setLayout(self.outerBox)
         self.setSizeGripEnabled(True)
+
         self._setStyleSheet()
+        self._fillCreditsPage()
 
         logger.debug("Ready: GuiAbout")
 
@@ -116,19 +118,14 @@ def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiAbout")
         return
 
-    def populateGUI(self) -> None:
-        """Populate tabs with text."""
-        self._fillCreditsPage()
-        return
-
     ##
     #  Events
     ##
 
     def closeEvent(self, event: QCloseEvent) -> None:
         """Capture the close event and perform cleanup."""
         event.accept()
-        self.deleteLater()
+        self.softDelete()
         return
 
     ##
@@ -137,16 +134,14 @@ def closeEvent(self, event: QCloseEvent) -> None:
 
     def _fillCreditsPage(self) -> None:
         """Load the content for the Credits page."""
-        docPath = CONFIG.assetPath("text") / "credits_en.htm"
-        docText = readTextFile(docPath)
-        if docText:
-            self.txtCredits.setHtml(docText)
+        if html := readTextFile(CONFIG.assetPath("text") / "credits_en.htm"):
+            self.txtCredits.setHtml(html)
         else:
             self.txtCredits.setHtml("Error loading credits text ...")
         return
 
     def _setStyleSheet(self) -> None:
-        """Set stylesheet for all browser tabs."""
+        """Set stylesheet text document."""
         baseCol = cssCol(self.palette().window().color())
         self.txtCredits.setStyleSheet(
             f"QTextBrowser {{border: none; background: {baseCol};}} "

novelwriter/dialogs/docmerge.py

@@ -27,21 +27,21 @@
 import logging
 
 from PyQt5.QtCore import Qt, pyqtSlot
-from PyQt5.QtGui import QCloseEvent
 from PyQt5.QtWidgets import (
-    QAbstractItemView, QDialog, QDialogButtonBox, QGridLayout, QLabel,
-    QListWidget, QListWidgetItem, QVBoxLayout, QWidget
+    QAbstractItemView, QDialogButtonBox, QGridLayout, QLabel, QListWidget,
+    QListWidgetItem, QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.extensions.configlayout import NColourLabel
+from novelwriter.extensions.modified import NDialog
 from novelwriter.extensions.switch import NSwitch
-from novelwriter.types import QtDialogCancel, QtDialogOk, QtDialogReset, QtUserRole
+from novelwriter.types import QtAccepted, QtDialogCancel, QtDialogOk, QtDialogReset, QtUserRole
 
 logger = logging.getLogger(__name__)
 
 
-class GuiDocMerge(QDialog):
+class GuiDocMerge(NDialog):
 
     D_HANDLE = QtUserRole
 
@@ -117,7 +117,7 @@ def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiDocMerge")
         return
 
-    def getData(self) -> dict:
+    def data(self) -> dict:
         """Return the user's choices."""
         finalItems = []
         for i in range(self.listBox.count()):
@@ -130,15 +130,15 @@ def getData(self) -> dict:
 
         return self._data
 
-    ##
-    #  Events
-    ##
-
-    def closeEvent(self, event: QCloseEvent) -> None:
-        """Capture the close event and perform cleanup."""
-        event.accept()
-        self.deleteLater()
-        return
+    @classmethod
+    def getData(cls, parent: QWidget, handle: str, items: list[str]) -> tuple[dict, bool]:
+        """Pop the dialog and return the result."""
+        cls = GuiDocMerge(parent, handle, items)
+        cls.exec()
+        data = cls.data()
+        accepted = cls.result() == QtAccepted
+        cls.softDelete()
+        return data, accepted
 
     ##
     #  Private Slots

novelwriter/dialogs/docsplit.py

@@ -27,21 +27,21 @@
 import logging
 
 from PyQt5.QtCore import pyqtSlot
-from PyQt5.QtGui import QCloseEvent
 from PyQt5.QtWidgets import (
-    QAbstractItemView, QComboBox, QDialog, QDialogButtonBox, QGridLayout,
-    QLabel, QListWidget, QListWidgetItem, QVBoxLayout, QWidget
+    QAbstractItemView, QComboBox, QDialogButtonBox, QGridLayout, QLabel,
+    QListWidget, QListWidgetItem, QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.extensions.configlayout import NColourLabel
+from novelwriter.extensions.modified import NDialog
 from novelwriter.extensions.switch import NSwitch
-from novelwriter.types import QtDialogCancel, QtDialogOk, QtUserRole
+from novelwriter.types import QtAccepted, QtDialogCancel, QtDialogOk, QtUserRole
 
 logger = logging.getLogger(__name__)
 
 
-class GuiDocSplit(QDialog):
+class GuiDocSplit(NDialog):
 
     LINE_ROLE  = QtUserRole
     LEVEL_ROLE = QtUserRole + 1
@@ -145,7 +145,7 @@ def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiDocSplit")
         return
 
-    def getData(self) -> tuple[dict, list]:
+    def data(self) -> tuple[dict, list[str]]:
         """Return the user's choices. Also save the users options for
         the next time the dialog is used.
         """
@@ -178,15 +178,15 @@ def getData(self) -> tuple[dict, list]:
 
         return self._data, self._text
 
-    ##
-    #  Events
-    ##
-
-    def closeEvent(self, event: QCloseEvent) -> None:
-        """Capture the close event and perform cleanup."""
-        event.accept()
-        self.deleteLater()
-        return
+    @classmethod
+    def getData(cls, parent: QWidget, handle: str) -> tuple[dict, list[str], bool]:
+        """Pop the dialog and return the result."""
+        cls = GuiDocSplit(parent, handle)
+        cls.exec()
+        data, text = cls.data()
+        accepted = cls.result() == QtAccepted
+        cls.softDelete()
+        return data, text, accepted
 
     ##
     #  Private Slots

novelwriter/dialogs/editlabel.py

@@ -25,18 +25,16 @@
 
 import logging
 
-from PyQt5.QtWidgets import (
-    QDialog, QDialogButtonBox, QHBoxLayout, QLabel, QLineEdit, QVBoxLayout,
-    QWidget
-)
+from PyQt5.QtWidgets import QDialogButtonBox, QHBoxLayout, QLabel, QLineEdit, QVBoxLayout, QWidget
 
 from novelwriter import CONFIG
-from novelwriter.types import QtDialogCancel, QtDialogOk
+from novelwriter.extensions.modified import NDialog
+from novelwriter.types import QtAccepted, QtDialogCancel, QtDialogOk
 
 logger = logging.getLogger(__name__)
 
 
-class GuiEditLabel(QDialog):
+class GuiEditLabel(NDialog):
 
     def __init__(self, parent: QWidget, text: str = "") -> None:
         super().__init__(parent=parent)
@@ -91,6 +89,6 @@ def getLabel(cls, parent: QWidget, text: str) -> tuple[str, bool]:
         cls = GuiEditLabel(parent, text=text)
         cls.exec()
         label = cls.itemLabel
-        accepted = cls.result() == QDialog.DialogCode.Accepted
-        cls.deleteLater()
+        accepted = cls.result() == QtAccepted
+        cls.softDelete()
         return label, accepted

novelwriter/dialogs/preferences.py

@@ -27,18 +27,20 @@
 import logging
 
 from PyQt5.QtCore import Qt, pyqtSignal, pyqtSlot
-from PyQt5.QtGui import QCloseEvent, QKeyEvent, QKeySequence
+from PyQt5.QtGui import QCloseEvent
 from PyQt5.QtWidgets import (
-    QAbstractButton, QApplication, QCompleter, QDialog, QDialogButtonBox,
-    QFileDialog, QHBoxLayout, QLineEdit, QPushButton, QVBoxLayout, QWidget
+    QAbstractButton, QApplication, QCompleter, QDialogButtonBox, QFileDialog,
+    QHBoxLayout, QLineEdit, QPushButton, QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.common import describeFont
 from novelwriter.constants import nwConst, nwUnicode
 from novelwriter.dialogs.quotes import GuiQuoteSelect
 from novelwriter.extensions.configlayout import NColourLabel, NScrollableForm
-from novelwriter.extensions.modified import NComboBox, NDoubleSpinBox, NIconToolButton, NSpinBox
+from novelwriter.extensions.modified import (
+    NComboBox, NDialog, NDoubleSpinBox, NIconToolButton, NSpinBox
+)
 from novelwriter.extensions.pagedsidebar import NPagedSideBar
 from novelwriter.extensions.switch import NSwitch
 from novelwriter.types import (
@@ -49,7 +51,7 @@
 logger = logging.getLogger(__name__)
 
 
-class GuiPreferences(QDialog):
+class GuiPreferences(NDialog):
 
     newPreferencesReady = pyqtSignal(bool, bool, bool, bool)
 
@@ -769,14 +771,7 @@ def closeEvent(self, event: QCloseEvent) -> None:
         event.accept()
         QApplication.processEvents()
         self.done(nwConst.DLG_FINISHED)
-        self.deleteLater()
-        return
-
-    def keyPressEvent(self, event: QKeyEvent) -> None:
-        """Overload keyPressEvent to block enter key to save."""
-        if event.matches(QKeySequence.StandardKey.Cancel):
-            self.close()
-        event.ignore()
+        self.softDelete()
         return
 
     ##

novelwriter/dialogs/projectsettings.py

@@ -29,7 +29,7 @@
 from PyQt5.QtCore import Qt, pyqtSignal, pyqtSlot
 from PyQt5.QtGui import QCloseEvent, QColor
 from PyQt5.QtWidgets import (
-    QAbstractItemView, QApplication, QColorDialog, QDialog, QDialogButtonBox,
+    QAbstractItemView, QApplication, QColorDialog, QDialogButtonBox,
     QHBoxLayout, QLineEdit, QMenu, QStackedWidget, QToolButton, QTreeWidget,
     QTreeWidgetItem, QVBoxLayout, QWidget
 )
@@ -40,7 +40,7 @@
 from novelwriter.core.status import NWStatus, StatusEntry
 from novelwriter.enum import nwStatusShape
 from novelwriter.extensions.configlayout import NColourLabel, NFixedPage, NScrollableForm
-from novelwriter.extensions.modified import NComboBox, NIconToolButton
+from novelwriter.extensions.modified import NComboBox, NDialog, NIconToolButton
 from novelwriter.extensions.pagedsidebar import NPagedSideBar
 from novelwriter.extensions.switch import NSwitch
 from novelwriter.types import (
@@ -51,7 +51,7 @@
 logger = logging.getLogger(__name__)
 
 
-class GuiProjectSettings(QDialog):
+class GuiProjectSettings(NDialog):
 
     PAGE_SETTINGS = 0
     PAGE_STATUS   = 1
@@ -147,7 +147,7 @@ def closeEvent(self, event: QCloseEvent) -> None:
         """Capture the user closing the window and save settings."""
         self._saveSettings()
         event.accept()
-        self.deleteLater()
+        self.softDelete()
         return
 
     ##

novelwriter/dialogs/quotes.py

@@ -28,18 +28,22 @@
 from PyQt5.QtCore import QSize, pyqtSlot
 from PyQt5.QtGui import QFontMetrics
 from PyQt5.QtWidgets import (
-    QDialog, QDialogButtonBox, QFrame, QHBoxLayout, QLabel, QListWidget,
+    QDialogButtonBox, QFrame, QHBoxLayout, QLabel, QListWidget,
     QListWidgetItem, QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG
 from novelwriter.constants import nwQuotes, trConst
-from novelwriter.types import QtAlignCenter, QtAlignTop, QtDialogCancel, QtDialogOk, QtUserRole
+from novelwriter.extensions.modified import NDialog
+from novelwriter.types import (
+    QtAccepted, QtAlignCenter, QtAlignTop, QtDialogCancel, QtDialogOk,
+    QtUserRole
+)
 
 logger = logging.getLogger(__name__)
 
 
-class GuiQuoteSelect(QDialog):
+class GuiQuoteSelect(NDialog):
 
     _selected = ""
 
@@ -126,8 +130,8 @@ def getQuote(cls, parent: QWidget, current: str = "") -> tuple[str, bool]:
         cls = GuiQuoteSelect(parent, current=current)
         cls.exec()
         quote = cls._selected
-        accepted = cls.result() == QDialog.DialogCode.Accepted
-        cls.deleteLater()
+        accepted = cls.result() == QtAccepted
+        cls.softDelete()
         return quote, accepted
 
     ##

novelwriter/dialogs/wordlist.py

@@ -30,21 +30,21 @@
 from PyQt5.QtCore import Qt, pyqtSignal, pyqtSlot
 from PyQt5.QtGui import QCloseEvent
 from PyQt5.QtWidgets import (
-    QAbstractItemView, QApplication, QDialog, QDialogButtonBox, QFileDialog,
+    QAbstractItemView, QApplication, QDialogButtonBox, QFileDialog,
     QHBoxLayout, QLineEdit, QListWidget, QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.common import formatFileFilter
 from novelwriter.core.spellcheck import UserDictionary
 from novelwriter.extensions.configlayout import NColourLabel
-from novelwriter.extensions.modified import NIconToolButton
+from novelwriter.extensions.modified import NDialog, NIconToolButton
 from novelwriter.types import QtDialogClose, QtDialogSave
 
 logger = logging.getLogger(__name__)
 
 
-class GuiWordList(QDialog):
+class GuiWordList(NDialog):
 
     newWordListReady = pyqtSignal()
 
@@ -140,7 +140,7 @@ def closeEvent(self, event: QCloseEvent) -> None:
         """Capture the close event and perform cleanup."""
         self._saveGuiSettings()
         event.accept()
-        self.deleteLater()
+        self.softDelete()
         return
 
     ##