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