novelWriter 2.7.5__py3-none-any.whl → 2.8b1__py3-none-any.whl

novelwriter/gui/docviewerpanel.py

@@ -20,7 +20,7 @@ General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <https://www.gnu.org/licenses/>.
-"""
+"""  # noqa
 from __future__ import annotations
 
 import logging
@@ -49,6 +49,10 @@ logger = logging.getLogger(__name__)
 
 
 class GuiDocViewerPanel(QWidget):
+    """GUI: Document Viewer Panel.
+
+    The panel of project meta data below the viewer.
+    """
 
     openDocumentRequest = pyqtSignal(str, Enum, str, bool)
     loadDocumentTagRequest = pyqtSignal(str, Enum)
@@ -96,15 +100,15 @@ class GuiDocViewerPanel(QWidget):
 
         logger.debug("Ready: GuiDocViewerPanel")
 
-        return
-
     ##
     #  Methods
     ##
 
     def updateTheme(self, updateTabs: bool = True) -> None:
         """Update theme elements."""
-        self.optsButton.setThemeIcon("more_vertical")
+        logger.debug("Theme Update: GuiDocViewerPanel")
+
+        self.optsButton.setThemeIcon("more_vertical", "default")
         self.optsButton.setStyleSheet(SHARED.theme.getStyleSheet(STYLES_MIN_TOOLBUTTON))
         self.mainTabs.setStyleSheet(SHARED.theme.getStyleSheet(STYLES_FLAT_TABS))
         if updateTabs:
@@ -113,7 +117,6 @@ class GuiDocViewerPanel(QWidget):
             for tab in self.kwTabs.values():
                 tab.updateTheme()
             self._loadAllTags()
-        return
 
     def openProjectTasks(self) -> None:
         """Run open project tasks."""
@@ -124,7 +127,6 @@ class GuiDocViewerPanel(QWidget):
             for key, value in colWidths.items():
                 if key in self.kwTabs and isinstance(value, list):
                     self.kwTabs[key].setColumnWidths(value)
-        return
 
     def closeProjectTasks(self) -> None:
         """Run close project tasks."""
@@ -133,7 +135,6 @@ class GuiDocViewerPanel(QWidget):
         hideInactive = self.aInactive.isChecked()
         SHARED.project.options.setValue("GuiDocViewerPanel", "colWidths", colWidths)
         SHARED.project.options.setValue("GuiDocViewerPanel", "hideInactive", hideInactive)
-        return
 
     ##
     #  Public Slots
@@ -145,7 +146,6 @@ class GuiDocViewerPanel(QWidget):
         self.tabBackRefs.clearContent()
         for cTab in self.kwTabs.values():
             cTab.clearContent()
-        return
 
     @pyqtSlot()
     def indexHasAppeared(self) -> None:
@@ -153,7 +153,6 @@ class GuiDocViewerPanel(QWidget):
         self._loadAllTags()
         self._updateTabVisibility()
         self.updateHandle(self._lastHandle)
-        return
 
     @pyqtSlot(str, Enum)
     def onProjectItemChanged(self, tHandle: str, change: nwChange) -> None:
@@ -168,14 +167,12 @@ class GuiDocViewerPanel(QWidget):
                 else:
                     self.kwTabs[tClass].removeEntry(key)
         self._updateTabVisibility()
-        return
 
     @pyqtSlot(str)
     def updateHandle(self, tHandle: str | None) -> None:
         """Update the document handle."""
         self._lastHandle = tHandle
         self.tabBackRefs.refreshContent(tHandle or None)
-        return
 
     @pyqtSlot(list, list)
     def updateChangedTags(self, updated: list[str], deleted: list[str]) -> None:
@@ -191,14 +188,12 @@ class GuiDocViewerPanel(QWidget):
             else:
                 logger.warning("Could not remove tag '%s' from view panel", key)
         self._updateTabVisibility()
