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

novelwriter/core/item.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
@@ -44,7 +44,7 @@ logger = logging.getLogger(__name__)
 
 
 class NWItem:
-    """Core: Item Data Class
+    """Core: Item Data Class.
 
     This class holds all the project information about a project item.
     Each item must be associated with a project and have a valid handle.
@@ -84,16 +84,14 @@ class NWItem:
         self._wordInit  = 0     # Initial character count
         self._charInit  = 0     # Initial word count
 
-        return
-
     def __repr__(self) -> str:
         return f"<NWItem handle={self._handle}, parent={self._parent}, name='{self._name}'>"
 
     def __bool__(self) -> bool:
-        """The truthiness of the class. The handle used to be initiated
-        to None, but this is no longer the case. It should always
-        evaluate to True since 2.1-beta1, although unpack and the NWTree
-        class can leave it as an empty string.
+        """Check the truthiness of the class. The handle used to be
+        initiated to None, but this is no longer the case. It should
+        always evaluate to True since 2.1-beta1, although unpack and the
+        NWTree class can leave it as an empty string.
         """
         return bool(self._handle)
 
@@ -206,15 +204,13 @@ class NWItem:
             meta["cursorPos"] = str(self._cursorPos)
             name["active"]    = yesNo(self._active)
 
-        data = {
+        return {
             "name": str(self._name),
             "itemAttr": item,
             "metaAttr": meta,
             "nameAttr": name,
         }
 
-        return data
-
     def unpack(self, data: dict) -> bool:
         """Set the values from a data dictionary."""
         item = data.get("itemAttr", {})
@@ -298,13 +294,11 @@ class NWItem:
     def notifyToRefresh(self) -> None:
         """Notify GUI that item info needs to be refreshed."""
         self._project.tree.refreshItems([self._handle])
-        return
 
     def notifyNovelStructureChange(self) -> None:
         """Notify that the structure of a novel has changed."""
         if self._root and self._class == nwItemClass.NOVEL:
             self._project.tree.novelStructureChanged(self._root)
-        return
 
     ##
     #  Lookup Methods
@@ -363,13 +357,13 @@ class NWItem:
         """
         if self.isFileType():
             key = "checked" if self._active else "unchecked"
-            color = "green" if self._active else "red"
+            color = "active" if self._active else "inactive"
             text = trConst(nwLabels.ACTIVE_NAME[key])
-            icon = SHARED.theme.getIcon(key, color)
         else:
+            key = "noncheckable"
+            color = "disabled"
             text = ""
-            icon = SHARED.theme.getIcon("noncheckable", "faded")
-        return text, icon
+        return text, SHARED.theme.getIcon(key, color)
 
     ##
     #  Checker Methods
@@ -457,8 +451,6 @@ class NWItem:
         if self._import is None:
             self.setImport("New")  # This forces a default value lookup
 
-        return
-
     ##
     #  Set Item Values
     ##
@@ -469,7 +461,6 @@ class NWItem:
             self._name = simplified(name)
         else:
             self._name = ""
-        return
 
     def setParent(self, handle: Any) -> None:
         """Set the parent handle, and ensure it is valid."""
@@ -479,7 +470,6 @@ class NWItem:
             self._parent = handle
         else:
             self._parent = None
-        return
 
     def setRoot(self, handle: Any) -> None:
         """Set the root handle, and ensure it is valid."""
@@ -489,7 +479,6 @@ class NWItem:
             self._root = handle
         else:
             self._root = None
-        return
 
     def setOrder(self, order: Any) -> None:
         """Set the item order, and ensure that it is valid. This value
@@ -497,7 +486,6 @@ class NWItem:
         the moment.
         """
         self._order = checkInt(order, 0)
-        return
 
     def setType(self, value: Any) -> None:
         """Set the item type from either a proper nwItemType, or set it
@@ -510,7 +498,6 @@ class NWItem:
         else:
             logger.error("Unrecognised item type '%s'", value)
             self._type = nwItemType.NO_TYPE
-        return
 
     def setClass(self, value: Any) -> None:
         """Set the item class from either a proper nwItemClass, or set
@@ -523,7 +510,6 @@ class NWItem:
         else:
             logger.error("Unrecognised item class '%s'", value)
             self._class = nwItemClass.NO_CLASS
-        return
 
     def setLayout(self, value: Any) -> None:
         """Set the item layout from either a proper nwItemLayout, or set
@@ -536,21 +522,18 @@ class NWItem:
         else:
             logger.error("Unrecognised item layout '%s'", value)
             self._layout = nwItemLayout.NO_LAYOUT
-        return
 
     def setStatus(self, value: Any) -> None:
         """Set the item status by looking it up in the valid status
         items of the current project.
         """
         self._status = self._project.data.itemStatus.check(value)
-        return
 
     def setImport(self, value: Any) -> None:
         """Set the item importance by looking it up in the valid import
         items of the current project.
         """
         self._import = self._project.data.itemImport.check(value)
-        return
 
     def setActive(self, state: Any) -> None:
         """Set the active flag."""
@@ -558,7 +541,6 @@ class NWItem:
             self._active = state
         else:
             self._active = False
-        return
 
     def setExpanded(self, state: Any) -> None:
         """Set the expanded status of an item in the project tree."""
@@ -566,7 +548,6 @@ class NWItem:
             self._expanded = state
         else:
             self._expanded = False
-        return
 
     ##
     #  Set Document Meta Data
@@ -576,7 +557,6 @@ class NWItem:
         """Set the main heading level."""
         if value in nwStyles.H_LEVEL:
             self._heading = value
-        return
 
     def setCharCount(self, count: Any) -> None:
         """Set the character count, and ensure that it is an integer."""
@@ -584,7 +564,6 @@ class NWItem:
             self._charCount = max(0, count)
         else:
             self._charCount = 0
-        return
 
     def setWordCount(self, count: Any) -> None:
         """Set the word count, and ensure that it is an integer."""
@@ -592,7 +571,6 @@ class NWItem:
             self._wordCount = max(0, count)
         else:
             self._wordCount = 0
-        return
 
     def setParaCount(self, count: Any) -> None:
         """Set the paragraph count, and ensure that it is an integer."""
@@ -600,7 +578,6 @@ class NWItem:
             self._paraCount = max(0, count)
         else:
             self._paraCount = 0
-        return
 
     def setCursorPos(self, position: Any) -> None:
         """Set the cursor position, and ensure that it is an integer."""
@@ -608,4 +585,3 @@ class NWItem:
             self._cursorPos = max(0, position)
         else:
             self._cursorPos = 0
-        return

novelwriter/core/itemmodel.py

@@ -21,7 +21,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
@@ -66,7 +66,7 @@ T_NodeData = str | QIcon | QFont | Qt.AlignmentFlag | None
 
 
 class ProjectNode:
-    """Core: Project Model Node Class
+    """Core: Project Model Node Class.
 
     The project tree structure is saved as nodes in a tree, starting
     from a root node. This class makes up these nodes.
@@ -103,7 +103,6 @@ class ProjectNode:
         self._count = 0
         self.refresh()
         self.updateCount()
-        return
 
     def __repr__(self) -> str:
         return (
@@ -114,7 +113,7 @@ class ProjectNode:
         )
 
     def __bool__(self) -> bool:
-        """A node should always evaluate to True."""
+        # A node should always evaluate to True.
         return True
 
     ##
@@ -162,15 +161,12 @@ class ProjectNode:
         self._cache[C_STATUS_TIP] = sText
         self._cache[C_STATUS_ACCESS] = sText
 
-        return
-
     def updateCount(self, propagate: bool = True) -> None:
         """Update counts, and propagate upwards in the tree."""
         self._count = self._item.mainCount + sum(c._count for c in self._children)  # noqa: SLF001
         self._cache[C_COUNT_TEXT] = f"{self._count:n}"
         if propagate and (parent := self._parent):
             parent.updateCount()
-        return
 
     ##
     #  Data Access
@@ -223,7 +219,6 @@ class ProjectNode:
             self._children.append(child)
         self._refreshChildrenPos()
         self._item.notifyNovelStructureChange()
-        return
 
     def takeChild(self, pos: int) -> ProjectNode | None:
         """Remove a child item and return it."""
@@ -243,7 +238,6 @@ class ProjectNode:
             self._children.insert(target, node)
             self._refreshChildrenPos()
             self._item.notifyNovelStructureChange()
-        return
 
     def setExpanded(self, state: bool) -> None:
         """Set the node's expanded state."""
