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
  37 struct _EvSidebarLinksPrivate {
  38         GtkWidget *tree_view;
  39
  40         /* Keep these ids around for blocking */
  41         guint selection_id;
  42         guint page_changed_id;
  43
  44         EvJob *job;
  45         GtkTreeModel *model;
  46         EvDocument *document;
  47         EvPageCache *page_cache;
  48 };
  49
  50 enum {
  51         PROP_0,
  52         PROP_MODEL,
  53 };
  54
  55
  56 static void links_page_num_func                         (GtkTreeViewColumn *tree_column,
  57                                                          GtkCellRenderer   *cell,
  58                                                          GtkTreeModel      *tree_model,
  59                                                          GtkTreeIter       *iter,
  60                                                          EvSidebarLinks    *sidebar_links);
  61 static void update_page_callback                        (EvPageCache       *page_cache,
  62                                                          gint               current_page,
  63                                                          EvSidebarLinks    *sidebar_links);
  64 static void ev_sidebar_links_page_iface_init            (EvSidebarPageIface *iface);
  65 static void ev_sidebar_links_clear_document             (EvSidebarLinks *sidebar_links);
  66 static void ev_sidebar_links_set_document               (EvSidebarPage  *sidebar_page,
  67                                                          EvDocument     *document);
  68 static gboolean ev_sidebar_links_support_document       (EvSidebarPage  *sidebar_page,
  69                                                          EvDocument     *document);
  70 static const gchar* ev_sidebar_links_get_label          (EvSidebarPage *sidebar_page);
  71
  72
  73 G_DEFINE_TYPE_EXTENDED (EvSidebarLinks,
  74                         ev_sidebar_links,
  75                         GTK_TYPE_VBOX,
  76                         0,
  77                         G_IMPLEMENT_INTERFACE (EV_TYPE_SIDEBAR_PAGE,
  78                                                ev_sidebar_links_page_iface_init))
  79
  80
  81 #define EV_SIDEBAR_LINKS_GET_PRIVATE(object) \
  82         (G_TYPE_INSTANCE_GET_PRIVATE ((object), EV_TYPE_SIDEBAR_LINKS, EvSidebarLinksPrivate))
  83
  84
  85 static void
  86 ev_sidebar_links_destroy (GtkObject *object)
  87 {
  88         EvSidebarLinks *ev_sidebar_links = (EvSidebarLinks *) object;
  89
  90         ev_sidebar_links_clear_document (ev_sidebar_links);
  91 }
  92
  93 static void
  94 ev_sidebar_links_set_property (GObject      *object,
  95                                guint         prop_id,
  96                                const GValue *value,
  97                                GParamSpec   *pspec)
  98 {
  99         EvSidebarLinks *ev_sidebar_links;
 100         GtkTreeModel *model;
 101
 102         ev_sidebar_links = EV_SIDEBAR_LINKS (object);
 103
 104         switch (prop_id)
 105         {
 106         case PROP_MODEL:
 107                 model = ev_sidebar_links->priv->model;
 108                 ev_sidebar_links->priv->model = GTK_TREE_MODEL (g_value_dup_object (value));
 109                 if (model)
 110                         g_object_unref (model);
 111                 break;
 112         default:
 113                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 114                 break;
 115         }
 116 }
 117
 118 static void
 119 ev_sidebar_links_get_property (GObject    *object,
 120                                guint       prop_id,
 121                                GValue     *value,
 122                                GParamSpec *pspec)
 123 {
 124         EvSidebarLinks *ev_sidebar_links;
 125
 126         ev_sidebar_links = EV_SIDEBAR_LINKS (object);
 127
 128         switch (prop_id)
 129         {
 130         case PROP_MODEL:
 131                 g_value_set_object (value, ev_sidebar_links->priv->model);
 132                 break;
 133         default:
 134                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 135                 break;
 136         }
 137 }
 138
 139
 140 static void
 141 ev_sidebar_links_class_init (EvSidebarLinksClass *ev_sidebar_links_class)
 142 {
 143         GObjectClass *g_object_class;
 144         GtkObjectClass *gtk_object_class;
 145
 146         g_object_class = G_OBJECT_CLASS (ev_sidebar_links_class);
 147         gtk_object_class = GTK_OBJECT_CLASS (ev_sidebar_links_class);
 148
 149         g_object_class->set_property = ev_sidebar_links_set_property;
 150         g_object_class->get_property = ev_sidebar_links_get_property;
 151
 152         gtk_object_class->destroy = ev_sidebar_links_destroy;
 153
 154         g_object_class_install_property (g_object_class,
 155                                          PROP_MODEL,
 156                                          g_param_spec_object ("model",
 157                                                               "Model",
 158                                                               "Current Model",
 159                                                               GTK_TYPE_TREE_MODEL,
 160                                                               G_PARAM_READWRITE));
 161
 162         g_type_class_add_private (g_object_class, sizeof (EvSidebarLinksPrivate));
 163 }
 164
 165 static void
 166 selection_changed_cb (GtkTreeSelection   *selection,
 167                       EvSidebarLinks     *ev_sidebar_links)
 168 {
 169         EvDocument *document;
 170         GtkTreeModel *model;
 171         GtkTreeIter iter;
 172
 173         g_return_if_fail (EV_IS_SIDEBAR_LINKS (ev_sidebar_links));
 174
 175         document = EV_DOCUMENT (ev_sidebar_links->priv->document);
 176         g_return_if_fail (ev_sidebar_links->priv->document != NULL);
 177
 178         if (gtk_tree_selection_get_selected (selection, &model, &iter)) {
 179                 EvLink *link;
 180
 181                 gtk_tree_model_get (model, &iter,
 182                                     EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
 183                                     -1);
 184
 185                 if (link == NULL)
 186                         return;
 187
 188                 g_signal_handler_block (ev_sidebar_links->priv->page_cache,
 189                                         ev_sidebar_links->priv->page_changed_id);
 190                 /* FIXME: we should handle this better.  This breaks w/ URLs */
 191                 ev_page_cache_set_link (ev_sidebar_links->priv->page_cache, link);
 192                 g_signal_handler_unblock (ev_sidebar_links->priv->page_cache,
 193                                           ev_sidebar_links->priv->page_changed_id);
 194         }
 195 }
 196
 197 static GtkTreeModel *
 198 create_loading_model (void)
 199 {
 200         GtkTreeModel *retval;
 201         GtkTreeIter iter;
 202         gchar *markup;
 203
 204         /* Creates a fake model to indicate that we're loading */
 205         retval = (GtkTreeModel *)gtk_list_store_new (EV_DOCUMENT_LINKS_COLUMN_NUM_COLUMNS,
 206                                                      G_TYPE_STRING,
 207                                                      G_TYPE_OBJECT);
 208
 209         gtk_list_store_append (GTK_LIST_STORE (retval), &iter);
 210         markup = g_strdup_printf ("<span size=\"larger\" style=\"italic\">%s</span>", _("Loading..."));
 211         gtk_list_store_set (GTK_LIST_STORE (retval), &iter,
 212                             EV_DOCUMENT_LINKS_COLUMN_MARKUP, markup,
 213                             EV_DOCUMENT_LINKS_COLUMN_LINK, NULL,
 214                             -1);
 215         g_free (markup);
 216
 217         return retval;
 218 }
 219
 220 static void
 221 ev_sidebar_links_construct (EvSidebarLinks *ev_sidebar_links)
 222 {
 223         EvSidebarLinksPrivate *priv;
 224         GtkWidget *swindow;
 225         GtkTreeViewColumn *column;
 226         GtkCellRenderer *renderer;
 227         GtkTreeSelection *selection;
 228         GtkTreeModel *loading_model;
 229
 230         priv = ev_sidebar_links->priv;
 231
 232         swindow = gtk_scrolled_window_new (NULL, NULL);
 233
 234         gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (swindow),
 235                                         GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 236         gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (swindow),
 237                                              GTK_SHADOW_IN);
 238
 239         /* Create tree view */
 240         loading_model = create_loading_model ();
 241         priv->tree_view = gtk_tree_view_new_with_model (loading_model);
 242         g_object_unref (loading_model);
 243
 244         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
 245         gtk_tree_selection_set_mode (selection, GTK_SELECTION_NONE);
 246         gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->tree_view), FALSE);
 247         gtk_container_add (GTK_CONTAINER (swindow), priv->tree_view);
 248
 249         gtk_box_pack_start (GTK_BOX (ev_sidebar_links), swindow, TRUE, TRUE, 0);
 250         gtk_widget_show_all (GTK_WIDGET (ev_sidebar_links));
 251
 252         column = gtk_tree_view_column_new ();
 253         gtk_tree_view_column_set_expand (GTK_TREE_VIEW_COLUMN (column), TRUE);
 254         gtk_tree_view_append_column (GTK_TREE_VIEW (priv->tree_view), column);
 255
 256         renderer = (GtkCellRenderer*)
 257                 g_object_new (GTK_TYPE_CELL_RENDERER_TEXT,
 258                               "ellipsize", PANGO_ELLIPSIZE_END,
 259                               NULL);
 260         gtk_tree_view_column_pack_start (GTK_TREE_VIEW_COLUMN (column), renderer, TRUE);
 261         gtk_tree_view_column_set_attributes (GTK_TREE_VIEW_COLUMN (column), renderer,
 262                                              "markup", EV_DOCUMENT_LINKS_COLUMN_MARKUP,
 263                                              NULL);
 264
 265
 266         renderer = gtk_cell_renderer_text_new ();
 267         gtk_tree_view_column_pack_end (GTK_TREE_VIEW_COLUMN (column), renderer, FALSE);
 268         gtk_tree_view_column_set_cell_data_func (GTK_TREE_VIEW_COLUMN (column), renderer,
 269                                                  (GtkTreeCellDataFunc) links_page_num_func,
 270                                                  ev_sidebar_links, NULL);
 271
 272
 273 }
 274
 275 static void
 276 ev_sidebar_links_init (EvSidebarLinks *ev_sidebar_links)
 277 {
 278         ev_sidebar_links->priv = EV_SIDEBAR_LINKS_GET_PRIVATE (ev_sidebar_links);
 279
 280         ev_sidebar_links_construct (ev_sidebar_links);
 281 }
 282
 283 static void
 284 links_page_num_func (GtkTreeViewColumn *tree_column,
 285                      GtkCellRenderer   *cell,
 286                      GtkTreeModel      *tree_model,
 287                      GtkTreeIter       *iter,
 288                      EvSidebarLinks    *sidebar_links)
 289 {
 290         EvLink *link;
 291
 292         gtk_tree_model_get (tree_model, iter,
 293                             EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
 294                             -1);
 295
 296         if (link != NULL &&
 297             ev_link_get_link_type (link) == EV_LINK_TYPE_PAGE) {
 298                 gchar *page_label;
 299                 gchar *page_string;
 300
 301                 page_label = ev_page_cache_get_page_label (sidebar_links->priv->page_cache, ev_link_get_page (link));
 302                 page_string = g_markup_printf_escaped ("<i>%s</i>", page_label);
 303
 304                 g_object_set (cell,
 305                               "markup", page_string,
 306                               "visible", TRUE,
 307                               NULL);
 308
 309                 g_free (page_label);
 310                 g_free (page_string);
 311         } else {
 312                 g_object_set (cell,
 313                               "visible", FALSE,
 314                               NULL);
 315         }
 316 }
 317
 318 /* Public Functions */
 319
 320 GtkWidget *
 321 ev_sidebar_links_new (void)
 322 {
 323         GtkWidget *ev_sidebar_links;
 324
 325         ev_sidebar_links = g_object_new (EV_TYPE_SIDEBAR_LINKS, NULL);
 326
 327         return ev_sidebar_links;
 328 }
 329
 330 static void
 331 ev_sidebar_links_clear_document (EvSidebarLinks *sidebar_links)
 332 {
 333         EvSidebarLinksPrivate *priv;
 334
 335         g_return_if_fail (EV_IS_SIDEBAR_LINKS (sidebar_links));
 336
 337         priv = sidebar_links->priv;
 338
 339         if (priv->document) {
 340                 g_object_unref (priv->document);
 341                 priv->document = NULL;
 342                 priv->page_cache = NULL;
 343         }
 344
 345         gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), NULL);
 346 }
 347
 348 static gboolean
 349 update_page_callback_foreach (GtkTreeModel *model,
 350                               GtkTreePath  *path,
 351                               GtkTreeIter  *iter,
 352                               gpointer      data)
 353 {
 354         EvSidebarLinks *sidebar_links = (data);
 355         EvLink *link;
 356
 357         gtk_tree_model_get (model, iter,
 358                             EV_DOCUMENT_LINKS_COLUMN_LINK, &link,
 359                             -1);
 360
 361         if (link && ev_link_get_link_type (link) == EV_LINK_TYPE_PAGE) {
 362                 int current_page;
 363
 364                 current_page = ev_page_cache_get_current_page (sidebar_links->priv->page_cache);
 365                 if (ev_link_get_page (link) == current_page) {
 366                         GtkTreeSelection *selection;
 367
 368                         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (sidebar_links->priv->tree_view));
 369
 370                         gtk_tree_selection_select_path (selection, path);
 371
 372                         return TRUE;
 373                 }
 374         }
 375
 376         return FALSE;
 377 }
 378
 379 static void
 380 update_page_callback (EvPageCache    *page_cache,
 381                       gint            current_page,
 382                       EvSidebarLinks *sidebar_links)
 383 {
 384         GtkTreeSelection *selection;
 385         /* We go through the tree linearly looking for the first page that
 386          * matches.  This is pretty inefficient.  We can do something neat with
 387          * a GtkTreeModelSort here to make it faster, if it turns out to be
 388          * slow.
 389          */
 390
 391         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (sidebar_links->priv->tree_view));
 392
 393         g_signal_handler_block (selection, sidebar_links->priv->selection_id);
 394
 395         gtk_tree_selection_unselect_all (selection);
 396         gtk_tree_model_foreach (sidebar_links->priv->model,
 397                                 update_page_callback_foreach,
 398                                 sidebar_links);
 399
 400         g_signal_handler_unblock (selection, sidebar_links->priv->selection_id);
 401 }
 402
 403 static void
 404 job_finished_cb (EvJobLinks     *job,
 405                  EvSidebarLinks *sidebar_links)
 406 {
 407         EvSidebarLinksPrivate *priv;
 408         GtkTreeSelection *selection;
 409         GtkTreeIter iter;
 410         GtkTreePath *path;
 411         gboolean result;
 412
 413         priv = sidebar_links->priv;
 414
 415         priv->model = g_object_ref (job->model);
 416         g_object_notify (G_OBJECT (sidebar_links), "model");
 417
 418         gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), job->model);
 419         g_object_unref (job);
 420
 421         /* Expand one level of the tree */
 422         path = gtk_tree_path_new_first ();
 423         for (result = gtk_tree_model_get_iter_first (priv->model, &iter);
 424              result;
 425              result = gtk_tree_model_iter_next (priv->model, &iter)) {
 426                 gtk_tree_view_expand_row (GTK_TREE_VIEW (priv->tree_view), path, FALSE);
 427                 gtk_tree_path_next (path);
 428         }
 429         gtk_tree_path_free (path);
 430
 431         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
 432         gtk_tree_selection_set_mode (selection, GTK_SELECTION_SINGLE);
 433         priv->selection_id = g_signal_connect (selection, "changed",
 434                                                G_CALLBACK (selection_changed_cb),
 435                                                sidebar_links);
 436         priv->page_changed_id = g_signal_connect (priv->page_cache, "page-changed",
 437                                                   G_CALLBACK (update_page_callback),
 438                                                   sidebar_links);
 439         update_page_callback (priv->page_cache,
 440                               ev_page_cache_get_current_page (priv->page_cache),
 441                               sidebar_links);
 442
 443 }
 444
 445 static void
 446 ev_sidebar_links_set_document (EvSidebarPage  *sidebar_page,
 447                                EvDocument     *document)
 448 {
 449         EvSidebarLinks *sidebar_links;
 450         EvSidebarLinksPrivate *priv;
 451
 452         g_return_if_fail (EV_IS_SIDEBAR_PAGE (sidebar_page));
 453         g_return_if_fail (EV_IS_DOCUMENT (document));
 454
 455         sidebar_links = EV_SIDEBAR_LINKS (sidebar_page);
 456
 457         priv = sidebar_links->priv;
 458
 459         g_object_ref (document);
 460
 461         priv->document = document;
 462         priv->page_cache = ev_document_get_page_cache (document);
 463
 464         priv->job = ev_job_links_new (document);
 465         g_signal_connect (priv->job,
 466                           "finished",
 467                           G_CALLBACK (job_finished_cb),
 468                           sidebar_links);
 469         /* The priority doesn't matter for this job */
 470         ev_job_queue_add_job (priv->job, EV_JOB_PRIORITY_LOW);
 471
 472 }
 473
 474 static gboolean
 475 ev_sidebar_links_support_document (EvSidebarPage  *sidebar_page,
 476                                    EvDocument *document)
 477 {
 478         return (EV_IS_DOCUMENT_LINKS (document) &&
 479                     ev_document_links_has_document_links (EV_DOCUMENT_LINKS (document)));
 480 }
 481
 482 static const gchar*
 483 ev_sidebar_links_get_label (EvSidebarPage *sidebar_page)
 484 {
 485     return _("Index");
 486 }
 487
 488 static void
 489 ev_sidebar_links_page_iface_init (EvSidebarPageIface *iface)
 490 {
 491         iface->support_document = ev_sidebar_links_support_document;
 492         iface->set_document = ev_sidebar_links_set_document;
 493         iface->get_label = ev_sidebar_links_get_label;
 494 }
 495