File: ev-document-annotations.h

package info (click to toggle)
evince 49~alpha-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 18,232 kB
  • sloc: ansic: 72,397; xml: 324; sh: 94; makefile: 21
file content (123 lines) | stat: -rw-r--r-- 4,628 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/* ev-document-annotations.h
 *  this file is part of evince, a gnome document viewer
 *
 * Copyright (C) 2007 IƱigo Martinez <inigomartinez@gmail.com>
 *
 * Evince is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Evince is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#pragma once

#if !defined (__EV_EVINCE_DOCUMENT_H_INSIDE__) && !defined (EVINCE_COMPILATION)
#error "Only <evince-document.h> can be included directly."
#endif

#include <glib-object.h>

#include "ev-macros.h"
#include "ev-document.h"
#include "ev-annotation.h"
#include "ev-mapping-list.h"

G_BEGIN_DECLS

#define EV_TYPE_DOCUMENT_ANNOTATIONS            (ev_document_annotations_get_type ())

EV_PUBLIC
G_DECLARE_INTERFACE (EvDocumentAnnotations, ev_document_annotations, EV, DOCUMENT_ANNOTATIONS, GObject)

typedef enum {
	EV_ANNOTATIONS_SAVE_NONE             = 0,
	EV_ANNOTATIONS_SAVE_CONTENTS         = 1 << 0,
	EV_ANNOTATIONS_SAVE_COLOR            = 1 << 1,
        EV_ANNOTATIONS_SAVE_AREA             = 1 << 2,

	/* Markup Annotations */
	EV_ANNOTATIONS_SAVE_LABEL            = 1 << 3,
	EV_ANNOTATIONS_SAVE_OPACITY          = 1 << 4,
	EV_ANNOTATIONS_SAVE_POPUP_RECT       = 1 << 5,
	EV_ANNOTATIONS_SAVE_POPUP_IS_OPEN    = 1 << 6,

	/* Text Annotations */
	EV_ANNOTATIONS_SAVE_TEXT_IS_OPEN     = 1 << 7,
	EV_ANNOTATIONS_SAVE_TEXT_ICON        = 1 << 8,

	/* Attachment Annotations */
	EV_ANNOTATIONS_SAVE_ATTACHMENT       = 1 << 9,

        /* Text Markup Annotations */
        EV_ANNOTATIONS_SAVE_TEXT_MARKUP_TYPE = 1 << 10,

	/* Save all */
	EV_ANNOTATIONS_SAVE_ALL              = (1 << 11) - 1
} EvAnnotationsSaveMask;

typedef enum {
	EV_ANNOTATION_OVER_MARKUP_NOT_IMPLEMENTED = 0,
	EV_ANNOTATION_OVER_MARKUP_UNKNOWN,
	EV_ANNOTATION_OVER_MARKUP_YES,
	EV_ANNOTATION_OVER_MARKUP_NOT
} EvAnnotationsOverMarkup;

struct _EvDocumentAnnotationsInterface
{
	GTypeInterface base_iface;

	/* Methods  */
	EvMappingList *(* get_annotations)      (EvDocumentAnnotations *document_annots,
						 EvPage                *page);
	gboolean       (* document_is_modified) (EvDocumentAnnotations *document_annots);
	void           (* add_annotation)       (EvDocumentAnnotations *document_annots,
						 EvAnnotation          *annot,
						 EvRectangle           *rect);
	void           (* save_annotation)      (EvDocumentAnnotations *document_annots,
						 EvAnnotation          *annot,
						 EvAnnotationsSaveMask  mask);
	void	       (* remove_annotation)    (EvDocumentAnnotations *document_annots,
						 EvAnnotation          *annot);
	EvAnnotationsOverMarkup (* over_markup) (EvDocumentAnnotations *document_annots,
						 EvAnnotation          *annot,
						 gdouble                 x,
						 gdouble                 y);
};

EV_PUBLIC
EvMappingList *ev_document_annotations_get_annotations      (EvDocumentAnnotations *document_annots,
							     EvPage                *page);
EV_PUBLIC
gboolean       ev_document_annotations_document_is_modified (EvDocumentAnnotations *document_annots);
EV_PUBLIC
void           ev_document_annotations_add_annotation       (EvDocumentAnnotations *document_annots,
							     EvAnnotation          *annot,
							     EvRectangle           *rect);
EV_PUBLIC
void           ev_document_annotations_remove_annotation    (EvDocumentAnnotations *document_annots,
                                                             EvAnnotation          *annot);

EV_PUBLIC
void           ev_document_annotations_save_annotation      (EvDocumentAnnotations *document_annots,
							     EvAnnotation          *annot,
							     EvAnnotationsSaveMask  mask);
EV_PUBLIC
gboolean       ev_document_annotations_can_add_annotation    (EvDocumentAnnotations *document_annots);
EV_PUBLIC
gboolean       ev_document_annotations_can_remove_annotation (EvDocumentAnnotations *document_annots);
EV_PUBLIC
EvAnnotationsOverMarkup ev_document_annotations_over_markup  (EvDocumentAnnotations *document_annots,
							      EvAnnotation          *annot,
							      gdouble                x,
							      gdouble                y);

G_END_DECLS