]> www.fi.muni.cz Git - evince.git/blob - backend/ev-document.h
be0d1dbfedb70d2e6e912e9f674f79d5b2a51b8b
[evince.git] / 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_target)      (EvDocument   *document,
77                                          GdkDrawable  *target);
78         void        (* set_scale)       (EvDocument   *document,
79                                          double        scale);
80         void        (* set_page_offset) (EvDocument   *document,
81                                          int           x,
82                                          int           y);
83         void        (* get_page_size)   (EvDocument   *document,
84                                          int           page,
85                                          int          *width,
86                                          int          *height);
87         char      * (* get_text)        (EvDocument   *document,
88                                          GdkRectangle *rect);
89         EvLink    * (* get_link)        (EvDocument   *document,
90                                          int           x,
91                                          int           y);
92         void        (* render)          (EvDocument   *document,
93                                          int           clip_x,
94                                          int           clip_y,
95                                          int           clip_width,
96                                          int           clip_height);
97         GdkPixbuf *(* render_pixbuf)    (EvDocument   *document);
98
99
100
101 };
102
103 GType        ev_document_get_type       (void);
104 GQuark       ev_document_error_quark    (void);
105 EvPageCache *ev_document_get_page_cache (EvDocument *document);
106 GMutex      *ev_document_get_doc_mutex  (void);
107
108
109 gboolean ev_document_load            (EvDocument   *document,
110                                       const char   *uri,
111                                       GError      **error);
112 gboolean ev_document_save            (EvDocument   *document,
113                                       const char   *uri,
114                                       GError      **error);
115 char    *ev_document_get_title       (EvDocument   *document);
116 int      ev_document_get_n_pages     (EvDocument   *document);
117 void     ev_document_set_page        (EvDocument   *document,
118                                       int           page);
119 int      ev_document_get_page        (EvDocument   *document);
120 void     ev_document_set_target      (EvDocument   *document,
121                                       GdkDrawable  *target);
122 void     ev_document_set_scale       (EvDocument   *document,
123                                       double        scale);
124 void     ev_document_set_page_offset (EvDocument   *document,
125                                       int           x,
126                                       int           y);
127 void     ev_document_get_page_size   (EvDocument   *document,
128                                       int           page,
129                                       int          *width,
130                                       int          *height);
131 char    *ev_document_get_text        (EvDocument   *document,
132                                       GdkRectangle *rect);
133 EvLink  *ev_document_get_link        (EvDocument   *document,
134                                       int           x,
135                                       int           y);
136 void     ev_document_render          (EvDocument   *document,
137                                       int           clip_x,
138                                       int           clip_y,
139                                       int           clip_width,
140                                       int           clip_height);
141 /* Quick hack to test threaded rendering */
142 GdkPixbuf *ev_document_render_pixbuf   (EvDocument   *document);
143 void     ev_document_page_changed    (EvDocument *document);
144 void     ev_document_scale_changed   (EvDocument *document);
145
146 G_END_DECLS
147
148 #endif