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

novelwriter/extensions/modified.py

@@ -24,15 +24,15 @@ 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
 
 from typing import TYPE_CHECKING
 
 from PyQt6.QtCore import QModelIndex, QSize, Qt, pyqtSignal, pyqtSlot
 from PyQt6.QtWidgets import (
-    QApplication, QComboBox, QDialog, QDoubleSpinBox, QLabel, QSpinBox,
-    QToolButton, QTreeView, QWidget
+    QApplication, QComboBox, QDialog, QDoubleSpinBox, QLabel, QPushButton,
+    QSpinBox, QToolButton, QTreeView, QWidget
 )
 
 from novelwriter import CONFIG, SHARED
@@ -47,6 +47,7 @@ if TYPE_CHECKING:
 
 
 class NDialog(QDialog):
+    """Custom: Modified QDialog."""
 
     def softDelete(self) -> None:
         """Since calling deleteLater is sometimes not safe from Python,
@@ -55,53 +56,54 @@ class NDialog(QDialog):
         so that it gets garbage collected when it runs out of scope.
         """
         self.setParent(None)  # type: ignore
-        return
 
     @pyqtSlot()
     def reject(self) -> None:
         """Overload the reject slot and also call close."""
         super().reject()
         self.close()
-        return
 
 
 class NToolDialog(NDialog):
+    """Custom: Modified QDialog for Tools."""
 
     def __init__(self, parent: GuiMain) -> None:
         super().__init__(parent=parent)
         self.setModal(False)
         if CONFIG.osDarwin:
             self.setWindowFlag(Qt.WindowType.Tool)
-        return
 
     def activateDialog(self) -> None:
-        """Helper function to activate dialog on various systems."""
+        """Activate dialog on various operating systems."""
         self.show()
         if CONFIG.osWindows:
             self.activateWindow()
         self.raise_()
         QApplication.processEvents()
-        return
 
 
 class NNonBlockingDialog(NDialog):
+    """Custom: Modified Non-Blocking QDialog."""
 
     def __init__(self, parent: QWidget | None = None) -> None:
         super().__init__(parent=parent)
         self.setModal(True)
-        return
 
     def activateDialog(self) -> None:
-        """Helper function to activate dialog on various systems."""
+        """Activate dialog on various operating systems."""
         self.show()
         if CONFIG.osWindows:
             self.activateWindow()
         self.raise_()
         QApplication.processEvents()
-        return
 
 
 class NTreeView(QTreeView):
+    """Custom: Modified QTreeView.
+
+    The main purpose is to provide the middleClicked signal that matches
+    clicked and doubleCLicked.
+    """
 
     middleClicked = pyqtSignal(QModelIndex)
 
@@ -116,42 +118,65 @@ class NTreeView(QTreeView):
 
 
 class NComboBox(QComboBox):
+    """Custom: Modified QComboBox.
 
-    def __init__(self, parent: QWidget | None = None) -> None:
+    The main purpose is to provide a combo box that doesn't scroll when
+    the mousewheel is active on it while scrolling through a scrollable
+    window of many widgets.
+    """
+
+    def __init__(self, parent: QWidget | None = None, maxItems: int = 15) -> None:
         super().__init__(parent=parent)
         self.setFocusPolicy(Qt.FocusPolicy.StrongFocus)
-        return
+        self.setMaxVisibleItems(maxItems)
+        self.updateStyle()
 
     def wheelEvent(self, event: QWheelEvent) -> None:
+        """Only capture the mouse wheel if the widget has focus."""
         if self.hasFocus():
             super().wheelEvent(event)
         else:
             event.ignore()
-        return
 
     def setCurrentData(self, data: str | int | Enum, default: str | int | Enum) -> None:
         """Set the current index from data, with a fallback."""
         idx = self.findData(data)
         self.setCurrentIndex(self.findData(default) if idx < 0 else idx)
-        return
+
+    def updateStyle(self) -> None:
+        """Update the style sheet."""
+        # The style sheet disables Fusion style pop-up mode on some
+        # platforms and allows for scrolling of long lists of items
+        self.setStyleSheet("QComboBox {combobox-popup: 0;}")
 
 
 class NSpinBox(QSpinBox):
+    """Custom: Modified QSpinBox.
+
+    The main purpose is to provide a spin box that doesn't scroll when
+    the mousewheel is active on it while scrolling through a scrollable
+    window of many widgets.
+    """
 
     def __init__(self, parent: QWidget | None = None) -> None:
         super().__init__(parent=parent)
         self.setFocusPolicy(Qt.FocusPolicy.StrongFocus)
