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 typedef struct _EvPageCache       EvPageCache;
  43 typedef struct _EvPageCacheClass  EvPageCacheClass;
  44
  45 #include "ev-page-cache.h"
  46
  47
  48 #define EV_DOCUMENT_ERROR ev_document_error_quark ()
  49 #define EV_DOC_MUTEX (ev_document_get_doc_mutex ())
  50
  51 typedef enum
  52 {
  53         EV_DOCUMENT_ERROR_INVALID,
  54         EV_DOCUMENT_ERROR_ENCRYPTED
  55 } EvDocumentError;
  56
  57 struct _EvDocumentIface
  58 {
  59         GTypeInterface base_iface;
  60
  61         /* Signals */
  62         void        (* page_changed)    (EvDocument *document);
  63         void        (* scale_changed)    (EvDocument *document);
  64
  65         /* Methods  */
  66         gboolean    (* load)            (EvDocument   *document,
  67                                          const char   *uri,
  68                                          GError      **error);
  69         gboolean    (* save)            (EvDocument   *document,
  70                                          const char   *uri,
  71                                          GError      **error);
  72         int         (* get_n_pages)     (EvDocument   *document);
  73         void        (* set_page)        (EvDocument   *document,
  74                                          int           page);
  75         int         (* get_page)        (EvDocument   *document);
  76         void        (* set_scale)       (EvDocument   *document,
  77                                          double        scale);
  78         void        (* get_page_size)   (EvDocument   *document,
  79                                          int           page,
  80                                          int          *width,
  81                                          int          *height);
  82         char      * (* get_text)        (EvDocument   *document,
  83                                          GdkRectangle *rect);
  84         EvLink    * (* get_link)        (EvDocument   *document,
  85                                          int           x,
  86                                          int           y);
  87         GList     * (* get_links)       (EvDocument   *document);
  88         GdkPixbuf * (* render_pixbuf)   (EvDocument   *document);
  89 };
  90
  91 GType        ev_document_get_type       (void);
  92 GQuark       ev_document_error_quark    (void);
  93 EvPageCache *ev_document_get_page_cache (EvDocument *document);
  94 GMutex      *ev_document_get_doc_mutex  (void);
  95
  96
  97 gboolean   ev_document_load          (EvDocument    *document,
  98                                       const char    *uri,
  99                                       GError       **error);
 100 gboolean   ev_document_save          (EvDocument    *document,
 101                                       const char    *uri,
 102                                       GError       **error);
 103 char      *ev_document_get_title     (EvDocument    *document);
 104 int        ev_document_get_n_pages   (EvDocument    *document);
 105 void       ev_document_set_page      (EvDocument    *document,
 106                                       int            page);
 107 int        ev_document_get_page      (EvDocument    *document);
 108 void       ev_document_set_scale     (EvDocument    *document,
 109                                       double         scale);
 110 void       ev_document_get_page_size (EvDocument    *document,
 111                                       int            page,
 112                                       int           *width,
 113                                       int           *height);
 114 char      *ev_document_get_text      (EvDocument    *document,
 115                                       GdkRectangle  *rect);
 116 EvLink    *ev_document_get_link      (EvDocument    *document,
 117                                       int            x,
 118                                       int            y);
 119 GList     *ev_document_get_links     (EvDocument    *document);
 120 GdkPixbuf *ev_document_render_pixbuf (EvDocument    *document);
 121
 122
 123 G_END_DECLS
 124
 125 #endif