shell/ev-view.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
   2 /* this file is part of evince, a gnome document viewer
   3  *
   4  *  Copyright (C) 2004 Red Hat, Inc
   5  *
   6  * Evince is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Evince is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #include <gtk/gtkalignment.h>
  22
  23 #include "ev-marshal.h"
  24 #include "ev-view.h"
  25 #include "ev-document-find.h"
  26
  27 #define EV_VIEW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), EV_TYPE_VIEW, EvViewClass))
  28 #define EV_IS_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EV_TYPE_VIEW))
  29 #define EV_VIEW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), EV_TYPE_VIEW, EvViewClass))
  30
  31 struct _EvView {
  32         GtkWidget parent_instance;
  33
  34         EvDocument *document;
  35
  36         GdkWindow *bin_window;
  37
  38         int scroll_x;
  39         int scroll_y;
  40
  41         GtkAdjustment *hadjustment;
  42         GtkAdjustment *vadjustment;
  43
  44         GArray *find_results;
  45
  46         double scale;
  47 };
  48
  49 struct _EvViewClass {
  50         GtkWidgetClass parent_class;
  51
  52         void    (*set_scroll_adjustments) (EvView         *view,
  53                                            GtkAdjustment  *hadjustment,
  54                                            GtkAdjustment  *vadjustment);
  55
  56         /* Should this be notify::page? */
  57         void    (*page_changed)           (EvView         *view);
  58 };
  59
  60 static guint page_changed_signal = 0;
  61
  62 static void ev_view_set_scroll_adjustments (EvView         *view,
  63                                             GtkAdjustment  *hadjustment,
  64                                             GtkAdjustment  *vadjustment);
  65
  66 G_DEFINE_TYPE (EvView, ev_view, GTK_TYPE_WIDGET)
  67
  68 /*** Helper functions ***/
  69
  70 static void
  71 view_update_adjustments (EvView *view)
  72 {
  73         int old_x = view->scroll_x;
  74         int old_y = view->scroll_y;
  75
  76         if (view->hadjustment)
  77                 view->scroll_x = view->hadjustment->value;
  78         else
  79                 view->scroll_x = 0;
  80
  81         if (view->vadjustment)
  82                 view->scroll_y = view->vadjustment->value;
  83         else
  84                 view->scroll_y = 0;
  85
  86         if (GTK_WIDGET_REALIZED (view) &&
  87             (view->scroll_x != old_x || view->scroll_y != old_y)) {
  88                 gdk_window_move (view->bin_window, - view->scroll_x, - view->scroll_y);
  89                 gdk_window_process_updates (view->bin_window, TRUE);
  90         }
  91 }
  92
  93 static void
  94 view_set_adjustment_values (EvView         *view,
  95                             GtkOrientation  orientation)
  96 {
  97         GtkWidget *widget = GTK_WIDGET (view);
  98         GtkAdjustment *adjustment;
  99         gboolean value_changed = FALSE;
 100         int requisition;
 101         int allocation;
 102
 103         if (orientation == GTK_ORIENTATION_HORIZONTAL)  {
 104                 requisition = widget->requisition.width;
 105                 allocation = widget->allocation.width;
 106                 adjustment = view->hadjustment;
 107         } else {
 108                 requisition = widget->requisition.height;
 109                 allocation = widget->allocation.height;
 110                 adjustment = view->vadjustment;
 111         }
 112
 113         if (!adjustment)
 114                 return;
 115
 116         adjustment->page_size = allocation;
 117         adjustment->step_increment = allocation * 0.1;
 118         adjustment->page_increment = allocation * 0.9;
 119         adjustment->lower = 0;
 120         adjustment->upper = MAX (allocation, requisition);
 121
 122         if (adjustment->value > adjustment->upper - adjustment->page_size) {
 123                 adjustment->value = adjustment->upper - adjustment->page_size;
 124                 value_changed = TRUE;
 125         }
 126
 127         gtk_adjustment_changed (adjustment);
 128         if (value_changed)
 129                 gtk_adjustment_value_changed (adjustment);
 130 }
 131
 132 /*** Virtual function implementations ***/
 133
 134 static void
 135 ev_view_finalize (GObject *object)
 136 {
 137         EvView *view = EV_VIEW (object);
 138
 139         if (view->document)
 140                 g_object_unref (view->document);
 141
 142         ev_view_set_scroll_adjustments (view, NULL, NULL);
 143
 144         g_array_free (view->find_results, TRUE);
 145         view->find_results = NULL;
 146
 147         G_OBJECT_CLASS (ev_view_parent_class)->finalize (object);
 148 }
 149
 150 static void
 151 ev_view_destroy (GtkObject *object)
 152 {
 153         EvView *view = EV_VIEW (object);
 154
 155         ev_view_set_scroll_adjustments (view, NULL, NULL);
 156
 157         GTK_OBJECT_CLASS (ev_view_parent_class)->destroy (object);
 158 }
 159
 160 static void
 161 ev_view_size_request (GtkWidget      *widget,
 162                       GtkRequisition *requisition)
 163 {
 164         EvView *view = EV_VIEW (widget);
 165
 166         if (GTK_WIDGET_REALIZED (widget)) {
 167                 if (view->document) {
 168                         ev_document_get_page_size (view->document,
 169                                                    &requisition->width,
 170                                                    &requisition->height);
 171                 } else {
 172                         requisition->width = 10;
 173                         requisition->height = 10;
 174                 }
 175         }
 176
 177 }
 178
 179 static void
 180 ev_view_size_allocate (GtkWidget      *widget,
 181                        GtkAllocation  *allocation)
 182 {
 183         EvView *view = EV_VIEW (widget);
 184
 185         GTK_WIDGET_CLASS (ev_view_parent_class)->size_allocate (widget, allocation);
 186
 187         view_set_adjustment_values (view, GTK_ORIENTATION_HORIZONTAL);
 188         view_set_adjustment_values (view, GTK_ORIENTATION_VERTICAL);
 189
 190         if (GTK_WIDGET_REALIZED (widget)) {
 191                 gdk_window_resize (view->bin_window,
 192                                    MAX (widget->allocation.width, widget->requisition.width),
 193                                    MAX (widget->allocation.height, widget->requisition.height));
 194         }
 195 }
 196
 197 static void
 198 update_window_backgrounds (EvView *view)
 199 {
 200         GtkWidget *widget = GTK_WIDGET (view);
 201
 202         if (GTK_WIDGET_REALIZED (view)) {
 203                 gdk_window_set_background (view->bin_window,
 204                                            &widget->style->base[GTK_WIDGET_STATE (widget)]);
 205         }
 206 }
 207
 208 static void
 209 ev_view_realize (GtkWidget *widget)
 210 {
 211         EvView *view = EV_VIEW (widget);
 212         GdkWindowAttr attributes;
 213
 214         GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
 215
 216         attributes.window_type = GDK_WINDOW_CHILD;
 217         attributes.wclass = GDK_INPUT_OUTPUT;
 218         attributes.visual = gtk_widget_get_visual (widget);
 219         attributes.colormap = gtk_widget_get_colormap (widget);
 220
 221         attributes.x = widget->allocation.x;
 222         attributes.y = widget->allocation.y;
 223         attributes.width = widget->allocation.width;
 224         attributes.height = widget->allocation.height;
 225         attributes.event_mask = 0;
 226
 227         widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
 228                                          &attributes,
 229                                          GDK_WA_X | GDK_WA_Y |
 230                                          GDK_WA_COLORMAP |
 231                                          GDK_WA_VISUAL);
 232         gdk_window_set_user_data (widget->window, widget);
 233         widget->style = gtk_style_attach (widget->style, widget->window);
 234
 235         attributes.x = 0;
 236         attributes.y = 0;
 237         attributes.width = MAX (widget->allocation.width, widget->requisition.width);
 238         attributes.height = MAX (widget->allocation.height, widget->requisition.height);
 239         attributes.event_mask = GDK_EXPOSURE_MASK;
 240
 241         view->bin_window = gdk_window_new (widget->window,
 242                                            &attributes,
 243                                            GDK_WA_X | GDK_WA_Y |
 244                                            GDK_WA_COLORMAP |
 245                                            GDK_WA_VISUAL);
 246         gdk_window_set_user_data (view->bin_window, widget);
 247         gdk_window_show (view->bin_window);
 248
 249         if (view->document) {
 250                 ev_document_set_target (view->document, view->bin_window);
 251
 252                 /* We can't get page size without a target, so we have to
 253                  * queue a size request at realization. Could be fixed
 254                  * with EvDocument changes to allow setting a GdkScreen
 255                  * without setting a target.
 256                  */
 257                 gtk_widget_queue_resize (widget);
 258         }
 259
 260         update_window_backgrounds (view);
 261 }
 262
 263 static void
 264 ev_view_unrealize (GtkWidget *widget)
 265 {
 266         EvView *view = EV_VIEW (widget);
 267
 268         if (view->document)
 269                 ev_document_set_target (view->document, NULL);
 270
 271         gdk_window_set_user_data (view->bin_window, NULL);
 272         gdk_window_destroy (view->bin_window);
 273         view->bin_window = NULL;
 274
 275         GTK_WIDGET_CLASS (ev_view_parent_class)->unrealize (widget);
 276 }
 277
 278 static void
 279 ev_view_style_set (GtkWidget      *widget,
 280                    GtkStyle       *previous_style)
 281 {
 282         update_window_backgrounds (EV_VIEW (widget));
 283 }
 284
 285 static void
 286 ev_view_state_changed (GtkWidget    *widget,
 287                        GtkStateType  previous_state)
 288 {
 289         update_window_backgrounds (EV_VIEW (widget));
 290 }
 291
 292 static void
 293 expose_bin_window (GtkWidget      *widget,
 294                    GdkEventExpose *event)
 295 {
 296         EvView *view = EV_VIEW (widget);
 297         int i;
 298         int current_page;
 299         const EvFindResult *results;
 300
 301         if (view->document == NULL)
 302                 return;
 303
 304         ev_document_render (view->document,
 305                             event->area.x, event->area.y,
 306                             event->area.width, event->area.height);
 307
 308         results = (EvFindResult*) view->find_results->data;
 309         current_page = ev_document_get_page (view->document);
 310         i = 0;
 311         while (i < view->find_results->len) {
 312 #if 0
 313                 g_printerr ("highlighting result %d page %d at %d,%d %dx%d\n",
 314                             i, results[i].page_num,
 315                             results[i].highlight_area.x,
 316                             results[i].highlight_area.y,
 317                             results[i].highlight_area.width,
 318                             results[i].highlight_area.height);
 319 #endif
 320                 if (results[i].page_num == current_page)
 321                         gdk_draw_rectangle (view->bin_window,
 322                                             widget->style->base_gc[GTK_STATE_SELECTED],
 323                                             FALSE,
 324                                             results[i].highlight_area.x,
 325                                             results[i].highlight_area.y,
 326                                             results[i].highlight_area.width,
 327                                             results[i].highlight_area.height);
 328                 ++i;
 329         }
 330 }
 331
 332 static gboolean
 333 ev_view_expose_event (GtkWidget      *widget,
 334                       GdkEventExpose *event)
 335 {
 336         EvView *view = EV_VIEW (widget);
 337
 338         if (event->window == view->bin_window)
 339                 expose_bin_window (widget, event);
 340         else
 341                 return GTK_WIDGET_CLASS (ev_view_parent_class)->expose_event (widget, event);
 342
 343         return FALSE;
 344 }
 345
 346 static gboolean
 347 ev_view_button_press_event (GtkWidget      *widget,
 348                             GdkEventButton *event)
 349 {
 350         /* EvView *view = EV_VIEW (widget); */
 351
 352         return FALSE;
 353 }
 354
 355 static gboolean
 356 ev_view_motion_notify_event (GtkWidget      *widget,
 357                              GdkEventMotion *event)
 358 {
 359         /* EvView *view = EV_VIEW (widget); */
 360
 361         return FALSE;
 362 }
 363
 364 static gboolean
 365 ev_view_button_release_event (GtkWidget      *widget,
 366                               GdkEventButton *event)
 367 {
 368         /* EvView *view = EV_VIEW (widget); */
 369
 370         return FALSE;
 371 }
 372
 373 static void
 374 on_adjustment_value_changed (GtkAdjustment  *adjustment,
 375                              EvView *view)
 376 {
 377         view_update_adjustments (view);
 378 }
 379
 380 static void
 381 set_scroll_adjustment (EvView *view,
 382                        GtkOrientation  orientation,
 383                        GtkAdjustment  *adjustment)
 384 {
 385         GtkAdjustment **to_set;
 386
 387         if (orientation == GTK_ORIENTATION_HORIZONTAL)
 388                 to_set = &view->hadjustment;
 389         else
 390                 to_set = &view->vadjustment;
 391
 392         if (*to_set != adjustment) {
 393                 if (*to_set) {
 394                         g_signal_handlers_disconnect_by_func (*to_set,
 395                                                               (gpointer) on_adjustment_value_changed,
 396                                                               view);
 397                         g_object_unref (*to_set);
 398                 }
 399
 400                 *to_set = adjustment;
 401                 view_set_adjustment_values (view, orientation);
 402
 403                 if (*to_set) {
 404                         g_object_ref (*to_set);
 405                         g_signal_connect (*to_set, "value_changed",
 406                                           G_CALLBACK (on_adjustment_value_changed), view);
 407                 }
 408         }
 409 }
 410
 411 static void
 412 ev_view_set_scroll_adjustments (EvView *view,
 413                                 GtkAdjustment  *hadjustment,
 414                                 GtkAdjustment  *vadjustment)
 415 {
 416         set_scroll_adjustment (view, GTK_ORIENTATION_HORIZONTAL, hadjustment);
 417         set_scroll_adjustment (view, GTK_ORIENTATION_VERTICAL, vadjustment);
 418
 419         view_update_adjustments (view);
 420 }
 421
 422 static void
 423 ev_view_class_init (EvViewClass *class)
 424 {
 425         GObjectClass *object_class = G_OBJECT_CLASS (class);
 426         GtkObjectClass *gtk_object_class = GTK_OBJECT_CLASS (class);
 427         GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
 428
 429         object_class->finalize = ev_view_finalize;
 430
 431         widget_class->expose_event = ev_view_expose_event;
 432         widget_class->button_press_event = ev_view_button_press_event;
 433         widget_class->motion_notify_event = ev_view_motion_notify_event;
 434         widget_class->button_release_event = ev_view_button_release_event;
 435         widget_class->size_request = ev_view_size_request;
 436         widget_class->size_allocate = ev_view_size_allocate;
 437         widget_class->realize = ev_view_realize;
 438         widget_class->unrealize = ev_view_unrealize;
 439         widget_class->style_set = ev_view_style_set;
 440         widget_class->state_changed = ev_view_state_changed;
 441         gtk_object_class->destroy = ev_view_destroy;
 442
 443         class->set_scroll_adjustments = ev_view_set_scroll_adjustments;
 444
 445         widget_class->set_scroll_adjustments_signal =  g_signal_new ("set-scroll-adjustments",
 446                                                                      G_OBJECT_CLASS_TYPE (object_class),
 447                                                                      G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
 448                                                                      G_STRUCT_OFFSET (EvViewClass, set_scroll_adjustments),
 449                                                                      NULL, NULL,
 450                                                                      ev_marshal_VOID__OBJECT_OBJECT,
 451                                                                      G_TYPE_NONE, 2,
 452                                                                      GTK_TYPE_ADJUSTMENT,
 453                                                                      GTK_TYPE_ADJUSTMENT);
 454         page_changed_signal = g_signal_new ("page-changed",
 455                                             G_OBJECT_CLASS_TYPE (object_class),
 456                                             G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
 457                                             G_STRUCT_OFFSET (EvViewClass, page_changed),
 458                                             NULL, NULL,
 459                                             ev_marshal_VOID__NONE,
 460                                             G_TYPE_NONE, 0);
 461 }
 462
 463 static void
 464 ev_view_init (EvView *view)
 465 {
 466         static const GdkColor white = { 0, 0xffff, 0xffff, 0xffff };
 467
 468         view->scale = 1.0;
 469
 470         gtk_widget_modify_bg (GTK_WIDGET (view), GTK_STATE_NORMAL, &white);
 471
 472         view->find_results = g_array_new (FALSE,
 473                                           FALSE,
 474                                           sizeof (EvFindResult));
 475 }
 476
 477
 478 static void
 479 found_results_callback (EvDocument         *document,
 480                         const EvFindResult *results,
 481                         int                 n_results,
 482                         double              percent_complete,
 483                         void               *data)
 484 {
 485   EvView *view = EV_VIEW (data);
 486
 487   g_array_set_size (view->find_results, 0);
 488
 489   if (n_results > 0)
 490           g_array_append_vals (view->find_results,
 491                                results, n_results);
 492
 493 #if 0
 494   {
 495           int i;
 496
 497           g_printerr ("%d results: ", n_results);
 498           i = 0;
 499           while (i < n_results) {
 500                   g_printerr ("%d ", results[i].page_num);
 501                   ++i;
 502           }
 503           g_printerr ("\n");
 504   }
 505 #endif
 506
 507   gtk_widget_queue_draw (GTK_WIDGET (view));
 508 }
 509
 510 /*** Public API ***/
 511
 512 GtkWidget*
 513 ev_view_new (void)
 514 {
 515         return g_object_new (EV_TYPE_VIEW, NULL);
 516 }
 517
 518 void
 519 ev_view_set_document (EvView     *view,
 520                       EvDocument *document)
 521 {
 522         g_return_if_fail (EV_IS_VIEW (view));
 523
 524         if (document != view->document) {
 525                 int old_page = ev_view_get_page (view);
 526
 527                 if (view->document) {
 528                         g_object_unref (view->document);
 529                         g_signal_handlers_disconnect_by_func (view->document,
 530                                                               found_results_callback,
 531                                                               view);
 532                         g_array_set_size (view->find_results, 0);
 533                 }
 534
 535                 view->document = document;
 536
 537                 if (view->document) {
 538                         g_object_ref (view->document);
 539                         g_signal_connect (view->document,
 540                                           "found",
 541                                           G_CALLBACK (found_results_callback),
 542                                           view);
 543                 }
 544
 545                 if (GTK_WIDGET_REALIZED (view))
 546                         ev_document_set_target (view->document, view->bin_window);
 547
 548                 gtk_widget_queue_resize (GTK_WIDGET (view));
 549
 550                 if (old_page != ev_view_get_page (view))
 551                         g_signal_emit (view, page_changed_signal, 0);
 552         }
 553 }
 554
 555 void
 556 ev_view_set_page (EvView *view,
 557                   int     page)
 558 {
 559         if (view->document) {
 560                 int old_page = ev_document_get_page (view->document);
 561                 if (old_page != page)
 562                         ev_document_set_page (view->document, page);
 563                 if (old_page != ev_document_get_page (view->document)) {
 564                         g_signal_emit (view, page_changed_signal, 0);
 565                         gtk_widget_queue_draw (GTK_WIDGET (view));
 566                 }
 567         }
 568 }
 569
 570 int
 571 ev_view_get_page (EvView *view)
 572 {
 573         if (view->document)
 574                 return ev_document_get_page (view->document);
 575         else
 576                 return 1;
 577 }
 578
 579 #define ZOOM_IN_FACTOR  1.2
 580 #define ZOOM_OUT_FACTOR (1.0/ZOOM_IN_FACTOR)
 581
 582 #define MIN_SCALE 0.05409
 583 #define MAX_SCALE 18.4884
 584
 585 static void
 586 ev_view_zoom (EvView   *view,
 587               double    factor,
 588               gboolean  relative)
 589 {
 590         double scale;
 591
 592         if (relative)
 593                 scale = view->scale * factor;
 594         else
 595                 scale = factor;
 596
 597         view->scale = CLAMP (scale, MIN_SCALE, MAX_SCALE);
 598
 599         ev_document_set_scale (view->document, view->scale);
 600
 601         gtk_widget_queue_draw (GTK_WIDGET (view));
 602 }
 603
 604 void
 605 ev_view_zoom_in (EvView *view)
 606 {
 607         ev_view_zoom (view, ZOOM_IN_FACTOR, TRUE);
 608 }
 609
 610 void
 611 ev_view_zoom_out (EvView *view)
 612 {
 613         ev_view_zoom (view, ZOOM_OUT_FACTOR, TRUE);
 614 }
 615
 616 void
 617 ev_view_normal_size (EvView *view)
 618 {
 619         ev_view_zoom (view, 1.0, FALSE);
 620 }
 621
 622 void
 623 ev_view_best_fit (EvView *view)
 624 {
 625         double scale;
 626         int width, height;
 627
 628         width = height = 0;
 629         ev_document_get_page_size (view->document, &width, &height);
 630
 631         scale = 1.0;
 632         if (width != 0 && height != 0) {
 633                 double scale_w, scale_h;
 634
 635                 scale_w = (double)GTK_WIDGET (view)->allocation.width * view->scale / width;
 636                 scale_h = (double)GTK_WIDGET (view)->allocation.height * view->scale / height;
 637
 638                 scale = (scale_w < scale_h) ? scale_w : scale_h;
 639         }
 640
 641         ev_view_zoom (view, scale, FALSE);
 642 }
 643
 644 void
 645 ev_view_fit_width (EvView *view)
 646 {
 647         double scale = 1.0;
 648         int width;
 649
 650         width = 0;
 651         ev_document_get_page_size (view->document, &width, NULL);
 652
 653         scale = 1.0;
 654         if (width != 0)
 655                 scale = (double)GTK_WIDGET (view)->allocation.width * view->scale / width;
 656
 657         ev_view_zoom (view, scale, FALSE);
 658 }