-        return
 
     def wheelEvent(self, event: QWheelEvent) -> None:
+        """Only capture the mouse wheel if the widget has focus."""
         if self.hasFocus():
             super().wheelEvent(event)
         else:
             event.ignore()
-        return
 
 
 class NDoubleSpinBox(QDoubleSpinBox):
+    """Custom: Modified QDoubleSpinBox.
+
+    The main purpose is to provide a float spin box that doesn't scroll
+    when the mousewheel is active on it while scrolling through a
+    scrollable window of many widgets.
+    """
 
     def __init__(
         self,
@@ -168,17 +193,43 @@ class NDoubleSpinBox(QDoubleSpinBox):
         self.setMaximum(maxVal)
         self.setSingleStep(step)
         self.setDecimals(prec)
-        return
 
     def wheelEvent(self, event: QWheelEvent) -> None:
+        """Only capture the mouse wheel if the widget has focus."""
         if self.hasFocus():
             super().wheelEvent(event)
         else:
             event.ignore()
-        return
+
+
+class NPushButton(QPushButton):
+    """Custom: Modified QPushButton.
+
+    A quicker way to create a push button using the app theme.
+    """
+
+    def __init__(
+        self, parent: QWidget, text: str, iconSize: QSize,
+        icon: str | None = None, color: str | None = None
+    ) -> None:
+        super().__init__(parent=parent)
+        self._icon = icon
+        self._color = color
+        self.setText(text)
+        self.setIconSize(iconSize)
+        self.updateIcon()
+
+    def updateIcon(self) -> None:
+        """Update the theme icon."""
+        if self._icon and self._color:
+            self.setIcon(SHARED.theme.getIcon(self._icon, self._color))
 
 
 class NIconToolButton(QToolButton):
+    """Custom: Modified QToolButton.
+
+    A quicker way to create a tool button using the app theme.
+    """
 
     def __init__(
         self, parent: QWidget, iconSize: QSize,
@@ -188,37 +239,41 @@ class NIconToolButton(QToolButton):
         self.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
         self.setIconSize(iconSize)
         self.setPopupMode(QToolButton.ToolButtonPopupMode.InstantPopup)
-        if icon:
+        if icon and color:
             self.setThemeIcon(icon, color)
-        return
 
-    def setThemeIcon(self, iconKey: str, color: str | None = None) -> None:
+    def setThemeIcon(self, icon: str, color: str) -> None:
         """Set an icon from the current theme."""
-        self.setIcon(SHARED.theme.getIcon(iconKey, color))
-        return
+        self.setIcon(SHARED.theme.getIcon(icon, color))
 
 
 class NIconToggleButton(QToolButton):
+    """Custom: Modified QToolButton.
 
-    def __init__(self, parent: QWidget, iconSize: QSize, icon: str | None = None) -> None:
+    A quicker way to create a toggle button using the app theme.
+    """
+
+    def __init__(
+        self, parent: QWidget, iconSize: QSize,
+        icon: str | None = None, color: str | None = None
+    ) -> None:
         super().__init__(parent=parent)
         self.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
         self.setIconSize(iconSize)
         self.setPopupMode(QToolButton.ToolButtonPopupMode.InstantPopup)
         self.setCheckable(True)
         self.setStyleSheet("border: none; background: transparent;")
-        if icon:
-            self.setThemeIcon(icon)
-        return
+        if icon and color:
+            self.setThemeIcon(icon, color)
 
-    def setThemeIcon(self, iconKey: str) -> None:
+    def setThemeIcon(self, icon: str, color: str) -> None:
         """Set an icon from the current theme."""
-        iconSize = self.iconSize()
-        self.setIcon(SHARED.theme.getToggleIcon(iconKey, (iconSize.width(), iconSize.height())))
-        return
+        size = self.iconSize()
+        self.setIcon(SHARED.theme.getToggleIcon(icon, (size.width(), size.height()), color))
 
 
 class NClickableLabel(QLabel):
+    """Custom: Clickable QLabel."""
 
     mouseClicked = pyqtSignal()
 

novelwriter/extensions/novelselector.py

@@ -20,23 +20,30 @@ 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 typing import TYPE_CHECKING
+
 from PyQt6.QtCore import pyqtSignal, pyqtSlot
 from PyQt6.QtGui import QPalette
-from PyQt6.QtWidgets import QComboBox, QWidget
+from PyQt6.QtWidgets import QComboBox
 
 from novelwriter import SHARED
 from novelwriter.constants import nwLabels
 from novelwriter.enum import nwItemClass
+from novelwriter.types import QtColDisabled
+
+if TYPE_CHECKING:
+    from PyQt6.QtWidgets import QWidget
 
 logger = logging.getLogger(__name__)
 
 
 class NovelSelector(QComboBox):
+    """Custom: Novel Root Folder Selector."""
 
     novelSelectionChanged = pyqtSignal(str)
 
@@ -48,7 +55,6 @@ class NovelSelector(QComboBox):
         self._listFormat = None
         self.currentIndexChanged.connect(self._indexChanged)
         self.updateTheme()
-        return
 
     ##
     #  Properties
@@ -75,26 +81,24 @@ class NovelSelector(QComboBox):
             self._blockSignal = blockSignal
             self.setCurrentIndex(index)
             self._blockSignal = False
-        return
 
     def setIncludeAll(self, value: bool) -> None:
         """Set flag to add an "All Novel Folders" option."""
         self._includeAll = value
-        return
 
     def setListFormat(self, value: str | None) -> None:
         """Set a format string for the list entries."""
         if value is None or "{0}" in value:
             self._listFormat = value
-        return
 
     def updateTheme(self) -> None:
         """Update theme colours."""
         palette = self.palette()
-        palette.setBrush(QPalette.ColorGroup.Disabled, QPalette.ColorRole.Text, palette.text())
+        palette.setBrush(QtColDisabled, QPalette.ColorRole.Text, palette.text())
+        palette.setBrush(QtColDisabled, QPalette.ColorRole.WindowText, palette.windowText())
+        palette.setBrush(QtColDisabled, QPalette.ColorRole.ButtonText, palette.buttonText())
         self.setPalette(palette)
         self.refreshNovelList()
-        return
 
     ##
     #  Public Slots
@@ -109,7 +113,7 @@ class NovelSelector(QComboBox):
         self._firstHandle = None
         self.clear()
 
-        icon = SHARED.theme.getIcon(nwLabels.CLASS_ICON[nwItemClass.NOVEL], "blue")
+        icon = SHARED.theme.getIcon(nwLabels.CLASS_ICON[nwItemClass.NOVEL], "root")
         for tHandle, nwItem in SHARED.project.tree.iterRoots(nwItemClass.NOVEL):
             if self._listFormat:
                 name = self._listFormat.format(nwItem.itemName)
@@ -128,8 +132,6 @@ class NovelSelector(QComboBox):
         self.setEnabled(self.count() > 1)
         self._blockSignal = False
 
-        return
-
     ##
     #  Private Slots
     ##
@@ -139,4 +141,3 @@ class NovelSelector(QComboBox):
         """Re-emit the change of selection signal, unless blocked."""
         if not self._blockSignal:
             self.novelSelectionChanged.emit(self.currentData())
-        return

novelwriter/extensions/pagedsidebar.py

@@ -22,7 +22,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
 
 from PyQt6.QtCore import QPoint, QRectF, QSize, Qt, pyqtSignal, pyqtSlot
@@ -39,7 +39,7 @@ from novelwriter.types import (
 
 
 class NPagedSideBar(QToolBar):
-    """Extensions: Paged Side Bar
+    """Extensions: Paged Side Bar.
 
     A side bar widget that holds buttons that mimic tabs. It is designed
     to be used in combination with a QStackedWidget for options panels.
@@ -65,8 +65,6 @@ class NPagedSideBar(QToolBar):
         stretch.setSizePolicy(QtSizeExpanding, QtSizeExpanding)
         self._stretchAction = self.addWidget(stretch)
 
-        return
-
     def button(self, buttonId: int) -> _PagedToolButton:
         """Return a specific button."""
         return self._buttons[buttonId]
@@ -74,14 +72,15 @@ class NPagedSideBar(QToolBar):
     def setLabelColor(self, color: QColor) -> None:
         """Set the text color for the labels."""
         self._labelCol = color
-        return
+        for widget in self.children():
+            if isinstance(widget, _NPagedToolLabel):
+                widget.setTextColor(color)
 
     def addLabel(self, text: str) -> None:
         """Add a new label to the toolbar."""
         label = _NPagedToolLabel(self, self._labelCol)
         label.setText(text)
         self.insertWidget(self._stretchAction, label)
-        return
 
     def addButton(self, text: str, buttonId: int = -1) -> None:
         """Add a new button to the toolbar."""
@@ -90,13 +89,11 @@ class NPagedSideBar(QToolBar):
         self.insertWidget(self._stretchAction, button)
         self._group.addButton(button, id=buttonId)
         self._buttons[buttonId] = button
-        return
 
     def setSelected(self, buttonId: int) -> None:
         """Set the selected button."""
         if button := self._group.button(buttonId):
             button.setChecked(True)
-        return
 
     ##
     #  Private Slots
@@ -104,11 +101,10 @@ class NPagedSideBar(QToolBar):
 
     @pyqtSlot("QAbstractButton*")
     def _buttonClicked(self, button: QAbstractButton) -> None:
-        """A button was clicked in the group, emit its id."""
+        """Handle a button click in the group and emit its id."""
         buttonId = self._group.id(button)
         if buttonId != -1:
             self.buttonClicked.emit(buttonId)
-        return
 
 
 class _PagedToolButton(QToolButton):
@@ -127,8 +123,6 @@ class _PagedToolButton(QToolButton):
         self._aH = 2*fH//7
         self.setFixedHeight(self._bH)
 
-        return
-
     def sizeHint(self) -> QSize:
         """Return a size hint that includes the arrow."""
         return super().sizeHint() + QSize(4*self._aH, 0)
@@ -156,7 +150,7 @@ class _PagedToolButton(QToolButton):
 
         if self.isChecked():
             painter.setBrush(palette.highlight())
-            painter.setOpacity(0.35)
+            painter.setOpacity(0.8)
             painter.drawRoundedRect(0, 0, width, height, 4, 4)
             textCol = palette.highlightedText().color()
         else:
@@ -180,8 +174,6 @@ class _PagedToolButton(QToolButton):
         ]))
         painter.end()
 
