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 #include "ev-mapping-list.h"
  33
  34 G_BEGIN_DECLS
  35
  36 #define EV_TYPE_DOCUMENT_ANNOTATIONS            (ev_document_annotations_get_type ())
  37 #define EV_DOCUMENT_ANNOTATIONS(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotations))
  38 #define EV_DOCUMENT_ANNOTATIONS_IFACE(k)        (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotationsInterface))
  39 #define EV_IS_DOCUMENT_ANNOTATIONS(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_ANNOTATIONS))
  40 #define EV_IS_DOCUMENT_ANNOTATIONS_IFACE(k)     (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_ANNOTATIONS))
  41 #define EV_DOCUMENT_ANNOTATIONS_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_ANNOTATIONS, EvDocumentAnnotationsInterface))
  42
  43 typedef struct _EvDocumentAnnotations          EvDocumentAnnotations;
  44 typedef struct _EvDocumentAnnotationsInterface EvDocumentAnnotationsInterface;
  45
  46 struct _EvDocumentAnnotationsInterface
  47 {
  48         GTypeInterface base_iface;
  49
  50         /* Methods  */
  51         EvMappingList *(* get_annotations)         (EvDocumentAnnotations *document_annots,
  52                                                     EvPage                *page);
  53         void           (* annotation_set_contents) (EvDocumentAnnotations *document_annots,
  54                                                     EvAnnotation          *annot,
  55                                                     const gchar           *contents);
  56 };
  57
  58 GType          ev_document_annotations_get_type                (void) G_GNUC_CONST;
  59 EvMappingList *ev_document_annotations_get_annotations         (EvDocumentAnnotations *document_annots,
  60                                                                 EvPage                *page);
  61
  62 void           ev_document_annotations_annotation_set_contents (EvDocumentAnnotations *document_annots,
  63                                                                 EvAnnotation          *annot,
  64                                                                 const gchar           *contents);
  65
  66 G_END_DECLS
  67
  68 #endif /* EV_DOCUMENT_ANNOTATIONS_H */
  69