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

novelwriter/dialogs/preferences.py

@@ -3,10 +3,10 @@ novelWriter – GUI Preferences
 =============================
 
 File History:
-Created: 2019-06-10 [0.1.5]
+Created: 2019-06-10 [0.1.5] GuiPreferences
 
 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 QFont
-from PyQt5.QtCore import Qt, pyqtSlot
+from PyQt5.QtGui import QCloseEvent, QFont
+from PyQt5.QtCore import Qt, pyqtSignal, pyqtSlot
 from PyQt5.QtWidgets import (
     QDialog, QWidget, QComboBox, QSpinBox, QPushButton, QDialogButtonBox,
-    QLineEdit, QFileDialog, QFontDialog, QDoubleSpinBox
+    QLineEdit, QFileDialog, QFontDialog, QDoubleSpinBox, qApp
 )
 
 from novelwriter import CONFIG, SHARED
@@ -43,6 +43,8 @@ logger = logging.getLogger(__name__)
 
 class GuiPreferences(NPagedDialog):
 
+    newPreferencesReady = pyqtSignal(bool, bool, bool, bool)
+
     def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
 
@@ -66,9 +68,10 @@ class GuiPreferences(NPagedDialog):
         self.addTab(self.tabAuto,     self.tr("Automation"))
         self.addTab(self.tabQuote,    self.tr("Quotes"))
 
-        self.buttonBox = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel)
+        self.buttonBox = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel, self)
         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)
 
         self.resize(*CONFIG.preferencesWinSize)
