novelWriter 2.2rc1__py3-none-any.whl → 2.3__py3-none-any.whl

novelwriter/extensions/configlayout.py

@@ -3,10 +3,13 @@ novelWriter – Custom Widget: Config Layout
 ==========================================
 
 File History:
-Created: 2020-05-03 [0.4.5]
+Created: 2020-05-03 [0.4.5] NColourLabel
+Created: 2024-01-08 [2.3b1] NScrollableForm
+Created: 2024-01-26 [2.3b1] NScrollablePage
+Created: 2024-01-26 [2.3b1] NFixedPage
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+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
@@ -23,210 +26,246 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-from PyQt5.QtGui import QColor, QPalette
+from PyQt5.QtGui import QColor, QFont, QPalette
 from PyQt5.QtCore import Qt
 from PyQt5.QtWidgets import (
-    QAbstractButton, QGridLayout, QHBoxLayout, QLabel, QLineEdit, QSizePolicy,
+    QAbstractButton, QFrame, QHBoxLayout, QLabel, QLayout, QScrollArea,
     QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG
 
-FONT_SCALE = 0.9
+DEFAULT_SCALE = 0.9
+RIGHT_TOP = Qt.AlignmentFlag.AlignRight | Qt.AlignmentFlag.AlignTop
+LEFT_TOP = Qt.AlignmentFlag.AlignLeft | Qt.AlignmentFlag.AlignTop
 
 
-class NConfigLayout(QGridLayout):
+class NFixedPage(QFrame):
+    """Extension: Fixed Page Widget
 
-    def __init__(self) -> None:
-        super().__init__()
+    A custom widget that holds a layout. This is just a wrapper around a
+    QFrame that sets the same frame style as the other Page widgets.
+    """
 
-        self._nextRow = 0
-        self._helpCol = QColor(0, 0, 0)
-        self._fontScale = FONT_SCALE
-        self._itemMap = {}
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
+        self.setFrameShadow(QFrame.Shadow.Sunken)
+        self.setFrameShape(QFrame.Shape.StyledPanel)
+        return
 
-        wSp = CONFIG.pxInt(8)
-        self.setHorizontalSpacing(wSp)
-        self.setVerticalSpacing(wSp)
-        self.setColumnStretch(0, 1)
+    def setCentralLayout(self, layout: QLayout) -> None:
+        """Set a layout as the central object."""
+        self.setLayout(layout)
+        return
 
+    def setCentralWidget(self, widget: QWidget) -> None:
+        """Set a layout as the central object."""
+        layout = QHBoxLayout()
+        layout.addWidget(widget)
+        self.setLayout(layout)
         return
 
-    ##
-    #  Getters and Setters
-    ##
+# END Class NFixedPage
 
-    def setHelpTextStyle(self, color: QColor | list | tuple,
-                         fontScale: float = FONT_SCALE) -> None:
-        """Set the text color for the help text."""
-        if isinstance(color, QColor):
-            self._helpCol = color
-        else:
-            self._helpCol = QColor(*color)
-        self._fontScale = fontScale
-        return
 
-    def setHelpText(self, row: int, text: str) -> None:
-        """Set the text for the help label."""
-        if row in self._itemMap:
-            qHelp = self._itemMap[row][1]
-            if isinstance(qHelp, NHelpLabel):
-                qHelp.setText(text)
+class NScrollablePage(QScrollArea):
+    """Extension: Scrollable Page Widget
+
+    A custom widget that holds a layout within a scrollable area.
+    """
+
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
+        self._widget = QWidget(self)
+        self.setWidget(self._widget)
+        self.setWidgetResizable(True)
+        self.setHorizontalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
+        self.setVerticalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
+        self.setFrameShadow(QFrame.Shadow.Sunken)
+        self.setFrameShape(QFrame.Shape.StyledPanel)
         return
 
-    def setLabelText(self, row: int, text: str) -> None:
-        """Set the text for the main label."""
-        if row in self._itemMap:
-            self._itemMap[row](0).setText(text)
+    def setCentralLayout(self, layout: QLayout) -> None:
+        """Set the central layout of the scroll page."""
+        self._widget.setLayout(layout)
         return
 
-    ##
-    #  Class Methods
-    ##
+# END Class NScrollablePage
 
-    def addGroupLabel(self, label: str) -> None:
-        """Add a text label to separate groups of settings."""
-        hM = CONFIG.pxInt(4)
-        qLabel = QLabel("<b>%s</b>" % label)
-        qLabel.setContentsMargins(0, hM, 0, hM)
-        self.addWidget(qLabel, self._nextRow, 0, 1, 2, Qt.AlignLeft)
-        self.setRowStretch(self._nextRow, 0)
-        self.setRowStretch(self._nextRow + 1, 1)
-        self._nextRow += 1
-        return
 
-    def addRow(self, label: str, widget: QWidget, helpText: str | None = None,
-               unit: str | None = None, button: QWidget | None = None) -> int:
-        """Add a label and a widget as a new row of the grid."""
-        wSp = CONFIG.pxInt(8)
-        qLabel = QLabel(label)
-        qLabel.setIndent(wSp)
-        qLabel.setBuddy(widget)
+class NScrollableForm(QScrollArea):
+    """Extension: Scrollable Form Widget
 
-        qHelp = None
-        if helpText is not None:
-            qHelp = NHelpLabel(str(helpText), self._helpCol, self._fontScale)
-            qHelp.setIndent(wSp)
-            labelBox = QVBoxLayout()
-            labelBox.addWidget(qLabel)
-            labelBox.addWidget(qHelp)
-            labelBox.setSpacing(0)
-            labelBox.addStretch(1)
-            self.addLayout(labelBox, self._nextRow, 0, 1, 1, Qt.AlignLeft | Qt.AlignTop)
-        else:
-            self.addWidget(qLabel, self._nextRow, 0, 1, 1, Qt.AlignLeft | Qt.AlignTop)
+    A custom widget that creates a form within a scrollable area.
+    """
 
-        if isinstance(unit, str):
-            controlBox = QHBoxLayout()
-            controlBox.addWidget(widget, 0, Qt.AlignVCenter)
-            controlBox.addWidget(QLabel(unit), 0, Qt.AlignVCenter)
-            controlBox.setSpacing(wSp)
-            self.addLayout(controlBox, self._nextRow, 1, 1, 1, Qt.AlignRight | Qt.AlignTop)
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
+        self._helpCol = QColor(0, 0, 0)
+        self._fontScale = DEFAULT_SCALE
+        self._first = True
+        self._indent = CONFIG.pxInt(12)
 
-        elif isinstance(button, QAbstractButton):
-            controlBox = QHBoxLayout()
-            controlBox.addWidget(widget, 0, Qt.AlignVCenter)
-            controlBox.addWidget(button, 0, Qt.AlignVCenter)
-            controlBox.setSpacing(wSp)
-            self.addLayout(controlBox, self._nextRow, 1, 1, 1, Qt.AlignRight | Qt.AlignTop)
+        self._sections: dict[int, QLabel] = {}
+        self._editable: dict[str, NColourLabel] = {}
+        self._index: dict[str, QWidget] = {}
 
-        else:
-            if isinstance(widget, QLineEdit):
-                qLayout = QHBoxLayout()
-                qLayout.addWidget(widget)
-                self.addLayout(qLayout, self._nextRow, 1, 1, 1, Qt.AlignRight | Qt.AlignTop)
-            else:
-                self.addWidget(widget, self._nextRow, 1, 1, 1, Qt.AlignRight | Qt.AlignTop)
+        self._layout = QVBoxLayout()
+        self._layout.setSpacing(CONFIG.pxInt(12))
 
-        self.setRowStretch(self._nextRow, 0)
-        self.setRowStretch(self._nextRow+1, 1)
+        self._widget = QWidget(self)
+        self._widget.setLayout(self._layout)
 
-        self._itemMap[self._nextRow] = (qLabel, qHelp, widget)
-        self._nextRow += 1
+        self.setWidget(self._widget)
+        self.setWidgetResizable(True)
+        self.setHorizontalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
+        self.setVerticalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
+        self.setFrameShadow(QFrame.Shadow.Sunken)
+        self.setFrameShape(QFrame.Shape.StyledPanel)
 
-        return self._nextRow - 1
+        return
 
-# END Class NConfigLayout
+    ##
+    #  Properties
+    ##
 
+    @property
+    def labels(self) -> list[str]:
+        return list(self._index.keys())
 
-class NSimpleLayout(QGridLayout):
-    """Similar to NConfigLayout, but only has a label + widget two
-    column layout.
-    """
+    ##
+    #  Setters
+    ##
 
-    def __init__(self) -> None:
-        super().__init__()
-        self._nextRow = 0
+    def setHelpTextStyle(self, color: QColor, scale: float = DEFAULT_SCALE) -> None:
+        """Set the text color for the help text."""
+        self._helpCol = color
+        self._fontScale = scale
+        return
 
-        wSp = CONFIG.pxInt(8)
-        self.setHorizontalSpacing(wSp)
-        self.setVerticalSpacing(wSp)
-        self.setColumnStretch(0, 1)
+    def setHelpText(self, key: str, text: str) -> None:
+        """Set the text for the help label."""
+        if qHelp := self._editable.get(key):
+            qHelp.setText(text)
+        return
 
+    def setRowIndent(self, indent: int) -> None:
+        """Set the indentation of each row."""
+        self._indent = max(indent, 0)
         return
 
     ##
     #  Methods
     ##
 
-    def addGroupLabel(self, label: str) -> None:
+    def scrollToSection(self, identifier: int) -> None:
+        """Scroll to the requested section identifier."""
+        if identifier in self._sections:
+            yPos = self._sections[identifier].pos().y() - CONFIG.pxInt(8)
+            self.verticalScrollBar().setValue(yPos)
+        return
+
+    def scrollToLabel(self, label: str) -> None:
+        """Scroll to the requested label."""
+        if label in self._index:
+            yPos = self._index[label].pos().y() - CONFIG.pxInt(8)
+            self.verticalScrollBar().setValue(yPos)
+        return
+
+    def addGroupLabel(self, label: str, identifier: int | None = None) -> None:
         """Add a text label to separate groups of settings."""
         hM = CONFIG.pxInt(4)
-        qLabel = QLabel("<b>%s</b>" % label)
+        qLabel = QLabel(f"<b>{label}</b>", self)
         qLabel.setContentsMargins(0, hM, 0, hM)
-        self.addWidget(qLabel, self._nextRow, 0, 1, 2, Qt.AlignLeft)
-        self.setRowStretch(self._nextRow, 0)
-        self.setRowStretch(self._nextRow + 1, 1)
-        self._nextRow += 1
+        if not self._first:
+            self._layout.addSpacing(5*hM)
+        self._layout.addWidget(qLabel)
+        self._first = False
+        if identifier is not None:
+            self._sections[identifier] = qLabel
         return
 
-    def addRow(self, label: str, widget: QWidget) -> None:
-        """Add a label and a widget as a new row of the grid."""
-        wSp = CONFIG.pxInt(8)
-        qLabel = QLabel(label)
-        qLabel.setIndent(wSp)
-        self.addWidget(qLabel, self._nextRow, 0, 1, 1, Qt.AlignLeft | Qt.AlignTop)
-
-        if isinstance(widget, QLineEdit):
-            qLayout = QHBoxLayout()
-            qLayout.addWidget(widget)
-            self.addLayout(qLayout, self._nextRow, 1, 1, 1, Qt.AlignRight | Qt.AlignTop)
-        else:
-            self.addWidget(widget, self._nextRow, 1, 1, 1, Qt.AlignRight | Qt.AlignTop)
+    def addRow(self, label: str, widget: QWidget, helpText: str = "", unit: str | None = None,
+               button: QWidget | None = None, editable: str | None = None,
+               stretch: tuple[int, int] = (1, 0)) -> None:
+        """Add a label and a widget as a new row of the form."""
+        row = QHBoxLayout()
+        row.setSpacing(CONFIG.pxInt(12))
 
+        qLabel = QLabel(label, self)
+        qLabel.setIndent(self._indent)
         qLabel.setBuddy(widget)
 
-        self.setRowStretch(self._nextRow, 0)
-        self.setRowStretch(self._nextRow+1, 1)
-        self._nextRow += 1
+        if helpText:
+            qHelp = NColourLabel(
+                str(helpText), color=self._helpCol, parent=self,
+                scale=self._fontScale, wrap=True, indent=self._indent
+            )
+            labelBox = QVBoxLayout()
+            labelBox.addWidget(qLabel, 0)
+            labelBox.addWidget(qHelp, 1)
+            labelBox.setSpacing(0)
+            row.addLayout(labelBox, stretch[0])
+            if editable:
+                self._editable[editable] = qHelp
+        else:
+            row.addWidget(qLabel, stretch[0])
 
+        if isinstance(unit, str):
+            box = QHBoxLayout()
+            box.addWidget(widget, 1)
+            box.addWidget(QLabel(unit, self), 0)
+            row.addLayout(box, stretch[1])
+        elif isinstance(button, QAbstractButton):
+            box = QHBoxLayout()
+            box.addWidget(widget, 1)
+            box.addWidget(button, 0)
+            row.addLayout(box, stretch[1])
+        else:
+            row.addWidget(widget, stretch[1])
+
+        self._layout.addLayout(row)
+        self._index[label.strip()] = widget
+        self._first = False
+
+        return
+
+    def finalise(self) -> None:
+        """Finalise the layout when the form is built."""
+        self._layout.addSpacing(CONFIG.pxInt(20))
+        self._layout.addStretch(1)
         return
 
-# END Class NSimpleLayout
+# END Class NScrollableForm
 
 
-class NHelpLabel(QLabel):
+class NColourLabel(QLabel):
+    """Extension: A Coloured Label
 
-    def __init__(self, text: str, color: QColor | list | tuple,
-                 fontSize: float = FONT_SCALE) -> None:
-        super().__init__(text)
+    A custom widget that draws a label in a specific colour, and
+    optionally at a specific size, and word wrapped.
+    """
 
-        if isinstance(color, QColor):
-            qCol = color
-        else:
-            qCol = QColor(*color)
+    HELP_SCALE = DEFAULT_SCALE
+    HEADER_SCALE = 1.25
 
-        lblCol = self.palette()
-        lblCol.setColor(QPalette.WindowText, qCol)
-        self.setPalette(lblCol)
+    def __init__(self, text: str, color: QColor | None = None, parent: QWidget | None = None,
+                 scale: float = HELP_SCALE, wrap: bool = False, indent: int = 0,
+                 bold: bool = False) -> None:
+        super().__init__(text, parent=parent)
 
-        lblFont = self.font()
-        lblFont.setPointSizeF(fontSize*lblFont.pointSizeF())
-        self.setFont(lblFont)
+        font = self.font()
+        font.setPointSizeF(scale*font.pointSizeF())
+        font.setWeight(QFont.Weight.Bold if bold else QFont.Weight.Normal)
+        if color:
+            colour = self.palette()
+            colour.setColor(QPalette.WindowText, color)
+            self.setPalette(colour)
 
-        self.setWordWrap(True)
-        self.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
+        self.setFont(font)
+        self.setIndent(indent)
+        self.setWordWrap(wrap)
 
         return
 
-# END Class NHelpLabel
+# END Class NColourLabel

novelwriter/extensions/{wheeleventfilter.py → eventfilters.py}

@@ -1,12 +1,13 @@
 """
-novelWriter – Custom Object: Wheel Event Filter
-===============================================
+novelWriter – Custom Objects: Event Filters
+===========================================
 
 File History:
-Created: 2023-08-31 [2.1rc1]
+Created: 2023-08-31 [2.1rc1] WheelEventFilter
+Created: 2023-11-28 [2.2]    StatusTipFilter
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+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
@@ -23,7 +24,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-from PyQt5.QtGui import QWheelEvent
+from PyQt5.QtGui import QStatusTipEvent, QWheelEvent
 from PyQt5.QtCore import QEvent, QObject
 from PyQt5.QtWidgets import QWidget
 
@@ -63,3 +64,12 @@ class WheelEventFilter(QObject):
         return False
 
 # END Class WheelEventFilter
+
+
+class StatusTipFilter(QObject):
+
+    def eventFilter(self, obj: QObject, event: QEvent) -> bool:
+        """Filter out status tip events on menus."""
+        return True if isinstance(event, QStatusTipEvent) else super().eventFilter(obj, event)
+
+# END Class StatusTipFilter

novelwriter/extensions/modified.py

@@ -0,0 +1,81 @@
+"""
+novelWriter – Custom Widget: Modified Widgets
+=============================================
+
+File History:
+Created: 2024-02-01 [2.3b1] NComboBox
+Created: 2024-02-01 [2.3b1] NSpinBox
+Created: 2024-02-01 [2.3b1] NDoubleSpinBox
+
+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 PyQt5.QtCore import Qt
+from PyQt5.QtGui import QWheelEvent
+from PyQt5.QtWidgets import QComboBox, QDoubleSpinBox, QSpinBox, QWidget
+
+
+class NComboBox(QComboBox):
+
+    def __init__(self, parent: QWidget | None = None) -> None:
+        super().__init__(parent=parent)
+        self.setFocusPolicy(Qt.FocusPolicy.StrongFocus)
+        return
+
+    def wheelEvent(self, event: QWheelEvent) -> None:
+        if self.hasFocus():
+            super().wheelEvent(event)
+        else:
+            event.ignore()
+        return
+
+# END Class NComboBox
+
+
+class NSpinBox(QSpinBox):
+
+    def __init__(self, parent: QWidget | None = None) -> None:
+        super().__init__(parent=parent)
+        self.setFocusPolicy(Qt.FocusPolicy.StrongFocus)
+        return
+
+    def wheelEvent(self, event: QWheelEvent) -> None:
+        if self.hasFocus():
+            super().wheelEvent(event)
+        else:
+            event.ignore()
+        return
+
+# END Class NSpinBox
+
+
+class NDoubleSpinBox(QDoubleSpinBox):
+
+    def __init__(self, parent: QWidget | None = None) -> None:
+        super().__init__(parent=parent)
+        self.setFocusPolicy(Qt.FocusPolicy.StrongFocus)
+        return
+
+    def wheelEvent(self, event: QWheelEvent) -> None:
+        if self.hasFocus():
+            super().wheelEvent(event)
+        else:
+            event.ignore()
+        return
+
+# END Class NDoubleSpinBox

novelwriter/extensions/novelselector.py

@@ -3,10 +3,10 @@ novelWriter – Custom Widget: Novel Selector
 ===========================================
 
 File History:
-Created: 2022-11-17 [2.0]
+Created: 2022-11-17 [2.0] NovelSelector
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+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
@@ -43,6 +43,8 @@ class NovelSelector(QComboBox):
         super().__init__(parent=parent)
         self._blockSignal = False
         self._firstHandle = None
+        self._includeAll = False
+        self._listFormat = None
         self.currentIndexChanged.connect(self._indexChanged)
         return
 
@@ -64,17 +66,29 @@ class NovelSelector(QComboBox):
 
     def setHandle(self, tHandle: str | None, blockSignal: bool = True) -> None:
         """Set the currently selected handle."""
-        self._blockSignal = blockSignal
-        if tHandle is None:
-            index = self.count() - 1
-        else:
-            index = self.findData(tHandle)
-        if index >= 0:
+        if (index := self.findData(tHandle) if tHandle else (self.count() - 1)) >= 0:
+            self._blockSignal = blockSignal
             self.setCurrentIndex(index)
-        self._blockSignal = False
+            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 updateList(self, includeAll: bool = False, prefix: str | None = None) -> None:
+    ##
+    #  Public Slots
+    ##
+
+    @pyqtSlot()
+    def refreshNovelList(self) -> None:
         """Rebuild the list of novel items."""
         self._blockSignal = True
         self._firstHandle = None
@@ -83,8 +97,8 @@ class NovelSelector(QComboBox):
         icon = SHARED.theme.getIcon(nwLabels.CLASS_ICON[nwItemClass.NOVEL])
         handle = self.currentData()
         for tHandle, nwItem in SHARED.project.tree.iterRoots(nwItemClass.NOVEL):
-            if prefix:
-                name = prefix.format(nwItem.itemName)
+            if self._listFormat:
+                name = self._listFormat.format(nwItem.itemName)
                 self.addItem(name, tHandle)
             else:
                 name = nwItem.itemName
@@ -92,7 +106,7 @@ class NovelSelector(QComboBox):
             if self._firstHandle is None:
                 self._firstHandle = tHandle
 
-        if includeAll:
+        if self._includeAll:
             self.insertSeparator(self.count())
             self.addItem(icon, self.tr("All Novel Folders"), "")