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