linkchecker/linkcheck/gui/help.py
Bastian Kleineidam d51ee5e61e Updated copyright.
2010-11-20 12:02:35 +01:00

74 lines
2.7 KiB
Python

# -*- coding: iso-8859-1 -*-
# Copyright (C) 2009-2010 Bastian Kleineidam
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
from .. import configuration
from PyQt4 import QtCore, QtGui, QtHelp
class HelpWindow (QtGui.QDialog):
"""A custom help display dialog."""
def __init__ (self, parent, qhcpath):
"""Initialize dialog and load qhc help project from given path."""
super(HelpWindow, self).__init__(parent)
self.engine = QtHelp.QHelpEngine(qhcpath, self)
self.engine.setupData()
self.setWindowTitle(u"%s Help" % configuration.AppName)
self.build_ui()
def build_ui (self):
"""Build UI for the help window."""
splitter = QtGui.QSplitter()
splitter.setOrientation(QtCore.Qt.Vertical)
self.browser = HelpBrowser(splitter, self.engine)
tree = self.engine.contentWidget()
tree.setExpandsOnDoubleClick(False)
tree.linkActivated.connect(self.browser.setSource)
splitter.addWidget(tree)
splitter.addWidget(self.browser)
splitter.setSizes((70, 530))
hlayout = QtGui.QHBoxLayout()
hlayout.addWidget(splitter)
self.setLayout(hlayout)
self.resize(800, 600)
def showDocumentation (self, url):
"""Show given URL in help browser."""
self.browser.setSource(url)
self.show()
class HelpBrowser (QtGui.QTextBrowser):
"""A QTextBrowser that can handle qthelp:// URLs."""
def __init__ (self, parent, engine):
"""Initialize and store given HelpEngine instance."""
super(HelpBrowser, self).__init__(parent)
self.engine = engine
def setSource (self, url):
if url.scheme() == "http":
import webbrowser
webbrowser.open(str(url.toString()))
else:
QtGui.QTextBrowser.setSource(self, url)
def loadResource (self, rtype, url):
"""Handle qthelp:// URLs, load content from help engine."""
if url.scheme() == "qthelp":
return QtCore.QVariant(self.engine.fileData(url))
return QtGui.QTextBrowser.loadResource(self, rtype, url)