-        return
-
 
 class _NPagedToolLabel(QLabel):
 
@@ -199,7 +191,9 @@ class _NPagedToolLabel(QLabel):
 
         self._textCol = textColor or self.palette().text().color()
 
-        return
+    def setTextColor(self, textColor: QColor | None = None) -> None:
+        """Set a new text colour."""
+        self._textCol = textColor or self.palette().text().color()
 
     def paintEvent(self, event: QPaintEvent) -> None:
         """Overload the paint event to draw a simple, left aligned text
@@ -215,5 +209,3 @@ class _NPagedToolLabel(QLabel):
         painter.setOpacity(1.0)
         painter.drawText(QRectF(4, self._tM, tW, tH), QtAlignLeft, self.text())
         painter.end()
-
-        return

novelwriter/extensions/progressbars.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
 
 from math import ceil
@@ -37,7 +37,7 @@ from novelwriter.types import (
 
 
 class NProgressCircle(QProgressBar):
-    """Extension: Circular Progress Widget
+    """Extension: Circular Progress Widget.
 
     A custom widget that paints a circular progress indicator instead of
     a straight bar. It is also possible to set custom text for iṫ.
@@ -64,7 +64,6 @@ class NProgressCircle(QProgressBar):
         self.setSizePolicy(QtSizeFixed, QtSizeFixed)
         self.setFixedWidth(size)
         self.setFixedHeight(size)
-        return
 
     def setColors(
         self, back: QColor | None = None, track: QColor | None = None,
@@ -80,16 +79,14 @@ class NProgressCircle(QProgressBar):
             self._bPen = QPen(QBrush(track), self._point, QtSolidLine, QtRoundCap)
         if isinstance(text, QColor):
             self._tColor = text
-        return
 
     def setCentreText(self, text: str | None) -> None:
         """Replace the progress text with a custom string."""
         self._text = text
         self.setValue(self.value())  # Triggers a redraw
-        return
 
     def paintEvent(self, event: QPaintEvent) -> None:
-        """Custom painter for the progress bar."""
+        """Paint the progress bar."""
         progress = 100.0*self.value()/self.maximum()
         angle = ceil(16*3.6*progress)
         painter = QPainter(self)
@@ -103,21 +100,19 @@ class NProgressCircle(QProgressBar):
         painter.drawArc(self._cRect, 90*16, -angle)
         painter.setPen(self._tColor)
         painter.drawText(self._cRect, QtAlignCenter, self._text or f"{progress:.1f} %")
-        return
 
 
 class NProgressSimple(QProgressBar):
-    """Extension: Simple Progress Widget
+    """Extension: Simple Progress Widget.
 
     A custom widget that paints a plain bar with no other styling.
     """
 
     def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
