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_TYPE_SIZING_MODE     (ev_sizing_mode_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 typedef struct _EvView       EvView;
  36 typedef struct _EvViewClass  EvViewClass;
  37
  38
  39 typedef enum {
  40         EV_SIZING_BEST_FIT,
  41         EV_SIZING_FIT_WIDTH,
  42         EV_SIZING_FREE,
  43 } EvSizingMode;
  44
  45 typedef enum {
  46         EV_SCROLL_PAGE_FORWARD,
  47         EV_SCROLL_PAGE_BACKWARD
  48 } EvScrollType;
  49
  50 GType           ev_view_get_type          (void) G_GNUC_CONST;
  51 GType           ev_sizing_mode_get_type   (void) G_GNUC_CONST;
  52 GtkWidget*      ev_view_new               (void);
  53 void            ev_view_set_document      (EvView         *view,
  54                                            EvDocument     *document);
  55
  56 /* Clipboard */
  57 void            ev_view_copy              (EvView         *view);
  58 void            ev_view_select_all        (EvView         *view);
  59
  60 /* sizing and behavior */
  61 /* These are all orthoganal to each other, except 'presentation' trumps all
  62  * other behaviors
  63  */
  64 void            ev_view_set_continuous    (EvView         *view,
  65                                            gboolean        continuous);
  66 void            ev_view_set_dual_page     (EvView         *view,
  67                                            gboolean        dual_page);
  68 void            ev_view_set_fullscreen    (EvView         *view,
  69                                            gboolean        fullscreen);
  70 gboolean        ev_view_get_fullscreen    (EvView         *view);
  71 void            ev_view_set_presentation  (EvView         *view,
  72                                            gboolean        presentation);
  73 gboolean        ev_view_get_presentation  (EvView         *view);
  74 void            ev_view_set_sizing_mode   (EvView         *view,
  75                                            EvSizingMode    mode);
  76 EvSizingMode    ev_view_get_sizing_mode   (EvView         *view);
  77
  78
  79 /* Page size */
  80 gboolean        ev_view_can_zoom_in       (EvView         *view);
  81 void            ev_view_zoom_in           (EvView         *view);
  82 gboolean        ev_view_can_zoom_out      (EvView         *view);
  83 void            ev_view_zoom_out          (EvView         *view);
  84 void            ev_view_set_zoom          (EvView         *view,
  85                                            double          factor,
  86                                            gboolean        relative);
  87 double          ev_view_get_zoom          (EvView         *view);
  88 void            ev_view_set_zoom_for_size (EvView         *view,
  89                                            int             width,
  90                                            int             height,
  91                                            int             vsb_width,
  92                                            int             hsb_height);
  93 void            ev_view_rotate_left       (EvView         *view);
  94 void            ev_view_rotate_right      (EvView         *view);
  95
  96 /* Find */
  97 gboolean        ev_view_can_find_next     (EvView         *view);
  98 void            ev_view_find_next         (EvView         *view);
  99 void            ev_view_find_previous     (EvView         *view);
 100
 101 /* Status */
 102 const char     *ev_view_get_status        (EvView         *view);
 103 const char     *ev_view_get_find_status   (EvView         *view);
 104
 105 /* Cursor */
 106 void           ev_view_hide_cursor        (EvView         *view);
 107 void           ev_view_show_cursor        (EvView         *view);
 108
 109 /* Scrolling */
 110 void           ev_view_scroll             (EvView         *view,
 111                                            EvScrollType    scroll);
 112
 113 G_END_DECLS
 114
 115 #endif /* __EV_VIEW_H__ */