libdocument/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 #include <cairo.h>
  29
  30 #include "ev-link.h"
  31 #include "ev-document-info.h"
  32 #include "ev-render-context.h"
  33
  34 G_BEGIN_DECLS
  35
  36 #define EV_TYPE_DOCUMENT            (ev_document_get_type ())
  37 #define EV_DOCUMENT(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT, EvDocument))
  38 #define EV_DOCUMENT_IFACE(k)        (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT, EvDocumentIface))
  39 #define EV_IS_DOCUMENT(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT))
  40 #define EV_IS_DOCUMENT_IFACE(k)     (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT))
  41 #define EV_DOCUMENT_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT, EvDocumentIface))
  42
  43 typedef struct _EvDocument        EvDocument;
  44 typedef struct _EvDocumentIface   EvDocumentIface;
  45 typedef struct _EvPageCache       EvPageCache;
  46 typedef struct _EvPageCacheClass  EvPageCacheClass;
  47
  48 #define EV_DOCUMENT_ERROR ev_document_error_quark ()
  49 #define EV_DOC_MUTEX_LOCK (ev_document_doc_mutex_lock ())
  50 #define EV_DOC_MUTEX_UNLOCK (ev_document_doc_mutex_unlock ())
  51
  52 typedef enum
  53 {
  54         EV_DOCUMENT_ERROR_INVALID,
  55         EV_DOCUMENT_ERROR_ENCRYPTED
  56 } EvDocumentError;
  57
  58 typedef struct {
  59         double x;
  60         double y;
  61 } EvPoint;
  62
  63 typedef struct {
  64         double x1;
  65         double y1;
  66         double x2;
  67         double y2;
  68 } EvRectangle;
  69
  70 struct _EvDocumentIface
  71 {
  72         GTypeInterface base_iface;
  73
  74         /* Methods  */
  75         gboolean          (* load)            (EvDocument      *document,
  76                                                const char      *uri,
  77                                                GError         **error);
  78         gboolean          (* save)            (EvDocument      *document,
  79                                                const char      *uri,
  80                                                GError         **error);
  81         int               (* get_n_pages)     (EvDocument      *document);
  82         void              (* get_page_size)   (EvDocument      *document,
  83                                                int              page,
  84                                                double          *width,
  85                                                double          *height);
  86         char            * (* get_page_label)  (EvDocument      *document,
  87                                                int              page);
  88         gboolean          (* can_get_text)    (EvDocument      *document);
  89         char            * (* get_text)        (EvDocument      *document,
  90                                                int              page,
  91                                                EvRectangle     *rect);
  92         gboolean          (* has_attachments) (EvDocument      *document);
  93         GList           * (* get_attachments) (EvDocument      *document);
  94         cairo_surface_t * (* render)          (EvDocument      *document,
  95                                                EvRenderContext *rc);
  96         EvDocumentInfo *  (* get_info)        (EvDocument      *document);
  97 };
  98
  99 GType            ev_document_get_type         (void) G_GNUC_CONST;
 100 GQuark           ev_document_error_quark      (void);
 101
 102 /* Document mutex */
 103 GMutex          *ev_document_get_doc_mutex    (void);
 104 void             ev_document_doc_mutex_lock   (void);
 105 void             ev_document_doc_mutex_unlock (void);
 106
 107 /* FontConfig mutex */
 108 GMutex          *ev_document_get_fc_mutex     (void);
 109 void             ev_document_fc_mutex_lock    (void);
 110 void             ev_document_fc_mutex_unlock  (void);
 111
 112 EvDocumentInfo  *ev_document_get_info         (EvDocument      *document);
 113 gboolean         ev_document_load             (EvDocument      *document,
 114                                                const char      *uri,
 115                                                GError         **error);
 116 gboolean         ev_document_save             (EvDocument      *document,
 117                                                const char      *uri,
 118                                                GError         **error);
 119 int              ev_document_get_n_pages      (EvDocument      *document);
 120 void             ev_document_get_page_size    (EvDocument      *document,
 121                                                int              page,
 122                                                double          *width,
 123                                                double          *height);
 124 char            *ev_document_get_page_label   (EvDocument      *document,
 125                                                int              page);
 126 gboolean         ev_document_can_get_text     (EvDocument      *document);
 127 char            *ev_document_get_text         (EvDocument      *document,
 128                                                int              page,
 129                                                EvRectangle     *rect);
 130 gboolean         ev_document_has_attachments  (EvDocument      *document);
 131 GList           *ev_document_get_attachments  (EvDocument      *document);
 132 cairo_surface_t *ev_document_render           (EvDocument      *document,
 133                                                EvRenderContext *rc);
 134
 135 gint            ev_rect_cmp                   (EvRectangle    *a,
 136                                                EvRectangle    *b);
 137 G_END_DECLS
 138
 139 #endif /* EV_DOCUMENT_H */