eric: comparison Helpviewer/HelpWindow.py

-:4c0b3ee7d2d8
+:7454861e4106
 privacyChanged = pyqtSignal(bool)
 helpwindows = []
 _fromEric = False
-useQtHelp = QTHELP_AVAILABLE
+_useQtHelp = QTHELP_AVAILABLE
 _networkAccessManager = None
 _cookieJar = None
 _helpEngine = None
 _bookmarksManager = None
 # initialize some SSL stuff
 from E5Network.E5SslUtilities import initSSL
 initSSL()
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
-self.__helpEngine = \
+self.__helpEngine = QHelpEngine(
-QHelpEngine(os.path.join(Utilities.getConfigDir(),
+HelpWindow.getQtHelpCollectionFileName(),
-"browser", "eric6help.qhc"), self)
+self)
 self.__removeOldDocumentation()
 self.__helpEngine.warning.connect(self.__warning)
 else:
 self.__helpEngine = None
 self.__helpInstaller = None
 QSizePolicy.Preferred, QSizePolicy.Expanding)
 centralWidget.setLayout(layout)
 self.setCentralWidget(centralWidget)
 self.findDlg.hide()
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 # setup the TOC widget
 self.__tocWindow = HelpTocWidget(self.__helpEngine, self)
 self.__tocDock = QDockWidget(self.tr("Contents"), self)
 self.__tocDock.setObjectName("TocWindow")
 self.__tocDock.setWidget(self.__tocWindow)
 QDesktopServices.setUrlHandler("http", self.__linkActivated)
 QDesktopServices.setUrlHandler("https", self.__linkActivated)
 # setup connections
 self.__activating = False
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 # TOC window
 self.__tocWindow.linkActivated.connect(self.__linkActivated)
 self.__tocWindow.escapePressed.connect(
 self.__activateCurrentBrowser)
 # index window
 self.__shutdownCalled = False
 self.flashCookieManager()
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 QTimer.singleShot(0, self.__lookForNewDocumentation)
 if self.__searchWord is not None:
 QTimer.singleShot(0, self.__searchForWord)
 e5App().focusChanged.connect(self.__appFocusChanged)
 if not self.initShortcutsOnly:
 self.featurePermissionAct.triggered.connect(
 self.__showFeaturePermissionDialog)
 self.__actions.append(self.featurePermissionAct)
-if self.useQtHelp or self.initShortcutsOnly:
+if HelpWindow._useQtHelp or self.initShortcutsOnly:
 self.syncTocAct = E5Action(
 self.tr('Sync with Table of Contents'),
 UI.PixmapCache.getIcon("syncToc.png"),
 self.tr('Sync with Table of Contents'),
 0, 0, self, 'help_sync_toc')
 menu.addAction(self.forwardAct)
 menu.addAction(self.homeAct)
 menu.addSeparator()
 menu.addAction(self.stopAct)
 menu.addAction(self.reloadAct)
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 menu.addSeparator()
 menu.addAction(self.syncTocAct)
 from .History.HistoryMenu import HistoryMenu
 self.historyMenu = HistoryMenu(self, self.tabWidget)
 self.__userAgentMenu = UserAgentMenu(self.tr("Global User Agent"))
 menu.addMenu(self.__userAgentMenu)
 menu.addAction(self.userAgentManagerAct)
 menu.addSeparator()
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 menu.addAction(self.manageQtHelpDocsAct)
 menu.addAction(self.manageQtHelpFiltersAct)
 menu.addAction(self.reindexDocumentationAct)
 menu.addSeparator()
 menu.addAction(self.clearPrivateDataAct)
 menu.addAction(self.toolsMonitorAct)
 menu = mb.addMenu(self.tr("&Window"))
 menu.setTearOffEnabled(True)
 menu.addAction(self.showDownloadManagerAct)
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 menu.addSeparator()
 menu.addAction(self.showTocAct)
 menu.addAction(self.showIndexAct)
 menu.addAction(self.showSearchAct)
 findtb.setIconSize(UI.Config.ToolBarIconSize)
 findtb.addAction(self.findAct)
 findtb.addAction(self.findNextAct)
 findtb.addAction(self.findPrevAct)
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 filtertb = self.addToolBar(self.tr("Filter"))
 filtertb.setObjectName("FilterToolBar")
 self.filterCombo = QComboBox()
 self.filterCombo.setMinimumWidth(
 QFontMetrics(QFont()).width("ComboBoxWithEnoughWidth"))
 self.flashCookieManager().shutdown()
 self.searchEdit.openSearchManager().close()
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 self.__searchEngine.cancelIndexing()
 self.__searchEngine.cancelSearching()
 if self.__helpInstaller:
 self.__helpInstaller.stop()
 Class method to set the QtHelp usage.
 @param use flag indicating usage (boolean)
 """
 if use:
-cls.useQtHelp = use and QTHELP_AVAILABLE
+cls._useQtHelp = use and QTHELP_AVAILABLE
 else:
-cls.useQtHelp = False
+cls._useQtHelp = False
 @classmethod
 def helpEngine(cls):
 """
 Class method to get a reference to the help engine.
 @return reference to the help engine (QHelpEngine)
 """
 if cls.useQtHelp:
 if cls._helpEngine is None:
-cls._helpEngine = \
+cls._helpEngine = QHelpEngine(
-QHelpEngine(os.path.join(Utilities.getConfigDir(),
+HelpWindow.getQtHelpCollectionFileName())
-"browser", "eric6help.qhc"))
 return cls._helpEngine
 else:
 return None
+@classmethod
+def getQtHelpCollectionFileName(cls):
+"""
+Class method to determine the name of the QtHelp collection file.
+@return path of the QtHelp collection file
+@rtype str
+"""
+qthelpDir = os.path.join(Utilities.getConfigDir(), "qthelp")
+if not os.path.exists(qthelpDir):
+os.makedirs(qthelpDir)
+return os.path.join(qthelpDir, "eric6help.qhc")
 @classmethod
 def networkAccessManager(cls):
 """
 Class method to get a reference to the network access manager.
 def __syncTOC(self):
 """
 Private slot to synchronize the TOC with the currently shown page.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 QApplication.setOverrideCursor(Qt.WaitCursor)
 url = self.currentBrowser().source()
 self.__showTocWindow()
 if not self.__tocWindow.syncToContent(url):
 self.statusBar().showMessage(
 def __showTocWindow(self):
 """
 Private method to show the table of contents window.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 self.__activateDock(self.__tocWindow)
 def __hideTocWindow(self):
 """
 Private method to hide the table of contents window.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 self.__tocDock.hide()
 def __showIndexWindow(self):
 """
 Private method to show the index window.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 self.__activateDock(self.__indexWindow)
 def __hideIndexWindow(self):
 """
 Private method to hide the index window.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 self.__indexDock.hide()
 def __showSearchWindow(self):
 """
 Private method to show the search window.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 self.__activateDock(self.__searchWindow)
 def __hideSearchWindow(self):
 """
 Private method to hide the search window.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 self.__searchDock.hide()
 def __activateDock(self, widget):
 """
 Private method to activate the dock widget of the given widget.
 def __setupFilterCombo(self):
 """
 Private slot to setup the filter combo box.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 curFilter = self.filterCombo.currentText()
 if not curFilter:
 curFilter = self.__helpEngine.currentFilter()
 self.filterCombo.clear()
 self.filterCombo.addItems(self.__helpEngine.customFilters())
 def __manageQtHelpDocumentation(self):
 """
 Private slot to manage the QtHelp documentation database.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 from .QtHelpDocumentationDialog import QtHelpDocumentationDialog
 dlg = QtHelpDocumentationDialog(self.__helpEngine, self)
 dlg.exec_()
 if dlg.hasChanges():
 for i in sorted(dlg.getTabsToClose(), reverse=True):
 def __manageQtHelpFilters(self):
 """
 Private slot to manage the QtHelp filters.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 from .QtHelpFiltersDialog import QtHelpFiltersDialog
 dlg = QtHelpFiltersDialog(self.__helpEngine, self)
 dlg.exec_()
 def __indexingStarted(self):
 """
 Private slot to handle the start of the indexing process.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 self.__indexing = True
 if self.__indexingProgress is None:
 self.__indexingProgress = QWidget()
 layout = QHBoxLayout(self.__indexingProgress)
 layout.setContentsMargins(0, 0, 0, 0)
 def __indexingFinished(self):
 """
 Private slot to handle the start of the indexing process.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 self.statusBar().removeWidget(self.__indexingProgress)
 self.__indexingProgress = None
 self.__indexing = False
 if self.__searchWord is not None:
 self.__searchForWord()
 def __searchForWord(self):
 """
 Private slot to search for a word.
 """
-if self.useQtHelp and not self.__indexing and \
+if HelpWindow._useQtHelp and not self.__indexing and \
 self.__searchWord is not None:
 self.__searchDock.show()
 self.__searchDock.raise_()
 query = QHelpSearchQuery(QHelpSearchQuery.DEFAULT,
 [self.__searchWord])
 """
 Public method to search for a word.
 @param word word to search for (string)
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 self.__searchWord = word
 self.__searchForWord()
 def __removeOldDocumentation(self):
 """
 def __lookForNewDocumentation(self):
 """
 Private slot to look for new documentation to be loaded into the
 help database.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 from .HelpDocsInstaller import HelpDocsInstaller
 self.__helpInstaller = HelpDocsInstaller(
 self.__helpEngine.collectionFile())
 self.__helpInstaller.errorMessage.connect(
 self.__showInstallationError)
 Private slot handling the end of documentation installation.
 @param installed flag indicating that documents were installed
 (boolean)
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 if installed:
 self.__helpEngine.setupData()
 self.statusBar().clearMessage()
 def __initHelpDb(self):
 """
 Private slot to initialize the documentation database.
 """
-if self.useQtHelp:
+if HelpWindow._useQtHelp:
 if not self.__helpEngine.setupData():
 return
 unfiltered = self.tr("Unfiltered")
 if unfiltered not in self.__helpEngine.customFilters():

Mercurial Repositories > eric / file comparison

comparison: Helpviewer/HelpWindow.py

Helpviewer/HelpWindow.py