Change from coloring tabs with paintEvent to setTabTextColor

Running in Houdini, the tab bar draws poorly, so remove overriding
paintEvent, and instead use setTabTextColor and setTabTextToolTip. This
means updating colors must be triggered, it doesn't come for free as in
paintEvent.

Author: macevhicz

preditor/gui/drag_tab_bar.py

@@ -6,15 +6,13 @@
 
 import six
 from Qt.QtCore import QByteArray, QMimeData, QPoint, QRect, Qt
-from Qt.QtGui import QColor, QCursor, QDrag, QPainter, QPalette, QPixmap, QRegion
+from Qt.QtGui import QColor, QCursor, QDrag, QPixmap, QRegion
 from Qt.QtWidgets import (
     QApplication,
     QFileDialog,
     QInputDialog,
     QMenu,
     QSizePolicy,
-    QStyle,
-    QStyleOptionTab,
     QTabBar,
 )
 
@@ -48,16 +46,20 @@ class DragTabBar(QTabBar):
 
     """
 
+    # the normalColor is set to an invalid color name. When QTabBar.setTabTextColor
+    # is called with an invalid color name, it reverts to the QTabBar foreground
+    # role instead
+    normalColor = QColor("invalidcolor")
+
     # These Qt Properties can be customized using style sheets.
-    normalColor = QtPropertyInit('_normalColor', QColor("lightgrey"))
-    linkedColor = QtPropertyInit('_linkedColor', QColor("turquoise"))
-    missingLinkedColor = QtPropertyInit('_missingLinkedColor', QColor("red"))
-    dirtyColor = QtPropertyInit('_dirtyColor', QColor("yellow"))
-    dirtyLinkedColor = QtPropertyInit('_dirtyLinkedColor', QColor("goldenrod"))
-    changedColor = QtPropertyInit('_changedColor', QColor("darkorchid"))
-    changedLinkedColor = QtPropertyInit('_changedLinkedColor', QColor("darkviolet"))
-    orphanedColor = QtPropertyInit('_orphanedColor', QColor("crimson"))
-    orphanedLinkedColor = QtPropertyInit('_orphanedLinkedColor', QColor("firebrick"))
+    linkedColor = QtPropertyInit('_linkedColor', QColor("grey"))
+    missingLinkedColor = QtPropertyInit('_missingLinkedColor', QColor("grey"))
+    dirtyColor = QtPropertyInit('_dirtyColor', QColor("grey"))
+    dirtyLinkedColor = QtPropertyInit('_dirtyLinkedColor', QColor("grey"))
+    changedColor = QtPropertyInit('_changedColor', QColor("grey"))
+    changedLinkedColor = QtPropertyInit('_changedLinkedColor', QColor("grey"))
+    orphanedColor = QtPropertyInit('_orphanedColor', QColor("grey"))
+    orphanedLinkedColor = QtPropertyInit('_orphanedLinkedColor', QColor("grey"))
 
     def __init__(self, parent=None, mime_type='DragTabBar'):
         super(DragTabBar, self).__init__(parent=parent)
@@ -70,7 +72,7 @@ def __init__(self, parent=None, mime_type='DragTabBar'):
         self.fg_color_map = {}
         self.bg_color_map = {}
 
-    def updateColors(self):
+    def updateColorMap(self):
         """This cannot be called during __init__, otherwise all bg colors will
         be default, and not read from the style sheet. So instead, the first
         time we need self.bg_color_map, we check if it has values, and call this
@@ -92,7 +94,7 @@ def updateColors(self):
             "1": "black",
         }
 
-    def get_color_and_tooltip(self, index):
+    def getColorAndToolTip(self, index):
         """Determine the color and tooltip based on the state of the workbox.
 
         Args:
@@ -131,13 +133,13 @@ def get_color_and_tooltip(self, index):
                     state = TabStates.OrphanedLinked
                     toolTip = (
                         "Linked workbox is either newly added, or orphaned by "
-                        "saving in another PrEditor instance"
+                        "being removed in another PrEditor instance and saved."
                     )
                 else:
                     state = TabStates.Orphaned
                     toolTip = (
                         "Workbox is either newly added, or orphaned by "
-                        "saving in another PrEditor instance"
+                        "being removed in another PrEditor instance and saved."
                     )
             elif widget.__is_dirty__():
                 if filename:
@@ -199,52 +201,30 @@ def get_color_and_tooltip(self, index):
         color = self.bg_color_map.get(state)
         return color, toolTip
 
-    def paintEvent(self, event):
-        """Override of .paintEvent to handle custom tab colors and toolTips.
-
-        If self.bg_color_map has not yet been populated, do so by calling
-        self.updateColors(). We do not call self.updateColor in this class's
-        __init__ because the QtPropertyInit won't be able to read the properties
-        from the stylesheet at that point.
+    def updateColorAndToolTip(self, index):
+        """Update the color and tooltip for the tab at index, based of various
+        factors about the workbox.
 
         Args:
-            event (QEvent): The event passed to this event handler.
+            index (int): The index of the tab to color, and possibly, set toolTip
         """
-        if not self.bg_color_map:
-            self.updateColors()
-
-        style = self.style()
-        painter = QPainter(self)
-        option = QStyleOptionTab()
-
-        isLight = self.normalColor.value() >= 128
+        self.updateColorMap()
 
-        # Update the the parent GroupTabWidget
-        self.parent().parent().parent().update()
+        color, toolTip = self.getColorAndToolTip(index)
+        self.setTabTextColor(index, color)
+        self.setTabToolTip(index, toolTip)
 
+    def updateColorsAndToolTips(self):
+        """Update the color and tooltip for all the tabs in this tabBar. Also,
+        update the tabBar above it.
+        """
         for index in range(self.count()):
-            # color_name, toolTip = self.get_color_and_tooltip(index)
-            color, toolTip = self.get_color_and_tooltip(index)
-            self.setTabToolTip(index, toolTip)
-
-            # Get colors
-            # color = QColor(color_name)
-            if isLight:
-                fillColor = color.lighter(175)
-                color = color.darker(250)
-            else:
-                fillColor = color.darker(250)
-                color = color.lighter(175)
-            # Pick white or black for text, based on lightness of fillColor
-            fg_idx = int(fillColor.value() >= 128)
-            fg_color_name = self.fg_color_map.get(str(fg_idx))
-            fg_color = QColor(fg_color_name)
-
-            self.initStyleOption(option, index)
-            option.palette.setColor(QPalette.ColorRole.WindowText, fg_color)
-            option.palette.setColor(QPalette.ColorRole.Window, color)
-            option.palette.setColor(QPalette.ColorRole.Button, fillColor)
-            style.drawControl(QStyle.ControlElement.CE_TabBarTab, option, painter)
+            self.updateColorAndToolTip(index)
+
+        parentIdx = self.window().indexOfWorkboxOrTabGroup(self.parent())
+        if parentIdx is not None:
+            tabBar = self.parent().__tab_widget__().tabBar()
+            tabBar.updateColorAndToolTip(parentIdx)
 
     def mouseMoveEvent(self, event):  # noqa: N802
         if not self._mime_data:
@@ -365,6 +345,7 @@ def rename_tab(self):
 
             if success:
                 self.setTabText(self._context_menu_tab, name)
+                self.updateColorsAndToolTips()
 
     def tab_menu(self, pos, popup=True):
         """Creates the custom context menu for the tab bar. To customize the menu
@@ -455,6 +436,7 @@ def link_file(self, workbox):
 
             name = Path(filename).name
             self.setTabText(self._context_menu_tab, name)
+            self.updateColorsAndToolTips()
             self.update()
             self.window().setWorkboxFontBasedOnConsole(workbox=workbox)
 
@@ -481,6 +463,7 @@ def save_and_link_file(self, workbox):
         name = Path(filename).name
 
         self.setTabText(self._context_menu_tab, name)
+        self.updateColorsAndToolTips()
         self.update()
         self.window().setWorkboxFontBasedOnConsole(workbox=workbox)
         workbox.__set_last_workbox_name__(workbox.__workbox_name__())
@@ -507,6 +490,7 @@ def unlink_file(self, workbox):
         workbox.__set_filename__("")
         name = self.parent().default_title
         self.setTabText(self._context_menu_tab, name)
+        self.updateColorsAndToolTips()
 
     def copyFilename(self, workbox):
         """Copy the given workbox's filename to the clipboard

preditor/gui/group_tab_widget/one_tab_widget.py

@@ -84,6 +84,7 @@ def removeTab(self, index):  # noqa: N802
         if hasattr(self, 'default_tab') and not self.count():
             self.addTab(*self.default_tab())
         self.update_closable_tabs()
+        self.window().updateTabColorsAndToolTips()
 
     def showEvent(self, event):  # noqa: N802
         super(OneTabWidget, self).showEvent(event)

preditor/gui/loggerwindow.py

@@ -299,6 +299,10 @@ def __init__(self, parent, name=None, run_workbox=False, standalone=False):
         self.uiClosePreferencesBTN.clicked.connect(self.update_workbox_stack)
         self.uiClosePreferencesBTN.clicked.connect(self.update_window_settings)
 
+        # Preferences
+        self.uiExtraTooltipInfoCHK.toggled.connect(self.updateTabColorsAndToolTips)
+        self.updateTabColorsAndToolTips()
+
         """Set various icons"""
         self.uiClearLogACT.setIcon(QIcon(resourcePath('img/close-thick.png')))
         self.uiNewWorkboxACT.setIcon(QIcon(resourcePath('img/file-plus.png')))
@@ -646,6 +650,7 @@ def change_to_workbox_version_text(self, versionType):
         txt = "{} [{}/{}]".format(filename, idx, count)
         self.setStatusText(txt)
         self.autoHideStatusText()
+        self.updateTabColorsAndToolTips()
 
     def openSetPreferredTextEditorDialog(self):
         dlg = SetTextEditorPathDialog(parent=self)
@@ -1154,6 +1159,36 @@ def prefsPath(self, name='preditor_pref.json'):
         path = prefs.prefs_path(name, core_name=self.name)
         return path
 
+    def indexOfWorkboxOrTabGroup(self, widget):
+        """For the given widget, the the index of it's tab widget that contains
+        it.
+
+        Args:
+            widget (GroupedTabWidget, WorkboxMixin): The workbox or tab group
+                for which to find it's index
+
+        Returns:
+            tabIdx (int, None): The found tab index or None
+        """
+        tabIdx = None
+        if not (widget.parent() and widget.parent().parent()):
+            return tabIdx
+
+        grandParent = widget.parent().parent()
+        for index in range(grandParent.count()):
+            curWidget = grandParent.widget(index)
+            if curWidget == widget:
+                tabIdx = index
+                break
+        return tabIdx
+
+    def updateTabColorsAndToolTips(self):
+        """Go thru all the tab groups and update their text color and toolTips."""
+        group = self.uiWorkboxTAB
+        for index in range(self.uiWorkboxTAB.count()):
+            grouped = group.widget(index)
+            grouped.tabBar().updateColorsAndToolTips()
+
     def linkedFileChanged(self, filename):
         """Slot for responding to the file watcher's signal. Handle updating this
         PrEditor instance accordingly.
@@ -1185,6 +1220,7 @@ def linkedFileChanged(self, filename):
                     filename = editor.__filename__()
                     if filename and Path(filename).is_file():
                         editor.__set_file_monitoring_enabled__(True)
+        self.updateTabColorsAndToolTips()
 
     def closeEvent(self, event):
         self.recordPrefs()
@@ -1848,6 +1884,7 @@ def setStyleSheet(self, stylesheet, recordPrefs=True):
 
         # Notify widgets that the styleSheet has changed
         self.styleSheetChanged.emit(stylesheet)
+        self.updateTabColorsAndToolTips()
 
     def setCaseSensitive(self, state):
         """Set completer case-sensivity"""

preditor/gui/workbox_mixin.py

@@ -12,7 +12,7 @@
 
 import chardet
 import Qt as Qt_py
-from Qt.QtCore import Qt
+from Qt.QtCore import Qt, Signal
 from Qt.QtWidgets import QMessageBox, QStackedWidget
 
 from ..prefs import (
@@ -76,6 +76,8 @@ class WorkboxMixin(object):
     _warning_text = None
     """When a user is picking this Workbox class, show a warning with this text."""
 
+    workboxSaved = Signal()
+
     def __init__(
         self,
         parent=None,
@@ -120,6 +122,9 @@ def __init__(
         self.__set_changed_by_instance__(False)
         self._changed_saved = False
 
+        self.textChanged.connect(self._tab_widget.tabBar().updateColorsAndToolTips)
+        self.workboxSaved.connect(self._tab_widget.tabBar().updateColorsAndToolTips)
+
     def __auto_reload_on_change__(self):
         """Whether the option to auto-reload linked files is set
 
@@ -849,6 +854,8 @@ def __save_prefs__(
             self.__set_last_workbox_name__(self.__workbox_name__())
             self.__set_last_saved_text__(self.__text__())
 
+        self.workboxSaved.emit()
+
         return ret
 
     @classmethod