File: pps-annotation.h

package info (click to toggle)
papers 49.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 21,044 kB
  • sloc: ansic: 37,728; sh: 197; xml: 127; makefile: 113
file content (252 lines) | stat: -rw-r--r-- 9,537 bytes parent folder | download | duplicates (2)
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
// SPDX-License-Identifier: GPL-2.0-or-later
/* pps-annotation.h
 *  this file is part of papers, a gnome document viewer
 *
 * Copyright (C) 2009 Carlos Garcia Campos <carlosgc@gnome.org>
 * Copyright (C) 2007 IƱigo Martinez <inigomartinez@gmail.com>
 */

#pragma once

#if !defined(__PPS_PAPERS_DOCUMENT_H_INSIDE__) && !defined(PAPERS_COMPILATION)
#error "Only <papers-document.h> can be included directly."
#endif

#include <gdk/gdk.h>
#include <glib-object.h>

#include "pps-attachment.h"
#include "pps-document.h"
#include "pps-macros.h"

G_BEGIN_DECLS

/* PpsAnnotation */
#define PPS_TYPE_ANNOTATION (pps_annotation_get_type ())
PPS_PUBLIC
G_DECLARE_DERIVABLE_TYPE (PpsAnnotation, pps_annotation, PPS, ANNOTATION, GObject);

struct _PpsAnnotationClass {
	GObjectClass parent_class;
};

/* PpsAnnotationMarkup */
#define PPS_TYPE_ANNOTATION_MARKUP (pps_annotation_markup_get_type ())

PPS_PUBLIC
G_DECLARE_DERIVABLE_TYPE (PpsAnnotationMarkup, pps_annotation_markup, PPS, ANNOTATION_MARKUP, PpsAnnotation);

struct _PpsAnnotationMarkupClass {
	PpsAnnotationClass parent_class;
};

/* PpsAnnotationText */
#define PPS_TYPE_ANNOTATION_TEXT (pps_annotation_text_get_type ())
PPS_PUBLIC
G_DECLARE_FINAL_TYPE (PpsAnnotationText, pps_annotation_text, PPS, ANNOTATION_TEXT, PpsAnnotation);

/* PpsAnnotationStamp */
#define PPS_TYPE_ANNOTATION_STAMP (pps_annotation_stamp_get_type ())
PPS_PUBLIC
G_DECLARE_FINAL_TYPE (PpsAnnotationStamp, pps_annotation_stamp, PPS, ANNOTATION_STAMP, PpsAnnotation);

/* PpsAnnotationFreeText */
#define PPS_TYPE_ANNOTATION_FREE_TEXT (pps_annotation_free_text_get_type ())
PPS_PUBLIC
G_DECLARE_FINAL_TYPE (
    PpsAnnotationFreeText, pps_annotation_free_text, PPS, ANNOTATION_FREE_TEXT, PpsAnnotation);

/* PpsAnnotationAttachment */
#define PPS_TYPE_ANNOTATION_ATTACHMENT (pps_annotation_attachment_get_type ())
PPS_PUBLIC
G_DECLARE_FINAL_TYPE (PpsAnnotationAttachment, pps_annotation_attachment, PPS, ANNOTATION_ATTACHMENT, PpsAnnotation);

/* PpsAnnotationTextMarkup */
#define PPS_TYPE_ANNOTATION_TEXT_MARKUP (pps_annotation_text_markup_get_type ())
PPS_PUBLIC
G_DECLARE_FINAL_TYPE (PpsAnnotationTextMarkup, pps_annotation_text_markup, PPS, ANNOTATION_TEXT_MARKUP, PpsAnnotation);

typedef enum {
	PPS_ANNOTATION_TYPE_UNKNOWN,
	PPS_ANNOTATION_TYPE_TEXT,
	PPS_ANNOTATION_TYPE_FREE_TEXT,
	PPS_ANNOTATION_TYPE_ATTACHMENT,
	PPS_ANNOTATION_TYPE_TEXT_MARKUP,
	PPS_ANNOTATION_TYPE_STAMP
} PpsAnnotationType;

