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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
"""bookmark.py - Bookmarks handler (including menu and dialog)."""
import os
import cPickle
import gtk
import gobject
import constants
import constants
_pickle_path = os.path.join(constants.DATA_DIR, 'bookmarks.pickle')
class BookmarksMenu(gtk.Menu):
"""BookmarksMenu extends gtk.Menu with convenience methods relating to
bookmarks. It contains fixed items for adding bookmarks etc. as well
as dynamic items corresponding to the current bookmarks.
"""
def __init__(self, ui, window):
gtk.Menu.__init__(self)
self._window = window
self._actiongroup = gtk.ActionGroup('comix-bookmarks')
self._actiongroup.add_actions([
('add_bookmark', 'comix-add-bookmark', _('_Add bookmark'),
'<Control>d', None, self._add_current_to_bookmarks),
('edit_bookmarks', None, _('_Edit bookmarks...'),
'<Control>b', None, self._edit_bookmarks),
('clear_bookmarks', gtk.STOCK_CLEAR, _('_Clear bookmarks...'),
None, None, self._clear_bookmarks)])
self._separator = gtk.SeparatorMenuItem()
action = self._actiongroup.get_action('add_bookmark')
action.set_accel_group(ui.get_accel_group())
self.append(action.create_menu_item())
action = self._actiongroup.get_action('edit_bookmarks')
action.set_accel_group(ui.get_accel_group())
self.append(action.create_menu_item())
self.append(self._separator)
self.append(gtk.SeparatorMenuItem())
action = self._actiongroup.get_action('clear_bookmarks')
action.set_accel_group(ui.get_accel_group())
self.append(action.create_menu_item())
self.show_all()
self._separator.hide()
self._bookmarks_store = _BookmarksStore(self, window.file_handler)
def add_bookmark(self, bookmark):
"""Add <bookmark> to the menu."""
self.insert(bookmark, 3)
bookmark.show()
self._separator.show()
def remove_bookmark(self, bookmark):
"""Remove <bookmark> from the menu."""
self.remove(bookmark)
if self._bookmarks_store.is_empty():
self._separator.hide()
def _add_current_to_bookmarks(self, *args):
"""Add the currently viewed file to the bookmarks."""
self._bookmarks_store.add_current_to_bookmarks()
def _edit_bookmarks(self, *args):
"""Open the bookmarks dialog."""
_BookmarksDialog(self._window, self._bookmarks_store)
def _clear_bookmarks(self, *args):
"""Remove all bookmarks, if the user presses 'Yes' in a confirmation
dialog.
"""
choice_dialog = gtk.MessageDialog(self._window, 0,
gtk.MESSAGE_QUESTION, gtk.BUTTONS_YES_NO,
_('Clear all bookmarks?'))
choice_dialog.format_secondary_text(
_('All stored bookmarks will be removed. Are you sure that you want to continue?'))
response = choice_dialog.run()
choice_dialog.destroy()
if response == gtk.RESPONSE_YES:
self._bookmarks_store.clear_bookmarks()
def set_sensitive(self, loaded):
"""Set the sensitivities of menu items as appropriate if <loaded>
represents whether a file is currently loaded in the main program
or not.
"""
self._actiongroup.get_action('add_bookmark').set_sensitive(loaded)
def write_bookmarks_file(self):
"""Store relevant bookmark info in the comix directory."""
self._bookmarks_store.write_bookmarks_file()
class _Bookmark(gtk.ImageMenuItem):
"""_Bookmark represents one bookmark. It extends the gtk.ImageMenuItem
and is thus put directly in the bookmarks menu.
"""
def __init__(self, file_handler, name, path, page, numpages, archive_type):
self._name = name
self._path = path
self._page = page
self._numpages = numpages
self._archive_type = archive_type
self._file_handler = file_handler
gtk.MenuItem.__init__(self, str(self), False)
if self._archive_type is not None:
im = gtk.image_new_from_stock('comix-archive', gtk.ICON_SIZE_MENU)
else:
im = gtk.image_new_from_stock('comix-image', gtk.ICON_SIZE_MENU)
self.set_image(im)
self.connect('activate', self._load)
def __str__(self):
return '%s, (%d / %d)' % (self._name, self._page, self._numpages)
def _load(self, *args):
"""Open the file and page the bookmark represents."""
self._file_handler.open_file(self._path, self._page)
def same_path(self, path):
"""Return True if the bookmark is for the file <path>."""
return path == self._path
def to_row(self):
"""Return a tuple corresponding to one row in the _BookmarkDialog's
ListStore.
"""
stock = self.get_image().get_stock()
pixbuf = self.render_icon(*stock)
page = '%d / %d' % (self._page, self._numpages)
return (pixbuf, self._name, page, self)
def pack(self):
"""Return a tuple suitable for pickling. The bookmark can be fully
re-created using the values in the tuple.
"""
return (self._name, self._path, self._page, self._numpages,
self._archive_type)
class _BookmarksStore:
"""The _BookmarksStore is a backend for both the bookmarks menu and dialog.
Changes in the _BookmarksStore is mirrored in both.
"""
def __init__(self, menu, file_handler):
self._menu = menu
self._file_handler = file_handler
self._bookmarks = []
if os.path.isfile(_pickle_path):
try:
fd = open(_pickle_path, 'rb')
version = cPickle.load(fd)
packs = cPickle.load(fd)
for pack in packs:
self.add_bookmark_by_values(*pack)
fd.close()
except Exception:
print '! bookmark.py: Could not parse', _pickle_path
print '! bookmark.py: Deleting corrupt bookmarks file.\n'
os.remove(_pickle_path)
self.clear_bookmarks()
def add_bookmark_by_values(self, name, path, page, numpages, archive_type):
"""Create a bookmark and add it to the store and the menu."""
bookmark = _Bookmark(self._file_handler, name, path, page, numpages,
archive_type)
self._bookmarks.append(bookmark)
self._menu.add_bookmark(bookmark)
def add_bookmark(self, bookmark):
"""Add the <bookmark> to the store and the menu."""
self._bookmarks.append(bookmark)
self._menu.add_bookmark(bookmark)
def remove_bookmark(self, bookmark):
"""Remove the <bookmark> from the store and the menu."""
self._bookmarks.remove(bookmark)
self._menu.remove_bookmark(bookmark)
def add_current_to_bookmarks(self):
"""Add the currently viewed file to the store and the menu."""
name = self._file_handler.get_pretty_current_filename()
path = self._file_handler.get_real_path()
page = self._file_handler.get_current_page()
numpages = self._file_handler.get_number_of_pages()
archive_type = self._file_handler.archive_type
for bookmark in self._bookmarks:
if bookmark.same_path(path):
self.remove_bookmark(bookmark)
break
return self.add_bookmark_by_values(name, path, page, numpages,
archive_type)
def clear_bookmarks(self):
"""Remove all bookmarks from the store and the menu."""
for bookmark in self._bookmarks[:]:
self.remove_bookmark(bookmark)
def get_bookmarks(self):
"""Return all the bookmarks in the store."""
return self._bookmarks
def is_empty(self):
"""Return True if the store is currently empty."""
return len(self._bookmarks) == 0
def write_bookmarks_file(self):
"""Store relevant bookmark info in the comix directory."""
fd = open(_pickle_path, 'wb')
cPickle.dump(constants.VERSION, fd, cPickle.HIGHEST_PROTOCOL)
packs = [bookmark.pack() for bookmark in self._bookmarks]
cPickle.dump(packs, fd, cPickle.HIGHEST_PROTOCOL)
fd.close()
class _BookmarksDialog(gtk.Dialog):
"""_BookmarksDialog lets the user remove and/or rearrange bookmarks."""
def __init__(self, window, bookmarks_store):
gtk.Dialog.__init__(self, _('Edit bookmarks'), window, gtk.DIALOG_MODAL,
(gtk.STOCK_REMOVE, gtk.RESPONSE_NO, gtk.STOCK_CLOSE,
gtk.RESPONSE_CLOSE))
self._bookmarks_store = bookmarks_store
self.set_has_separator(False)
self.set_resizable(True)
self.set_default_response(gtk.RESPONSE_CLOSE)
scrolled = gtk.ScrolledWindow()
self.set_border_width(4)
scrolled.set_border_width(6)
scrolled.set_shadow_type(gtk.SHADOW_IN)
scrolled.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
self.vbox.pack_start(scrolled)
self._liststore = gtk.ListStore(gtk.gdk.Pixbuf, gobject.TYPE_STRING,
gobject.TYPE_STRING, _Bookmark)
self._treeview = gtk.TreeView(self._liststore)
self._treeview.set_rules_hint(True)
self._treeview.set_reorderable(True)
self._selection = self._treeview.get_selection()
scrolled.add(self._treeview)
cellrenderer_text = gtk.CellRendererText()
cellrenderer_pbuf = gtk.CellRendererPixbuf()
self._icon_col = gtk.TreeViewColumn(None, cellrenderer_pbuf)
self._name_col = gtk.TreeViewColumn(_('Name'), cellrenderer_text)
self._page_col = gtk.TreeViewColumn(_('Page'), cellrenderer_text)
self._treeview.append_column(self._icon_col)
self._treeview.append_column(self._name_col)
self._treeview.append_column(self._page_col)
self._icon_col.set_attributes(cellrenderer_pbuf, pixbuf=0)
self._name_col.set_attributes(cellrenderer_text, text=1)
self._page_col.set_attributes(cellrenderer_text, text=2)
self._name_col.set_expand(True)
self._icon_col.set_sizing(gtk.TREE_VIEW_COLUMN_AUTOSIZE)
self._name_col.set_sizing(gtk.TREE_VIEW_COLUMN_AUTOSIZE)
self._page_col.set_sizing(gtk.TREE_VIEW_COLUMN_AUTOSIZE)
self.resize(450, 450)
self.connect('response', self._response)
self.connect('delete_event', self._close)
self._treeview.connect('key_press_event', self._key_press_event)
for bookmark in self._bookmarks_store.get_bookmarks():
self._add_bookmark(bookmark)
self.show_all()
def _add_bookmark(self, bookmark):
"""Add the <bookmark> to the dialog."""
self._liststore.prepend(bookmark.to_row())
def _remove_selected(self):
"""Remove the currently selected bookmark from the dialog and from
the store."""
treeiter = self._selection.get_selected()[1]
if treeiter is not None:
bookmark = self._liststore.get_value(treeiter, 3)
self._liststore.remove(treeiter)
self._bookmarks_store.remove_bookmark(bookmark)
def _response(self, dialog, response):
if response == gtk.RESPONSE_CLOSE:
self._close()
elif response == gtk.RESPONSE_NO:
self._remove_selected()
def _key_press_event(self, dialog, event, *args):
if event.keyval == gtk.keysyms.Delete:
self._remove_selected()
def _close(self, *args):
"""Close the dialog and update the _BookmarksStore with the new
ordering."""
ordering = []
treeiter = self._liststore.get_iter_root()
while treeiter is not None:
bookmark = self._liststore.get_value(treeiter, 3)
ordering.insert(0, bookmark)
treeiter = self._liststore.iter_next(treeiter)
for bookmark in ordering:
self._bookmarks_store.remove_bookmark(bookmark)
self._bookmarks_store.add_bookmark(bookmark)
self.destroy()
|