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

novelwriter/dialogs/projsettings.py

@@ -96,21 +96,22 @@ class GuiProjectSettings(NPagedDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiProjectSettings")
         return
 
     ##
-    #  Slots
+    #  Private Slots
     ##
 
-    def _doSave(self):
-        """Save settings and close dialog.
-        """
-        project = SHARED.project
+    @pyqtSlot()
+    def _doSave(self) -> None:
+        """Save settings and close dialog."""
+        project    = SHARED.project
         projName   = self.tabMain.editName.text()
         bookTitle  = self.tabMain.editTitle.text()
         bookAuthor = self.tabMain.editAuthor.text()
+        projLang   = self.tabMain.projLang.currentData()
         spellLang  = self.tabMain.spellLang.currentData()
         doBackup   = not self.tabMain.doBackup.isChecked()
 
@@ -119,6 +120,7 @@ class GuiProjectSettings(NPagedDialog):
         project.data.setAuthor(bookAuthor)
         project.data.setDoBackup(doBackup)
         project.data.setSpellLang(spellLang)
+        project.setProjectLang(projLang)
 
         if self.tabStatus.colChanged:
             newList, delList = self.tabStatus.getNewList()
@@ -140,9 +142,9 @@ class GuiProjectSettings(NPagedDialog):
 
         return
 
-    def _doClose(self):
-        """Save settings and close the dialog.
-        """
+    @pyqtSlot()
+    def _doClose(self) -> None:
+        """Save settings and close the dialog."""
         self._saveGuiSettings()
         self.reject()
         return
@@ -151,9 +153,8 @@ class GuiProjectSettings(NPagedDialog):
     #  Internal Functions
     ##
 
-    def _focusTab(self, tab):
-        """Change which is the focused tab.
-        """
+    def _focusTab(self, tab: int) -> None:
+        """Change which is the focused tab."""
         if tab == self.TAB_MAIN:
             self.setCurrentWidget(self.tabMain)
         elif tab == self.TAB_STATUS:
@@ -164,9 +165,8 @@ class GuiProjectSettings(NPagedDialog):
             self.setCurrentWidget(self.tabReplace)
         return
 
-    def _saveGuiSettings(self):
-        """Save GUI settings.
-        """
+    def _saveGuiSettings(self) -> None:
+        """Save GUI settings."""
         winWidth    = CONFIG.rpxInt(self.width())
         winHeight   = CONFIG.rpxInt(self.height())
         replaceColW = CONFIG.rpxInt(self.tabReplace.listBox.columnWidth(0))
@@ -187,8 +187,8 @@ class GuiProjectSettings(NPagedDialog):
 
 class GuiProjectEditMain(QWidget):
 
-    def __init__(self, projGui):
-        super().__init__(parent=projGui)
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
 
         # The Form
         self.mainForm = NConfigLayout()
@@ -230,24 +230,41 @@ class GuiProjectEditMain(QWidget):
             self.tr("Change whenever you want!")
         )
 
+        self.projLang = QComboBox(self)
+        self.projLang.setMaximumWidth(xW)
+        for tag, language in CONFIG.listLanguages(CONFIG.LANG_PROJ):
+            self.projLang.addItem(language, tag)
+        self.mainForm.addRow(
+            self.tr("Project language"),
+            self.projLang,
+            self.tr("Used when building the manuscript.")
+        )
+
+        langIdx = 0
+        if pData.language is not None:
+            langIdx = self.projLang.findData(pData.language)
+        if langIdx == -1:
+            langIdx = self.projLang.findData("en_GB")
+        if langIdx != -1:
+            self.projLang.setCurrentIndex(langIdx)
+
         self.spellLang = QComboBox(self)
         self.spellLang.setMaximumWidth(xW)
         self.spellLang.addItem(self.tr("Default"), "None")
         if CONFIG.hasEnchant:
             for tag, language in SHARED.spelling.listDictionaries():
                 self.spellLang.addItem(language, tag)
-
         self.mainForm.addRow(
             self.tr("Spell check language"),
             self.spellLang,
             self.tr("Overrides main preferences.")
         )
 
-        spellIdx = 0
+        langIdx = 0
         if pData.spellLang is not None:
-            spellIdx = self.spellLang.findData(pData.spellLang)
-        if spellIdx != -1:
-            self.spellLang.setCurrentIndex(spellIdx)
+            langIdx = self.spellLang.findData(pData.spellLang)
+        if langIdx != -1:
+            self.spellLang.setCurrentIndex(langIdx)
 
         self.doBackup = NSwitch(self)
         self.doBackup.setChecked(not pData.doBackup)
@@ -271,8 +288,8 @@ class GuiProjectEditStatus(QWidget):
     COL_ROLE = Qt.ItemDataRole.UserRole + 1
     NUM_ROLE = Qt.ItemDataRole.UserRole + 2
 
-    def __init__(self, projGui, isStatus):
-        super().__init__(parent=projGui)
+    def __init__(self, parent: QWidget, isStatus: bool) -> None:
+        super().__init__(parent=parent)
 
         if isStatus:
             self.theStatus = SHARED.project.data.itemStatus
@@ -372,9 +389,8 @@ class GuiProjectEditStatus(QWidget):
 
         return
 
-    def getNewList(self):
-        """Return list of entries.
-        """
+    def getNewList(self) -> tuple[list, list]:
+        """Return list of entries."""
         if self.colChanged:
             newList = []
             for n in range(self.listBox.topLevelItemCount()):
@@ -394,9 +410,8 @@ class GuiProjectEditStatus(QWidget):
     ##
 
     @pyqtSlot()
-    def _selectColour(self):
-        """Open a dialog to select the status icon colour.
-        """
+    def _selectColour(self) -> None:
+        """Open a dialog to select the status icon colour."""
         if self.selColour is not None:
             newCol = QColorDialog.getColor(
                 self.selColour, self, self.tr("Select Colour")
@@ -410,17 +425,15 @@ class GuiProjectEditStatus(QWidget):
         return
 
     @pyqtSlot()
-    def _newItem(self):
-        """Create a new status item.
-        """
+    def _newItem(self) -> None:
+        """Create a new status item."""
         self._addItem(None, self.tr("New Item"), (100, 100, 100), 0)
         self.colChanged = True
         return
 
     @pyqtSlot()
-    def _delItem(self):
-        """Delete a status item.
-        """
+    def _delItem(self) -> None:
+        """Delete a status item."""
         selItem = self._getSelectedItem()
         if isinstance(selItem, QTreeWidgetItem):
             iRow = self.listBox.indexOfTopLevelItem(selItem)
@@ -433,9 +446,8 @@ class GuiProjectEditStatus(QWidget):
         return
 
     @pyqtSlot()
-    def _saveItem(self):
-        """Save changes made to a status item.
-        """
+    def _saveItem(self) -> None:
+        """Save changes made to a status item."""
         selItem = self._getSelectedItem()
         if isinstance(selItem, QTreeWidgetItem):
             selItem.setText(self.COL_LABEL, simplified(self.editName.text()))
@@ -444,11 +456,10 @@ class GuiProjectEditStatus(QWidget):
                 self.selColour.red(), self.selColour.green(), self.selColour.blue()
             ))
             self.colChanged = True
-
         return
 
     @pyqtSlot()
-    def _selectedItem(self):
+    def _selectedItem(self) -> None:
         """Extract the info of a selected item and populate the settings
         boxes and button. If no item is selected, clear the form.
         """
@@ -456,7 +467,6 @@ class GuiProjectEditStatus(QWidget):
         if isinstance(selItem, QTreeWidgetItem):
             cols = selItem.data(self.COL_LABEL, self.COL_ROLE)
             name = selItem.text(self.COL_LABEL)
-
             pixmap = QPixmap(self.iPx, self.iPx)
             pixmap.fill(QColor(*cols))
             self.selColour = QColor(*cols)
@@ -464,31 +474,27 @@ class GuiProjectEditStatus(QWidget):
             self.colButton.setIcon(QIcon(pixmap))
             self.editName.selectAll()
             self.editName.setFocus()
-
             self.editName.setEnabled(True)
             self.colButton.setEnabled(True)
             self.saveButton.setEnabled(True)
-
         else:
             pixmap = QPixmap(self.iPx, self.iPx)
             pixmap.fill(QColor(100, 100, 100))
             self.selColour = QColor(100, 100, 100)
             self.editName.setText("")
             self.colButton.setIcon(QIcon(pixmap))
