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

novelwriter/dialogs/projdetails.py

@@ -3,10 +3,10 @@ novelWriter – GUI Project Details
 =================================
 
 File History:
-Created: 2021-01-03 [1.1rc1]
+Created: 2021-01-03 [1.1rc1] GuiProjectDetails
 
 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,8 +26,8 @@ from __future__ import annotations
 import math
 import logging
 
+from PyQt5.QtGui import QCloseEvent, QFont
 from PyQt5.QtCore import Qt, QSize, pyqtSlot
-from PyQt5.QtGui import QFont
 from PyQt5.QtWidgets import (
     QAbstractItemView, QDialogButtonBox, QGridLayout, QHBoxLayout, QLabel,
     QLineEdit, QSpinBox, QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget
@@ -45,7 +45,7 @@ logger = logging.getLogger(__name__)
 
 class GuiProjectDetails(NPagedDialog):
 
-    def __init__(self, parent):
+    def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
 
         logger.debug("Create: GuiProjectDetails")
@@ -71,43 +71,41 @@ class GuiProjectDetails(NPagedDialog):
         self.addTab(self.tabContents, self.tr("Contents"))
 
         self.buttonBox = QDialogButtonBox(QDialogButtonBox.Close)
-        self.buttonBox.button(QDialogButtonBox.Close)
-        self.buttonBox.rejected.connect(self._doClose)
+        self.buttonBox.rejected.connect(self.close)
+        self.rejected.connect(self.close)
         self.addControls(self.buttonBox)
 
         logger.debug("Ready: GuiProjectDetails")
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiProjectDetails")
         return
 
-    def updateValues(self):
-        """Set all the values of the pages.
-        """
+    def updateValues(self) -> None:
+        """Set all the values of the pages."""
         self.tabMain.updateValues()
         self.tabContents.updateValues()
         return
 
     ##
-    #  Slots
+    #  Events
     ##
 
-    def _doClose(self):
-        """Save settings and close the dialog.
-        """
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the close event and perform cleanup."""
         self._saveGuiSettings()
-        self.close()
+        event.accept()
+        self.deleteLater()
         return
 
     ##
     #  Internal Functions
     ##
 
-    def _saveGuiSettings(self):
-        """Save GUI settings.
-        """
+    def _saveGuiSettings(self) -> None:
+        """Save GUI settings."""
         winWidth  = CONFIG.rpxInt(self.width())
         winHeight = CONFIG.rpxInt(self.height())
 
@@ -122,6 +120,7 @@ class GuiProjectDetails(NPagedDialog):
         countFrom    = self.tabContents.poValue.value()
         clearDouble  = self.tabContents.dblValue.isChecked()
 
+        logger.debug("Saving State: GuiProjectDetails")
         pOptions = SHARED.project.options
         pOptions.setValue("GuiProjectDetails", "winWidth",     winWidth)
         pOptions.setValue("GuiProjectDetails", "winHeight",    winHeight)
@@ -141,7 +140,7 @@ class GuiProjectDetails(NPagedDialog):
 
 class GuiProjectDetailsMain(QWidget):
 
-    def __init__(self, parent):
+    def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
 
         fPx = SHARED.theme.fontPixelSize
@@ -270,7 +269,7 @@ class GuiProjectDetailsContents(QWidget):
     C_PAGE  = 3
     C_PROG  = 4
 
-    def __init__(self, parent):
+    def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
 
         # Internal
@@ -406,9 +405,8 @@ class GuiProjectDetailsContents(QWidget):
 
         return
 
-    def getColumnSizes(self):
-        """Return the column widths for the tree columns.
-        """
+    def getColumnSizes(self) -> list[int]:
+        """Return the column widths for the tree columns."""
         retVals = [
             self.tocTree.columnWidth(0),
             self.tocTree.columnWidth(1),
@@ -418,24 +416,21 @@ class GuiProjectDetailsContents(QWidget):
         ]
         return retVals
 
-    def updateValues(self):
-        """Populate the tree.
-        """
+    def updateValues(self) -> None:
+        """Populate the tree."""
         self._currentRoot = None
         self.novelValue.updateList()
         self.novelValue.setHandle(self.novelValue.firstHandle)
         self._prepareData(self.novelValue.firstHandle)
         self._populateTree()
-
         return
 
     ##
     #  Internal Functions
     ##
 
-    def _prepareData(self, rootHandle):
-        """Extract the information from the project index.
-        """
+    def _prepareData(self, rootHandle: str | None) -> None:
+        """Extract the information from the project index."""
         logger.debug("Populating ToC from handle '%s'", rootHandle)
         self._theToC = SHARED.project.index.getTableOfContents(rootHandle, 2)
         self._theToC.append(("", 0, self.tr("END"), 0))
@@ -446,9 +441,8 @@ class GuiProjectDetailsContents(QWidget):
     ##
 
     @pyqtSlot(str)
-    def _novelValueChanged(self, tHandle):
-        """Refresh the tree with another root item.
-        """
+    def _novelValueChanged(self, tHandle: str) -> None:
+        """Refresh the tree with another root item."""
         if tHandle != self._currentRoot:
             self._prepareData(tHandle)
             self._populateTree()
@@ -456,9 +450,8 @@ class GuiProjectDetailsContents(QWidget):
         return
 
     @pyqtSlot()
-    def _populateTree(self):
-        """Set the content of the chapter/page tree.
-        """
+    def _populateTree(self) -> None:
+        """Set the content of the chapter/page tree."""
         dblPages = self.dblValue.isChecked()
         wpPage = self.wpValue.value()
         fstPage = self.poValue.value() - 1

novelwriter/dialogs/projload.py

@@ -3,10 +3,10 @@ novelWriter – GUI Open Project
 ==============================
 
 File History:
-Created: 2020-02-26 [0.4.5]
+Created: 2020-02-26 [0.4.5] GuiProjectLoad
 
 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,8 +29,8 @@ from typing import TYPE_CHECKING
 from pathlib import Path
 from datetime import datetime
 
-from PyQt5.QtGui import QKeySequence
-from PyQt5.QtCore import Qt, QSize
+from PyQt5.QtGui import QCloseEvent, QKeySequence
+from PyQt5.QtCore import Qt, QSize, pyqtSlot
 from PyQt5.QtWidgets import (
     QDialog, QHBoxLayout, QVBoxLayout, QGridLayout, QPushButton, QTreeWidget,
     QAbstractItemView, QTreeWidgetItem, QDialogButtonBox, QLabel, QShortcut,
@@ -112,8 +112,7 @@ class GuiProjectLoad(QDialog):
         self.selPath = QLineEdit("")
         self.selPath.setReadOnly(True)
 
-        self.browseButton = QPushButton("...")
-        self.browseButton.setMaximumWidth(int(2.5*SHARED.theme.getTextWidth("...")))
+        self.browseButton = QPushButton(SHARED.theme.getIcon("browse"), "", self)
         self.browseButton.clicked.connect(self._doBrowse)
 
         self.projectForm.addWidget(self.lblRecent,    0, 0, 1, 3)
@@ -154,17 +153,17 @@ class GuiProjectLoad(QDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiProjectLoad")
         return
 
     ##
-    #  Buttons
+    #  Private Slots
     ##
 
-    def _doOpenRecent(self):
-        """Close the dialog window with a recent project selected.
-        """
+    @pyqtSlot()
+    def _doOpenRecent(self) -> None:
+        """Close the dialog window with a recent project selected."""
         self._saveSettings()
 
         self.openPath = None
@@ -178,17 +177,17 @@ class GuiProjectLoad(QDialog):
 
         return
 
-    def _doSelectRecent(self):
-        """A recent item has been selected.
-        """
+    @pyqtSlot()
+    def _doSelectRecent(self) -> None:
+        """Update path when a recent item has been selected."""
         selList = self.listBox.selectedItems()
         if selList:
             self.selPath.setText(selList[0].data(self.C_NAME, self.D_PATH))
         return
 
-    def _doBrowse(self):
-        """Browse for a folder path.
-        """
+    @pyqtSlot()
+    def _doBrowse(self) -> None:
+        """Browse for a folder path."""
         extFilter = [
             self.tr("novelWriter Project File ({0})").format(nwFiles.PROJ_FILE),
             self.tr("All files ({0})").format("*"),
@@ -205,26 +204,26 @@ class GuiProjectLoad(QDialog):
 
         return
 
-    def _doCancel(self):
-        """Close the dialog window without doing anything.
-        """
+    @pyqtSlot()
+    def _doCancel(self) -> None:
+        """Close the dialog window without doing anything."""
         self.openPath = None
         self.openState = self.NONE_STATE
         self.close()
         return
 
-    def _doNewProject(self):
-        """Create a new project.
-        """
+    @pyqtSlot()
+    def _doNewProject(self) -> None:
+        """Create a new project."""
         self._saveSettings()
         self.openPath = None
         self.openState = self.NEW_STATE
         self.accept()
         return
 
-    def _doDeleteRecent(self):
-        """Remove an entry from the recent projects list.
-        """
+    @pyqtSlot()
+    def _doDeleteRecent(self) -> None:
+        """Remove an entry from the recent projects list."""
         selList = self.listBox.selectedItems()
         if selList:
             projName = selList[0].text(self.C_NAME)
@@ -244,20 +243,18 @@ class GuiProjectLoad(QDialog):
     #  Events
     ##
 
-    def closeEvent(self, theEvent):
-        """Capture the user closing the dialog so we can save settings.
-        """
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the user closing the dialog and save settings."""
         self._saveSettings()
-        theEvent.accept()
+        event.accept()
         return
 
     ##
     #  Internal Functions
     ##
 
-    def _saveSettings(self):
-        """Save the changes made to the dialog.
-        """
+    def _saveSettings(self) -> None:
+        """Save the changes made to the dialog."""
         colWidths = [0, 0, 0]
         colWidths[self.C_NAME]  = self.listBox.columnWidth(self.C_NAME)
         colWidths[self.C_COUNT] = self.listBox.columnWidth(self.C_COUNT)
@@ -265,9 +262,8 @@ class GuiProjectLoad(QDialog):
         CONFIG.setProjLoadColWidths(colWidths)
         return
 
-    def _populateList(self):
-        """Populate the list box with recent project data.
-        """
+    def _populateList(self) -> None:
+        """Populate the list box with recent project data."""
         self.listBox.clear()
         dataList = CONFIG.recentProjects.listEntries()
         sortList = sorted(dataList, key=lambda x: x[3], reverse=True)

novelwriter/dialogs/projsettings.py

@@ -3,10 +3,10 @@ novelWriter – GUI Project Settings
 ==================================
 
 File History:
-Created: 2018-09-29 [0.0.1]
+Created: 2018-09-29 [0.0.1] GuiProjectSettings
 
 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
@@ -27,11 +27,11 @@ import logging
 
 from typing import TYPE_CHECKING
 
-from PyQt5.QtGui import QIcon, QPixmap, QColor
-from PyQt5.QtCore import Qt, pyqtSlot
+from PyQt5.QtGui import QCloseEvent, QIcon, QPixmap, QColor
+from PyQt5.QtCore import Qt, pyqtSignal, pyqtSlot
 from PyQt5.QtWidgets import (
     QColorDialog, QComboBox, QDialogButtonBox, QHBoxLayout, QLabel, QLineEdit,
-    QPushButton, QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget
+    QPushButton, QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget, qApp
 )
 
 from novelwriter import CONFIG, SHARED
@@ -53,6 +53,8 @@ class GuiProjectSettings(NPagedDialog):
     TAB_IMPORT  = 2
     TAB_REPLACE = 3
 
+    newProjectSettingsReady = pyqtSignal()
+
     def __init__(self, mainGui: GuiMain, focusTab: int = TAB_MAIN) -> None:
         super().__init__(parent=mainGui)
 
@@ -86,7 +88,8 @@ class GuiProjectSettings(NPagedDialog):
 
         self.buttonBox = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel)
         self.buttonBox.accepted.connect(self._doSave)
