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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
# GNU Solfege - free ear training software
# Copyright (C) 2005, 2006, 2007, 2008 Tom Cato Amundsen
#
# 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 3 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, see <http://www.gnu.org/licenses/>.
import gtk
import history
import utils
import os
import filesystem
import i18n
from htmlwidget import HtmlWidget
class DocViewer(gtk.VBox):
"""
The purpose of this class is to:
- provide the status bar
- select the correct translation of a document
"""
def __init__(self, activate_cb):
gtk.VBox.__init__(self)
self.m_htmlwidget = HtmlWidget(activate_cb, self.on_anchor_track)
self.m_htmlwidget.show_all()
self.pack_start(self.m_htmlwidget)
self.set_size_request(500, 300)
self.get_vadjustment = self.m_htmlwidget.get_vadjustment
self.on_key_press_event = self.m_htmlwidget.on_key_press_event
self.m_statusbar = gtk.Statusbar()
self.m_statusbar.show()
self.pack_start(self.m_statusbar, False)
self.source = self.m_htmlwidget.source
self.grab_focus = self.m_htmlwidget.grab_focus
self.m_language = "C"
for lang in i18n.langs():
if os.path.isdir(os.path.join('help', lang)):
self.m_language = lang
break
self.m_htmlwidget.m_document_wd = os.path.join("help", self.m_language)
def read_docfile(self, fn, anchor):
"""
We reread the docfile even if we are already displaying this file,
just in case it has changed on disk.
fn is one of two:
1. A absolute path to a file that we should read. Display 'File
not found' if exactly this file is not found.
2. Relative path to a file relative to the file currently displayed
in m_htmlwidget.
Set self.m_loaded_file.
"""
try:
if fn:
if os.path.isabs(fn):
self.m_htmlwidget.read_file_abs(fn)
else:
if not os.path.exists(os.path.join(self.m_htmlwidget.m_document_wd, fn)):
fn = os.path.normpath(os.path.join("../C", fn))
self.m_htmlwidget.read_file_rel(fn)
self.m_loaded_file = fn
if anchor and 'g_view' in dir(self.m_htmlwidget):
self.m_htmlwidget.g_view.jump_to_anchor(anchor)
except IOError:
self.m_htmlwidget.source("<html>File not found: '%s'</html>" % fn)
def on_anchor_track(self, url):
if url:
# remove newlines in url because it make the window resize
s = url.replace("\n", "")
self.m_statusbar.pop(1)
self.m_statusbar.push(1, s)
else:
self.m_statusbar.pop(1)
class HelpBrowser(gtk.Window):
def __init__(self, app):
gtk.Window.__init__(self)
self.m_app = app
self.m_history = history.History()
self.g_action_group = gtk.ActionGroup('HelpBrowser')
self.g_action_group.add_actions([
('HelpToolbar', None, 'help'),
('HelpBrowserBack', 'gtk-go-back', None, None, None,
self.history_back),
('HelpBrowserForward', 'gtk-go-forward', None, None, None,
self.history_forward),
('HelpBrowserRefresh', 'gtk-refresh', None, None, None, self.refresh),
('HelpBrowserHome', 'gtk-home', None, None, None, self.go_home),
('HelpBrowserClose', 'gtk-close', None, None, _("Close the window"), self.hide_on_delete),
])
self.g_ui_manager = gtk.UIManager()
self.g_ui_manager.insert_action_group(self.g_action_group, 0)
self.g_ui_manager.add_ui_from_file("helpbrowser.xml")
self.add_accel_group(self.g_ui_manager.get_accel_group())
self.g_ui_manager.get_accel_group().connect_group(gtk.keysyms.W,
gtk.gdk.CONTROL_MASK, 0,
self.hide_on_delete)
self.vbox = gtk.VBox()
self.add(self.vbox)
self.vbox.pack_start(self.g_ui_manager.get_widget("/HelpToolbar"), False)
#self.add_accel_group(self.g_ui_manager.get_accel_group())
self.set_default_size(550, 500)
self.g_docviewer = DocViewer(self.handle_href)
self.vbox.pack_start(self.g_docviewer)
self.connect('delete_event', self.hide_on_delete)
self.show_all()
def go_home(self, action):
self.show_docfile('index.html')
def refresh(self, action):
self.m_history.set_adj_of_current(self.g_docviewer.get_vadjustment().get_value())
self.show_docfile(*self.m_history.get_current()[0].split("#"))
while gtk.events_pending(): gtk.main_iteration()
adj = self.m_history.get_current()[1]
if not adj:
adj = 0.0
self.g_docviewer.get_vadjustment().set_value(adj)
def history_back(self, action):
self.m_history.set_adj_of_current(self.g_docviewer.get_vadjustment().get_value())
self.m_history.back()
self.m_history.lock()
self.show_docfile(*self.m_history.get_current()[0].split("#"))
self.m_history.unlock()
while gtk.events_pending(): gtk.main_iteration()
adj = self.m_history.get_current()[1]
if not adj:
adj = 0.0
self.g_docviewer.get_vadjustment().set_value(adj)
def history_forward(self, action):
self.m_history.set_adj_of_current(self.g_docviewer.get_vadjustment().get_value())
self.m_history.forward()
self.m_history.lock()
self.show_docfile(*self.m_history.get_current()[0].split("#"))
self.m_history.unlock()
while gtk.events_pending(): gtk.main_iteration()
adj = self.m_history.get_current()[1]
if not adj:
adj = 0.0
self.g_docviewer.get_vadjustment().set_value(adj)
def handle_href(self, href):
"""
If href is the name of a HTML file, then we display it.
If not, we call m_app.handle_href to take care of it.
"""
urlobj = utils.Url(href)
if not(not urlobj.protocol and urlobj.filename.endswith(".html")):
self.m_app.handle_href(href)
return
fn = href.split("#")[0]
anchor = "#".join(href.split("#")[1:])
# If history is locked, then we are probably called from the back
# or forward functions, and they handle adjustment themselves.
if not self.m_history.m_lock:
self.m_history.set_adj_of_current(self.g_docviewer.get_vadjustment().get_value())
saved_document_wd = self.g_docviewer.m_htmlwidget.m_document_wd
self.g_docviewer.read_docfile(fn, anchor)
# Find the absolute path to the file filename
absname = os.path.join(os.getcwdu(),
saved_document_wd, self.g_docviewer.m_loaded_file)
self.m_history.add(absname)
def show_docfile(self, filename, anchor=None):
"""
Load a html file relative to the help directory for the current
language, for example help/C or help/no. But try the same file
in help/C if the file does not exist for the language we are using.
"""
absname = os.path.join(os.getcwdu(), "help", self.g_docviewer.m_language, filename)
if not os.path.exists(absname):
absname = os.path.join(os.getcwdu(), "help", "C", filename)
self.m_history.add(absname)
self.g_docviewer.read_docfile(absname, anchor)
if __name__ == '__main__':
import sys
sys.path.insert(0, ".")
import src
import src.i18n
src.i18n.setup(".")
w = HelpBrowser()
w.connect('delete_event', gtk.main_quit)
w.show()
w.show_docfile("toc.html")
gtk.main()
|