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-links.h"
  32 #include "ev-job-queue.h"
  33 #include "ev-document-links.h"
  34 #include "ev-window.h"
  35
  36 struct _EvSidebarLinksPrivate {
  37         GtkWidget *tree_view;
  38
  39         /* Keep these ids around for blocking */
  40         guint selection_id;
  41         guint page_changed_id;
  42
  43         EvJob *job;
  44         GtkTreeModel *model;
  45         EvDocument *document;
  46         EvPageCache *page_cache;
  47 };
  48
  49
  50 static void links_page_num_func  (GtkTreeViewColumn *tree_column,
  51                                   GtkCellRenderer   *cell,
  52                                   GtkTreeModel      *tree_model,
  53                                   GtkTreeIter       *iter,
  54                                   EvSidebarLinks    *sidebar_links);
  55 static void update_page_callback (EvPageCache       *page_cache,
  56                                   gint               current_page,
  57                                   EvSidebarLinks    *sidebar_links);
  58
  59
  60 G_DEFINE_TYPE (EvSidebarLinks, ev_sidebar_links, GTK_TYPE_VBOX)
  61
  62 #define EV_SIDEBAR_LINKS_GET_PRIVATE(object) \
  63         (G_TYPE_INSTANCE_GET_PRIVATE ((object), EV_TYPE_SIDEBAR_LINKS, EvSidebarLinksPrivate))
  64
  65
  66 static void
  67 ev_sidebar_links_destroy (GtkObject *object)
  68 {
  69         EvSidebarLinks *ev_sidebar_links = (EvSidebarLinks *) object;
  70
  71         ev_sidebar_links_clear_document (ev_sidebar_links);
  72 }
  73
  74 static void
  75 ev_sidebar_links_class_init (EvSidebarLinksClass *ev_sidebar_links_class)
  76 {
  77         GObjectClass *g_object_class;
  78         GtkObjectClass *gtk_object_class;
  79
  80         g_object_class = G_OBJECT_CLASS (ev_sidebar_links_class);
  81         gtk_object_class = GTK_OBJECT_CLASS (ev_sidebar_links_class);
  82
  83         gtk_object_class->destroy = ev_sidebar_links_destroy;
  84
  85         g_type_class_add_private (g_object_class, sizeof (EvSidebarLinksPrivate));
  86 }
  87
  88 static void
  89 selection_changed_cb (GtkTreeSelection   *selection,
  90                       EvSidebarLinks     *ev_sidebar_links)
  91 {
  92         EvDocument *document;
  93         GtkTreeModel *model;
  94         GtkTreeIter iter;
  95
  96         g_return_if_fail (EV_IS_SIDEBAR_LINKS (ev_sidebar_links));
  97
  98         document = EV_DOCUMENT (ev_sidebar_links->priv->document);
  99         g_return_if_fail (ev_sidebar_links->priv->document != NULL);
 100
 101         if (gtk_tree_selection_get_selected (selection, &model, &iter)) {
 102                 EvLink *link;
 103
 104                 gtk_tree_model_get (model, &iter,
 105                                     EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
 106                                     -1);
 107
 108                 if (link == NULL)
 109                         return;
 110
 111                 g_signal_handler_block (ev_sidebar_links->priv->page_cache,
 112                                         ev_sidebar_links->priv->page_changed_id);
 113                 ev_page_cache_set_link (ev_sidebar_links->priv->page_cache, link);
 114                 g_signal_handler_unblock (ev_sidebar_links->priv->page_cache,
 115                                           ev_sidebar_links->priv->page_changed_id);
 116         }
 117 }
 118
 119 static GtkTreeModel *
 120 create_loading_model (void)
 121 {
 122         GtkTreeModel *retval;
 123         GtkTreeIter iter;
 124         gchar *markup;
 125
 126         /* Creates a fake model to indicate that we're loading */
 127         retval = (GtkTreeModel *)gtk_list_store_new (EV_DOCUMENT_LINKS_COLUMN_NUM_COLUMNS,
 128                                                      G_TYPE_STRING,
 129                                                      G_TYPE_OBJECT);
 130
 131         gtk_list_store_append (GTK_LIST_STORE (retval), &iter);
 132         markup = g_strdup_printf ("<span size=\"larger\" style=\"italic\">%s</span>", _("Loading..."));
 133         gtk_list_store_set (GTK_LIST_STORE (retval), &iter,
 134                             EV_DOCUMENT_LINKS_COLUMN_MARKUP, markup,
 135                             EV_DOCUMENT_LINKS_COLUMN_LINK, NULL,
 136                             -1);
 137         g_free (markup);
 138
 139         return retval;
 140 }
 141
 142 static void
 143 ev_sidebar_links_construct (EvSidebarLinks *ev_sidebar_links)
 144 {
 145         EvSidebarLinksPrivate *priv;
 146         GtkWidget *swindow;
 147         GtkTreeViewColumn *column;
 148         GtkCellRenderer *renderer;
 149         GtkTreeSelection *selection;
 150         GtkTreeModel *loading_model;
 151
 152         priv = ev_sidebar_links->priv;
 153
 154         swindow = gtk_scrolled_window_new (NULL, NULL);
 155
 156         gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (swindow),
 157                                         GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 158         gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (swindow),
 159                                              GTK_SHADOW_IN);
 160
 161         /* Create tree view */
 162         loading_model = create_loading_model ();
 163         priv->tree_view = gtk_tree_view_new_with_model (loading_model);
 164         g_object_unref (loading_model);
 165
 166         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
 167         gtk_tree_selection_set_mode (selection, GTK_SELECTION_NONE);
 168         gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->tree_view), FALSE);
 169         gtk_container_add (GTK_CONTAINER (swindow), priv->tree_view);
 170
 171         gtk_box_pack_start (GTK_BOX (ev_sidebar_links), swindow, TRUE, TRUE, 0);
 172         gtk_widget_show_all (GTK_WIDGET (ev_sidebar_links));
 173
 174         column = gtk_tree_view_column_new ();
 175         gtk_tree_view_column_set_expand (GTK_TREE_VIEW_COLUMN (column), TRUE);
 176         gtk_tree_view_append_column (GTK_TREE_VIEW (priv->tree_view), column);
 177
 178         renderer = (GtkCellRenderer*)
 179                 g_object_new (GTK_TYPE_CELL_RENDERER_TEXT,
 180                               "ellipsize", PANGO_ELLIPSIZE_END,
 181                               NULL);
 182         gtk_tree_view_column_pack_start (GTK_TREE_VIEW_COLUMN (column), renderer, TRUE);
 183         gtk_tree_view_column_set_attributes (GTK_TREE_VIEW_COLUMN (column), renderer,
 184                                              "markup", EV_DOCUMENT_LINKS_COLUMN_MARKUP,
 185                                              NULL);
 186
 187
 188         renderer = gtk_cell_renderer_text_new ();
 189         gtk_tree_view_column_pack_end (GTK_TREE_VIEW_COLUMN (column), renderer, FALSE);
 190         gtk_tree_view_column_set_cell_data_func (GTK_TREE_VIEW_COLUMN (column), renderer,
 191                                                  (GtkTreeCellDataFunc) links_page_num_func,
 192                                                  ev_sidebar_links, NULL);
 193
 194
 195 }
 196
 197 static void
 198 ev_sidebar_links_init (EvSidebarLinks *ev_sidebar_links)
 199 {
 200         ev_sidebar_links->priv = EV_SIDEBAR_LINKS_GET_PRIVATE (ev_sidebar_links);
 201
 202         ev_sidebar_links_construct (ev_sidebar_links);
 203 }
 204
 205 static void
 206 links_page_num_func (GtkTreeViewColumn *tree_column,
 207                      GtkCellRenderer   *cell,
 208                      GtkTreeModel      *tree_model,
 209                      GtkTreeIter       *iter,
 210                      EvSidebarLinks    *sidebar_links)
 211 {
 212         EvLink *link;
 213
 214         gtk_tree_model_get (tree_model, iter,
 215                             EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
 216                             -1);
 217
 218         if (link != NULL &&
 219             ev_link_get_link_type (link) == EV_LINK_TYPE_PAGE) {
 220                 gchar *page_label;
 221                 gchar *page_string;
 222
 223                 page_label = ev_page_cache_get_page_label (sidebar_links->priv->page_cache, ev_link_get_page (link));
 224                 page_string = g_markup_printf_escaped ("<i>%s</i>", page_label);
 225
 226                 g_object_set (cell,
 227                               "markup", page_string,
 228                               "visible", TRUE,
 229                               NULL);
 230
 231                 g_free (page_label);
 232                 g_free (page_string);
 233         } else {
 234                 g_object_set (cell,
 235                               "visible", FALSE,
 236                               NULL);
 237         }
 238 }
 239
 240 /* Public Functions */
 241
 242 GtkWidget *
 243 ev_sidebar_links_new (void)
 244 {
 245         GtkWidget *ev_sidebar_links;
 246
 247         ev_sidebar_links = g_object_new (EV_TYPE_SIDEBAR_LINKS, NULL);
 248
 249         return ev_sidebar_links;
 250 }
 251
 252 void
 253 ev_sidebar_links_clear_document (EvSidebarLinks *sidebar_links)
 254 {
 255         EvSidebarLinksPrivate *priv;
 256
 257         g_return_if_fail (EV_IS_SIDEBAR_LINKS (sidebar_links));
 258
 259         priv = sidebar_links->priv;
 260
 261         if (priv->document) {
 262                 g_object_unref (priv->document);
 263                 priv->document = NULL;
 264                 priv->page_cache = NULL;
 265         }
 266
 267         gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), NULL);
 268 }
 269
 270 static gboolean
 271 update_page_callback_foreach (GtkTreeModel *model,
 272                               GtkTreePath  *path,
 273                               GtkTreeIter  *iter,
 274                               gpointer      data)
 275 {
 276         EvSidebarLinks *sidebar_links = (data);
 277         EvLink *link;
 278
 279         gtk_tree_model_get (model, iter,
 280                             EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
 281                             -1);
 282
 283         if (link && ev_link_get_link_type (link) == EV_LINK_TYPE_PAGE) {
 284                 int current_page;
 285
 286                 current_page = ev_page_cache_get_current_page (sidebar_links->priv->page_cache);
 287                 if (ev_link_get_page (link) == current_page) {
 288                         GtkTreeSelection *selection;
 289
 290                         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (sidebar_links->priv->tree_view));
 291
 292                         gtk_tree_selection_select_path (selection, path);
 293
 294                         return TRUE;
 295                 }
 296         }
 297
 298         return FALSE;
 299 }
 300
 301 static void
 302 update_page_callback (EvPageCache    *page_cache,
 303                       gint            current_page,
 304                       EvSidebarLinks *sidebar_links)
 305 {
 306         GtkTreeSelection *selection;
 307         /* We go through the tree linearly looking for the first page that
 308          * matches.  This is pretty inefficient.  We can do something neat with
 309          * a GtkTreeModelSort here to make it faster, if it turns out to be
 310          * slow.
 311          */
 312
 313         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (sidebar_links->priv->tree_view));
 314
 315         g_signal_handler_block (selection, sidebar_links->priv->selection_id);
 316
 317         gtk_tree_selection_unselect_all (selection);
 318         gtk_tree_model_foreach (sidebar_links->priv->model,
 319                                 update_page_callback_foreach,
 320                                 sidebar_links);
 321
 322         g_signal_handler_unblock (selection, sidebar_links->priv->selection_id);
 323 }
 324
 325 static void
 326 job_finished_cb (EvJobLinks     *job,
 327                  EvSidebarLinks *sidebar_links)
 328 {
 329         EvSidebarLinksPrivate *priv;
 330         GtkTreeSelection *selection;
 331         GtkTreeIter iter;
 332         GtkTreePath *path;
 333         gboolean result;
 334
 335         priv = sidebar_links->priv;
 336
 337         priv->model = g_object_ref (job->model);
 338         gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), job->model);
 339         g_object_unref (job);
 340
 341         /* Expand one level of the tree */
 342         path = gtk_tree_path_new_first ();
 343         for (result = gtk_tree_model_get_iter_first (priv->model, &iter);
 344              result;
 345              result = gtk_tree_model_iter_next (priv->model, &iter)) {
 346                 gtk_tree_view_expand_row (GTK_TREE_VIEW (priv->tree_view), path, FALSE);
 347                 gtk_tree_path_next (path);
 348         }
 349         gtk_tree_path_free (path);
 350
 351         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
 352         gtk_tree_selection_set_mode (selection, GTK_SELECTION_SINGLE);
 353         priv->selection_id = g_signal_connect (selection, "changed",
 354                                                G_CALLBACK (selection_changed_cb),
 355                                                sidebar_links);
 356         priv->page_changed_id = g_signal_connect (priv->page_cache, "page-changed",
 357                                                   G_CALLBACK (update_page_callback),
 358                                                   sidebar_links);
 359         update_page_callback (priv->page_cache,
 360                               ev_page_cache_get_current_page (priv->page_cache),
 361                               sidebar_links);
 362
 363 }
 364
 365 void
 366 ev_sidebar_links_set_document (EvSidebarLinks *sidebar_links,
 367                                EvDocument     *document)
 368 {
 369         EvSidebarLinksPrivate *priv;
 370
 371         g_return_if_fail (EV_IS_SIDEBAR_LINKS (sidebar_links));
 372         g_return_if_fail (EV_IS_DOCUMENT (document));
 373
 374         priv = sidebar_links->priv;
 375
 376         g_object_ref (document);
 377
 378         priv->document = document;
 379         priv->page_cache = ev_document_get_page_cache (document);
 380
 381         priv->job = ev_job_links_new (document);
 382         g_signal_connect (priv->job,
 383                           "finished",
 384                           G_CALLBACK (job_finished_cb),
 385                           sidebar_links);
 386         /* The priority doesn't matter for this job */
 387         ev_job_queue_add_job (priv->job, EV_JOB_PRIORITY_LOW);
 388
 389 }
 390