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