Add focus widget hinting (#1940)

vkbo · web-flow · commit 251475197dae · 2024-06-21T00:26:20.000+02:00
diff --git a/.github/workflows/test_linux.yml b/.github/workflows/test_linux.yml
@@ -15,6 +15,7 @@ jobs:
     strategy:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12"]
+      fail-fast: false
     runs-on: ubuntu-latest
     steps:
       - name: Python Setup
diff --git a/docs/source/more_customise.rst b/docs/source/more_customise.rst
@@ -132,6 +132,7 @@ A GUI theme ``.conf`` file consists of the following settings:
 
    [GUI]
    helptext        =   0,   0,   0
+   fadedtext       = 128, 128, 128
    errortext       = 255,   0,   0
    statusnone      = 120, 120, 120
    statussaved     =   2, 133,  37
@@ -149,7 +150,7 @@ colour values are RGB numbers on the format ``r, g, b`` where each is an integer
 not defined, it is computed as a colour between the ``window`` and ``windowtext`` colour.
 
 .. versionadded:: 2.5
-   The ``errortext`` theme colour entry was added.
+   The ``fadedtext`` and ``errortext`` theme colour entries were added.
 
 
 Custom Syntax Theme
diff --git a/novelwriter/assets/themes/cyberpunk_night.conf b/novelwriter/assets/themes/cyberpunk_night.conf
@@ -25,6 +25,7 @@ linkvisited     =  50,   0,  80
 
 [GUI]
 helptext        =  97,  97,  97
+fadedtext       =  97,  97,  97
 errortext       = 255,  77,  77
 statusnone      =  50,  50,  50
 statussaved     =  77, 255,  77
diff --git a/novelwriter/assets/themes/default_dark.conf b/novelwriter/assets/themes/default_dark.conf
@@ -26,6 +26,7 @@ linkvisited     = 102, 153, 204
 
 [GUI]
 helptext        = 164, 164, 164
+fadedtext       = 148, 148, 148
 errortext       = 255, 164, 164
 statusnone      = 150, 152, 150
 statussaved     =  39, 135,  78
diff --git a/novelwriter/assets/themes/default_light.conf b/novelwriter/assets/themes/default_light.conf
@@ -26,6 +26,7 @@ linkvisited     =  66, 113, 174
 
 [GUI]
 helptext        =  92,  92,  92
+fadedtext       = 108, 108, 108
 errortext       = 255,  92,  92
 statusnone      = 120, 120, 120
 statussaved     = 200,  15,  39
diff --git a/novelwriter/assets/themes/dracula.conf b/novelwriter/assets/themes/dracula.conf
@@ -41,6 +41,7 @@ linkvisited     = 139, 233, 253
 
 [GUI]
 helptext        = 204, 172, 249
+fadedtext       =  98, 114, 164
 errortext       = 255,  85,  85
 statusnone      =  98, 114, 164
 statussaved     =  80, 250, 123
diff --git a/novelwriter/assets/themes/solarized_dark.conf b/novelwriter/assets/themes/solarized_dark.conf
@@ -25,6 +25,7 @@ linkvisited     =  38, 139, 210
 
 [GUI]
 helptext        = 166, 161, 149
+fadedtext       = 166, 161, 149
 errortext       = 255, 161, 149
 statusnone      =  88, 110, 117
 statussaved     =  42, 161, 152
diff --git a/novelwriter/assets/themes/solarized_light.conf b/novelwriter/assets/themes/solarized_light.conf
@@ -25,6 +25,7 @@ linkvisited     =  38, 139, 210
 
 [GUI]
 helptext        =  78,  91,  95
+fadedtext       =  78,  91,  95
 errortext       = 255,  91,  95
 statusnone      =  88, 110, 117
 statussaved     =  42, 161, 152
diff --git a/novelwriter/dialogs/about.py b/novelwriter/dialogs/about.py
@@ -75,7 +75,7 @@ def __init__(self, parent: QWidget) -> None:
 
         # Credits
         self.lblCredits = NColourLabel(
-            self.tr("Credits"), scale=1.6, parent=self, bold=True
+            self.tr("Credits"), self, scale=1.6, bold=True
         )
 
         self.txtCredits = QTextBrowser(self)
diff --git a/novelwriter/dialogs/docmerge.py b/novelwriter/dialogs/docmerge.py
@@ -58,7 +58,7 @@ def __init__(self, parent: QWidget, sHandle: str, itemList: list[str]) -> None:
         self.headLabel.setFont(SHARED.theme.guiFontB)
         self.helpLabel = NColourLabel(
             self.tr("Drag and drop items to change the order, or uncheck to exclude."),
-            SHARED.theme.helpText, parent=self, wrap=True
+            self, color=SHARED.theme.helpText, wrap=True
         )
 
         iPx = SHARED.theme.baseIconHeight
diff --git a/novelwriter/dialogs/docsplit.py b/novelwriter/dialogs/docsplit.py
@@ -62,7 +62,7 @@ def __init__(self, parent: QWidget, sHandle: str) -> None:
         self.headLabel.setFont(SHARED.theme.guiFontB)
         self.helpLabel = NColourLabel(
             self.tr("Select the maximum level to split into files."),
-            SHARED.theme.helpText, parent=self, wrap=True
+            self, color=SHARED.theme.helpText, wrap=True
         )
 
         # Values
diff --git a/novelwriter/dialogs/preferences.py b/novelwriter/dialogs/preferences.py
@@ -66,8 +66,8 @@ def __init__(self, parent: QWidget) -> None:
 
         # Title
         self.titleLabel = NColourLabel(
-            self.tr("Preferences"), SHARED.theme.helpText,
-            parent=self, scale=NColourLabel.HEADER_SCALE, indent=CONFIG.pxInt(4)
+            self.tr("Preferences"), self, color=SHARED.theme.helpText,
+            scale=NColourLabel.HEADER_SCALE, indent=CONFIG.pxInt(4)
         )
 
         # Search Box
diff --git a/novelwriter/dialogs/projectsettings.py b/novelwriter/dialogs/projectsettings.py
@@ -76,8 +76,8 @@ def __init__(self, parent: QWidget, gotoPage: int = PAGE_SETTINGS) -> None:
 
         # Title
         self.titleLabel = NColourLabel(
-            self.tr("Project Settings"), SHARED.theme.helpText,
-            parent=self, scale=NColourLabel.HEADER_SCALE, indent=CONFIG.pxInt(4)
+            self.tr("Project Settings"), self, color=SHARED.theme.helpText,
+            scale=NColourLabel.HEADER_SCALE, indent=CONFIG.pxInt(4)
         )
 
         # SideBar
@@ -345,7 +345,7 @@ def __init__(self, parent: QWidget, isStatus: bool) -> None:
 
         # Title
         self.pageTitle = NColourLabel(
-            pageLabel, SHARED.theme.helpText, parent=self,
+            pageLabel, self, color=SHARED.theme.helpText,
             scale=NColourLabel.HEADER_SCALE
         )
 
@@ -637,8 +637,8 @@ def __init__(self, parent: QWidget) -> None:
 
         # Title
         self.pageTitle = NColourLabel(
-            self.tr("Text Auto-Replace for Preview and Build"),
-            SHARED.theme.helpText, parent=self, scale=NColourLabel.HEADER_SCALE
+            self.tr("Text Auto-Replace for Preview and Build"), self,
+            color=SHARED.theme.helpText, scale=NColourLabel.HEADER_SCALE
         )
 
         # List Box
diff --git a/novelwriter/dialogs/wordlist.py b/novelwriter/dialogs/wordlist.py
@@ -69,7 +69,7 @@ def __init__(self, parent: QWidget) -> None:
 
         # Header
         self.headLabel = NColourLabel(
-            self.tr("Project Word List"), SHARED.theme.helpText, parent=self,
+            self.tr("Project Word List"), self, color=SHARED.theme.helpText,
             scale=NColourLabel.HEADER_SCALE
         )
 
diff --git a/novelwriter/enum.py b/novelwriter/enum.py
@@ -148,12 +148,11 @@ class nwView(Enum):
     SEARCH  = 4
 
 
-class nwWidget(Enum):
+class nwFocus(Enum):
 
-    TREE    = 1
-    EDITOR  = 2
-    VIEWER  = 3
-    OUTLINE = 4
+    TREE     = 1
+    DOCUMENT = 2
+    OUTLINE  = 3
 
 
 class nwOutline(Enum):
diff --git a/novelwriter/extensions/configlayout.py b/novelwriter/extensions/configlayout.py
@@ -34,7 +34,7 @@
     QVBoxLayout, QWidget
 )
 
-from novelwriter import CONFIG
+from novelwriter import CONFIG, SHARED
 
 DEFAULT_SCALE = 0.9
 
@@ -203,7 +203,7 @@ def addRow(self, label: str, widget: QWidget | list[QWidget], helpText: str = ""
 
         if helpText:
             qHelp = NColourLabel(
-                str(helpText), color=self._helpCol, parent=self,
+                str(helpText), self, color=self._helpCol,
                 scale=self._fontScale, wrap=True, indent=self._indent
             )
             labelBox = QVBoxLayout()
@@ -252,12 +252,21 @@ class NColourLabel(QLabel):
     HELP_SCALE = DEFAULT_SCALE
     HEADER_SCALE = 1.25
 
-    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:
+    _state = None
+
+    def __init__(
+        self, text: str, parent: QWidget, *,
+        color: QColor | None = None, faded: QColor | None = None,
+        scale: float = HELP_SCALE, wrap: bool = False, indent: int = 0,
+        bold: bool = False
+    ) -> None:
         super().__init__(text, parent=parent)
 
-        font = self.font()
+        default = self.palette().windowText().color()
+        self._color = color or default
+        self._faded = faded or default
+
+        font = SHARED.theme.guiFont
         font.setPointSizeF(scale*font.pointSizeF())
         font.setWeight(QFont.Weight.Bold if bold else QFont.Weight.Normal)
         if color:
@@ -268,7 +277,17 @@ def __init__(self, text: str, color: QColor | None = None, parent: QWidget | Non
         self.setFont(font)
         self.setIndent(indent)
         self.setWordWrap(wrap)
+        self.setColorState(True)
+
+        return
 
+    def setColorState(self, state: bool) -> None:
+        """Change the colour state."""
+        if self._state is not state:
+            self._state = state
+            colour = self.palette()
+            colour.setColor(QPalette.ColorRole.WindowText, self._color if state else self._faded)
+            self.setPalette(colour)
         return
 
 
diff --git a/novelwriter/gui/doceditor.py b/novelwriter/gui/doceditor.py
@@ -55,6 +55,7 @@
 from novelwriter.constants import nwConst, nwKeyWords, nwShortcode, nwUnicode
 from novelwriter.core.document import NWDocument
 from novelwriter.enum import nwComment, nwDocAction, nwDocInsert, nwDocMode, nwItemClass, nwTrinary
+from novelwriter.extensions.configlayout import NColourLabel
 from novelwriter.extensions.eventfilters import WheelEventFilter
 from novelwriter.extensions.modified import NIconToggleButton, NIconToolButton
 from novelwriter.gui.dochighlight import BLOCK_META, BLOCK_TITLE
@@ -210,6 +211,7 @@ def __init__(self, parent: QWidget) -> None:
         # Function Mapping
         self.closeSearch = self.docSearch.closeSearch
         self.searchVisible = self.docSearch.isVisible
+        self.changeFocusState = self.docHeader.changeFocusState
 
         # Finalise
         self.updateSyntaxColours()
@@ -2785,8 +2787,7 @@ def __init__(self, docEditor: GuiDocEditor) -> None:
         self.setAutoFillBackground(True)
 
         # Title Label
-        self.itemTitle = QLabel("", self)
-        self.itemTitle.setIndent(0)
+        self.itemTitle = NColourLabel("", self, faded=SHARED.theme.fadedText)
         self.itemTitle.setMargin(0)
         self.itemTitle.setContentsMargins(0, 0, 0, 0)
         self.itemTitle.setAutoFillBackground(True)
@@ -2924,6 +2925,11 @@ def matchColours(self) -> None:
 
         return
 
+    def changeFocusState(self, state: bool) -> None:
+        """Toggle focus state."""
+        self.itemTitle.setColorState(state)
+        return
+
     def setHandle(self, tHandle: str) -> None:
         """Set the document title from the handle, or alternatively, set
         the whole document path within the project.
diff --git a/novelwriter/gui/docviewer.py b/novelwriter/gui/docviewer.py
@@ -33,7 +33,7 @@
 from PyQt5.QtCore import QPoint, Qt, QUrl, pyqtSignal, pyqtSlot
 from PyQt5.QtGui import QCursor, QMouseEvent, QPalette, QResizeEvent, QTextCursor
 from PyQt5.QtWidgets import (
-    QAction, QApplication, QFrame, QHBoxLayout, QLabel, QMenu, QTextBrowser,
+    QAction, QApplication, QFrame, QHBoxLayout, QMenu, QTextBrowser,
     QToolButton, QWidget
 )
 
@@ -42,6 +42,7 @@
 from novelwriter.core.toqdoc import TextDocumentTheme, ToQTextDocument
 from novelwriter.enum import nwDocAction, nwDocMode, nwItemType
 from novelwriter.error import logException
+from novelwriter.extensions.configlayout import NColourLabel
 from novelwriter.extensions.eventfilters import WheelEventFilter
 from novelwriter.extensions.modified import NIconToolButton
 from novelwriter.gui.theme import STYLES_MIN_TOOLBUTTON
@@ -92,6 +93,9 @@ def __init__(self, parent: QWidget) -> None:
         self.setContextMenuPolicy(Qt.ContextMenuPolicy.CustomContextMenu)
         self.customContextMenuRequested.connect(self._openContextMenu)
 
+        # Function Mapping
+        self.changeFocusState = self.docHeader.changeFocusState
+
         self.initViewer()
 
         logger.debug("Ready: GuiDocViewer")
@@ -278,6 +282,10 @@ def docAction(self, action: nwDocAction) -> bool:
             return False
         return True
 
+    def anyFocus(self) -> bool:
+        """Check if any widget or child widget has focus."""
+        return self.hasFocus() or self.isAncestorOf(QApplication.focusWidget())
+
     def clearNavHistory(self) -> None:
         """Clear the navigation history."""
         self.docHistory.clear()
@@ -597,9 +605,7 @@ def __init__(self, docViewer: GuiDocViewer) -> None:
         self.setAutoFillBackground(True)
 
         # Title Label
-        self.itemTitle = QLabel(self)
-        self.itemTitle.setText("")
-        self.itemTitle.setIndent(0)
+        self.itemTitle = NColourLabel("", self, faded=SHARED.theme.fadedText)
         self.itemTitle.setMargin(0)
         self.itemTitle.setContentsMargins(0, 0, 0, 0)
         self.itemTitle.setAutoFillBackground(True)
@@ -738,6 +744,11 @@ def matchColours(self) -> None:
         self.itemTitle.setPalette(palette)
         return
 
+    def changeFocusState(self, state: bool) -> None:
+        """Toggle focus state."""
+        self.itemTitle.setColorState(state)
+        return
+
     def setHandle(self, tHandle: str) -> None:
         """Sets the document title from the handle, or alternatively,
         set the whole document path.
diff --git a/novelwriter/gui/mainmenu.py b/novelwriter/gui/mainmenu.py
@@ -35,7 +35,7 @@
 from novelwriter import CONFIG, SHARED
 from novelwriter.common import openExternalPath
 from novelwriter.constants import nwConst, nwKeyWords, nwLabels, nwUnicode, trConst
-from novelwriter.enum import nwDocAction, nwDocInsert, nwView, nwWidget
+from novelwriter.enum import nwDocAction, nwDocInsert, nwFocus, nwView
 from novelwriter.extensions.eventfilters import StatusTipFilter
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -54,7 +54,7 @@ class GuiMainMenu(QMenuBar):
     requestDocInsert = pyqtSignal(nwDocInsert)
     requestDocInsertText = pyqtSignal(str)
     requestDocKeyWordInsert = pyqtSignal(str)
-    requestFocusChange = pyqtSignal(nwWidget)
+    requestFocusChange = pyqtSignal(nwFocus)
     requestViewChange = pyqtSignal(nwView)
 
     def __init__(self, mainGui: GuiMain) -> None:
@@ -303,24 +303,24 @@ def _buildViewMenu(self) -> None:
         self.viewMenu = self.addMenu(self.tr("&View"))
 
         # View > TreeView
-        self.aFocusTree = self.viewMenu.addAction(self.tr("Go to Project Tree"))
+        self.aFocusTree = self.viewMenu.addAction(self.tr("Go to Tree View"))
         self.aFocusTree.setShortcut("Ctrl+T")
         self.aFocusTree.triggered.connect(
-            lambda: self.requestFocusChange.emit(nwWidget.TREE)
+            lambda: self.requestFocusChange.emit(nwFocus.TREE)
         )
 
         # View > Document Editor
-        self.aFocusEditor = self.viewMenu.addAction(self.tr("Go to Document Editor"))
-        self.aFocusEditor.setShortcut("Ctrl+E")
-        self.aFocusEditor.triggered.connect(
-            lambda: self.requestFocusChange.emit(nwWidget.EDITOR)
+        self.aFocusDocument = self.viewMenu.addAction(self.tr("Go to Document"))
+        self.aFocusDocument.setShortcut("Ctrl+E")
+        self.aFocusDocument.triggered.connect(
+            lambda: self.requestFocusChange.emit(nwFocus.DOCUMENT)
         )
 
         # View > Outline
         self.aFocusOutline = self.viewMenu.addAction(self.tr("Go to Outline"))
         self.aFocusOutline.setShortcut("Ctrl+Shift+T")
         self.aFocusOutline.triggered.connect(
-            lambda: self.requestFocusChange.emit(nwWidget.OUTLINE)
+            lambda: self.requestFocusChange.emit(nwFocus.OUTLINE)
         )
 
         # View > Separator
diff --git a/novelwriter/gui/outline.py b/novelwriter/gui/outline.py
@@ -215,7 +215,7 @@ def __init__(self, outlineView: GuiOutlineView) -> None:
 
         # Novel Selector
         self.novelLabel = NColourLabel(
-            self.tr("Outline of"), parent=self, scale=NColourLabel.HEADER_SCALE, bold=True
+            self.tr("Outline of"), self, scale=NColourLabel.HEADER_SCALE, bold=True
         )
         self.novelLabel.setContentsMargins(0, 0, CONFIG.pxInt(12), 0)
 
diff --git a/novelwriter/gui/theme.py b/novelwriter/gui/theme.py
diff --git a/novelwriter/guimain.py b/novelwriter/guimain.py
diff --git a/novelwriter/tools/manussettings.py b/novelwriter/tools/manussettings.py
diff --git a/novelwriter/tools/noveldetails.py b/novelwriter/tools/noveldetails.py
diff --git a/tests/test_base/test_base_init.py b/tests/test_base/test_base_init.py
diff --git a/tests/test_gui/test_gui_doceditor.py b/tests/test_gui/test_gui_doceditor.py
diff --git a/tests/test_gui/test_gui_guimain.py b/tests/test_gui/test_gui_guimain.py
diff --git a/tests/test_gui/test_gui_i18n.py b/tests/test_gui/test_gui_i18n.py
diff --git a/tests/test_gui/test_gui_noveltree.py b/tests/test_gui/test_gui_noveltree.py
diff --git a/tests/test_gui/test_gui_projtree.py b/tests/test_gui/test_gui_projtree.py

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ def __init__(self, parent: QWidget) -> None:`
`75`	`75`
`76`	`76`	`# Credits`
`77`	`77`	`self.lblCredits = NColourLabel(`
`78`		`- self.tr("Credits"), scale=1.6, parent=self, bold=True`
	`78`	`+ self.tr("Credits"), self, scale=1.6, bold=True`
`79`	`79`	`)`
`80`	`80`
`81`	`81`	`self.txtCredits = QTextBrowser(self)`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ def __init__(self, parent: QWidget, sHandle: str, itemList: list[str]) -> None:`
`58`	`58`	`self.headLabel.setFont(SHARED.theme.guiFontB)`
`59`	`59`	`self.helpLabel = NColourLabel(`
`60`	`60`	`self.tr("Drag and drop items to change the order, or uncheck to exclude."),`
`61`		`- SHARED.theme.helpText, parent=self, wrap=True`
	`61`	`+ self, color=SHARED.theme.helpText, wrap=True`
`62`	`62`	`)`
`63`	`63`
`64`	`64`	`iPx = SHARED.theme.baseIconHeight`