novelWriter 2.2rc1__py3-none-any.whl → 2.3b1__py3-none-any.whl

novelwriter/shared.py

@@ -3,10 +3,11 @@ novelWriter – Shared Data Class
 ===============================
 
 File History:
-Created: 2023-08-10 [2.1rc1]
+Created: 2023-08-10 [2.1rc1] SharedData
+Created: 2023-08-14 [2.1rc1] _GuiAlert
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -26,12 +27,14 @@ from __future__ import annotations
 import logging
 
 from time import time
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, TypeVar
 from pathlib import Path
 
 from PyQt5.QtCore import QObject, QRunnable, QThreadPool, pyqtSignal
-from PyQt5.QtWidgets import QMessageBox, QWidget
+from PyQt5.QtWidgets import QFileDialog, QMessageBox, QWidget
+from novelwriter.common import formatFileFilter
 
+from novelwriter.constants import nwFiles
 from novelwriter.core.spellcheck import NWSpellEnchant
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -41,11 +44,13 @@ if TYPE_CHECKING:  # pragma: no cover
 
 logger = logging.getLogger(__name__)
 
+NWWidget = TypeVar("NWWidget", bound=QWidget)
+
 
 class SharedData(QObject):
 
     __slots__ = (
-        "_gui", "_theme", "_project", "_spelling", "_lockedBy", "_alert",
+        "_gui", "_theme", "_project", "_spelling", "_lockedBy", "_lastAlert",
         "_idleTime", "_idleRefTime",
     )
 
@@ -68,7 +73,7 @@ class SharedData(QObject):
 
         # Settings
         self._lockedBy = None
-        self._alert = None
+        self._lastAlert = ""
         self._idleTime = 0.0
         self._idleRefTime = time()
 
@@ -122,9 +127,9 @@ class SharedData(QObject):
         return self._idleTime
 
     @property
-    def alert(self) -> _GuiAlert | None:
-        """Return a pointer to the last alert box."""
-        return self._alert
+    def lastAlert(self) -> str:
+        """Return the last alert message."""
+        return self._lastAlert
 
     ##
     #  Methods
@@ -214,6 +219,25 @@ class SharedData(QObject):
         QThreadPool.globalInstance().start(runnable, priority=priority)
         return
 
+    def getProjectPath(self, parent: QWidget, path: str | Path | None = None,
+                       allowZip: bool = False) -> Path | None:
+        """Open the file dialog and select a novelWriter project file."""
+        label = (self.tr("novelWriter Project File or Zip File")
+                 if allowZip else self.tr("novelWriter Project File"))
+        ext = f"{nwFiles.PROJ_FILE} *.zip" if allowZip else nwFiles.PROJ_FILE
+        ffilter = formatFileFilter([(label, ext), "*"])
+        selected, _ = QFileDialog.getOpenFileName(
+            parent, self.tr("Open Project"), str(path or ""), filter=ffilter
+        )
+        return Path(selected) if selected else None
+
+    def findTopLevelWidget(self, kind: type[NWWidget]) -> NWWidget | None:
+        """Find a top level widget."""
+        for widget in self.mainGui.children():
+            if isinstance(widget, kind):
+                return widget
+        return None
+
     ##
     #  Signal Proxy
     ##
@@ -238,44 +262,53 @@ class SharedData(QObject):
 
     def info(self, text: str, info: str = "", details: str = "", log: bool = True) -> None:
         """Open an information alert box."""
-        self._alert = _GuiAlert(self.mainGui, self.theme)
-        self._alert.setMessage(text, info, details)
-        self._alert.setAlertType(_GuiAlert.INFO, False)
+        alert = _GuiAlert(self.mainGui, self.theme)
+        alert.setMessage(text, info, details)
+        alert.setAlertType(_GuiAlert.INFO, False)
+        self._lastAlert = alert.logMessage
         if log:
-            logger.info(self._alert.logMessage, stacklevel=2)
-        self._alert.exec_()
+            logger.info(self._lastAlert, stacklevel=2)
+        alert.exec_()
+        alert.deleteLater()
         return
 
     def warn(self, text: str, info: str = "", details: str = "", log: bool = True) -> None:
         """Open a warning alert box."""