-        return
 
     @pyqtSlot(str)
     def updateStatusLabels(self, kind: str) -> None:
         """Update the importance labels."""
         if kind == "i":
             self._loadAllTags()
-        return
 
     ##
     #  Private Slots
@@ -212,7 +207,6 @@ class GuiDocViewerPanel(QWidget):
             cTab.clearContent()
         self._loadAllTags()
         self._updateTabVisibility()
-        return
 
     ##
     #  Internal Functions
@@ -222,7 +216,6 @@ class GuiDocViewerPanel(QWidget):
         """Hide class tabs with no content."""
         for tClass, cTab in self.kwTabs.items():
             self.mainTabs.setTabVisible(self.idTabs[tClass], cTab.countEntries() > 0)
-        return
 
     def _loadAllTags(self) -> None:
         """Load all tags into the tabs."""
@@ -230,7 +223,6 @@ class GuiDocViewerPanel(QWidget):
         for key, name, tClass, iItem, hItem in data:
             if tClass in self.kwTabs and iItem and hItem:
                 self.kwTabs[tClass].addUpdateEntry(key, name, iItem, hItem)
-        return
 
 
 class _ViewPanelBackRefs(QTreeWidget):
@@ -271,30 +263,28 @@ class _ViewPanelBackRefs(QTreeWidget):
             header.setSectionsMovable(False)
 
         # Cache Icons Locally
-        self._editIcon = SHARED.theme.getIcon("edit", "green")
-        self._viewIcon = SHARED.theme.getIcon("view", "blue")
+        self._editIcon = SHARED.theme.getIcon("edit", "change")
+        self._viewIcon = SHARED.theme.getIcon("view", "action")
 
         # Signals
         self.clicked.connect(self._treeItemClicked)
         self.doubleClicked.connect(self._treeItemDoubleClicked)
 
-        return
-
     def updateTheme(self) -> None:
         """Update theme elements."""
-        self._editIcon = SHARED.theme.getIcon("edit", "green")
-        self._viewIcon = SHARED.theme.getIcon("view", "blue")
+        logger.debug("Theme Update: _ViewPanelBackRefs")
+
+        self._editIcon = SHARED.theme.getIcon("edit", "change")
+        self._viewIcon = SHARED.theme.getIcon("view", "action")
         for i in range(self.topLevelItemCount()):
             if item := self.topLevelItem(i):
                 item.setIcon(self.C_EDIT, self._editIcon)
                 item.setIcon(self.C_VIEW, self._viewIcon)
-        return
 
     def clearContent(self) -> None:
         """Clear the widget."""
         self.clear()
         self._treeMap = {}
-        return
 
     def refreshContent(self, dHandle: str | None) -> None:
         """Update the content."""
@@ -303,7 +293,6 @@ class _ViewPanelBackRefs(QTreeWidget):
             refs = SHARED.project.index.getBackReferenceList(dHandle)
             for tHandle, (sTitle, hItem) in refs.items():
                 self._setTreeItemValues(tHandle, sTitle, hItem)
-        return
 
     def refreshDocument(self, tHandle: str) -> None:
         """Refresh document meta data."""
@@ -311,7 +300,6 @@ class _ViewPanelBackRefs(QTreeWidget):
             for sTitle, hItem in iItem.items():
                 if f"{tHandle}:{sTitle}" in self._treeMap:
                     self._setTreeItemValues(tHandle, sTitle, hItem)
-        return
 
     ##
     #  Private Slots
@@ -325,7 +313,6 @@ class _ViewPanelBackRefs(QTreeWidget):
             self._parent.openDocumentRequest.emit(tHandle, nwDocMode.EDIT, "", True)
         elif index.column() == self.C_VIEW:
             self._parent.openDocumentRequest.emit(tHandle, nwDocMode.VIEW, "", True)
-        return
 
     @pyqtSlot("QModelIndex")
     def _treeItemDoubleClicked(self, index: QModelIndex) -> None:
