Create a scrollable config layout and start adding it to preferences

novelwriter/extensions/configlayout.py

@@ -26,7 +26,7 @@ from __future__ import annotations
 from PyQt5.QtGui import QColor, QPalette
 from PyQt5.QtCore import Qt
 from PyQt5.QtWidgets import (
-    QAbstractButton, QGridLayout, QHBoxLayout, QLabel, QLineEdit, QSizePolicy,
+    QAbstractButton, QGridLayout, QHBoxLayout, QLabel, QLineEdit, QScrollArea, QSizePolicy,
     QVBoxLayout, QWidget
 )
 
@@ -37,6 +37,99 @@ RIGHT_TOP = Qt.AlignmentFlag.AlignRight | Qt.AlignmentFlag.AlignTop
 LEFT_TOP = Qt.AlignmentFlag.AlignLeft | Qt.AlignmentFlag.AlignTop
 
 
+class NScrollableForm(QScrollArea):
+
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
+        self._helpCol = QColor(0, 0, 0)
+        self._fontScale = FONT_SCALE
+        self._sections: dict[int, QLabel] = {}
+        self._editable: dict[str, NHelpLabel] = {}
+
+        self._layout = QVBoxLayout()
+        self._layout.setSpacing(CONFIG.pxInt(12))
+
+        self._widget = QWidget(self)
+        self._widget.setLayout(self._layout)
+
+        self.setWidget(self._widget)
+        self.setWidgetResizable(True)
+        self.setHorizontalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
+        self.setVerticalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
+
+        return
+
+    def setHelpTextStyle(self, color: QColor | list | tuple, scale: float = FONT_SCALE) -> None:
+        """Set the text color for the help text."""
+        self._helpCol = color if isinstance(color, QColor) else QColor(*color)
+        self._fontScale = scale
+        return
+
+    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 finalise(self) -> None:
+        """Finalise the layout when the form is built."""
+        self._layout.addStretch(1)
+        return
+
+    def scrollToSection(self, identifier: int, offset: int = 50) -> 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 addGroupLabel(self, label: str, identifier: int) -> None:
+        """Add a text label to separate groups of settings."""
+        hM = CONFIG.pxInt(4)
+        qLabel = QLabel(f"<b>{label}</b>", self)
+        qLabel.setContentsMargins(0, hM, 0, hM)
+        self._layout.addWidget(qLabel)
+        self._sections[identifier] = qLabel
+        return
+
+    def addRow(self, label: str, widget: QWidget, helpText: str = "", unit: str | None = None,
+               button: QWidget | None = None, editable: str | None = None) -> None:
+        """Add a label and a widget as a new row of the grid."""
+        row = QHBoxLayout()
+
+        wSp = CONFIG.pxInt(8)
+        qLabel = QLabel(label, self)
+        qLabel.setIndent(wSp)
+        qLabel.setBuddy(widget)
+
+        if helpText:
+            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)
+            row.addLayout(labelBox)
+            if editable:
+                self._editable[editable] = qHelp
+        else:
+            row.addWidget(qLabel)
+
+        row.addWidget(widget)
+
+        if isinstance(unit, str):
+            row.addWidget(QLabel(unit, self))
+        elif isinstance(button, QAbstractButton):
+            row.addWidget(button)
+
+        self._layout.addLayout(row)
+
+        return
+
+# END Class NScrollableForm
+
+
 class NConfigLayout(QGridLayout):
 
     def __init__(self) -> None:
@@ -58,11 +151,10 @@ class NConfigLayout(QGridLayout):
     #  Getters and Setters
     ##
 
-    def setHelpTextStyle(self, color: QColor | list | tuple,
-                         fontScale: float = FONT_SCALE) -> None:
+    def setHelpTextStyle(self, color: QColor | list | tuple, scale: float = FONT_SCALE) -> None:
         """Set the text color for the help text."""
         self._helpCol = color if isinstance(color, QColor) else QColor(*color)
-        self._fontScale = fontScale
+        self._fontScale = scale
         return
 
     def setHelpText(self, row: int, text: str) -> None: