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 enum {
  44         EV_ANNOTATIONS_SAVE_NONE          = 0,
  45         EV_ANNOTATIONS_SAVE_CONTENTS      = 1 << 0,
  46         EV_ANNOTATIONS_SAVE_COLOR         = 1 << 1,
  47
  48         /* Markup Annotations */
  49         EV_ANNOTATIONS_SAVE_LABEL         = 1 << 2,
  50         EV_ANNOTATIONS_SAVE_OPACITY       = 1 << 3,
  51         EV_ANNOTATIONS_SAVE_POPUP_RECT    = 1 << 4,
  52         EV_ANNOTATIONS_SAVE_POPUP_IS_OPEN = 1 << 5,
  53
  54         /* Text Annotations */
  55         EV_ANNOTATIONS_SAVE_TEXT_IS_OPEN  = 1 << 6,
  56         EV_ANNOTATIONS_SAVE_TEXT_ICON     = 1 << 7,
  57
  58         /* Attachment Annotations */
  59         EV_ANNOTATIONS_SAVE_ATTACHMENT    = 1 << 8,
  60
  61         /* Save all */
  62         EV_ANNOTATIONS_SAVE_ALL           = (1 << 9) - 1
  63 } EvAnnotationsSaveMask;
  64
  65 typedef struct _EvDocumentAnnotations          EvDocumentAnnotations;
  66 typedef struct _EvDocumentAnnotationsInterface EvDocumentAnnotationsInterface;
  67
  68 struct _EvDocumentAnnotationsInterface
  69 {
  70         GTypeInterface base_iface;
  71
  72         /* Methods  */
  73         EvMappingList *(* get_annotations)      (EvDocumentAnnotations *document_annots,
  74                                                  EvPage                *page);
  75         gboolean       (* document_is_modified) (EvDocumentAnnotations *document_annots);
  76         void           (* add_annotation)       (EvDocumentAnnotations *document_annots,
  77                                                  EvAnnotation          *annot,
  78                                                  EvRectangle           *rect);
  79         void           (* save_annotation)      (EvDocumentAnnotations *document_annots,
  80                                                  EvAnnotation          *annot,
  81                                                  EvAnnotationsSaveMask  mask);
  82 };
  83
  84 GType          ev_document_annotations_get_type             (void) G_GNUC_CONST;
  85 EvMappingList *ev_document_annotations_get_annotations      (EvDocumentAnnotations *document_annots,
  86                                                              EvPage                *page);
  87 gboolean       ev_document_annotations_document_is_modified (EvDocumentAnnotations *document_annots);
  88 void           ev_document_annotations_add_annotation       (EvDocumentAnnotations *document_annots,
  89                                                              EvAnnotation          *annot,
  90                                                              EvRectangle           *rect);
  91 void           ev_document_annotations_save_annotation      (EvDocumentAnnotations *document_annots,
  92                                                              EvAnnotation          *annot,
  93                                                              EvAnnotationsSaveMask  mask);
  94 gboolean       ev_document_annotations_can_add_annotation   (EvDocumentAnnotations *document_annots);
  95
  96 G_END_DECLS
  97
  98 #endif /* EV_DOCUMENT_ANNOTATIONS_H */
  99