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>
34 #include "ev-document-misc.h"
35 #include "ev-document-thumbnails.h"
36 #include "ev-job-scheduler.h"
37 #include "ev-sidebar-page.h"
38 #include "ev-sidebar-thumbnails.h"
40 #include "ev-window.h"
42 #define THUMBNAIL_WIDTH 100
44 /* The IconView doesn't scale nearly as well as the TreeView, so we arbitrarily
46 #define MAX_ICON_VIEW_PAGE_COUNT 1500
49 struct _EvSidebarThumbnailsPrivate {
53 GtkAdjustment *vadjustment;
54 GtkListStore *list_store;
55 GdkPixbuf *loading_icon;
57 EvPageCache *page_cache;
59 gint n_pages, pages_done;
64 gint start_page, end_page;
80 static void ev_sidebar_thumbnails_clear_model (EvSidebarThumbnails *sidebar);
81 static gboolean ev_sidebar_thumbnails_support_document (EvSidebarPage *sidebar_page,
82 EvDocument *document);
83 static void ev_sidebar_thumbnails_page_iface_init (EvSidebarPageIface *iface);
84 static void ev_sidebar_thumbnails_set_document (EvSidebarPage *sidebar_page,
85 EvDocument *document);
86 static const gchar* ev_sidebar_thumbnails_get_label (EvSidebarPage *sidebar_page);
87 static void thumbnail_job_completed_callback (EvJobThumbnail *job,
88 EvSidebarThumbnails *sidebar_thumbnails);
89 static void adjustment_changed_cb (EvSidebarThumbnails *sidebar_thumbnails);
91 G_DEFINE_TYPE_EXTENDED (EvSidebarThumbnails,
92 ev_sidebar_thumbnails,
95 G_IMPLEMENT_INTERFACE (EV_TYPE_SIDEBAR_PAGE,
96 ev_sidebar_thumbnails_page_iface_init))
98 #define EV_SIDEBAR_THUMBNAILS_GET_PRIVATE(object) \
99 (G_TYPE_INSTANCE_GET_PRIVATE ((object), EV_TYPE_SIDEBAR_THUMBNAILS, EvSidebarThumbnailsPrivate));
103 ev_sidebar_thumbnails_dispose (GObject *object)
105 EvSidebarThumbnails *sidebar_thumbnails = EV_SIDEBAR_THUMBNAILS (object);
107 if (sidebar_thumbnails->priv->loading_icon) {
108 g_object_unref (sidebar_thumbnails->priv->loading_icon);
109 sidebar_thumbnails->priv->loading_icon = NULL;
112 if (sidebar_thumbnails->priv->list_store) {
113 ev_sidebar_thumbnails_clear_model (sidebar_thumbnails);
114 g_object_unref (sidebar_thumbnails->priv->list_store);
115 sidebar_thumbnails->priv->list_store = NULL;
118 G_OBJECT_CLASS (ev_sidebar_thumbnails_parent_class)->dispose (object);
122 ev_sidebar_thumbnails_get_property (GObject *object,
127 EvSidebarThumbnails *sidebar = EV_SIDEBAR_THUMBNAILS (object);
131 if (sidebar->priv->tree_view)
132 g_value_set_object (value, sidebar->priv->tree_view);
134 g_value_set_object (value, sidebar->priv->icon_view);
137 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
143 ev_sidebar_thumbnails_map (GtkWidget *widget)
145 EvSidebarThumbnails *sidebar;
147 sidebar = EV_SIDEBAR_THUMBNAILS (widget);
149 GTK_WIDGET_CLASS (ev_sidebar_thumbnails_parent_class)->map (widget);
151 adjustment_changed_cb (sidebar);
155 ev_sidebar_thumbnails_class_init (EvSidebarThumbnailsClass *ev_sidebar_thumbnails_class)
157 GObjectClass *g_object_class;
158 GtkObjectClass *gtk_object_class;
159 GtkWidgetClass *widget_class;
161 g_object_class = G_OBJECT_CLASS (ev_sidebar_thumbnails_class);
162 gtk_object_class = GTK_OBJECT_CLASS (ev_sidebar_thumbnails_class);
163 widget_class = GTK_WIDGET_CLASS (ev_sidebar_thumbnails_class);
165 g_object_class->dispose = ev_sidebar_thumbnails_dispose;
166 g_object_class->get_property = ev_sidebar_thumbnails_get_property;
167 widget_class->map = ev_sidebar_thumbnails_map;
169 g_object_class_override_property (g_object_class,
173 g_type_class_add_private (g_object_class, sizeof (EvSidebarThumbnailsPrivate));
177 ev_sidebar_thumbnails_new (void)
179 GtkWidget *ev_sidebar_thumbnails;
181 ev_sidebar_thumbnails = g_object_new (EV_TYPE_SIDEBAR_THUMBNAILS, NULL);
183 return ev_sidebar_thumbnails;
187 clear_range (EvSidebarThumbnails *sidebar_thumbnails,
191 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
196 g_assert (start_page <= end_page);
198 path = gtk_tree_path_new_from_indices (start_page, -1);
199 for (result = gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->list_store), &iter, path);
200 result && start_page <= end_page;
201 result = gtk_tree_model_iter_next (GTK_TREE_MODEL (priv->list_store), &iter), start_page ++) {
204 gtk_tree_model_get (GTK_TREE_MODEL (priv->list_store),
210 g_signal_handlers_disconnect_by_func (job, thumbnail_job_completed_callback, sidebar_thumbnails);
211 ev_job_cancel (EV_JOB (job));
212 g_object_unref (job);
215 gtk_list_store_set (priv->list_store, &iter,
217 COLUMN_THUMBNAIL_SET, FALSE,
218 COLUMN_PIXBUF, priv->loading_icon,
221 gtk_tree_path_free (path);
225 get_scale_for_page (EvSidebarThumbnails *sidebar_thumbnails,
228 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
231 ev_page_cache_get_size (priv->page_cache,
233 1.0, &width, &height);
235 return (gdouble)THUMBNAIL_WIDTH / (gdouble)width;
239 add_range (EvSidebarThumbnails *sidebar_thumbnails,
243 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
247 gint page = start_page;
249 g_assert (start_page <= end_page);
251 path = gtk_tree_path_new_from_indices (start_page, -1);
252 for (result = gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->list_store), &iter, path);
253 result && page <= end_page;
254 result = gtk_tree_model_iter_next (GTK_TREE_MODEL (priv->list_store), &iter), page ++) {
256 gboolean thumbnail_set;
258 gtk_tree_model_get (GTK_TREE_MODEL (priv->list_store), &iter,
260 COLUMN_THUMBNAIL_SET, &thumbnail_set,
263 if (job == NULL && !thumbnail_set) {
264 job = ev_job_thumbnail_new (priv->document,
265 page, priv->rotation,
266 get_scale_for_page (sidebar_thumbnails, page));
267 ev_job_scheduler_push_job (EV_JOB (job), EV_JOB_PRIORITY_HIGH);
269 g_object_set_data_full (G_OBJECT (job), "tree_iter",
270 gtk_tree_iter_copy (&iter),
271 (GDestroyNotify) gtk_tree_iter_free);
272 g_signal_connect (job, "finished",
273 G_CALLBACK (thumbnail_job_completed_callback),
275 gtk_list_store_set (priv->list_store, &iter,
279 /* The queue and the list own a ref to the job now */
280 g_object_unref (job);
282 g_object_unref (job);
285 gtk_tree_path_free (path);
288 /* This modifies start */
290 update_visible_range (EvSidebarThumbnails *sidebar_thumbnails,
294 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
295 int old_start_page, old_end_page;
297 old_start_page = priv->start_page;
298 old_end_page = priv->end_page;
300 if (start_page == old_start_page &&
301 end_page == old_end_page)
304 /* Clear the areas we no longer display */
305 if (old_start_page >= 0 && old_start_page < start_page)
306 clear_range (sidebar_thumbnails, old_start_page, MIN (start_page - 1, old_end_page));
308 if (old_end_page > 0 && old_end_page > end_page)
309 clear_range (sidebar_thumbnails, MAX (end_page + 1, old_start_page), old_end_page);
311 add_range (sidebar_thumbnails, start_page, end_page);
313 priv->start_page = start_page;
314 priv->end_page = end_page;
318 adjustment_changed_cb (EvSidebarThumbnails *sidebar_thumbnails)
320 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
321 GtkTreePath *path = NULL;
322 GtkTreePath *path2 = NULL;
326 /* Widget is not currently visible */
327 if (!GTK_WIDGET_MAPPED (sidebar_thumbnails))
330 if (priv->tree_view) {
331 if (! GTK_WIDGET_REALIZED (priv->tree_view))
334 #if GTK_CHECK_VERSION (2, 11, 3)
335 gtk_tree_view_convert_widget_to_bin_window_coords (GTK_TREE_VIEW (priv->tree_view),
336 0, (int) priv->vadjustment->value,
338 gtk_tree_view_convert_widget_to_bin_window_coords (GTK_TREE_VIEW (priv->tree_view),
339 0, (int) (priv->vadjustment->value + priv->vadjustment->page_size),
342 gtk_tree_view_tree_to_widget_coords (GTK_TREE_VIEW (priv->tree_view),
343 0, (int) priv->vadjustment->value,
345 gtk_tree_view_tree_to_widget_coords (GTK_TREE_VIEW (priv->tree_view),
346 0, (int) (priv->vadjustment->value + priv->vadjustment->page_size),
348 #endif /* GTK_CHECK_VERSION (2, 11, 3) */
350 gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (priv->tree_view),
353 gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (priv->tree_view),
356 } else if (priv->icon_view) {
357 if (! GTK_WIDGET_REALIZED (priv->icon_view))
359 if (! gtk_icon_view_get_visible_range (GTK_ICON_VIEW (priv->icon_view), &path, &path2))
366 update_visible_range (sidebar_thumbnails,
367 gtk_tree_path_get_indices (path)[0],
368 gtk_tree_path_get_indices (path2)[0]);
371 gtk_tree_path_free (path);
372 gtk_tree_path_free (path2);
376 ev_sidebar_thumbnails_fill_model (EvSidebarThumbnails *sidebar_thumbnails)
378 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
382 for (i = 0; i < sidebar_thumbnails->priv->n_pages; i++) {
386 page_label = ev_page_cache_get_page_label (priv->page_cache, i);
387 page_string = g_markup_printf_escaped ("<i>%s</i>", page_label);
389 gtk_list_store_append (priv->list_store, &iter);
390 gtk_list_store_set (priv->list_store, &iter,
391 COLUMN_PAGE_STRING, page_string,
392 COLUMN_PIXBUF, priv->loading_icon,
393 COLUMN_THUMBNAIL_SET, FALSE,
396 g_free (page_string);
402 ev_sidebar_thumbnails_set_loading_icon (EvSidebarThumbnails *sidebar_thumbnails)
404 if (sidebar_thumbnails->priv->loading_icon)
405 g_object_unref (sidebar_thumbnails->priv->loading_icon);
407 if (sidebar_thumbnails->priv->document &&
408 sidebar_thumbnails->priv->n_pages > 0) {
411 /* We get the dimensions of the first page so that we can make a blank
413 ev_page_cache_get_thumbnail_size (sidebar_thumbnails->priv->page_cache, 0,
414 sidebar_thumbnails->priv->rotation,
417 sidebar_thumbnails->priv->loading_icon =
418 ev_document_misc_get_thumbnail_frame (width, height, NULL);
420 sidebar_thumbnails->priv->loading_icon = NULL;
426 refresh (EvSidebarThumbnails *sidebar_thumbnails)
428 adjustment_changed_cb (sidebar_thumbnails);
433 ev_sidebar_thumbnails_refresh (EvSidebarThumbnails *sidebar_thumbnails,
436 sidebar_thumbnails->priv->rotation = rotation;
437 ev_sidebar_thumbnails_set_loading_icon (sidebar_thumbnails);
439 if (sidebar_thumbnails->priv->document == NULL ||
440 sidebar_thumbnails->priv->n_pages <= 0)
443 ev_sidebar_thumbnails_clear_model (sidebar_thumbnails);
444 ev_sidebar_thumbnails_fill_model (sidebar_thumbnails);
446 /* Trigger a redraw */
447 sidebar_thumbnails->priv->start_page = -1;
448 sidebar_thumbnails->priv->end_page = -1;
449 g_idle_add ((GSourceFunc)refresh, sidebar_thumbnails);
453 ev_sidebar_tree_selection_changed (GtkTreeSelection *selection,
454 EvSidebarThumbnails *ev_sidebar_thumbnails)
456 EvSidebarThumbnailsPrivate *priv = ev_sidebar_thumbnails->priv;
461 if (!gtk_tree_selection_get_selected (selection, NULL, &iter))
464 path = gtk_tree_model_get_path (GTK_TREE_MODEL (priv->list_store),
466 page = gtk_tree_path_get_indices (path)[0];
467 gtk_tree_path_free (path);
469 ev_page_cache_set_current_page_history (priv->page_cache, page);
473 ev_sidebar_icon_selection_changed (GtkIconView *icon_view,
474 EvSidebarThumbnails *ev_sidebar_thumbnails)
476 EvSidebarThumbnailsPrivate *priv = ev_sidebar_thumbnails->priv;
481 selected = gtk_icon_view_get_selected_items (icon_view);
482 if (selected == NULL)
485 /* We don't handle or expect multiple selection. */
486 g_assert (selected->next == NULL);
488 path = selected->data;
489 page = gtk_tree_path_get_indices (path)[0];
491 gtk_tree_path_free (path);
492 g_list_free (selected);
494 ev_page_cache_set_current_page_history (priv->page_cache, page);
498 ev_sidebar_init_tree_view (EvSidebarThumbnails *ev_sidebar_thumbnails)
500 EvSidebarThumbnailsPrivate *priv;
501 GtkTreeSelection *selection;
502 GtkCellRenderer *renderer;
504 priv = ev_sidebar_thumbnails->priv;
505 priv->tree_view = gtk_tree_view_new_with_model (GTK_TREE_MODEL (priv->list_store));
507 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
508 g_signal_connect (selection, "changed",
509 G_CALLBACK (ev_sidebar_tree_selection_changed), ev_sidebar_thumbnails);
510 gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->tree_view), FALSE);
511 renderer = g_object_new (GTK_TYPE_CELL_RENDERER_PIXBUF,
515 gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (priv->tree_view), -1,
519 gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (priv->tree_view), -1,
520 NULL, gtk_cell_renderer_text_new (),
522 gtk_container_add (GTK_CONTAINER (priv->swindow), priv->tree_view);
523 gtk_widget_show (priv->tree_view);
527 ev_sidebar_init_icon_view (EvSidebarThumbnails *ev_sidebar_thumbnails)
529 EvSidebarThumbnailsPrivate *priv;
531 priv = ev_sidebar_thumbnails->priv;
533 priv->icon_view = gtk_icon_view_new_with_model (GTK_TREE_MODEL (priv->list_store));
534 gtk_icon_view_set_markup_column (GTK_ICON_VIEW (priv->icon_view), 0);
535 gtk_icon_view_set_pixbuf_column (GTK_ICON_VIEW (priv->icon_view), 1);
536 g_signal_connect (priv->icon_view, "selection-changed",
537 G_CALLBACK (ev_sidebar_icon_selection_changed), ev_sidebar_thumbnails);
539 gtk_container_add (GTK_CONTAINER (priv->swindow), priv->icon_view);
540 gtk_widget_show (priv->icon_view);
544 ev_sidebar_thumbnails_use_icon_view (EvSidebarThumbnails *sidebar_thumbnails)
546 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
547 if (ev_page_cache_get_n_pages (priv->page_cache) > MAX_ICON_VIEW_PAGE_COUNT)
553 ev_sidebar_thumbnails_init (EvSidebarThumbnails *ev_sidebar_thumbnails)
555 EvSidebarThumbnailsPrivate *priv;
557 priv = ev_sidebar_thumbnails->priv = EV_SIDEBAR_THUMBNAILS_GET_PRIVATE (ev_sidebar_thumbnails);
559 priv->list_store = gtk_list_store_new (NUM_COLUMNS,
563 EV_TYPE_JOB_THUMBNAIL);
565 priv->swindow = gtk_scrolled_window_new (NULL, NULL);
567 /* We actually don't want GTK_POLICY_AUTOMATIC for horizontal scrollbar here
568 * it's just a workaround for bug #449462
570 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->swindow),
571 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
572 gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (priv->swindow),
574 priv->vadjustment = gtk_scrolled_window_get_vadjustment (GTK_SCROLLED_WINDOW (priv->swindow));
575 g_signal_connect_data (G_OBJECT (priv->vadjustment), "value-changed",
576 G_CALLBACK (adjustment_changed_cb),
577 ev_sidebar_thumbnails, NULL,
578 G_CONNECT_SWAPPED | G_CONNECT_AFTER);
579 g_signal_connect_swapped (G_OBJECT (priv->swindow), "size-allocate",
580 G_CALLBACK (adjustment_changed_cb),
581 ev_sidebar_thumbnails);
582 gtk_box_pack_start (GTK_BOX (ev_sidebar_thumbnails), priv->swindow, TRUE, TRUE, 0);
584 /* Put it all together */
585 gtk_widget_show_all (priv->swindow);
589 page_changed_cb (EvPageCache *page_cache,
591 EvSidebarThumbnails *sidebar)
593 GtkTreeView *tree_view;
596 path = gtk_tree_path_new_from_indices (page, -1);
598 if (sidebar->priv->tree_view) {
599 tree_view = GTK_TREE_VIEW (sidebar->priv->tree_view);
600 gtk_tree_view_set_cursor (tree_view, path, NULL, FALSE);
601 gtk_tree_view_scroll_to_cell (tree_view, path, NULL, FALSE, 0.0, 0.0);
602 } else if (sidebar->priv->icon_view) {
604 g_signal_handlers_block_by_func
605 (sidebar->priv->icon_view,
606 G_CALLBACK (ev_sidebar_icon_selection_changed), sidebar);
608 gtk_icon_view_select_path (GTK_ICON_VIEW (sidebar->priv->icon_view), path);
610 g_signal_handlers_unblock_by_func
611 (sidebar->priv->icon_view,
612 G_CALLBACK (ev_sidebar_icon_selection_changed), sidebar);
614 gtk_icon_view_set_cursor (GTK_ICON_VIEW (sidebar->priv->icon_view), path, NULL, FALSE);
617 gtk_tree_path_free (path);
621 thumbnail_job_completed_callback (EvJobThumbnail *job,
622 EvSidebarThumbnails *sidebar_thumbnails)
624 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
627 iter = (GtkTreeIter *) g_object_get_data (G_OBJECT (job), "tree_iter");
628 gtk_list_store_set (priv->list_store,
630 COLUMN_PIXBUF, job->thumbnail,
631 COLUMN_THUMBNAIL_SET, TRUE,
637 ev_sidebar_thumbnails_set_document (EvSidebarPage *sidebar_page,
638 EvDocument *document)
640 EvSidebarThumbnails *sidebar_thumbnails = EV_SIDEBAR_THUMBNAILS (sidebar_page);
642 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
644 g_return_if_fail (EV_IS_DOCUMENT_THUMBNAILS (document));
646 priv->page_cache = ev_page_cache_get (document);
647 priv->document = document;
648 priv->n_pages = ev_page_cache_get_n_pages (priv->page_cache);
650 ev_sidebar_thumbnails_set_loading_icon (sidebar_thumbnails);
652 ev_sidebar_thumbnails_clear_model (sidebar_thumbnails);
653 ev_sidebar_thumbnails_fill_model (sidebar_thumbnails);
655 /* Create the view widget, and remove the old one, if needed */
656 if (ev_sidebar_thumbnails_use_icon_view (sidebar_thumbnails)) {
657 if (priv->tree_view) {
658 gtk_container_remove (GTK_CONTAINER (priv->swindow), priv->tree_view);
659 priv->tree_view = NULL;
662 if (! priv->icon_view) {
663 ev_sidebar_init_icon_view (sidebar_thumbnails);
664 g_object_notify (G_OBJECT (sidebar_thumbnails), "main_widget");
666 gtk_widget_queue_resize (priv->icon_view);
669 if (priv->icon_view) {
670 gtk_container_remove (GTK_CONTAINER (priv->swindow), priv->icon_view);
671 priv->icon_view = NULL;
674 if (! priv->tree_view) {
675 ev_sidebar_init_tree_view (sidebar_thumbnails);
676 g_object_notify (G_OBJECT (sidebar_thumbnails), "main_widget");
680 /* Connect to the signal and trigger a fake callback */
681 g_signal_connect (priv->page_cache, "page-changed", G_CALLBACK (page_changed_cb), sidebar_thumbnails);
682 sidebar_thumbnails->priv->start_page = -1;
683 sidebar_thumbnails->priv->end_page = -1;
684 page_changed_cb (priv->page_cache,
685 ev_page_cache_get_current_page (priv->page_cache),
687 adjustment_changed_cb (sidebar_thumbnails);
691 ev_sidebar_thumbnails_clear_job (GtkTreeModel *model,
698 gtk_tree_model_get (model, iter, COLUMN_JOB, &job, -1);
702 g_signal_handlers_disconnect_by_func (job, thumbnail_job_completed_callback, data);
703 g_object_unref (job);
710 ev_sidebar_thumbnails_clear_model (EvSidebarThumbnails *sidebar_thumbnails)
712 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
714 gtk_tree_model_foreach (GTK_TREE_MODEL (priv->list_store), ev_sidebar_thumbnails_clear_job, sidebar_thumbnails);
715 gtk_list_store_clear (priv->list_store);
719 ev_sidebar_thumbnails_support_document (EvSidebarPage *sidebar_page,
720 EvDocument *document)
722 return (EV_IS_DOCUMENT_THUMBNAILS (document));
726 ev_sidebar_thumbnails_get_label (EvSidebarPage *sidebar_page)
728 return _("Thumbnails");
732 ev_sidebar_thumbnails_page_iface_init (EvSidebarPageIface *iface)
734 iface->support_document = ev_sidebar_thumbnails_support_document;
735 iface->set_document = ev_sidebar_thumbnails_set_document;
736 iface->get_label = ev_sidebar_thumbnails_get_label;