novelWriter 2.2.1__py3-none-any.whl → 2.3__py3-none-any.whl

novelwriter/guimain.py

@@ -30,14 +30,15 @@ from time import time
 from pathlib import Path
 from datetime import datetime
 
-from PyQt5.QtCore import Qt, QTimer, pyqtSlot
 from PyQt5.QtGui import QCloseEvent, QCursor, QIcon
+from PyQt5.QtCore import Qt, QTimer, pyqtSlot
 from PyQt5.QtWidgets import (
-    QDialog, QFileDialog, QHBoxLayout, QMainWindow, QMessageBox, QShortcut,
-    QSplitter, QStackedWidget, QVBoxLayout, QWidget, qApp
+    QFileDialog, QHBoxLayout, QMainWindow, QMessageBox, QShortcut, QSplitter,
+    QStackedWidget, QVBoxLayout, QWidget, qApp
 )
 
-from novelwriter import CONFIG, SHARED, __hexversion__
+from novelwriter import CONFIG, SHARED, __hexversion__, __version__
+from novelwriter.constants import nwConst
 from novelwriter.gui.theme import GuiTheme
 from novelwriter.gui.sidebar import GuiSideBar
 from novelwriter.gui.outline import GuiOutlineView
@@ -50,23 +51,19 @@ from novelwriter.gui.statusbar import GuiMainStatus
 from novelwriter.gui.itemdetails import GuiItemDetails
 from novelwriter.gui.docviewerpanel import GuiDocViewerPanel
 from novelwriter.dialogs.about import GuiAbout
-from novelwriter.dialogs.updates import GuiUpdates
-from novelwriter.dialogs.projload import GuiProjectLoad
 from novelwriter.dialogs.wordlist import GuiWordList
 from novelwriter.dialogs.preferences import GuiPreferences
-from novelwriter.dialogs.projdetails import GuiProjectDetails
-from novelwriter.dialogs.projsettings import GuiProjectSettings
+from novelwriter.dialogs.projectsettings import GuiProjectSettings
+from novelwriter.tools.welcome import GuiWelcome
 from novelwriter.tools.manuscript import GuiManuscript
-from novelwriter.tools.projwizard import GuiProjectWizard
 from novelwriter.tools.dictionaries import GuiDictionaries
+from novelwriter.tools.noveldetails import GuiNovelDetails
 from novelwriter.tools.writingstats import GuiWritingStats
-from novelwriter.core.coretools import ProjectBuilder
 
 from novelwriter.enum import (
-    nwDocAction, nwDocInsert, nwDocMode, nwItemType, nwItemClass, nwWidget, nwView
+    nwDocAction, nwDocInsert, nwDocMode, nwItemType, nwWidget, nwView
 )
-from novelwriter.common import hexToInt
-from novelwriter.constants import nwFiles
+from novelwriter.common import formatFileFilter, formatVersion, hexToInt
 
 logger = logging.getLogger(__name__)
 
@@ -82,13 +79,6 @@ class GuiMain(QMainWindow):
     function. Also, the project instance and theme instance are created
     here. These should be passed around to all other objects who need
     them and new instances of them should generally not be created.
-
-      * All other GUI classes that depend on any components from the
-        main GUI should be passed a reference to the instance of this
-        class.
-      * All non-GUI classes can be passed a reference to the NWProject
-        instance if the Main GUI is not needed (which it generally
-        shouldn't need).
     """
 
     def __init__(self) -> None:
@@ -359,12 +349,18 @@ class GuiMain(QMainWindow):
             self.openProject(cmdOpen)
 
         if not SHARED.hasProject:
-            self.showProjectLoadDialog()
+            self.showWelcomeDialog()
 
-        # Determine whether release notes need to be shown or not
+        # If this is a new release, let the user know
         if hexToInt(CONFIG.lastNotes) < hexToInt(__hexversion__):
             CONFIG.lastNotes = __hexversion__
-            self.showAboutNWDialog(showNotes=True)
+            trVersion = self.tr(
+                "You are now running novelWriter version {0}.".format(formatVersion(__version__))
+            )
+            trRelease = self.tr(
+                "Please check the {0}release notes{1} for further details."
+            ).format(f"<a href='{nwConst.URL_RELEASES}'>", "</a>")
+            SHARED.info(f"{trVersion}<br>{trRelease}")
 
         return
 
@@ -372,42 +368,6 @@ class GuiMain(QMainWindow):
     #  Project Actions
     ##
 
-    def newProject(self, projData: dict | None = None) -> bool:
-        """Create a new project via the new project wizard."""
-        if SHARED.hasProject:
-            if not self.closeProject():
-                SHARED.error(self.tr(
-                    "Cannot create a new project when another project is open."
-                ))
-                return False
-
-        if projData is None:
-            projData = self.showNewProjectDialog()
-
-        if projData is None:
-            return False
-
-        projPath = projData.get("projPath", None)
-        if projPath is None or projData is None:
-            logger.error("No projData or projPath set")
-            return False
-
-        if (Path(projPath) / nwFiles.PROJ_FILE).is_file():
-            SHARED.error(self.tr(
-                "A project already exists in that location. "
-                "Please choose another folder."
-            ))
-            return False
-
-        logger.info("Creating new project")
-        nwProject = ProjectBuilder()
-        if nwProject.buildProject(projData):
-            self.openProject(projPath)
-        else:
-            return False
-
-        return True
-
     def closeProject(self, isYes: bool = False) -> bool:
         """Close the project if one is open. isYes is passed on from the
         close application event so the user doesn't get prompted twice
@@ -446,7 +406,7 @@ class GuiMain(QMainWindow):
             self.docViewerPanel.closeProjectTasks()
             self.outlineView.closeProjectTasks()
             self.novelView.closeProjectTasks()
-            self.projView.clearProjectView()
+            self.projView.closeProjectTasks()
             self.itemDetails.clearDetails()
             self.mainStatus.clearStatus()
 
@@ -462,8 +422,7 @@ class GuiMain(QMainWindow):
         if projFile is None:
             return False
 
-        # Make sure any open project is cleared out first before we load
-        # another one
+        # Make sure any open project is cleared out first
         if not self.closeProject():
             return False
 
@@ -711,14 +670,9 @@ class GuiMain(QMainWindow):
             return False
 
         lastPath = CONFIG.lastPath()
-        extFilter = [
-            self.tr("Text files ({0})").format("*.txt"),
-            self.tr("Markdown files ({0})").format("*.md"),
-            self.tr("novelWriter files ({0})").format("*.nwd"),
-            self.tr("All files ({0})").format("*"),
-        ]
+        ffilter = formatFileFilter(["*.txt", "*.md", "*.nwd", "*"])
         loadFile, _ = QFileDialog.getOpenFileName(
-            self, self.tr("Import File"), str(lastPath), filter=";;".join(extFilter)
+            self, self.tr("Import File"), str(lastPath), filter=ffilter
         )
         if not loadFile:
             return False
@@ -726,10 +680,10 @@ class GuiMain(QMainWindow):
         if loadFile.strip() == "":
             return False
 
-        theText = None
+        text = None
         try:
             with open(loadFile, mode="rt", encoding="utf-8") as inFile:
-                theText = inFile.read()
+                text = inFile.read()
             CONFIG.setLastPath(loadFile)
         except Exception as exc:
             SHARED.error(self.tr(
@@ -751,7 +705,7 @@ class GuiMain(QMainWindow):
             if not msgYes:
                 return False
 
-        self.docEditor.replaceText(theText)
+        self.docEditor.replaceText(text)
 
         return True
 
@@ -838,33 +792,14 @@ class GuiMain(QMainWindow):
     #  Main Dialogs
     ##
 
-    def showProjectLoadDialog(self) -> None:
-        """Open the projects dialog for selecting either existing
-        projects from a cache of recently opened projects, or provide a
-        browse button for projects not yet cached. Selecting to create a
-        new project is forwarded to the new project wizard.
-        """
-        dlgProj = GuiProjectLoad(self)
-        dlgProj.exec_()
-
-        if dlgProj.result() == QDialog.Accepted:
-            if dlgProj.openState == GuiProjectLoad.OPEN_STATE:
-                self.openProject(dlgProj.openPath)
-            elif dlgProj.openState == GuiProjectLoad.NEW_STATE:
-                self.newProject()
-
+    @pyqtSlot()
+    def showWelcomeDialog(self) -> None:
+        """Open the welcome dialog."""
+        dialog = GuiWelcome(self)
+        dialog.openProjectRequest.connect(self._openProjectFromWelcome)
+        dialog.exec_()
         return
 
-    def showNewProjectDialog(self) -> dict | None:
-        """Open the wizard and assemble a project options dict."""
-        newProj = GuiProjectWizard(self)
-        newProj.exec_()
-
-        if newProj.result() == QDialog.Accepted:
-            return self._assembleProjectWizardData(newProj)
-
-        return None
-
     @pyqtSlot()
     def showPreferencesDialog(self) -> None:
         """Open the preferences dialog."""
@@ -875,19 +810,19 @@ class GuiMain(QMainWindow):
 
     @pyqtSlot()
     @pyqtSlot(int)
-    def showProjectSettingsDialog(self, focusTab: int = GuiProjectSettings.TAB_MAIN) -> None:
+    def showProjectSettingsDialog(self, focusTab: int = GuiProjectSettings.PAGE_SETTINGS) -> None:
         """Open the project settings dialog."""
         if SHARED.hasProject:
-            dialog = GuiProjectSettings(self, focusTab=focusTab)
+            dialog = GuiProjectSettings(self, gotoPage=focusTab)
             dialog.newProjectSettingsReady.connect(self._processProjectSettingsChanges)
             dialog.exec_()
         return
 
     @pyqtSlot()
-    def showProjectDetailsDialog(self) -> None:
-        """Open the project details dialog."""
+    def showNovelDetailsDialog(self) -> None:
+        """Open the novel details dialog."""
         if SHARED.hasProject:
-            dialog = GuiProjectDetails(self)
+            dialog = GuiNovelDetails(self)
             dialog.setModal(True)
             dialog.show()
             dialog.raise_()
@@ -931,7 +866,7 @@ class GuiMain(QMainWindow):
         return
 
     @pyqtSlot()
-    def showAboutNWDialog(self, showNotes: bool = False) -> None:
+    def showAboutNWDialog(self) -> None:
         """Show the novelWriter about dialog."""
         dialog = GuiAbout(self)
         dialog.setModal(True)
@@ -939,8 +874,6 @@ class GuiMain(QMainWindow):
         dialog.raise_()
         qApp.processEvents()
         dialog.populateGUI()
-        if showNotes:
-            dialog.showReleaseNotes()
         return
 
     @pyqtSlot()
@@ -950,17 +883,6 @@ class GuiMain(QMainWindow):
         msgBox.aboutQt(self, "About Qt")
         return
 
-    @pyqtSlot()
-    def showUpdatesDialog(self) -> None:
-        """Show the check for updates dialog."""
-        dialog = GuiUpdates(self)
-        dialog.setModal(True)
-        dialog.show()
-        dialog.raise_()
-        qApp.processEvents()
-        dialog.checkLatest()
-        return
-
     @pyqtSlot()
     def showDictionariesDialog(self) -> None:
         """Show the download dictionaries dialog."""
@@ -1179,13 +1101,15 @@ class GuiMain(QMainWindow):
 
         return
 
-    @pyqtSlot()
-    def _processProjectSettingsChanges(self) -> None:
+    @pyqtSlot(bool)
+    def _processProjectSettingsChanges(self, rebuildTrees: bool) -> None:
         """Refresh data dependent on project settings."""
         logger.debug("Applying new project settings")
         SHARED.updateSpellCheckLanguage()
         self.itemDetails.refreshDetails()
         self._updateWindowTitle(SHARED.project.data.name)
+        if rebuildTrees:
+            self.rebuildTrees()
         return
 
     @pyqtSlot()
@@ -1207,6 +1131,15 @@ class GuiMain(QMainWindow):
                 self.viewDocument(tHandle=tHandle, sTitle=sTitle)
         return
 
+    @pyqtSlot(Path)
+    def _openProjectFromWelcome(self, path: Path) -> None:
+        """Handle an open project request from the welcome dialog."""
+        qApp.processEvents()
+        self.openProject(path)
+        if not SHARED.hasProject:
+            self.showWelcomeDialog()
+        return
+
     @pyqtSlot(str, nwDocMode, str, bool)
     def _openDocument(self, tHandle: str, mode: nwDocMode, sTitle: str, setFocus: bool) -> None:
         """Handle an open document request."""
@@ -1461,44 +1394,6 @@ class GuiMain(QMainWindow):
         self.setWindowTitle(winTitle)
         return
 
-    def _assembleProjectWizardData(self, newProj: GuiProjectWizard) -> dict:
-        """Extract the user choices from the New Project Wizard and
-        store them in a dictionary.
-        """
-        projData = {
-            "projName": newProj.field("projName"),
-            "projTitle": newProj.field("projTitle"),
-            "projAuthor": newProj.field("projAuthor"),
-            "projPath": newProj.field("projPath"),
-            "popSample": newProj.field("popSample"),
-            "popMinimal": newProj.field("popMinimal"),
-            "popCustom": newProj.field("popCustom"),
-            "addRoots": [],
-            "addNotes": False,
-            "numChapters": 0,
-            "numScenes": 0,
-        }
-        if newProj.field("popCustom"):
-            addRoots = []
-            if newProj.field("addPlot"):
-                addRoots.append(nwItemClass.PLOT)
-            if newProj.field("addChar"):
-                addRoots.append(nwItemClass.CHARACTER)
-            if newProj.field("addWorld"):
-                addRoots.append(nwItemClass.WORLD)
-            projData["addRoots"] = addRoots
-            projData["addNotes"] = newProj.field("addNotes")
-            projData["numChapters"] = newProj.field("numChapters")
-            projData["numScenes"] = newProj.field("numScenes")
-
-        try:
-            langIdx = newProj.field("projLang")
-            projData["projLang"] = CONFIG.listLanguages(CONFIG.LANG_PROJ)[langIdx][0]
-        except Exception:
-            projData["projLang"] = "en_GB"
-
-        return projData
-
     def _getTagSource(self, tag: str) -> tuple[str | None, str | None]:
         """Handle the index lookup of a tag and display an alert if the
         tag cannot be found.

novelwriter/shared.py

@@ -31,8 +31,10 @@ 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
@@ -217,6 +219,18 @@ 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():

novelwriter/tools/dictionaries.py

@@ -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/manuscript.py

@@ -375,9 +375,9 @@ class GuiManuscript(QDialog):
     @pyqtSlot()
     def _printDocument(self) -> None:
         """Open the print preview dialog."""
-        thePreview = QPrintPreviewDialog(self)
-        thePreview.paintRequested.connect(self.docPreview.printPreview)
-        thePreview.exec_()
+        preview = QPrintPreviewDialog(self)
+        preview.paintRequested.connect(self.docPreview.printPreview)
+        preview.exec_()
         return
 
     ##
@@ -604,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()
@@ -771,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)