novelWriter 2.1.1__py3-none-any.whl → 2.2rc1__py3-none-any.whl

novelwriter/gui/docviewer.py

@@ -4,7 +4,6 @@ novelWriter – GUI Document Viewer
 
 File History:
 Created: 2019-05-10 [0.0.1] GuiDocViewer
-Created: 2019-10-31 [0.3.2] GuiDocViewDetails
 Created: 2020-04-25 [0.4.5] GuiDocViewHeader
 Created: 2020-06-09 [0.8]   GuiDocViewFooter
 Created: 2020-09-08 [1.0b1] GuiDocViewHistory
@@ -34,12 +33,12 @@ from typing import TYPE_CHECKING
 
 from PyQt5.QtCore import pyqtSignal, pyqtSlot, QPoint, QSize, Qt, QUrl
 from PyQt5.QtGui import (
-    QColor, QCursor, QFont, QIcon, QMouseEvent, QPalette, QResizeEvent,
-    QTextCursor, QTextOption
+    QColor, QCursor, QFont, QMouseEvent, QPalette, QResizeEvent, QTextCursor,
+    QTextOption
 )
 from PyQt5.QtWidgets import (
-    QAction, qApp, QFrame, QHBoxLayout, QLabel, QMenu, QScrollArea,
-    QTextBrowser, QToolButton, QWidget
+    QAction, QFrame, QHBoxLayout, QLabel, QMenu, QTextBrowser, QToolButton,
+    QWidget, qApp
 )
 
 from novelwriter import CONFIG, SHARED
@@ -57,7 +56,10 @@ logger = logging.getLogger(__name__)
 
 class GuiDocViewer(QTextBrowser):
 
+    documentLoaded = pyqtSignal(str)
     loadDocumentTagRequest = pyqtSignal(str, Enum)
+    togglePanelVisibility = pyqtSignal()
+    requestProjectItemSelected = pyqtSignal(str, bool)
 
     def __init__(self, mainGui: GuiMain) -> None:
         super().__init__(parent=mainGui)
@@ -74,8 +76,8 @@ class GuiDocViewer(QTextBrowser):
         self.setMinimumWidth(CONFIG.pxInt(300))
         self.setAutoFillBackground(True)
         self.setOpenExternalLinks(False)
-        self.setFocusPolicy(Qt.StrongFocus)
-        self.setFrameStyle(QFrame.NoFrame)
+        self.setFocusPolicy(Qt.FocusPolicy.StrongFocus)
+        self.setFrameStyle(QFrame.Shape.NoFrame)
 
         # Document Header and Footer
         self.docHeader  = GuiDocViewHeader(self)
@@ -91,7 +93,7 @@ class GuiDocViewer(QTextBrowser):
         self.installEventFilter(self.wheelEventFilter)
 
         # Context Menu
-        self.setContextMenuPolicy(Qt.CustomContextMenu)
+        self.setContextMenuPolicy(Qt.ContextMenuPolicy.CustomContextMenu)
         self.customContextMenuRequested.connect(self._openContextMenu)
 
         self.initViewer()
@@ -147,14 +149,14 @@ class GuiDocViewer(QTextBrowser):
 
         # Set the widget colours to match syntax theme
         mainPalette = self.palette()
-        mainPalette.setColor(QPalette.Window, QColor(*SHARED.theme.colBack))
-        mainPalette.setColor(QPalette.Base, QColor(*SHARED.theme.colBack))
-        mainPalette.setColor(QPalette.Text, QColor(*SHARED.theme.colText))
+        mainPalette.setColor(QPalette.ColorRole.Window, QColor(*SHARED.theme.colBack))
+        mainPalette.setColor(QPalette.ColorRole.Base, QColor(*SHARED.theme.colBack))
+        mainPalette.setColor(QPalette.ColorRole.Text, QColor(*SHARED.theme.colText))
         self.setPalette(mainPalette)
 
         docPalette = self.viewport().palette()
-        docPalette.setColor(QPalette.Base, QColor(*SHARED.theme.colBack))
-        docPalette.setColor(QPalette.Text, QColor(*SHARED.theme.colText))
+        docPalette.setColor(QPalette.ColorRole.Base, QColor(*SHARED.theme.colBack))
+        docPalette.setColor(QPalette.ColorRole.Text, QColor(*SHARED.theme.colText))
         self.viewport().setPalette(docPalette)
 
         self.docHeader.matchColours()
@@ -164,19 +166,19 @@ class GuiDocViewer(QTextBrowser):
         self.document().setDocumentMargin(0)
         theOpt = QTextOption()
         if CONFIG.doJustify:
-            theOpt.setAlignment(Qt.AlignJustify)
+            theOpt.setAlignment(Qt.AlignmentFlag.AlignJustify)
         self.document().setDefaultTextOption(theOpt)
 
         # Scroll bars
         if CONFIG.hideVScroll:
-            self.setVerticalScrollBarPolicy(Qt.ScrollBarAlwaysOff)
+            self.setVerticalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAlwaysOff)
         else:
-            self.setVerticalScrollBarPolicy(Qt.ScrollBarAsNeeded)
+            self.setVerticalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
 
         if CONFIG.hideHScroll:
-            self.setHorizontalScrollBarPolicy(Qt.ScrollBarAlwaysOff)
+            self.setHorizontalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAlwaysOff)
         else:
-            self.setHorizontalScrollBarPolicy(Qt.ScrollBarAsNeeded)
+            self.setHorizontalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
 
         # Refresh the tab stops
         self.setTabStopDistance(CONFIG.getTabWidth())
@@ -191,10 +193,11 @@ class GuiDocViewer(QTextBrowser):
         """Load text into the viewer from an item handle."""
         if not SHARED.project.tree.checkType(tHandle, nwItemType.FILE):
             logger.warning("Item not found")
+            self.documentLoaded.emit("")
             return False
 
         logger.debug("Generating preview for item '%s'", tHandle)
-        qApp.setOverrideCursor(QCursor(Qt.WaitCursor))
+        qApp.setOverrideCursor(QCursor(Qt.CursorShape.WaitCursor))
 
         sPos = self.verticalScrollBar().value()
         aDoc = ToHtml(SHARED.project)
@@ -223,14 +226,12 @@ class GuiDocViewer(QTextBrowser):
         if updateHistory:
             self.docHistory.append(tHandle)
 
-        self.setHtml(aDoc.theResult.replace("\t", "!!tab!!"))
         self.setDocumentTitle(tHandle)
 
-        # Loop through the text and put back in the tabs. Tabs are removed by
-        # the setHtml function, so the ToHtml class puts in a placeholder.
+        # Replace tabs before setting the HTML, and then put them back in
+        self.setHtml(aDoc.theResult.replace("\t", "!!tab!!"))
         while self.find("!!tab!!"):
-            theCursor = self.textCursor()
-            theCursor.insertText("\t")
+            self.textCursor().insertText("\t")
 
         if self._docHandle == tHandle:
             # This is a refresh, so we set the scrollbar back to where it was
@@ -241,13 +242,11 @@ class GuiDocViewer(QTextBrowser):
         self.docHeader.setTitleFromHandle(self._docHandle)
         self.updateDocMargins()
 
-        # Make sure the main GUI knows we changed the content
-        self.mainGui.viewMeta.refreshReferences(tHandle)
-
         # Since we change the content while it may still be rendering, we mark
         # the document dirty again to make sure it's re-rendered properly.
         self.redrawText()
         qApp.restoreOverrideCursor()
+        self.documentLoaded.emit(tHandle)
 
         return True
 
@@ -263,33 +262,31 @@ class GuiDocViewer(QTextBrowser):
         self.updateDocMargins()
         return
 
-    def docAction(self, theAction: nwDocAction) -> bool:
+    def docAction(self, action: nwDocAction) -> bool:
         """Process document actions on the current document."""
-        logger.debug("Requesting action: '%s'", theAction.name)
+        logger.debug("Requesting action: '%s'", action.name)
         if self._docHandle is None:
             logger.error("No document open")
             return False
-        if theAction == nwDocAction.CUT:
+        if action == nwDocAction.CUT:
             self.copy()
-        elif theAction == nwDocAction.COPY:
+        elif action == nwDocAction.COPY:
             self.copy()
-        elif theAction == nwDocAction.SEL_ALL:
-            self._makeSelection(QTextCursor.Document)
-        elif theAction == nwDocAction.SEL_PARA:
-            self._makeSelection(QTextCursor.BlockUnderCursor)
+        elif action == nwDocAction.SEL_ALL:
+            self._makeSelection(QTextCursor.SelectionType.Document)
+        elif action == nwDocAction.SEL_PARA:
+            self._makeSelection(QTextCursor.SelectionType.BlockUnderCursor)
         else:
-            logger.debug("Unknown or unsupported document action '%s'", str(theAction))
+            logger.debug("Unknown or unsupported document action '%s'", str(action))
             return False
         return True
 
-    def navigateTo(self, tAnchor: str) -> bool:
+    def navigateTo(self, tAnchor: str) -> None:
         """Go to a specific #link in the document."""
-        if not isinstance(tAnchor, str):
-            return False
-        if tAnchor.startswith("#"):
+        if isinstance(tAnchor, str) and tAnchor.startswith("#"):
             logger.debug("Moving to anchor '%s'", tAnchor)
             self.setSource(QUrl(tAnchor))
-        return True
+        return
 
     def clearNavHistory(self) -> None:
         """Clear the navigation history."""
@@ -342,7 +339,7 @@ class GuiDocViewer(QTextBrowser):
 
     @pyqtSlot(str)
     def updateDocInfo(self, tHandle: str) -> None:
-        """Update the header titlebar if needed."""
+        """Update the header title bar if needed."""
         if tHandle == self._docHandle:
             self.docHeader.setTitleFromHandle(self._docHandle)
             self.updateDocMargins()
@@ -366,11 +363,11 @@ class GuiDocViewer(QTextBrowser):
 
     @pyqtSlot("QUrl")
     def _linkClicked(self, url: QUrl) -> None:
-        """Process a clicked link internally in the document."""
-        theLink = url.url()
-        logger.debug("Clicked link: '%s'", theLink)
-        if len(theLink) > 0:
-            theBits = theLink.split("=")
+        """Process a clicked link in the document."""
+        link = url.url()
+        logger.debug("Clicked link: '%s'", link)
+        if len(link) > 0:
+            theBits = link.split("=")
             if len(theBits) == 2:
                 self.loadDocumentTagRequest.emit(theBits[1], nwDocMode.VIEW)
         return
@@ -383,9 +380,6 @@ class GuiDocViewer(QTextBrowser):
 
         mnuContext = QMenu(self)
 
-        # Cut, Copy and Paste
-        # ===================
-
         if userSelection:
             mnuCopy = QAction(self.tr("Copy"), mnuContext)
             mnuCopy.triggered.connect(lambda: self.docAction(nwDocAction.COPY))
@@ -393,22 +387,19 @@ class GuiDocViewer(QTextBrowser):
 
             mnuContext.addSeparator()
 
-        # Selections
-        # ==========
-
         mnuSelAll = QAction(self.tr("Select All"), mnuContext)
         mnuSelAll.triggered.connect(lambda: self.docAction(nwDocAction.SEL_ALL))
         mnuContext.addAction(mnuSelAll)
 
         mnuSelWord = QAction(self.tr("Select Word"), mnuContext)
         mnuSelWord.triggered.connect(
-            lambda: self._makePosSelection(QTextCursor.WordUnderCursor, point)
+            lambda: self._makePosSelection(QTextCursor.SelectionType.WordUnderCursor, point)
         )
         mnuContext.addAction(mnuSelWord)
 
         mnuSelPara = QAction(self.tr("Select Paragraph"), mnuContext)
         mnuSelPara.triggered.connect(
-            lambda: self._makePosSelection(QTextCursor.BlockUnderCursor, point)
+            lambda: self._makePosSelection(QTextCursor.SelectionType.BlockUnderCursor, point)
         )
         mnuContext.addAction(mnuSelPara)
 
@@ -429,9 +420,9 @@ class GuiDocViewer(QTextBrowser):
 
     def mouseReleaseEvent(self, event: QMouseEvent) -> None:
         """Capture mouse click events on the document."""
-        if event.button() == Qt.BackButton:
+        if event.button() == Qt.MouseButton.BackButton:
             self.navBackward()
-        elif event.button() == Qt.ForwardButton:
+        elif event.button() == Qt.MouseButton.ForwardButton:
             self.navForward()
         else:
             super().mouseReleaseEvent(event)
@@ -442,29 +433,28 @@ class GuiDocViewer(QTextBrowser):
     ##
 
     def _makeSelection(self, selType: QTextCursor.SelectionType) -> None:
-        """Handle select of text based on a selection mode."""
-        theCursor = self.textCursor()
-        theCursor.clearSelection()
-        theCursor.select(selType)
+        """Handle selection of text based on a selection mode."""
+        cursor = self.textCursor()
+        cursor.clearSelection()
+        cursor.select(selType)
 
-        if selType == QTextCursor.BlockUnderCursor:
+        if selType == QTextCursor.SelectionType.BlockUnderCursor:
             # This selection mode also selects the preceding paragraph
             # separator, which we want to avoid.
-            posS = theCursor.selectionStart()
-            posE = theCursor.selectionEnd()
-            selTxt = theCursor.selectedText()
+            posS = cursor.selectionStart()
+            posE = cursor.selectionEnd()
+            selTxt = cursor.selectedText()
             if selTxt.startswith(nwUnicode.U_PSEP):
-                theCursor.setPosition(posS+1, QTextCursor.MoveAnchor)
-                theCursor.setPosition(posE, QTextCursor.KeepAnchor)
+                cursor.setPosition(posS+1, QTextCursor.MoveMode.MoveAnchor)
+                cursor.setPosition(posE, QTextCursor.MoveMode.KeepAnchor)
 
-        self.setTextCursor(theCursor)
+        self.setTextCursor(cursor)
 
         return
 
     def _makePosSelection(self, selType: QTextCursor.SelectionType, pos: QPoint) -> None:
         """Handle text selection at a given location."""
-        theCursor = self.cursorForPosition(pos)
-        self.setTextCursor(theCursor)
+        self.setTextCursor(self.cursorForPosition(pos))
         self._makeSelection(selType)
         return
 
@@ -530,20 +520,16 @@ class GuiDocViewer(QTextBrowser):
 
 class GuiDocViewHistory:
 
-    def __init__(self, docViewer):
-
+    def __init__(self, docViewer: GuiDocViewer) -> None:
         self.docViewer = docViewer
-
         self._navHistory = []
         self._posHistory = []
         self._currPos = -1
         self._prevPos = -1
-
         return
 
-    def clear(self):
-        """Clear the view history.
-        """
+    def clear(self) -> None:
+        """Clear the view history."""
         logger.debug("View history cleared")
         self._navHistory = []
         self._posHistory = []
@@ -551,7 +537,7 @@ class GuiDocViewHistory:
         self._prevPos = -1
         return
 
-    def append(self, tHandle):
+    def append(self, tHandle: str) -> bool:
         """Append a document handle and its scroll bar position to the
         history, but only if the document is different than the current
         active entry. Any further entries are truncated.
@@ -577,78 +563,65 @@ class GuiDocViewHistory:
 
         return True
 
-    def forward(self):
-        """Navigate to the next entry in the view history.
-        """
+    def forward(self) -> None:
+        """Navigate to the next entry in the view history."""
         newPos = self._currPos + 1
         if newPos < len(self._navHistory):
             logger.debug("Move forward in view history")
             self._prevPos = self._currPos
             self._updateScrollBar()
-
             self.docViewer.loadText(self._navHistory[newPos], updateHistory=False)
             self.docViewer.setScrollPosition(self._posHistory[newPos])
             self._currPos = newPos
             self._updateNavButtons()
-
             self._dumpHistory()
-
         return
 
-    def backward(self):
-        """Navigate to the previous entry in the view history.
-        """
+    def backward(self) -> None:
+        """Navigate to the previous entry in the view history."""
         newPos = self._currPos - 1
         if newPos >= 0:
             logger.debug("Move backward in view history")
             self._prevPos = self._currPos
             self._updateScrollBar()
-
             self.docViewer.loadText(self._navHistory[newPos], updateHistory=False)
             self.docViewer.setScrollPosition(self._posHistory[newPos])
             self._currPos = newPos
             self._updateNavButtons()
-
             self._dumpHistory()
-
         return
 
     ##
     #  Internal Functions
     ##
 
-    def _updateScrollBar(self):
-        """Update the scrollbar position of the previous entry.
-        """
+    def _updateScrollBar(self) -> None:
+        """Update the scrollbar position of the previous entry."""
         if self._prevPos >= 0 and self._prevPos < len(self._posHistory):
             self._posHistory[self._prevPos] = self.docViewer.scrollPosition
         return
 
-    def _updateNavButtons(self):
-        """Update the navigation buttons in the document header.
-        """
+    def _updateNavButtons(self) -> None:
+        """Update the navigation buttons in the document header."""
         self.docViewer.docHeader.updateNavButtons(0, len(self._navHistory) - 1, self._currPos)
         return
 
-    def _truncateHistory(self, atPos):
+    def _truncateHistory(self, atPos: int) -> None:
         """Truncate the navigation history to the given position. Also
         enforces a maximum length of the navigation history to 20.
         """
         nSkip = 1 if atPos > 19 else 0
-
         self._navHistory = self._navHistory[nSkip:atPos + 1]
         self._posHistory = self._posHistory[nSkip:atPos + 1]
-
         self._currPos -= nSkip
         self._prevPos -= nSkip
-
         return
 
-    def _dumpHistory(self):
+    def _dumpHistory(self) -> None:
         """Debug function to dump history to the logger. Since it is a
         for loop, it is skipped entirely if log level isn't DEBUG.
         """
-        if logger.getEffectiveLevel() == logging.DEBUG:
+        if CONFIG.isDebug:  # pragma: no cover
             for i, (h, p) in enumerate(zip(self._navHistory, self._posHistory)):
                 logger.debug(
                     "History %02d: %s %13s [x:%d]" % (
@@ -667,7 +640,7 @@ class GuiDocViewHistory:
 
 class GuiDocViewHeader(QWidget):
 
-    def __init__(self, docViewer):
+    def __init__(self, docViewer: GuiDocViewer) -> None:
         super().__init__(parent=docViewer)
 
         logger.debug("Create: GuiDocViewHeader")
@@ -685,54 +658,54 @@ class GuiDocViewHeader(QWidget):
         self.setAutoFillBackground(True)
 
         # Title Label
-        self.theTitle = QLabel()
-        self.theTitle.setText("")
-        self.theTitle.setIndent(0)
-        self.theTitle.setMargin(0)
-        self.theTitle.setContentsMargins(0, 0, 0, 0)
-        self.theTitle.setAutoFillBackground(True)
-        self.theTitle.setAlignment(Qt.AlignHCenter | Qt.AlignTop)
-        self.theTitle.setFixedHeight(fPx)
-
-        lblFont = self.theTitle.font()
+        self.docTitle = QLabel()
+        self.docTitle.setText("")
+        self.docTitle.setIndent(0)
+        self.docTitle.setMargin(0)
+        self.docTitle.setContentsMargins(0, 0, 0, 0)
+        self.docTitle.setAutoFillBackground(True)
+        self.docTitle.setAlignment(Qt.AlignmentFlag.AlignHCenter | Qt.AlignmentFlag.AlignTop)
+        self.docTitle.setFixedHeight(fPx)
+
+        lblFont = self.docTitle.font()
         lblFont.setPointSizeF(0.9*SHARED.theme.fontPointSize)
-        self.theTitle.setFont(lblFont)
+        self.docTitle.setFont(lblFont)
 
         # Buttons
         self.backButton = QToolButton(self)
         self.backButton.setContentsMargins(0, 0, 0, 0)
         self.backButton.setIconSize(QSize(fPx, fPx))
         self.backButton.setFixedSize(fPx, fPx)
-        self.backButton.setToolButtonStyle(Qt.ToolButtonIconOnly)
+        self.backButton.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
         self.backButton.setVisible(False)
-        self.backButton.setToolTip(self.tr("Go backward"))
+        self.backButton.setToolTip(self.tr("Go Backward"))
         self.backButton.clicked.connect(self.docViewer.navBackward)
 
         self.forwardButton = QToolButton(self)
         self.forwardButton.setContentsMargins(0, 0, 0, 0)
         self.forwardButton.setIconSize(QSize(fPx, fPx))
         self.forwardButton.setFixedSize(fPx, fPx)
-        self.forwardButton.setToolButtonStyle(Qt.ToolButtonIconOnly)
+        self.forwardButton.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
         self.forwardButton.setVisible(False)
-        self.forwardButton.setToolTip(self.tr("Go forward"))
+        self.forwardButton.setToolTip(self.tr("Go Forward"))
         self.forwardButton.clicked.connect(self.docViewer.navForward)
 
         self.refreshButton = QToolButton(self)
         self.refreshButton.setContentsMargins(0, 0, 0, 0)
         self.refreshButton.setIconSize(QSize(fPx, fPx))
         self.refreshButton.setFixedSize(fPx, fPx)
-        self.refreshButton.setToolButtonStyle(Qt.ToolButtonIconOnly)
+        self.refreshButton.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
         self.refreshButton.setVisible(False)
-        self.refreshButton.setToolTip(self.tr("Reload the document"))
+        self.refreshButton.setToolTip(self.tr("Reload"))
         self.refreshButton.clicked.connect(self._refreshDocument)
 
         self.closeButton = QToolButton(self)
         self.closeButton.setContentsMargins(0, 0, 0, 0)
         self.closeButton.setIconSize(QSize(fPx, fPx))
         self.closeButton.setFixedSize(fPx, fPx)
-        self.closeButton.setToolButtonStyle(Qt.ToolButtonIconOnly)
+        self.closeButton.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
         self.closeButton.setVisible(False)
-        self.closeButton.setToolTip(self.tr("Close the document"))
+        self.closeButton.setToolTip(self.tr("Close"))
         self.closeButton.clicked.connect(self._closeDocument)
 
         # Assemble Layout
@@ -740,7 +713,7 @@ class GuiDocViewHeader(QWidget):
         self.outerBox.setSpacing(hSp)
         self.outerBox.addWidget(self.backButton, 0)
         self.outerBox.addWidget(self.forwardButton, 0)
-        self.outerBox.addWidget(self.theTitle, 1)
+        self.outerBox.addWidget(self.docTitle, 1)
         self.outerBox.addWidget(self.refreshButton, 0)
         self.outerBox.addWidget(self.closeButton, 0)
         self.setLayout(self.outerBox)
@@ -763,9 +736,8 @@ class GuiDocViewHeader(QWidget):
     #  Methods
     ##
 
-    def updateTheme(self):
-        """Update theme elements.
-        """
+    def updateTheme(self) -> None:
+        """Update theme elements."""
         self.backButton.setIcon(SHARED.theme.getIcon("backward"))
         self.forwardButton.setIcon(SHARED.theme.getIcon("forward"))
         self.refreshButton.setIcon(SHARED.theme.getIcon("refresh"))
@@ -785,32 +757,30 @@ class GuiDocViewHeader(QWidget):
 
         return
 
-    def matchColours(self):
+    def matchColours(self) -> None:
         """Update the colours of the widget to match those of the syntax
         theme rather than the main GUI.
         """
-        thePalette = QPalette()
-        thePalette.setColor(QPalette.Window, QColor(*SHARED.theme.colBack))
-        thePalette.setColor(QPalette.WindowText, QColor(*SHARED.theme.colText))
-        thePalette.setColor(QPalette.Text, QColor(*SHARED.theme.colText))
-
-        self.setPalette(thePalette)
-        self.theTitle.setPalette(thePalette)
-
+        palette = QPalette()
+        palette.setColor(QPalette.ColorRole.Window, QColor(*SHARED.theme.colBack))
+        palette.setColor(QPalette.ColorRole.WindowText, QColor(*SHARED.theme.colText))
+        palette.setColor(QPalette.ColorRole.Text, QColor(*SHARED.theme.colText))
+        self.setPalette(palette)
+        self.docTitle.setPalette(palette)
         return
 
-    def setTitleFromHandle(self, tHandle):
+    def setTitleFromHandle(self, tHandle: str | None) -> None:
         """Sets the document title from the handle, or alternatively,
         set the whole document path.
         """
         self._docHandle = tHandle
         if tHandle is None:
-            self.theTitle.setText("")
+            self.docTitle.setText("")
             self.backButton.setVisible(False)
             self.forwardButton.setVisible(False)
             self.closeButton.setVisible(False)
             self.refreshButton.setVisible(False)
-            return True
+            return
 
         pTree = SHARED.project.tree
         if CONFIG.showFullPath:
@@ -821,42 +791,37 @@ class GuiDocViewHeader(QWidget):
                 if nwItem is not None:
                     tTitle.append(nwItem.itemName)
             sSep = "  %s  " % nwUnicode.U_RSAQUO
-            self.theTitle.setText(sSep.join(tTitle))
+            self.docTitle.setText(sSep.join(tTitle))
         else:
-            nwItem = pTree[tHandle]
-            if nwItem is None:
-                return False
-            self.theTitle.setText(nwItem.itemName)
+            if nwItem := pTree[tHandle]:
+                self.docTitle.setText(nwItem.itemName)
 
         self.backButton.setVisible(True)
         self.forwardButton.setVisible(True)
         self.closeButton.setVisible(True)
         self.refreshButton.setVisible(True)
 
-        return True
+        return
 
-    def updateNavButtons(self, firstIdx, lastIdx, currIdx):
-        """Enable and disable nav buttons based on index in history.
-        """
+    def updateNavButtons(self, firstIdx: int, lastIdx: int, currIdx: int) -> None:
+        """Enable and disable nav buttons based on index in history."""
         self.backButton.setEnabled(currIdx > firstIdx)
         self.forwardButton.setEnabled(currIdx < lastIdx)
         return
 
     ##
-    #  Slots
+    #  Private Slots
     ##
 
     @pyqtSlot()
-    def _closeDocument(self):
-        """Trigger the close editor/viewer on the main window.
-        """
+    def _closeDocument(self) -> None:
+        """Trigger the close editor/viewer on the main window."""
         self.mainGui.closeDocViewer()
         return
 
     @pyqtSlot()
-    def _refreshDocument(self):
-        """Reload the content of the document.
-        """
+    def _refreshDocument(self) -> None:
+        """Reload the content of the document."""
         if self.docViewer.docHandle == self.mainGui.docEditor.docHandle:
             self.mainGui.saveDocument()
         self.docViewer.reloadText()
@@ -866,11 +831,12 @@ class GuiDocViewHeader(QWidget):
     #  Events
     ##
 
-    def mousePressEvent(self, theEvent):
+    def mousePressEvent(self, event: QMouseEvent) -> None:
         """Capture a click on the title and ensure that the item is
         selected in the project tree.
         """
-        self.mainGui.projView.setSelectedHandle(self._docHandle, doScroll=True)
+        if event.button() == Qt.MouseButton.LeftButton:
+            self.docViewer.requestProjectItemSelected.emit(self._docHandle, True)
         return
 
 # END Class GuiDocViewHeader
@@ -883,14 +849,13 @@ class GuiDocViewHeader(QWidget):
 
 class GuiDocViewFooter(QWidget):
 
-    def __init__(self, docViewer):
+    def __init__(self, docViewer: GuiDocViewer) -> None:
         super().__init__(parent=docViewer)
 
         logger.debug("Create: GuiDocViewFooter")
 
         self.docViewer = docViewer
         self.mainGui   = docViewer.mainGui
-        self.viewMeta  = docViewer.mainGui.viewMeta
 
         # Internal Variables
         self._docHandle = None
@@ -905,62 +870,33 @@ class GuiDocViewFooter(QWidget):
 
         # Show/Hide Details
         self.showHide = QToolButton(self)
-        self.showHide.setToolButtonStyle(Qt.ToolButtonIconOnly)
+        self.showHide.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
         self.showHide.setIconSize(QSize(fPx, fPx))
         self.showHide.setFixedSize(QSize(fPx, fPx))
-        self.showHide.clicked.connect(self._doShowHide)
-        self.showHide.setToolTip(self.tr("Show/hide the references panel"))
-
-        # Sticky Button
-        self.stickyRefs = QToolButton(self)
-        self.stickyRefs.setCheckable(True)
-        self.stickyRefs.setToolButtonStyle(Qt.ToolButtonIconOnly)
-        self.stickyRefs.setIconSize(QSize(fPx, fPx))
-        self.stickyRefs.setFixedSize(QSize(fPx, fPx))
-        self.stickyRefs.toggled.connect(self._doToggleSticky)
-        self.stickyRefs.setToolTip(self.tr(
-            "Activate to freeze the content of the references panel when changing document"
-        ))
+        self.showHide.clicked.connect(lambda: self.docViewer.togglePanelVisibility.emit())
+        self.showHide.setToolTip(self.tr("Show/Hide Viewer Panel"))
 
         # Show Comments
         self.showComments = QToolButton(self)
         self.showComments.setCheckable(True)
         self.showComments.setChecked(CONFIG.viewComments)
-        self.showComments.setToolButtonStyle(Qt.ToolButtonIconOnly)
+        self.showComments.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
         self.showComments.setIconSize(QSize(fPx, fPx))
         self.showComments.setFixedSize(QSize(fPx, fPx))
         self.showComments.toggled.connect(self._doToggleComments)
-        self.showComments.setToolTip(self.tr("Show comments"))
+        self.showComments.setToolTip(self.tr("Show Comments"))
 
         # Show Synopsis
         self.showSynopsis = QToolButton(self)
         self.showSynopsis.setCheckable(True)
         self.showSynopsis.setChecked(CONFIG.viewSynopsis)
-        self.showSynopsis.setToolButtonStyle(Qt.ToolButtonIconOnly)
+        self.showSynopsis.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
         self.showSynopsis.setIconSize(QSize(fPx, fPx))
         self.showSynopsis.setFixedSize(QSize(fPx, fPx))
         self.showSynopsis.toggled.connect(self._doToggleSynopsis)
-        self.showSynopsis.setToolTip(self.tr("Show synopsis comments"))
+        self.showSynopsis.setToolTip(self.tr("Show Synopsis Comments"))
 
         # Labels
-        self.lblRefs = QLabel(self.tr("References"))
-        self.lblRefs.setBuddy(self.showHide)
-        self.lblRefs.setIndent(0)
-        self.lblRefs.setMargin(0)
-        self.lblRefs.setContentsMargins(0, 0, 0, 0)
-        self.lblRefs.setAutoFillBackground(True)
-        self.lblRefs.setFixedHeight(fPx)
-        self.lblRefs.setAlignment(Qt.AlignLeft | Qt.AlignTop)
-
-        self.lblSticky = QLabel(self.tr("Sticky"))
-        self.lblSticky.setBuddy(self.stickyRefs)
-        self.lblSticky.setIndent(0)
-        self.lblSticky.setMargin(0)
-        self.lblSticky.setContentsMargins(0, 0, 0, 0)
-        self.lblSticky.setAutoFillBackground(True)
-        self.lblSticky.setFixedHeight(fPx)
-        self.lblSticky.setAlignment(Qt.AlignLeft | Qt.AlignTop)
-
         self.lblComments = QLabel(self.tr("Comments"))
         self.lblComments.setBuddy(self.showComments)
         self.lblComments.setIndent(0)
@@ -968,7 +904,7 @@ class GuiDocViewFooter(QWidget):
         self.lblComments.setContentsMargins(0, 0, 0, 0)
         self.lblComments.setAutoFillBackground(True)
         self.lblComments.setFixedHeight(fPx)
-        self.lblComments.setAlignment(Qt.AlignLeft | Qt.AlignTop)
+        self.lblComments.setAlignment(Qt.AlignmentFlag.AlignLeft | Qt.AlignmentFlag.AlignTop)
 
         self.lblSynopsis = QLabel(self.tr("Synopsis"))
         self.lblSynopsis.setBuddy(self.showSynopsis)
@@ -977,12 +913,10 @@ class GuiDocViewFooter(QWidget):
         self.lblSynopsis.setContentsMargins(0, 0, 0, 0)
         self.lblSynopsis.setAutoFillBackground(True)
         self.lblSynopsis.setFixedHeight(fPx)
-        self.lblSynopsis.setAlignment(Qt.AlignLeft | Qt.AlignTop)
+        self.lblSynopsis.setAlignment(Qt.AlignmentFlag.AlignLeft | Qt.AlignmentFlag.AlignTop)
 
         lblFont = self.font()
         lblFont.setPointSizeF(0.9*SHARED.theme.fontPointSize)
-        self.lblRefs.setFont(lblFont)
-        self.lblSticky.setFont(lblFont)
         self.lblComments.setFont(lblFont)
         self.lblSynopsis.setFont(lblFont)
 
@@ -990,10 +924,6 @@ class GuiDocViewFooter(QWidget):
         self.outerBox = QHBoxLayout()
         self.outerBox.setSpacing(bSp)
         self.outerBox.addWidget(self.showHide, 0)
-        self.outerBox.addWidget(self.lblRefs, 0)
-        self.outerBox.addSpacing(hSp)
-        self.outerBox.addWidget(self.stickyRefs, 0)
-        self.outerBox.addWidget(self.lblSticky, 0)
         self.outerBox.addStretch(1)
         self.outerBox.addWidget(self.showComments, 0)
         self.outerBox.addWidget(self.lblComments, 0)
@@ -1020,39 +950,23 @@ class GuiDocViewFooter(QWidget):
     #  Methods
     ##
 
-    def updateTheme(self):
-        """Update theme elements.
-        """
+    def updateTheme(self) -> None:
+        """Update theme elements."""
         # Icons
-
         fPx = int(0.9*SHARED.theme.fontPixelSize)
+        bulletIcon = SHARED.theme.getToggleIcon("bullet", (fPx, fPx))
 
-        stickyOn  = SHARED.theme.getPixmap("sticky-on", (fPx, fPx))
-        stickyOff = SHARED.theme.getPixmap("sticky-off", (fPx, fPx))
-        stickyIcon = QIcon()
-        stickyIcon.addPixmap(stickyOn, QIcon.Normal, QIcon.On)
-        stickyIcon.addPixmap(stickyOff, QIcon.Normal, QIcon.Off)
-
-        bulletOn  = SHARED.theme.getPixmap("bullet-on", (fPx, fPx))
-        bulletOff = SHARED.theme.getPixmap("bullet-off", (fPx, fPx))
-        bulletIcon = QIcon()
-        bulletIcon.addPixmap(bulletOn, QIcon.Normal, QIcon.On)
-        bulletIcon.addPixmap(bulletOff, QIcon.Normal, QIcon.Off)
-
-        self.showHide.setIcon(SHARED.theme.getIcon("reference"))
-        self.stickyRefs.setIcon(stickyIcon)
+        self.showHide.setIcon(SHARED.theme.getIcon("panel"))
         self.showComments.setIcon(bulletIcon)
         self.showSynopsis.setIcon(bulletIcon)
 
         # StyleSheets
-
         buttonStyle = (
             "QToolButton {{border: none; background: transparent;}} "
             "QToolButton:hover {{border: none; background: rgba({0},{1},{2},0.2);}}"
         ).format(*SHARED.theme.colText)
 
         self.showHide.setStyleSheet(buttonStyle)
-        self.stickyRefs.setStyleSheet(buttonStyle)
         self.showComments.setStyleSheet(buttonStyle)
         self.showSynopsis.setStyleSheet(buttonStyle)
 
@@ -1060,138 +974,35 @@ class GuiDocViewFooter(QWidget):
 
         return
 
-    def matchColours(self):
+    def matchColours(self) -> None:
         """Update the colours of the widget to match those of the syntax
         theme rather than the main GUI.
         """
-        thePalette = QPalette()
-        thePalette.setColor(QPalette.Window, QColor(*SHARED.theme.colBack))
-        thePalette.setColor(QPalette.WindowText, QColor(*SHARED.theme.colText))
-        thePalette.setColor(QPalette.Text, QColor(*SHARED.theme.colText))
-
-        self.setPalette(thePalette)
-        self.lblRefs.setPalette(thePalette)
-        self.lblSticky.setPalette(thePalette)
-        self.lblComments.setPalette(thePalette)
-        self.lblSynopsis.setPalette(thePalette)
-
+        palette = QPalette()
+        palette.setColor(QPalette.ColorRole.Window, QColor(*SHARED.theme.colBack))
+        palette.setColor(QPalette.ColorRole.WindowText, QColor(*SHARED.theme.colText))
+        palette.setColor(QPalette.ColorRole.Text, QColor(*SHARED.theme.colText))
+        self.setPalette(palette)
+        self.lblComments.setPalette(palette)
+        self.lblSynopsis.setPalette(palette)
         return
 
     ##
-    #  Slots
+    #  Private Slots
     ##
 
-    @pyqtSlot()
-    def _doShowHide(self):
-        """Toggle the expand/collapse of the panel.
-        """
-        isVisible = self.viewMeta.isVisible()
-        self.viewMeta.setVisible(not isVisible)
-        return
-
     @pyqtSlot(bool)
-    def _doToggleSticky(self, theState):
-        """Toggle the sticky flag for the reference panel.
-        """
-        logger.debug("Reference sticky is %s", str(theState))
-        self.docViewer.stickyRef = theState
-        if not theState and self.docViewer.docHandle is not None:
-            self.viewMeta.refreshReferences(self.docViewer.docHandle)
-        return
-
-    @pyqtSlot(bool)
-    def _doToggleComments(self, theState):
-        """Toggle the view comment button and reload the document.
-        """
-        CONFIG.viewComments = theState
+    def _doToggleComments(self, state: bool) -> None:
+        """Toggle the view comment button and reload the document."""
+        CONFIG.viewComments = state
         self.docViewer.reloadText()
         return
 
     @pyqtSlot(bool)
-    def _doToggleSynopsis(self, theState):
-        """Toggle the view synopsis button and reload the document.
-        """
-        CONFIG.viewSynopsis = theState
+    def _doToggleSynopsis(self, state: bool) -> None:
+        """Toggle the view synopsis button and reload the document."""
+        CONFIG.viewSynopsis = state
         self.docViewer.reloadText()
         return
 
 # END Class GuiDocViewFooter
-
-
-# =============================================================================================== #
-#  The Document Back-Reference Panel
-#  Placed in a separate QSplitter position in the main GUI window
-# =============================================================================================== #
-
-class GuiDocViewDetails(QScrollArea):
-
-    def __init__(self, mainGui):
-        super().__init__(parent=mainGui)
-
-        logger.debug("Create: GuiDocViewDetails")
-
-        self.mainGui = mainGui
-
-        self.refList = QLabel("")
-        self.refList.setWordWrap(True)
-        self.refList.setAlignment(Qt.AlignTop)
-        self.refList.setScaledContents(True)
-        self.refList.linkActivated.connect(self._linkClicked)
-
-        self.linkStyle = "style='color: rgb({0},{1},{2})'".format(*SHARED.theme.colLink)
-
-        # Assemble
-        self.outerWidget = QWidget()
-        self.outerBox = QHBoxLayout()
-        self.outerBox.addWidget(self.refList, 1)
-
-        self.outerWidget.setLayout(self.outerBox)
-        self.setWidget(self.outerWidget)
-
-        self.setHorizontalScrollBarPolicy(Qt.ScrollBarAsNeeded)
-        self.setVerticalScrollBarPolicy(Qt.ScrollBarAsNeeded)
-        self.setWidgetResizable(True)
-        self.setMinimumHeight(CONFIG.pxInt(50))
-        self.setFrameStyle(QFrame.NoFrame)
-
-        logger.debug("Ready: GuiDocViewDetails")
-
-        return
-
-    def refreshReferences(self, tHandle):
-        """Update the current list of document references from the
-        project index.
-        """
-        if self.mainGui.docViewer.stickyRef:
-            return
-
-        theRefs = SHARED.project.index.getBackReferenceList(tHandle)
-        theList = []
-        for tHandle in theRefs:
-            tItem = SHARED.project.tree[tHandle]
-            if tItem is not None:
-                theList.append("<a href='%s#%s' %s>%s</a>" % (
-                    tHandle, theRefs[tHandle], self.linkStyle, tItem.itemName
-                ))
-
-        self.refList.setText(", ".join(theList))
-
-        return
-
-    ##
-    #  Private Slots
-    ##
-
-    @pyqtSlot(str)
-    def _linkClicked(self, theLink):
-        """Capture the link-click and forward it to the document viewer
-        class for handling.
-        """
-        logger.debug("Clicked link: '%s'", theLink)
-        if len(theLink) >= 13:
-            tHandle = theLink[:13]
-            tAnchor = theLink[13:] or None
-            self.mainGui.viewDocument(tHandle, tAnchor)
-        return
-
-# END Class GuiDocViewDetails