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

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
@@ -26,10 +26,10 @@ from __future__ import annotations
 import logging
 
 from PyQt5.QtGui import QFontMetrics
-from PyQt5.QtCore import Qt, QSize
+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
@@ -40,18 +40,21 @@ logger = logging.getLogger(__name__)
 
 class GuiQuoteSelect(QDialog):
 
-    selectedQuote = ""
+    _selected = ""
 
     D_KEY = Qt.ItemDataRole.UserRole
 
-    def __init__(self, parent=None, currentQuote='"'):
+    def __init__(self, parent: QWidget, current: str = '"') -> None:
         super().__init__(parent=parent)
 
+        logger.debug("Create: GuiQuoteSelect")
+        self.setObjectName("GuiQuoteSelect")
+
         self.outerBox = QVBoxLayout()
         self.innerBox = QHBoxLayout()
         self.labelBox = QVBoxLayout()
 
-        self.selectedQuote = currentQuote
+        self._selected = current
 
         qMetrics = QFontMetrics(self.font())
         pxW = 7*qMetrics.boundingRectChar("M").width()
@@ -62,7 +65,7 @@ class GuiQuoteSelect(QDialog):
         lblFont.setPointSizeF(4*lblFont.pointSizeF())
 
         # Preview Label
-        self.previewLabel = QLabel(currentQuote)
+        self.previewLabel = QLabel(current)
         self.previewLabel.setFont(lblFont)
         self.previewLabel.setFixedSize(QSize(pxW, pxH))
         self.previewLabel.setAlignment(Qt.AlignCenter)
@@ -74,12 +77,12 @@ class GuiQuoteSelect(QDialog):
 
         minSize = 100
         for sKey, sLabel in nwQuotes.SYMBOLS.items():
-            theText = "[ %s ] %s" % (sKey, trConst(sLabel))
-            minSize = max(minSize, qMetrics.boundingRect(theText).width())
-            qtItem = QListWidgetItem(theText)
+            text = "[ %s ] %s" % (sKey, trConst(sLabel))
+            minSize = max(minSize, qMetrics.boundingRect(text).width())
+            qtItem = QListWidgetItem(text)
             qtItem.setData(self.D_KEY, sKey)
             self.listBox.addItem(qtItem)
-            if sKey == currentQuote:
+            if sKey == current:
                 self.listBox.setCurrentItem(qtItem)
 
         self.listBox.setMinimumWidth(minSize + CONFIG.pxInt(40))
@@ -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,32 +105,40 @@ class GuiQuoteSelect(QDialog):
 
         self.setLayout(self.outerBox)
 
-        return
-
-    ##
-    #  Slots
-    ##
+        logger.debug("Ready: GuiQuoteSelect")
 
-    def _selectedSymbol(self):
-        """Update the preview label and the selected quote style.
-        """
-        selItems = self.listBox.selectedItems()
-        if selItems:
-            theSymbol = selItems[0].data(self.D_KEY)
-            self.previewLabel.setText(theSymbol)
-            self.selectedQuote = theSymbol
         return
 
-    def _doAccept(self):
-        """Ok button clicked.
-        """
-        self.accept()
+    def __del__(self) -> None:  # pragma: no cover
+        logger.debug("Delete: GuiQuoteSelect")
         return
 
-    def _doReject(self):
-        """Cancel button clicked.
-        """
-        self.reject()
+    @property
+    def selectedQuote(self) -> str:
+        """Return the selected quote symbol."""
+        return self._selected
+
+    @classmethod
+    def getQuote(cls, parent: QWidget, current: str = "") -> tuple[str, bool]:
+        """Pop the dialog and return the result."""
+        cls = GuiQuoteSelect(parent, current=current)
+        cls.exec_()
+        quote = cls._selected
+        accepted = cls.result() == QDialog.DialogCode.Accepted
+        cls.deleteLater()
+        return quote, accepted
+
+    ##
+    #  Private Slots
+    ##
+
+    @pyqtSlot()
+    def _selectedSymbol(self) -> None:
+        """Update the preview label and the selected quote style."""
+        if items := self.listBox.selectedItems():
+            quote = items[0].data(self.D_KEY)
+            self.previewLabel.setText(quote)
+            self._selected = quote
         return
 
 # END Class GuiQuoteSelect

novelwriter/dialogs/wordlist.py

@@ -3,10 +3,10 @@ novelWriter – GUI User Wordlist
 ===============================
 
 File History:
-Created: 2021-02-12 [1.2rc1]
+Created: 2021-02-12 [1.2rc1] GuiWordList
 
 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,15 +26,19 @@ from __future__ import annotations
 import logging
 
 from typing import TYPE_CHECKING
+from pathlib import Path
 
-from PyQt5.QtCore import Qt
+from PyQt5.QtGui import QCloseEvent
+from PyQt5.QtCore import Qt, pyqtSignal, pyqtSlot
 from PyQt5.QtWidgets import (
-    QAbstractItemView, QDialog, QDialogButtonBox, QHBoxLayout, QLabel,
-    QLineEdit, QListWidget, QListWidgetItem, QPushButton, QVBoxLayout
+    QAbstractItemView, QDialog, QDialogButtonBox, QFileDialog, QHBoxLayout,
+    QLineEdit, QListWidget, QPushButton, QVBoxLayout, qApp
 )
 
 from novelwriter import CONFIG, SHARED
+from novelwriter.common import formatFileFilter
 from novelwriter.core.spellcheck import UserDictionary
+from novelwriter.extensions.configlayout import NColourLabel
 
 if TYPE_CHECKING:  # pragma: no cover
     from novelwriter.guimain import GuiMain
@@ -44,7 +48,9 @@ logger = logging.getLogger(__name__)
 
 class GuiWordList(QDialog):
 
-    def __init__(self, mainGui: GuiMain):
+    newWordListReady = pyqtSignal()
+
+    def __init__(self, mainGui: GuiMain) -> None:
         super().__init__(parent=mainGui)
 
         logger.debug("Create: GuiWordList")
@@ -54,30 +60,46 @@ class GuiWordList(QDialog):
         mS = CONFIG.pxInt(250)
         wW = CONFIG.pxInt(320)
         wH = CONFIG.pxInt(340)
-        pOptions = SHARED.project.options
 
         self.setMinimumWidth(mS)
         self.setMinimumHeight(mS)
         self.resize(
-            CONFIG.pxInt(pOptions.getInt("GuiWordList", "winWidth",  wW)),
-            CONFIG.pxInt(pOptions.getInt("GuiWordList", "winHeight", wH))
+            CONFIG.pxInt(SHARED.project.options.getInt("GuiWordList", "winWidth",  wW)),
+            CONFIG.pxInt(SHARED.project.options.getInt("GuiWordList", "winHeight", wH))
+        )
+
+        # Header
+        self.headLabel = NColourLabel(
+            "Project Word List", SHARED.theme.helpText, parent=self,
+            scale=NColourLabel.HEADER_SCALE
         )
 
-        # Main Widgets
-        # ============
+        self.importButton = QPushButton(SHARED.theme.getIcon("import"), "", self)
+        self.importButton.setToolTip(self.tr("Import words from text file"))
+        self.importButton.clicked.connect(self._importWords)
 
-        self.headLabel = QLabel("<b>%s</b>" % self.tr("Project Word List"))
+        self.exportButton = QPushButton(SHARED.theme.getIcon("export"), "", self)
+        self.exportButton.setToolTip(self.tr("Export words to text file"))
+        self.exportButton.clicked.connect(self._exportWords)
 
