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 GType           ev_view_get_type        (void) G_GNUC_CONST;
  46 GType           ev_sizing_mode_get_type (void) G_GNUC_CONST;
  47 GtkWidget*      ev_view_new             (void);
  48 void            ev_view_set_document    (EvView     *view,
  49                                          EvDocument *document);
  50
  51 /* Clipboard */
  52 void            ev_view_copy            (EvView     *view);
  53 void            ev_view_select_all      (EvView     *view);
  54
  55
  56 /* sizing and behavior */
  57 /* These are all orthoganal to each other, with the exception of 'presentation'
  58  */
  59 void ev_view_set_continuous   (EvView       *view,
  60                                gboolean      continuous);
  61 void ev_view_set_dual_page    (EvView       *view,
  62                                gboolean      dual_page);
  63 void ev_view_set_full_screen  (EvView       *view,
  64                                gboolean      full_screen);
  65 void ev_view_set_presentation (EvView       *view,
  66                                gboolean      presentation);
  67 void ev_view_set_sizing_mode  (EvView       *view,
  68                                EvSizingMode  mode);
  69
  70
  71 /* Page size */
  72 gboolean        ev_view_can_zoom_in     (EvView     *view);
  73 void            ev_view_zoom_in         (EvView     *view);
  74 gboolean        ev_view_can_zoom_out    (EvView     *view);
  75 void            ev_view_zoom_out        (EvView     *view);
  76 void            ev_view_set_zoom_for_size (EvView     *view,
  77                                            int         width,
  78                                            int         height,
  79                                            int         vsb_width,
  80                                            int         hsb_height);
  81 void            ev_view_zoom_normal     (EvView     *view);
  82 void            ev_view_set_size        (EvView     *view,
  83                                          int         width,
  84                                          int         height);
  85 void            ev_view_set_spacing     (EvView     *view,
  86                                          int         spacing);
  87 void            ev_view_set_show_border (EvView     *view,
  88                                          gboolean    show_border);
  89
  90 /* Find */
  91 gboolean        ev_view_can_find_next   (EvView     *view);
  92 void            ev_view_find_next       (EvView     *view);
  93 void            ev_view_find_previous   (EvView     *view);
  94
  95 /* Status */
  96 const char     *ev_view_get_status      (EvView     *view);
  97 const char     *ev_view_get_find_status (EvView     *view);
  98
  99 /* Cursor */
 100 void           ev_view_hide_cursor     (EvView     *view);
 101 void           ev_view_show_cursor     (EvView     *view);
 102
 103 G_END_DECLS
 104
 105 #endif /* __EV_VIEW_H__ */