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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/* ev-annotation.h
* this file is part of evince, a gnome document viewer
*
* Copyright (C) 2009 Carlos Garcia Campos <carlosgc@gnome.org>
* 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-document.h"
#include "ev-attachment.h"
#include "ev-macros.h"
G_BEGIN_DECLS
/* EvAnnotation */
#define EV_TYPE_ANNOTATION (ev_annotation_get_type())
#define EV_ANNOTATION(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION, EvAnnotation))
#define EV_ANNOTATION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION, EvAnnotationClass))
#define EV_IS_ANNOTATION(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION))
#define EV_IS_ANNOTATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION))
#define EV_ANNOTATION_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION, EvAnnotationClass))
/* EvAnnotationMarkup */
#define EV_TYPE_ANNOTATION_MARKUP (ev_annotation_markup_get_type ())
#define EV_ANNOTATION_MARKUP(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkup))
#define EV_ANNOTATION_MARKUP_IFACE(k) (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkupInterface))
#define EV_IS_ANNOTATION_MARKUP(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_ANNOTATION_MARKUP))
#define EV_IS_ANNOTATION_MARKUP_IFACE(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_ANNOTATION_MARKUP))
#define EV_ANNOTATION_MARKUP_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_ANNOTATION_MARKUP, EvAnnotationMarkupInterface))
/* EvAnnotationText */
#define EV_TYPE_ANNOTATION_TEXT (ev_annotation_text_get_type())
#define EV_ANNOTATION_TEXT(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION_TEXT, EvAnnotationText))
#define EV_ANNOTATION_TEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION_TEXT, EvAnnotationTextClass))
#define EV_IS_ANNOTATION_TEXT(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION_TEXT))
#define EV_IS_ANNOTATION_TEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION_TEXT))
#define EV_ANNOTATION_TEXT_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION_TEXT, EvAnnotationTextClass))
/* EvAnnotationAttachment */
#define EV_TYPE_ANNOTATION_ATTACHMENT (ev_annotation_attachment_get_type())
#define EV_ANNOTATION_ATTACHMENT(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachment))
#define EV_ANNOTATION_ATTACHMENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachmentClass))
#define EV_IS_ANNOTATION_ATTACHMENT(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ANNOTATION_ATTACHMENT))
#define EV_IS_ANNOTATION_ATTACHMENT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ANNOTATION_ATTACHMENT))
#define EV_ANNOTATION_ATTACHMENT_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ANNOTATION_ATTACHMENT, EvAnnotationAttachmentClass))
/* EvAnnotationTextMarkup */
#define EV_TYPE_ANNOTATION_TEXT_MARKUP (ev_annotation_text_markup_get_type ())
#define EV_ANNOTATION_TEXT_MARKUP(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), EV_TYPE_ANNOTATION_TEXT_MARKUP, EvAnnotationTextMarkup))
#define EV_ANNOTATION_TEXT_MARKUP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), EV_TYPE_ANNOTATION_TEXT_MARKUP, EvAnnotationTextMarkupClass))
#define EV_IS_ANNOTATION_TEXT_MARKUP(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), EV_TYPE_ANNOTATION_TEXT_MARKUP))
#define EV_IS_ANNOTATION_TEXT_MARKUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EV_TYPE_ANNOTATION_TEXT_MARKUP))
#define EV_ANNOTATION_TEXT_MARKUP_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), EV_TYPE_ANNOTATION_TEXT_MARKUP, EvAnnotationTextMarkupClass))
typedef struct _EvAnnotation EvAnnotation;
typedef struct _EvAnnotationClass EvAnnotationClass;
typedef struct _EvAnnotationMarkup EvAnnotationMarkup;
typedef struct _EvAnnotationMarkupInterface EvAnnotationMarkupInterface;
typedef struct _EvAnnotationText EvAnnotationText;
typedef struct _EvAnnotationTextClass EvAnnotationTextClass;
typedef struct _EvAnnotationAttachment EvAnnotationAttachment;
typedef struct _EvAnnotationAttachmentClass EvAnnotationAttachmentClass;
typedef struct _EvAnnotationTextMarkup EvAnnotationTextMarkup;
typedef struct _EvAnnotationTextMarkupClass EvAnnotationTextMarkupClass;
typedef enum {
EV_ANNOTATION_TYPE_UNKNOWN,
EV_ANNOTATION_TYPE_TEXT,
EV_ANNOTATION_TYPE_ATTACHMENT,
EV_ANNOTATION_TYPE_TEXT_MARKUP
} EvAnnotationType;
typedef enum {
EV_ANNOTATION_TEXT_ICON_NOTE,
EV_ANNOTATION_TEXT_ICON_COMMENT,
EV_ANNOTATION_TEXT_ICON_KEY,
EV_ANNOTATION_TEXT_ICON_HELP,
EV_ANNOTATION_TEXT_ICON_NEW_PARAGRAPH,
EV_ANNOTATION_TEXT_ICON_PARAGRAPH,
EV_ANNOTATION_TEXT_ICON_INSERT,
EV_ANNOTATION_TEXT_ICON_CROSS,
EV_ANNOTATION_TEXT_ICON_CIRCLE,
EV_ANNOTATION_TEXT_ICON_UNKNOWN
} EvAnnotationTextIcon;
typedef enum {
EV_ANNOTATION_TEXT_MARKUP_HIGHLIGHT,
EV_ANNOTATION_TEXT_MARKUP_STRIKE_OUT,
EV_ANNOTATION_TEXT_MARKUP_UNDERLINE,
EV_ANNOTATION_TEXT_MARKUP_SQUIGGLY
} EvAnnotationTextMarkupType;
#define EV_ANNOTATION_DEFAULT_COLOR ((const GdkRGBA) { 1., 1., 0, 1.});
/* EvAnnotation */
EV_PUBLIC
GType ev_annotation_get_type (void) G_GNUC_CONST;
EV_PUBLIC
EvAnnotationType ev_annotation_get_annotation_type (EvAnnotation *annot);
EV_PUBLIC
EvPage *ev_annotation_get_page (EvAnnotation *annot);
EV_PUBLIC
guint ev_annotation_get_page_index (EvAnnotation *annot);
EV_PUBLIC
gboolean ev_annotation_equal (EvAnnotation *annot,
EvAnnotation *other);
EV_PUBLIC
const gchar *ev_annotation_get_contents (EvAnnotation *annot);
EV_PUBLIC
gboolean ev_annotation_set_contents (EvAnnotation *annot,
const gchar *contents);
EV_PUBLIC
const gchar *ev_annotation_get_name (EvAnnotation *annot);
EV_PUBLIC
gboolean ev_annotation_set_name (EvAnnotation *annot,
const gchar *name);
EV_PUBLIC
const gchar *ev_annotation_get_modified (EvAnnotation *annot);
EV_PUBLIC
gboolean ev_annotation_set_modified (EvAnnotation *annot,
const gchar *modified);
EV_PUBLIC
gboolean ev_annotation_set_modified_from_time_t (EvAnnotation *annot,
time_t utime);
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
EV_DEPRECATED_FOR(ev_annotaion_set_modified_from_time_t)
EV_PUBLIC
gboolean ev_annotation_set_modified_from_time (EvAnnotation *annot,
GTime utime);
EV_DEPRECATED_FOR(ev_annotaion_get_rgba)
EV_PUBLIC
void ev_annotation_get_color (EvAnnotation *annot,
GdkColor *color);
EV_DEPRECATED_FOR(ev_annotaion_set_rgba)
EV_PUBLIC
gboolean ev_annotation_set_color (EvAnnotation *annot,
const GdkColor *color);
G_GNUC_END_IGNORE_DEPRECATIONS
EV_PUBLIC
void ev_annotation_get_rgba (EvAnnotation *annot,
GdkRGBA *rgba);
EV_PUBLIC
gboolean ev_annotation_set_rgba (EvAnnotation *annot,
const GdkRGBA *rgba);
EV_PUBLIC
void ev_annotation_get_area (EvAnnotation *annot,
EvRectangle *area);
EV_PUBLIC
gboolean ev_annotation_set_area (EvAnnotation *annot,
const EvRectangle *area);
/* EvAnnotationMarkup */
EV_PUBLIC
GType ev_annotation_markup_get_type (void) G_GNUC_CONST;
EV_PUBLIC
const gchar *ev_annotation_markup_get_label (EvAnnotationMarkup *markup);
EV_PUBLIC
gboolean ev_annotation_markup_set_label (EvAnnotationMarkup *markup,
const gchar *label);
EV_PUBLIC
gdouble ev_annotation_markup_get_opacity (EvAnnotationMarkup *markup);
EV_PUBLIC
gboolean ev_annotation_markup_set_opacity (EvAnnotationMarkup *markup,
gdouble opacity);
EV_PUBLIC
gboolean ev_annotation_markup_can_have_popup (EvAnnotationMarkup *markup);
EV_PUBLIC
gboolean ev_annotation_markup_has_popup (EvAnnotationMarkup *markup);
EV_PUBLIC
gboolean ev_annotation_markup_set_has_popup (EvAnnotationMarkup *markup,
gboolean has_popup);
EV_PUBLIC
void ev_annotation_markup_get_rectangle (EvAnnotationMarkup *markup,
EvRectangle *ev_rect);
EV_PUBLIC
gboolean ev_annotation_markup_set_rectangle (EvAnnotationMarkup *markup,
const EvRectangle *ev_rect);
EV_PUBLIC
gboolean ev_annotation_markup_get_popup_is_open (EvAnnotationMarkup *markup);
EV_PUBLIC
gboolean ev_annotation_markup_set_popup_is_open (EvAnnotationMarkup *markup,
gboolean is_open);
/* EvAnnotationText */
EV_PUBLIC
GType ev_annotation_text_get_type (void) G_GNUC_CONST;
EV_PUBLIC
EvAnnotation *ev_annotation_text_new (EvPage *page);
EV_PUBLIC
EvAnnotationTextIcon ev_annotation_text_get_icon (EvAnnotationText *text);
EV_PUBLIC
gboolean ev_annotation_text_set_icon (EvAnnotationText *text,
EvAnnotationTextIcon icon);
EV_PUBLIC
gboolean ev_annotation_text_get_is_open (EvAnnotationText *text);
EV_PUBLIC
gboolean ev_annotation_text_set_is_open (EvAnnotationText *text,
gboolean is_open);
/* EvAnnotationAttachment */
EV_PUBLIC
GType ev_annotation_attachment_get_type (void) G_GNUC_CONST;
EV_PUBLIC
EvAnnotation *ev_annotation_attachment_new (EvPage *page,
EvAttachment *attachment);
EV_PUBLIC
EvAttachment *ev_annotation_attachment_get_attachment (EvAnnotationAttachment *annot);
EV_PUBLIC
gboolean ev_annotation_attachment_set_attachment (EvAnnotationAttachment *annot,
EvAttachment *attachment);
/* EvAnnotationTextMarkup */
EV_PUBLIC
GType ev_annotation_text_markup_get_type (void) G_GNUC_CONST;
EV_PUBLIC
EvAnnotation *ev_annotation_text_markup_highlight_new (EvPage *page);
EV_PUBLIC
EvAnnotation *ev_annotation_text_markup_strike_out_new (EvPage *page);
EV_PUBLIC
EvAnnotation *ev_annotation_text_markup_underline_new (EvPage *page);
EV_PUBLIC
EvAnnotation *ev_annotation_text_markup_squiggly_new (EvPage *page);
EV_PUBLIC
EvAnnotationTextMarkupType ev_annotation_text_markup_get_markup_type (EvAnnotationTextMarkup *annot);
EV_PUBLIC
gboolean ev_annotation_text_markup_set_markup_type (EvAnnotationTextMarkup *annot,
EvAnnotationTextMarkupType markup_type);
G_END_DECLS
|