@@ -251,7 +245,6 @@ class ProjectNode:
             self._item.setExpanded(True)
         else:
             self._item.setExpanded(False)
-        return
 
     ##
     #  Internal Functions
@@ -262,14 +255,12 @@ class ProjectNode:
         for node in self._children:
             children.append(node)
             node._recursiveAppendChildren(children)  # noqa: SLF001
-        return
 
     def _refreshChildrenPos(self) -> None:
         """Update the row value on all children."""
         for n, child in enumerate(self._children):
             child._row = n  # noqa: SLF001
             child.item.setOrder(n)
-        return
 
     def _updateRelationships(self, child: ProjectNode) -> None:
         """Update a child item's relationships."""
@@ -282,11 +273,10 @@ class ProjectNode:
             child.item.setParent(None)
             child.item.setRoot(child.item.itemHandle)
             child.item.setClassDefaults(child.item.itemClass)
-        return
 
 
 class ProjectModel(QAbstractItemModel):
-    """Core: Project Model Class
+    """Core: Project Model Class.
 
     This class provides the interface for the tree widget used on the
     GUI. It implements the QModelIndex based interface required, adds
@@ -302,11 +292,9 @@ class ProjectModel(QAbstractItemModel):
         self._root = ProjectNode(NWItem(tree.project, INV_ROOT))
         self._root.item.setName("Invisible Root")
         logger.debug("Ready: ProjectModel")
-        return
 
     def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: ProjectModel")
-        return
 
     ##
     #  Properties
@@ -363,7 +351,7 @@ class ProjectModel(QAbstractItemModel):
     ##
 
     def supportedDropActions(self) -> Qt.DropAction:
-        """Return supported drop actions"""
+        """Return supported drop actions."""
         return Qt.DropAction.MoveAction
 
     def mimeTypes(self) -> list[str]:
@@ -445,7 +433,6 @@ class ProjectModel(QAbstractItemModel):
         self.beginInsertRows(parent, row, row)
         node.addChild(child, row)
         self.endInsertRows()
-        return
 
     def removeChild(self, parent: QModelIndex, pos: int) -> ProjectNode | None:
         """Remove a node from the model and return it."""
@@ -469,7 +456,6 @@ class ProjectModel(QAbstractItemModel):
                     self.beginMoveRows(index.parent(), pos, pos, index.parent(), end)
                     parent.moveChild(pos, new)
                     self.endMoveRows()
-        return
 
     def multiMove(self, indices: list[QModelIndex], target: QModelIndex, pos: int = -1) -> None:
         """Move multiple items to a new location."""
@@ -497,7 +483,6 @@ class ProjectModel(QAbstractItemModel):
                             node._updateRelationships(child)  # noqa: SLF001
                             child.item.notifyToRefresh()
                         node.item.notifyToRefresh()
-        return
 
     ##
     #  Other Methods
@@ -506,7 +491,6 @@ class ProjectModel(QAbstractItemModel):
     def clear(self) -> None:
         """Clear the project model."""
         self._root.children.clear()
-        return
 
     def allExpanded(self) -> list[QModelIndex]:
         """Return a list of all expanded items."""

novelwriter/core/novelmodel.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
@@ -54,21 +54,20 @@ T_NodeData = str | QIcon | QPixmap | Qt.AlignmentFlag | None
 
 
 class NovelModel(QAbstractTableModel):
+    """Core: Novel Model CLass."""
 
     __slots__ = ("_columns", "_extraKey", "_extraLabel", "_more", "_rows")
 
     def __init__(self) -> None:
         super().__init__()
         self._rows: list[dict[int, T_NodeData]] = []
-        self._more = SHARED.theme.getIcon("more_arrow")
+        self._more = SHARED.theme.getIcon("more_arrow", "tool")
         self._columns = 3
         self._extraKey = ""
         self._extraLabel = ""
