Merge pull request #193 from vkbo/gui_changes

New Preferences Dialog

nw/additions/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+from nw.additions.qconfiglayout import QConfigLayout
+from nw.additions.qswitch import QSwitch
+
+__all__ = [
+    "QConfigLayout",
+    "QSwitch",
+]

nw/additions/qconfiglayout.py

@@ -0,0 +1,178 @@
+# -*- coding: utf-8 -*-
+"""novelWriter Addition QConfigLayout
+
+ novelWriter – Addition QConfigLayout
+======================================
+ A custom Qt grid layout for config forms similar to QFormLayout
+
+ File History:
+ Created: 2020-05-03 [0.4.5]
+
+ This file is a part of novelWriter
+ Copyright 2020, 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/.
+"""
+
+import logging
+import nw
+
+from PyQt5.QtCore import Qt
+from PyQt5.QtGui import QColor, QPalette
+from PyQt5.QtWidgets import (
+    QGridLayout, QLabel, QWidget, QVBoxLayout, QHBoxLayout
+)
+
+from nw.constants import nwUnicode
+
+logger = logging.getLogger(__name__)
+
+class QConfigLayout(QGridLayout):
+
+    def __init__(self):
+        super().__init__()
+
+        self._nextRow = 0
+        self._helpCol = QColor(0, 0, 0)
+        self._fontScale = 0.9
+
+        self._itemMap = {}
+
+        self.setHorizontalSpacing(8)
+        self.setVerticalSpacing(8)
+
+        return
+
+    ##
+    #  Getters and Setters
+    ##
+
+    def setHelpTextStyle(self, helpCol, fontScale=0.9):
+        """Set the text color for the help text.
+        """
+        if isinstance(helpCol, QColor):
+            self._helpCol = helpCol
+        else:
+            self._helpCol = QColor(*helpCol)
+        self._fontScale = fontScale
+        return
+
+    def setHelpText(self, intRow, theText):
+        if intRow in self._itemMap:
+            self._itemMap[intRow]["help"].setText(theText)
+        return
+
+    def setLabelText(self, intRow, theText):
+        if intRow in self._itemMap:
+            self._itemMap[intRow]["label"].setText(theText)
+        return
+
+    ##
+    #  Class Methods
+    ##
+
+    def addGroupLabel(self, theLabel):
+        """Adds a text label to separate groups of settings.
+        """
+
+        if isinstance(theLabel, QLabel):
+            qLabel = theLabel
+        elif isinstance(theLabel, str):
+            qLabel = QLabel("<b>%s</b>" % theLabel)
+        else:
+            qLabel = None
+            raise ValueError("theLabel must be a QLabel")
+
+        qLabel.setContentsMargins(0,4,0,4)
+        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, theLabel, theWidget, helpText=None, theUnit=None):
+        """Add a label and a widget as a new row of the grid.
+        """
+
+        thisEntry = {
+            "label"  : None,
+            "help"   : None,
+            "widget" : None,
+        }
+
+        if isinstance(theLabel, QLabel):
+            qLabel = theLabel
+        elif isinstance(theLabel, str):
+            qLabel = QLabel(theLabel)
+        else:
+            qLabel = None
+            raise ValueError("theLabel must be a QLabel")
+
+        if isinstance(theWidget, QWidget):
+            qWidget = theWidget
+        else:
+            qWidget = None
+            raise ValueError("theWidget must be a QWidget")
+
+        qLabel.setIndent(8)
+        if helpText is not None:
+            qHelp = QLabel(str(helpText))
+            qHelp.setIndent(8)
+
+            lblCol = qHelp.palette()
+            lblCol.setColor(QPalette.WindowText, self._helpCol)
+            qHelp.setPalette(lblCol)
+
+            lblFont = qHelp.font()
+            lblFont.setPointSizeF(self._fontScale*lblFont.pointSizeF())
+            qHelp.setFont(lblFont)
+
+            labelBox = QVBoxLayout()
+            labelBox.addWidget(qLabel)
+            labelBox.addWidget(qHelp)
+            labelBox.setSpacing(0)
+
+            thisEntry["help"] = qHelp
+            self.addLayout(labelBox, self._nextRow, 0, Qt.AlignLeft)
+
+        else:
+            self.addWidget(qLabel, self._nextRow, 0, Qt.AlignLeft)
+
+        if theUnit is not None:
+            controlBox = QHBoxLayout()
+            controlBox.addWidget(qWidget, 0, Qt.AlignVCenter)
+            controlBox.addWidget(QLabel(theUnit), 0, Qt.AlignVCenter)
+            controlBox.setSpacing(8)
+            self.addLayout(controlBox, self._nextRow, 1, Qt.AlignRight)
+        else:
+            self.addWidget(qWidget, self._nextRow, 1, Qt.AlignRight)
+
+        qLabel.setBuddy(qWidget)
+
+        self.setRowStretch(self._nextRow, 0)
+        self.setRowStretch(self._nextRow+1, 1)
+
+        thisEntry["label"] = qLabel
+        thisEntry["widget"] = qWidget
+
+        self._itemMap[self._nextRow] = thisEntry
+
+        self._nextRow += 1
+
+        return self._nextRow - 1
+
+# END Class QConfigLayout