@@ -333,7 +320,6 @@ class _ViewPanelBackRefs(QTreeWidget):
         tHandle = index.siblingAtColumn(self.C_DATA).data(self.D_HANDLE)
         if index.column() not in (self.C_EDIT, self.C_VIEW):
             self._parent.openDocumentRequest.emit(tHandle, nwDocMode.VIEW, "", True)
-        return
 
     ##
     #  Internal Functions
@@ -362,8 +348,6 @@ class _ViewPanelBackRefs(QTreeWidget):
                 self.addTopLevelItem(trItem)
                 self._treeMap[tKey] = trItem
 
-        return
-
 
 class _ViewPanelKeyWords(QTreeWidget):
 
@@ -418,14 +402,13 @@ class _ViewPanelKeyWords(QTreeWidget):
         self.clicked.connect(self._treeItemClicked)
         self.doubleClicked.connect(self._treeItemDoubleClicked)
 
-        return
-
     def updateTheme(self) -> None:
         """Update theme elements."""
+        logger.debug("Theme Update: _ViewPanelKeyWords")
+
         self._classIcon = SHARED.theme.getIcon(nwLabels.CLASS_ICON[self._class], "root")
-        self._editIcon = SHARED.theme.getIcon("edit", "green")
-        self._viewIcon = SHARED.theme.getIcon("view", "blue")
-        return
+        self._editIcon = SHARED.theme.getIcon("edit", "change")
+        self._viewIcon = SHARED.theme.getIcon("view", "action")
 
     def countEntries(self) -> int:
         """Return the number of items in the list."""
@@ -435,7 +418,6 @@ class _ViewPanelKeyWords(QTreeWidget):
         """Clear the list."""
         self._treeMap = {}
         self.clear()
-        return
 
     def addUpdateEntry(self, tag: str, name: str, iItem: IndexNode, hItem: IndexHeading) -> None:
         """Add a new entry, or update an existing one."""
@@ -470,8 +452,6 @@ class _ViewPanelKeyWords(QTreeWidget):
             self.addTopLevelItem(trItem)
             self._treeMap[tag] = trItem
 
-        return
-
     def removeEntry(self, tag: str) -> bool:
         """Remove a tag from the list."""
         if tag in self._treeMap:
@@ -487,7 +467,6 @@ class _ViewPanelKeyWords(QTreeWidget):
             self.setColumnWidth(self.C_IMPORT, checkInt(widths[1], 100))
             self.setColumnWidth(self.C_DOC,    checkInt(widths[2], 100))
             self.setColumnWidth(self.C_TITLE,  checkInt(widths[3], 100))
-        return
 
     def getColumnWidths(self) -> list[int]:
         """Get the widths of the user-adjustable columns."""
@@ -510,7 +489,6 @@ class _ViewPanelKeyWords(QTreeWidget):
             self._parent.loadDocumentTagRequest.emit(tag, nwDocMode.EDIT)
         elif index.column() == self.C_VIEW:
             self._parent.loadDocumentTagRequest.emit(tag, nwDocMode.VIEW)
-        return
 
     @pyqtSlot("QModelIndex")
     def _treeItemDoubleClicked(self, index: QModelIndex) -> None:
@@ -518,4 +496,3 @@ class _ViewPanelKeyWords(QTreeWidget):
         tag = index.siblingAtColumn(self.C_DATA).data(self.D_TAG)
         if index.column() not in (self.C_EDIT, self.C_VIEW):
             self._parent.loadDocumentTagRequest.emit(tag, nwDocMode.VIEW)
-        return

novelwriter/gui/editordocument.py

@@ -20,7 +20,7 @@ General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <https://www.gnu.org/licenses/>.
-"""
+"""  # noqa
 from __future__ import annotations
 
 import logging
@@ -42,6 +42,11 @@ logger = logging.getLogger(__name__)
 
 
 class GuiTextDocument(QTextDocument):
+    """Custom: Modified QTextDocument.
+
+    A special text document format that incorporates a few additional
+    features including spell checking.
+    """
 
     def __init__(self, parent: QObject) -> None:
         super().__init__(parent=parent)
@@ -52,11 +57,8 @@ class GuiTextDocument(QTextDocument):
 
         logger.debug("Ready: GuiTextDocument")
 
-        return
-
     def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiTextDocument")
-        return
 
     ##
     #  Properties
@@ -96,8 +98,6 @@ class GuiTextDocument(QTextDocument):
         logger.debug("Loaded %d text blocks in %.3f ms", count, 1000*(tMid - tStart))
         logger.debug("Highlighted document in %.3f ms", 1000*(tEnd - tMid))
 
-        return
-
     def metaDataAtPos(self, pos: int) -> tuple[str, str]:
         """Check if there is meta data available at a given position in
         the document, and if so, return it.
@@ -113,7 +113,7 @@ class GuiTextDocument(QTextDocument):
                         return cData, cType
         return "", ""
 
-    def spellErrorAtPos(self, pos: int) -> tuple[str, int, int, list[str]]:
+    def spellErrorAtPos(self, pos: int) -> tuple[str, int, list[str]]:
         """Check if there is a misspelled word at a given position in
         the document, and if so, return it.
         """
@@ -122,15 +122,11 @@ class GuiTextDocument(QTextDocument):
         block = cursor.block()
         data = block.userData()
         if block.isValid() and isinstance(data, TextBlockData):
-            text = block.text()
-            check = pos - block.position()
-            if check >= 0:
-                for cPos, cEnd in data.spellErrors:
-                    cLen = cEnd - cPos
-                    if cPos <= check <= cEnd:
-                        word = text[cPos:cEnd]
-                        return word, cPos, cLen, SHARED.spelling.suggestWords(word)
-        return "", -1, -1, []
+            if (check := pos - block.position()) >= 0:
+                for start, end, word in data.spellErrors:
+                    if start <= check <= end:
+                        return word, start, SHARED.spelling.suggestWords(word)
+        return "", -1, []
 
     def iterBlockByType(self, cType: int, maxCount: int = 1000) -> Iterable[QTextBlock]:
         """Iterate over all text blocks of a given type."""
@@ -150,4 +146,3 @@ class GuiTextDocument(QTextDocument):
     def setSpellCheckState(self, state: bool) -> None:
         """Set the spell check state of the syntax highlighter."""
         self._syntax.setSpellCheck(state)
-        return

novelwriter/gui/itemdetails.py

@@ -20,7 +20,7 @@ General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <https://www.gnu.org/licenses/>.
-"""
+"""  # noqa
 from __future__ import annotations
 
 import logging
@@ -43,6 +43,7 @@ logger = logging.getLogger(__name__)
 
 
 class GuiItemDetails(QWidget):
+    """GUI: Project Item Details Panel."""
 
     def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
@@ -190,8 +191,6 @@ class GuiItemDetails(QWidget):
 
         logger.debug("Ready: GuiItemDetails")
 
-        return
-
     ###
     #  Class Methods
     ##
@@ -210,7 +209,6 @@ class GuiItemDetails(QWidget):
         self.cCountData.clear()
         self.wCountData.clear()
         self.pCountData.clear()
-        return
 
     def refreshDetails(self) -> None:
         """Reload the content of the details panel."""
@@ -218,8 +216,8 @@ class GuiItemDetails(QWidget):
 
     def updateTheme(self) -> None:
         """Update theme elements."""
+        logger.debug("Theme Update: GuiItemDetails")
         self.updateViewBox(self._handle)
-        return
 
     def updateViewBox(self, tHandle: str | None) -> None:
         """Populate the details box from a given handle."""
@@ -233,14 +231,8 @@ class GuiItemDetails(QWidget):
         # Label
         # =====
 
-        if nwItem.isFileType():
-            if nwItem.isActive:
-                self.labelIcon.setPixmap(SHARED.theme.getPixmap("checked", (iPx, iPx), "green"))
-            else:
-                self.labelIcon.setPixmap(SHARED.theme.getPixmap("unchecked", (iPx, iPx), "red"))
-        else:
-            self.labelIcon.setPixmap(SHARED.theme.getPixmap("noncheckable", (iPx, iPx), "faded"))
-
+        _, icon = nwItem.getActiveStatus()
+        self.labelIcon.setPixmap(icon.pixmap(iPx, iPx))
         self.labelData.setText(elide(nwItem.itemName, 100))
 
         # Status
@@ -289,4 +281,3 @@ class GuiItemDetails(QWidget):
                 self.updateViewBox(tHandle)
             elif change == nwChange.DELETE:
                 self.updateViewBox(None)
-        return

novelwriter/gui/mainmenu.py

@@ -20,7 +20,7 @@ General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <https://www.gnu.org/licenses/>.
-"""
+"""  # noqa
 from __future__ import annotations
 
 import logging
@@ -82,8 +82,6 @@ class GuiMainMenu(QMenuBar):
 
         logger.debug("Ready: GuiMainMenu")
 
-        return
-
     ##
     #  Public Slots
     ##
@@ -92,7 +90,18 @@ class GuiMainMenu(QMenuBar):
     def setSpellCheckState(self, state: bool) -> None:
         """Forward spell check check state to its action."""
         self.aSpellCheck.setChecked(state)
-        return
+
+    @pyqtSlot()
+    def updateSpellCheckLanguages(self) -> None:
+        """Update the list of available spell check languages."""
+        self.mSelectLanguage.clear()
+        languages = SHARED.spelling.listDictionaries()
+        languages.insert(0, ("None", self.tr("Default")))
+        for tag, language in languages:
+            aSpell = QAction(self.mSelectLanguage)
+            aSpell.setText(language)
+            aSpell.triggered.connect(qtLambda(self._changeSpelling, tag))
+            self.mSelectLanguage.addAction(aSpell)
 
     ##
     #  Private Slots
@@ -105,21 +114,18 @@ class GuiMainMenu(QMenuBar):
         decision, just pass a None to the function and let it decide.
         """
         self.mainGui.docEditor.toggleSpellCheck(None)