typedef enum {
	PPS_ANNOTATION_TEXT_ICON_NOTE,
	PPS_ANNOTATION_TEXT_ICON_COMMENT,
	PPS_ANNOTATION_TEXT_ICON_KEY,
	PPS_ANNOTATION_TEXT_ICON_HELP,
	PPS_ANNOTATION_TEXT_ICON_NEW_PARAGRAPH,
	PPS_ANNOTATION_TEXT_ICON_PARAGRAPH,
	PPS_ANNOTATION_TEXT_ICON_INSERT,
	PPS_ANNOTATION_TEXT_ICON_CROSS,
	PPS_ANNOTATION_TEXT_ICON_CIRCLE,
	PPS_ANNOTATION_TEXT_ICON_UNKNOWN
} PpsAnnotationTextIcon;

typedef enum {
	PPS_ANNOTATION_TEXT_MARKUP_HIGHLIGHT,
	PPS_ANNOTATION_TEXT_MARKUP_STRIKE_OUT,
	PPS_ANNOTATION_TEXT_MARKUP_UNDERLINE,
	PPS_ANNOTATION_TEXT_MARKUP_SQUIGGLY
} PpsAnnotationTextMarkupType;

/* yellow-4 (#f5c211) from libadwaita */
#define PPS_ANNOTATION_DEFAULT_COLOR ((const GdkRGBA) { 0.960784, 0.760784, 0.066666, 1. });

/* PpsAnnotation */
PPS_PUBLIC
PpsAnnotationType pps_annotation_get_annotation_type (PpsAnnotation *annot);
PPS_PUBLIC
PpsPage *pps_annotation_get_page (PpsAnnotation *annot);
PPS_PUBLIC
guint pps_annotation_get_page_index (PpsAnnotation *annot);
PPS_PUBLIC
gboolean pps_annotation_equal (PpsAnnotation *annot,
                               PpsAnnotation *other);
PPS_PUBLIC
const gchar *pps_annotation_get_contents (PpsAnnotation *annot);
PPS_PUBLIC
gboolean pps_annotation_set_contents (PpsAnnotation *annot,
                                      const gchar *contents);
PPS_PUBLIC
const gchar *pps_annotation_get_name (PpsAnnotation *annot);
PPS_PUBLIC
gboolean pps_annotation_set_name (PpsAnnotation *annot,
                                  const gchar *name);
PPS_PUBLIC
const gchar *pps_annotation_get_modified (PpsAnnotation *annot);
PPS_PUBLIC
gboolean pps_annotation_set_modified (PpsAnnotation *annot,
                                      const gchar *modified);
PPS_PUBLIC
gboolean pps_annotation_set_hidden (PpsAnnotation *annot,
                                    const gboolean hidden);
PPS_PUBLIC
gboolean pps_annotation_get_hidden (PpsAnnotation *annot);
PPS_PUBLIC
gboolean pps_annotation_set_border_width (PpsAnnotation *annot,
                                          const gdouble width);
PPS_PUBLIC
gdouble pps_annotation_get_border_width (PpsAnnotation *annot);
PPS_PUBLIC
gboolean pps_annotation_set_modified_from_time_t (PpsAnnotation *annot,
                                                  time_t utime);
PPS_PUBLIC
void pps_annotation_get_rgba (PpsAnnotation *annot,
                              GdkRGBA *rgba);
PPS_PUBLIC
gboolean pps_annotation_set_rgba (PpsAnnotation *annot,
                                  const GdkRGBA *rgba);
PPS_PUBLIC
void pps_annotation_get_area (PpsAnnotation *annot,
                              PpsRectangle *area);
PPS_PUBLIC
gboolean pps_annotation_set_area (PpsAnnotation *annot,
                                  const PpsRectangle *area);

/* Undo */
PPS_PUBLIC
void pps_annotation_get_value_last_property (PpsAnnotation *annot, GValue *value);

/* PpsAnnotationMarkup */
PPS_PUBLIC
const gchar *pps_annotation_markup_get_label (PpsAnnotationMarkup *markup);
PPS_PUBLIC
gboolean pps_annotation_markup_set_label (PpsAnnotationMarkup *markup,
                                          const gchar *label);
PPS_PUBLIC
gdouble pps_annotation_markup_get_opacity (PpsAnnotationMarkup *markup);
PPS_PUBLIC
gboolean pps_annotation_markup_set_opacity (PpsAnnotationMarkup *markup,
                                            gdouble opacity);
PPS_PUBLIC
gboolean pps_annotation_markup_can_have_popup (PpsAnnotationMarkup *markup);
PPS_PUBLIC
gboolean pps_annotation_markup_has_popup (PpsAnnotationMarkup *markup);
PPS_PUBLIC
gboolean pps_annotation_markup_set_has_popup (PpsAnnotationMarkup *markup,
                                              gboolean has_popup);
