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

novelwriter/core/tree.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
@@ -50,7 +50,7 @@ MAX_DEPTH = 999  # Cap of tree traversing for loops (recursion limit)
 
 
 class NWTree:
-    """Core: Project Tree Data Class
+    """Core: Project Tree Data Class.
 
     Only one instance of this class should exist in the project class.
     This class holds all the project items of the project as instances
@@ -71,18 +71,16 @@ class NWTree:
         self._trash = None
         self._ready = False
         logger.debug("Ready: NWTree")
-        return
 
     def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: NWTree")
-        return
 
     def __len__(self) -> int:
-        """The number of items in the project."""
+        """Return the number of items in the project."""
         return len(self._items)
 
     def __bool__(self) -> bool:
-        """True if there are any items in the project."""
+        """Return True if there are any items in the project."""
         return bool(self._items)
 
     def __getitem__(self, tHandle: str | None) -> NWItem | None:
@@ -91,11 +89,11 @@ class NWTree:
         """
         if tHandle and tHandle in self._items:
             return self._items[tHandle]
-        logger.error("No tree item with handle '%s'", str(tHandle))
+        logger.error("No tree item with handle '%s'", tHandle)
         return None
 
     def __contains__(self, tHandle: str) -> bool:
-        """Checks if a handle exists in the tree."""
+        """Check if a handle exists in the tree."""
         return tHandle in self._items
 
     def __iter__(self) -> Iterator[NWItem]:
@@ -142,7 +140,6 @@ class NWTree:
         self._trash = None
         oldModel.deleteLater()
         del oldModel
-        return
 
     def add(self, item: NWItem, pos: int = -1) -> bool:
         """Add a project item into the project tree."""
@@ -260,8 +257,6 @@ class NWTree:
         self._model.endInsertRows()
         self._model.layoutChanged.emit()
 
-        return
-
     def pickParent(self, sNode: ProjectNode, hLevel: int, isNote: bool) -> tuple[str | None, int]:
         """Pick an appropriate parent handle for adding a new item."""
         if sNode.item.isFolderType() or sNode.item.isRootType():
@@ -299,7 +294,6 @@ class NWTree:
                 indexE = self._model.indexFromNode(node, 3)
                 self._model.dataChanged.emit(indexS, indexE)
                 self._itemChange(node.item, nwChange.UPDATE)
-        return
 
     def refreshAllItems(self) -> None:
         """Refresh all items in the tree."""
@@ -309,13 +303,11 @@ class NWTree:
         self._model.root.refresh()
         self._model.root.updateCount(propagate=False)
         self._model.layoutChanged.emit()
-        return
 
     def novelStructureChanged(self, tHandle: str) -> None:
         """Emit a novel structure change signal."""
         if self._ready:
             SHARED.novelStructureChanged.emit(tHandle)
-        return
 
     def checkConsistency(self, prefix: str) -> tuple[int, int]:
         """Check the project tree consistency. Also check the content
@@ -496,7 +488,6 @@ class NWTree:
         SHARED.emitProjectItemChanged(self._project, tHandle, change)
         if item.isRootType():
             SHARED.emitRootFolderChanged(self._project, tHandle, change)
-        return
 
     def _getTrashNode(self) -> ProjectNode | None:
         """Get the trash node. If it doesn't exist, create it."""

novelwriter/dialogs/about.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
@@ -33,10 +33,11 @@ from PyQt6.QtWidgets import (
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.common import readTextFile
+from novelwriter.enum import nwStandardButton
 from novelwriter.extensions.configlayout import NColorLabel
 from novelwriter.extensions.modified import NDialog
 from novelwriter.extensions.versioninfo import VersionInfoWidget
-from novelwriter.types import QtAlignRightTop, QtDialogClose, QtHexArgb
+from novelwriter.types import QtAlignRightTop, QtHexArgb, QtRoleDestruct
 
 if TYPE_CHECKING:
     from PyQt6.QtGui import QCloseEvent
@@ -45,6 +46,7 @@ logger = logging.getLogger(__name__)
 
 
 class GuiAbout(NDialog):
+    """GUI: About novelWriter Dialog."""
 
     def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
@@ -81,8 +83,11 @@ class GuiAbout(NDialog):
         self.txtCredits.setViewportMargins(0, 8, 8, 0)
 
         # Buttons
-        self.btnBox = QDialogButtonBox(QtDialogClose, self)
-        self.btnBox.rejected.connect(self.reject)
+        self.btnClose = SHARED.theme.getStandardButton(nwStandardButton.CLOSE, self)
+        self.btnClose.clicked.connect(self.reject)
+
+        self.btnBox = QDialogButtonBox(self)
+        self.btnBox.addButton(self.btnClose, QtRoleDestruct)
 
         # Assemble
         self.innerBox = QVBoxLayout()
@@ -109,11 +114,8 @@ class GuiAbout(NDialog):
 
         logger.debug("Ready: GuiAbout")
 
-        return
-
     def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiAbout")
-        return
 
     ##
     #  Events
@@ -123,7 +125,6 @@ class GuiAbout(NDialog):
         """Capture the close event and perform cleanup."""
         event.accept()
         self.softDelete()
-        return
 
     ##
     #  Internal Functions
@@ -135,7 +136,6 @@ class GuiAbout(NDialog):
             self.txtCredits.setHtml(html)
         else:
             self.txtCredits.setHtml("Error loading credits text ...")
-        return
 
     def _setStyleSheet(self) -> None:
         """Set stylesheet text document."""
@@ -143,4 +143,3 @@ class GuiAbout(NDialog):
         self.txtCredits.setStyleSheet(
             f"QTextBrowser {{border: none; background: {baseCol};}} "
         )
-        return

novelwriter/dialogs/docmerge.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
@@ -33,15 +33,17 @@ from PyQt6.QtWidgets import (
 )
 
 from novelwriter import SHARED
+from novelwriter.enum import nwStandardButton
 from novelwriter.extensions.configlayout import NColorLabel
 from novelwriter.extensions.modified import NDialog
 from novelwriter.extensions.switch import NSwitch
-from novelwriter.types import QtAccepted, QtDialogCancel, QtDialogOk, QtDialogReset, QtUserRole
+from novelwriter.types import QtAccepted, QtRoleAccept, QtRoleReject, QtRoleReset, QtUserRole
 
 logger = logging.getLogger(__name__)
 
 
 class GuiDocMerge(NDialog):
+    """GUI: Document Merge Tool."""
 
     D_HANDLE = QtUserRole
 
@@ -84,13 +86,19 @@ class GuiDocMerge(NDialog):
         self.optBox.setColumnStretch(2, 1)
 
         # Buttons
-        self.buttonBox = QDialogButtonBox(QtDialogOk | QtDialogCancel, self)
-        self.buttonBox.accepted.connect(self.accept)
-        self.buttonBox.rejected.connect(self.reject)
+        self.btnOk = SHARED.theme.getStandardButton(nwStandardButton.OK, self)
+        self.btnOk.clicked.connect(self.accept)
+
+        self.btnCancel = SHARED.theme.getStandardButton(nwStandardButton.CANCEL, self)
+        self.btnCancel.clicked.connect(self.reject)
 
-        self.resetButton = self.buttonBox.addButton(QtDialogReset)
-        if self.resetButton:
-            self.resetButton.clicked.connect(self._resetList)
+        self.btnReset = SHARED.theme.getStandardButton(nwStandardButton.RESET, self)
+        self.btnReset.clicked.connect(self._resetList)
+
+        self.btnBox = QDialogButtonBox(self)
+        self.btnBox.addButton(self.btnOk, QtRoleAccept)
+        self.btnBox.addButton(self.btnCancel, QtRoleReject)
+        self.btnBox.addButton(self.btnReset, QtRoleReset)
 
         # Assemble
         self.outerBox = QVBoxLayout()
@@ -102,7 +110,7 @@ class GuiDocMerge(NDialog):
         self.outerBox.addSpacing(8)
         self.outerBox.addLayout(self.optBox)
         self.outerBox.addSpacing(12)
-        self.outerBox.addWidget(self.buttonBox)
+        self.outerBox.addWidget(self.btnBox)
         self.setLayout(self.outerBox)
 
         # Load Content
@@ -110,11 +118,8 @@ class GuiDocMerge(NDialog):
 
         logger.debug("Ready: GuiDocMerge")
 
-        return
-
     def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiDocMerge")
-        return
 
     def data(self) -> dict:
         """Return the user's choices."""
@@ -150,7 +155,6 @@ class GuiDocMerge(NDialog):
         if sHandle := self._data.get("sHandle"):
             itemList = self._data.get("origItems", [])
             self._loadContent(sHandle, itemList)
-        return
 
     ##
     #  Internal Functions
@@ -170,4 +174,3 @@ class GuiDocMerge(NDialog):
                 item.setData(self.D_HANDLE, tHandle)
                 item.setCheckState(Qt.CheckState.Checked)
                 self.listBox.addItem(item)
-        return

novelwriter/dialogs/docsplit.py

@@ -21,27 +21,29 @@ 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
 
 from PyQt6.QtCore import pyqtSlot
 from PyQt6.QtWidgets import (
-    QAbstractItemView, QComboBox, QDialogButtonBox, QGridLayout, QLabel,
-    QListWidget, QListWidgetItem, QVBoxLayout, QWidget
+    QAbstractItemView, QDialogButtonBox, QGridLayout, QLabel, QListWidget,
+    QListWidgetItem, QVBoxLayout, QWidget
 )
 
 from novelwriter import SHARED
+from novelwriter.enum import nwStandardButton
 from novelwriter.extensions.configlayout import NColorLabel
-from novelwriter.extensions.modified import NDialog
+from novelwriter.extensions.modified import NComboBox, NDialog
 from novelwriter.extensions.switch import NSwitch
-from novelwriter.types import QtAccepted, QtDialogCancel, QtDialogOk, QtUserRole
+from novelwriter.types import QtAccepted, QtRoleAccept, QtRoleReject, QtUserRole
 
 logger = logging.getLogger(__name__)
 
 
 class GuiDocSplit(NDialog):
+    """GUI: Document Split Tool."""
 
     LINE_ROLE  = QtUserRole
     LEVEL_ROLE = QtUserRole + 1
@@ -79,7 +81,7 @@ class GuiDocSplit(NDialog):
         self.listBox.setMinimumWidth(400)
         self.listBox.setMinimumHeight(180)
 
-        self.splitLevel = QComboBox(self)
+        self.splitLevel = NComboBox(self)
         self.splitLevel.addItem(self.tr("Split on Heading Level 1 (Partition)"),  1)
         self.splitLevel.addItem(self.tr("Split up to Heading Level 2 (Chapter)"), 2)
         self.splitLevel.addItem(self.tr("Split up to Heading Level 3 (Scene)"),   3)
@@ -116,9 +118,15 @@ class GuiDocSplit(NDialog):
         self.optBox.setColumnStretch(3, 1)
 
         # Buttons
-        self.buttonBox = QDialogButtonBox(QtDialogOk | QtDialogCancel, self)
-        self.buttonBox.accepted.connect(self.accept)
-        self.buttonBox.rejected.connect(self.reject)
+        self.btnOk = SHARED.theme.getStandardButton(nwStandardButton.OK, self)
+        self.btnOk.clicked.connect(self.accept)
+
+        self.btnCancel = SHARED.theme.getStandardButton(nwStandardButton.CANCEL, self)
+        self.btnCancel.clicked.connect(self.reject)
+
+        self.btnBox = QDialogButtonBox(self)
+        self.btnBox.addButton(self.btnOk, QtRoleAccept)
+        self.btnBox.addButton(self.btnCancel, QtRoleReject)
 
         # Assemble
         self.outerBox = QVBoxLayout()
@@ -131,7 +139,7 @@ class GuiDocSplit(NDialog):
         self.outerBox.addSpacing(8)
         self.outerBox.addLayout(self.optBox)
         self.outerBox.addSpacing(12)
-        self.outerBox.addWidget(self.buttonBox)
+        self.outerBox.addWidget(self.btnBox)
         self.setLayout(self.outerBox)
 
         # Load Content
@@ -139,11 +147,8 @@ class GuiDocSplit(NDialog):
 
         logger.debug("Ready: GuiDocSplit")
 
-        return
-
     def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiDocSplit")
-        return
 
     def data(self) -> tuple[dict, list[str]]:
         """Return the user's choices. Also save the users options for
@@ -197,7 +202,6 @@ class GuiDocSplit(NDialog):
         """Reload the content of the list box."""
         if sHandle := self._data.get("sHandle"):
             self._loadContent(sHandle)
-        return
 
     ##
     #  Internal Functions

novelwriter/dialogs/editlabel.py

@@ -20,20 +20,23 @@ 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
 
 from PyQt6.QtWidgets import QDialogButtonBox, QHBoxLayout, QLabel, QLineEdit, QVBoxLayout, QWidget
 
+from novelwriter import SHARED
+from novelwriter.enum import nwStandardButton
 from novelwriter.extensions.modified import NDialog
-from novelwriter.types import QtAccepted, QtDialogCancel, QtDialogOk
+from novelwriter.types import QtAccepted, QtRoleAccept, QtRoleReject
 
 logger = logging.getLogger(__name__)
 
 
 class GuiEditLabel(NDialog):
+    """GUI: Edit Item Label Dialog."""
 
     def __init__(self, parent: QWidget, text: str = "") -> None:
         super().__init__(parent=parent)
@@ -53,9 +56,15 @@ class GuiEditLabel(NDialog):
         self.lblValue.setBuddy(self.lblValue)
 
         # Buttons
-        self.buttonBox = QDialogButtonBox(QtDialogOk | QtDialogCancel, self)
-        self.buttonBox.accepted.connect(self.accept)
-        self.buttonBox.rejected.connect(self.reject)
+        self.btnOk = SHARED.theme.getStandardButton(nwStandardButton.OK, self)
+        self.btnOk.clicked.connect(self.accept)
+
+        self.btnCancel = SHARED.theme.getStandardButton(nwStandardButton.CANCEL, self)
+        self.btnCancel.clicked.connect(self.reject)
+
+        self.btnBox = QDialogButtonBox(self)
+        self.btnBox.addButton(self.btnOk, QtRoleAccept)
+        self.btnBox.addButton(self.btnCancel, QtRoleReject)
 
         # Assemble
         self.innerBox = QHBoxLayout()
@@ -66,17 +75,14 @@ class GuiEditLabel(NDialog):
         self.outerBox = QVBoxLayout()
         self.outerBox.setSpacing(12)
         self.outerBox.addLayout(self.innerBox, 1)
-        self.outerBox.addWidget(self.buttonBox, 0)
+        self.outerBox.addWidget(self.btnBox, 0)
 
         self.setLayout(self.outerBox)
 
         logger.debug("Ready: GuiEditLabel")
 
-        return
-
     def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiEditLabel")
-        return
 
     @property
     def itemLabel(self) -> str: