libview/ev-view.h

   1 /* this file is part of evince, a gnome document viewer
   2  *
   3  *  Copyright (C) 2004 Red Hat, Inc
   4  *
   5  * Evince is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * Evince is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 #if !defined (__EV_EVINCE_VIEW_H_INSIDE__) && !defined (EVINCE_COMPILATION)
  21 #error "Only <evince-view.h> can be included directly."
  22 #endif
  23
  24 #ifndef __EV_VIEW_H__
  25 #define __EV_VIEW_H__
  26
  27 #include <gtk/gtk.h>
  28
  29 #include <evince-document.h>
  30
  31 #include "ev-document-model.h"
  32
  33 G_BEGIN_DECLS
  34
  35 #define EV_TYPE_VIEW            (ev_view_get_type ())
  36 #define EV_VIEW(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), EV_TYPE_VIEW, EvView))
  37 #define EV_IS_VIEW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EV_TYPE_VIEW))
  38
  39 typedef struct _EvView       EvView;
  40 typedef struct _EvViewClass  EvViewClass;
  41
  42 typedef enum {
  43         EV_VIEW_SELECTION_TEXT,
  44         EV_VIEW_SELECTION_RECTANGLE,
  45 } EvViewSelectionMode;
  46
  47 GType           ev_view_get_type            (void) G_GNUC_CONST;
  48
  49 GtkWidget*      ev_view_new                 (void);
  50 void            ev_view_set_model           (EvView          *view,
  51                                              EvDocumentModel *model);
  52 void            ev_view_set_loading         (EvView          *view,
  53                                              gboolean         loading);
  54 void            ev_view_reload              (EvView          *view);
  55 void            ev_view_set_page_cache_size (EvView          *view,
  56                                              gsize            cache_size);
  57
  58 /* Clipboard */
  59 void            ev_view_copy              (EvView         *view);
  60 void            ev_view_copy_link_address (EvView         *view,
  61                                            EvLinkAction   *action);
  62 void            ev_view_select_all        (EvView         *view);
  63 gboolean        ev_view_get_has_selection (EvView         *view);
  64
  65 /* Page size */
  66 gboolean        ev_view_can_zoom_in       (EvView         *view);
  67 void            ev_view_zoom_in           (EvView         *view);
  68 gboolean        ev_view_can_zoom_out      (EvView         *view);
  69 void            ev_view_zoom_out          (EvView         *view);
  70
  71 /* Find */
  72 void            ev_view_find_next                 (EvView         *view);
  73 void            ev_view_find_previous             (EvView         *view);
  74 void            ev_view_find_search_changed       (EvView         *view);
  75 void            ev_view_find_set_highlight_search (EvView         *view,
  76                                                    gboolean        value);
  77 void            ev_view_find_changed              (EvView         *view,
  78                                                    GList         **results,
  79                                                    gint            page);
  80 void            ev_view_find_cancel               (EvView         *view);
  81
  82 /* Synctex */
  83 void            ev_view_highlight_forward_search (EvView       *view,
  84                                                   EvSourceLink *link);
  85
  86 /* Cursor */
  87 void           ev_view_hide_cursor        (EvView         *view);
  88 void           ev_view_show_cursor        (EvView         *view);
  89
  90 /* Navigation */
  91 void           ev_view_scroll             (EvView         *view,
  92                                            GtkScrollType   scroll,
  93                                            gboolean        horizontal);
  94 void           ev_view_handle_link        (EvView         *view,
  95                                            EvLink         *link);
  96 gboolean       ev_view_next_page          (EvView         *view);
  97 gboolean       ev_view_previous_page      (EvView         *view);
  98
  99 void           ev_view_autoscroll_start   (EvView *view);
 100 void           ev_view_autoscroll_stop    (EvView *view);
 101
 102 gboolean       ev_view_get_page_extents   (EvView       *view,
 103                                            gint          page,
 104                                            GdkRectangle *page_area,
 105                                            GtkBorder    *border);
 106 /* Annotations */
 107 void           ev_view_focus_annotation      (EvView          *view,
 108                                               EvMapping       *annot_mapping);
 109 void           ev_view_begin_add_annotation  (EvView          *view,
 110                                               EvAnnotationType annot_type);
 111 void           ev_view_cancel_add_annotation (EvView          *view);
 112
 113 G_END_DECLS
 114
 115 #endif /* __EV_VIEW_H__ */