-        return
 
     @pyqtSlot()
     def _openUserManualFile(self) -> None:
         """Open the documentation in PDF format."""
         if isinstance(CONFIG.pdfDocs, Path):
             openExternalPath(CONFIG.pdfDocs)
-        return
 
     @pyqtSlot(str)
     def _changeSpelling(self, language: str) -> None:
         """Change the spell check language."""
         SHARED.project.data.setSpellLang(language)
         SHARED.updateSpellCheckLanguage()
-        return
 
     ##
     #  Internal Functions
@@ -188,8 +194,6 @@ class GuiMainMenu(QMenuBar):
         self.aExitNW.triggered.connect(qtLambda(self.mainGui.closeMain))
         self.mainGui.addAction(self.aExitNW)
 
-        return
-
     def _buildDocumentMenu(self) -> None:
         """Assemble the Document menu."""
         # Document
@@ -236,8 +240,6 @@ class GuiMainMenu(QMenuBar):
         self.aImportFile = qtAddAction(self.docuMenu, self.tr("Import Text from File"))
         self.aImportFile.triggered.connect(qtLambda(self.mainGui.importDocument))
 
-        return
-
     def _buildEditMenu(self) -> None:
         """Assemble the Edit menu."""
         # Edit
@@ -305,8 +307,6 @@ class GuiMainMenu(QMenuBar):
         )
         self.mainGui.addAction(self.aSelectPar)
 
-        return
-
     def _buildViewMenu(self) -> None:
         """Assemble the View menu."""
         # View
@@ -318,6 +318,7 @@ class GuiMainMenu(QMenuBar):
         self.aFocusTree.triggered.connect(
             lambda: self.requestFocusChange.emit(nwFocus.TREE)
         )