-        return
 
     def paintEvent(self, event: QPaintEvent) -> None:
-        """Custom painter for the progress bar."""
+        """Paint the progress bar."""
         if (value := self.value()) > 0:
             progress = ceil(self.width()*float(value)/self.maximum())
             painter = QPainter(self)
@@ -125,4 +120,3 @@ class NProgressSimple(QProgressBar):
             painter.setPen(self.palette().highlight().color())
             painter.setBrush(self.palette().highlight())
             painter.drawRect(0, 0, progress, self.height())
-        return

novelwriter/extensions/statusled.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
@@ -34,6 +34,7 @@ logger = logging.getLogger(__name__)
 
 
 class StatusLED(QAbstractButton):
+    """Custom: LED Style Indicator."""
 
     __slots__ = ("_color", "_negative", "_neutral", "_postitve", "_state")
 
@@ -46,7 +47,6 @@ class StatusLED(QAbstractButton):
         self._state = None
         self.setFixedWidth(sW)
         self.setFixedHeight(sH)
-        return
 
     @property
     def state(self) -> bool | None:
@@ -59,7 +59,6 @@ class StatusLED(QAbstractButton):
         self._postitve = positive
         self._negative = negative
         self.setState(self._state)
-        return
 
     def setState(self, state: bool | None) -> None:
         """Set the colour state."""
