libdocument/ev-annotation.h

   1 /* ev-annotation.h
   2  *  this file is part of evince, a gnome document viewer
   3  *
   4  * Copyright (C) 2009 Carlos Garcia Campos <carlosgc@gnome.org>
   5  * Copyright (C) 2007 Iñigo Martinez <inigomartinez@gmail.com>
   6  *
   7  * Evince is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * Evince is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  */
  21
  22 #if !defined (__EV_EVINCE_DOCUMENT_H_INSIDE__) && !defined (EVINCE_COMPILATION)
  23 #error "Only <evince-document.h> can be included directly."
  24 #endif
  25
  26 #ifndef EV_ANNOTATION_H
  27 #define EV_ANNOTATION_H
  28
  29 #include <glib-object.h>
  30
  31 #include "ev-document.h"
  32 #include "ev-attachment.h"
  33
  34 G_BEGIN_DECLS
  35
  36 /* EvAnnotation */
  37 #define EV_TYPE_ANNOTATION                      (ev_annotation_get_type())
  38 #define EV_ANNOTATION(object)                   (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION, EvAnnotation))
  39 #define EV_ANNOTATION_CLASS(klass)              (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION, EvAnnotationClass))
  40 #define EV_IS_ANNOTATION(object)                (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION))
  41 #define EV_IS_ANNOTATION_CLASS(klass)           (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION))
  42 #define EV_ANNOTATION_GET_CLASS(object)         (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION, EvAnnotationClass))
  43
  44 /* EvAnnotationMarkup */
  45 #define EV_TYPE_ANNOTATION_MARKUP               (ev_annotation_markup_get_type ())
  46 #define EV_ANNOTATION_MARKUP(o)                 (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkup))
  47 #define EV_ANNOTATION_MARKUP_IFACE(k)           (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkupIface))
  48 #define EV_IS_ANNOTATION_MARKUP(o)              (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_ANNOTATION_MARKUP))
  49 #define EV_IS_ANNOTATION_MARKUP_IFACE(k)        (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_ANNOTATION_MARKUP))
  50 #define EV_ANNOTATION_MARKUP_GET_IFACE(inst)    (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkupIface))
  51
  52 /* EvAnnotationText */
  53 #define EV_TYPE_ANNOTATION_TEXT                 (ev_annotation_text_get_type())
  54 #define EV_ANNOTATION_TEXT(object)              (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION_TEXT, EvAnnotationText))
  55 #define EV_ANNOTATION_TEXT_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION_TEXT, EvAnnotationTextClass))
  56 #define EV_IS_ANNOTATION_TEXT(object)           (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION_TEXT))
  57 #define EV_IS_ANNOTATION_TEXT_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION_TEXT))
  58 #define EV_ANNOTATION_TEXT_GET_CLASS(object)    (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION_TEXT, EvAnnotationTextClass))
  59
  60 /* EvAnnotationText */
  61 #define EV_TYPE_ANNOTATION_ATTACHMENT              (ev_annotation_attachment_get_type())
  62 #define EV_ANNOTATION_ATTACHMENT(object)           (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachment))
  63 #define EV_ANNOTATION_ATTACHMENT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachmentClass))
  64 #define EV_IS_ANNOTATION_ATTACHMENT(object)        (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION_ATTACHMENT))
  65 #define EV_IS_ANNOTATION_ATTACHMENT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION_ATTACHMENT))
  66 #define EV_ANNOTATION_ATTACHMENT_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachmentClass))
  67
  68 typedef struct _EvAnnotation                EvAnnotation;
  69 typedef struct _EvAnnotationClass           EvAnnotationClass;
  70
  71 typedef struct _EvAnnotationMarkup          EvAnnotationMarkup;
  72 typedef struct _EvAnnotationMarkupIface     EvAnnotationMarkupIface;
  73
  74 typedef struct _EvAnnotationText            EvAnnotationText;
  75 typedef struct _EvAnnotationTextClass       EvAnnotationTextClass;
  76
  77 typedef struct _EvAnnotationAttachment      EvAnnotationAttachment;
  78 typedef struct _EvAnnotationAttachmentClass EvAnnotationAttachmentClass;
  79
  80 struct _EvAnnotation
  81 {
  82         GObject parent;
  83
  84         EvPage  *page;
  85         gboolean changed;
  86
  87         gchar   *contents;
  88         gchar   *name;
  89         gchar   *modified;
  90         GdkColor color;
  91
  92 };
  93
  94 struct _EvAnnotationClass
  95 {
  96         GObjectClass parent_class;
  97 };
  98
  99 struct _EvAnnotationMarkupIface
 100 {
 101         GTypeInterface base_iface;
 102 };
 103
 104 struct _EvAnnotationText
 105 {
 106         EvAnnotation parent;
 107
 108         gboolean is_open : 1;
 109 };
 110
 111 struct _EvAnnotationTextClass
 112 {
 113         EvAnnotationClass parent_class;
 114 };
 115
 116 struct _EvAnnotationAttachment
 117 {
 118         EvAnnotation parent;
 119
 120         EvAttachment *attachment;
 121 };
 122
 123 struct _EvAnnotationAttachmentClass
 124 {
 125         EvAnnotationClass parent_class;
 126 };
 127
 128 /* EvAnnotation */
 129 GType         ev_annotation_get_type             (void) G_GNUC_CONST;
 130
 131 /* EvAnnotationMarkup */
 132 GType         ev_annotation_markup_get_type      (void) G_GNUC_CONST;
 133 gchar        *ev_annotation_markup_get_label     (EvAnnotationMarkup *markup);
 134 void          ev_annotation_markup_set_label     (EvAnnotationMarkup *markup,
 135                                                   const gchar        *label);
 136 gdouble       ev_annotation_markup_get_opacity   (EvAnnotationMarkup *markup);
 137 void          ev_annotation_markup_set_opacity   (EvAnnotationMarkup *markup,
 138                                                   gdouble             opacity);
 139 gboolean      ev_annotation_markup_has_popup     (EvAnnotationMarkup *markup);
 140 void          ev_annotation_markup_get_rectangle (EvAnnotationMarkup *markup,
 141                                                   EvRectangle        *ev_rect);
 142 gboolean      ev_annotation_markup_get_is_open   (EvAnnotationMarkup *markup);
 143 void          ev_annotation_markup_set_is_open   (EvAnnotationMarkup *markup,
 144                                                   gboolean            is_open);
 145
 146 /* EvAnnotationText */
 147 GType         ev_annotation_text_get_type        (void) G_GNUC_CONST;
 148 EvAnnotation *ev_annotation_text_new             (EvPage             *page);
 149
 150 /* EvAnnotationText */
 151 GType         ev_annotation_attachment_get_type  (void) G_GNUC_CONST;
 152 EvAnnotation *ev_annotation_attachment_new       (EvPage             *page,
 153                                                   EvAttachment       *attachment);
 154
 155 G_END_DECLS
 156
 157 #endif /* EV_ANNOTATION_H */