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 #include "ev-document-info.h"
  31
  32 G_BEGIN_DECLS
  33
  34 #define EV_TYPE_DOCUMENT            (ev_document_get_type ())
  35 #define EV_DOCUMENT(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT, EvDocument))
  36 #define EV_DOCUMENT_IFACE(k)        (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT, EvDocumentIface))
  37 #define EV_IS_DOCUMENT(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT))
  38 #define EV_IS_DOCUMENT_IFACE(k)     (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT))
  39 #define EV_DOCUMENT_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT, EvDocumentIface))
  40
  41 typedef struct _EvDocument        EvDocument;
  42 typedef struct _EvDocumentIface   EvDocumentIface;
  43 typedef struct _EvPageCache       EvPageCache;
  44 typedef struct _EvPageCacheClass  EvPageCacheClass;
  45
  46
  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 enum
  59 {
  60         EV_ORIENTATION_PORTRAIT,
  61         EV_ORIENTATION_LANDSCAPE,
  62         EV_ORIENTATION_UPSIDEDOWN,
  63         EV_ORIENTATION_SEASCAPE
  64 } EvOrientation;
  65
  66 typedef struct {
  67         double x1;
  68         double y1;
  69         double x2;
  70         double y2;
  71 } EvRectangle;
  72
  73 struct _EvDocumentIface
  74 {
  75         GTypeInterface base_iface;
  76
  77         /* Methods  */
  78         gboolean         (* load)            (EvDocument   *document,
  79                                               const char   *uri,
  80                                               GError      **error);
  81         gboolean         (* save)            (EvDocument   *document,
  82                                               const char   *uri,
  83                                               GError      **error);
  84         int              (* get_n_pages)     (EvDocument   *document);
  85         void             (* get_page_size)   (EvDocument   *document,
  86                                               int           page,
  87                                               double       *width,
  88                                               double       *height);
  89         char           * (* get_page_label)  (EvDocument   *document,
  90                                               int           page);
  91         gboolean         (* can_get_text)    (EvDocument   *document);
  92         char           * (* get_text)        (EvDocument   *document,
  93                                               int           page,
  94                                               EvRectangle  *rect);
  95         GList          * (* get_links)       (EvDocument   *document,
  96                                               int           page);
  97         GdkPixbuf      * (* render_pixbuf)   (EvDocument   *document,
  98                                               int           page,
  99                                               double        scale);
 100         EvOrientation    (* get_orientation) (EvDocument   *document);
 101         void             (* set_orientation) (EvDocument   *document,
 102                                               EvOrientation orientation);
 103         EvDocumentInfo * (* get_info)        (EvDocument   *document);
 104 };
 105
 106 GType           ev_document_get_type       (void);
 107 GQuark          ev_document_error_quark    (void);
 108 GMutex         *ev_document_get_doc_mutex  (void);
 109 void            ev_document_doc_mutex_lock (void);
 110 void            ev_document_doc_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 GList          *ev_document_get_links       (EvDocument     *document,
 131                                              int             page);
 132 GdkPixbuf      *ev_document_render_pixbuf   (EvDocument     *document,
 133                                              int             page,
 134                                              double          scale);
 135 EvOrientation   ev_document_get_orientation (EvDocument     *document);
 136 void            ev_document_set_orientation (EvDocument     *document,
 137                                              EvOrientation   orientation);
 138
 139 G_END_DECLS
 140
 141 #endif