novelWriter 2.2b1__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
+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,12 +43,13 @@ logger = logging.getLogger(__name__)
 
 class GuiPreferences(NPagedDialog):
 
-    def __init__(self, mainGui):
-        super().__init__(parent=mainGui)
+    newPreferencesReady = pyqtSignal(bool, bool, bool, bool)
+
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
 
         logger.debug("Create: GuiPreferences")
         self.setObjectName("GuiPreferences")
-
         self.setWindowTitle(self.tr("Preferences"))
 
         self.tabGeneral  = GuiPreferencesGeneral(self)
@@ -67,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)
@@ -84,40 +86,29 @@ 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):
-        return self._updateTheme
-
-    @property
-    def updateSyntax(self):
-        return self._updateSyntax
-
-    @property
-    def needsRestart(self):
-        return self._needsRestart
-
-    @property
-    def refreshTree(self):
-        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
 
     ##
-    #  Slots
+    #  Private Slots
     ##
 
-    def _doSave(self):
-        """Trigger all the save functions in the tabs, and collect the
-        status of the saves.
-        """
-        logger.debug("Saving new preferences")
-
+    @pyqtSlot()
+    def _doSave(self) -> None:
+        """Trigger save functions in the tabs and emit ready signal."""
         self.tabGeneral.saveValues()
         self.tabProjects.saveValues()
         self.tabDocs.saveValues()
@@ -126,26 +117,21 @@ 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()
 
-    def _doClose(self):
-        """Close the preferences without saving the changes.
-        """
-        self._saveWindowSize()
-        self.reject()
         return
 
     ##
     #  Internal Functions
     ##
 
-    def _saveWindowSize(self):
-        """Save the dialog window size.
-        """
+    def _saveWindowSize(self) -> None:
+        """Save the dialog window size."""
         CONFIG.setPreferencesWinSize(self.width(), self.height())
         return
 
@@ -154,7 +140,7 @@ class GuiPreferences(NPagedDialog):
 
 class GuiPreferencesGeneral(QWidget):
 
-    def __init__(self, prefsGui):
+    def __init__(self, prefsGui: GuiPreferences) -> None:
         super().__init__(parent=prefsGui)
 
         self.prefsGui = prefsGui
@@ -170,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:
@@ -188,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:
@@ -204,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:
@@ -220,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(
@@ -285,9 +271,8 @@ class GuiPreferencesGeneral(QWidget):
 
         return
 
-    def saveValues(self):
-        """Save the values set for this tab.
-        """
+    def saveValues(self) -> None:
+        """Save the values set for this tab."""
         guiLocale   = self.guiLocale.currentData()
         guiTheme    = self.guiTheme.currentData()
         guiSyntax   = self.guiSyntax.currentData()
@@ -316,12 +301,12 @@ class GuiPreferencesGeneral(QWidget):
         return
 
     ##
-    #  Slots
+    #  Private Slots
     ##
 
-    def _selectFont(self):
-        """Open the QFontDialog and set a font for the font style.
-        """
+    @pyqtSlot()
+    def _selectFont(self) -> None:
+        """Open the QFontDialog and set a font for the font style."""
         currFont = QFont()
         currFont.setFamily(CONFIG.guiFont)
         currFont.setPointSize(CONFIG.guiFontSize)
@@ -336,7 +321,7 @@ class GuiPreferencesGeneral(QWidget):
 
 class GuiPreferencesProjects(QWidget):
 
-    def __init__(self, prefsGui):
+    def __init__(self, prefsGui: GuiPreferences) -> None:
         super().__init__(parent=prefsGui)
 
         # The Form
@@ -380,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"),
@@ -423,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)
@@ -438,9 +423,8 @@ class GuiPreferencesProjects(QWidget):
 
         return
 
-    def saveValues(self):
-        """Save the values set for this tab.
-        """
+    def saveValues(self) -> None:
+        """Save the values set for this tab."""
         # Automatic Save
         CONFIG.autoSaveDoc  = self.autoSaveDoc.value()
         CONFIG.autoSaveProj = self.autoSaveProj.value()
@@ -457,12 +441,12 @@ class GuiPreferencesProjects(QWidget):
         return
 
     ##
-    #  Slots
+    #  Private Slots
     ##
 