-        return
 
     def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: NovelModel")
-        return
 
     ##
     #  Properties
@@ -102,7 +101,6 @@ class NovelModel(QAbstractTableModel):
                 self._columns = 4
                 self._extraKey = nwKeyWords.PLOT_KEY
                 self._extraLabel = trConst(nwLabels.KEY_NAME[nwKeyWords.PLOT_KEY])
-        return
 
     ##
     #  Model Interface
@@ -147,7 +145,6 @@ class NovelModel(QAbstractTableModel):
     def clear(self) -> None:
         """Clear the model."""
         self._rows.clear()
-        return
 
     def append(self, node: IndexNode) -> None:
         """Append a node to the model."""
@@ -155,7 +152,6 @@ class NovelModel(QAbstractTableModel):
         for key, head in node.items():
             if key != "T0000":
                 self._rows.append(self._generateEntry(handle, key, head))
-        return
 
     def refresh(self, node: IndexNode) -> bool:
         """Refresh an index node."""

novelwriter/core/options.py

@@ -21,7 +21,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 json
@@ -56,7 +56,7 @@ VALID_MAP: dict[str, set[str]] = {
     "GuiWordList": {"winWidth", "winHeight"},
     "GuiNovelView": {"lastCol", "lastColSize"},
     "GuiBuildSettings": {
-        "winWidth", "winHeight", "treeWidth", "filterWidth",
+        "winWidth", "winHeight", "treeWidth", "filterWidth", "autoPreview",
     },
     "GuiManuscript": {
         "winWidth", "winHeight", "optsWidth", "viewWidth", "listHeight",
@@ -80,7 +80,7 @@ VALID_MAP: dict[str, set[str]] = {
 
 
 class OptionState:
-    """Core: GUI Options Storage
+    """Core: GUI Options Storage.
 
     A class for storing the state of the GUI. The data is stored per
     project. Settings that should be project-independent are stored in
@@ -90,7 +90,6 @@ class OptionState:
     def __init__(self, project: NWProject) -> None:
         self._project = project
         self._state = {}
-        return
 
     ##
     #  Load and Save Cache

novelwriter/core/project.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 json
@@ -57,6 +57,7 @@ logger = logging.getLogger(__name__)
 
 
 class NWProjectState(Enum):
+    """The state of the loaded project."""
 
     UNKNOWN  = 0
     LOCKED   = 1
@@ -65,6 +66,11 @@ class NWProjectState(Enum):
 
 
 class NWProject:
+    """Core: novelWriter Project Class.
+
+    This class is the parent class of the project, and holds instances
+    of project data, the project tree, and the project index.
+    """
 
     __slots__ = (
         "_changed", "_data", "_index", "_langData", "_options", "_session",
@@ -92,17 +98,13 @@ class NWProject:
 
         logger.debug("Ready: NWProject")
 
-        return
-
     def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: NWProject")
-        return
 
     def clear(self) -> None:
         """Clear the project."""
         self._tree.clear()
         self._index.clear()
-        return
 
     ##
     #  Properties
@@ -224,7 +226,7 @@ class NWProject:
 
         return True
 
-    def copyFileContent(self, tHandle: str, sHandle: str) -> bool:
+    def copyFileContent(self, tHandle: str, sHandle: str, newTitle: str | None = None) -> bool:
         """Copy content to a new document after it is created. This
         will not run if the file exists and is not empty.
         """
@@ -239,6 +241,14 @@ class NWProject:
 
         logger.debug("Populating '%s' with text from '%s'", tHandle, sHandle)
         text = self._storage.getDocumentText(sHandle)
+        if (
+            newTitle and (lines := text.split("\n")) and lines
+            and lines[0].startswith(("# ", "## ", "### ", "#### ", "#! ", "##! ", "###! "))
+        ):
+            prefix, _, _ = lines[0].partition(" ")
+            lines[0] = f"{prefix} {newTitle}"
+            text = "\n".join(lines)
+
         self._storage.getDocument(tHandle).writeDocument(text)
         sItem.setLayout(tItem.itemLayout)
         self._index.reIndexHandle(tHandle)
@@ -255,7 +265,6 @@ class NWProject:
             if rHandle and (tHandle := SHARED.project.newFile(tag.title(), rHandle)):
                 self.writeNewFile(tHandle, 1, False, f"@tag: {tag}\n\n")
                 self._tree.refreshItems([tHandle])
-        return
 
     ##
     #  Project Methods
@@ -433,7 +442,6 @@ class NWProject:
         self._tree.writeToCFile()
         self._session.appendSession(idleTime)
         self._storage.closeSession()
-        return
 
     def backupProject(self, doNotify: bool) -> bool:
         """Create a zip file of the entire project."""
@@ -483,15 +491,14 @@ class NWProject:
 
     def setDefaultStatusImport(self) -> None:
         """Set the default status and importance values."""
-        self._data.itemStatus.add(None, self.tr("New"),      (120, 120, 120), "STAR", 0)
-        self._data.itemStatus.add(None, self.tr("Note"),     (205, 171, 143), "TRIANGLE", 0)
-        self._data.itemStatus.add(None, self.tr("Draft"),    (143, 240, 164), "CIRCLE_T", 0)
-        self._data.itemStatus.add(None, self.tr("Finished"), (249, 240, 107), "STAR", 0)
-        self._data.itemImport.add(None, self.tr("New"),      (120, 120, 120), "SQUARE", 0)
-        self._data.itemImport.add(None, self.tr("Minor"),    (220, 138, 221), "BLOCK_2", 0)
-        self._data.itemImport.add(None, self.tr("Major"),    (220, 138, 221), "BLOCK_3", 0)
-        self._data.itemImport.add(None, self.tr("Main"),     (220, 138, 221), "BLOCK_4", 0)
-        return
+        self._data.itemStatus.add(None, self.tr("New"), "faded", "STAR", 0)
+        self._data.itemStatus.add(None, self.tr("Note"), "red", "TRIANGLE", 0)
+        self._data.itemStatus.add(None, self.tr("Draft"), "yellow", "CIRCLE_T", 0)
+        self._data.itemStatus.add(None, self.tr("Finished"), "green", "STAR", 0)
+        self._data.itemImport.add(None, self.tr("New"), "purple", "SQUARE", 0)
+        self._data.itemImport.add(None, self.tr("Minor"), "purple", "BLOCK_2", 0)
+        self._data.itemImport.add(None, self.tr("Major"), "purple", "BLOCK_3", 0)
+        self._data.itemImport.add(None, self.tr("Main"), "purple", "BLOCK_4", 0)
 
     def setProjectLang(self, language: str | None) -> None:
         """Set the project-specific language."""
@@ -500,7 +507,6 @@ class NWProject:
             self._data.setLanguage(language)
             self._loadProjectLocalisation()
             self.setProjectChanged(True)
-        return
 
     def setProjectChanged(self, status: bool) -> bool:
         """Toggle the project changed flag, and propagate the
@@ -519,7 +525,6 @@ class NWProject:
         """Update the total word and character count values."""
         wNovel, wNotes, cNovel, cNotes = self._tree.sumCounts()
         self._data.setCurrCounts(wNovel=wNovel, wNotes=wNotes, cNovel=cNovel, cNotes=cNotes)
-        return
 
     def countStatus(self) -> None:
         """Count how many times the various status flags are used in the
@@ -533,7 +538,6 @@ class NWProject:
                 self._data.itemStatus.increment(nwItem.itemStatus)
             else:
                 self._data.itemImport.increment(nwItem.itemImport)
-        return
 
     def updateStatus(self, kind: T_StatusKind, update: T_UpdateEntry) -> None:
         """Update status or import entries."""
@@ -545,7 +549,13 @@ class NWProject:
             self._data.itemImport.update(update)
             SHARED.emitStatusLabelsChanged(self, kind)
             self._tree.refreshAllItems()
-        return
+
+    def updateTheme(self) -> None:
+        """Update theme elements."""
+        logger.debug("Theme Update: NWProject")
+
+        self._data.itemStatus.refreshIcons()
+        self._data.itemImport.refreshIcons()
 
     def localLookup(self, word: str | int) -> str:
         """Look up a word or number in the translation map for the