eric6/Helpviewer/HelpTocWidget.py

changeset 6942
2602857055c5
parent 6645
ad476851d7e0
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/Helpviewer/HelpTocWidget.py	Sun Apr 14 15:09:21 2019 +0200
@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2009 - 2019 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a window for showing the QtHelp TOC.
+"""
+
+from __future__ import unicode_literals
+
+from PyQt5.QtCore import pyqtSignal, pyqtSlot, Qt, QUrl
+from PyQt5.QtWidgets import QWidget, QVBoxLayout, QMenu, QApplication
+
+
+class HelpTocWidget(QWidget):
+    """
+    Class implementing a window for showing the QtHelp TOC.
+    
+    @signal linkActivated(QUrl) emitted when a TOC entry is activated
+    @signal escapePressed() emitted when the ESC key was pressed
+    """
+    linkActivated = pyqtSignal(QUrl)
+    escapePressed = pyqtSignal()
+    
+    def __init__(self, engine, mainWindow, parent=None):
+        """
+        Constructor
+        
+        @param engine reference to the help engine (QHelpEngine)
+        @param mainWindow reference to the main window object (QMainWindow)
+        @param parent reference to the parent widget (QWidget)
+        """
+        super(HelpTocWidget, self).__init__(parent)
+        
+        self.__engine = engine
+        self.__mw = mainWindow
+        self.__expandDepth = -2
+        
+        self.__tocWidget = self.__engine.contentWidget()
+        self.__tocWidget.setContextMenuPolicy(Qt.CustomContextMenu)
+        
+        self.__layout = QVBoxLayout(self)
+        self.__layout.addWidget(self.__tocWidget)
+        
+        self.__tocWidget.customContextMenuRequested.connect(
+            self.__showContextMenu)
+        self.__tocWidget.linkActivated.connect(self.__linkActivated)
+        
+        model = self.__tocWidget.model()
+        model.contentsCreated.connect(self.__expandTOC)
+    
+    @pyqtSlot(QUrl)
+    def __linkActivated(self, url):
+        """
+        Private slot handling the activation of an entry.
+        
+        @param url URL of the activated entry
+        @type QUrl
+        """
+        if not url.isEmpty() and url.isValid():
+            buttons = QApplication.mouseButtons()
+            modifiers = QApplication.keyboardModifiers()
+            
+            if buttons & Qt.MidButton:
+                self.__mw.newTab(url)
+            else:
+                if modifiers & Qt.ControlModifier:
+                    self.__mw.newTab(url)
+                else:
+                    self.linkActivated.emit(url)
+    
+    def __expandTOC(self):
+        """
+        Private slot to expand the table of contents.
+        """
+        if self.__expandDepth > -2:
+            self.expandToDepth(self.__expandDepth)
+            self.__expandDepth = -2
+    
+    def expandToDepth(self, depth):
+        """
+        Public slot to expand the table of contents to a specific depth.
+        
+        @param depth depth to expand to (integer)
+        """
+        self.__expandDepth = depth
+        if depth == -1:
+            self.__tocWidget.expandAll()
+        else:
+            self.__tocWidget.expandToDepth(depth)
+    
+    def focusInEvent(self, evt):
+        """
+        Protected method handling focus in events.
+        
+        @param evt reference to the focus event object (QFocusEvent)
+        """
+        if evt.reason() != Qt.MouseFocusReason:
+            self.__tocWidget.setFocus()
+    
+    def keyPressEvent(self, evt):
+        """
+        Protected method handling key press events.
+        
+        @param evt reference to the key press event (QKeyEvent)
+        """
+        if evt.key() == Qt.Key_Escape:
+            self.escapePressed.emit()
+    
+    def itemClicked(self, index):
+        """
+        Public slot handling a click of a TOC entry.
+        
+        @param index index of the TOC clicked (QModelIndex)
+        """
+        if not index.isValid():
+            return
+        
+        model = self.__tocWidget.model()
+        itm = model.contentItemAt(index)
+        if itm:
+            self.linkActivated.emit(itm.url())
+    
+    def syncToContent(self, url):
+        """
+        Public method to sync the TOC to the displayed page.
+        
+        @param url URL of the displayed page (QUrl)
+        @return flag indicating a successful synchronization (boolean)
+        """
+        idx = self.__tocWidget.indexOf(url)
+        if not idx.isValid():
+            return False
+        self.__tocWidget.setCurrentIndex(idx)
+        return True
+    
+    def __showContextMenu(self, pos):
+        """
+        Private slot showing the context menu.
+        
+        @param pos position to show the menu at (QPoint)
+        """
+        if not self.__tocWidget.indexAt(pos).isValid():
+            return
+        
+        menu = QMenu()
+        curTab = menu.addAction(self.tr("Open Link"))
+        newTab = menu.addAction(self.tr("Open Link in New Tab"))
+        menu.move(self.__tocWidget.mapToGlobal(pos))
+        
+        model = self.__tocWidget.model()
+        itm = model.contentItemAt(self.__tocWidget.currentIndex())
+        
+        act = menu.exec_()
+        if act == curTab:
+            self.linkActivated.emit(itm.url())
+        elif act == newTab:
+            self.__mw.newTab(itm.url())

eric ide

mercurial