Refactor custom widgets (#1937)

novelwriter/extensions/progressbars.py

@@ -1,9 +1,10 @@
 """
-novelWriter – Custom Widget: Progress Circle
-============================================
+novelWriter – Custom Widget: Progress Bars
+==========================================
 
 File History:
-Created: 2023-06-07 [2.1b1]
+Created: 2023-06-07 [2.1b1] NProgressCircle
+Created: 2023-06-09 [2.1b1] NProgressSimple
 
 This file is a part of novelWriter
 Copyright 2018–2024, Veronica Berglyd Olsen
@@ -101,3 +102,25 @@ class NProgressCircle(QProgressBar):
         painter.setPen(self._tColor)
         painter.drawText(self._cRect, QtAlignCenter, self._text or f"{progress:.1f} %")
         return
+
+
+class NProgressSimple(QProgressBar):
+    """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."""
+        if (value := self.value()) > 0:
+            progress = ceil(self.width()*float(value)/self.maximum())
+            painter = QPainter(self)
+            painter.setRenderHint(QtPaintAnitAlias, True)
+            painter.setPen(self.palette().highlight().color())
+            painter.setBrush(self.palette().highlight())
+            painter.drawRect(0, 0, progress, self.height())
+        return

novelwriter/extensions/simpleprogress.py

@@ -1,53 +0,0 @@
-"""
-novelWriter – Custom Widget: Progress Simple
-============================================
-
-File History:
-Created: 2023-06-09 [2.1b1]
-
-This file is a part of novelWriter
-Copyright 2018–2024, Veronica Berglyd Olsen
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-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/>.
-"""
-from __future__ import annotations
-
-from math import ceil
-
-from PyQt5.QtGui import QPainter, QPaintEvent
-from PyQt5.QtWidgets import QProgressBar, QWidget
-
-from novelwriter.types import QtPaintAnitAlias
-
-
-class NProgressSimple(QProgressBar):
-    """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."""
-        if (value := self.value()) > 0:
-            progress = ceil(self.width()*float(value)/self.maximum())
-            painter = QPainter(self)
-            painter.setRenderHint(QtPaintAnitAlias, True)
-            painter.setPen(self.palette().highlight().color())
-            painter.setBrush(self.palette().highlight())
-            painter.drawRect(0, 0, progress, self.height())
-        return

novelwriter/tools/manusbuild.py

@@ -43,7 +43,7 @@ from novelwriter.core.docbuild import NWBuildDocument
 from novelwriter.core.item import NWItem
 from novelwriter.enum import nwBuildFmt
 from novelwriter.extensions.modified import NDialog, NIconToolButton
-from novelwriter.extensions.simpleprogress import NProgressSimple
+from novelwriter.extensions.progressbars import NProgressSimple
 from novelwriter.types import QtAlignCenter, QtDialogClose, QtRoleAction, QtRoleReject, QtUserRole
 
 logger = logging.getLogger(__name__)

novelwriter/tools/manuscript.py

@@ -44,8 +44,8 @@ from novelwriter.core.buildsettings import BuildCollection, BuildSettings
 from novelwriter.core.docbuild import NWBuildDocument
 from novelwriter.core.tokenizer import HeadingFormatter
 from novelwriter.core.toqdoc import TextDocumentTheme, ToQTextDocument
-from novelwriter.extensions.circularprogress import NProgressCircle
 from novelwriter.extensions.modified import NIconToggleButton, NIconToolButton, NToolDialog
+from novelwriter.extensions.progressbars import NProgressCircle
 from novelwriter.gui.theme import STYLES_FLAT_TABS, STYLES_MIN_TOOLBUTTON
 from novelwriter.tools.manusbuild import GuiManuscriptBuild
 from novelwriter.tools.manussettings import GuiBuildSettings

tests/test_ext/test_ext_progressbars.py

@@ -0,0 +1,78 @@
+"""
+novelWriter – Progress Bar Tester
+=================================
+
+This file is a part of novelWriter
+Copyright 2018–2024, Veronica Berglyd Olsen
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+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/>.
+"""
+from __future__ import annotations
+
+from time import sleep
+
+import pytest
+
+from PyQt5.QtGui import QColor
+
+from novelwriter.extensions.progressbars import NProgressCircle, NProgressSimple
+
+from tests.tools import SimpleDialog
+
+
+@pytest.mark.gui
+def testExtProgressBars_NProgressCircle(qtbot):
+    """Test the NProgressCircle class."""
+    dialog = SimpleDialog()
+    progress = NProgressCircle(dialog, 200, 16)
+
+    with qtbot.waitExposed(dialog):
+        # This ensures the paint event is executed
+        dialog.show()
+
+    dialog.resize(200, 200)
+    progress.setColours(
+        QColor(255, 255, 255), QColor(255, 192, 192),
+        QColor(255, 0, 0), QColor(0, 0, 0),
+    )
+
+    progress.setMaximum(100)
+    for i in range(1, 101):
+        progress.setValue(i)
+        sleep(0.0025)
+        assert progress.value() == i
+
+    progress.setCentreText("Done!")
+    assert progress._text == "Done!"
+
+    # qtbot.stop()
+
+
+@pytest.mark.gui
+def testExtProgressBars_NProgressSimple(qtbot):
+    """Test the NProgressSimple class."""
+    dialog = SimpleDialog()
+    progress = NProgressSimple(dialog)
+
+    with qtbot.waitExposed(dialog):
+        # This ensures the paint event is executed
+        dialog.show()
+
+    progress.setMaximum(100)
+    for i in range(1, 101):
+        progress.setValue(i)
+        sleep(0.0025)
+        assert progress.value() == i
+
+    # qtbot.stop()

tests/test_ext/test_ext_switch.py

@@ -0,0 +1,74 @@
+"""
+novelWriter – Switch Tester
+===========================
+
+This file is a part of novelWriter
+Copyright 2018–2024, Veronica Berglyd Olsen
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+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/>.
+"""
+from __future__ import annotations
+
+import pytest
+
+from PyQt5.QtCore import QEvent, QPoint
+from PyQt5.QtGui import QMouseEvent
+
+from novelwriter.extensions.switch import NSwitch
+from novelwriter.types import QtModNone, QtMouseLeft
+
+from tests.tools import SimpleDialog
+
+
+@pytest.mark.gui
+def testExtSwitch_Main(qtbot):
+    """Test the NSwitch class. This is mostly a check that all the calls
+    work as the result is visual.
+    """
+    dialog = SimpleDialog()
+    switch = NSwitch(dialog, 40)
+
+    with qtbot.waitExposed(dialog):
+        # This ensures the paint event is executed
+        dialog.show()
+
+    dialog.resize(200, 100)
+
+    switch.setEnabled(False)
+    switch.setChecked(False)
+    switch.repaint()
+    qtbot.wait(20)
+
+    switch.setChecked(True)
+    switch.repaint()
+    qtbot.wait(20)
+
+    switch.setEnabled(True)
+    switch.setChecked(False)
+    switch.repaint()
+    qtbot.wait(20)
+
+    switch.setChecked(True)
+    switch.repaint()
+    qtbot.wait(20)
+
+    button = QtMouseLeft
+    modifier = QtModNone
+    event = QMouseEvent(QEvent.Type.MouseButtonRelease, QPoint(), button, button, modifier)
+    switch.mouseReleaseEvent(event)
+
+    event = QEvent(QEvent.Type.Enter)
+    switch.enterEvent(event)
+
+    # qtbot.stop()

tests/tools.py

@@ -204,17 +204,21 @@ def buildTestProject(obj: object, projPath: Path) -> None:
 
 class SimpleDialog(QDialog):
 
-    def __init__(self, widget: QWidget) -> None:
+    def __init__(self, widget: QWidget | None = None) -> None:
         super().__init__()
         self._widget = widget
-
         layout = QVBoxLayout()
-        layout.addWidget(widget)
         layout.setContentsMargins(40, 40, 40, 40)
         self.setLayout(layout)
-
+        if widget:
+            layout.addWidget(widget)
         return
 
     @property
-    def widget(self) -> QWidget:
+    def widget(self) -> QWidget | None:
         return self._widget
+
+    def addWidget(self, widget: QWidget) -> None:
+        self._widget = widget
+        self.layout().addWidget(widget)
+        return