-
             self.editName.setEnabled(False)
             self.colButton.setEnabled(False)
             self.saveButton.setEnabled(False)
-
         return
 
     ##
     #  Internal Functions
     ##
 
-    def _addItem(self, key, name, cols, count):
-        """Add a status item to the list.
-        """
+    def _addItem(self, key: str | None, name: str,
+                 cols: tuple[int, int, int], count: int) -> None:
+        """Add a status item to the list."""
         pixmap = QPixmap(self.iPx, self.iPx)
         pixmap.fill(QColor(*cols))
 
@@ -504,9 +510,8 @@ class GuiProjectEditStatus(QWidget):
 
         return
 
-    def _moveItem(self, step):
-        """Move and item up or down step.
-        """
+    def _moveItem(self, step: int) -> None:
+        """Move and item up or down step."""
         selItem = self._getSelectedItem()
         if selItem is None:
             return
@@ -527,17 +532,15 @@ class GuiProjectEditStatus(QWidget):
 
         return
 
-    def _getSelectedItem(self):
-        """Get the currently selected item.
-        """
+    def _getSelectedItem(self) -> QTreeWidgetItem | None:
+        """Get the currently selected item."""
         selItem = self.listBox.selectedItems()
         if len(selItem) > 0:
             return selItem[0]
         return None
 
-    def _usageString(self, nUse):
-        """Generate usage string.
-        """
+    def _usageString(self, nUse: int) -> str:
+        """Generate usage string."""
         if nUse == 0:
             return self.tr("Not in use")
         elif nUse == 1:
@@ -553,8 +556,8 @@ class GuiProjectEditReplace(QWidget):
     COL_KEY  = 0
     COL_REPL = 1
 
-    def __init__(self, projGui):
-        super().__init__(parent=projGui)
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
 
         self.arChanged = False
 
@@ -635,25 +638,23 @@ class GuiProjectEditReplace(QWidget):
 
         return
 
-    def getNewList(self):
-        """Extract the list from the widget.
-        """
-        newList = {}
+    def getNewList(self) -> dict:
+        """Extract the list from the widget."""
+        new = {}
         for n in range(self.listBox.topLevelItemCount()):
             tItem = self.listBox.topLevelItem(n)
             if tItem is not None:
                 aKey = self._stripNotAllowed(tItem.text(0))
                 aVal = tItem.text(1)
                 if len(aKey) > 0:
-                    newList[aKey] = aVal
-
-        return newList
+                    new[aKey] = aVal
+        return new
 
     ##
     #  Internal Functions
     ##
 
-    def _selectedItem(self):
+    def _selectedItem(self) -> bool:
         """Extract the details from the selected item and populate the
         edit form.
         """
@@ -670,63 +671,53 @@ class GuiProjectEditReplace(QWidget):
         self.editKey.setFocus()
         return True
 
-    def _saveEntry(self):
-        """Save the form data into the list widget.
-        """
+    def _saveEntry(self) -> None:
+        """Save the form data into the list widget."""
         selItem = self._getSelectedItem()
-        if selItem is None:
-            return False
-
-        newKey = self.editKey.text()
-        newVal = self.editValue.text()
-        saveKey = self._stripNotAllowed(newKey)
-
-        if len(saveKey) > 0 and len(newVal) > 0:
-            selItem.setText(self.COL_KEY,  "<%s>" % saveKey)
-            selItem.setText(self.COL_REPL, newVal)
-            self.editKey.clear()
-            self.editValue.clear()
-            self.editKey.setEnabled(False)
-            self.editValue.setEnabled(False)
-            self.listBox.clearSelection()
-            self.arChanged = True
-
+        if selItem:
+            newKey = self.editKey.text()
+            newVal = self.editValue.text()
+            saveKey = self._stripNotAllowed(newKey)
+            if len(saveKey) > 0 and len(newVal) > 0:
+                selItem.setText(self.COL_KEY,  "<%s>" % saveKey)
+                selItem.setText(self.COL_REPL, newVal)
+                self.editKey.clear()
+                self.editValue.clear()
+                self.editKey.setEnabled(False)
+                self.editValue.setEnabled(False)
+                self.listBox.clearSelection()
+                self.arChanged = True
         return
 
