]> www.fi.muni.cz Git - evince.git/blob - libdocument/ev-document-annotations.h
[pdf] Implement EvDocumentText interface
[evince.git] / libdocument / ev-document-annotations.h
1 /* ev-document-annotations.h
2  *  this file is part of evince, a gnome document viewer
3  *
4  * Copyright (C) 2007 IƱigo Martinez <inigomartinez@gmail.com>
5  *
6  * Evince is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Evince is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  */
20
21 #if !defined (__EV_EVINCE_DOCUMENT_H_INSIDE__) && !defined (EVINCE_COMPILATION)
22 #error "Only <evince-document.h> can be included directly."
23 #endif
24
25 #ifndef EV_DOCUMENT_ANNOTATIONS_H
26 #define EV_DOCUMENT_ANNOTATIONS_H
27
28 #include <glib-object.h>
29
30 #include "ev-document.h"
31 #include "ev-annotation.h"
32
33 G_BEGIN_DECLS
34
35 #define EV_TYPE_DOCUMENT_ANNOTATIONS            (ev_document_annotations_get_type ())
36 #define EV_DOCUMENT_ANNOTATIONS(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotations))
37 #define EV_DOCUMENT_ANNOTATIONS_IFACE(k)        (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotationsInterface))
38 #define EV_IS_DOCUMENT_ANNOTATIONS(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_ANNOTATIONS))
39 #define EV_IS_DOCUMENT_ANNOTATIONS_IFACE(k)     (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_ANNOTATIONS))
40 #define EV_DOCUMENT_ANNOTATIONS_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotationsInterface))
41
42 typedef struct _EvDocumentAnnotations          EvDocumentAnnotations;
43 typedef struct _EvDocumentAnnotationsInterface EvDocumentAnnotationsInterface;
44
45 struct _EvDocumentAnnotationsInterface
46 {
47         GTypeInterface base_iface;
48
49         /* Methods  */
50         GList *(* get_annotations)         (EvDocumentAnnotations *document_annots,
51                                             EvPage                *page);
52         void   (* annotation_set_contents) (EvDocumentAnnotations *document_annots,
53                                             EvAnnotation          *annot,
54                                             const gchar           *contents);
55 };
56
57 GType  ev_document_annotations_get_type                (void) G_GNUC_CONST;
58 GList *ev_document_annotations_get_annotations         (EvDocumentAnnotations *document_annots,
59                                                         EvPage                *page);
60
61 void   ev_document_annotations_annotation_set_contents (EvDocumentAnnotations *document_annots,
62                                                         EvAnnotation          *annot,
63                                                         const gchar           *contents);
64
65 G_END_DECLS
66
67 #endif /* EV_DOCUMENT_ANNOTATIONS_H */
68