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
|
from pathlib import Path
from fpdf import FPDF
from fpdf.actions import GoToAction, GoToRemoteAction, LaunchAction, NamedAction
from fpdf.enums import AnnotationName
from fpdf.syntax import DestinationXYZ
from test.conftest import assert_pdf_equal, EPOCH, LOREM_IPSUM
HERE = Path(__file__).resolve().parent
def test_text_annotation(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=12)
all_visible_flags = (
"PRINT",
"NO_ZOOM",
"NO_ROTATE",
"READ_ONLY",
"LOCKED",
"TOGGLE_NO_VIEW",
"LOCKED_CONTENTS",
)
for i, flags in enumerate((("PRINT",), all_visible_flags)):
for j, flag in enumerate(flags):
pdf.text(x=15 + 50 * i, y=10 + 5 * j, text=flag)
for j, name in enumerate(
(None,)
+ tuple(AnnotationName.__members__.keys())
+ tuple(AnnotationName.__members__.values())
):
pdf.text_annotation(
x=20 + 50 * i,
y=50 + 15 * j,
text=f"This is a {name or 'default'} annotation.",
name=name,
flags=flags,
)
assert_pdf_equal(pdf, HERE / "text_annotation.pdf", tmp_path)
def test_named_actions(tmp_path):
pdf = FPDF()
pdf.set_font("Helvetica", size=24)
pdf.add_page()
pdf.text(x=80, y=140, text="First page")
pdf.add_page()
pdf.underline = True
for x, y, named_action in (
(40, 80, "NextPage"),
(120, 80, "PrevPage"),
(40, 200, "FirstPage"),
(120, 200, "LastPage"),
):
pdf.text(x=x, y=y, text=named_action)
pdf.add_action(
NamedAction(named_action),
x=x,
y=y - pdf.font_size,
w=pdf.get_string_width(named_action),
h=pdf.font_size,
)
pdf.underline = False
pdf.add_page()
pdf.text(x=80, y=140, text="Last page")
assert_pdf_equal(pdf, HERE / "named_actions.pdf", tmp_path)
def test_goto_action(tmp_path):
pdf = FPDF()
pdf.set_font("Helvetica", size=24)
pdf.add_page()
x, y, text = 80, 140, "GoTo action"
pdf.text(x=x, y=y, text=text)
pdf.add_action(
GoToAction(dest=DestinationXYZ(page=2, top=pdf.h_pt)),
x=x,
y=y - pdf.font_size,
w=pdf.get_string_width(text),
h=pdf.font_size,
)
pdf.add_page()
pdf.text(x=80, y=140, text="Page 2")
assert_pdf_equal(pdf, HERE / "goto_action.pdf", tmp_path)
def test_goto_remote_action(tmp_path):
pdf = FPDF()
pdf.set_font("Helvetica", size=24)
pdf.add_page()
x, y, text = 80, 140, "GoTo-Remote action"
pdf.text(x=x, y=y, text=text)
dest = DestinationXYZ(page=1, top=pdf.h_pt)
pdf.add_action(
GoToRemoteAction("goto_action.pdf", dest=dest),
x=x,
y=y - pdf.font_size,
w=pdf.get_string_width(text),
h=pdf.font_size,
)
assert_pdf_equal(pdf, HERE / "goto_remote_action.pdf", tmp_path)
def test_launch_action(tmp_path):
pdf = FPDF()
pdf.set_font("Helvetica", size=24)
pdf.add_page()
x, y, text = 80, 140, "Launch action"
pdf.text(x=x, y=y, text=text)
pdf.add_action(
LaunchAction(file="goto_action.pdf"),
x=x,
y=y - pdf.font_size,
w=pdf.get_string_width(text),
h=pdf.font_size,
)
assert_pdf_equal(pdf, HERE / "launch_action.pdf", tmp_path)
def test_highlighted(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=24)
with pdf.highlight("Highlight comment", type="Squiggly", modification_time=EPOCH):
pdf.text(50, 50, "Line 1")
pdf.set_y(50)
pdf.multi_cell(w=30, text="Line 2")
pdf.cell(w=60, text="Not highlighted", border=1)
assert_pdf_equal(pdf, HERE / "highlighted.pdf", tmp_path)
def test_highlighted_over_page_break(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("helvetica", size=24)
pdf.write(text=LOREM_IPSUM)
pdf.ln()
with pdf.highlight("Comment", title="Freddy Mercury", modification_time=EPOCH):
pdf.write(text=LOREM_IPSUM)
assert_pdf_equal(pdf, HERE / "highlighted_over_page_break.pdf", tmp_path)
def test_ink_annotation(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=24)
pdf.text(50, 50, "Some text")
pdf.ink_annotation(
[(40, 50), (70, 25), (100, 50), (70, 75), (40, 50)],
title="Lucas",
text="Hello world!",
)
assert_pdf_equal(pdf, HERE / "ink_annotation.pdf", tmp_path)
def test_free_text_annotation_all_parameters(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=24)
pdf.text(x=50, y=50, text="Some text.")
pdf.set_font_size(12)
pdf.set_draw_color(255, 0, 0)
pdf.free_text_annotation(
x=100,
y=130,
text="This is a free text annotation.",
w=150,
h=15,
)
assert_pdf_equal(pdf, HERE / "free_text_annotation_all_parameters.pdf", tmp_path)
def test_free_text_annotation_text_parameter(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=24)
pdf.text(x=50, y=50, text="Some text.")
pdf.set_font_size(12)
pdf.free_text_annotation(text="This is a free text annotation.")
assert_pdf_equal(pdf, HERE / "free_text_annotation_text_parameter.pdf", tmp_path)
def test_free_text_annotation_width_parameter(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=24)
pdf.text(x=50, y=50, text="Some text.")
pdf.set_font_size(12)
pdf.free_text_annotation(text="This is a free text annotation.", w=80)
assert_pdf_equal(pdf, HERE / "free_text_annotation_width_parameter.pdf", tmp_path)
|