PPS_PUBLIC
void pps_annotation_markup_get_rectangle (PpsAnnotationMarkup *markup,
                                          PpsRectangle *pps_rect);
PPS_PUBLIC
gboolean pps_annotation_markup_set_rectangle (PpsAnnotationMarkup *markup,
                                              const PpsRectangle *pps_rect);
PPS_PUBLIC
gboolean pps_annotation_markup_get_popup_is_open (PpsAnnotationMarkup *markup);
PPS_PUBLIC
gboolean pps_annotation_markup_set_popup_is_open (PpsAnnotationMarkup *markup,
                                                  gboolean is_open);

/* PpsAnnotationText */
PPS_PUBLIC
PpsAnnotation *pps_annotation_text_new (PpsPage *page);
PPS_PUBLIC
PpsAnnotationTextIcon pps_annotation_text_get_icon (PpsAnnotationText *text);
PPS_PUBLIC
gboolean pps_annotation_text_set_icon (PpsAnnotationText *text,
                                       PpsAnnotationTextIcon icon);
PPS_PUBLIC
gboolean pps_annotation_text_get_is_open (PpsAnnotationText *text);
PPS_PUBLIC
gboolean pps_annotation_text_set_is_open (PpsAnnotationText *text,
                                          gboolean is_open);

/* PpsAnnotationStamp */
PPS_PUBLIC
PpsAnnotation *pps_annotation_stamp_new (PpsPage *page);
PPS_PUBLIC
void pps_annotation_stamp_set_surface (PpsAnnotationStamp *stamp, cairo_surface_t *surface);
PPS_PUBLIC
cairo_surface_t *pps_annotation_stamp_get_surface (PpsAnnotationStamp *stamp);

/* PpsAnnotationFreeText */
PPS_PUBLIC
PpsAnnotation *pps_annotation_free_text_new (PpsPage *page);
PPS_PUBLIC
gboolean pps_annotation_free_text_set_font_description (PpsAnnotationFreeText *annot,
                                                        const PangoFontDescription *font_desc);
PPS_PUBLIC
PangoFontDescription *pps_annotation_free_text_get_font_description (PpsAnnotationFreeText *annot);
PPS_PUBLIC
gboolean pps_annotation_free_text_set_font_rgba (PpsAnnotationFreeText *annot,
                                                 const GdkRGBA *rgba);
PPS_PUBLIC
GdkRGBA *pps_annotation_free_text_get_font_rgba (PpsAnnotationFreeText *annot);
PPS_PUBLIC
void pps_annotation_free_text_auto_resize (PpsAnnotationFreeText *annot,
                                           PangoContext *ctx);

/* PpsAnnotationAttachment */
PPS_PUBLIC
PpsAnnotation *pps_annotation_attachment_new (PpsPage *page,
                                              PpsAttachment *attachment);
PPS_PUBLIC
PpsAttachment *pps_annotation_attachment_get_attachment (PpsAnnotationAttachment *annot);
PPS_PUBLIC
gboolean pps_annotation_attachment_set_attachment (PpsAnnotationAttachment *annot,
                                                   PpsAttachment *attachment);

/* PpsAnnotationTextMarkup */
PPS_PUBLIC
PpsAnnotation *pps_annotation_text_markup_new (PpsPage *page, PpsAnnotationTextMarkupType markup_type);
PPS_PUBLIC
PpsAnnotation *pps_annotation_text_markup_highlight_new (PpsPage *page);
PPS_PUBLIC
PpsAnnotation *pps_annotation_text_markup_strike_out_new (PpsPage *page);
PPS_PUBLIC
PpsAnnotation *pps_annotation_text_markup_underline_new (PpsPage *page);
PPS_PUBLIC
PpsAnnotation *pps_annotation_text_markup_squiggly_new (PpsPage *page);
PPS_PUBLIC
PpsAnnotationTextMarkupType pps_annotation_text_markup_get_markup_type (PpsAnnotationTextMarkup *annot);
PPS_PUBLIC
gboolean pps_annotation_text_markup_set_markup_type (PpsAnnotationTextMarkup *annot,
                                                     PpsAnnotationTextMarkupType markup_type);

G_END_DECLS