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

novelwriter/core/status.py

@@ -3,11 +3,11 @@ novelWriter – Project Item Status Class
 =======================================
 
 File History:
-Created:   2019-05-19 [0.1.3]
-Rewritten: 2022-04-05 [2.0b1]
+Created:   2019-05-19 [0.1.3] NWStatus
+Rewritten: 2022-04-05 [2.0b1] NWStatus
 
 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

novelwriter/core/storage.py

@@ -6,7 +6,7 @@ File History:
 Created: 2022-11-01 [2.0rc2] NWStorage
 
 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

novelwriter/core/tohtml.py

@@ -3,10 +3,10 @@ novelWriter – HTML Text Converter
 =================================
 
 File History:
-Created: 2019-05-07 [0.0.1]
+Created: 2019-05-07 [0.0.1] ToHtml
 
 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

novelwriter/core/tokenizer.py

@@ -7,7 +7,7 @@ Created: 2019-05-05 [0.0.1] Tokenizer
 Created: 2023-05-23 [2.1b1] HeadingFormatter
 
 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

novelwriter/core/tomd.py

@@ -3,10 +3,10 @@ novelWriter – Markdown Text Converter
 =====================================
 
 File History:
-Created: 2021-02-06 [1.2b1]
+Created: 2021-02-06 [1.2b1] ToMarkdown
 
 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

novelwriter/core/toodt.py

@@ -9,7 +9,7 @@ Created: 2021-01-27 [1.2b1] ODTTextStyle
 Created: 2021-08-14 [1.5b1] XMLParagraph
 
 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

novelwriter/core/tree.py

@@ -3,10 +3,10 @@ novelWriter – Project Tree Class
 ================================
 
 File History:
-Created: 2020-05-07 [0.4.5]
+Created: 2020-05-07 [0.4.5] NWTree
 
 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

novelwriter/dialogs/about.py

@@ -3,10 +3,10 @@ novelWriter – GUI About Box
 ===========================
 
 File History:
-Created: 2020-05-21 [0.5.2]
+Created: 2020-05-21 [0.5.2] GuiAbout
 
 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
@@ -28,7 +28,7 @@ import novelwriter
 
 from datetime import datetime
 
