1 /* this file is part of evince, a gnome document viewer
3 * Copyright (C) 2004 Red Hat, Inc.
4 * Copyright (C) 2004, 2005 Anders Carlsson <andersca@gnome.org>
7 * Jonathan Blandford <jrb@alum.mit.edu>
8 * Anders Carlsson <andersca@gnome.org>
10 * Evince is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * Evince is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
31 #include <glib/gi18n.h>
33 #include "ev-sidebar-page.h"
34 #include "ev-sidebar-thumbnails.h"
35 #include "ev-document-thumbnails.h"
36 #include "ev-document-misc.h"
37 #include "ev-job-queue.h"
38 #include "ev-window.h"
41 #define THUMBNAIL_WIDTH 100
43 /* The IconView doesn't scale nearly as well as the TreeView, so we arbitrarily
45 #define MAX_ICON_VIEW_PAGE_COUNT 1500
48 struct _EvSidebarThumbnailsPrivate {
52 GtkAdjustment *vadjustment;
53 GtkListStore *list_store;
54 GdkPixbuf *loading_icon;
57 gint n_pages, pages_done;
60 gint start_page, end_page;
76 static void ev_sidebar_thumbnails_clear_model (EvSidebarThumbnails *sidebar);
77 static gboolean ev_sidebar_thumbnails_support_document (EvSidebarPage *sidebar_page,
78 EvDocument *document);
79 static void ev_sidebar_thumbnails_page_iface_init (EvSidebarPageIface *iface);
80 static void ev_sidebar_thumbnails_set_document (EvSidebarPage *sidebar_page,
81 EvDocument *document);
82 static const gchar* ev_sidebar_thumbnails_get_label (EvSidebarPage *sidebar_page);
83 static void thumbnail_job_completed_callback (EvJobThumbnail *job,
84 EvSidebarThumbnails *sidebar_thumbnails);
86 G_DEFINE_TYPE_EXTENDED (EvSidebarThumbnails,
87 ev_sidebar_thumbnails,
90 G_IMPLEMENT_INTERFACE (EV_TYPE_SIDEBAR_PAGE,
91 ev_sidebar_thumbnails_page_iface_init))
93 #define EV_SIDEBAR_THUMBNAILS_GET_PRIVATE(object) \
94 (G_TYPE_INSTANCE_GET_PRIVATE ((object), EV_TYPE_SIDEBAR_THUMBNAILS, EvSidebarThumbnailsPrivate));
98 ev_sidebar_thumbnails_dispose (GObject *object)
100 EvSidebarThumbnails *sidebar_thumbnails = EV_SIDEBAR_THUMBNAILS (object);
102 ev_sidebar_thumbnails_clear_model (sidebar_thumbnails);
103 g_object_unref (sidebar_thumbnails->priv->loading_icon);
104 g_object_unref (sidebar_thumbnails->priv->list_store);
106 G_OBJECT_CLASS (ev_sidebar_thumbnails_parent_class)->dispose (object);
110 ev_sidebar_thumbnails_get_property (GObject *object,
115 EvSidebarThumbnails *sidebar = EV_SIDEBAR_THUMBNAILS (object);
120 if (sidebar->priv->tree_view)
121 g_value_set_object (value, sidebar->priv->tree_view);
123 g_value_set_object (value, sidebar->priv->icon_view);
126 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
132 ev_sidebar_thumbnails_class_init (EvSidebarThumbnailsClass *ev_sidebar_thumbnails_class)
134 GObjectClass *g_object_class;
135 GtkObjectClass *gtk_object_class;
137 g_object_class = G_OBJECT_CLASS (ev_sidebar_thumbnails_class);
138 gtk_object_class = GTK_OBJECT_CLASS (ev_sidebar_thumbnails_class);
140 g_object_class->dispose = ev_sidebar_thumbnails_dispose;
141 g_object_class->get_property = ev_sidebar_thumbnails_get_property;
143 g_object_class_override_property (g_object_class,
147 g_type_class_add_private (g_object_class, sizeof (EvSidebarThumbnailsPrivate));
151 ev_sidebar_thumbnails_new (void)
153 GtkWidget *ev_sidebar_thumbnails;
155 ev_sidebar_thumbnails = g_object_new (EV_TYPE_SIDEBAR_THUMBNAILS, NULL);
157 return ev_sidebar_thumbnails;
161 clear_range (EvSidebarThumbnails *sidebar_thumbnails,
165 EvSidebarThumbnailsPrivate *priv;
170 priv = sidebar_thumbnails->priv = EV_SIDEBAR_THUMBNAILS_GET_PRIVATE (sidebar_thumbnails);
172 g_assert (start_page <= end_page);
174 path = gtk_tree_path_new_from_indices (start_page, -1);
175 for (result = gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->list_store), &iter, path);
176 result && start_page <= end_page;
177 result = gtk_tree_model_iter_next (GTK_TREE_MODEL (priv->list_store), &iter), start_page ++) {
180 gtk_tree_model_get (GTK_TREE_MODEL (priv->list_store),
186 g_signal_handlers_disconnect_by_func (job, thumbnail_job_completed_callback, sidebar_thumbnails);
187 ev_job_queue_remove_job (EV_JOB (job));
188 g_object_unref (job);
191 gtk_list_store_set (priv->list_store, &iter,
193 COLUMN_THUMBNAIL_SET, FALSE,
194 COLUMN_PIXBUF, priv->loading_icon,
197 gtk_tree_path_free (path);
201 add_range (EvSidebarThumbnails *sidebar_thumbnails,
205 EvSidebarThumbnailsPrivate *priv;
209 gint page = start_page;
211 priv = sidebar_thumbnails->priv = EV_SIDEBAR_THUMBNAILS_GET_PRIVATE (sidebar_thumbnails);
213 g_assert (start_page <= end_page);
215 path = gtk_tree_path_new_from_indices (start_page, -1);
216 for (result = gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->list_store), &iter, path);
217 result && page <= end_page;
218 result = gtk_tree_model_iter_next (GTK_TREE_MODEL (priv->list_store), &iter), page ++) {
220 gboolean thumbnail_set;
222 gtk_tree_model_get (GTK_TREE_MODEL (priv->list_store), &iter,
224 COLUMN_THUMBNAIL_SET, &thumbnail_set,
227 if (job == NULL && !thumbnail_set) {
228 job = (EvJobThumbnail *)ev_job_thumbnail_new (priv->document, page, THUMBNAIL_WIDTH);
229 ev_job_queue_add_job (EV_JOB (job), EV_JOB_PRIORITY_HIGH);
230 g_object_set_data_full (G_OBJECT (job), "tree_iter",
231 gtk_tree_iter_copy (&iter),
232 (GDestroyNotify) gtk_tree_iter_free);
233 g_signal_connect (job, "finished",
234 G_CALLBACK (thumbnail_job_completed_callback),
236 gtk_list_store_set (priv->list_store, &iter,
239 /* The queue and the list own a ref to the job now */
240 g_object_unref (job);
242 g_object_unref (job);
245 gtk_tree_path_free (path);
248 /* This modifies start */
250 update_visible_range (EvSidebarThumbnails *sidebar_thumbnails,
254 EvSidebarThumbnailsPrivate *priv;
255 int old_start_page, old_end_page;
257 priv = sidebar_thumbnails->priv = EV_SIDEBAR_THUMBNAILS_GET_PRIVATE (sidebar_thumbnails);
259 old_start_page = priv->start_page;
260 old_end_page = priv->end_page;
262 if (start_page == old_start_page &&
263 end_page == old_end_page)
266 /* Clear the areas we no longer display */
267 if (old_start_page < start_page)
268 clear_range (sidebar_thumbnails, old_start_page, MIN (start_page - 1, old_end_page));
270 if (old_end_page > end_page)
271 clear_range (sidebar_thumbnails, MAX (end_page + 1, old_start_page), old_end_page);
273 add_range (sidebar_thumbnails, start_page, end_page);
275 priv->start_page = start_page;
276 priv->end_page = end_page;
280 adjustment_changed_cb (EvSidebarThumbnails *sidebar_thumbnails)
282 EvSidebarThumbnailsPrivate *priv;
283 GtkTreePath *path = NULL;
284 GtkTreePath *path2 = NULL;
288 priv = sidebar_thumbnails->priv = EV_SIDEBAR_THUMBNAILS_GET_PRIVATE (sidebar_thumbnails);
290 if (priv->tree_view) {
291 if (! GTK_WIDGET_REALIZED (priv->tree_view))
294 gtk_tree_view_tree_to_widget_coords (GTK_TREE_VIEW (priv->tree_view),
295 0, (int) priv->vadjustment->value,
297 gtk_tree_view_tree_to_widget_coords (GTK_TREE_VIEW (priv->tree_view),
298 0, (int) (priv->vadjustment->value + priv->vadjustment->page_size),
300 gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (priv->tree_view),
303 gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (priv->tree_view),
306 } else if (priv->icon_view) {
307 #ifdef HAVE_GTK_ICON_VIEW_GET_VISIBLE_RANGE
308 if (! GTK_WIDGET_REALIZED (priv->icon_view))
310 gtk_icon_view_get_visible_range (GTK_ICON_VIEW (priv->icon_view), &path, &path2);
312 g_assert_not_reached ();
319 path = gtk_tree_path_new_first ();
321 path2 = gtk_tree_path_new_from_indices (priv->n_pages,
323 update_visible_range (sidebar_thumbnails,
324 gtk_tree_path_get_indices (path)[0],
325 gtk_tree_path_get_indices (path2)[0]);
327 gtk_tree_path_free (path);
328 gtk_tree_path_free (path2);
332 ev_sidebar_tree_selection_changed (GtkTreeSelection *selection,
333 EvSidebarThumbnails *ev_sidebar_thumbnails)
335 EvSidebarThumbnailsPrivate *priv;
336 EvPageCache *page_cache;
341 priv = ev_sidebar_thumbnails->priv = EV_SIDEBAR_THUMBNAILS_GET_PRIVATE (ev_sidebar_thumbnails);
343 if (!gtk_tree_selection_get_selected (selection, NULL, &iter))
346 path = gtk_tree_model_get_path (GTK_TREE_MODEL (priv->list_store),
348 page = gtk_tree_path_get_indices (path)[0];
349 gtk_tree_path_free (path);
351 page_cache = ev_page_cache_get (priv->document);
352 ev_page_cache_set_current_page (page_cache, page);
356 ev_sidebar_icon_selection_changed (GtkIconView *icon_view,
357 EvSidebarThumbnails *ev_sidebar_thumbnails)
359 EvSidebarThumbnailsPrivate *priv;
360 EvPageCache *page_cache;
365 priv = ev_sidebar_thumbnails->priv = EV_SIDEBAR_THUMBNAILS_GET_PRIVATE (ev_sidebar_thumbnails);
367 selected = gtk_icon_view_get_selected_items (icon_view);
368 if (selected == NULL)
371 /* We don't handle or expect multiple selection. */
372 g_assert (selected->next == NULL);
374 path = selected->data;
375 page = gtk_tree_path_get_indices (path)[0];
377 gtk_tree_path_free (path);
378 g_list_free (selected);
380 page_cache = ev_page_cache_get (priv->document);
381 ev_page_cache_set_current_page (page_cache, page);
385 ev_sidebar_init_tree_view (EvSidebarThumbnails *ev_sidebar_thumbnails)
387 EvSidebarThumbnailsPrivate *priv;
388 GtkTreeSelection *selection;
389 GtkCellRenderer *renderer;
391 priv = ev_sidebar_thumbnails->priv;
392 priv->tree_view = gtk_tree_view_new_with_model (GTK_TREE_MODEL (priv->list_store));
394 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
395 g_signal_connect (selection, "changed",
396 G_CALLBACK (ev_sidebar_tree_selection_changed), ev_sidebar_thumbnails);
397 gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->tree_view), FALSE);
398 renderer = g_object_new (GTK_TYPE_CELL_RENDERER_PIXBUF,
402 gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (priv->tree_view), -1,
406 gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (priv->tree_view), -1,
407 NULL, gtk_cell_renderer_text_new (),
409 gtk_container_add (GTK_CONTAINER (priv->swindow), priv->tree_view);
410 gtk_widget_show (priv->tree_view);
414 ev_sidebar_init_icon_view (EvSidebarThumbnails *ev_sidebar_thumbnails)
416 EvSidebarThumbnailsPrivate *priv;
418 priv = ev_sidebar_thumbnails->priv;
420 priv->icon_view = gtk_icon_view_new_with_model (GTK_TREE_MODEL (priv->list_store));
421 gtk_icon_view_set_markup_column (GTK_ICON_VIEW (priv->icon_view), 0);
422 gtk_icon_view_set_pixbuf_column (GTK_ICON_VIEW (priv->icon_view), 1);
423 g_signal_connect (priv->icon_view, "selection-changed",
424 G_CALLBACK (ev_sidebar_icon_selection_changed), ev_sidebar_thumbnails);
426 gtk_container_add (GTK_CONTAINER (priv->swindow), priv->icon_view);
427 gtk_widget_show (priv->icon_view);
431 ev_sidebar_thumbnails_use_icon_view (EvSidebarThumbnails *sidebar_thumbnails)
433 #ifdef HAVE_GTK_ICON_VIEW_GET_VISIBLE_RANGE
434 EvPageCache *page_cache;
436 page_cache = ev_page_cache_get (sidebar_thumbnails->priv->document);
438 if (ev_page_cache_get_n_pages (page_cache) > MAX_ICON_VIEW_PAGE_COUNT)
447 ev_sidebar_thumbnails_init (EvSidebarThumbnails *ev_sidebar_thumbnails)
449 EvSidebarThumbnailsPrivate *priv;
451 priv = ev_sidebar_thumbnails->priv = EV_SIDEBAR_THUMBNAILS_GET_PRIVATE (ev_sidebar_thumbnails);
453 priv->list_store = gtk_list_store_new (NUM_COLUMNS,
457 EV_TYPE_JOB_THUMBNAIL);
459 priv->swindow = gtk_scrolled_window_new (NULL, NULL);
460 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->swindow),
461 GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
462 gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (priv->swindow),
464 priv->vadjustment = gtk_scrolled_window_get_vadjustment (GTK_SCROLLED_WINDOW (priv->swindow));
465 g_signal_connect_data (G_OBJECT (priv->vadjustment), "value-changed",
466 G_CALLBACK (adjustment_changed_cb),
467 ev_sidebar_thumbnails, NULL,
468 G_CONNECT_SWAPPED | G_CONNECT_AFTER);
469 g_signal_connect_swapped (G_OBJECT (priv->swindow), "size-allocate",
470 G_CALLBACK (adjustment_changed_cb),
471 ev_sidebar_thumbnails);
472 gtk_box_pack_start (GTK_BOX (ev_sidebar_thumbnails), priv->swindow, TRUE, TRUE, 0);
474 /* Put it all together */
475 gtk_widget_show_all (priv->swindow);
479 page_changed_cb (EvPageCache *page_cache,
481 EvSidebarThumbnails *sidebar)
483 GtkTreeView *tree_view;
486 path = gtk_tree_path_new_from_indices (page, -1);
488 if (sidebar->priv->tree_view) {
489 tree_view = GTK_TREE_VIEW (sidebar->priv->tree_view);
490 gtk_tree_view_set_cursor (tree_view, path, NULL, FALSE);
491 gtk_tree_view_scroll_to_cell (tree_view, path, NULL, FALSE, 0.0, 0.0);
492 } else if (sidebar->priv->icon_view) {
493 /* Guard against gtk-2.6 */
494 #ifdef HAVE_GTK_ICON_VIEW_GET_VISIBLE_RANGE
495 gtk_icon_view_select_path (GTK_ICON_VIEW (sidebar->priv->icon_view), path);
496 gtk_icon_view_set_cursor (GTK_ICON_VIEW (sidebar->priv->icon_view), path, NULL, FALSE);
500 gtk_tree_path_free (path);
504 thumbnail_job_completed_callback (EvJobThumbnail *job,
505 EvSidebarThumbnails *sidebar_thumbnails)
507 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
510 iter = (GtkTreeIter *) g_object_get_data (G_OBJECT (job), "tree_iter");
511 gtk_list_store_set (priv->list_store,
513 COLUMN_PIXBUF, job->thumbnail,
514 COLUMN_THUMBNAIL_SET, TRUE,
520 ev_sidebar_thumbnails_set_document (EvSidebarPage *sidebar_page,
521 EvDocument *document)
523 EvSidebarThumbnails *sidebar_thumbnails = EV_SIDEBAR_THUMBNAILS (sidebar_page);
526 gint width = THUMBNAIL_WIDTH;
527 gint height = THUMBNAIL_WIDTH;
528 EvPageCache *page_cache;
530 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
532 g_return_if_fail (EV_IS_DOCUMENT_THUMBNAILS (document));
534 page_cache = ev_page_cache_get (document);
535 n_pages = ev_page_cache_get_n_pages (page_cache);
537 priv->document = document;
538 priv->n_pages = n_pages;
540 /* We get the dimensions of the first doc so that we can make a blank
542 ev_document_doc_mutex_lock ();
543 ev_document_thumbnails_get_dimensions (EV_DOCUMENT_THUMBNAILS (priv->document),
544 0, THUMBNAIL_WIDTH, &width, &height);
545 ev_document_doc_mutex_unlock ();
547 if (priv->loading_icon)
548 g_object_unref (priv->loading_icon);
549 priv->loading_icon = ev_document_misc_get_thumbnail_frame (width, height, NULL);
551 ev_sidebar_thumbnails_clear_model (sidebar_thumbnails);
552 for (i = 0; i < n_pages; i++) {
556 page_label = ev_page_cache_get_page_label (page_cache, i);
557 page_string = g_markup_printf_escaped ("<i>%s</i>", page_label);
559 gtk_list_store_append (priv->list_store, &iter);
560 gtk_list_store_set (priv->list_store, &iter,
561 COLUMN_PAGE_STRING, page_string,
562 COLUMN_PIXBUF, priv->loading_icon,
563 COLUMN_THUMBNAIL_SET, FALSE,
566 g_free (page_string);
570 /* Create the view widget, and remove the old one, if needed */
571 if (ev_sidebar_thumbnails_use_icon_view (sidebar_thumbnails)) {
572 if (priv->tree_view) {
573 gtk_container_remove (GTK_CONTAINER (priv->swindow), priv->tree_view);
574 priv->tree_view = NULL;
577 if (! priv->icon_view) {
578 ev_sidebar_init_icon_view (sidebar_thumbnails);
579 g_object_notify (G_OBJECT (sidebar_thumbnails), "main_widget");
582 if (priv->icon_view) {
583 gtk_container_remove (GTK_CONTAINER (priv->swindow), priv->icon_view);
584 priv->icon_view = NULL;
587 if (! priv->tree_view) {
588 ev_sidebar_init_tree_view (sidebar_thumbnails);
589 g_object_notify (G_OBJECT (sidebar_thumbnails), "main_widget");
593 /* Connect to the signal and trigger a fake callback */
594 g_signal_connect (page_cache, "page-changed", G_CALLBACK (page_changed_cb), sidebar_thumbnails);
595 adjustment_changed_cb (sidebar_thumbnails);
599 ev_sidebar_thumbnails_clear_job (GtkTreeModel *model,
606 gtk_tree_model_get (model, iter, COLUMN_JOB, &job, -1);
609 ev_job_queue_remove_job (job);
610 g_signal_handlers_disconnect_by_func (job, thumbnail_job_completed_callback, data);
611 g_object_unref (job);
618 ev_sidebar_thumbnails_clear_model (EvSidebarThumbnails *sidebar_thumbnails)
620 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
622 gtk_tree_model_foreach (GTK_TREE_MODEL (priv->list_store), ev_sidebar_thumbnails_clear_job, sidebar_thumbnails);
623 gtk_list_store_clear (priv->list_store);
627 ev_sidebar_thumbnails_support_document (EvSidebarPage *sidebar_page,
628 EvDocument *document)
630 return (EV_IS_DOCUMENT_THUMBNAILS (document) &&
631 (ev_document_get_n_pages (document) > 1));
635 ev_sidebar_thumbnails_get_label (EvSidebarPage *sidebar_page)
637 return _("Thumbnails");
641 ev_sidebar_thumbnails_page_iface_init (EvSidebarPageIface *iface)
643 iface->support_document = ev_sidebar_thumbnails_support_document;
644 iface->set_document = ev_sidebar_thumbnails_set_document;
645 iface->get_label = ev_sidebar_thumbnails_get_label;