@@ -71,15 +70,13 @@ class StatusLED(QAbstractButton):
             self._color = self._neutral
         self._state = state
         self.update()
-        return
 
     def paintEvent(self, event: QPaintEvent) -> None:
         """Draw the LED."""
         painter = QPainter(self)
         painter.setRenderHint(QtPaintAntiAlias, True)
-        painter.setPen(self.palette().text().color())
+        painter.setPen(self.palette().light().color())
         painter.setBrush(self._color)
         painter.setOpacity(1.0)
         painter.drawEllipse(1, 1, self.width() - 2, self.height() - 2)
         painter.end()
-        return

novelwriter/extensions/switch.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
 
 from PyQt6.QtCore import QPropertyAnimation, Qt, pyqtProperty, pyqtSlot  # pyright: ignore
@@ -32,6 +32,7 @@ from novelwriter.types import QtNoPen, QtPaintAntiAlias, QtSizeFixed
 
 
 class NSwitch(QAbstractButton):
+    """Custom: Toggle Switch."""
 
     __slots__ = ("_offset", "_rH", "_rR", "_xH", "_xR", "_xW")
 
@@ -48,12 +49,11 @@ class NSwitch(QAbstractButton):
         self.setSizePolicy(QtSizeFixed, QtSizeFixed)
         self.setFixedWidth(self._xW)
         self.setFixedHeight(self._xH)
+        self.setUpdatesEnabled(True)
         self._offset = self._xR
 
         self.clicked.connect(self._onClick)
 
-        return
-
     ##
     #  Properties
     ##
@@ -66,7 +66,6 @@ class NSwitch(QAbstractButton):
     def offset(self, offset: int) -> None:
         self._offset = offset
         self.update()
-        return
 
     ##
     #  Getters and Setters
@@ -76,7 +75,6 @@ class NSwitch(QAbstractButton):
         """Overload setChecked to also alter the offset."""
         super().setChecked(checked)
         self._offset = (self._xW - self._xR) if checked else self._xR
-        return
 
     ##
     #  Events
@@ -86,7 +84,6 @@ class NSwitch(QAbstractButton):
         """Overload resize to ensure correct offset."""
         super().resizeEvent(event)
         self._offset = (self._xW - self._xR) if self.isChecked() else self._xR
-        return
 
     def paintEvent(self, event: QPaintEvent) -> None:
         """Drawing the switch itself."""
@@ -97,7 +94,7 @@ class NSwitch(QAbstractButton):
         painter.setOpacity(1.0 if self.isEnabled() else 0.5)
 
         painter.setPen(palette.highlight().color() if self.hasFocus() else palette.mid().color())
-        painter.setBrush(palette.highlight() if self.isChecked() else palette.alternateBase())
+        painter.setBrush(SHARED.theme.accentCol if self.isChecked() else palette.alternateBase())
         painter.drawRoundedRect(0, 0, self._xW, self._xH, self._xR, self._xR)
 
         painter.setPen(QtNoPen)
@@ -106,13 +103,14 @@ class NSwitch(QAbstractButton):
 
         painter.end()
 
-        return
-
     def enterEvent(self, event: QEnterEvent) -> None:
         """Change the cursor when hovering the button."""
         self.setCursor(Qt.CursorShape.PointingHandCursor)
         super().enterEvent(event)
-        return
+
+    ##
+    #  Internal Functions
+    ##
 
     @pyqtSlot(bool)
     def _onClick(self, checked: bool) -> None:
@@ -122,4 +120,3 @@ class NSwitch(QAbstractButton):
         anim.setStartValue(self._offset)
         anim.setEndValue((self._xW - self._xR) if checked else self._xR)
         anim.start()
-        return