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

novelwriter/gui/docviewer.py

@@ -33,7 +33,7 @@ from enum import Enum
 from PyQt5.QtCore import QPoint, Qt, QUrl, pyqtSignal, pyqtSlot
 from PyQt5.QtGui import QCursor, QMouseEvent, QPalette, QResizeEvent, QTextCursor
 from PyQt5.QtWidgets import (
-    QAction, QApplication, QFrame, QHBoxLayout, QLabel, QMenu, QTextBrowser,
+    QAction, QApplication, QFrame, QHBoxLayout, QMenu, QTextBrowser,
     QToolButton, QWidget
 )
 
@@ -42,6 +42,7 @@ from novelwriter.constants import nwHeaders, nwUnicode
 from novelwriter.core.toqdoc import TextDocumentTheme, ToQTextDocument
 from novelwriter.enum import nwDocAction, nwDocMode, nwItemType
 from novelwriter.error import logException
+from novelwriter.extensions.configlayout import NColourLabel
 from novelwriter.extensions.eventfilters import WheelEventFilter
 from novelwriter.extensions.modified import NIconToolButton
 from novelwriter.gui.theme import STYLES_MIN_TOOLBUTTON
@@ -92,6 +93,9 @@ class GuiDocViewer(QTextBrowser):
         self.setContextMenuPolicy(Qt.ContextMenuPolicy.CustomContextMenu)
         self.customContextMenuRequested.connect(self._openContextMenu)
 
+        # Function Mapping
+        self.changeFocusState = self.docHeader.changeFocusState
+
         self.initViewer()
 
         logger.debug("Ready: GuiDocViewer")
@@ -165,6 +169,8 @@ class GuiDocViewer(QTextBrowser):
         self._docTheme.keyword   = SHARED.theme.colKey
         self._docTheme.tag       = SHARED.theme.colTag
         self._docTheme.optional  = SHARED.theme.colOpt
+        self._docTheme.dialog    = SHARED.theme.colDialN
+        self._docTheme.altdialog = SHARED.theme.colDialA
 
         # Set default text margins
         self.document().setDocumentMargin(0)
@@ -201,6 +207,7 @@ class GuiDocViewer(QTextBrowser):
         sPos = self.verticalScrollBar().value()
         qDoc = ToQTextDocument(SHARED.project)
         qDoc.setJustify(CONFIG.doJustify)
+        qDoc.setDialogueHighlight(True)
         qDoc.initDocument(CONFIG.textFont, self._docTheme)
         qDoc.setKeywords(True)
         qDoc.setComments(CONFIG.viewComments)
@@ -245,9 +252,6 @@ class GuiDocViewer(QTextBrowser):
         })
         self.updateDocMargins()
 
-        # Since we change the content while it may still be rendering, we mark
-        # the document dirty again to make sure it's re-rendered properly.
-        self.redrawText()
         QApplication.restoreOverrideCursor()
         self.documentLoaded.emit(tHandle)
 
@@ -259,12 +263,6 @@ class GuiDocViewer(QTextBrowser):
             self.loadText(self._docHandle, updateHistory=False)
         return
 
-    def redrawText(self) -> None:
-        """Redraw the text by marking the content as "dirty"."""
-        self.document().markContentsDirty(0, self.document().characterCount())
-        self.updateDocMargins()
-        return
-
     def docAction(self, action: nwDocAction) -> bool:
         """Process document actions on the current document."""
         logger.debug("Requesting action: '%s'", action.name)
@@ -284,6 +282,10 @@ class GuiDocViewer(QTextBrowser):
             return False
         return True
 
+    def anyFocus(self) -> bool:
+        """Check if any widget or child widget has focus."""
+        return self.hasFocus() or self.isAncestorOf(QApplication.focusWidget())
+
     def clearNavHistory(self) -> None:
         """Clear the navigation history."""
         self.docHistory.clear()
@@ -370,8 +372,10 @@ class GuiDocViewer(QTextBrowser):
         """Process a clicked link in the document."""
         if link := url.url():
             logger.debug("Clicked link: '%s'", link)
-            if (bits := link.partition("_")) and bits[2]:
+            if (bits := link.partition("_")) and bits[0] == "#tag" and bits[2]:
                 self.loadDocumentTagRequest.emit(bits[2], nwDocMode.VIEW)
