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