]> www.fi.muni.cz Git - evince.git/blob - shell/ev-sidebar-links.c
Select first item
[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         GtkMenu *menu = build_popup_menu (sidebar);
284
285         gtk_menu_popup (menu, NULL, NULL,
286                         ev_gui_menu_position_tree_selection,
287                         sidebar->priv->tree_view, 0,
288                         gtk_get_current_event_time ());
289         gtk_menu_shell_select_first (GTK_MENU_SHELL (menu), FALSE);
290 }
291
292 static gboolean
293 button_press_cb (GtkWidget *treeview,
294                  GdkEventButton *event,
295                  EvSidebarLinks *sidebar)
296 {
297         GtkTreePath *path = NULL;
298
299         if (event->button == 3) {
300                 if (gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (treeview),
301                                                    event->x,
302                                                    event->y,
303                                                    &path,
304                                                    NULL, NULL, NULL)) {
305                         gtk_tree_view_set_cursor (GTK_TREE_VIEW (treeview),
306                                                   path, NULL, FALSE);
307                         gtk_menu_popup (build_popup_menu (sidebar), NULL,
308                                         NULL, NULL, NULL, event->button,
309                                         gtk_get_current_event_time ());
310                         gtk_tree_path_free (path);
311
312                         return TRUE;
313                 }
314         }
315
316         return FALSE;
317 }
318
319
320 static void
321 ev_sidebar_links_construct (EvSidebarLinks *ev_sidebar_links)
322 {
323         EvSidebarLinksPrivate *priv;
324         GtkWidget *swindow;
325         GtkTreeViewColumn *column;
326         GtkCellRenderer *renderer;
327         GtkTreeSelection *selection;
328         GtkTreeModel *loading_model;
329
330         priv = ev_sidebar_links->priv;
331
332         swindow = gtk_scrolled_window_new (NULL, NULL);
333
334         gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (swindow),
335                                         GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
336         gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (swindow),
337                                              GTK_SHADOW_IN);
338
339         /* Create tree view */
340         loading_model = create_loading_model ();
341         priv->tree_view = gtk_tree_view_new_with_model (loading_model);
342         g_object_unref (loading_model);
343
344         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
345         gtk_tree_selection_set_mode (selection, GTK_SELECTION_NONE);
346         gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->tree_view), FALSE);
347         gtk_container_add (GTK_CONTAINER (swindow), priv->tree_view);
348
349         gtk_box_pack_start (GTK_BOX (ev_sidebar_links), swindow, TRUE, TRUE, 0);
350         gtk_widget_show_all (GTK_WIDGET (ev_sidebar_links));
351
352         column = gtk_tree_view_column_new ();
353         gtk_tree_view_column_set_expand (GTK_TREE_VIEW_COLUMN (column), TRUE);
354         gtk_tree_view_append_column (GTK_TREE_VIEW (priv->tree_view), column);
355
356         renderer = (GtkCellRenderer*)
357                 g_object_new (GTK_TYPE_CELL_RENDERER_TEXT,
358                               "ellipsize", PANGO_ELLIPSIZE_END,
359                               NULL);
360         gtk_tree_view_column_pack_start (GTK_TREE_VIEW_COLUMN (column), renderer, TRUE);
361         gtk_tree_view_column_set_attributes (GTK_TREE_VIEW_COLUMN (column), renderer,
362                                              "markup", EV_DOCUMENT_LINKS_COLUMN_MARKUP,
363                                              NULL);
364
365         
366         renderer = gtk_cell_renderer_text_new ();
367         gtk_tree_view_column_pack_end (GTK_TREE_VIEW_COLUMN (column), renderer, FALSE);
368         gtk_tree_view_column_set_cell_data_func (GTK_TREE_VIEW_COLUMN (column), renderer,
369                                                  (GtkTreeCellDataFunc) links_page_num_func,
370                                                  ev_sidebar_links, NULL);
371
372         g_signal_connect (GTK_TREE_VIEW (priv->tree_view),
373                           "button_press_event",
374                           G_CALLBACK (button_press_cb),
375                           ev_sidebar_links);
376         g_signal_connect (GTK_TREE_VIEW (priv->tree_view),
377                           "popup_menu",
378                           G_CALLBACK (popup_menu_cb),
379                           ev_sidebar_links);
380 }
381
382 static void
383 ev_sidebar_links_init (EvSidebarLinks *ev_sidebar_links)
384 {
385         ev_sidebar_links->priv = EV_SIDEBAR_LINKS_GET_PRIVATE (ev_sidebar_links);
386
387         ev_sidebar_links_construct (ev_sidebar_links);
388 }
389
390 static void
391 links_page_num_func (GtkTreeViewColumn *tree_column,
392                      GtkCellRenderer   *cell,
393                      GtkTreeModel      *tree_model,
394                      GtkTreeIter       *iter,
395                      EvSidebarLinks    *sidebar_links)
396 {
397         EvLink *link;
398
399         gtk_tree_model_get (tree_model, iter,
400                             EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
401                             -1);
402         
403         if (link != NULL &&
404             ev_link_get_link_type (link) == EV_LINK_TYPE_PAGE) {
405                 gchar *page_label;
406                 gchar *page_string;
407
408                 page_label = ev_page_cache_get_page_label (sidebar_links->priv->page_cache, ev_link_get_page (link));
409                 page_string = g_markup_printf_escaped ("<i>%s</i>", page_label);
410
411                 g_object_set (cell,
412                               "markup", page_string,
413                               "visible", TRUE,
414                               NULL);
415
416                 g_free (page_label);
417                 g_free (page_string);
418         } else {
419                 g_object_set (cell,
420                               "visible", FALSE,
421                               NULL);
422         }
423 }
424
425 /* Public Functions */
426
427 GtkWidget *
428 ev_sidebar_links_new (void)
429 {
430         GtkWidget *ev_sidebar_links;
431
432         ev_sidebar_links = g_object_new (EV_TYPE_SIDEBAR_LINKS, NULL);
433
434         return ev_sidebar_links;
435 }
436
437 static void
438 ev_sidebar_links_clear_document (EvSidebarLinks *sidebar_links)
439 {
440         EvSidebarLinksPrivate *priv;
441
442         g_return_if_fail (EV_IS_SIDEBAR_LINKS (sidebar_links));
443
444         priv = sidebar_links->priv;
445
446         if (priv->document) {
447                 g_object_unref (priv->document);
448                 priv->document = NULL;
449                 priv->page_cache = NULL;
450         }
451
452         gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), NULL);
453 }
454
455 static gboolean
456 update_page_callback_foreach (GtkTreeModel *model,
457                               GtkTreePath  *path,
458                               GtkTreeIter  *iter,
459                               gpointer      data)
460 {
461         EvSidebarLinks *sidebar_links = (data);
462         EvLink *link;
463
464         gtk_tree_model_get (model, iter,
465                             EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
466                             -1);
467
468         if (link && ev_link_get_link_type (link) == EV_LINK_TYPE_PAGE) {
469                 int current_page;
470
471                 current_page = ev_page_cache_get_current_page (sidebar_links->priv->page_cache);
472                 if (ev_link_get_page (link) == current_page) {
473                         GtkTreeSelection *selection;
474
475                         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (sidebar_links->priv->tree_view));
476
477                         gtk_tree_selection_select_path (selection, path);
478
479                         return TRUE;
480                 }
481         }
482         
483         return FALSE;
484 }
485
486 static void
487 update_page_callback (EvPageCache    *page_cache,
488                       gint            current_page,
489                       EvSidebarLinks *sidebar_links)
490 {
491         GtkTreeSelection *selection;
492         /* We go through the tree linearly looking for the first page that
493          * matches.  This is pretty inefficient.  We can do something neat with
494          * a GtkTreeModelSort here to make it faster, if it turns out to be
495          * slow.
496          */
497
498         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (sidebar_links->priv->tree_view));
499
500         g_signal_handler_block (selection, sidebar_links->priv->selection_id);
501         g_signal_handler_block (sidebar_links->priv->tree_view, sidebar_links->priv->row_activated_id);
502
503         gtk_tree_selection_unselect_all (selection);
504         gtk_tree_model_foreach (sidebar_links->priv->model,
505                                 update_page_callback_foreach,
506                                 sidebar_links);
507
508         g_signal_handler_unblock (selection, sidebar_links->priv->selection_id);
509         g_signal_handler_unblock (sidebar_links->priv->tree_view, sidebar_links->priv->row_activated_id);
510 }
511
512 static void 
513 row_activated_callback                  (GtkTreeView *treeview,
514                                          GtkTreePath *arg1,
515                                          GtkTreeViewColumn *arg2,
516                                          gpointer user_data)
517 {       
518         if (gtk_tree_view_row_expanded (GTK_TREE_VIEW (treeview), arg1)) {
519                     gtk_tree_view_collapse_row (GTK_TREE_VIEW (treeview), arg1);
520         } else {
521                     gtk_tree_view_expand_row (GTK_TREE_VIEW (treeview), arg1, FALSE);
522         }
523         
524         return;
525 }
526                                 
527 static void
528 job_finished_callback (EvJobLinks     *job,
529                        EvSidebarLinks *sidebar_links)
530 {
531         EvSidebarLinksPrivate *priv;
532         GtkTreeSelection *selection;
533         GtkTreeIter iter;
534         GtkTreePath *path;
535         gboolean result;
536
537         priv = sidebar_links->priv;
538
539         priv->model = g_object_ref (job->model);
540         g_object_notify (G_OBJECT (sidebar_links), "model");
541
542         gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), job->model);
543         g_object_unref (job);
544
545         /* Expand one level of the tree */
546         path = gtk_tree_path_new_first ();
547         for (result = gtk_tree_model_get_iter_first (priv->model, &iter);
548              result;
549              result = gtk_tree_model_iter_next (priv->model, &iter)) {
550                 gtk_tree_view_expand_row (GTK_TREE_VIEW (priv->tree_view), path, FALSE);
551                 gtk_tree_path_next (path);
552         }
553         gtk_tree_path_free (path);
554         
555         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
556         gtk_tree_selection_set_mode (selection, GTK_SELECTION_SINGLE);
557         priv->selection_id = g_signal_connect (selection, "changed",
558                                                G_CALLBACK (selection_changed_callback),
559                                                sidebar_links);
560         priv->page_changed_id = g_signal_connect (priv->page_cache, "page-changed",
561                                                   G_CALLBACK (update_page_callback),
562                                                   sidebar_links);
563         priv->row_activated_id = g_signal_connect (G_OBJECT (priv->tree_view), "row-activated",
564                                                     G_CALLBACK (row_activated_callback), sidebar_links);
565         update_page_callback (priv->page_cache,
566                               ev_page_cache_get_current_page (priv->page_cache),
567                               sidebar_links);
568
569 }
570
571 static void
572 ev_sidebar_links_set_document (EvSidebarPage  *sidebar_page,
573                                EvDocument     *document)
574 {
575         EvSidebarLinks *sidebar_links;
576         EvSidebarLinksPrivate *priv;
577
578         g_return_if_fail (EV_IS_SIDEBAR_PAGE (sidebar_page));
579         g_return_if_fail (EV_IS_DOCUMENT (document));
580         
581         sidebar_links = EV_SIDEBAR_LINKS (sidebar_page);
582
583         priv = sidebar_links->priv;
584
585         g_object_ref (document);
586
587         priv->document = document;
588         priv->page_cache = ev_document_get_page_cache (document);
589
590         priv->job = ev_job_links_new (document);
591         g_signal_connect (priv->job,
592                           "finished",
593                           G_CALLBACK (job_finished_callback),
594                           sidebar_links);
595         /* The priority doesn't matter for this job */
596         ev_job_queue_add_job (priv->job, EV_JOB_PRIORITY_LOW);
597
598 }
599
600 static gboolean
601 ev_sidebar_links_support_document (EvSidebarPage  *sidebar_page,
602                                    EvDocument *document)
603 {
604         return (EV_IS_DOCUMENT_LINKS (document) &&
605                     ev_document_links_has_document_links (EV_DOCUMENT_LINKS (document)));
606 }
607
608 static const gchar*
609 ev_sidebar_links_get_label (EvSidebarPage *sidebar_page)
610 {
611     return _("Index");
612 }
613
614 GtkWidget *
615 ev_sidebar_links_get_treeview (EvSidebarLinks *sidebar)
616 {
617         return sidebar->priv->tree_view;
618 }
619
620 static void
621 ev_sidebar_links_page_iface_init (EvSidebarPageIface *iface)
622 {
623         iface->support_document = ev_sidebar_links_support_document;
624         iface->set_document = ev_sidebar_links_set_document;
625         iface->get_label = ev_sidebar_links_get_label;
626 }
627