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 G_BEGIN_DECLS
  32
  33 #define EV_TYPE_VIEW            (ev_view_get_type ())
  34 #define EV_VIEW(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), EV_TYPE_VIEW, EvView))
  35 #define EV_IS_VIEW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EV_TYPE_VIEW))
  36
  37 typedef struct _EvView       EvView;
  38 typedef struct _EvViewClass  EvViewClass;
  39
  40
  41 typedef enum {
  42         EV_SIZING_BEST_FIT,
  43         EV_SIZING_FIT_WIDTH,
  44         EV_SIZING_FREE,
  45 } EvSizingMode;
  46
  47 typedef enum {
  48         EV_VIEW_SELECTION_TEXT,
  49         EV_VIEW_SELECTION_RECTANGLE,
  50 } EvViewSelectionMode;
  51
  52 GType           ev_view_get_type          (void) G_GNUC_CONST;
  53
  54 GtkWidget*      ev_view_new               (void);
  55 void            ev_view_set_document      (EvView         *view,
  56                                            EvDocument     *document);
  57 void            ev_view_set_loading       (EvView         *view,
  58                                            gboolean        loading);
  59 void            ev_view_reload            (EvView         *view);
  60
  61 /* Clipboard */
  62 void            ev_view_copy              (EvView         *view);
  63 void            ev_view_copy_link_address (EvView         *view,
  64                                            EvLinkAction   *action);
  65 void            ev_view_select_all        (EvView         *view);
  66 gboolean        ev_view_get_has_selection (EvView         *view);
  67
  68 /* sizing and behavior */
  69 /* These are all orthoganal to each other, except 'presentation' trumps all
  70  * other behaviors
  71  */
  72 gboolean        ev_view_get_continuous    (EvView         *view);
  73 void            ev_view_set_continuous    (EvView         *view,
  74                                            gboolean        continuous);
  75 gboolean        ev_view_get_dual_page     (EvView         *view);
  76 void            ev_view_set_dual_page     (EvView         *view,
  77                                            gboolean        dual_page);
  78 void            ev_view_set_fullscreen    (EvView         *view,
  79                                            gboolean        fullscreen);
  80 gboolean        ev_view_get_fullscreen    (EvView         *view);
  81 void            ev_view_set_presentation  (EvView         *view,
  82                                            gboolean        presentation);
  83 gboolean        ev_view_get_presentation  (EvView         *view);
  84 void            ev_view_set_sizing_mode   (EvView         *view,
  85                                            EvSizingMode    mode);
  86 EvSizingMode    ev_view_get_sizing_mode   (EvView         *view);
  87
  88
  89 /* Page size */
  90 gboolean        ev_view_can_zoom_in       (EvView         *view);
  91 void            ev_view_zoom_in           (EvView         *view);
  92 gboolean        ev_view_can_zoom_out      (EvView         *view);
  93 void            ev_view_zoom_out          (EvView         *view);
  94 void            ev_view_set_zoom          (EvView         *view,
  95                                            double          factor,
  96                                            gboolean        relative);
  97 void            ev_view_set_zoom_for_size (EvView         *view,
  98                                            int             width,
  99                                            int             height,
 100                                            int             vsb_width,
 101                                            int             hsb_height);
 102 double          ev_view_get_zoom          (EvView         *view);
 103 void            ev_view_set_screen_dpi    (EvView         *view,
 104                                            gdouble         dpi);
 105 void            ev_view_rotate_left       (EvView         *view);
 106 void            ev_view_rotate_right      (EvView         *view);
 107 void            ev_view_set_rotation      (EvView         *view,
 108                                            int             rotation);
 109 int             ev_view_get_rotation      (EvView         *view);
 110
 111 /* Find */
 112 void            ev_view_find_next                 (EvView         *view);
 113 void            ev_view_find_previous             (EvView         *view);
 114 void            ev_view_find_search_changed       (EvView         *view);
 115 void            ev_view_find_set_highlight_search (EvView         *view,
 116                                                    gboolean        value);
 117 void            ev_view_find_changed              (EvView         *view,
 118                                                    GList         **results,
 119                                                    gint            page);
 120 void            ev_view_find_cancel               (EvView         *view);
 121
 122 /* Cursor */
 123 void           ev_view_hide_cursor        (EvView         *view);
 124 void           ev_view_show_cursor        (EvView         *view);
 125
 126 /* Navigation */
 127 void           ev_view_scroll             (EvView         *view,
 128                                            GtkScrollType   scroll,
 129                                            gboolean        horizontal);
 130 void           ev_view_handle_link        (EvView         *view,
 131                                            EvLink         *link);
 132 gboolean       ev_view_next_page          (EvView         *view);
 133 gboolean       ev_view_previous_page      (EvView         *view);
 134 gchar*         ev_view_page_label_from_dest (EvView *view, EvLinkDest *dest);
 135
 136 void           ev_view_update_view_size   (EvView            *view,
 137                                            GtkScrolledWindow *scrolled_window);
 138
 139 void           ev_view_autoscroll_start   (EvView *view);
 140 void           ev_view_autoscroll_stop    (EvView *view);
 141
 142 G_END_DECLS
 143
 144 #endif /* __EV_VIEW_H__ */