1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
#!/usr/bin/env python3
#****************************************************************************
# helpview.py, provides a window for viewing an html help file
#
# Copyright (C) 2017, Douglas W. Bell
#
# This is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License, either Version 2 or any later
# version. This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY. See the included LICENSE file for details.
#*****************************************************************************
from PyQt5.QtCore import QUrl, Qt
from PyQt5.QtGui import QTextDocument
from PyQt5.QtWidgets import (QAction, QLabel, QLineEdit, QMainWindow, QMenu,
QStatusBar, QTextBrowser)
import dataeditors
class HelpView(QMainWindow):
"""Main window for viewing an html help file.
"""
def __init__(self, pathObj, caption, icons, parent=None):
"""Helpview initialize with text.
Arguments:
pathObj -- a path object for the help file
caption -- the window caption
icons -- dict of view icons
"""
QMainWindow.__init__(self, parent)
self.setAttribute(Qt.WA_QuitOnClose, False)
self.setWindowFlags(Qt.Window)
self.setStatusBar(QStatusBar())
self.textView = HelpViewer(self)
self.setCentralWidget(self.textView)
self.textView.setSearchPaths([str(pathObj.parent)])
self.textView.setSource(QUrl(pathObj.as_uri()))
self.resize(520, 440)
self.setWindowTitle(caption)
tools = self.addToolBar(_('Tools'))
self.menu = QMenu(self.textView)
self.textView.highlighted[str].connect(self.showLink)
backAct = QAction(_('&Back'), self)
backAct.setIcon(icons['helpback'])
tools.addAction(backAct)
self.menu.addAction(backAct)
backAct.triggered.connect(self.textView.backward)
backAct.setEnabled(False)
self.textView.backwardAvailable.connect(backAct.setEnabled)
forwardAct = QAction(_('&Forward'), self)
forwardAct.setIcon(icons['helpforward'])
tools.addAction(forwardAct)
self.menu.addAction(forwardAct)
forwardAct.triggered.connect(self.textView.forward)
forwardAct.setEnabled(False)
self.textView.forwardAvailable.connect(forwardAct.setEnabled)
homeAct = QAction(_('&Home'), self)
homeAct.setIcon(icons['helphome'])
tools.addAction(homeAct)
self.menu.addAction(homeAct)
homeAct.triggered.connect(self.textView.home)
tools.addSeparator()
tools.addSeparator()
findLabel = QLabel(_(' Find: '), self)
tools.addWidget(findLabel)
self.findEdit = QLineEdit(self)
tools.addWidget(self.findEdit)
self.findEdit.textEdited.connect(self.findTextChanged)
self.findEdit.returnPressed.connect(self.findNext)
self.findPreviousAct = QAction(_('Find &Previous'), self)
self.findPreviousAct.setIcon(icons['helpprevious'])
tools.addAction(self.findPreviousAct)
self.menu.addAction(self.findPreviousAct)
self.findPreviousAct.triggered.connect(self.findPrevious)
self.findPreviousAct.setEnabled(False)
self.findNextAct = QAction(_('Find &Next'), self)
self.findNextAct.setIcon(icons['helpnext'])
tools.addAction(self.findNextAct)
self.menu.addAction(self.findNextAct)
self.findNextAct.triggered.connect(self.findNext)
self.findNextAct.setEnabled(False)
def showLink(self, text):
"""Send link text to the statusbar.
Arguments:
text -- link text to show
"""
self.statusBar().showMessage(text)
def findTextChanged(self, text):
"""Update find controls based on text in text edit.
Arguments:
text -- the search text
"""
self.findPreviousAct.setEnabled(len(text) > 0)
self.findNextAct.setEnabled(len(text) > 0)
def findPrevious(self):
"""Command to find the previous string.
"""
if self.textView.find(self.findEdit.text(),
QTextDocument.FindBackward):
self.statusBar().clearMessage()
else:
self.statusBar().showMessage(_('Text string not found'))
def findNext(self):
"""Command to find the next string.
"""
if self.textView.find(self.findEdit.text()):
self.statusBar().clearMessage()
else:
self.statusBar().showMessage(_('Text string not found'))
class HelpViewer(QTextBrowser):
"""Shows an html help file.
"""
def __init__(self, parent=None):
"""Initialize the viewer.
Arguments:
parent -- the parent widget, if given
"""
QTextBrowser.__init__(self, parent)
def setSource(self, url):
"""Called when user clicks on a URL.
Arguments:
url -- the clicked on QUrl
"""
name = url.toString()
if name.startswith('http'):
dataeditors.openExtUrl(name)
else:
QTextBrowser.setSource(self, QUrl(name))
def contextMenuEvent(self, event):
"""Init popup menu on right click"".
Arguments:
event -- the menu event
"""
self.parentWidget().menu.exec_(event.globalPos())
|