-    def _backupFolder(self):
-        """Open a dialog to select the backup folder.
-        """
+    @pyqtSlot()
+    def _backupFolder(self) -> None:
+        """Open a dialog to select the backup folder."""
         currDir = self.backupPath or ""
         newDir = QFileDialog.getExistingDirectory(
             self, self.tr("Backup Directory"), str(currDir), options=QFileDialog.ShowDirsOnly
@@ -472,15 +456,13 @@ class GuiPreferencesProjects(QWidget):
             self.mainForm.setHelpText(
                 self.backupPathRow, self.tr("Path: {0}").format(self.backupPath)
             )
-            return True
-
-        return False
+            return
+        return
 
-    def _toggledBackupOnClose(self, theState):
-        """Enable or disable switch that depends on the backup on close
-        switch.
-        """
-        self.askBeforeBackup.setEnabled(theState)
+    @pyqtSlot(bool)
+    def _toggledBackupOnClose(self, state: bool) -> None:
+        """Toggle switch that depends on the backup on close switch."""
+        self.askBeforeBackup.setEnabled(state)
         return
 
 # END Class GuiPreferencesProjects
@@ -488,7 +470,7 @@ class GuiPreferencesProjects(QWidget):
 
 class GuiPreferencesDocuments(QWidget):
 
-    def __init__(self, prefsGui):
+    def __init__(self, prefsGui: GuiPreferences)  -> None:
         super().__init__(parent=prefsGui)
 
         # The Form
@@ -501,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(
@@ -604,9 +586,8 @@ class GuiPreferencesDocuments(QWidget):
 
         return
 
-    def saveValues(self):
-        """Save the values set for this tab.
-        """
+    def saveValues(self) -> None:
+        """Save the values set for this tab."""
         # Text Style
         CONFIG.setTextFont(self.textFont.text(), self.textSize.value())
 
@@ -621,12 +602,12 @@ class GuiPreferencesDocuments(QWidget):
         return
 
     ##
-    #  Slots
+    #  Private Slots
     ##
 
+    @pyqtSlot()
     def _selectFont(self):
-        """Open the QFontDialog and set a font for the font style.
-        """
+        """Open the QFontDialog and set a font for the font style."""
         currFont = QFont()
         currFont.setFamily(CONFIG.textFont)
         currFont.setPointSize(CONFIG.textSize)
@@ -642,7 +623,7 @@ class GuiPreferencesDocuments(QWidget):
 
 class GuiPreferencesEditor(QWidget):
 
-    def __init__(self, prefsGui):
+    def __init__(self, prefsGui: GuiPreferences) -> None:
         super().__init__(parent=prefsGui)
 
         # The Form
@@ -726,6 +707,15 @@ class GuiPreferencesEditor(QWidget):
         # ================
         self.mainForm.addGroupLabel(self.tr("Scroll Behaviour"))
 
+        # Scroll Past End
+        self.scrollPastEnd = NSwitch()
+        self.scrollPastEnd.setChecked(CONFIG.scrollPastEnd)
+        self.mainForm.addRow(
+            self.tr("Scroll past end of the document"),
+            self.scrollPastEnd,
+            self.tr("Also centres the cursor when scrolling.")
+        )
+
         # Typewriter Scrolling
         self.autoScroll = NSwitch()
         self.autoScroll.setChecked(CONFIG.autoScroll)
@@ -750,7 +740,7 @@ class GuiPreferencesEditor(QWidget):
 
         return
 
-    def saveValues(self):
+    def saveValues(self) -> None:
         """Save the values set for this tab."""
         # Spell Checking
         CONFIG.spellLanguage = self.spellLanguage.currentData()
@@ -766,6 +756,7 @@ class GuiPreferencesEditor(QWidget):
         # Scroll Behaviour
         CONFIG.autoScroll    = self.autoScroll.isChecked()
         CONFIG.autoScrollPos = self.autoScrollPos.value()
+        CONFIG.scrollPastEnd = self.scrollPastEnd.isChecked()
 
         return
 
@@ -774,7 +765,7 @@ class GuiPreferencesEditor(QWidget):
 
 class GuiPreferencesSyntax(QWidget):
 
-    def __init__(self, prefsGui):
+    def __init__(self, prefsGui: GuiPreferences) -> None:
         super().__init__(parent=prefsGui)
 
         self.prefsGui = prefsGui
@@ -840,9 +831,8 @@ class GuiPreferencesSyntax(QWidget):
 
         return
 
-    def saveValues(self):
-        """Save the values set for this tab.
-        """
+    def saveValues(self) -> None:
+        """Save the values set for this tab."""
         highlightQuotes = self.highlightQuotes.isChecked()
         allowOpenSQuote = self.allowOpenSQuote.isChecked()
         allowOpenDQuote = self.allowOpenDQuote.isChecked()
@@ -862,15 +852,14 @@ class GuiPreferencesSyntax(QWidget):
         return
 
     ##
-    #  Slots
+    #  Private Slots
     ##
 
-    def _toggleHighlightQuotes(self, theState):
-        """Enables or disables switches controlled by the highlight
-        quotes switch.
-        """
-        self.allowOpenSQuote.setEnabled(theState)
-        self.allowOpenDQuote.setEnabled(theState)
+    @pyqtSlot(bool)
+    def _toggleHighlightQuotes(self, state: bool) -> None:
+        """Toggle switches controlled by the highlight quotes switch."""
+        self.allowOpenSQuote.setEnabled(state)
+        self.allowOpenDQuote.setEnabled(state)
         return
 
 # END Class GuiPreferencesSyntax
@@ -878,7 +867,7 @@ class GuiPreferencesSyntax(QWidget):
 
 class GuiPreferencesAutomation(QWidget):
 
-    def __init__(self, prefsGui):
+    def __init__(self, prefsGui: GuiPreferences) -> None:
         super().__init__(parent=prefsGui)
 
         # The Form
@@ -958,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(
@@ -968,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(
@@ -989,9 +978,8 @@ class GuiPreferencesAutomation(QWidget):
 
         return
 
-    def saveValues(self):
-        """Save the values set for this tab.
-        """
+    def saveValues(self) -> None:
+        """Save the values set for this tab."""
         # Automatic Features
         CONFIG.autoSelect = self.autoSelect.isChecked()
         CONFIG.doReplace  = self.doReplace.isChecked()
@@ -1010,18 +998,17 @@ class GuiPreferencesAutomation(QWidget):
         return
 
     ##
-    #  Slots
+    #  Private Slots
     ##
 
-    def _toggleAutoReplaceMain(self, theState):
-        """Enables or disables switches controlled by the main auto
-        replace switch.
-        """
-        self.doReplaceSQuote.setEnabled(theState)
-        self.doReplaceDQuote.setEnabled(theState)
-        self.doReplaceDash.setEnabled(theState)
-        self.doReplaceDots.setEnabled(theState)
-        self.fmtPadThin.setEnabled(theState)
+    @pyqtSlot(bool)
+    def _toggleAutoReplaceMain(self, state: bool) -> None:
+        """Toggle switches controlled by the auto replace switch."""
+        self.doReplaceSQuote.setEnabled(state)
+        self.doReplaceDQuote.setEnabled(state)
+        self.doReplaceDash.setEnabled(state)
+        self.doReplaceDots.setEnabled(state)
+        self.fmtPadThin.setEnabled(state)
         return
 
 # END Class GuiPreferencesAutomation
@@ -1029,7 +1016,7 @@ class GuiPreferencesAutomation(QWidget):
 
 class GuiPreferencesQuotes(QWidget):
 
-    def __init__(self, prefsGui):
+    def __init__(self, prefsGui: GuiPreferences) -> None:
         super().__init__(parent=prefsGui)
 
         # The Form
@@ -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(
@@ -1113,9 +1100,8 @@ class GuiPreferencesQuotes(QWidget):
 
         return
 
-    def saveValues(self):
-        """Save the values set for this tab.
-        """
+    def saveValues(self) -> None:
+        """Save the values set for this tab."""
         # Quotation Style
         CONFIG.fmtSQuoteOpen = self.quoteSym["SO"].text()
         CONFIG.fmtSQuoteClose = self.quoteSym["SC"].text()
@@ -1124,12 +1110,11 @@ class GuiPreferencesQuotes(QWidget):
         return
 
     ##
-    #  Slots
+    #  Internal Functions
     ##
 
-    def _getQuote(self, qType):
-        """Dialog for single quote open.
-        """
+    def _getQuote(self, qType: str) -> None:
+        """Dialog for single quote open."""
         qtBox = GuiQuoteSelect(self, currentQuote=self.quoteSym[qType].text())
         if qtBox.exec_() == QDialog.Accepted:
             self.quoteSym[qType].setText(qtBox.selectedQuote)