+            else:
+                self.navigateTo(link)
         return
 
     @pyqtSlot("QPoint")
@@ -601,9 +605,7 @@ class GuiDocViewHeader(QWidget):
         self.setAutoFillBackground(True)
 
         # Title Label
-        self.itemTitle = QLabel(self)
-        self.itemTitle.setText("")
-        self.itemTitle.setIndent(0)
+        self.itemTitle = NColourLabel("", self, faded=SHARED.theme.fadedText)
         self.itemTitle.setMargin(0)
         self.itemTitle.setContentsMargins(0, 0, 0, 0)
         self.itemTitle.setAutoFillBackground(True)
@@ -742,6 +744,11 @@ class GuiDocViewHeader(QWidget):
         self.itemTitle.setPalette(palette)
         return
 
+    def changeFocusState(self, state: bool) -> None:
+        """Toggle focus state."""
+        self.itemTitle.setColorState(state)
+        return
+
     def setHandle(self, tHandle: str) -> None:
         """Sets the document title from the handle, or alternatively,
         set the whole document path.

novelwriter/gui/mainmenu.py

@@ -35,7 +35,7 @@ from PyQt5.QtWidgets import QAction, QMenuBar
 from novelwriter import CONFIG, SHARED
 from novelwriter.common import openExternalPath
 from novelwriter.constants import nwConst, nwKeyWords, nwLabels, nwUnicode, trConst
-from novelwriter.enum import nwDocAction, nwDocInsert, nwView, nwWidget
+from novelwriter.enum import nwDocAction, nwDocInsert, nwFocus, nwView
 from novelwriter.extensions.eventfilters import StatusTipFilter
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -54,7 +54,7 @@ class GuiMainMenu(QMenuBar):
     requestDocInsert = pyqtSignal(nwDocInsert)
     requestDocInsertText = pyqtSignal(str)
     requestDocKeyWordInsert = pyqtSignal(str)
-    requestFocusChange = pyqtSignal(nwWidget)
+    requestFocusChange = pyqtSignal(nwFocus)
     requestViewChange = pyqtSignal(nwView)
 
     def __init__(self, mainGui: GuiMain) -> None:
@@ -167,7 +167,7 @@ class GuiMainMenu(QMenuBar):
         # Project > Edit
         self.aEditItem = self.projMenu.addAction(self.tr("Rename Item"))
         self.aEditItem.setShortcut("F2")
-        self.aEditItem.triggered.connect(lambda: self.mainGui.editItemLabel(None))
+        self.aEditItem.triggered.connect(lambda: self.mainGui.projView.renameTreeItem(None))
 
         # Project > Delete
         self.aDeleteItem = self.projMenu.addAction(self.tr("Delete Item"))
@@ -303,24 +303,24 @@ class GuiMainMenu(QMenuBar):
         self.viewMenu = self.addMenu(self.tr("&View"))
 
         # View > TreeView
-        self.aFocusTree = self.viewMenu.addAction(self.tr("Go to Project Tree"))
+        self.aFocusTree = self.viewMenu.addAction(self.tr("Go to Tree View"))
         self.aFocusTree.setShortcut("Ctrl+T")
         self.aFocusTree.triggered.connect(
-            lambda: self.requestFocusChange.emit(nwWidget.TREE)
+            lambda: self.requestFocusChange.emit(nwFocus.TREE)
         )
 
         # View > Document Editor
-        self.aFocusEditor = self.viewMenu.addAction(self.tr("Go to Document Editor"))
-        self.aFocusEditor.setShortcut("Ctrl+E")
-        self.aFocusEditor.triggered.connect(
-            lambda: self.requestFocusChange.emit(nwWidget.EDITOR)
+        self.aFocusDocument = self.viewMenu.addAction(self.tr("Go to Document"))
+        self.aFocusDocument.setShortcut("Ctrl+E")
+        self.aFocusDocument.triggered.connect(
+            lambda: self.requestFocusChange.emit(nwFocus.DOCUMENT)
         )
 
         # View > Outline
         self.aFocusOutline = self.viewMenu.addAction(self.tr("Go to Outline"))
         self.aFocusOutline.setShortcut("Ctrl+Shift+T")
         self.aFocusOutline.triggered.connect(
-            lambda: self.requestFocusChange.emit(nwWidget.OUTLINE)
+            lambda: self.requestFocusChange.emit(nwFocus.OUTLINE)
         )
 
         # View > Separator
@@ -422,7 +422,7 @@ class GuiMainMenu(QMenuBar):
         self.aInsMSApos = self.mInsQuotes.addAction(self.tr("Alternative Apostrophe"))
         self.aInsMSApos.setShortcut("Ctrl+K, '")
         self.aInsMSApos.triggered.connect(
-            lambda: self.requestDocInsertText.emit(nwUnicode.U_MAPOSS)
+            lambda: self.requestDocInsertText.emit(nwUnicode.U_MAPOS)
         )
 
         # Insert > Symbols

novelwriter/gui/outline.py

@@ -215,7 +215,7 @@ class GuiOutlineToolBar(QToolBar):
 
         # Novel Selector
         self.novelLabel = NColourLabel(
-            self.tr("Outline of"), parent=self, scale=NColourLabel.HEADER_SCALE, bold=True
+            self.tr("Outline of"), self, scale=NColourLabel.HEADER_SCALE, bold=True
         )
         self.novelLabel.setContentsMargins(0, 0, CONFIG.pxInt(12), 0)
 
@@ -523,12 +523,12 @@ class GuiOutlineTree(QTreeWidget):
     @pyqtSlot()
     def exportOutline(self) -> None:
         """Export the outline as a CSV file."""
-        path = CONFIG.lastPath() / f"{makeFileNameSafe(SHARED.project.data.name)}.csv"
+        path = CONFIG.lastPath("outline") / f"{makeFileNameSafe(SHARED.project.data.name)}.csv"
         path, _ = QFileDialog.getSaveFileName(
             self, self.tr("Save Outline As"), str(path), formatFileFilter(["*.csv", "*"])
         )
         if path:
-            CONFIG.setLastPath(path)
+            CONFIG.setLastPath("outline", path)
             logger.info("Writing CSV file: %s", path)
             cols = [col for col in self._treeOrder if not self._colHidden[col]]
             order = [self._colIdx[col] for col in cols]

novelwriter/gui/projtree.py

@@ -34,9 +34,8 @@ from time import time
 from PyQt5.QtCore import QPoint, Qt, QTimer, pyqtSignal, pyqtSlot
 from PyQt5.QtGui import QDragEnterEvent, QDragMoveEvent, QDropEvent, QIcon, QMouseEvent, QPalette
 from PyQt5.QtWidgets import (
-    QAbstractItemView, QAction, QDialog, QFrame, QHBoxLayout, QHeaderView,
-    QLabel, QMenu, QShortcut, QTreeWidget, QTreeWidgetItem, QVBoxLayout,
-    QWidget
+    QAbstractItemView, QAction, QFrame, QHBoxLayout, QHeaderView, QLabel,
+    QMenu, QShortcut, QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG, SHARED
@@ -998,7 +997,7 @@ class GuiProjectTree(QTreeWidget):
             trItemP.takeChild(tIndex)
 
             for dHandle in reversed(self.getTreeFromHandle(tHandle)):
-                SHARED.closeDocument(dHandle)
+                SHARED.closeEditor(dHandle)
                 SHARED.project.removeItem(dHandle)
                 self._treeMap.pop(dHandle, None)
 
@@ -1397,19 +1396,15 @@ class GuiProjectTree(QTreeWidget):
         if not newFile:
             itemList.remove(tHandle)
 
-        dlgMerge = GuiDocMerge(SHARED.mainGui, tHandle, itemList)
-        dlgMerge.exec()
-
-        if dlgMerge.result() == QDialog.DialogCode.Accepted:
-
-            mrgData = dlgMerge.getData()
-            mrgList = mrgData.get("finalItems", [])
-            if not mrgList:
+        data, status = GuiDocMerge.getData(SHARED.mainGui, tHandle, itemList)
+        if status:
+            items = data.get("finalItems", [])
+            if not items:
                 SHARED.info(self.tr("No documents selected for merging."))
                 return False
 
             # Save the open document first, in case it's part of merge
-            SHARED.saveDocument()
+            SHARED.saveEditor()
 
             # Create merge object, and append docs
             docMerger = DocMerger(SHARED.project)
@@ -1424,7 +1419,7 @@ class GuiProjectTree(QTreeWidget):
             else:
                 return False
 
-            for sHandle in mrgList:
+            for sHandle in items:
                 docMerger.appendText(sHandle, True, mLabel)
 
             if not docMerger.writeTargetDoc():
@@ -1441,8 +1436,8 @@ class GuiProjectTree(QTreeWidget):
             self.projView.openDocumentRequest.emit(mHandle, nwDocMode.EDIT, "", False)
             self.projView.setSelectedHandle(mHandle, doScroll=True)
 
-            if mrgData.get("moveToTrash", False):
-                for sHandle in reversed(mrgData.get("finalItems", [])):
+            if data.get("moveToTrash", False):
+                for sHandle in reversed(data.get("finalItems", [])):
                     trItem = self._getTreeItem(sHandle)
                     if isinstance(trItem, QTreeWidgetItem) and trItem.childCount() == 0:
                         self.moveItemToTrash(sHandle, askFirst=False, flush=False)
@@ -1468,16 +1463,11 @@ class GuiProjectTree(QTreeWidget):
             logger.error("Only valid document items can be split")
             return False
 
-        dlgSplit = GuiDocSplit(SHARED.mainGui, tHandle)
-        dlgSplit.exec()
-
-        if dlgSplit.result() == QDialog.DialogCode.Accepted:
-
-            splitData, splitText = dlgSplit.getData()
-
-            headerList = splitData.get("headerList", [])
-            intoFolder = splitData.get("intoFolder", False)
-            docHierarchy = splitData.get("docHierarchy", False)
+        data, text, status = GuiDocSplit.getData(SHARED.mainGui, tHandle)
+        if status:
+            headerList = data.get("headerList", [])
+            intoFolder = data.get("intoFolder", False)
+            docHierarchy = data.get("docHierarchy", False)
 
             docSplit = DocSplitter(SHARED.project, tHandle)
             if intoFolder:
@@ -1487,7 +1477,7 @@ class GuiProjectTree(QTreeWidget):
             else:
                 docSplit.setParentItem(tItem.itemParent)
 
-            docSplit.splitDocument(headerList, splitText)
+            docSplit.splitDocument(headerList, text)
             for writeOk, dHandle, nHandle in docSplit.writeDocuments(docHierarchy):
                 SHARED.project.index.reIndexHandle(dHandle)
                 self.revealNewTreeItem(dHandle, nHandle=nHandle, wordCount=True)
@@ -1498,7 +1488,7 @@ class GuiProjectTree(QTreeWidget):
                         info=docSplit.getError()
                     )
 
-            if splitData.get("moveToTrash", False):
+            if data.get("moveToTrash", False):
                 self.moveItemToTrash(tHandle, askFirst=False, flush=True)
 
             self.saveTreeOrder()
@@ -1815,6 +1805,7 @@ class _TreeContextMenu(QMenu):
 
     def _itemHeader(self) -> None:
         """Check if there is a header that can be used for rename."""
+        SHARED.saveEditor()
         if hItem := SHARED.project.index.getItemHeading(self._handle, "T0001"):
             action = self.addAction(self.tr("Rename to Heading"))
             action.triggered.connect(

novelwriter/gui/search.py

@@ -208,6 +208,12 @@ class GuiProjectSearch(QWidget):
         self.searchResult.clear()
         return
 
+    def refreshCurrentSearch(self) -> None:
+        """Refresh the search if there is one."""
+        if self.searchResult.topLevelItemCount() > 0:
+            self._processSearch()
+        return
+
     ##
     #  Events
     ##
@@ -259,7 +265,7 @@ class GuiProjectSearch(QWidget):
         if not self._blocked:
             QApplication.setOverrideCursor(QCursor(Qt.CursorShape.WaitCursor))
             start = time()
-            SHARED.saveDocument()
+            SHARED.saveEditor()
             self._blocked = True
             self._map = {}
             self.searchResult.clear()
@@ -298,18 +304,21 @@ class GuiProjectSearch(QWidget):
     def _toggleCase(self, state: bool) -> None:
         """Enable/disable case sensitive mode."""
         CONFIG.searchProjCase = state
+        self.refreshCurrentSearch()
         return
 
     @pyqtSlot(bool)
     def _toggleWord(self, state: bool) -> None:
         """Enable/disable whole word search mode."""
         CONFIG.searchProjWord = state
+        self.refreshCurrentSearch()
         return
 
     @pyqtSlot(bool)
     def _toggleRegEx(self, state: bool) -> None:
         """Enable/disable regular expression search mode."""
         CONFIG.searchProjRegEx = state
+        self.refreshCurrentSearch()
         return
 
     ##

novelwriter/gui/statusbar.py

@@ -27,7 +27,6 @@ import logging
 
 from datetime import datetime
 from time import time
-from typing import Literal
 
 from PyQt5.QtCore import QLocale, pyqtSlot
 from PyQt5.QtWidgets import QApplication, QLabel, QStatusBar, QWidget
@@ -35,6 +34,7 @@ from PyQt5.QtWidgets import QApplication, QLabel, QStatusBar, QWidget
 from novelwriter import CONFIG, SHARED
 from novelwriter.common import formatTime
 from novelwriter.constants import nwConst
+from novelwriter.enum import nwTrinary
 from novelwriter.extensions.statusled import StatusLED
 
 logger = logging.getLogger(__name__)
@@ -51,10 +51,6 @@ class GuiMainStatus(QStatusBar):
         self._userIdle = False
         self._debugInfo = False
 
-        colNone = SHARED.theme.statNone
-        colSaved = SHARED.theme.statSaved
-        colUnsaved = SHARED.theme.statUnsaved
-
         iPx = SHARED.theme.baseIconHeight
 
         # Permanent Widgets
@@ -71,7 +67,7 @@ class GuiMainStatus(QStatusBar):
         self.addPermanentWidget(self.langText)
 
         # The Editor Status
-        self.docIcon = StatusLED(colNone, colSaved, colUnsaved, iPx, iPx, self)
+        self.docIcon = StatusLED(iPx, iPx, self)
         self.docText = QLabel(self.tr("Editor"), self)
         self.docIcon.setContentsMargins(0, 0, 0, 0)
         self.docText.setContentsMargins(0, 0, xM, 0)
@@ -79,7 +75,7 @@ class GuiMainStatus(QStatusBar):
         self.addPermanentWidget(self.docText)
 
         # The Project Status
-        self.projIcon = StatusLED(colNone, colSaved, colUnsaved, iPx, iPx, self)
+        self.projIcon = StatusLED(iPx, iPx, self)
         self.projText = QLabel(self.tr("Project"), self)
         self.projIcon.setContentsMargins(0, 0, 0, 0)
         self.projText.setContentsMargins(0, 0, xM, 0)
@@ -120,8 +116,8 @@ class GuiMainStatus(QStatusBar):
         self.setRefTime(-1.0)
         self.setLanguage(*SHARED.spelling.describeDict())
         self.setProjectStats(0, 0)
-        self.setProjectStatus(StatusLED.S_NONE)
-        self.setDocumentStatus(StatusLED.S_NONE)
+        self.setProjectStatus(nwTrinary.NEUTRAL)
+        self.setDocumentStatus(nwTrinary.NEUTRAL)
         self.updateTime()
         return
 
@@ -133,6 +129,13 @@ class GuiMainStatus(QStatusBar):
         self.timePixmap = SHARED.theme.getPixmap("status_time", (iPx, iPx))
         self.idlePixmap = SHARED.theme.getPixmap("status_idle", (iPx, iPx))
         self.timeIcon.setPixmap(self.timePixmap)
+
+        colNone = SHARED.theme.statNone
+        colSaved = SHARED.theme.statSaved
+        colUnsaved = SHARED.theme.statUnsaved
+        self.docIcon.setColors(colNone, colSaved, colUnsaved)
+        self.projIcon.setColors(colNone, colSaved, colUnsaved)
+
         return
 
     ##
@@ -144,12 +147,12 @@ class GuiMainStatus(QStatusBar):
         self._refTime = refTime
         return
 
-    def setProjectStatus(self, state: Literal[0, 1, 2]) -> None:
+    def setProjectStatus(self, state: nwTrinary) -> None:
         """Set the project status colour icon."""
         self.projIcon.setState(state)
         return
 
-    def setDocumentStatus(self, state: Literal[0, 1, 2]) -> None:
+    def setDocumentStatus(self, state: nwTrinary) -> None:
         """Set the document status colour icon."""
         self.docIcon.setState(state)
         return
@@ -212,13 +215,13 @@ class GuiMainStatus(QStatusBar):
     @pyqtSlot(bool)
     def updateProjectStatus(self, status: bool) -> None:
         """Update the project status."""
-        self.setProjectStatus(StatusLED.S_BAD if status else StatusLED.S_GOOD)
+        self.setProjectStatus(nwTrinary.NEGATIVE if status else nwTrinary.POSITIVE)
         return
 
     @pyqtSlot(bool)
     def updateDocumentStatus(self, status: bool) -> None:
         """Update the document status."""
-        self.setDocumentStatus(StatusLED.S_BAD if status else StatusLED.S_GOOD)
+        self.setDocumentStatus(nwTrinary.NEGATIVE if status else nwTrinary.POSITIVE)
         return
 
     ##
@@ -236,9 +239,7 @@ class GuiMainStatus(QStatusBar):
         """
         import tracemalloc
 