-        self.listBox = QListWidget()
+        self.headerBox = QHBoxLayout()
+        self.headerBox.addWidget(self.headLabel, 1)
+        self.headerBox.addWidget(self.importButton, 0)
+        self.headerBox.addWidget(self.exportButton, 0)
+
+        # List Box
+        self.listBox = QListWidget(self)
         self.listBox.setDragDropMode(QAbstractItemView.NoDragDrop)
+        self.listBox.setSelectionMode(QAbstractItemView.SelectionMode.ExtendedSelection)
         self.listBox.setSortingEnabled(True)
 
-        self.newEntry = QLineEdit()
+        # Add/Remove Form
+        self.newEntry = QLineEdit(self)
 
-        self.addButton = QPushButton(SHARED.theme.getIcon("add"), "")
+        self.addButton = QPushButton(SHARED.theme.getIcon("add"), "", self)
         self.addButton.clicked.connect(self._doAdd)
 
-        self.delButton = QPushButton(SHARED.theme.getIcon("remove"), "")
+        self.delButton = QPushButton(SHARED.theme.getIcon("remove"), "", self)
         self.delButton.clicked.connect(self._doDelete)
 
         self.editBox = QHBoxLayout()
@@ -85,20 +107,19 @@ class GuiWordList(QDialog):
         self.editBox.addWidget(self.addButton, 0)
         self.editBox.addWidget(self.delButton, 0)
 
+        # Buttons
         self.buttonBox = QDialogButtonBox(QDialogButtonBox.Save | QDialogButtonBox.Close)
         self.buttonBox.accepted.connect(self._doSave)
-        self.buttonBox.rejected.connect(self._doClose)
+        self.buttonBox.rejected.connect(self.close)
 
         # Assemble
-        # ========
-
         self.outerBox = QVBoxLayout()
-        self.outerBox.addWidget(self.headLabel)
-        self.outerBox.addSpacing(CONFIG.pxInt(8))
+        self.outerBox.addLayout(self.headerBox, 0)
         self.outerBox.addWidget(self.listBox, 1)
         self.outerBox.addLayout(self.editBox, 0)
         self.outerBox.addSpacing(CONFIG.pxInt(12))
         self.outerBox.addWidget(self.buttonBox, 0)
+        self.outerBox.setSpacing(CONFIG.pxInt(4))
 
         self.setLayout(self.outerBox)
 