@@ -83,29 +86,21 @@ class GuiPreferences(NPagedDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiPreferences")
         return
 
     ##
-    #  Properties
+    #  Events
     ##
 
-    @property
-    def updateTheme(self) -> bool:
-        return self._updateTheme
-
-    @property
-    def updateSyntax(self) -> bool:
-        return self._updateSyntax
-
-    @property
-    def needsRestart(self) -> bool:
-        return self._needsRestart
-
-    @property
-    def refreshTree(self) -> bool:
-        return self._refreshTree
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the close event and perform cleanup."""
+        logger.debug("Close: GuiPreferences")
+        self._saveWindowSize()
+        event.accept()
+        self.deleteLater()
+        return
 
     ##
     #  Private Slots
@@ -113,11 +108,7 @@ class GuiPreferences(NPagedDialog):
 
     @pyqtSlot()
     def _doSave(self) -> None:
-        """Trigger all the save functions in the tabs, and collect the
-        status of the saves.
-        """
-        logger.debug("Saving new preferences")
-
+        """Trigger save functions in the tabs and emit ready signal."""
         self.tabGeneral.saveValues()
         self.tabProjects.saveValues()
         self.tabDocs.saveValues()
@@ -126,17 +117,13 @@ class GuiPreferences(NPagedDialog):
         self.tabAuto.saveValues()
         self.tabQuote.saveValues()
 
-        self._saveWindowSize()
         CONFIG.saveConfig()
-        self.accept()
-
-        return
+        self.newPreferencesReady.emit(
+            self._needsRestart, self._refreshTree, self._updateTheme, self._updateSyntax
+        )
+        qApp.processEvents()
+        self.close()
 
-    @pyqtSlot()
-    def _doClose(self) -> None:
-        """Close the preferences without saving the changes."""
-        self._saveWindowSize()
-        self.reject()
         return
 
     ##
@@ -169,7 +156,7 @@ class GuiPreferencesGeneral(QWidget):
         minWidth = CONFIG.pxInt(200)
 
         # Select Locale
-        self.guiLocale = QComboBox()
+        self.guiLocale = QComboBox(self)
         self.guiLocale.setMinimumWidth(minWidth)
         theLangs = CONFIG.listLanguages(CONFIG.LANG_NW)
         for lang, langName in theLangs:
@@ -187,7 +174,7 @@ class GuiPreferencesGeneral(QWidget):
         )
 
         # Select Theme
-        self.guiTheme = QComboBox()
+        self.guiTheme = QComboBox(self)
         self.guiTheme.setMinimumWidth(minWidth)
         self.theThemes = SHARED.theme.listThemes()
         for themeDir, themeName in self.theThemes:
@@ -203,7 +190,7 @@ class GuiPreferencesGeneral(QWidget):
         )
 
         # Editor Theme
-        self.guiSyntax = QComboBox()
+        self.guiSyntax = QComboBox(self)
         self.guiSyntax.setMinimumWidth(CONFIG.pxInt(200))
         self.theSyntaxes = SHARED.theme.listSyntax()
         for syntaxFile, syntaxName in self.theSyntaxes:
@@ -219,11 +206,11 @@ class GuiPreferencesGeneral(QWidget):
         )
 
         # Font Family
-        self.guiFont = QLineEdit()
+        self.guiFont = QLineEdit(self)
         self.guiFont.setReadOnly(True)
         self.guiFont.setFixedWidth(CONFIG.pxInt(162))
         self.guiFont.setText(CONFIG.guiFont)
-        self.fontButton = QPushButton("...")
+        self.fontButton = QPushButton("...", self)
         self.fontButton.setMaximumWidth(int(2.5*SHARED.theme.getTextWidth("...")))
         self.fontButton.clicked.connect(self._selectFont)
         self.mainForm.addRow(
@@ -378,7 +365,7 @@ class GuiPreferencesProjects(QWidget):
 
         # Backup Path
         self.backupPath = CONFIG.backupPath()
-        self.backupGetPath = QPushButton(self.tr("Browse"))
+        self.backupGetPath = QPushButton(self.tr("Browse"), self)
         self.backupGetPath.clicked.connect(self._backupFolder)
         self.backupPathRow = self.mainForm.addRow(
             self.tr("Backup storage location"),
@@ -421,7 +408,7 @@ class GuiPreferencesProjects(QWidget):
         )
 
         # Inactive time for idle
-        self.userIdleTime = QDoubleSpinBox()
+        self.userIdleTime = QDoubleSpinBox(self)
         self.userIdleTime.setMinimum(0.5)
         self.userIdleTime.setMaximum(600.0)
         self.userIdleTime.setSingleStep(0.5)
@@ -496,11 +483,11 @@ class GuiPreferencesDocuments(QWidget):
         self.mainForm.addGroupLabel(self.tr("Text Style"))
 
         # Font Family
-        self.textFont = QLineEdit()
+        self.textFont = QLineEdit(self)
         self.textFont.setReadOnly(True)
         self.textFont.setFixedWidth(CONFIG.pxInt(162))
         self.textFont.setText(CONFIG.textFont)
-        self.fontButton = QPushButton("...")
+        self.fontButton = QPushButton("...", self)
         self.fontButton.setMaximumWidth(int(2.5*SHARED.theme.getTextWidth("...")))
         self.fontButton.clicked.connect(self._selectFont)
         self.mainForm.addRow(
@@ -960,7 +947,7 @@ class GuiPreferencesAutomation(QWidget):
         self.mainForm.addGroupLabel(self.tr("Automatic Padding"))
 
         # Pad Before
-        self.fmtPadBefore = QLineEdit()
+        self.fmtPadBefore = QLineEdit(self)
         self.fmtPadBefore.setMaxLength(32)
         self.fmtPadBefore.setText(CONFIG.fmtPadBefore)
         self.mainForm.addRow(
@@ -970,7 +957,7 @@ class GuiPreferencesAutomation(QWidget):
         )
 
         # Pad After
-        self.fmtPadAfter = QLineEdit()
+        self.fmtPadAfter = QLineEdit(self)
         self.fmtPadAfter.setMaxLength(32)
         self.fmtPadAfter.setText(CONFIG.fmtPadAfter)
         self.mainForm.addRow(
@@ -1046,13 +1033,13 @@ class GuiPreferencesQuotes(QWidget):
         self.quoteSym = {}
 
         # Single Quote Style
-        self.quoteSym["SO"] = QLineEdit()
+        self.quoteSym["SO"] = QLineEdit(self)
         self.quoteSym["SO"].setMaxLength(1)
         self.quoteSym["SO"].setReadOnly(True)
         self.quoteSym["SO"].setFixedWidth(qWidth)
         self.quoteSym["SO"].setAlignment(Qt.AlignCenter)
         self.quoteSym["SO"].setText(CONFIG.fmtSQuoteOpen)
-        self.btnSingleStyleO = QPushButton("...")
+        self.btnSingleStyleO = QPushButton("...", self)
         self.btnSingleStyleO.setMaximumWidth(bWidth)
         self.btnSingleStyleO.clicked.connect(lambda: self._getQuote("SO"))
         self.mainForm.addRow(
@@ -1062,13 +1049,13 @@ class GuiPreferencesQuotes(QWidget):
             button=self.btnSingleStyleO
         )
 
-        self.quoteSym["SC"] = QLineEdit()
+        self.quoteSym["SC"] = QLineEdit(self)
         self.quoteSym["SC"].setMaxLength(1)
         self.quoteSym["SC"].setReadOnly(True)
         self.quoteSym["SC"].setFixedWidth(qWidth)
         self.quoteSym["SC"].setAlignment(Qt.AlignCenter)
         self.quoteSym["SC"].setText(CONFIG.fmtSQuoteClose)
-        self.btnSingleStyleC = QPushButton("...")
+        self.btnSingleStyleC = QPushButton("...", self)
         self.btnSingleStyleC.setMaximumWidth(bWidth)
         self.btnSingleStyleC.clicked.connect(lambda: self._getQuote("SC"))
         self.mainForm.addRow(
@@ -1079,13 +1066,13 @@ class GuiPreferencesQuotes(QWidget):
         )
 
         # Double Quote Style
-        self.quoteSym["DO"] = QLineEdit()
+        self.quoteSym["DO"] = QLineEdit(self)
         self.quoteSym["DO"].setMaxLength(1)
         self.quoteSym["DO"].setReadOnly(True)
         self.quoteSym["DO"].setFixedWidth(qWidth)
         self.quoteSym["DO"].setAlignment(Qt.AlignCenter)
         self.quoteSym["DO"].setText(CONFIG.fmtDQuoteOpen)
-        self.btnDoubleStyleO = QPushButton("...")
+        self.btnDoubleStyleO = QPushButton("...", self)
         self.btnDoubleStyleO.setMaximumWidth(bWidth)
         self.btnDoubleStyleO.clicked.connect(lambda: self._getQuote("DO"))
         self.mainForm.addRow(
@@ -1095,13 +1082,13 @@ class GuiPreferencesQuotes(QWidget):
             button=self.btnDoubleStyleO
         )
 
-        self.quoteSym["DC"] = QLineEdit()
+        self.quoteSym["DC"] = QLineEdit(self)
         self.quoteSym["DC"].setMaxLength(1)
         self.quoteSym["DC"].setReadOnly(True)
         self.quoteSym["DC"].setFixedWidth(qWidth)
         self.quoteSym["DC"].setAlignment(Qt.AlignCenter)
         self.quoteSym["DC"].setText(CONFIG.fmtDQuoteClose)
-        self.btnDoubleStyleC = QPushButton("...")
+        self.btnDoubleStyleC = QPushButton("...", self)
         self.btnDoubleStyleC.setMaximumWidth(bWidth)
         self.btnDoubleStyleC.clicked.connect(lambda: self._getQuote("DC"))
         self.mainForm.addRow(

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)