-        self.buttonBox.rejected.connect(self._doClose)
+        self.buttonBox.rejected.connect(self.close)
+        self.rejected.connect(self.close)
         self.addControls(self.buttonBox)
 
         # Focus Tab
@@ -100,6 +103,13 @@ class GuiProjectSettings(NPagedDialog):
         logger.debug("Delete: GuiProjectSettings")
         return
 
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the close event and perform cleanup."""
+        self._saveGuiSettings()
+        event.accept()
+        self.deleteLater()
+        return
+
     ##
     #  Private Slots
     ##
@@ -137,18 +147,12 @@ class GuiProjectSettings(NPagedDialog):
             newList = self.tabReplace.getNewList()
             project.data.setAutoReplace(newList)
 
-        self._saveGuiSettings()
-        self.accept()
+        self.newProjectSettingsReady.emit()
+        qApp.processEvents()
+        self.close()
 
         return
 
-    @pyqtSlot()
-    def _doClose(self) -> None:
-        """Save settings and close the dialog."""
-        self._saveGuiSettings()
-        self.reject()
-        return
-
     ##
     #  Internal Functions
     ##
@@ -173,6 +177,7 @@ class GuiProjectSettings(NPagedDialog):
         statusColW  = CONFIG.rpxInt(self.tabStatus.listBox.columnWidth(0))
         importColW  = CONFIG.rpxInt(self.tabImport.listBox.columnWidth(0))
 
+        logger.debug("Saving State: GuiProjectSettings")
         pOptions = SHARED.project.options
         pOptions.setValue("GuiProjectSettings", "winWidth",    winWidth)
         pOptions.setValue("GuiProjectSettings", "winHeight",   winHeight)

novelwriter/dialogs/quotes.py

@@ -3,10 +3,10 @@ novelWriter – GUI Quotes Dialog
 ===============================
 
 File History:
-Created: 2020-06-18 [0.9]
+Created: 2020-06-18 [0.9.0] GuiQuoteSelect
 
 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
@@ -25,11 +25,11 @@ from __future__ import annotations
 
 import logging
 
-from PyQt5.QtGui import QFontMetrics
-from PyQt5.QtCore import Qt, QSize
+from PyQt5.QtGui import QCloseEvent, QFontMetrics
+from PyQt5.QtCore import QSize, Qt, pyqtSlot
 from PyQt5.QtWidgets import (
-    QLabel, QVBoxLayout, QHBoxLayout, QDialog, QDialogButtonBox,
-    QListWidget, QListWidgetItem, QFrame
+    QDialog, QDialogButtonBox, QFrame, QHBoxLayout, QLabel, QListWidget,
+    QListWidgetItem, QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG
@@ -44,9 +44,12 @@ class GuiQuoteSelect(QDialog):
 
     D_KEY = Qt.ItemDataRole.UserRole
 
-    def __init__(self, parent=None, currentQuote='"'):
+    def __init__(self, parent: QWidget, currentQuote: str = '"') -> None:
         super().__init__(parent=parent)
 
+        logger.debug("Create: GuiQuoteSelect")
+        self.setObjectName("GuiQuoteSelect")
+
         self.outerBox = QVBoxLayout()
         self.innerBox = QHBoxLayout()
         self.labelBox = QVBoxLayout()
@@ -87,8 +90,8 @@ class GuiQuoteSelect(QDialog):
 
         # Buttons
         self.buttonBox = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel)
-        self.buttonBox.accepted.connect(self._doAccept)
-        self.buttonBox.rejected.connect(self._doReject)
+        self.buttonBox.accepted.connect(self.accept)
+        self.buttonBox.rejected.connect(self.reject)
 
         # Assemble
         self.labelBox.addWidget(self.previewLabel, 0, Qt.AlignTop)
@@ -102,15 +105,31 @@ class GuiQuoteSelect(QDialog):
 
         self.setLayout(self.outerBox)
 
+        logger.debug("Ready: GuiQuoteSelect")
+
+        return
+
+    def __del__(self) -> None:  # pragma: no cover
+        logger.debug("Delete: GuiQuoteSelect")
         return
 
     ##
-    #  Slots
+    #  Events
     ##
 
-    def _selectedSymbol(self):
-        """Update the preview label and the selected quote style.
-        """
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the close event and perform cleanup."""
+        event.accept()
+        self.deleteLater()
+        return
+
+    ##
+    #  Private Slots
+    ##
+
+    @pyqtSlot()
+    def _selectedSymbol(self) -> None:
+        """Update the preview label and the selected quote style."""
         selItems = self.listBox.selectedItems()
         if selItems:
             theSymbol = selItems[0].data(self.D_KEY)
@@ -118,16 +137,4 @@ class GuiQuoteSelect(QDialog):
             self.selectedQuote = theSymbol
         return
 
-    def _doAccept(self):
-        """Ok button clicked.
-        """
-        self.accept()
-        return
-
-    def _doReject(self):
-        """Cancel button clicked.
-        """
-        self.reject()
-        return
-
 # END Class GuiQuoteSelect

novelwriter/dialogs/updates.py

@@ -3,10 +3,10 @@ novelWriter – GUI Updates
 =========================
 
 File History:
-Created: 2021-08-21 [1.5b1]
+Created: 2021-08-21 [1.5b1] GuiUpdates
 
 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,10 +29,10 @@ import logging
 from datetime import datetime
 from urllib.request import Request, urlopen
 
-from PyQt5.QtGui import QCursor
+from PyQt5.QtGui import QCloseEvent, QCursor
 from PyQt5.QtCore import Qt
 from PyQt5.QtWidgets import (
-    qApp, QDialog, QHBoxLayout, QVBoxLayout, QDialogButtonBox, QLabel
+    QWidget, qApp, QDialog, QHBoxLayout, QVBoxLayout, QDialogButtonBox, QLabel
 )
 
 from novelwriter import CONFIG, SHARED, __version__, __date__
@@ -44,8 +44,8 @@ logger = logging.getLogger(__name__)
 
 class GuiUpdates(QDialog):
 
-    def __init__(self, mainGui):
-        super().__init__(parent=mainGui)
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
 
         logger.debug("Create: GuiUpdates")
         self.setObjectName("GuiUpdates")
@@ -94,8 +94,8 @@ class GuiUpdates(QDialog):
         self.latestLabel.setFont(hFont)
 
         # Buttons
-        self.buttonBox = QDialogButtonBox(QDialogButtonBox.Ok)
-        self.buttonBox.accepted.connect(self._doClose)
+        self.buttonBox = QDialogButtonBox(QDialogButtonBox.Close)
+        self.buttonBox.rejected.connect(self.close)
 
         # Assemble
         self.innerBox = QHBoxLayout()
@@ -114,17 +114,16 @@ class GuiUpdates(QDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiUpdates")
         return
 
-    def checkLatest(self):
-        """Check for latest release.
-        """
+    def checkLatest(self) -> None:
+        """Check for latest release."""
         qApp.setOverrideCursor(QCursor(Qt.WaitCursor))
 
         urlReq = Request("https://api.github.com/repos/vkbo/novelwriter/releases/latest")
-        urlReq.add_header("User-Agent", "Mozilla/5.0 (compatible; novelWriter (Python))")
+        urlReq.add_header("User-Agent", nwConst.USER_AGENT)
         urlReq.add_header("Accept", "application/vnd.github.v3+json")
 
         rawData = {}
@@ -161,11 +160,13 @@ class GuiUpdates(QDialog):
         return
 
     ##
-    #  Internal Functions
+    #  Events
     ##
 
-    def _doClose(self):
-        self.close()
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the user closing the window."""
+        event.accept()
+        self.deleteLater()
         return
 
 # END Class GuiUpdates