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/gtkwidget.h>
  24 #include <gtk/gtklayout.h>
  25 #include <gtk/gtkscrolledwindow.h>
  26
  27 #include "ev-document.h"
  28 #include "ev-link.h"
  29 #include "ev-view-accessible.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 #define EV_TYPE_SIZING_MODE     (ev_sizing_mode_get_type())
  38 #define EV_SIZING_MODE_CLASS    (g_type_class_peek (EV_TYPE_SIZING_MODE))
  39
  40 #define EV_TYPE_SCROLL_TYPE     (ev_scroll_type_get_type())
  41 #define EV_SCROLL_TYPE_CLASS    (g_type_class_peek (EV_TYPE_SCROLL_TYPE))
  42
  43 typedef struct _EvView       EvView;
  44 typedef struct _EvViewClass  EvViewClass;
  45
  46
  47 typedef enum {
  48         EV_SIZING_BEST_FIT,
  49         EV_SIZING_FIT_WIDTH,
  50         EV_SIZING_FREE,
  51 } EvSizingMode;
  52
  53 typedef enum {
  54         EV_VIEW_SELECTION_TEXT,
  55         EV_VIEW_SELECTION_RECTANGLE,
  56 } EvViewSelectionMode;
  57
  58 typedef enum {
  59         EV_SCROLL_PAGE_FORWARD,
  60         EV_SCROLL_PAGE_BACKWARD,
  61         EV_SCROLL_STEP_BACKWARD,
  62         EV_SCROLL_STEP_FORWARD,
  63         EV_SCROLL_STEP_DOWN,
  64         EV_SCROLL_STEP_UP,
  65 } EvScrollType;
  66
  67 GType           ev_view_get_type          (void) G_GNUC_CONST;
  68 GType           ev_sizing_mode_get_type   (void) G_GNUC_CONST;
  69 GType           ev_scroll_type_get_type   (void) G_GNUC_CONST;
  70
  71 GtkWidget*      ev_view_new               (void);
  72 void            ev_view_set_document      (EvView         *view,
  73                                            EvDocument     *document);
  74 void            ev_view_set_loading       (EvView         *view,
  75                                            gboolean        loading);
  76 /* Clipboard */
  77 void            ev_view_copy              (EvView         *view);
  78 void            ev_view_copy_link_address (EvView         *view,
  79                                            EvLinkAction   *action);
  80 void            ev_view_select_all        (EvView         *view);
  81 gboolean        ev_view_get_has_selection (EvView         *view);
  82
  83 /* sizing and behavior */
  84 /* These are all orthoganal to each other, except 'presentation' trumps all
  85  * other behaviors
  86  */
  87 gboolean        ev_view_get_continuous    (EvView         *view);
  88 void            ev_view_set_continuous    (EvView         *view,
  89                                            gboolean        continuous);
  90 gboolean        ev_view_get_dual_page     (EvView         *view);
  91 void            ev_view_set_dual_page     (EvView         *view,
  92                                            gboolean        dual_page);
  93 void            ev_view_set_fullscreen    (EvView         *view,
  94                                            gboolean        fullscreen);
  95 gboolean        ev_view_get_fullscreen    (EvView         *view);
  96 void            ev_view_set_presentation  (EvView         *view,
  97                                            gboolean        presentation);
  98 gboolean        ev_view_get_presentation  (EvView         *view);
  99 void            ev_view_set_sizing_mode   (EvView         *view,
 100                                            EvSizingMode    mode);
 101 EvSizingMode    ev_view_get_sizing_mode   (EvView         *view);
 102
 103
 104 /* Page size */
 105 gboolean        ev_view_can_zoom_in       (EvView         *view);
 106 void            ev_view_zoom_in           (EvView         *view);
 107 gboolean        ev_view_can_zoom_out      (EvView         *view);
 108 void            ev_view_zoom_out          (EvView         *view);
 109 void            ev_view_set_zoom          (EvView         *view,
 110                                            double          factor,
 111                                            gboolean        relative);
 112 double          ev_view_get_zoom          (EvView         *view);
 113 void            ev_view_set_screen_dpi    (EvView         *view,
 114                                            gdouble         dpi);
 115 void            ev_view_rotate_left       (EvView         *view);
 116 void            ev_view_rotate_right      (EvView         *view);
 117 void            ev_view_set_rotation      (EvView         *view,
 118                                            int             rotation);
 119 int             ev_view_get_rotation      (EvView         *view);
 120
 121 /* Find */
 122 gboolean        ev_view_can_find_next        (EvView         *view);
 123 void            ev_view_find_next            (EvView         *view);
 124 gboolean        ev_view_can_find_previous    (EvView         *view);
 125 void            ev_view_find_previous        (EvView         *view);
 126 void            ev_view_search_changed       (EvView         *view);
 127 void            ev_view_set_highlight_search (EvView         *view,
 128                                               gboolean        value);
 129 void            ev_view_find_cancel          (EvView         *view);
 130
 131 /* Status */
 132 const char     *ev_view_get_status        (EvView         *view);
 133 const char     *ev_view_get_find_status   (EvView         *view);
 134
 135 /* Cursor */
 136 void           ev_view_hide_cursor        (EvView         *view);
 137 void           ev_view_show_cursor        (EvView         *view);
 138
 139 /* Navigation */
 140 void           ev_view_scroll             (EvView         *view,
 141                                            EvScrollType    scroll,
 142                                            gboolean        horizontal);
 143 void           ev_view_handle_link        (EvView         *view,
 144                                            EvLink         *link);
 145 gboolean       ev_view_next_page          (EvView         *view);
 146 gboolean       ev_view_previous_page      (EvView         *view);
 147 gchar*         ev_view_page_label_from_dest (EvView *view, EvLinkDest *dest);
 148
 149 void           ev_view_update_view_size (EvView *view, GtkScrolledWindow *scrolled_window);
 150
 151 void           ev_view_autoscroll_start   (EvView *view);
 152 void           ev_view_autoscroll_stop    (EvView *view);
 153
 154 G_END_DECLS
 155
 156 #endif /* __EV_VIEW_H__ */