@@ -108,82 +129,130 @@ class GuiWordList(QDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiWordList")
         return
 
     ##
-    #  Slots
+    #  Events
     ##
 
-    def _doAdd(self):
-        """Add a new word to the word list."""
-        word = self.newEntry.text().strip()
-        if word == "":
-            SHARED.error(self.tr("Cannot add a blank word."))
-            return
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the close event and perform cleanup."""
+        self._saveGuiSettings()
+        event.accept()
+        self.deleteLater()
+        return
 
-        if self.listBox.findItems(word, Qt.MatchExactly):
-            SHARED.error(self.tr(
-                "The word '{0}' is already in the word list."
-            ).format(word))
-            return
+    ##
+    #  Private Slots
+    ##
 
-        self.listBox.addItem(word)
+    @pyqtSlot()
+    def _doAdd(self) -> None:
+        """Add a new word to the word list."""
+        word = self.newEntry.text().strip()
         self.newEntry.setText("")
-
+        self.listBox.clearSelection()
+        self._addWord(word)
+        if items := self.listBox.findItems(word, Qt.MatchExactly):
+            self.listBox.setCurrentItem(items[0])
+            self.listBox.scrollToItem(items[0], QAbstractItemView.ScrollHint.PositionAtCenter)
         return
 
-    def _doDelete(self):
-        """Delete the selected item."""
-        selItem = self.listBox.selectedItems()
-        if selItem:
-            self.listBox.takeItem(self.listBox.row(selItem[0]))
+    @pyqtSlot()
+    def _doDelete(self) -> None:
+        """Delete the selected items."""
+        for item in self.listBox.selectedItems():
+            self.listBox.takeItem(self.listBox.row(item))
         return
 
-    def _doSave(self):
+    @pyqtSlot()
+    def _doSave(self) -> None:
         """Save the new word list and close."""
-        self._saveGuiSettings()
         userDict = UserDictionary(SHARED.project)
-        for i in range(self.listBox.count()):
-            item = self.listBox.item(i)
-            if isinstance(item, QListWidgetItem):
-                word = item.text().strip()
-                if word:
-                    userDict.add(word)
+        for word in self._listWords():
+            userDict.add(word)
         userDict.save()
-        self.accept()
-        return True
+        self.newWordListReady.emit()
+        qApp.processEvents()
+        self.close()
+        return
 
-    def _doClose(self):
-        """Close without saving the word list."""
-        self._saveGuiSettings()
-        self.reject()
+    @pyqtSlot()
+    def _importWords(self) -> None:
+        """Import words from file."""
+        SHARED.info(self.tr(
+            "Note: The import file must be a plain text file with UTF-8 or ASCII encoding."
+        ))
+        ffilter = formatFileFilter(["*.txt", "*"])
+        path, _ = QFileDialog.getOpenFileName(
+            self, self.tr("Import File"), str(Path.home()), filter=ffilter
+        )
+        if path:
+            try:
+                with open(path, mode="r", encoding="utf-8") as fo:
+                    words = set(w.strip() for w in fo.read().split())
+            except Exception as exc:
+                SHARED.error("Could not read file.", exc=exc)
+                return
+            for word in words:
+                self._addWord(word)
+        return
+
+    @pyqtSlot()
+    def _exportWords(self) -> None:
+        """Export words to file."""
+        path, _ = QFileDialog.getSaveFileName(
+            self, self.tr("Export File"), str(Path.home())
+        )
+        if path:
+            try:
+                path = Path(path).with_suffix(".txt")
+                with open(path, mode="w", encoding="utf-8") as fo:
+                    fo.write("\n".join(self._listWords()))
+            except Exception as exc:
+                SHARED.error("Could not write file.", exc=exc)
         return
 
     ##
     #  Internal Functions
     ##
 
-    def _loadWordList(self):
+    def _loadWordList(self) -> None:
         """Load the project's word list, if it exists."""
         userDict = UserDictionary(SHARED.project)
         userDict.load()
         self.listBox.clear()
         for word in userDict:
-            if word:
-                self.listBox.addItem(word)
+            self.listBox.addItem(word)
         return
 
-    def _saveGuiSettings(self):
+    def _saveGuiSettings(self) -> None:
         """Save GUI settings."""
         winWidth  = CONFIG.rpxInt(self.width())
         winHeight = CONFIG.rpxInt(self.height())
 
+        logger.debug("Saving State: GuiWordList")
         pOptions = SHARED.project.options
         pOptions.setValue("GuiWordList", "winWidth",  winWidth)
         pOptions.setValue("GuiWordList", "winHeight", winHeight)
 
         return
 
+    def _addWord(self, word: str) -> None:
+        """Add a single word to the list."""
+        if word and not self.listBox.findItems(word, Qt.MatchExactly):
+            self.listBox.addItem(word)
+            self._changed = True
+        return
+
+    def _listWords(self) -> list[str]:
+        """List all words in the list box."""
+        result = []
+        for i in range(self.listBox.count()):
+            if (item := self.listBox.item(i)) and (word := item.text().strip()):
+                result.append(word)
+        return result
+
 # END Class GuiWordList

novelwriter/enum.py

@@ -6,7 +6,7 @@ File History:
 Created: 2018-11-02 [0.0.1]
 
 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
@@ -47,7 +47,8 @@ class nwItemClass(Enum):
     ENTITY    = 7
     CUSTOM    = 8
     ARCHIVE   = 9
-    TRASH     = 10
+    TEMPLATE  = 10
+    TRASH     = 11
 
 # END Enum nwItemClass
 
@@ -95,9 +96,9 @@ class nwDocAction(Enum):
     CUT       = 3
     COPY      = 4
     PASTE     = 5
-    EMPH      = 6
-    STRONG    = 7
-    STRIKE    = 8
+    MD_ITALIC = 6
+    MD_BOLD   = 7
+    MD_STRIKE = 8
     S_QUOTE   = 9
     D_QUOTE   = 10
     SEL_ALL   = 11
@@ -107,23 +108,24 @@ class nwDocAction(Enum):
     BLOCK_H3  = 15
     BLOCK_H4  = 16
     BLOCK_COM = 17
-    BLOCK_TXT = 18
-    BLOCK_TTL = 19
-    BLOCK_UNN = 20
-    REPL_SNG  = 21
-    REPL_DBL  = 22
-    RM_BREAKS = 23
-    ALIGN_L   = 24
-    ALIGN_C   = 25
-    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
+    BLOCK_IGN = 18
+    BLOCK_TXT = 19
+    BLOCK_TTL = 20
+    BLOCK_UNN = 21
+    REPL_SNG  = 22
+    REPL_DBL  = 23
+    RM_BREAKS = 24
+    ALIGN_L   = 25
+    ALIGN_C   = 26
+    ALIGN_R   = 27
+    INDENT_L  = 28
+    INDENT_R  = 29
+    SC_ITALIC = 30
+    SC_BOLD   = 31
+    SC_STRIKE = 32
+    SC_ULINE  = 33
+    SC_SUP    = 34
+    SC_SUB    = 35
 
 # END Enum nwDocAction
 
@@ -140,6 +142,7 @@ class nwDocInsert(Enum):
     NEW_PAGE  = 7
     VSPACE_S  = 8
     VSPACE_M  = 9
+    LIPSUM    = 10
 
 # END Enum nwDocInsert
 

novelwriter/error.py

@@ -6,7 +6,7 @@ File History:
 Created: 2020-08-02 [0.10.2]
 
 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
@@ -50,7 +50,7 @@ def logException() -> None:
     """Log the content of an exception message."""
     exType, exValue, _ = sys.exc_info()
     if exType is not None:
-        logger.error("%s: %s", exType.__name__, str(exValue))
+        logger.error(f"{exType.__name__}: {str(exValue)}", stacklevel=2)
     return
 
 

novelwriter/extensions/circularprogress.py

@@ -6,7 +6,7 @@ File History:
 Created: 2023-06-07 [2.1b1]
 
 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
@@ -84,17 +84,17 @@ class NProgressCircle(QProgressBar):
         """Custom painter for the progress bar."""
         progress = 100.0*self.value()/self.maximum()
         angle = ceil(16*3.6*progress)
-        qPaint = QPainter(self)
-        qPaint.setRenderHint(QPainter.Antialiasing, True)
-        qPaint.setPen(self._dPen)
-        qPaint.setBrush(self._dBrush)
-        qPaint.drawEllipse(self._dRect)
-        qPaint.setPen(self._bPen)
-        qPaint.drawArc(self._cRect, 0, 360*16)
-        qPaint.setPen(self._cPen)
-        qPaint.drawArc(self._cRect, 90*16, -angle)
-        qPaint.setPen(self._tColor)
-        qPaint.drawText(self._cRect, Qt.AlignCenter, self._text or f"{progress:.1f} %")
+        painter = QPainter(self)
+        painter.setRenderHint(QPainter.Antialiasing, True)
+        painter.setPen(self._dPen)
+        painter.setBrush(self._dBrush)
+        painter.drawEllipse(self._dRect)
+        painter.setPen(self._bPen)
+        painter.drawArc(self._cRect, 0, 360*16)
+        painter.setPen(self._cPen)
+        painter.drawArc(self._cRect, 90*16, -angle)
+        painter.setPen(self._tColor)
+        painter.drawText(self._cRect, Qt.AlignCenter, self._text or f"{progress:.1f} %")
         return
 
 # END Class NProgressCircle