novelWriter 2.4.3__py3-none-any.whl → 2.5__py3-none-any.whl

novelwriter/dialogs/quotes.py

@@ -25,21 +25,25 @@ from __future__ import annotations
 
 import logging
 
-from PyQt5.QtGui import QFontMetrics
 from PyQt5.QtCore import QSize, pyqtSlot
+from PyQt5.QtGui import QFontMetrics
 from PyQt5.QtWidgets import (
-    QDialog, QDialogButtonBox, QFrame, QHBoxLayout, QLabel, QListWidget,
+    QDialogButtonBox, QFrame, QHBoxLayout, QLabel, QListWidget,
     QListWidgetItem, QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG
-from novelwriter.constants import trConst, nwQuotes
-from novelwriter.types import QtAlignCenter, QtAlignTop, QtDialogCancel, QtDialogOk, QtUserRole
+from novelwriter.constants import nwQuotes, trConst
+from novelwriter.extensions.modified import NDialog
+from novelwriter.types import (
+    QtAccepted, QtAlignCenter, QtAlignTop, QtDialogCancel, QtDialogOk,
+    QtUserRole
+)
 
 logger = logging.getLogger(__name__)
 
 
-class GuiQuoteSelect(QDialog):
+class GuiQuoteSelect(NDialog):
 
     _selected = ""
 
@@ -50,6 +54,7 @@ class GuiQuoteSelect(QDialog):
 
         logger.debug("Create: GuiQuoteSelect")
         self.setObjectName("GuiQuoteSelect")
+        self.setWindowTitle(self.tr("Select Quote Style"))
 
         self.outerBox = QVBoxLayout()
         self.innerBox = QHBoxLayout()
@@ -125,8 +130,8 @@ class GuiQuoteSelect(QDialog):
         cls = GuiQuoteSelect(parent, current=current)
         cls.exec()
         quote = cls._selected
-        accepted = cls.result() == QDialog.DialogCode.Accepted
-        cls.deleteLater()
+        accepted = cls.result() == QtAccepted
+        cls.softDelete()
         return quote, accepted
 
     ##
@@ -141,5 +146,3 @@ class GuiQuoteSelect(QDialog):
             self.previewLabel.setText(quote)
             self._selected = quote
         return
-
-# END Class GuiQuoteSelect

novelwriter/dialogs/wordlist.py

@@ -25,35 +25,31 @@ from __future__ import annotations
 
 import logging
 
-from typing import TYPE_CHECKING
 from pathlib import Path
 
 from PyQt5.QtCore import Qt, pyqtSignal, pyqtSlot
 from PyQt5.QtGui import QCloseEvent
 from PyQt5.QtWidgets import (
-    QAbstractItemView, QApplication, QDialog, QDialogButtonBox, QFileDialog,
-    QHBoxLayout, QLineEdit, QListWidget, QVBoxLayout
+    QAbstractItemView, QApplication, QDialogButtonBox, QFileDialog,
+    QHBoxLayout, QLineEdit, QListWidget, QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.common import formatFileFilter
 from novelwriter.core.spellcheck import UserDictionary
 from novelwriter.extensions.configlayout import NColourLabel
-from novelwriter.extensions.modified import NIconToolButton
+from novelwriter.extensions.modified import NDialog, NIconToolButton
 from novelwriter.types import QtDialogClose, QtDialogSave
 
-if TYPE_CHECKING:  # pragma: no cover
-    from novelwriter.guimain import GuiMain
-
 logger = logging.getLogger(__name__)
 
 
-class GuiWordList(QDialog):
+class GuiWordList(NDialog):
 
     newWordListReady = pyqtSignal()
 
-    def __init__(self, mainGui: GuiMain) -> None:
-        super().__init__(parent=mainGui)
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
 
         logger.debug("Create: GuiWordList")
         self.setObjectName("GuiWordList")
@@ -73,7 +69,7 @@ class GuiWordList(QDialog):
 
         # Header
         self.headLabel = NColourLabel(
-            self.tr("Project Word List"), SHARED.theme.helpText, parent=self,
+            self.tr("Project Word List"), self, color=SHARED.theme.helpText,
             scale=NColourLabel.HEADER_SCALE
         )
 
@@ -113,7 +109,7 @@ class GuiWordList(QDialog):
         # Buttons
         self.buttonBox = QDialogButtonBox(QtDialogSave | QtDialogClose, self)
         self.buttonBox.accepted.connect(self._doSave)
-        self.buttonBox.rejected.connect(self.close)
+        self.buttonBox.rejected.connect(self.reject)
 
         # Assemble
         self.outerBox = QVBoxLayout()
@@ -144,7 +140,7 @@ class GuiWordList(QDialog):
         """Capture the close event and perform cleanup."""
         self._saveGuiSettings()
         event.accept()
-        self.deleteLater()
+        self.softDelete()
         return
 
     ##
@@ -257,5 +253,3 @@ class GuiWordList(QDialog):
             if (item := self.listBox.item(i)) and (word := item.text().strip()):
                 result.append(word)
         return result
-
-# END Class GuiWordList

novelwriter/enum.py

@@ -32,8 +32,6 @@ class nwItemType(Enum):
     FOLDER  = 2
     FILE    = 3
 
-# END Enum nwItemType
-
 
 class nwItemClass(Enum):
 
@@ -50,8 +48,6 @@ class nwItemClass(Enum):
     TEMPLATE  = 10
     TRASH     = 11
 
-# END Enum nwItemClass
-
 
 class nwItemLayout(Enum):
 
@@ -59,16 +55,17 @@ class nwItemLayout(Enum):
     DOCUMENT  = 1
     NOTE      = 2
 
-# END Enum nwItemLayout
-
 
 class nwComment(Enum):
 
     PLAIN    = 0
-    SYNOPSIS = 1
-    SHORT    = 2
-
-# END Enum nwComment
+    IGNORE   = 1
+    SYNOPSIS = 2
+    SHORT    = 3
+    NOTE     = 4
+    FOOTNOTE = 5
+    COMMENT  = 6
+    STORY    = 7
 
 
 class nwTrinary(Enum):
@@ -77,16 +74,12 @@ class nwTrinary(Enum):
     NEUTRAL  = 0
     POSITIVE = 1
 
-# END Enum nwTrinary
-
 
 class nwDocMode(Enum):
 
     VIEW = 0
     EDIT = 1
 
-# END Enum nwDocMode
-
 
 class nwDocAction(Enum):
 
@@ -129,8 +122,6 @@ class nwDocAction(Enum):
     SC_SUP    = 36
     SC_SUB    = 37
 
-# END Enum nwDocAction
-
 
 class nwDocInsert(Enum):
 
@@ -145,8 +136,7 @@ class nwDocInsert(Enum):
     VSPACE_S  = 8
     VSPACE_M  = 9
     LIPSUM    = 10
-
-# END Enum nwDocInsert
+    FOOTNOTE  = 11
 
 
 class nwView(Enum):
@@ -157,17 +147,12 @@ class nwView(Enum):
     OUTLINE = 3
     SEARCH  = 4
 
-# END Enum nwView
-
 
-class nwWidget(Enum):
+class nwFocus(Enum):
 
-    TREE    = 1
-    EDITOR  = 2
-    VIEWER  = 3
-    OUTLINE = 4
-
-# END Enum nwWidget
+    TREE     = 1
+    DOCUMENT = 2
+    OUTLINE  = 3
 
 
 class nwOutline(Enum):
@@ -190,8 +175,6 @@ class nwOutline(Enum):
     CUSTOM = 15
     SYNOP  = 16
 
-# END Enum nwOutline
-
 
 class nwBuildFmt(Enum):
 
@@ -204,4 +187,26 @@ class nwBuildFmt(Enum):
     J_HTML = 6
     J_NWD  = 7
 
-# END Enum nwBuildFormat
+
+class nwStatusShape(Enum):
+
+    SQUARE   = 0
+    TRIANGLE = 1
+    NABLA    = 2
+    DIAMOND  = 3
+    PENTAGON = 4
+    HEXAGON  = 5
+    STAR     = 6
+    PACMAN   = 7
+    CIRCLE_Q = 8
+    CIRCLE_H = 9
+    CIRCLE_T = 10
+    CIRCLE   = 11
+    BARS_1   = 12
+    BARS_2   = 13
+    BARS_3   = 14
+    BARS_4   = 15
+    BLOCK_1  = 16
+    BLOCK_2  = 17
+    BLOCK_3  = 18
+    BLOCK_4  = 19

novelwriter/error.py

@@ -23,17 +23,17 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-import sys
-import random
 import logging
+import random
+import sys
 
 from typing import TYPE_CHECKING
 
 from PyQt5.QtCore import Qt, pyqtSlot
 from PyQt5.QtGui import QFont, QFontDatabase
 from PyQt5.QtWidgets import (
-    QApplication, QWidget, QDialog, QGridLayout, QStyle, QPlainTextEdit,
-    QLabel, QDialogButtonBox
+    QApplication, QDialog, QDialogButtonBox, QGridLayout, QLabel,
+    QPlainTextEdit, QStyle, QWidget
 )
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -42,10 +42,6 @@ if TYPE_CHECKING:  # pragma: no cover
 logger = logging.getLogger(__name__)
 
 
-# =============================================================================================== #
-#  Utility Functions
-# =============================================================================================== #
-
 def logException() -> None:
     """Log the content of an exception message."""
     exType, exValue, _ = sys.exc_info()
@@ -61,10 +57,6 @@ def formatException(exc: BaseException) -> str:
     return f"{type(exc).__name__}: {str(exc)}"
 
 
-# =============================================================================================== #
-#  Error Handler
-# =============================================================================================== #
-
 class NWErrorMessage(QDialog):
 
     def __init__(self, parent: QWidget) -> None:
@@ -125,9 +117,11 @@ class NWErrorMessage(QDialog):
         error traceback.
         """
         from traceback import format_tb
+
+        from PyQt5.QtCore import PYQT_VERSION_STR, QT_VERSION_STR, QSysInfo
+
         from novelwriter import __version__
         from novelwriter.constants import nwConst
-        from PyQt5.QtCore import QT_VERSION_STR, PYQT_VERSION_STR, QSysInfo
 
         self.msgHead.setText(
             "<p>An unhandled error has been encountered.</p>"
@@ -175,12 +169,11 @@ class NWErrorMessage(QDialog):
         self.close()
         return
 
-# END Class NWErrorMessage
-
 
 def exceptionHandler(exType: type, exValue: BaseException, exTrace: TracebackType) -> None:
     """Function to catch unhandled global exceptions."""
     from traceback import print_tb
+
     from PyQt5.QtWidgets import QApplication
 
     logger.critical("%s: %s", exType.__name__, str(exValue))

novelwriter/extensions/configlayout.py

@@ -27,8 +27,8 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-from PyQt5.QtGui import QColor, QFont, QPalette
 from PyQt5.QtCore import Qt
+from PyQt5.QtGui import QColor, QFont, QPalette
 from PyQt5.QtWidgets import (
     QAbstractButton, QFrame, QHBoxLayout, QLabel, QLayout, QScrollArea,
     QVBoxLayout, QWidget
@@ -64,8 +64,6 @@ class NFixedPage(QFrame):
         self.setLayout(layout)
         return
 
-# END Class NFixedPage
-
 
 class NScrollablePage(QScrollArea):
     """Extension: Scrollable Page Widget
@@ -89,8 +87,6 @@ class NScrollablePage(QScrollArea):
         self._widget.setLayout(layout)
         return
 
-# END Class NScrollablePage
-
 
 class NScrollableForm(QScrollArea):
     """Extension: Scrollable Form Widget
@@ -184,20 +180,30 @@ class NScrollableForm(QScrollArea):
             self._sections[identifier] = qLabel
         return
 
-    def addRow(self, label: str, widget: QWidget, helpText: str = "", unit: str | None = None,
-               button: QWidget | None = None, editable: str | None = None,
+    def addRow(self, label: str, widget: QWidget | list[QWidget], helpText: str = "",
+               unit: str | None = None, button: QWidget | None = None, editable: str | None = None,
                stretch: tuple[int, int] = (1, 0)) -> None:
         """Add a label and a widget as a new row of the form."""
         row = QHBoxLayout()
         row.setSpacing(CONFIG.pxInt(12))
 
+        if isinstance(widget, list):
+            wBox = QHBoxLayout()
+            wBox.setContentsMargins(0, 0, 0, 0)
+            for item in widget:
+                wBox.addWidget(item)
+            qWidget = QWidget(self)
+            qWidget.setLayout(wBox)
+        else:
+            qWidget = widget
+
         qLabel = QLabel(label, self)
         qLabel.setIndent(self._indent)
-        qLabel.setBuddy(widget)
+        qLabel.setBuddy(qWidget)
 
         if helpText:
             qHelp = NColourLabel(
-                str(helpText), color=self._helpCol, parent=self,
+                str(helpText), self, color=self._helpCol,
                 scale=self._fontScale, wrap=True, indent=self._indent
             )
             labelBox = QVBoxLayout()
@@ -212,19 +218,19 @@ class NScrollableForm(QScrollArea):
 
         if isinstance(unit, str):
             box = QHBoxLayout()
-            box.addWidget(widget, 1)
+            box.addWidget(qWidget, 1)
             box.addWidget(QLabel(unit, self), 0)
             row.addLayout(box, stretch[1])
         elif isinstance(button, QAbstractButton):
             box = QHBoxLayout()
-            box.addWidget(widget, 1)
+            box.addWidget(qWidget, 1)
             box.addWidget(button, 0)
             row.addLayout(box, stretch[1])
         else:
-            row.addWidget(widget, stretch[1])
+            row.addWidget(qWidget, stretch[1])
 
         self._layout.addLayout(row)
-        self._index[label.strip()] = widget
+        self._index[label.strip()] = qWidget
         self._first = False
 
         return
@@ -235,8 +241,6 @@ class NScrollableForm(QScrollArea):
         self._layout.addStretch(1)
         return
 
-# END Class NScrollableForm
-
 
 class NColourLabel(QLabel):
     """Extension: A Coloured Label
@@ -248,11 +252,20 @@ class NColourLabel(QLabel):
     HELP_SCALE = DEFAULT_SCALE
     HEADER_SCALE = 1.25
 
-    def __init__(self, text: str, color: QColor | None = None, parent: QWidget | None = None,
-                 scale: float = HELP_SCALE, wrap: bool = False, indent: int = 0,
-                 bold: bool = False) -> None:
+    _state = None
+
+    def __init__(
+        self, text: str, parent: QWidget, *,
+        color: QColor | None = None, faded: QColor | None = None,
+        scale: float = HELP_SCALE, wrap: bool = False, indent: int = 0,
+        bold: bool = False
+    ) -> None:
         super().__init__(text, parent=parent)
 
+        default = self.palette().windowText().color()
+        self._color = color or default
+        self._faded = faded or default
+
         font = self.font()
         font.setPointSizeF(scale*font.pointSizeF())
         font.setWeight(QFont.Weight.Bold if bold else QFont.Weight.Normal)
@@ -264,10 +277,33 @@ class NColourLabel(QLabel):
         self.setFont(font)
         self.setIndent(indent)
         self.setWordWrap(wrap)
+        self.setColorState(True)
 
         return
 
-# END Class NColourLabel
+    def setTextColors(self, *, color: QColor | None = None, faded: QColor | None = None) -> None:
+        """Set or update the text colours."""
+        self._color = color or self._color
+        self._faded = faded or self._faded
+        self._refeshTextColor()
+        return
+
+    def setColorState(self, state: bool) -> None:
+        """Change the colour state."""
+        if self._state is not state:
+            self._state = state
+            self._refeshTextColor()
+        return
+
+    def _refeshTextColor(self) -> None:
+        """Refresh the colour of the text on the label."""
+        palette = self.palette()
+        palette.setColor(
+            QPalette.ColorRole.WindowText,
+            self._color if self._state else self._faded,
+        )
+        self.setPalette(palette)
+        return
 
 
 class NWrappedWidgetBox(QHBoxLayout):
@@ -287,5 +323,3 @@ class NWrappedWidgetBox(QHBoxLayout):
         if after:
             self.addWidget(QLabel(after.lstrip()))
         return
-
-# END Class NWrappedWidgetBox

novelwriter/extensions/eventfilters.py

@@ -24,8 +24,8 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-from PyQt5.QtGui import QStatusTipEvent, QWheelEvent
 from PyQt5.QtCore import QEvent, QObject
+from PyQt5.QtGui import QStatusTipEvent, QWheelEvent
 from PyQt5.QtWidgets import QWidget
 
 
@@ -63,13 +63,9 @@ class WheelEventFilter(QObject):
             self._locked = False
         return False
 
-# END Class WheelEventFilter
-
 
 class StatusTipFilter(QObject):
 
     def eventFilter(self, obj: QObject, event: QEvent) -> bool:
         """Filter out status tip events on menus."""
         return True if isinstance(event, QStatusTipEvent) else super().eventFilter(obj, event)
-
-# END Class StatusTipFilter

novelwriter/extensions/modified.py

@@ -6,6 +6,8 @@ File History:
 Created: 2024-02-01 [2.3b1] NComboBox
 Created: 2024-02-01 [2.3b1] NSpinBox
 Created: 2024-02-01 [2.3b1] NDoubleSpinBox
+Created: 2024-05-01 [2.5b1] NToolDialog
+Created: 2024-05-01 [2.5b1] NNonBlockingDialog
 
 This file is a part of novelWriter
 Copyright 2018–2024, Veronica Berglyd Olsen
@@ -25,11 +27,75 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-from PyQt5.QtCore import QSize, Qt
+from enum import Enum
+from typing import TYPE_CHECKING
+
+from PyQt5.QtCore import QSize, Qt, pyqtSlot
 from PyQt5.QtGui import QWheelEvent
-from PyQt5.QtWidgets import QComboBox, QDoubleSpinBox, QSpinBox, QToolButton, QWidget
+from PyQt5.QtWidgets import (
+    QApplication, QComboBox, QDialog, QDoubleSpinBox, QSpinBox, QToolButton,
+    QWidget
+)
+
+from novelwriter import CONFIG, SHARED
+
+if TYPE_CHECKING:  # pragma: no cover
+    from novelwriter.guimain import GuiMain
+
+
+class NDialog(QDialog):
+
+    def softDelete(self) -> None:
+        """Since calling deleteLater is sometimes not safe from Python,
+        as the C++ object can be deleted before the Python process is
+        done with the object, we instead set the dialog's parent to None
+        so that it gets garbage collected when it runs out of scope.
+        """
+        self.setParent(None)  # type: ignore
+        return
+
+    @pyqtSlot()
+    def reject(self) -> None:
+        """Overload the reject slot and also call close."""
+        super().reject()
+        self.close()
+        return
+
+
+class NToolDialog(NDialog):
+
+    def __init__(self, parent: GuiMain) -> None:
+        super().__init__(parent=parent)
+        self.setModal(False)
+        if CONFIG.osDarwin:
+            self.setWindowFlag(Qt.WindowType.Tool)
+        return
 
-from novelwriter import SHARED
+    def activateDialog(self) -> None:
+        """Helper function to activate dialog on various systems."""
+        self.show()
+        if CONFIG.osWindows:
+            self.activateWindow()
+        self.raise_()
+        QApplication.processEvents()
+        return
+
+
+class NNonBlockingDialog(NDialog):
+
+    def __init__(self, parent: QWidget | None = None) -> None:
+        super().__init__(parent=parent)
+        self.setModal(True)
+        return
+
+    def activateDialog(self) -> None:
+        """Helper function to activate dialog on various systems."""
+        self.show()
+        if CONFIG.osWindows:
+            self.activateWindow()
+        self.raise_()
+        QApplication.processEvents()
+        return
 
 
 class NComboBox(QComboBox):
@@ -46,14 +112,12 @@ class NComboBox(QComboBox):
             event.ignore()
         return
 
-    def setCurrentData(self, data: str, default: str) -> None:
+    def setCurrentData(self, data: str | int | Enum, default: str | int | Enum) -> None:
         """Set the current index from data, with a fallback."""
         idx = self.findData(data)
         self.setCurrentIndex(self.findData(default) if idx < 0 else idx)
         return
 
-# END Class NComboBox
-
 
 class NSpinBox(QSpinBox):
 
@@ -69,8 +133,6 @@ class NSpinBox(QSpinBox):
             event.ignore()
         return
 
-# END Class NSpinBox
-
 
 class NDoubleSpinBox(QDoubleSpinBox):
 
@@ -86,8 +148,6 @@ class NDoubleSpinBox(QDoubleSpinBox):
             event.ignore()
         return
 
-# END Class NDoubleSpinBox
-
 
 class NIconToolButton(QToolButton):
 
@@ -105,8 +165,6 @@ class NIconToolButton(QToolButton):
         self.setIcon(SHARED.theme.getIcon(iconKey))
         return
 
-# END Class NIconToolButton
-
 
 class NIconToggleButton(QToolButton):
 
@@ -126,5 +184,3 @@ class NIconToggleButton(QToolButton):
         iconSize = self.iconSize()
         self.setIcon(SHARED.theme.getToggleIcon(iconKey, (iconSize.width(), iconSize.height())))
         return
-
-# END Class NUnfoldButton

novelwriter/extensions/novelselector.py

@@ -29,8 +29,8 @@ from PyQt5.QtCore import pyqtSignal, pyqtSlot
 from PyQt5.QtWidgets import QComboBox, QWidget
 
 from novelwriter import SHARED
-from novelwriter.enum import nwItemClass
 from novelwriter.constants import nwLabels
+from novelwriter.enum import nwItemClass
 
 logger = logging.getLogger(__name__)
 
@@ -126,5 +126,3 @@ class NovelSelector(QComboBox):
         if not self._blockSignal:
             self.novelSelectionChanged.emit(self.currentData())
         return
-
-# END Class NovelSelector