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
  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 typedef enum {
  53         EV_SCROLL_PAGE_FORWARD,
  54         EV_SCROLL_PAGE_BACKWARD
  55 } EvScrollType;
  56
  57 GType           ev_view_get_type          (void) G_GNUC_CONST;
  58 GType           ev_sizing_mode_get_type   (void) G_GNUC_CONST;
  59 GtkWidget*      ev_view_new               (void);
  60 void            ev_view_set_document      (EvView         *view,
  61                                            EvDocument     *document);
  62
  63 /* Clipboard */
  64 void            ev_view_copy              (EvView         *view);
  65 void            ev_view_select_all        (EvView         *view);
  66
  67 /* sizing and behavior */
  68 /* These are all orthoganal to each other, except 'presentation' trumps all
  69  * other behaviors
  70  */
  71 gboolean        ev_view_get_continuous    (EvView         *view);
  72 void            ev_view_set_continuous    (EvView         *view,
  73                                            gboolean        continuous);
  74 gboolean        ev_view_get_dual_page     (EvView         *view);
  75 void            ev_view_set_dual_page     (EvView         *view,
  76                                            gboolean        dual_page);
  77 void            ev_view_set_fullscreen    (EvView         *view,
  78                                            gboolean        fullscreen);
  79 gboolean        ev_view_get_fullscreen    (EvView         *view);
  80 void            ev_view_set_presentation  (EvView         *view,
  81                                            gboolean        presentation);
  82 gboolean        ev_view_get_presentation  (EvView         *view);
  83 void            ev_view_set_sizing_mode   (EvView         *view,
  84                                            EvSizingMode    mode);
  85 EvSizingMode    ev_view_get_sizing_mode   (EvView         *view);
  86
  87
  88 /* Page size */
  89 gboolean        ev_view_can_zoom_in       (EvView         *view);
  90 void            ev_view_zoom_in           (EvView         *view);
  91 gboolean        ev_view_can_zoom_out      (EvView         *view);
  92 void            ev_view_zoom_out          (EvView         *view);
  93 void            ev_view_set_zoom          (EvView         *view,
  94                                            double          factor,
  95                                            gboolean        relative);
  96 double          ev_view_get_zoom          (EvView         *view);
  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 void            ev_view_rotate_left       (EvView         *view);
 103 void            ev_view_rotate_right      (EvView         *view);
 104 void            ev_view_set_rotation      (EvView         *view,
 105                                            int             rotation);
 106 int             ev_view_get_rotation      (EvView         *view);
 107
 108 /* Find */
 109 gboolean        ev_view_can_find_next     (EvView         *view);
 110 void            ev_view_find_next         (EvView         *view);
 111 void            ev_view_find_previous     (EvView         *view);
 112
 113 /* Status */
 114 const char     *ev_view_get_status        (EvView         *view);
 115 const char     *ev_view_get_find_status   (EvView         *view);
 116
 117 /* Cursor */
 118 void           ev_view_hide_cursor        (EvView         *view);
 119 void           ev_view_show_cursor        (EvView         *view);
 120
 121 /* Scrolling */
 122 void           ev_view_scroll             (EvView         *view,
 123                                            EvScrollType    scroll);
 124
 125 G_END_DECLS
 126
 127 #endif /* __EV_VIEW_H__ */