-from PyQt5.QtGui import QCursor
+from PyQt5.QtGui import QCloseEvent, QCursor
 from PyQt5.QtCore import Qt
 from PyQt5.QtWidgets import (
     qApp, QDialog, QDialogButtonBox, QHBoxLayout, QLabel, QTabWidget,
@@ -44,7 +44,7 @@ logger = logging.getLogger(__name__)
 
 class GuiAbout(QDialog):
 
-    def __init__(self, parent: QWidget):
+    def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
 
         logger.debug("Create: GuiAbout")
@@ -101,7 +101,7 @@ class GuiAbout(QDialog):
 
         # OK Button
         self.buttonBox = QDialogButtonBox(QDialogButtonBox.Ok)
-        self.buttonBox.accepted.connect(self._doClose)
+        self.buttonBox.accepted.connect(self.close)
 
         self.outerBox.addLayout(self.innerBox)
         self.outerBox.addWidget(self.buttonBox)
@@ -111,13 +111,12 @@ class GuiAbout(QDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiAbout")
         return
 
-    def populateGUI(self):
-        """Populate tabs with text.
-        """
+    def populateGUI(self) -> None:
+        """Populate tabs with text."""
         qApp.setOverrideCursor(QCursor(Qt.WaitCursor))
         self._setStyleSheet()
         self._fillAboutPage()
@@ -127,19 +126,27 @@ class GuiAbout(QDialog):
         qApp.restoreOverrideCursor()
         return
 
-    def showReleaseNotes(self):
-        """Show the release notes.
-        """
+    def showReleaseNotes(self) -> None:
+        """Show the release notes."""
         self.tabBox.setCurrentWidget(self.pageNotes)
         return
 
+    ##
+    #  Events
+    ##
+
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the close event and perform cleanup."""
+        event.accept()
+        self.deleteLater()
+        return
+
     ##
     #  Internal Functions
     ##
 
-    def _fillAboutPage(self):
-        """Generate the content for the About page.
-        """
+    def _fillAboutPage(self) -> None:
+        """Generate the content for the About page."""
         aboutMsg = (
             "<h2>{title1}</h2>"
             "<p>{copy}</p>"
@@ -181,9 +188,8 @@ class GuiAbout(QDialog):
 
         return
 
-    def _fillNotesPage(self):
-        """Load the content for the Release Notes page.
-        """
+    def _fillNotesPage(self) -> None:
+        """Load the content for the Release Notes page."""
         docPath = CONFIG.assetPath("text") / "release_notes.htm"
         docText = readTextFile(docPath)
         if docText:
@@ -192,9 +198,8 @@ class GuiAbout(QDialog):
             self.pageNotes.setHtml("Error loading release notes text ...")
         return
 
-    def _fillCreditsPage(self):
-        """Load the content for the Credits page.
-        """
+    def _fillCreditsPage(self) -> None:
+        """Load the content for the Credits page."""
         docPath = CONFIG.assetPath("text") / "credits_en.htm"
         docText = readTextFile(docPath)
         if docText:
@@ -203,9 +208,8 @@ class GuiAbout(QDialog):
             self.pageCredits.setHtml("Error loading credits text ...")
         return
 
-    def _fillLicensePage(self):
-        """Load the content for the Licence page.
-        """
+    def _fillLicensePage(self) -> None:
+        """Load the content for the Licence page."""
         docPath = CONFIG.assetPath("text") / "gplv3_en.htm"
         docText = readTextFile(docPath)
         if docText:
@@ -214,9 +218,8 @@ class GuiAbout(QDialog):
             self.pageLicense.setHtml("Error loading licence text ...")
         return
 
-    def _setStyleSheet(self):
-        """Set stylesheet for all browser tabs
-        """
+    def _setStyleSheet(self) -> None:
+        """Set stylesheet for all browser tabs."""
         styleSheet = (
             "h1, h2, h3, h4 {{"
             "  color: rgb({hColR},{hColG},{hColB});"
@@ -242,8 +245,4 @@ class GuiAbout(QDialog):
 
         return
 
-    def _doClose(self):
-        self.close()
-        return
-
 # END Class GuiAbout

novelwriter/dialogs/docmerge.py

@@ -3,11 +3,11 @@ novelWriter – GUI Doc Merge Dialog
 ==================================
 
 File History:
-Created:   2020-01-23 [0.4.3]
-Rewritten: 2022-10-06 [2.0rc1]
+Created:   2020-01-23 [0.4.3]  GuiDocMerge
+Rewritten: 2022-10-06 [2.0rc1] GuiDocMerge
 
 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,7 +26,8 @@ from __future__ import annotations
 
 import logging
 
-from PyQt5.QtCore import Qt, QSize
+from PyQt5.QtGui import QCloseEvent
+from PyQt5.QtCore import Qt, QSize, pyqtSlot
 from PyQt5.QtWidgets import (
     QAbstractItemView, QDialog, QDialogButtonBox, QGridLayout, QLabel,
     QListWidget, QListWidgetItem, QVBoxLayout, QWidget
@@ -108,13 +109,12 @@ class GuiDocMerge(QDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiDocMerge")
         return
 
-    def getData(self):
-        """Return the user's choices.
-        """
+    def getData(self) -> dict:
+        """Return the user's choices."""
         finalItems = []
         for i in range(self.listBox.count()):
             item = self.listBox.item(i)
@@ -127,12 +127,22 @@ class GuiDocMerge(QDialog):
         return self._data
 
     ##
-    #  Slots
+    #  Events
     ##
 
-    def _resetList(self):
-        """Reset the content of the list box to its original state.
-        """
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the close event and perform cleanup."""
+        event.accept()
+        self.deleteLater()
+        return
+
+    ##
+    #  Private Slots
+    ##
+
+    @pyqtSlot()
+    def _resetList(self) -> None:
+        """Reset the content of the list box to its original state."""
         logger.debug("Resetting list box content")
         sHandle = self._data.get("sHandle", None)
         itemList = self._data.get("origItems", [])
@@ -143,9 +153,8 @@ class GuiDocMerge(QDialog):
     #  Internal Functions
     ##
 
-    def _loadContent(self, sHandle, itemList):
-        """Load content from a given list of items.
-        """
+    def _loadContent(self, sHandle: str, itemList: list[str]) -> None:
+        """Load content from a given list of items."""
         self._data = {}
         self._data["sHandle"] = sHandle
         self._data["origItems"] = itemList

novelwriter/dialogs/docsplit.py

@@ -3,11 +3,11 @@ novelWriter – GUI Doc Split Dialog
 ==================================
 
 File History:
-Created:   2020-02-01 [0.4.3]
-Rewritten: 2022-10-12 [2.0rc1]
+Created:   2020-02-01 [0.4.3]  GuiDocSplit
+Rewritten: 2022-10-12 [2.0rc1] GuiDocSplit
 
 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,11 @@ from __future__ import annotations
 
 import logging
 
-from PyQt5.QtCore import Qt
+from PyQt5.QtGui import QCloseEvent
+from PyQt5.QtCore import Qt, pyqtSlot
 from PyQt5.QtWidgets import (
-    QDialog, QVBoxLayout, QComboBox, QListWidget, QAbstractItemView,
-    QListWidgetItem, QDialogButtonBox, QLabel, QGridLayout
+    QAbstractItemView, QComboBox, QDialog, QDialogButtonBox, QGridLayout,
+    QLabel, QListWidget, QListWidgetItem, QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG, SHARED
@@ -45,7 +46,7 @@ class GuiDocSplit(QDialog):
     LEVEL_ROLE = Qt.ItemDataRole.UserRole + 1
     LABEL_ROLE = Qt.ItemDataRole.UserRole + 2
 
-    def __init__(self, parent, sHandle):
+    def __init__(self, parent: QWidget, sHandle: str) -> None:
         super().__init__(parent=parent)
 
         logger.debug("Create: GuiDocSplit")
@@ -138,11 +139,11 @@ class GuiDocSplit(QDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiDocSplit")
         return
 
-    def getData(self):
+    def getData(self) -> tuple[dict, list]:
         """Return the user's choices. Also save the users options for
         the next time the dialog is used.
         """
@@ -167,6 +168,7 @@ class GuiDocSplit(QDialog):
         self._data["docHierarchy"] = docHierarchy
         self._data["moveToTrash"] = moveToTrash
 
+        logger.debug("Saving State: GuiDocSplit")
         pOptions = SHARED.project.options
         pOptions.setValue("GuiDocSplit", "spLevel", spLevel)
         pOptions.setValue("GuiDocSplit", "intoFolder", intoFolder)
@@ -175,12 +177,22 @@ class GuiDocSplit(QDialog):
         return self._data, self._text
 
     ##
-    #  Slots
+    #  Events
     ##
 
-    def _reloadList(self):
-        """Reload the content of the list box.
-        """
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the close event and perform cleanup."""
+        event.accept()
+        self.deleteLater()
+        return
+
+    ##
+    #  Private Slots
+    ##
+
+    @pyqtSlot()
+    def _reloadList(self) -> None:
+        """Reload the content of the list box."""
         sHandle = self._data.get("sHandle", None)
         self._loadContent(sHandle)
         return
@@ -189,9 +201,8 @@ class GuiDocSplit(QDialog):
     #  Internal Functions
     ##
 
-    def _loadContent(self, sHandle):
-        """Load content from a given source item.
-        """
+    def _loadContent(self, sHandle: str) -> None:
+        """Load content from a given source item."""
         self._data = {}
         self._data["sHandle"] = sHandle
 

novelwriter/dialogs/editlabel.py

@@ -3,10 +3,10 @@ novelWriter – Edit Label Dialog
 ===============================
 
 File History:
-Created: 2022-06-11 [2.0rc1]
+Created: 2022-06-11 [2.0rc1] GuiEditLabel
 
 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,7 +26,8 @@ from __future__ import annotations
 import logging
 
 from PyQt5.QtWidgets import (
-    QDialog, QVBoxLayout, QLineEdit, QLabel, QDialogButtonBox, QHBoxLayout
+    QDialog, QDialogButtonBox, QHBoxLayout, QLabel, QLineEdit, QVBoxLayout,
+    QWidget
 )
 
 from novelwriter import CONFIG
@@ -36,9 +37,10 @@ logger = logging.getLogger(__name__)
 
 class GuiEditLabel(QDialog):
 
-    def __init__(self, parent, text=""):
+    def __init__(self, parent: QWidget, text: str = "") -> None:
         super().__init__(parent=parent)
 
+        logger.debug("Create: GuiEditLabel")
         self.setObjectName("GuiEditLabel")
         self.setWindowTitle(self.tr("Item Label"))
 
@@ -70,16 +72,26 @@ class GuiEditLabel(QDialog):
 
         self.setLayout(self.outerBox)
 
+        logger.debug("Ready: GuiEditLabel")
+
+        return
+
+    def __del__(self) -> None:  # pragma: no cover
+        logger.debug("Delete: GuiEditLabel")
         return
 
     @property
-    def itemLabel(self):
+    def itemLabel(self) -> str:
         return self.labelValue.text()
 
     @classmethod
-    def getLabel(cls, parent, text):
+    def getLabel(cls, parent: QWidget, text: str) -> tuple[str, bool]:
+        """Pop the dialog and return the result."""
         cls = GuiEditLabel(parent, text=text)
         cls.exec_()
-        return cls.itemLabel, cls.result() == QDialog.Accepted
+        label = cls.itemLabel
+        accepted = cls.result() == QDialog.Accepted
+        cls.deleteLater()
+        return label, accepted
 
 # END Class GuiEditLabel