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