-    def _addEntry(self):
-        """Add a new list entry.
-        """
+    def _addEntry(self) -> None:
+        """Add a new list entry."""
         saveKey = "<keyword%d>" % (self.listBox.topLevelItemCount() + 1)
         newVal  = ""
         newItem = QTreeWidgetItem([saveKey, newVal])
         self.listBox.addTopLevelItem(newItem)
-        return True
+        return
 
-    def _delEntry(self):
-        """Delete the selected entry.
-        """
+    def _delEntry(self) -> None:
+        """Delete the selected entry."""
         selItem = self._getSelectedItem()
-        if selItem is None:
-            return False
-        self.listBox.takeTopLevelItem(self.listBox.indexOfTopLevelItem(selItem))
-        self.arChanged = True
-        return True
+        if selItem:
+            self.listBox.takeTopLevelItem(self.listBox.indexOfTopLevelItem(selItem))
+            self.arChanged = True
+        return
 
-    def _getSelectedItem(self):
-        """Extract the currently selected item.
-        """
+    def _getSelectedItem(self) -> QTreeWidgetItem | None:
+        """Extract the currently selected item."""
         selItem = self.listBox.selectedItems()
         if len(selItem) == 0:
             return None
         return selItem[0]
 
-    def _stripNotAllowed(self, theKey):
-        """Clean up the replace key string.
-        """
-        retKey = ""
-        for c in theKey:
+    def _stripNotAllowed(self, key: str) -> str:
+        """Clean up the replace key string."""
+        result = ""
+        for c in key:
             if c.isalnum():
-                retKey += c
-        return retKey
+                result += c
+        return result
 
 # END Class GuiProjectEditReplace

novelwriter/dialogs/updates.py

@@ -29,10 +29,10 @@ import logging
 from datetime import datetime
 from urllib.request import Request, urlopen
 
-from PyQt5.QtGui import QCursor
-from PyQt5.QtCore import Qt
+from PyQt5.QtGui import QCloseEvent, QCursor
+from PyQt5.QtCore import Qt, pyqtSlot
 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._doClose)
 
         # 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,10 +160,22 @@ class GuiUpdates(QDialog):
         return
 
     ##
-    #  Internal Functions
+    #  Events
     ##
 
-    def _doClose(self):
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the user closing the window."""
+        event.accept()
+        self.deleteLater()
+        return
+
+    ##
+    #  Private Slots
+    ##
+
+    @pyqtSlot()
+    def _doClose(self) -> None:
+        """Close the dialog."""
         self.close()
         return
 

novelwriter/enum.py

@@ -61,6 +61,24 @@ class nwItemLayout(Enum):
 # END Enum nwItemLayout
 
 
+class nwComment(Enum):
+
+    PLAIN    = 0
+    SYNOPSIS = 1
+    SHORT    = 2
+
+# END Enum nwComment
+
+
+class nwTrinary(Enum):
+
+    NEGATIVE = -1
+    NEUTRAL  = 0
+    POSITIVE = 1
+
+# END Enum nwTrinary
+
+
 class nwDocMode(Enum):
 
     VIEW = 0
@@ -100,6 +118,12 @@ class nwDocAction(Enum):
     ALIGN_R   = 26
     INDENT_L  = 27
     INDENT_R  = 28
+    SC_ITALIC = 29
+    SC_BOLD   = 30
+    SC_STRIKE = 31
+    SC_ULINE  = 32
+    SC_SUP    = 33
+    SC_SUB    = 34
 
 # END Enum nwDocAction
 
@@ -112,9 +136,10 @@ class nwDocInsert(Enum):
     QUOTE_LD  = 3
     QUOTE_RD  = 4
     SYNOPSIS  = 5
-    NEW_PAGE  = 6
-    VSPACE_S  = 7
-    VSPACE_M  = 8
+    SHORT     = 6
+    NEW_PAGE  = 7
+    VSPACE_S  = 8
+    VSPACE_M  = 9
 
 # END Enum nwDocInsert
 

novelwriter/extensions/novelselector.py

@@ -62,7 +62,7 @@ class NovelSelector(QComboBox):
     #  Methods
     ##
 
-    def setHandle(self, tHandle: str, blockSignal: bool = True) -> None:
+    def setHandle(self, tHandle: str | None, blockSignal: bool = True) -> None:
         """Set the currently selected handle."""
         self._blockSignal = blockSignal
         if tHandle is None: