novelWriter 2.4b1__py3-none-any.whl → 2.4rc1__py3-none-any.whl

novelwriter/tools/manuscript.py

@@ -26,19 +26,19 @@ from __future__ import annotations
 import json
 import logging
 
+from datetime import datetime
 from time import time
 from typing import TYPE_CHECKING
-from datetime import datetime
 
+from PyQt5.QtCore import QTimer, QUrl, Qt, pyqtSignal, pyqtSlot
 from PyQt5.QtGui import QCloseEvent, QColor, QCursor, QFont, QPalette, QResizeEvent
-from PyQt5.QtCore import QSize, QTimer, QUrl, Qt, pyqtSignal, pyqtSlot
+from PyQt5.QtPrintSupport import QPrintPreviewDialog, QPrinter
 from PyQt5.QtWidgets import (
-    QAbstractItemView, QDialog, QFormLayout, QGridLayout, QHBoxLayout, QLabel,
-    QListWidget, QListWidgetItem, QPushButton, QSizePolicy, QSplitter,
-    QStackedWidget, QTabWidget, QTextBrowser, QTreeWidget, QTreeWidgetItem,
-    QVBoxLayout, QWidget, qApp
+    QAbstractItemView, QApplication, QDialog, QFormLayout, QGridLayout,
+    QHBoxLayout, QLabel, QListWidget, QListWidgetItem, QPushButton,
+    QSizePolicy, QSplitter, QStackedWidget, QTabWidget, QTextBrowser,
+    QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget
 )
-from PyQt5.QtPrintSupport import QPrintPreviewDialog, QPrinter
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.common import checkInt, fuzzyTime
@@ -48,10 +48,14 @@ from novelwriter.core.tohtml import ToHtml
 from novelwriter.core.tokenizer import HeadingFormatter
 from novelwriter.error import logException
 from novelwriter.extensions.circularprogress import NProgressCircle
-from novelwriter.extensions.modified import NIconToolButton
+from novelwriter.extensions.modified import NIconToggleButton, NIconToolButton
 from novelwriter.gui.theme import STYLES_FLAT_TABS, STYLES_MIN_TOOLBUTTON
 from novelwriter.tools.manusbuild import GuiManuscriptBuild
 from novelwriter.tools.manussettings import GuiBuildSettings
+from novelwriter.types import (
+    QtAlignAbsolute, QtAlignCenter, QtAlignJustify, QtAlignRight, QtAlignTop,
+    QtUserRole
+)
 
 if TYPE_CHECKING:  # pragma: no cover
     from novelwriter.guimain import GuiMain
@@ -67,7 +71,7 @@ class GuiManuscript(QDialog):
     a document directly to disk.
     """
 
-    D_KEY = Qt.ItemDataRole.UserRole
+    D_KEY = QtUserRole
 
     def __init__(self, mainGui: GuiMain) -> None:
         super().__init__(parent=mainGui)
@@ -86,7 +90,7 @@ class GuiManuscript(QDialog):
         self.setMinimumWidth(CONFIG.pxInt(600))
         self.setMinimumHeight(CONFIG.pxInt(500))
 
-        iPx = SHARED.theme.baseIconSize
+        iSz = SHARED.theme.baseIconSize
         wWin = CONFIG.pxInt(900)
         hWin = CONFIG.pxInt(600)
 
@@ -100,30 +104,27 @@ class GuiManuscript(QDialog):
         # ==============
 
         qPalette = self.palette()
-        qPalette.setBrush(QPalette.Window, qPalette.base())
+        qPalette.setBrush(QPalette.ColorRole.Window, qPalette.base())
         self.setPalette(qPalette)
 
         buttonStyle = SHARED.theme.getStyleSheet(STYLES_MIN_TOOLBUTTON)
 
-        self.tbAdd = NIconToolButton(self, iPx)
-        self.tbAdd.setIcon(SHARED.theme.getIcon("add"))
+        self.tbAdd = NIconToolButton(self, iSz, "add")
         self.tbAdd.setToolTip(self.tr("Add New Build"))
         self.tbAdd.setStyleSheet(buttonStyle)
         self.tbAdd.clicked.connect(self._createNewBuild)
 
-        self.tbDel = NIconToolButton(self, iPx)
-        self.tbDel.setIcon(SHARED.theme.getIcon("remove"))
+        self.tbDel = NIconToolButton(self, iSz, "remove")
         self.tbDel.setToolTip(self.tr("Delete Selected Build"))
         self.tbDel.setStyleSheet(buttonStyle)
         self.tbDel.clicked.connect(self._deleteSelectedBuild)
 
-        self.tbEdit = NIconToolButton(self, iPx)
-        self.tbEdit.setIcon(SHARED.theme.getIcon("edit"))
+        self.tbEdit = NIconToolButton(self, iSz, "edit")
         self.tbEdit.setToolTip(self.tr("Edit Selected Build"))
         self.tbEdit.setStyleSheet(buttonStyle)
         self.tbEdit.clicked.connect(self._editSelectedBuild)
 
-        self.lblBuilds = QLabel("<b>{0}</b>".format(self.tr("Builds")))
+        self.lblBuilds = QLabel("<b>{0}</b>".format(self.tr("Builds")), self)
 
         self.listToolBox = QHBoxLayout()
         self.listToolBox.addWidget(self.lblBuilds)
@@ -137,11 +138,11 @@ class GuiManuscript(QDialog):
         # ======
 
         self.buildList = QListWidget(self)
-        self.buildList.setIconSize(QSize(iPx, iPx))
+        self.buildList.setIconSize(iSz)
         self.buildList.doubleClicked.connect(self._editSelectedBuild)
         self.buildList.currentItemChanged.connect(self._updateBuildDetails)
-        self.buildList.setSelectionMode(QAbstractItemView.SingleSelection)
-        self.buildList.setDragDropMode(QAbstractItemView.InternalMove)
+        self.buildList.setSelectionMode(QAbstractItemView.SelectionMode.SingleSelection)
+        self.buildList.setDragDropMode(QAbstractItemView.DragDropMode.InternalMove)
 
         # Details Tabs
         # ============
@@ -169,16 +170,16 @@ class GuiManuscript(QDialog):
         # Process Controls
         # ================
 
-        self.btnPreview = QPushButton(self.tr("Preview"))
+        self.btnPreview = QPushButton(self.tr("Preview"), self)
         self.btnPreview.clicked.connect(self._generatePreview)
 
-        self.btnPrint = QPushButton(self.tr("Print"))
+        self.btnPrint = QPushButton(self.tr("Print"), self)
         self.btnPrint.clicked.connect(self._printDocument)
 
-        self.btnBuild = QPushButton(self.tr("Build"))
+        self.btnBuild = QPushButton(self.tr("Build"), self)
         self.btnBuild.clicked.connect(self._buildManuscript)
 
-        self.btnClose = QPushButton(self.tr("Close"))
+        self.btnClose = QPushButton(self.tr("Close"), self)
         self.btnClose.clicked.connect(self.close)
 
         self.processBox = QGridLayout()
@@ -210,7 +211,7 @@ class GuiManuscript(QDialog):
         self.optsWidget = QWidget(self)
         self.optsWidget.setLayout(self.controlBox)
 
-        self.mainSplit = QSplitter()
+        self.mainSplit = QSplitter(self)
         self.mainSplit.addWidget(self.optsWidget)
         self.mainSplit.addWidget(self.docWdiget)
         self.mainSplit.setCollapsible(0, False)
@@ -352,7 +353,7 @@ class GuiManuscript(QDialog):
         self.docPreview.beginNewBuild(len(docBuild))
         for step, _ in docBuild.iterBuildHTML(None):
             self.docPreview.buildStep(step + 1)
-            qApp.processEvents()
+            QApplication.processEvents()
 
         buildObj = docBuild.lastBuild
         assert isinstance(buildObj, ToHtml)
@@ -385,7 +386,7 @@ class GuiManuscript(QDialog):
         build = self._getSelectedBuild()
         if isinstance(build, BuildSettings):
             dlgBuild = GuiManuscriptBuild(self, build)
-            dlgBuild.exec_()
+            dlgBuild.exec()
 
             # After the build is done, save build settings changes
             if build.changed:
@@ -398,7 +399,7 @@ class GuiManuscript(QDialog):
         """Open the print preview dialog."""
         preview = QPrintPreviewDialog(self)
         preview.paintRequested.connect(self.docPreview.printPreview)
-        preview.exec_()
+        preview.exec()
         return
 
     ##
@@ -486,7 +487,7 @@ class GuiManuscript(QDialog):
         dlgSettings.setModal(False)
         dlgSettings.show()
         dlgSettings.raise_()
-        qApp.processEvents()
+        QApplication.processEvents()
         dlgSettings.loadContent()
         dlgSettings.newSettingsReady.connect(self._processNewSettings)
 
@@ -526,7 +527,7 @@ class _DetailsWidget(QWidget):
         # Tree Widget
         self.listView = QTreeWidget(self)
         self.listView.setHeaderLabels([self.tr("Setting"), self.tr("Value")])
-        self.listView.setIndentation(SHARED.theme.baseIconSize)
+        self.listView.setIndentation(SHARED.theme.baseIconHeight)
         self.listView.setSelectionMode(QAbstractItemView.SelectionMode.NoSelection)
 
         # Assemble
@@ -661,7 +662,7 @@ class _DetailsWidget(QWidget):
 
 class _OutlineWidget(QWidget):
 
-    D_LINE = Qt.ItemDataRole.UserRole
+    D_LINE = QtUserRole
 
     outlineEntryClicked = pyqtSignal(str)
 
@@ -721,7 +722,9 @@ class _OutlineWidget(QWidget):
                         parent.addChild(item)
                         indent = True
 
-            self.listView.setIndentation(SHARED.theme.baseIconSize if indent else CONFIG.pxInt(4))
+            self.listView.setIndentation(
+                SHARED.theme.baseIconHeight if indent else CONFIG.pxInt(4)
+            )
             self._outline = data
 
         return
@@ -748,8 +751,8 @@ class _PreviewWidget(QTextBrowser):
 
         # Document Setup
         dPalette = self.palette()
-        dPalette.setColor(QPalette.Base, QColor(255, 255, 255))
-        dPalette.setColor(QPalette.Text, QColor(0, 0, 0))
+        dPalette.setColor(QPalette.ColorRole.Base, QColor(255, 255, 255))
+        dPalette.setColor(QPalette.ColorRole.Text, QColor(0, 0, 0))
         self.setPalette(dPalette)
 
         self.setMinimumWidth(40*SHARED.theme.textNWidth)
@@ -766,8 +769,8 @@ class _PreviewWidget(QTextBrowser):
 
         # Document Age
         aPalette = self.palette()
-        aPalette.setColor(QPalette.Background, aPalette.toolTipBase().color())
-        aPalette.setColor(QPalette.Foreground, aPalette.toolTipText().color())
+        aPalette.setColor(QPalette.ColorRole.Window, aPalette.toolTipBase().color())
+        aPalette.setColor(QPalette.ColorRole.WindowText, aPalette.toolTipText().color())
 
         aFont = self.font()
         aFont.setPointSizeF(0.9*SHARED.theme.fontPointSize)
@@ -777,7 +780,7 @@ class _PreviewWidget(QTextBrowser):
         self.ageLabel.setFont(aFont)
         self.ageLabel.setPalette(aPalette)
         self.ageLabel.setAutoFillBackground(True)
-        self.ageLabel.setAlignment(Qt.AlignmentFlag.AlignCenter)
+        self.ageLabel.setAlignment(QtAlignCenter)
         self.ageLabel.setFixedHeight(int(2.1*SHARED.theme.fontPixelSize))
 
         # Progress
@@ -816,9 +819,9 @@ class _PreviewWidget(QTextBrowser):
         """Enable/disable the justify text option."""
         pOptions = self.document().defaultTextOption()
         if state:
-            pOptions.setAlignment(Qt.AlignmentFlag.AlignJustify)
+            pOptions.setAlignment(QtAlignJustify)
         else:
-            pOptions.setAlignment(Qt.AlignmentFlag.AlignAbsolute)
+            pOptions.setAlignment(QtAlignAbsolute)
         self.document().setDefaultTextOption(pOptions)
         return
 
@@ -848,16 +851,16 @@ class _PreviewWidget(QTextBrowser):
     def buildStep(self, value: int) -> None:
         """Update the progress bar value."""
         self.buildProgress.setValue(value)
-        qApp.processEvents()
+        QApplication.processEvents()
         return
 
     def setContent(self, data: dict) -> None:
         """Set the content of the preview widget."""
         sPos = self.verticalScrollBar().value()
-        qApp.setOverrideCursor(QCursor(Qt.CursorShape.WaitCursor))
+        QApplication.setOverrideCursor(QCursor(Qt.CursorShape.WaitCursor))
 
         self.buildProgress.setCentreText(self.tr("Processing ..."))
-        qApp.processEvents()
+        QApplication.processEvents()
 
         styles = "\n".join(data.get("styles", []))
         self.document().setDefaultStyleSheet(styles)
@@ -865,7 +868,7 @@ class _PreviewWidget(QTextBrowser):
         html = "".join(data.get("html", []))
         html = html.replace("\t", "!!tab!!")
         self.setHtml(html)
-        qApp.processEvents()
+        QApplication.processEvents()
         while self.find("!!tab!!"):
             cursor = self.textCursor()
             cursor.insertText("\t")
@@ -879,8 +882,8 @@ class _PreviewWidget(QTextBrowser):
         self.document().markContentsDirty(0, self.document().characterCount())
 
         self.buildProgress.setCentreText(self.tr("Done"))
-        qApp.restoreOverrideCursor()
-        qApp.processEvents()
+        QApplication.restoreOverrideCursor()
+        QApplication.processEvents()
         QTimer.singleShot(300, self._hideProgress)
 
         return
@@ -902,10 +905,10 @@ class _PreviewWidget(QTextBrowser):
     @pyqtSlot("QPrinter*")
     def printPreview(self, printer: QPrinter) -> None:
         """Connect the print preview painter to the document viewer."""
-        qApp.setOverrideCursor(QCursor(Qt.WaitCursor))
-        printer.setOrientation(QPrinter.Portrait)
+        QApplication.setOverrideCursor(QCursor(Qt.CursorShape.WaitCursor))
+        printer.setOrientation(QPrinter.Orientation.Portrait)
         self.document().print(printer)
-        qApp.restoreOverrideCursor()
+        QApplication.restoreOverrideCursor()
         return
 
     @pyqtSlot(str)
@@ -976,13 +979,7 @@ class _StatsWidget(QWidget):
         self.minWidget = QWidget(self)
         self.maxWidget = QWidget(self)
 
-        iPx = int(0.6*SHARED.theme.baseIconSize)
-        toggleIcon = SHARED.theme.getToggleIcon("unfold", (iPx, iPx))
-
-        self.toggleButton = NIconToolButton(self, iPx)
-        self.toggleButton.setCheckable(True)
-        self.toggleButton.setIcon(toggleIcon)
-        self.toggleButton.setStyleSheet(SHARED.theme.getStyleSheet(STYLES_MIN_TOOLBUTTON))
+        self.toggleButton = NIconToggleButton(self, SHARED.theme.baseIconSize, "unfold")
         self.toggleButton.toggled.connect(self._toggleView)
 
         self._buildMinimal()
@@ -993,8 +990,8 @@ class _StatsWidget(QWidget):
         self.mainStack.addWidget(self.maxWidget)
 
         self.outerBox = QHBoxLayout()
-        self.outerBox.addWidget(self.toggleButton, 0, Qt.AlignmentFlag.AlignTop)
-        self.outerBox.addWidget(self.mainStack, 1, Qt.AlignmentFlag.AlignTop)
+        self.outerBox.addWidget(self.toggleButton, 0, QtAlignTop)
+        self.outerBox.addWidget(self.mainStack, 1, QtAlignTop)
         self.outerBox.setContentsMargins(0, 0, 0, 0)
 
         self.setLayout(self.outerBox)
@@ -1057,10 +1054,10 @@ class _StatsWidget(QWidget):
         """Build the minimal stats page."""
         mPx = CONFIG.pxInt(8)
 
-        self.lblWordCount = QLabel(self.tr("Words"))
+        self.lblWordCount = QLabel(self.tr("Words"), self)
         self.minWordCount = QLabel(self)
 
-        self.lblCharCount = QLabel(self.tr("Characters"))
+        self.lblCharCount = QLabel(self.tr("Characters"), self)
         self.minCharCount = QLabel(self)
 
         # Assemble
@@ -1083,8 +1080,6 @@ class _StatsWidget(QWidget):
         hPx = CONFIG.pxInt(12)
         vPx = CONFIG.pxInt(4)
 
-        alignRight = Qt.AlignmentFlag.AlignRight
-
         # Left Column
         self.maxTotalWords = QLabel(self)
         self.maxHeaderWords = QLabel(self)
@@ -1092,11 +1087,11 @@ class _StatsWidget(QWidget):
         self.maxTitleCount = QLabel(self)
         self.maxParCount = QLabel(self)
 
-        self.maxTotalWords.setAlignment(alignRight)
-        self.maxHeaderWords.setAlignment(alignRight)
-        self.maxTextWords.setAlignment(alignRight)
-        self.maxTitleCount.setAlignment(alignRight)
-        self.maxParCount.setAlignment(alignRight)
+        self.maxTotalWords.setAlignment(QtAlignRight)
+        self.maxHeaderWords.setAlignment(QtAlignRight)
+        self.maxTextWords.setAlignment(QtAlignRight)
+        self.maxTitleCount.setAlignment(QtAlignRight)
+        self.maxParCount.setAlignment(QtAlignRight)
 
         self.leftForm = QFormLayout()
         self.leftForm.addRow(self.tr("Words"), self.maxTotalWords)
@@ -1117,13 +1112,13 @@ class _StatsWidget(QWidget):
         self.maxHeaderWordChars = QLabel(self)
         self.maxTextWordChars = QLabel(self)
 
-        self.maxTotalChars.setAlignment(alignRight)
-        self.maxHeaderChars.setAlignment(alignRight)
-        self.maxTextChars.setAlignment(alignRight)
+        self.maxTotalChars.setAlignment(QtAlignRight)
+        self.maxHeaderChars.setAlignment(QtAlignRight)
+        self.maxTextChars.setAlignment(QtAlignRight)
 
-        self.maxTotalWordChars.setAlignment(alignRight)
-        self.maxHeaderWordChars.setAlignment(alignRight)
-        self.maxTextWordChars.setAlignment(alignRight)
+        self.maxTotalWordChars.setAlignment(QtAlignRight)
+        self.maxHeaderWordChars.setAlignment(QtAlignRight)
+        self.maxTextWordChars.setAlignment(QtAlignRight)
 
         self.rightForm = QFormLayout()
         self.rightForm.addRow(self.tr("Characters"), self.maxTotalChars)