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;
56 EvPageCache *page_cache;
58 gint n_pages, pages_done;
63 gint start_page, end_page;
79 static void ev_sidebar_thumbnails_clear_model (EvSidebarThumbnails *sidebar);
80 static gboolean ev_sidebar_thumbnails_support_document (EvSidebarPage *sidebar_page,
81 EvDocument *document);
82 static void ev_sidebar_thumbnails_page_iface_init (EvSidebarPageIface *iface);
83 static void ev_sidebar_thumbnails_set_document (EvSidebarPage *sidebar_page,
84 EvDocument *document);
85 static const gchar* ev_sidebar_thumbnails_get_label (EvSidebarPage *sidebar_page);
86 static void thumbnail_job_completed_callback (EvJobThumbnail *job,
87 EvSidebarThumbnails *sidebar_thumbnails);
88 static void adjustment_changed_cb (EvSidebarThumbnails *sidebar_thumbnails);
90 G_DEFINE_TYPE_EXTENDED (EvSidebarThumbnails,
91 ev_sidebar_thumbnails,
94 G_IMPLEMENT_INTERFACE (EV_TYPE_SIDEBAR_PAGE,
95 ev_sidebar_thumbnails_page_iface_init))
97 #define EV_SIDEBAR_THUMBNAILS_GET_PRIVATE(object) \
98 (G_TYPE_INSTANCE_GET_PRIVATE ((object), EV_TYPE_SIDEBAR_THUMBNAILS, EvSidebarThumbnailsPrivate));
102 ev_sidebar_thumbnails_dispose (GObject *object)
104 EvSidebarThumbnails *sidebar_thumbnails = EV_SIDEBAR_THUMBNAILS (object);
106 if (sidebar_thumbnails->priv->loading_icon) {
107 g_object_unref (sidebar_thumbnails->priv->loading_icon);
108 sidebar_thumbnails->priv->loading_icon = NULL;
111 if (sidebar_thumbnails->priv->list_store) {
112 ev_sidebar_thumbnails_clear_model (sidebar_thumbnails);
113 g_object_unref (sidebar_thumbnails->priv->list_store);
114 sidebar_thumbnails->priv->list_store = NULL;
117 G_OBJECT_CLASS (ev_sidebar_thumbnails_parent_class)->dispose (object);
121 ev_sidebar_thumbnails_get_property (GObject *object,
126 EvSidebarThumbnails *sidebar = EV_SIDEBAR_THUMBNAILS (object);
130 if (sidebar->priv->tree_view)
131 g_value_set_object (value, sidebar->priv->tree_view);
133 g_value_set_object (value, sidebar->priv->icon_view);
136 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
142 ev_sidebar_thumbnails_map (GtkWidget *widget)
144 EvSidebarThumbnails *sidebar;
146 sidebar = EV_SIDEBAR_THUMBNAILS (widget);
148 GTK_WIDGET_CLASS (ev_sidebar_thumbnails_parent_class)->map (widget);
150 adjustment_changed_cb (sidebar);
154 ev_sidebar_thumbnails_class_init (EvSidebarThumbnailsClass *ev_sidebar_thumbnails_class)
156 GObjectClass *g_object_class;
157 GtkObjectClass *gtk_object_class;
158 GtkWidgetClass *widget_class;
160 g_object_class = G_OBJECT_CLASS (ev_sidebar_thumbnails_class);
161 gtk_object_class = GTK_OBJECT_CLASS (ev_sidebar_thumbnails_class);
162 widget_class = GTK_WIDGET_CLASS (ev_sidebar_thumbnails_class);
164 g_object_class->dispose = ev_sidebar_thumbnails_dispose;
165 g_object_class->get_property = ev_sidebar_thumbnails_get_property;
166 widget_class->map = ev_sidebar_thumbnails_map;
168 g_object_class_override_property (g_object_class,
172 g_type_class_add_private (g_object_class, sizeof (EvSidebarThumbnailsPrivate));
176 ev_sidebar_thumbnails_new (void)
178 GtkWidget *ev_sidebar_thumbnails;
180 ev_sidebar_thumbnails = g_object_new (EV_TYPE_SIDEBAR_THUMBNAILS, NULL);
182 return ev_sidebar_thumbnails;
186 clear_range (EvSidebarThumbnails *sidebar_thumbnails,
190 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
195 g_assert (start_page <= end_page);
197 path = gtk_tree_path_new_from_indices (start_page, -1);
198 for (result = gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->list_store), &iter, path);
199 result && start_page <= end_page;
200 result = gtk_tree_model_iter_next (GTK_TREE_MODEL (priv->list_store), &iter), start_page ++) {
203 gtk_tree_model_get (GTK_TREE_MODEL (priv->list_store),
209 g_signal_handlers_disconnect_by_func (job, thumbnail_job_completed_callback, sidebar_thumbnails);
210 ev_job_queue_remove_job (EV_JOB (job));
211 g_object_unref (job);
214 gtk_list_store_set (priv->list_store, &iter,
216 COLUMN_THUMBNAIL_SET, FALSE,
217 COLUMN_PIXBUF, priv->loading_icon,
220 gtk_tree_path_free (path);
224 get_scale_for_page (EvSidebarThumbnails *sidebar_thumbnails,
227 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
230 ev_page_cache_get_size (priv->page_cache,
232 1.0, &width, &height);
234 return (gdouble)THUMBNAIL_WIDTH / (gdouble)width;
238 add_range (EvSidebarThumbnails *sidebar_thumbnails,
242 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
246 gint page = start_page;
248 g_assert (start_page <= end_page);
250 path = gtk_tree_path_new_from_indices (start_page, -1);
251 for (result = gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->list_store), &iter, path);
252 result && page <= end_page;
253 result = gtk_tree_model_iter_next (GTK_TREE_MODEL (priv->list_store), &iter), page ++) {
255 gboolean thumbnail_set;
257 gtk_tree_model_get (GTK_TREE_MODEL (priv->list_store), &iter,
259 COLUMN_THUMBNAIL_SET, &thumbnail_set,
262 if (job == NULL && !thumbnail_set) {
265 rc = ev_render_context_new (priv->rotation, page,
266 get_scale_for_page (sidebar_thumbnails, page));
267 job = ev_job_thumbnail_new (priv->document, rc);
268 ev_job_queue_add_job (EV_JOB (job), EV_JOB_PRIORITY_HIGH);
271 g_object_set_data_full (G_OBJECT (job), "tree_iter",
272 gtk_tree_iter_copy (&iter),
273 (GDestroyNotify) gtk_tree_iter_free);
274 g_signal_connect (job, "finished",
275 G_CALLBACK (thumbnail_job_completed_callback),
277 gtk_list_store_set (priv->list_store, &iter,
281 /* The queue and the list own a ref to the job now */
282 g_object_unref (job);
284 g_object_unref (job);
287 gtk_tree_path_free (path);
290 /* This modifies start */
292 update_visible_range (EvSidebarThumbnails *sidebar_thumbnails,
296 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
297 int old_start_page, old_end_page;
299 old_start_page = priv->start_page;
300 old_end_page = priv->end_page;
302 if (start_page == old_start_page &&
303 end_page == old_end_page)
306 /* Clear the areas we no longer display */
307 if (old_start_page < start_page)
308 clear_range (sidebar_thumbnails, old_start_page, MIN (start_page - 1, old_end_page));
310 if (old_end_page > end_page)
311 clear_range (sidebar_thumbnails, MAX (end_page + 1, old_start_page), old_end_page);
313 add_range (sidebar_thumbnails, start_page, end_page);
315 priv->start_page = start_page;
316 priv->end_page = end_page;
320 adjustment_changed_cb (EvSidebarThumbnails *sidebar_thumbnails)
322 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
323 GtkTreePath *path = NULL;
324 GtkTreePath *path2 = NULL;
328 /* Widget is not currently visible */
329 if (!GTK_WIDGET_MAPPED (sidebar_thumbnails))
332 if (priv->tree_view) {
333 if (! GTK_WIDGET_REALIZED (priv->tree_view))
336 #if GTK_CHECK_VERSION (2, 11, 3)
337 gtk_tree_view_convert_widget_to_bin_window_coords (GTK_TREE_VIEW (priv->tree_view),
338 0, (int) priv->vadjustment->value,
340 gtk_tree_view_convert_widget_to_bin_window_coords (GTK_TREE_VIEW (priv->tree_view),
341 0, (int) (priv->vadjustment->value + priv->vadjustment->page_size),
344 gtk_tree_view_tree_to_widget_coords (GTK_TREE_VIEW (priv->tree_view),
345 0, (int) priv->vadjustment->value,
347 gtk_tree_view_tree_to_widget_coords (GTK_TREE_VIEW (priv->tree_view),
348 0, (int) (priv->vadjustment->value + priv->vadjustment->page_size),
350 #endif /* GTK_CHECK_VERSION (2, 11, 3) */
352 gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (priv->tree_view),
355 gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (priv->tree_view),
358 } else if (priv->icon_view) {
359 if (! GTK_WIDGET_REALIZED (priv->icon_view))
361 if (! gtk_icon_view_get_visible_range (GTK_ICON_VIEW (priv->icon_view), &path, &path2))
368 update_visible_range (sidebar_thumbnails,
369 gtk_tree_path_get_indices (path)[0],
370 gtk_tree_path_get_indices (path2)[0]);
373 gtk_tree_path_free (path);
374 gtk_tree_path_free (path2);
378 ev_sidebar_thumbnails_fill_model (EvSidebarThumbnails *sidebar_thumbnails)
380 EvSidebarThumbnailsPrivate *priv = sidebar_thumbnails->priv;
384 for (i = 0; i < sidebar_thumbnails->priv->n_pages; i++) {
388 page_label = ev_page_cache_get_page_label (priv->page_cache, i);
389 page_string = g_markup_printf_escaped ("<i>%s</i>", page_label);
391 gtk_list_store_append (priv->list_store, &iter);
392 gtk_list_store_set (priv->list_store, &iter,
393 COLUMN_PAGE_STRING, page_string,
394 COLUMN_PIXBUF, priv->loading_icon,
395 COLUMN_THUMBNAIL_SET, FALSE,
398 g_free (page_string);
404 ev_sidebar_thumbnails_set_loading_icon (EvSidebarThumbnails *sidebar_thumbnails)
406 if (sidebar_thumbnails->priv->loading_icon)
407 g_object_unref (sidebar_thumbnails->priv->loading_icon);
409 if (sidebar_thumbnails->priv->document) {
412 /* We get the dimensions of the first page so that we can make a blank
414 ev_page_cache_get_thumbnail_size (sidebar_thumbnails->priv->page_cache, 0,
415 sidebar_thumbnails->priv->rotation,
418 sidebar_thumbnails->priv->loading_icon =
419 ev_document_misc_get_thumbnail_frame (width, height, NULL);
421 sidebar_thumbnails->priv->loading_icon = NULL;
427 refresh (EvSidebarThumbnails *sidebar_thumbnails)
429 adjustment_changed_cb (sidebar_thumbnails);
434 ev_sidebar_thumbnails_refresh (EvSidebarThumbnails *sidebar_thumbnails,
437 sidebar_thumbnails->priv->rotation = rotation;
438 ev_sidebar_thumbnails_set_loading_icon (sidebar_thumbnails);
440 if (sidebar_thumbnails->priv->document == NULL)
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 = 0;
448 sidebar_thumbnails->priv->end_page = 0;
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 = 0;
683 sidebar_thumbnails->priv->end_page = 0;
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);
701 ev_job_queue_remove_job (job);
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) &&
723 (ev_document_get_n_pages (document) > 1));
727 ev_sidebar_thumbnails_get_label (EvSidebarPage *sidebar_page)
729 return _("Thumbnails");
733 ev_sidebar_thumbnails_page_iface_init (EvSidebarPageIface *iface)
735 iface->support_document = ev_sidebar_thumbnails_support_document;
736 iface->set_document = ev_sidebar_thumbnails_set_document;
737 iface->get_label = ev_sidebar_thumbnails_get_label;