1 /* this file is part of evince, a gnome document viewer
3 * Copyright (C) 2004 Red Hat, Inc.
6 * Jonathan Blandford <jrb@alum.mit.edu>
8 * Evince is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * Evince is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
28 #include <glib/gi18n.h>
31 #include "ev-sidebar-page.h"
32 #include "ev-sidebar-links.h"
33 #include "ev-job-queue.h"
34 #include "ev-document-links.h"
35 #include "ev-window.h"
37 struct _EvSidebarLinksPrivate {
40 /* Keep these ids around for blocking */
42 guint page_changed_id;
43 guint row_activated_id;
48 EvPageCache *page_cache;
62 static void links_page_num_func (GtkTreeViewColumn *tree_column,
63 GtkCellRenderer *cell,
64 GtkTreeModel *tree_model,
66 EvSidebarLinks *sidebar_links);
67 static void update_page_callback (EvPageCache *page_cache,
69 EvSidebarLinks *sidebar_links);
70 static void row_activated_callback (GtkTreeView *treeview,
72 GtkTreeViewColumn *arg2,
74 static void job_finished_callback (EvJobLinks *job,
75 EvSidebarLinks *sidebar_links);
76 static void ev_sidebar_links_page_iface_init (EvSidebarPageIface *iface);
77 static void ev_sidebar_links_set_document (EvSidebarPage *sidebar_page,
78 EvDocument *document);
79 static gboolean ev_sidebar_links_support_document (EvSidebarPage *sidebar_page,
80 EvDocument *document);
81 static const gchar* ev_sidebar_links_get_label (EvSidebarPage *sidebar_page);
83 static guint signals[N_SIGNALS];
85 G_DEFINE_TYPE_EXTENDED (EvSidebarLinks,
89 G_IMPLEMENT_INTERFACE (EV_TYPE_SIDEBAR_PAGE,
90 ev_sidebar_links_page_iface_init))
93 #define EV_SIDEBAR_LINKS_GET_PRIVATE(object) \
94 (G_TYPE_INSTANCE_GET_PRIVATE ((object), EV_TYPE_SIDEBAR_LINKS, EvSidebarLinksPrivate))
97 ev_sidebar_links_set_property (GObject *object,
102 EvSidebarLinks *ev_sidebar_links;
105 ev_sidebar_links = EV_SIDEBAR_LINKS (object);
110 model = ev_sidebar_links->priv->model;
111 ev_sidebar_links->priv->model = GTK_TREE_MODEL (g_value_dup_object (value));
113 g_object_unref (model);
116 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
122 ev_sidebar_links_get_property (GObject *object,
127 EvSidebarLinks *ev_sidebar_links;
129 ev_sidebar_links = EV_SIDEBAR_LINKS (object);
134 g_value_set_object (value, ev_sidebar_links->priv->model);
137 g_value_set_object (value, ev_sidebar_links->priv->tree_view);
140 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
146 ev_sidebar_links_dispose (GObject *object)
148 EvSidebarLinks *sidebar = EV_SIDEBAR_LINKS (object);
150 if (sidebar->priv->job) {
151 g_signal_handlers_disconnect_by_func (sidebar->priv->job,
152 job_finished_callback, sidebar);
153 ev_job_queue_remove_job (sidebar->priv->job);
154 g_object_unref (sidebar->priv->job);
155 sidebar->priv->job = NULL;
158 if (sidebar->priv->model) {
159 g_object_unref (sidebar->priv->model);
160 sidebar->priv->model = NULL;
163 if (sidebar->priv->document) {
164 g_object_unref (sidebar->priv->document);
165 sidebar->priv->document = NULL;
166 sidebar->priv->page_cache = NULL;
169 G_OBJECT_CLASS (ev_sidebar_links_parent_class)->dispose (object);
173 ev_sidebar_links_map (GtkWidget *widget)
175 EvSidebarLinks *links;
177 links = EV_SIDEBAR_LINKS (widget);
179 GTK_WIDGET_CLASS (ev_sidebar_links_parent_class)->map (widget);
181 if (links->priv->page_cache) {
182 update_page_callback (links->priv->page_cache,
183 ev_page_cache_get_current_page (links->priv->page_cache),
189 ev_sidebar_links_class_init (EvSidebarLinksClass *ev_sidebar_links_class)
191 GObjectClass *g_object_class;
192 GtkWidgetClass *widget_class;
194 g_object_class = G_OBJECT_CLASS (ev_sidebar_links_class);
195 widget_class = GTK_WIDGET_CLASS (ev_sidebar_links_class);
197 g_object_class->set_property = ev_sidebar_links_set_property;
198 g_object_class->get_property = ev_sidebar_links_get_property;
199 g_object_class->dispose = ev_sidebar_links_dispose;
201 widget_class->map = ev_sidebar_links_map;
203 signals[LINK_ACTIVATED] = g_signal_new ("link-activated",
204 G_TYPE_FROM_CLASS (g_object_class),
205 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
206 G_STRUCT_OFFSET (EvSidebarLinksClass, link_activated),
208 g_cclosure_marshal_VOID__OBJECT,
209 G_TYPE_NONE, 1, G_TYPE_OBJECT);
211 g_object_class_install_property (g_object_class,
213 g_param_spec_object ("model",
218 g_object_class_override_property (g_object_class,
222 g_type_class_add_private (g_object_class, sizeof (EvSidebarLinksPrivate));
226 selection_changed_callback (GtkTreeSelection *selection,
227 EvSidebarLinks *ev_sidebar_links)
229 EvDocument *document;
233 document = EV_DOCUMENT (ev_sidebar_links->priv->document);
234 g_return_if_fail (ev_sidebar_links->priv->document != NULL);
236 if (gtk_tree_selection_get_selected (selection, &model, &iter)) {
239 gtk_tree_model_get (model, &iter,
240 EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
246 g_signal_handler_block (ev_sidebar_links->priv->page_cache,
247 ev_sidebar_links->priv->page_changed_id);
248 g_signal_emit (ev_sidebar_links, signals[LINK_ACTIVATED], 0, link);
249 g_signal_handler_unblock (ev_sidebar_links->priv->page_cache,
250 ev_sidebar_links->priv->page_changed_id);
252 g_object_unref (link);
256 static GtkTreeModel *
257 create_loading_model (void)
259 GtkTreeModel *retval;
263 /* Creates a fake model to indicate that we're loading */
264 retval = (GtkTreeModel *)gtk_list_store_new (EV_DOCUMENT_LINKS_COLUMN_NUM_COLUMNS,
269 gtk_list_store_append (GTK_LIST_STORE (retval), &iter);
270 markup = g_strdup_printf ("<span size=\"larger\" style=\"italic\">%s</span>", _("Loading..."));
271 gtk_list_store_set (GTK_LIST_STORE (retval), &iter,
272 EV_DOCUMENT_LINKS_COLUMN_MARKUP, markup,
273 EV_DOCUMENT_LINKS_COLUMN_EXPAND, FALSE,
274 EV_DOCUMENT_LINKS_COLUMN_LINK, NULL,
282 get_page_from_link (EvLink *link)
284 EvLinkAction *action;
287 action = ev_link_get_action (link);
291 if (ev_link_action_get_action_type (action) !=
292 EV_LINK_ACTION_TYPE_GOTO_DEST)
295 dest = ev_link_action_get_dest (action);
297 return ev_link_dest_get_page (dest);
303 print_section_cb (GtkWidget *menuitem, EvSidebarLinks *sidebar)
306 GtkTreeSelection *selection;
310 selection = gtk_tree_view_get_selection
311 (GTK_TREE_VIEW (sidebar->priv->tree_view));
313 if (gtk_tree_selection_get_selected (selection, &model, &iter)) {
315 int first_page, last_page = -1;
317 gtk_tree_model_get (model, &iter,
318 EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
324 first_page = get_page_from_link (link);
325 if (first_page == -1) {
326 g_object_unref (link);
331 g_object_unref (link);
333 if (gtk_tree_model_iter_next (model, &iter)) {
334 gtk_tree_model_get (model, &iter,
335 EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
339 last_page = get_page_from_link (link);
340 g_object_unref (link);
343 last_page = ev_page_cache_get_n_pages (sidebar->priv->page_cache);
347 last_page = ev_page_cache_get_n_pages (sidebar->priv->page_cache);
349 window = gtk_widget_get_toplevel (GTK_WIDGET (sidebar));
350 if (EV_IS_WINDOW (window)) {
352 ev_window_print_range (EV_WINDOW (window),
353 first_page, last_page);
360 build_popup_menu (EvSidebarLinks *sidebar)
365 menu = gtk_menu_new ();
366 item = gtk_image_menu_item_new_from_stock (GTK_STOCK_PRINT, NULL);
367 gtk_label_set_label (GTK_LABEL (GTK_BIN (item)->child), _("Print..."));
368 gtk_widget_show (item);
369 gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
370 g_signal_connect (item, "activate",
371 G_CALLBACK (print_section_cb), sidebar);
373 return GTK_MENU (menu);
377 popup_menu_cb (GtkWidget *treeview, EvSidebarLinks *sidebar)
379 GtkMenu *menu = build_popup_menu (sidebar);
381 gtk_menu_popup (menu, NULL, NULL,
382 ev_gui_menu_position_tree_selection,
383 sidebar->priv->tree_view, 0,
384 gtk_get_current_event_time ());
385 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu), FALSE);
389 button_press_cb (GtkWidget *treeview,
390 GdkEventButton *event,
391 EvSidebarLinks *sidebar)
393 GtkTreePath *path = NULL;
395 if (event->button == 3) {
396 if (gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (treeview),
401 gtk_tree_view_set_cursor (GTK_TREE_VIEW (treeview),
403 gtk_menu_popup (build_popup_menu (sidebar), NULL,
404 NULL, NULL, NULL, event->button,
405 gtk_get_current_event_time ());
406 gtk_tree_path_free (path);
417 ev_sidebar_links_construct (EvSidebarLinks *ev_sidebar_links)
419 EvSidebarLinksPrivate *priv;
421 GtkTreeViewColumn *column;
422 GtkCellRenderer *renderer;
423 GtkTreeSelection *selection;
424 GtkTreeModel *loading_model;
426 priv = ev_sidebar_links->priv;
428 swindow = gtk_scrolled_window_new (NULL, NULL);
430 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (swindow),
431 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
432 gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (swindow),
435 /* Create tree view */
436 loading_model = create_loading_model ();
437 priv->tree_view = gtk_tree_view_new_with_model (loading_model);
438 g_object_unref (loading_model);
440 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
441 gtk_tree_selection_set_mode (selection, GTK_SELECTION_NONE);
442 gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->tree_view), FALSE);
443 gtk_container_add (GTK_CONTAINER (swindow), priv->tree_view);
445 gtk_box_pack_start (GTK_BOX (ev_sidebar_links), swindow, TRUE, TRUE, 0);
446 gtk_widget_show_all (GTK_WIDGET (ev_sidebar_links));
448 column = gtk_tree_view_column_new ();
449 gtk_tree_view_column_set_expand (GTK_TREE_VIEW_COLUMN (column), TRUE);
450 gtk_tree_view_append_column (GTK_TREE_VIEW (priv->tree_view), column);
452 renderer = (GtkCellRenderer*)
453 g_object_new (GTK_TYPE_CELL_RENDERER_TEXT,
454 "ellipsize", PANGO_ELLIPSIZE_END,
456 gtk_tree_view_column_pack_start (GTK_TREE_VIEW_COLUMN (column), renderer, TRUE);
457 gtk_tree_view_column_set_attributes (GTK_TREE_VIEW_COLUMN (column), renderer,
458 "markup", EV_DOCUMENT_LINKS_COLUMN_MARKUP,
462 renderer = gtk_cell_renderer_text_new ();
463 gtk_tree_view_column_pack_end (GTK_TREE_VIEW_COLUMN (column), renderer, FALSE);
464 gtk_tree_view_column_set_cell_data_func (GTK_TREE_VIEW_COLUMN (column), renderer,
465 (GtkTreeCellDataFunc) links_page_num_func,
466 ev_sidebar_links, NULL);
468 g_signal_connect (GTK_TREE_VIEW (priv->tree_view),
469 "button_press_event",
470 G_CALLBACK (button_press_cb),
472 g_signal_connect (GTK_TREE_VIEW (priv->tree_view),
474 G_CALLBACK (popup_menu_cb),
479 ev_sidebar_links_init (EvSidebarLinks *ev_sidebar_links)
481 ev_sidebar_links->priv = EV_SIDEBAR_LINKS_GET_PRIVATE (ev_sidebar_links);
483 ev_sidebar_links_construct (ev_sidebar_links);
487 links_page_num_func (GtkTreeViewColumn *tree_column,
488 GtkCellRenderer *cell,
489 GtkTreeModel *tree_model,
491 EvSidebarLinks *sidebar_links)
496 gtk_tree_model_get (tree_model, iter,
497 EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
507 page = get_page_from_link (link);
513 page_label = ev_page_cache_get_page_label (sidebar_links->priv->page_cache,
515 page_string = g_markup_printf_escaped ("<i>%s</i>", page_label);
518 "markup", page_string,
523 g_free (page_string);
530 g_object_unref (link);
533 /* Public Functions */
536 ev_sidebar_links_new (void)
538 GtkWidget *ev_sidebar_links;
540 ev_sidebar_links = g_object_new (EV_TYPE_SIDEBAR_LINKS, NULL);
542 return ev_sidebar_links;
546 update_page_callback_foreach (GtkTreeModel *model,
551 EvSidebarLinks *sidebar_links = (data);
554 gtk_tree_model_get (model, iter,
555 EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
562 dest_page = get_page_from_link (link);
563 g_object_unref (link);
565 current_page = ev_page_cache_get_current_page (sidebar_links->priv->page_cache);
567 if (dest_page == current_page) {
568 gtk_tree_view_expand_to_path (GTK_TREE_VIEW (sidebar_links->priv->tree_view),
570 gtk_tree_view_set_cursor (GTK_TREE_VIEW (sidebar_links->priv->tree_view),
581 update_page_callback (EvPageCache *page_cache,
583 EvSidebarLinks *sidebar_links)
585 GtkTreeSelection *selection;
589 /* Widget is not currently visible */
590 if (!GTK_WIDGET_MAPPED (sidebar_links))
593 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (sidebar_links->priv->tree_view));
595 if (gtk_tree_selection_get_selected (selection, &model, &iter)) {
598 gtk_tree_model_get (model, &iter,
599 EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
604 dest_page = get_page_from_link (link);
605 g_object_unref (link);
607 if (dest_page == current_page)
612 /* We go through the tree linearly looking for the first page that
613 * matches. This is pretty inefficient. We can do something neat with
614 * a GtkTreeModelSort here to make it faster, if it turns out to be
617 g_signal_handler_block (selection, sidebar_links->priv->selection_id);
618 g_signal_handler_block (sidebar_links->priv->tree_view, sidebar_links->priv->row_activated_id);
620 gtk_tree_model_foreach (model,
621 update_page_callback_foreach,
624 g_signal_handler_unblock (selection, sidebar_links->priv->selection_id);
625 g_signal_handler_unblock (sidebar_links->priv->tree_view, sidebar_links->priv->row_activated_id);
629 row_activated_callback (GtkTreeView *treeview,
631 GtkTreeViewColumn *arg2,
634 if (gtk_tree_view_row_expanded (GTK_TREE_VIEW (treeview), arg1)) {
635 gtk_tree_view_collapse_row (GTK_TREE_VIEW (treeview), arg1);
637 gtk_tree_view_expand_row (GTK_TREE_VIEW (treeview), arg1, FALSE);
642 expand_open_links (GtkTreeView *tree_view, GtkTreeModel *model, GtkTreeIter *parent)
647 if (gtk_tree_model_iter_children (model, &iter, parent)) {
649 gtk_tree_model_get (model, &iter,
650 EV_DOCUMENT_LINKS_COLUMN_EXPAND, &expand,
655 path = gtk_tree_model_get_path (model, &iter);
656 gtk_tree_view_expand_row (tree_view, path, FALSE);
657 gtk_tree_path_free (path);
660 expand_open_links (tree_view, model, &iter);
661 } while (gtk_tree_model_iter_next (model, &iter));
666 job_finished_callback (EvJobLinks *job,
667 EvSidebarLinks *sidebar_links)
669 EvSidebarLinksPrivate *priv;
670 GtkTreeSelection *selection;
672 priv = sidebar_links->priv;
674 priv->model = job->model;
675 g_object_notify (G_OBJECT (sidebar_links), "model");
677 gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), job->model);
679 g_object_unref (job);
682 expand_open_links (GTK_TREE_VIEW (priv->tree_view), priv->model, NULL);
684 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
685 gtk_tree_selection_set_mode (selection, GTK_SELECTION_SINGLE);
686 priv->selection_id = g_signal_connect (selection, "changed",
687 G_CALLBACK (selection_changed_callback),
689 priv->page_changed_id = g_signal_connect (priv->page_cache, "page-changed",
690 G_CALLBACK (update_page_callback),
692 priv->row_activated_id = g_signal_connect (G_OBJECT (priv->tree_view), "row-activated",
693 G_CALLBACK (row_activated_callback), sidebar_links);
694 update_page_callback (priv->page_cache,
695 ev_page_cache_get_current_page (priv->page_cache),
701 ev_sidebar_links_set_document (EvSidebarPage *sidebar_page,
702 EvDocument *document)
704 EvSidebarLinks *sidebar_links;
705 EvSidebarLinksPrivate *priv;
707 g_return_if_fail (EV_IS_SIDEBAR_PAGE (sidebar_page));
708 g_return_if_fail (EV_IS_DOCUMENT (document));
710 sidebar_links = EV_SIDEBAR_LINKS (sidebar_page);
712 priv = sidebar_links->priv;
714 if (priv->document) {
715 gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), NULL);
716 g_object_unref (priv->document);
719 priv->document = g_object_ref (document);
720 priv->page_cache = ev_page_cache_get (document);
723 g_signal_handlers_disconnect_by_func (priv->job,
724 job_finished_callback,
726 g_object_unref (priv->job);
729 priv->job = ev_job_links_new (document);
730 g_signal_connect (priv->job,
732 G_CALLBACK (job_finished_callback),
734 /* The priority doesn't matter for this job */
735 ev_job_queue_add_job (priv->job, EV_JOB_PRIORITY_LOW);
739 ev_sidebar_links_support_document (EvSidebarPage *sidebar_page,
740 EvDocument *document)
742 return (EV_IS_DOCUMENT_LINKS (document) &&
743 ev_document_links_has_document_links (EV_DOCUMENT_LINKS (document)));
747 ev_sidebar_links_get_label (EvSidebarPage *sidebar_page)
753 ev_sidebar_links_page_iface_init (EvSidebarPageIface *iface)
755 iface->support_document = ev_sidebar_links_support_document;
756 iface->set_document = ev_sidebar_links_set_document;
757 iface->get_label = ev_sidebar_links_get_label;