Complete the paged sidebar widget

novelwriter/extensions/pagedsidebar.py

@@ -5,7 +5,7 @@ A custom widget for making a sidebar for flipping through pages
 
 File History:
 Created: 2023-02-21 [2.1b1] NPagedSideBar
-Created: 2023-02-21 [2.1b1] NToolLabelButton
+Created: 2023-02-21 [2.1b1] NPagedToolButton
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen
@@ -24,8 +24,12 @@ 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 PyQt5.QtCore import Qt
-from PyQt5.QtWidgets import QActionGroup, QSizePolicy, QToolBar, QToolButton, QWidget
+from PyQt5.QtCore import QRectF, Qt
+from PyQt5.QtGui import QColor, QPainter
+from PyQt5.QtWidgets import (
+    QButtonGroup, QLabel, QSizePolicy, QStyle, QStyleOptionToolButton, QToolBar,
+    QToolButton, QWidget
+)
 
 
 class NPagedSideBar(QToolBar):
@@ -35,8 +39,10 @@ class NPagedSideBar(QToolBar):
 
         self._buttons = []
         self._actions = []
-        self._group = QActionGroup(self)
+        self._group = QButtonGroup(self)
         self._group.setExclusive(True)
+        self._labelCol = None
+        self._spacerHeight = self.fontMetrics().height() // 2
 
         self.setMovable(False)
         self.setOrientation(Qt.Vertical)
@@ -47,20 +53,40 @@ class NPagedSideBar(QToolBar):
 
         return
 
-    def addLabel(self, text, height):
-        """Add a new label to the toolbar.
+    def setLabelColor(self, color):
+        """Set the text color for the labels.
         """
+        if isinstance(color, list):
+            self._labelCol = QColor(*color)
+        elif isinstance(color, QColor):
+            self._labelCol = color
         return
 
-    def addButton(self, text, height):
+    def addSeparator(self):
+        """Add a spacer widget.
+        """
+        spacer = QWidget(self)
+        spacer.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Fixed)
+        spacer.setFixedHeight(self._spacerHeight)
+        self.insertWidget(self._stretchAction, spacer)
+        return
+
+    def addLabel(self, text):
+        """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):
         """Add a new button to the toolbar.
         """
-        button = NToolLabelButton(self)
-        button.setFixedHeight(height)
+        button = NPagedToolButton(self)
         button.setText(text)
 
         action = self.insertWidget(self._stretchAction, button)
-        self._group.addAction(action)
+        self._group.addButton(button)
 
         self._buttons.append(button)
         self._actions.append(action)
@@ -70,7 +96,9 @@ class NPagedSideBar(QToolBar):
 # END Class NPagedSideBar
 
 
-class NToolLabelButton(QToolButton):
+class NPagedToolButton(QToolButton):
+
+    __slots__ = ["_bH", "_tM", "_lM", "_cR"]
 
     def __init__(self, parent):
         super().__init__(parent=parent)
@@ -78,6 +106,95 @@ class NToolLabelButton(QToolButton):
         self.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Fixed)
         self.setCheckable(True)
 
+        fH = self.fontMetrics().height()
+        self._bH = round(fH * 1.7)
+        self._tM = (self._bH - fH) // 2
+        self._lM = self.style().pixelMetric(QStyle.PM_ButtonMargin)
+        self._cR = self._lM // 2
+        self.setFixedHeight(self._bH)
+
         return
 
-# END Class NToolLabelButton
+    def paintEvent(self, event):
+        """Overload the paint event to draw a simple, left aligned text
+        label, with a highlight when selected and alternative base
+        colour when hovered.
+        """
+        opt = QStyleOptionToolButton()
+        opt.initFrom(self)
+
+        paint = QPainter(self)
+        paint.setRenderHint(QPainter.Antialiasing, True)
+        paint.setPen(Qt.NoPen)
+
+        width = self.width()
+        height = self.height()
+        palette = self.palette()
+
+        if opt.state & QStyle.State_MouseOver:
+            backCol = palette.alternateBase()
+            paint.setBrush(backCol)
+            paint.setOpacity(0.5)
+            paint.drawRoundedRect(0, 0, width, height, self._cR, self._cR)
+
+        if self.isChecked():
+            backCol = palette.highlight()
+            paint.setBrush(backCol)
+            paint.setOpacity(0.5)
+            paint.drawRoundedRect(0, 0, width, height, self._cR, self._cR)
+            textCol = palette.highlightedText().color()
+        else:
+            textCol = palette.text().color()
+
+        tW = width - 2*self._lM
+        tH = height - 2*self._tM
+
+        paint.setPen(textCol)
+        paint.setOpacity(1.0)
+        paint.drawText(QRectF(self._lM, self._tM, tW, tH), Qt.AlignLeft, self.text())
+
+        return
+
+# END Class NPagedToolButton
+
+
+class NPagedToolLabel(QLabel):
+
+    __slots__ = ["_bH", "_tM", "_lM", "_textCol"]
+
+    def __init__(self, parent, textColor=None):
+        super().__init__(parent=parent)
+
+        self.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Fixed)
+
+        fH = self.fontMetrics().height()
+        self._bH = round(fH * 1.7)
+        self._tM = (self._bH - fH) // 2
+        self._lM = self.style().pixelMetric(QStyle.PM_ButtonMargin)
+        self.setFixedHeight(self._bH)
+
+        self._textCol = textColor or self.palette().text().color()
+
+        return
+
+    def paintEvent(self, event):
+        """Overload the paint event to draw a simple, left aligned text
+        label that matches the button style.
+        """
+        paint = QPainter(self)
+        paint.setRenderHint(QPainter.Antialiasing, True)
+        paint.setPen(Qt.NoPen)
+
+        width = self.width()
+        height = self.height()
+
+        tW = width - 2*self._lM
+        tH = height - 2*self._tM
+
+        paint.setPen(self._textCol)
+        paint.setOpacity(1.0)
+        paint.drawText(QRectF(self._lM, self._tM, tW, tH), Qt.AlignLeft, self.text())
+
+        return
+
+# END Class NPagedToolLabel