novelWriter 2.2rc1__py3-none-any.whl → 2.2.1__py3-none-any.whl

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()
-        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):

novelwriter/tools/manussettings.py

@@ -6,7 +6,7 @@ File History:
 Created: 2023-02-13 [2.1b1] GuiBuildSettings
 
 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
@@ -253,13 +253,11 @@ class GuiBuildSettings(QDialog):
 
     def _saveSettings(self) -> None:
         """Save the various user settings."""
-        logger.debug("Saving GuiBuildSettings settings")
-
         winWidth  = CONFIG.rpxInt(self.width())
         winHeight = CONFIG.rpxInt(self.height())
-
         treeWidth, filterWidth = self.optTabSelect.mainSplitSizes()
 
+        logger.debug("Saving State: GuiBuildSettings")
         pOptions = SHARED.project.options
         pOptions.setValue("GuiBuildSettings", "winWidth", winWidth)
         pOptions.setValue("GuiBuildSettings", "winHeight", winHeight)

novelwriter/tools/projwizard.py

@@ -3,10 +3,10 @@ novelWriter – GUI New Project Wizard
 ====================================
 
 File History:
-Created: 2020-07-11 [0.10.1]
+Created: 2020-07-11 [0.10.1] GuiProjectWizard
 
 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
@@ -80,7 +80,7 @@ class GuiProjectWizard(QWizard):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiProjectWizard")
         return
 

novelwriter/tools/writingstats.py

@@ -3,10 +3,10 @@ novelWriter – GUI Writing Statistics
 ====================================
 
 File History:
-Created: 2019-10-20 [0.3]
+Created: 2019-10-20 [0.3.0] GuiWritingStats
 
 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
@@ -29,7 +29,7 @@ import logging
 from datetime import datetime
 from typing import TYPE_CHECKING
 
