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., 59 Temple Place, Suite 330, Boston, MA 02111-1307, 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
  56 /* Clipboard */
  57 void            ev_view_copy              (EvView         *view);
  58 void            ev_view_copy_link_address (EvView         *view,
  59                                            EvLinkAction   *action);
  60 void            ev_view_select_all        (EvView         *view);
  61 gboolean        ev_view_get_has_selection (EvView         *view);
  62
  63 /* sizing and behavior */
  64 /* These are all orthoganal to each other, except 'presentation' trumps all
  65  * other behaviors
  66  */
  67 gboolean        ev_view_get_continuous    (EvView         *view);
  68 void            ev_view_set_continuous    (EvView         *view,
  69                                            gboolean        continuous);
  70 gboolean        ev_view_get_dual_page     (EvView         *view);
  71 void            ev_view_set_dual_page     (EvView         *view,
  72                                            gboolean        dual_page);
  73 void            ev_view_set_fullscreen    (EvView         *view,
  74                                            gboolean        fullscreen);
  75 gboolean        ev_view_get_fullscreen    (EvView         *view);
  76 void            ev_view_set_presentation  (EvView         *view,
  77                                            gboolean        presentation);
  78 gboolean        ev_view_get_presentation  (EvView         *view);
  79 void            ev_view_set_sizing_mode   (EvView         *view,
  80                                            EvSizingMode    mode);
  81 EvSizingMode    ev_view_get_sizing_mode   (EvView         *view);
  82
  83
  84 /* Page size */
  85 gboolean        ev_view_can_zoom_in       (EvView         *view);
  86 void            ev_view_zoom_in           (EvView         *view);
  87 gboolean        ev_view_can_zoom_out      (EvView         *view);
  88 void            ev_view_zoom_out          (EvView         *view);
  89 void            ev_view_set_zoom          (EvView         *view,
  90                                            double          factor);
  91 double          ev_view_get_zoom          (EvView         *view);
  92 void            ev_view_set_screen_dpi    (EvView         *view,
  93                                            gdouble         dpi);
  94 void            ev_view_rotate_left       (EvView         *view);
  95 void            ev_view_rotate_right      (EvView         *view);
  96 void            ev_view_set_rotation      (EvView         *view,
  97                                            int             rotation);
  98 int             ev_view_get_rotation      (EvView         *view);
  99
 100 /* Find */
 101 void            ev_view_find_next                 (EvView         *view);
 102 void            ev_view_find_previous             (EvView         *view);
 103 void            ev_view_find_search_changed       (EvView         *view);
 104 void            ev_view_find_set_highlight_search (EvView         *view,
 105                                                    gboolean        value);
 106 void            ev_view_find_changed              (EvView         *view,
 107                                                    GList         **results,
 108                                                    gint            page);
 109 void            ev_view_find_cancel               (EvView         *view);
 110
 111 /* Cursor */
 112 void           ev_view_hide_cursor        (EvView         *view);
 113 void           ev_view_show_cursor        (EvView         *view);
 114
 115 /* Navigation */
 116 void           ev_view_scroll             (EvView         *view,
 117                                            GtkScrollType   scroll,
 118                                            gboolean        horizontal);
 119 void           ev_view_handle_link        (EvView         *view,
 120                                            EvLink         *link);
 121 gboolean       ev_view_next_page          (EvView         *view);
 122 gboolean       ev_view_previous_page      (EvView         *view);
 123 gchar*         ev_view_page_label_from_dest (EvView *view, EvLinkDest *dest);
 124
 125 void           ev_view_autoscroll_start   (EvView *view);
 126 void           ev_view_autoscroll_stop    (EvView *view);
 127
 128 G_END_DECLS
 129
 130 #endif /* __EV_VIEW_H__ */