+        self.mainGui.addAction(self.aFocusTree)
 
         # View > Document Editor
         self.aFocusDocument = qtAddAction(self.viewMenu, self.tr("Go to Document"))
@@ -332,6 +333,7 @@ class GuiMainMenu(QMenuBar):
         self.aFocusOutline.triggered.connect(
             lambda: self.requestFocusChange.emit(nwFocus.OUTLINE)
         )
+        self.mainGui.addAction(self.aFocusOutline)
 
         # View > Separator
         self.viewMenu.addSeparator()
@@ -365,8 +367,6 @@ class GuiMainMenu(QMenuBar):
         self.aFullScreen.triggered.connect(self.mainGui.toggleFullScreenMode)
         self.mainGui.addAction(self.aFullScreen)
 
-        return
-
     def _buildInsertMenu(self) -> None:
         """Assemble the Insert menu."""
         # Insert
@@ -644,8 +644,6 @@ class GuiMainMenu(QMenuBar):
             lambda: self.requestDocInsert.emit(nwDocInsert.FOOTNOTE)
         )
 
-        return
-
     def _buildFormatMenu(self) -> None:
         """Assemble the Format menu."""
         # Format
@@ -675,6 +673,14 @@ class GuiMainMenu(QMenuBar):
         )
         self.mainGui.addAction(self.aFmtStrike)
 
+        # Format > Highlight
+        self.aFmtMark = qtAddAction(self.fmtMenu, self.tr("Highlight"))
+        self.aFmtMark.setShortcut("Ctrl+M")
+        self.aFmtMark.triggered.connect(
+            lambda: self.requestDocAction.emit(nwDocAction.MD_MARK)
+        )
+        self.mainGui.addAction(self.aFmtStrike)
+
         # Edit > Separator
         self.fmtMenu.addSeparator()
 
@@ -891,8 +897,6 @@ class GuiMainMenu(QMenuBar):
             lambda: self.requestDocAction.emit(nwDocAction.RM_BREAKS)
         )
 
-        return
-
     def _buildSearchMenu(self) -> None:
         """Assemble the Search menu."""
         # Search
@@ -938,8 +942,6 @@ class GuiMainMenu(QMenuBar):
         self.aFindProj.setShortcut("Ctrl+Shift+F")
         self.aFindProj.triggered.connect(qtLambda(self.requestViewChange.emit, nwView.SEARCH))
 
-        return
-
     def _buildToolsMenu(self) -> None:
         """Assemble the Tools menu."""
         # Tools
@@ -954,13 +956,7 @@ class GuiMainMenu(QMenuBar):
         self.mainGui.addAction(self.aSpellCheck)
 
         self.mSelectLanguage = qtAddMenu(self.toolsMenu, self.tr("Spell Check Language"))
-        languages = SHARED.spelling.listDictionaries()
-        languages.insert(0, ("None", self.tr("Default")))
-        for tag, language in languages:
-            aSpell = QAction(self.mSelectLanguage)
-            aSpell.setText(language)
-            aSpell.triggered.connect(qtLambda(self._changeSpelling, tag))
-            self.mSelectLanguage.addAction(aSpell)
+        self.updateSpellCheckLanguages()
 
         # Tools > Re-Run Spell Check
         self.aReRunSpell = qtAddAction(self.toolsMenu, self.tr("Re-Run Spell Check"))
@@ -1009,8 +1005,6 @@ class GuiMainMenu(QMenuBar):
         self.aPreferences.triggered.connect(self.mainGui.showPreferencesDialog)
         self.mainGui.addAction(self.aPreferences)
 
-        return
-
     def _buildHelpMenu(self) -> None:
         """Assemble the Help menu."""
         # Help
@@ -1056,5 +1050,3 @@ class GuiMainMenu(QMenuBar):
         # Document > Main Website
         self.aWebsite = qtAddAction(self.helpMenu, self.tr("The novelWriter Website"))
         self.aWebsite.triggered.connect(qtLambda(SHARED.openWebsite, nwConst.URL_WEB))
-
-        return