backend/ev-document.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
   2 /*
   3  *  Copyright (C) 2000-2003 Marco Pesenti Gritti
   4  *
   5  *  This program is free software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation; either version 2, or (at your option)
   8  *  any later version.
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU 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  *  $Id$
  20  */
  21
  22 #ifndef EV_DOCUMENT_H
  23 #define EV_DOCUMENT_H
  24
  25 #include <glib-object.h>
  26 #include <glib.h>
  27 #include <gdk/gdk.h>
  28
  29 #include "ev-link.h"
  30
  31 G_BEGIN_DECLS
  32
  33 #define EV_TYPE_DOCUMENT            (ev_document_get_type ())
  34 #define EV_DOCUMENT(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT, EvDocument))
  35 #define EV_DOCUMENT_IFACE(k)        (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT, EvDocumentIface))
  36 #define EV_IS_DOCUMENT(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT))
  37 #define EV_IS_DOCUMENT_IFACE(k)     (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT))
  38 #define EV_DOCUMENT_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT, EvDocumentIface))
  39
  40 typedef struct _EvDocument      EvDocument;
  41 typedef struct _EvDocumentIface EvDocumentIface;
  42
  43 #define EV_DOCUMENT_ERROR ev_document_error_quark ()
  44
  45 typedef enum
  46 {
  47         EV_DOCUMENT_ERROR_INVALID,
  48         EV_DOCUMENT_ERROR_ENCRYPTED
  49 } EvDocumentError;
  50
  51 struct _EvDocumentIface
  52 {
  53         GTypeInterface base_iface;
  54
  55         /* Signals */
  56         void        (* changed)         (EvDocument *document);
  57
  58         /* Methods  */
  59         gboolean    (* load)            (EvDocument   *document,
  60                                          const char   *uri,
  61                                          GError      **error);
  62         gboolean    (* save)            (EvDocument   *document,
  63                                          const char   *uri,
  64                                          GError      **error);
  65         int         (* get_n_pages)     (EvDocument   *document);
  66         void        (* set_page)        (EvDocument   *document,
  67                                          int           page);
  68         int         (* get_page)        (EvDocument   *document);
  69         void        (* set_target)      (EvDocument   *document,
  70                                          GdkDrawable  *target);
  71         void        (* set_scale)       (EvDocument   *document,
  72                                          double        scale);
  73         void        (* set_page_offset) (EvDocument   *document,
  74                                          int           x,
  75                                          int           y);
  76         void        (* get_page_size)   (EvDocument   *document,
  77                                          int          *width,
  78                                          int          *height);
  79         char      * (* get_text)        (EvDocument   *document,
  80                                          GdkRectangle *rect);
  81         EvLink    * (* get_link)        (EvDocument   *document,
  82                                          int           x,
  83                                          int           y);
  84         void        (* render)          (EvDocument   *document,
  85                                          int           clip_x,
  86                                          int           clip_y,
  87                                          int           clip_width,
  88                                          int           clip_height);
  89
  90
  91 };
  92
  93 GType    ev_document_get_type    (void);
  94 GQuark   ev_document_error_quark (void);
  95
  96 gboolean ev_document_load            (EvDocument   *document,
  97                                       const char   *uri,
  98                                       GError      **error);
  99 gboolean ev_document_save            (EvDocument   *document,
 100                                       const char   *uri,
 101                                       GError      **error);
 102 char    *ev_document_get_title       (EvDocument   *document);
 103 int      ev_document_get_n_pages     (EvDocument   *document);
 104 void     ev_document_set_page        (EvDocument   *document,
 105                                       int           page);
 106 int      ev_document_get_page        (EvDocument   *document);
 107 void     ev_document_set_target      (EvDocument   *document,
 108                                       GdkDrawable  *target);
 109 void     ev_document_set_scale       (EvDocument   *document,
 110                                       double        scale);
 111 void     ev_document_set_page_offset (EvDocument   *document,
 112                                       int           x,
 113                                       int           y);
 114 void     ev_document_get_page_size   (EvDocument   *document,
 115                                       int          *width,
 116                                       int          *height);
 117 char    *ev_document_get_text        (EvDocument   *document,
 118                                       GdkRectangle *rect);
 119 EvLink  *ev_document_get_link        (EvDocument   *document,
 120                                       int           x,
 121                                       int           y);
 122 void     ev_document_render          (EvDocument   *document,
 123                                       int           clip_x,
 124                                       int           clip_y,
 125                                       int           clip_width,
 126                                       int           clip_height);
 127 void     ev_document_changed         (EvDocument *document);
 128
 129 G_END_DECLS
 130
 131 #endif