-        self._alert = _GuiAlert(self.mainGui, self.theme)
-        self._alert.setMessage(text, info, details)
-        self._alert.setAlertType(_GuiAlert.WARN, False)
+        alert = _GuiAlert(self.mainGui, self.theme)
+        alert.setMessage(text, info, details)
+        alert.setAlertType(_GuiAlert.WARN, False)
+        self._lastAlert = alert.logMessage
         if log:
-            logger.warning(self._alert.logMessage, stacklevel=2)
-        self._alert.exec_()
+            logger.warning(self._lastAlert, stacklevel=2)
+        alert.exec_()
+        alert.deleteLater()
         return
 
     def error(self, text: str, info: str = "", details: str = "", log: bool = True,
               exc: Exception | None = None) -> None:
         """Open an error alert box."""
-        self._alert = _GuiAlert(self.mainGui, self.theme)
-        self._alert.setMessage(text, info, details)
-        self._alert.setAlertType(_GuiAlert.ERROR, False)
+        alert = _GuiAlert(self.mainGui, self.theme)
+        alert.setMessage(text, info, details)
+        alert.setAlertType(_GuiAlert.ERROR, False)
         if exc:
-            self._alert.setException(exc)
+            alert.setException(exc)
+        self._lastAlert = alert.logMessage
         if log:
-            logger.error(self._alert.logMessage, stacklevel=2)
-        self._alert.exec_()
+            logger.error(self._lastAlert, stacklevel=2)
+        alert.exec_()
+        alert.deleteLater()
         return
 
     def question(self, text: str, info: str = "", details: str = "", warn: bool = False) -> bool:
         """Open a question box."""
-        self._alert = _GuiAlert(self.mainGui, self.theme)
-        self._alert.setMessage(text, info, details)
-        self._alert.setAlertType(_GuiAlert.WARN if warn else _GuiAlert.ASK, True)
-        self._alert.exec_()
-        return self._alert.result() == QMessageBox.Yes
+        alert = _GuiAlert(self.mainGui, self.theme)
+        alert.setMessage(text, info, details)
+        alert.setAlertType(_GuiAlert.WARN if warn else _GuiAlert.ASK, True)
+        self._lastAlert = alert.logMessage
+        alert.exec_()
+        isYes = alert.result() == QMessageBox.StandardButton.Yes
+        alert.deleteLater()
+        return isYes
 
     ##
     #  Internal Functions
@@ -312,6 +345,11 @@ class _GuiAlert(QMessageBox):
         super().__init__(parent=parent)
         self._theme = theme
         self._message = ""
+        logger.debug("Ready: _GuiAlert")
+        return
+
+    def __del__(self) -> None:  # pragma: no cover
+        logger.debug("Delete: _GuiAlert")
         return
 
     @property

novelwriter/tools/dictionaries.py

@@ -3,10 +3,10 @@ novelWriter – GUI Dictionary Downloader
 =======================================
 
 File History:
-Created: 2023-11-19 [2.2rc1]
+Created: 2023-11-19 [2.2rc1] GuiDictionaries
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -37,7 +37,7 @@ from PyQt5.QtWidgets import (
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.error import formatException
-from novelwriter.common import openExternalPath, formatInt, getFileSize
+from novelwriter.common import formatFileFilter, openExternalPath, formatInt, getFileSize
 
 logger = logging.getLogger(__name__)
 
@@ -180,12 +180,11 @@ class GuiDictionaries(QDialog):
     @pyqtSlot()
     def _doBrowseHunspell(self):
         """Browse for a Free/Libre Office dictionary."""
-        extFilter = [
-            self.tr("Free or Libre Office extension ({0})").format("*.sox *.oxt"),
-            self.tr("All files ({0})").format("*"),
-        ]
+        ffilter = formatFileFilter([
+            (self.tr("Free or Libre Office extension"), "*.sox *.oxt"), "*"
+        ])
         soxFile, _ = QFileDialog.getOpenFileName(
-            self, self.tr("Browse Files"), "", filter=";;".join(extFilter)
+            self, self.tr("Browse Files"), "", filter=ffilter
         )
         if soxFile:
             path = Path(soxFile).absolute()

novelwriter/tools/lipsum.py

@@ -3,10 +3,10 @@ novelWriter – Lorem Ipsum Tool
 ==============================
 
 File History:
-Created: 2022-04-02 [2.0rc1]
+Created: 2022-04-02 [2.0rc1] GuiLipsum
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -26,10 +26,10 @@ from __future__ import annotations
 import random
 import logging
 
-from PyQt5.QtCore import Qt
+from PyQt5.QtCore import Qt, pyqtSlot
 from PyQt5.QtWidgets import (
-    QDialog, QGridLayout, QHBoxLayout, QVBoxLayout, QLabel, QDialogButtonBox,
-    QSpinBox
+    QDialog, QDialogButtonBox, QGridLayout, QHBoxLayout, QLabel, QSpinBox,
+    QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG, SHARED
@@ -41,15 +41,15 @@ logger = logging.getLogger(__name__)
 
 class GuiLipsum(QDialog):
 
-    def __init__(self, mainGui):
-        super().__init__(parent=mainGui)
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
 
         logger.debug("Create: GuiLipsum")
         self.setObjectName("GuiLipsum")
         if CONFIG.osDarwin:
             self.setWindowFlag(Qt.WindowType.Tool)
 
-        self.mainGui = mainGui
+        self._lipsumText = ""
 
         self.setWindowTitle(self.tr("Insert Placeholder Text"))
 
@@ -92,14 +92,16 @@ class GuiLipsum(QDialog):
 
         # Buttons
         self.buttonBox = QDialogButtonBox()
-        self.buttonBox.rejected.connect(self._doClose)
+        self.buttonBox.rejected.connect(self.close)
 
         self.btnClose = self.buttonBox.addButton(QDialogButtonBox.Close)
         self.btnClose.setAutoDefault(False)
 
-        self.btnSave = self.buttonBox.addButton(self.tr("Insert"), QDialogButtonBox.ActionRole)
-        self.btnSave.clicked.connect(self._doInsert)
-        self.btnSave.setAutoDefault(False)
+        self.btnInsert = self.buttonBox.addButton(self.tr("Insert"), QDialogButtonBox.ActionRole)
+        self.btnInsert.clicked.connect(self._doInsert)
+        self.btnInsert.setAutoDefault(False)
+
+        self.rejected.connect(self.close)
 
         # Assemble
         self.outerBox = QVBoxLayout()
@@ -112,33 +114,37 @@ class GuiLipsum(QDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiLipsum")
         return
 
+    @property
+    def lipsumText(self) -> str:
+        """Return the generated text."""
+        return self._lipsumText
+
+    @classmethod
+    def getLipsum(cls, parent: QWidget) -> str:
+        """Pop the dialog and return the lipsum text."""
+        cls = GuiLipsum(parent)
+        cls.exec_()
+        text = cls.lipsumText
+        cls.deleteLater()
+        return text
+
     ##
-    #  Slots
+    #  Private Slots
     ##
 
-    def _doInsert(self):
-        """Load the text and insert it in the open document.
-        """
+    @pyqtSlot()
+    def _doInsert(self) -> None:
+        """Generate the text."""
         lipsumFile = CONFIG.assetPath("text") / "lipsum.txt"
         lipsumText = readTextFile(lipsumFile).splitlines()
-
         if self.randSwitch.isChecked():
             random.shuffle(lipsumText)
-
         pCount = self.paraCount.value()
-        inText = "\n\n".join(lipsumText[0:pCount]) + "\n\n"
-
-        self.mainGui.docEditor.insertText(inText)
-
-        return
-
-    def _doClose(self):
-        """Close the dialog window without doing anything.
-        """
+        self._lipsumText = "\n\n".join(lipsumText[0:pCount]) + "\n\n"
         self.close()
         return
 

novelwriter/tools/manusbuild.py

@@ -6,7 +6,7 @@ File History:
 Created: 2023-05-24 [2.1b1] GuiManuscriptBuild
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -331,7 +331,7 @@ class GuiManuscriptBuild(QDialog):
         self._build.setLastBuildName(bName)
         self._build.setLastFormat(bFormat)
 
-        QTimer.singleShot(1000, self._resetProgress)
+        QTimer.singleShot(3000, self._resetProgress)
 
         return True
 
@@ -344,8 +344,6 @@ class GuiManuscriptBuild(QDialog):
 
     def _saveSettings(self):
         """Save the user GUI settings."""
-        logger.debug("Saving GuiManuscriptBuild settings")
-
         winWidth  = CONFIG.rpxInt(self.width())
         winHeight = CONFIG.rpxInt(self.height())
 
@@ -353,6 +351,7 @@ class GuiManuscriptBuild(QDialog):
         fmtWidth = CONFIG.rpxInt(mainSplit[0])
         sumWidth = CONFIG.rpxInt(mainSplit[1])
 
+        logger.debug("Saving State: GuiManuscriptBuild")
         pOptions = SHARED.project.options
         pOptions.setValue("GuiManuscriptBuild", "winWidth", winWidth)
         pOptions.setValue("GuiManuscriptBuild", "winHeight", winHeight)

novelwriter/tools/manuscript.py

@@ -6,7 +6,7 @@ File History:
 Created: 2023-05-13 [2.1b1] GuiManuscript
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, Veronica Berglyd Olsen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -66,7 +66,7 @@ class GuiManuscript(QDialog):
 
     D_KEY = Qt.ItemDataRole.UserRole
 
-    def __init__(self, mainGui: GuiMain):
+    def __init__(self, mainGui: GuiMain) -> None:
         super().__init__(parent=mainGui)
 
         logger.debug("Create: GuiManuscript")
@@ -173,7 +173,7 @@ class GuiManuscript(QDialog):
         self.btnBuild.clicked.connect(self._buildManuscript)
 
         self.btnClose = QPushButton(self.tr("Close"))
-        self.btnClose.clicked.connect(self._doClose)
+        self.btnClose.clicked.connect(self.close)
 
         self.processBox = QGridLayout()
         self.processBox.addWidget(self.btnPreview, 0, 0)
@@ -217,11 +217,11 @@ class GuiManuscript(QDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiManuscript")
         return
 
-    def loadContent(self):
+    def loadContent(self) -> None:
         """Load dialog content from project data."""
         if len(self._builds) == 0:
             build = BuildSettings()
@@ -255,7 +255,7 @@ class GuiManuscript(QDialog):
     #  Events
     ##
 
-    def closeEvent(self, event: QCloseEvent):
+    def closeEvent(self, event: QCloseEvent) -> None:
         """Capture the user closing the window so we can save GUI
         settings. We also check that we don't have a build settings
         dialog open.
@@ -274,7 +274,7 @@ class GuiManuscript(QDialog):
     ##
 
     @pyqtSlot()
-    def _createNewBuild(self):
+    def _createNewBuild(self) -> None:
         """Open the build settings dialog for a new build."""
         build = BuildSettings()
         build.setName(self.tr("My Manuscript"))
@@ -282,7 +282,7 @@ class GuiManuscript(QDialog):
         return
 
     @pyqtSlot()
-    def _editSelectedBuild(self):
+    def _editSelectedBuild(self) -> None:
         """Edit the currently selected build settings entry."""
         build = self._getSelectedBuild()
         if build is not None:
@@ -299,7 +299,7 @@ class GuiManuscript(QDialog):
         return
 
     @pyqtSlot()
-    def _deleteSelectedBuild(self):
+    def _deleteSelectedBuild(self) -> None:
         """Delete the currently selected build settings entry."""
         build = self._getSelectedBuild()
         if build is not None:
@@ -309,7 +309,7 @@ class GuiManuscript(QDialog):
         return
 
     @pyqtSlot(BuildSettings)
-    def _processNewSettings(self, build: BuildSettings):
+    def _processNewSettings(self, build: BuildSettings) -> None:
         """Process new build settings from the settings dialog."""
         self._builds.setBuild(build)
         self._updateBuildItem(build)
@@ -319,7 +319,7 @@ class GuiManuscript(QDialog):
         return
 
     @pyqtSlot()
-    def _generatePreview(self):
+    def _generatePreview(self) -> None:
         """Run the document builder on the current build settings for
         the preview widget.
         """
@@ -359,7 +359,7 @@ class GuiManuscript(QDialog):
         return
 
     @pyqtSlot()
-    def _buildManuscript(self):
+    def _buildManuscript(self) -> None:
         """Open the build dialog and build the manuscript."""
         build = self._getSelectedBuild()
         if isinstance(build, BuildSettings):
@@ -373,24 +373,18 @@ class GuiManuscript(QDialog):
         return
 
     @pyqtSlot()
-    def _printDocument(self):
+    def _printDocument(self) -> None:
         """Open the print preview dialog."""
-        thePreview = QPrintPreviewDialog(self)
-        thePreview.paintRequested.connect(self.docPreview.printPreview)
-        thePreview.exec_()
-        return
-
-    @pyqtSlot()
-    def _doClose(self):
-        """Forward the close button to the default close method."""
-        self.close()
+        preview = QPrintPreviewDialog(self)
+        preview.paintRequested.connect(self.docPreview.printPreview)
+        preview.exec_()
         return
 
     ##
     #  Internal Functions
     ##
 
-    def _updatePreview(self, data: dict, build: BuildSettings):
+    def _updatePreview(self, data: dict, build: BuildSettings) -> None:
         """Update the preview widget and set relevant values."""
         self.docPreview.setContent(data)
         self.docPreview.setBuildName(build.name)
@@ -415,10 +409,8 @@ class GuiManuscript(QDialog):
                 return build
         return None
 
-    def _saveSettings(self):
+    def _saveSettings(self) -> None:
         """Save the user GUI settings."""
-        logger.debug("Saving GuiManuscript settings")
-
         buildOrder = []
         for i in range(self.buildList.count()):
             if item := self.buildList.item(i):
@@ -442,6 +434,7 @@ class GuiManuscript(QDialog):
         detailsWidth = CONFIG.rpxInt(self.buildDetails.getColumnWidth())
         detailsExpanded = self.buildDetails.getExpandedState()
 
+        logger.debug("Saving State: GuiManuscript")
         pOptions = SHARED.project.options
         pOptions.setValue("GuiManuscript", "winWidth", winWidth)
         pOptions.setValue("GuiManuscript", "winHeight", winHeight)
@@ -455,7 +448,7 @@ class GuiManuscript(QDialog):
 
         return
 
-    def _openSettingsDialog(self, build: BuildSettings):
+    def _openSettingsDialog(self, build: BuildSettings) -> None:
         """Open the build settings dialog."""
         for obj in self.mainGui.children():
             # Don't open a second dialog if one exists
@@ -476,7 +469,7 @@ class GuiManuscript(QDialog):
 
         return
 
-    def _updateBuildsList(self):
+    def _updateBuildsList(self) -> None:
         """Update the list of available builds."""
         self.buildList.clear()
         for key, name in self._builds.builds():
@@ -488,7 +481,7 @@ class GuiManuscript(QDialog):
             self._buildMap[key] = bItem
         return
 
-    def _updateBuildItem(self, build: BuildSettings):
+    def _updateBuildItem(self, build: BuildSettings) -> None:
         """Update the entry of a specific build item."""
         bItem = self._buildMap.get(build.buildID, None)
         if isinstance(bItem, QListWidgetItem):
@@ -611,7 +604,7 @@ class _DetailsWidget(QWidget):
         for key in entries:
             sub = QTreeWidgetItem()
             sub.setText(0, build.getLabel(key))
-            sub.setText(1, hFmt.apply(build.getStr(key), title))
+            sub.setText(1, hFmt.apply(build.getStr(key), title, 0))
             item.addChild(sub)
         for key in ["headings.hideScene", "headings.hideSection"]:
             sub = QTreeWidgetItem()
@@ -778,8 +771,8 @@ class _PreviewWidget(QTextBrowser):
         self.setHtml(html)
         qApp.processEvents()
         while self.find("!!tab!!"):
-            theCursor = self.textCursor()
-            theCursor.insertText("\t")
+            cursor = self.textCursor()
+            cursor.insertText("\t")
 
         self.verticalScrollBar().setValue(sPos)
         self._docTime = checkInt(data.get("time"), 0)