-from PyQt5.QtGui import QPixmap, QCursor
+from PyQt5.QtGui import QCloseEvent, QPixmap, QCursor
 from PyQt5.QtCore import Qt, pyqtSlot
 from PyQt5.QtWidgets import (
     qApp, QDialog, QTreeWidget, QTreeWidgetItem, QDialogButtonBox, QGridLayout,
@@ -307,9 +307,20 @@ class GuiWritingStats(QDialog):
         return
 
     ##
-    #  Slots
+    #  Events
     ##
 
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the user closing the window."""
+        event.accept()
+        self.deleteLater()
+        return
+
+    ##
+    #  Private Slots
+    ##
+
+    @pyqtSlot()
     def _doClose(self) -> None:
         """Save the state of the window, clear cache, end close."""
         self.logData = []
@@ -330,6 +341,7 @@ class GuiWritingStats(QDialog):
         showIdleTime = self.showIdleTime.isChecked()
         histMax      = self.histMax.value()
 
+        logger.debug("Saving State: GuiWritingStats")
         pOptions = SHARED.project.options
         pOptions.setValue("GuiWritingStats", "winWidth",     winWidth)
         pOptions.setValue("GuiWritingStats", "winHeight",    winHeight)
@@ -347,6 +359,7 @@ class GuiWritingStats(QDialog):
         pOptions.setValue("GuiWritingStats", "showIdleTime", showIdleTime)
         pOptions.setValue("GuiWritingStats", "histMax",      histMax)
         pOptions.saveSettings()
+
         self.close()
 
         return

novelwriter/assets/icons/typicons_dark/nw_tb-markdown.svg

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg width="24" height="24" version="1.1" viewBox="0 0 6.35 6.35" xmlns="http://www.w3.org/2000/svg">
- <g fill="#aeaeae" stroke-width="1.1">
-  <path d="m0.79397 2.8846-0.29357-0.21175 0.28393-0.5005-0.51975-0.23582 0.11068-0.3465 0.55825 0.1155 0.062562-0.56787h0.37057l0.062562 0.57268 0.55343-0.12032 0.1155 0.3465-0.51975 0.23582 0.28393 0.5005-0.29356 0.21175-0.385-0.42832z"/>
-  <path d="m2.8219 3.15-0.09999 0.37496h0.86866l-0.09374-0.37496q-0.08749-0.30622-0.16873-0.64993-0.081241-0.34372-0.16248-0.66243h-0.024997q-0.074992 0.32496-0.15623 0.66868-0.074992 0.33747-0.16248 0.64369zm-1.4749 2.0623 1.2749-4.0746h1.1062l1.2749 4.0746h-0.97489l-0.24997-0.96865h-1.2437l-0.24997 0.96865z"/>
-  <path d="m4.7812 2.8846-0.29357-0.21175 0.28394-0.5005-0.51975-0.23582 0.11069-0.3465 0.55825 0.1155 0.062562-0.56787h0.37056l0.062562 0.57268 0.55343-0.12032 0.1155 0.3465-0.51975 0.23582 0.28393 0.5005-0.29356 0.21175-0.385-0.42832z"/>
- </g>
-</svg>

novelwriter/assets/icons/typicons_dark/nw_tb-shortcode.svg

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg width="24" height="24" version="1.1" viewBox="0 0 6.35 6.35" xmlns="http://www.w3.org/2000/svg">
- <g fill="#aeaeae" stroke-width="1.3799">
-  <path d="m0.52917 5.2683v-4.1866h1.0272v0.37972h-0.49167v3.4272h0.49167v0.37972z"/>
-  <path d="m2.9 2.9219-0.077889 0.29209h0.67667l-0.073022-0.29209q-0.068154-0.23854-0.13144-0.50628-0.063285-0.26775-0.12657-0.51601h-0.019472q-0.058417 0.25314-0.1217 0.52088-0.058417 0.26288-0.12657 0.50141zm-1.1489 1.6065 0.9931-3.174h0.86166l0.9931 3.174h-0.75942l-0.19472-0.75455h-0.96876l-0.19472 0.75455z"/>
-  <path d="m4.7937 5.2683v-0.37972h0.49654v-3.4272h-0.49654v-0.37972h1.0272v4.1866z"/>
- </g>
-</svg>

novelwriter/assets/icons/typicons_light/nw_tb-markdown.svg

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg width="24" height="24" version="1.1" viewBox="0 0 6.35 6.35" xmlns="http://www.w3.org/2000/svg">
- <g fill-opacity=".78039" stroke-width="1.1">
-  <path d="m0.79397 2.8846-0.29357-0.21175 0.28393-0.5005-0.51975-0.23582 0.11068-0.3465 0.55825 0.1155 0.062562-0.56787h0.37057l0.062562 0.57268 0.55343-0.12032 0.1155 0.3465-0.51975 0.23582 0.28393 0.5005-0.29356 0.21175-0.385-0.42832z"/>
-  <path d="m2.8219 3.15-0.09999 0.37496h0.86866l-0.09374-0.37496q-0.08749-0.30622-0.16873-0.64993-0.081241-0.34372-0.16248-0.66243h-0.024997q-0.074992 0.32496-0.15623 0.66868-0.074992 0.33747-0.16248 0.64369zm-1.4749 2.0623 1.2749-4.0746h1.1062l1.2749 4.0746h-0.97489l-0.24997-0.96865h-1.2437l-0.24997 0.96865z"/>
-  <path d="m4.7812 2.8846-0.29357-0.21175 0.28394-0.5005-0.51975-0.23582 0.11069-0.3465 0.55825 0.1155 0.062562-0.56787h0.37056l0.062562 0.57268 0.55343-0.12032 0.1155 0.3465-0.51975 0.23582 0.28393 0.5005-0.29356 0.21175-0.385-0.42832z"/>
- </g>
-</svg>

novelwriter/assets/icons/typicons_light/nw_tb-shortcode.svg

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg width="24" height="24" version="1.1" viewBox="0 0 6.35 6.35" xmlns="http://www.w3.org/2000/svg">
- <g fill-opacity=".78039" stroke-width="1.3799">
-  <path d="m0.52917 5.2683v-4.1866h1.0272v0.37972h-0.49167v3.4272h0.49167v0.37972z"/>
-  <path d="m2.9 2.9219-0.077889 0.29209h0.67667l-0.073022-0.29209q-0.068154-0.23854-0.13144-0.50628-0.063285-0.26775-0.12657-0.51601h-0.019472q-0.058417 0.25314-0.1217 0.52088-0.058417 0.26288-0.12657 0.50141zm-1.1489 1.6065 0.9931-3.174h0.86166l0.9931 3.174h-0.75942l-0.19472-0.75455h-0.96876l-0.19472 0.75455z"/>
-  <path d="m4.7937 5.2683v-0.37972h0.49654v-3.4272h-0.49654v-0.37972h1.0272v4.1866z"/>
- </g>
-</svg>