-        from collections import Counter
-
-        widgets = QApplication.allWidgets()
+        count = len(QApplication.allWidgets())
         if not self._debugInfo:
             if tracemalloc.is_tracing():
                 self._traceMallocRef = "Total"
@@ -246,19 +247,14 @@ class GuiMainStatus(QStatusBar):
                 self._traceMallocRef = "Relative"
                 tracemalloc.start()
             self._debugInfo = True
-            self._wCounts = Counter([type(x).__name__ for x in widgets])
-
-        if hasattr(self, "_wCounts"):
-            diff = Counter([type(x).__name__ for x in widgets]) - self._wCounts
-            for name, count in diff.items():
-                logger.debug("Widget '%s': +%d", name, count)
 
-        mem = tracemalloc.get_traced_memory()
+        current, peak = tracemalloc.get_traced_memory()
         stamp = datetime.now().strftime("%H:%M:%S")
-        self.showMessage((
-            f"Debug [{stamp}]"
-            f" \u2013 Widgets: {len(widgets)}"
-            f" \u2013 {self._traceMallocRef} Memory: {mem[0]:n}"
-            f" \u2013 Peak: {mem[1]:n}"
-        ), 6000)
+        message = (
+            f"Widgets: {count} \u2013 "
+            f"{self._traceMallocRef} Memory: {current/1024:,.2f} kiB \u2013 "
+            f"Peak: {peak/1024:,.2f} kiB"
+        )
+        self.showMessage(f"Debug [{stamp}] {message}", 6000)
+        logger.debug("[MEMINFO] %s", message)
         return

novelwriter/gui/theme.py

@@ -75,6 +75,7 @@ class GuiTheme:
         self.statUnsaved = QColor(0, 0, 0)
         self.statSaved   = QColor(0, 0, 0)
         self.helpText    = QColor(0, 0, 0)
+        self.fadedText   = QColor(0, 0, 0)
         self.errorText   = QColor(255, 0, 0)
 
         # Loaded Syntax Settings
@@ -263,6 +264,7 @@ class GuiTheme:
         sec = "GUI"
         if parser.has_section(sec):
             self.helpText    = self._parseColour(parser, sec, "helptext")
+            self.fadedText   = self._parseColour(parser, sec, "fadedtext")
             self.errorText   = self._parseColour(parser, sec, "errortext")
             self.statNone    = self._parseColour(parser, sec, "statusnone")
             self.statUnsaved = self._parseColour(parser, sec, "statusunsaved")
@@ -405,6 +407,7 @@ class GuiTheme:
         self.statUnsaved = QColor(200, 15, 39)
         self.statSaved   = QColor(2, 133, 37)
         self.helpText    = QColor(0, 0, 0)
+        self.fadedText   = QColor(128, 128, 128)
         self.errorText   = QColor(255, 0, 0)
         return