]> www.fi.muni.cz Git - evince.git/blob - shell/ev-sidebar-links.c
PageCache and EvJobs are moved from backend to shell. Two new jobs to
[evince.git] / shell / ev-sidebar-links.c
1 /* this file is part of evince, a gnome document viewer
2  *
3  *  Copyright (C) 2004 Red Hat, Inc.
4  *
5  *  Author:
6  *    Jonathan Blandford <jrb@alum.mit.edu>
7  *
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.
12  *
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.
17  *
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.
21  */
22
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
27 #include <string.h>
28 #include <glib/gi18n.h>
29 #include <gtk/gtk.h>
30
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"
36 #include "ev-gui.h"
37
38 struct _EvSidebarLinksPrivate {
39         GtkWidget *tree_view;
40
41         /* Keep these ids around for blocking */
42         guint selection_id;
43         guint page_changed_id;
44         guint row_activated_id;
45
46         EvJob *job;
47         GtkTreeModel *model;
48         EvDocument *document;
49         EvPageCache *page_cache;
50 };
51
52 enum {
53         PROP_0,
54         PROP_MODEL,
55 };
56
57
58 static void links_page_num_func                         (GtkTreeViewColumn *tree_column,
59                                                          GtkCellRenderer   *cell,
60                                                          GtkTreeModel      *tree_model,
61                                                          GtkTreeIter       *iter,
62                                                          EvSidebarLinks    *sidebar_links);
63 static void update_page_callback                        (EvPageCache       *page_cache,
64                                                          gint               current_page,
65                                                          EvSidebarLinks    *sidebar_links);
66 static void row_activated_callback                      (GtkTreeView *treeview,
67                                                          GtkTreePath *arg1,
68                                                          GtkTreeViewColumn *arg2,
69                                                          gpointer user_data);
70 static void job_finished_callback                       (EvJobLinks     *job,
71                                                          EvSidebarLinks *sidebar_links);
72 static void ev_sidebar_links_page_iface_init            (EvSidebarPageIface *iface);
73 static void ev_sidebar_links_set_document               (EvSidebarPage  *sidebar_page,
74                                                          EvDocument     *document);
75 static gboolean ev_sidebar_links_support_document       (EvSidebarPage  *sidebar_page,
76                                                          EvDocument     *document);
77 static const gchar* ev_sidebar_links_get_label          (EvSidebarPage *sidebar_page);
78
79
80 G_DEFINE_TYPE_EXTENDED (EvSidebarLinks, 
81                         ev_sidebar_links, 
82                         GTK_TYPE_VBOX,
83                         0, 
84                         G_IMPLEMENT_INTERFACE (EV_TYPE_SIDEBAR_PAGE, 
85                                                ev_sidebar_links_page_iface_init))
86
87
88 #define EV_SIDEBAR_LINKS_GET_PRIVATE(object) \
89         (G_TYPE_INSTANCE_GET_PRIVATE ((object), EV_TYPE_SIDEBAR_LINKS, EvSidebarLinksPrivate))
90
91 static void
92 ev_sidebar_links_set_property (GObject      *object,
93                                guint         prop_id,
94                                const GValue *value,
95                                GParamSpec   *pspec)
96 {
97         EvSidebarLinks *ev_sidebar_links;
98         GtkTreeModel *model;
99   
100         ev_sidebar_links = EV_SIDEBAR_LINKS (object);
101
102         switch (prop_id)
103         {
104         case PROP_MODEL:
105                 model = ev_sidebar_links->priv->model;
106                 ev_sidebar_links->priv->model = GTK_TREE_MODEL (g_value_dup_object (value));
107                 if (model)
108                         g_object_unref (model);
109                 break;
110         default:
111                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
112                 break;
113         }
114 }
115
116 static void
117 ev_sidebar_links_get_property (GObject    *object,
118                                guint       prop_id,
119                                GValue     *value,
120                                GParamSpec *pspec)
121 {
122         EvSidebarLinks *ev_sidebar_links;
123   
124         ev_sidebar_links = EV_SIDEBAR_LINKS (object);
125
126         switch (prop_id)
127         {
128         case PROP_MODEL:
129                 g_value_set_object (value, ev_sidebar_links->priv->model);
130                 break;
131         default:
132                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
133                 break;
134         }
135 }
136
137 static void
138 ev_sidebar_links_dispose (GObject *object)
139 {
140         EvSidebarLinks *sidebar = EV_SIDEBAR_LINKS (object);
141
142         if (sidebar->priv->document) {
143                 g_object_unref (sidebar->priv->document);
144                 sidebar->priv->document = NULL;
145                 sidebar->priv->page_cache = NULL;
146         }
147
148         if (sidebar->priv->job) {
149                 g_signal_handlers_disconnect_by_func (sidebar->priv->job,
150                                                       job_finished_callback, sidebar);
151                 ev_job_queue_remove_job (sidebar->priv->job);                                                 
152                 g_object_unref (sidebar->priv->job);
153                 sidebar->priv->job = NULL;
154         }
155
156         G_OBJECT_CLASS (ev_sidebar_links_parent_class)->dispose (object);
157 }
158
159 static void
160 ev_sidebar_links_class_init (EvSidebarLinksClass *ev_sidebar_links_class)
161 {
162         GObjectClass *g_object_class;
163
164         g_object_class = G_OBJECT_CLASS (ev_sidebar_links_class);
165
166         g_object_class->set_property = ev_sidebar_links_set_property;
167         g_object_class->get_property = ev_sidebar_links_get_property;
168         g_object_class->dispose = ev_sidebar_links_dispose;
169
170         g_object_class_install_property (g_object_class,
171                                          PROP_MODEL,
172                                          g_param_spec_object ("model",
173                                                               "Model",
174                                                               "Current Model",
175                                                               GTK_TYPE_TREE_MODEL,
176                                                               G_PARAM_READWRITE));
177
178         g_type_class_add_private (g_object_class, sizeof (EvSidebarLinksPrivate));
179 }
180
181 static void
182 selection_changed_callback (GtkTreeSelection   *selection,
183                             EvSidebarLinks     *ev_sidebar_links)
184 {
185         EvDocument *document;
186         GtkTreeModel *model;
187         GtkTreeIter iter;
188
189         g_return_if_fail (EV_IS_SIDEBAR_LINKS (ev_sidebar_links));
190
191         document = EV_DOCUMENT (ev_sidebar_links->priv->document);
192         g_return_if_fail (ev_sidebar_links->priv->document != NULL);
193
194         if (gtk_tree_selection_get_selected (selection, &model, &iter)) {
195                 EvLink *link;
196
197                 gtk_tree_model_get (model, &iter,
198                                     EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
199                                     -1);
200                 
201                 if (link == NULL)
202                         return;
203
204                 g_signal_handler_block (ev_sidebar_links->priv->page_cache,
205                                         ev_sidebar_links->priv->page_changed_id);
206                 /* FIXME: we should handle this better.  This breaks w/ URLs */
207                 ev_page_cache_set_link (ev_sidebar_links->priv->page_cache, link);
208                 g_signal_handler_unblock (ev_sidebar_links->priv->page_cache,
209                                           ev_sidebar_links->priv->page_changed_id);
210         }
211 }
212
213 static GtkTreeModel *
214 create_loading_model (void)
215 {
216         GtkTreeModel *retval;
217         GtkTreeIter iter;
218         gchar *markup;
219
220         /* Creates a fake model to indicate that we're loading */
221         retval = (GtkTreeModel *)gtk_list_store_new (EV_DOCUMENT_LINKS_COLUMN_NUM_COLUMNS,
222                                                      G_TYPE_STRING,
223                                                      G_TYPE_OBJECT);
224
225         gtk_list_store_append (GTK_LIST_STORE (retval), &iter);
226         markup = g_strdup_printf ("<span size=\"larger\" style=\"italic\">%s</span>", _("Loading..."));
227         gtk_list_store_set (GTK_LIST_STORE (retval), &iter,
228                             EV_DOCUMENT_LINKS_COLUMN_MARKUP, markup,
229                             EV_DOCUMENT_LINKS_COLUMN_LINK, NULL,
230                             -1);
231         g_free (markup);
232
233         return retval;
234 }
235
236 static void
237 print_section_cb (GtkWidget *menuitem, EvSidebarLinks *sidebar)
238 {
239         GtkWidget *window;
240         GtkTreeSelection *selection;
241         GtkTreeModel *model;
242         GtkTreeIter iter;
243
244         selection = gtk_tree_view_get_selection
245                 (GTK_TREE_VIEW (sidebar->priv->tree_view));
246
247         if (gtk_tree_selection_get_selected (selection, &model, &iter)) {
248                 EvLink *link;
249                 int first_page, last_page;
250
251                 gtk_tree_model_get (model, &iter,
252                                     EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
253                                     -1);
254                 first_page = ev_link_get_page (link) + 1;
255
256                 if (gtk_tree_model_iter_next (model, &iter)) {
257                         gtk_tree_model_get (model, &iter,
258                                             EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
259                                             -1);
260                         last_page = ev_link_get_page (link);
261                 } else {
262                         last_page = -1;
263                 }
264         
265                 window = gtk_widget_get_toplevel (GTK_WIDGET (sidebar));
266                 if (EV_IS_WINDOW (window)) {
267                         ev_window_print_range (EV_WINDOW (window),
268                                                first_page, last_page);
269                 }
270         }
271 }
272
273 static GtkMenu *
274 build_popup_menu (EvSidebarLinks *sidebar)
275 {
276         GtkWidget *menu;
277         GtkWidget *item;
278
279         menu = gtk_menu_new ();
280         item = gtk_image_menu_item_new_from_stock (GTK_STOCK_PRINT, NULL);
281         gtk_label_set_label (GTK_LABEL (GTK_BIN (item)->child), _("Print..."));
282         gtk_widget_show (item);
283         gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
284         g_signal_connect (item, "activate",
285                           G_CALLBACK (print_section_cb), sidebar);
286
287         return GTK_MENU (menu);
288 }
289
290 static void
291 popup_menu_cb (GtkWidget *treeview, EvSidebarLinks *sidebar)
292 {
293         GtkMenu *menu = build_popup_menu (sidebar);
294
295         gtk_menu_popup (menu, NULL, NULL,
296                         ev_gui_menu_position_tree_selection,
297                         sidebar->priv->tree_view, 0,
298                         gtk_get_current_event_time ());
299         gtk_menu_shell_select_first (GTK_MENU_SHELL (menu), FALSE);
300 }
301
302 static gboolean
303 button_press_cb (GtkWidget *treeview,
304                  GdkEventButton *event,
305                  EvSidebarLinks *sidebar)
306 {
307         GtkTreePath *path = NULL;
308
309         if (event->button == 3) {
310                 if (gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (treeview),
311                                                    event->x,
312                                                    event->y,
313                                                    &path,
314                                                    NULL, NULL, NULL)) {
315                         gtk_tree_view_set_cursor (GTK_TREE_VIEW (treeview),
316                                                   path, NULL, FALSE);
317                         gtk_menu_popup (build_popup_menu (sidebar), NULL,
318                                         NULL, NULL, NULL, event->button,
319                                         gtk_get_current_event_time ());
320                         gtk_tree_path_free (path);
321
322                         return TRUE;
323                 }
324         }
325
326         return FALSE;
327 }
328
329
330 static void
331 ev_sidebar_links_construct (EvSidebarLinks *ev_sidebar_links)
332 {
333         EvSidebarLinksPrivate *priv;
334         GtkWidget *swindow;
335         GtkTreeViewColumn *column;
336         GtkCellRenderer *renderer;
337         GtkTreeSelection *selection;
338         GtkTreeModel *loading_model;
339
340         priv = ev_sidebar_links->priv;
341
342         swindow = gtk_scrolled_window_new (NULL, NULL);
343
344         gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (swindow),
345                                         GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
346         gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (swindow),
347                                              GTK_SHADOW_IN);
348
349         /* Create tree view */
350         loading_model = create_loading_model ();
351         priv->tree_view = gtk_tree_view_new_with_model (loading_model);
352         g_object_unref (loading_model);
353
354         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
355         gtk_tree_selection_set_mode (selection, GTK_SELECTION_NONE);
356         gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->tree_view), FALSE);
357         gtk_container_add (GTK_CONTAINER (swindow), priv->tree_view);
358
359         gtk_box_pack_start (GTK_BOX (ev_sidebar_links), swindow, TRUE, TRUE, 0);
360         gtk_widget_show_all (GTK_WIDGET (ev_sidebar_links));
361
362         column = gtk_tree_view_column_new ();
363         gtk_tree_view_column_set_expand (GTK_TREE_VIEW_COLUMN (column), TRUE);
364         gtk_tree_view_append_column (GTK_TREE_VIEW (priv->tree_view), column);
365
366         renderer = (GtkCellRenderer*)
367                 g_object_new (GTK_TYPE_CELL_RENDERER_TEXT,
368                               "ellipsize", PANGO_ELLIPSIZE_END,
369                               NULL);
370         gtk_tree_view_column_pack_start (GTK_TREE_VIEW_COLUMN (column), renderer, TRUE);
371         gtk_tree_view_column_set_attributes (GTK_TREE_VIEW_COLUMN (column), renderer,
372                                              "markup", EV_DOCUMENT_LINKS_COLUMN_MARKUP,
373                                              NULL);
374
375         
376         renderer = gtk_cell_renderer_text_new ();
377         gtk_tree_view_column_pack_end (GTK_TREE_VIEW_COLUMN (column), renderer, FALSE);
378         gtk_tree_view_column_set_cell_data_func (GTK_TREE_VIEW_COLUMN (column), renderer,
379                                                  (GtkTreeCellDataFunc) links_page_num_func,
380                                                  ev_sidebar_links, NULL);
381
382         g_signal_connect (GTK_TREE_VIEW (priv->tree_view),
383                           "button_press_event",
384                           G_CALLBACK (button_press_cb),
385                           ev_sidebar_links);
386         g_signal_connect (GTK_TREE_VIEW (priv->tree_view),
387                           "popup_menu",
388                           G_CALLBACK (popup_menu_cb),
389                           ev_sidebar_links);
390 }
391
392 static void
393 ev_sidebar_links_init (EvSidebarLinks *ev_sidebar_links)
394 {
395         ev_sidebar_links->priv = EV_SIDEBAR_LINKS_GET_PRIVATE (ev_sidebar_links);
396
397         ev_sidebar_links_construct (ev_sidebar_links);
398 }
399
400 static void
401 links_page_num_func (GtkTreeViewColumn *tree_column,
402                      GtkCellRenderer   *cell,
403                      GtkTreeModel      *tree_model,
404                      GtkTreeIter       *iter,
405                      EvSidebarLinks    *sidebar_links)
406 {
407         EvLink *link;
408
409         gtk_tree_model_get (tree_model, iter,
410                             EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
411                             -1);
412         
413         if (link != NULL &&
414             ev_link_get_link_type (link) == EV_LINK_TYPE_PAGE) {
415                 gchar *page_label;
416                 gchar *page_string;
417
418                 page_label = ev_page_cache_get_page_label (sidebar_links->priv->page_cache, ev_link_get_page (link));
419                 page_string = g_markup_printf_escaped ("<i>%s</i>", page_label);
420
421                 g_object_set (cell,
422                               "markup", page_string,
423                               "visible", TRUE,
424                               NULL);
425
426                 g_free (page_label);
427                 g_free (page_string);
428         } else {
429                 g_object_set (cell,
430                               "visible", FALSE,
431                               NULL);
432         }
433 }
434
435 /* Public Functions */
436
437 GtkWidget *
438 ev_sidebar_links_new (void)
439 {
440         GtkWidget *ev_sidebar_links;
441
442         ev_sidebar_links = g_object_new (EV_TYPE_SIDEBAR_LINKS, NULL);
443
444         return ev_sidebar_links;
445 }
446
447 static gboolean
448 update_page_callback_foreach (GtkTreeModel *model,
449                               GtkTreePath  *path,
450                               GtkTreeIter  *iter,
451                               gpointer      data)
452 {
453         EvSidebarLinks *sidebar_links = (data);
454         EvLink *link;
455
456         gtk_tree_model_get (model, iter,
457                             EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
458                             -1);
459
460         if (link && ev_link_get_link_type (link) == EV_LINK_TYPE_PAGE) {
461                 int current_page;
462
463                 current_page = ev_page_cache_get_current_page (sidebar_links->priv->page_cache);
464                 if (ev_link_get_page (link) == current_page) {
465                         GtkTreeSelection *selection;
466
467                         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (sidebar_links->priv->tree_view));
468
469                         gtk_tree_selection_select_path (selection, path);
470
471                         return TRUE;
472                 }
473         }
474         
475         return FALSE;
476 }
477
478 static void
479 update_page_callback (EvPageCache    *page_cache,
480                       gint            current_page,
481                       EvSidebarLinks *sidebar_links)
482 {
483         GtkTreeSelection *selection;
484         /* We go through the tree linearly looking for the first page that
485          * matches.  This is pretty inefficient.  We can do something neat with
486          * a GtkTreeModelSort here to make it faster, if it turns out to be
487          * slow.
488          */
489
490         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (sidebar_links->priv->tree_view));
491
492         g_signal_handler_block (selection, sidebar_links->priv->selection_id);
493         g_signal_handler_block (sidebar_links->priv->tree_view, sidebar_links->priv->row_activated_id);
494
495         gtk_tree_selection_unselect_all (selection);
496         gtk_tree_model_foreach (sidebar_links->priv->model,
497                                 update_page_callback_foreach,
498                                 sidebar_links);
499
500         g_signal_handler_unblock (selection, sidebar_links->priv->selection_id);
501         g_signal_handler_unblock (sidebar_links->priv->tree_view, sidebar_links->priv->row_activated_id);
502 }
503
504 static void 
505 row_activated_callback                  (GtkTreeView *treeview,
506                                          GtkTreePath *arg1,
507                                          GtkTreeViewColumn *arg2,
508                                          gpointer user_data)
509 {       
510         if (gtk_tree_view_row_expanded (GTK_TREE_VIEW (treeview), arg1)) {
511                     gtk_tree_view_collapse_row (GTK_TREE_VIEW (treeview), arg1);
512         } else {
513                     gtk_tree_view_expand_row (GTK_TREE_VIEW (treeview), arg1, FALSE);
514         }
515         
516         return;
517 }
518                                 
519 static void
520 job_finished_callback (EvJobLinks     *job,
521                        EvSidebarLinks *sidebar_links)
522 {
523         EvSidebarLinksPrivate *priv;
524         GtkTreeSelection *selection;
525         GtkTreeIter iter;
526         GtkTreePath *path;
527         gboolean result;
528
529         priv = sidebar_links->priv;
530
531         priv->model = g_object_ref (job->model);
532         g_object_notify (G_OBJECT (sidebar_links), "model");
533
534         gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), job->model);
535         g_object_unref (job);
536         priv->job = NULL;
537
538         /* Expand one level of the tree */
539         path = gtk_tree_path_new_first ();
540         for (result = gtk_tree_model_get_iter_first (priv->model, &iter);
541              result;
542              result = gtk_tree_model_iter_next (priv->model, &iter)) {
543                 gtk_tree_view_expand_row (GTK_TREE_VIEW (priv->tree_view), path, FALSE);
544                 gtk_tree_path_next (path);
545         }
546         gtk_tree_path_free (path);
547         
548         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
549         gtk_tree_selection_set_mode (selection, GTK_SELECTION_SINGLE);
550         priv->selection_id = g_signal_connect (selection, "changed",
551                                                G_CALLBACK (selection_changed_callback),
552                                                sidebar_links);
553         priv->page_changed_id = g_signal_connect (priv->page_cache, "page-changed",
554                                                   G_CALLBACK (update_page_callback),
555                                                   sidebar_links);
556         priv->row_activated_id = g_signal_connect (G_OBJECT (priv->tree_view), "row-activated",
557                                                     G_CALLBACK (row_activated_callback), sidebar_links);
558         update_page_callback (priv->page_cache,
559                               ev_page_cache_get_current_page (priv->page_cache),
560                               sidebar_links);
561
562 }
563
564 static void
565 ev_sidebar_links_set_document (EvSidebarPage  *sidebar_page,
566                                EvDocument     *document)
567 {
568         EvSidebarLinks *sidebar_links;
569         EvSidebarLinksPrivate *priv;
570
571         g_return_if_fail (EV_IS_SIDEBAR_PAGE (sidebar_page));
572         g_return_if_fail (EV_IS_DOCUMENT (document));
573         
574         sidebar_links = EV_SIDEBAR_LINKS (sidebar_page);
575
576         priv = sidebar_links->priv;
577
578         if (priv->document) {
579                 gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), NULL);
580                 g_object_unref (priv->document);
581         }
582
583         priv->document = g_object_ref (document);
584         priv->page_cache = ev_page_cache_get (document);
585
586         if (priv->job) {
587                 g_signal_handlers_disconnect_by_func (priv->job,
588                                                       job_finished_callback,
589                                                       sidebar_links);
590                 g_object_unref (priv->job);
591         }
592
593         priv->job = ev_job_links_new (document);
594         g_signal_connect (priv->job,
595                           "finished",
596                           G_CALLBACK (job_finished_callback),
597                           sidebar_links);
598         /* The priority doesn't matter for this job */
599         ev_job_queue_add_job (priv->job, EV_JOB_PRIORITY_LOW);
600 }
601
602 static gboolean
603 ev_sidebar_links_support_document (EvSidebarPage  *sidebar_page,
604                                    EvDocument *document)
605 {
606         return (EV_IS_DOCUMENT_LINKS (document) &&
607                     ev_document_links_has_document_links (EV_DOCUMENT_LINKS (document)));
608 }
609
610 static const gchar*
611 ev_sidebar_links_get_label (EvSidebarPage *sidebar_page)
612 {
613     return _("Index");
614 }
615
616 GtkWidget *
617 ev_sidebar_links_get_treeview (EvSidebarLinks *sidebar)
618 {
619         return sidebar->priv->tree_view;
620 }
621
622 static void
623 ev_sidebar_links_page_iface_init (EvSidebarPageIface *iface)
624 {
625         iface->support_document = ev_sidebar_links_support_document;
626         iface->set_document = ev_sidebar_links_set_document;
627         iface->get_label = ev_sidebar_links_get_label;
628 }
629