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
  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 #define EV_TYPE_SCROLL_TYPE     (ev_scroll_type_get_type())
  39 #define EV_SCROLL_TYPE_CLASS    (g_type_class_peek (EV_TYPE_SCROLL_TYPE))
  40
  41 typedef struct _EvView       EvView;
  42 typedef struct _EvViewClass  EvViewClass;
  43
  44
  45 typedef enum {
  46         EV_SIZING_BEST_FIT,
  47         EV_SIZING_FIT_WIDTH,
  48         EV_SIZING_FREE,
  49 } EvSizingMode;
  50
  51 typedef enum {
  52         EV_VIEW_SELECTION_TEXT,
  53         EV_VIEW_SELECTION_RECTANGLE,
  54 } EvViewSelectionMode;
  55
  56 typedef enum {
  57         EV_SCROLL_PAGE_FORWARD,
  58         EV_SCROLL_PAGE_BACKWARD,
  59         EV_SCROLL_STEP_BACKWARD,
  60         EV_SCROLL_STEP_FORWARD,
  61         EV_SCROLL_STEP_DOWN,
  62         EV_SCROLL_STEP_UP,
  63 } EvScrollType;
  64
  65 GType           ev_view_get_type          (void) G_GNUC_CONST;
  66 GType           ev_sizing_mode_get_type   (void) G_GNUC_CONST;
  67 GType           ev_scroll_type_get_type   (void) G_GNUC_CONST;
  68
  69 GtkWidget*      ev_view_new               (void);
  70 void            ev_view_set_document      (EvView         *view,
  71                                            EvDocument     *document);
  72 void            ev_view_set_loading       (EvView         *view,
  73                                            gboolean        loading);
  74
  75 /* Clipboard */
  76 void            ev_view_copy              (EvView         *view);
  77 void            ev_view_select_all        (EvView         *view);
  78 gboolean        ev_view_get_has_selection (EvView         *view);
  79
  80 /* sizing and behavior */
  81 /* These are all orthoganal to each other, except 'presentation' trumps all
  82  * other behaviors
  83  */
  84 gboolean        ev_view_get_continuous    (EvView         *view);
  85 void            ev_view_set_continuous    (EvView         *view,
  86                                            gboolean        continuous);
  87 gboolean        ev_view_get_dual_page     (EvView         *view);
  88 void            ev_view_set_dual_page     (EvView         *view,
  89                                            gboolean        dual_page);
  90 void            ev_view_set_fullscreen    (EvView         *view,
  91                                            gboolean        fullscreen);
  92 gboolean        ev_view_get_fullscreen    (EvView         *view);
  93 void            ev_view_set_presentation  (EvView         *view,
  94                                            gboolean        presentation);
  95 gboolean        ev_view_get_presentation  (EvView         *view);
  96 void            ev_view_set_sizing_mode   (EvView         *view,
  97                                            EvSizingMode    mode);
  98 EvSizingMode    ev_view_get_sizing_mode   (EvView         *view);
  99
 100
 101 /* Page size */
 102 gboolean        ev_view_can_zoom_in       (EvView         *view);
 103 void            ev_view_zoom_in           (EvView         *view);
 104 gboolean        ev_view_can_zoom_out      (EvView         *view);
 105 void            ev_view_zoom_out          (EvView         *view);
 106 void            ev_view_set_zoom          (EvView         *view,
 107                                            double          factor,
 108                                            gboolean        relative);
 109 double          ev_view_get_zoom          (EvView         *view);
 110 void            ev_view_set_zoom_for_size (EvView         *view,
 111                                            int             width,
 112                                            int             height,
 113                                            int             vsb_width,
 114                                            int             hsb_height);
 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
 128 /* Status */
 129 const char     *ev_view_get_status        (EvView         *view);
 130 const char     *ev_view_get_find_status   (EvView         *view);
 131
 132 /* Cursor */
 133 void           ev_view_hide_cursor        (EvView         *view);
 134 void           ev_view_show_cursor        (EvView         *view);
 135
 136 /* Navigation */
 137 void           ev_view_scroll             (EvView         *view,
 138                                            EvScrollType    scroll,
 139                                            gboolean        horizontal);
 140 void           ev_view_handle_link        (EvView         *view,
 141                                            EvLink         *link);
 142 void           ev_view_goto_dest          (EvView         *view,
 143                                            EvLinkDest     *dest);
 144 gboolean       ev_view_next_page          (EvView         *view);
 145 gboolean       ev_view_previous_page      (EvView         *view);
 146
 147 G_END_DECLS
 148
 149 #endif /* __EV_VIEW_H__ */