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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
from pathlib import Path
from fpdf import FPDF
from test.conftest import assert_pdf_equal
import pytest
HERE = Path(__file__).resolve().parent
def test_hyperlinks(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("helvetica", size=24)
pdf.y = 50
pdf.cell(
text="Link from FPDF.cell()",
center=True,
link="https://github.com/py-pdf/fpdf2",
)
pdf.set_xy(60, 100)
pdf.write_html('<a href="https://py-pdf.github.io/fpdf2/">Link defined as HTML</a>')
text = "Link set over an arbitrary area with FPDF.link()"
x, y = 20, 150
pdf.text(x=x, y=y, text=text)
width = pdf.get_string_width(text)
pdf.link(
x=x,
y=y - pdf.font_size,
w=width,
h=pdf.font_size,
link="https://github.com/py-pdf/fpdf2/discussions",
)
assert_pdf_equal(pdf, HERE / "hyperlinks.pdf", tmp_path)
def test_link_alt_text(tmp_path):
"""
It can be tested that the reference file for this test
has the link description read out loud by the NVDA screen reader
when opened with Adobe Acrobat Reader.
"""
pdf = FPDF()
pdf.add_page()
pdf.set_font("helvetica", size=24)
text = "py-pdf/fpdf2"
pdf.text(x=80, y=150, text=text)
width = pdf.get_string_width(text)
line_height = 10
pdf.link(
x=80,
y=150 - line_height,
w=width,
h=line_height,
link="https://github.com/py-pdf/fpdf2",
alt_text="GitHub repository of the fpdf2 library",
)
assert_pdf_equal(pdf, HERE / "link_alt_text.pdf", tmp_path)
def test_link_with_zoom_and_shift(tmp_path):
pdf = FPDF()
pdf.set_font("helvetica", size=24)
pdf.add_page()
link = pdf.add_link()
pdf.set_link(link, page=2, x=pdf.epw / 4, y=pdf.epw / 3, zoom=4)
pdf.set_xy(30, 50)
pdf.cell(
w=140,
h=10,
text="Link to 2nd page zoomed & shifted",
border=1,
align="C",
link=link,
)
pdf.add_page()
pdf.multi_cell(
pdf.epw,
text="Lorem ipsum dolor sit amet, consectetur adipiscing elit,"
" sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
" Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
" Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur."
" Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
)
# Drawing Adobe Reader viewport after clicking on the link,
# with the right panel open. The initial zoom level does not matter.
pdf.set_draw_color(r=255, g=0, b=0)
pdf.rect(x=pdf.epw / 4, y=pdf.epw / 3, w=53.5, h=31)
assert_pdf_equal(pdf, HERE / "link_with_zoom_and_shift.pdf", tmp_path)
def test_link_border(tmp_path):
"Acrobat renders this border it but not Sumatra"
pdf = FPDF()
pdf.add_page()
pdf.set_font("Helvetica", size=24)
text = "https://github.com/py-pdf/fpdf2"
height = 10
x, y = 50, 150
pdf.text(x=x, y=y, text=text)
pdf.link(
x=x,
y=y - height,
w=pdf.get_string_width(text),
h=height,
link="https://github.com/py-pdf/fpdf2",
border_width=4,
)
assert_pdf_equal(pdf, HERE / "link_border.pdf", tmp_path)
def test_inserting_same_page_link_twice(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.link(
x=pdf.l_margin,
y=pdf.t_margin,
w=pdf.epw,
h=pdf.eph,
link=pdf.add_link(page=2),
)
pdf.add_page()
pdf.link(
x=pdf.l_margin,
y=pdf.t_margin,
w=pdf.epw,
h=pdf.eph,
link=pdf.add_link(page=2),
)
assert_pdf_equal(pdf, HERE / "inserting_same_page_link_twice.pdf", tmp_path)
def test_inserting_link_to_non_existing_page():
pdf = FPDF()
pdf.add_page()
pdf.link(
x=pdf.l_margin,
y=pdf.t_margin,
w=pdf.epw,
h=pdf.eph,
link=pdf.add_link(page=2),
)
with pytest.raises(ValueError):
pdf.output()
def test_inserting_link_with_no_page_number():
pdf = FPDF()
link = pdf.add_link()
pdf.add_page()
pdf.set_font("helvetica", size=12)
with pytest.raises(ValueError):
pdf.cell(text="Page 1", link=link)
def test_later_call_to_set_link(tmp_path): # v2.6.1 bug spotted in discussion 729
pdf = FPDF()
pdf.set_font("helvetica")
pdf.add_page() # page 1
link_to_section1 = pdf.add_link()
pdf.cell(text="Section 1", link=link_to_section1)
pdf.add_page() # page 2
pdf.set_link(link_to_section1, page=pdf.page)
pdf.cell(text="Section 1: Bla bla bla")
assert_pdf_equal(pdf, HERE / "later_call_to_set_link.pdf", tmp_path)
def test_link_to_other_document(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("helvetica", size=24)
pdf.set_xy(80, 50)
pdf.cell(
text="Link defined with FPDF.cell",
border=1,
align="C",
link="links.pdf",
)
pdf.set_y(100)
pdf.multi_cell(
w=pdf.epw,
text="Link defined with FPDF.multi_cell",
border=1,
align="C",
link="links.pdf",
)
pdf.set_y(150)
pdf.multi_cell(
w=pdf.epw,
text="Link defined with FPDF.multi_cell and markdown=True: [links.pdf](links.pdf)",
border=1,
align="C",
markdown=True,
)
pdf.set_xy(60, 200)
pdf.write_html('<a href="links.pdf">Link defined with FPDF.write_html</a>')
text = "Link defined with FPDF.link"
pdf.text(x=80, y=250, text=text)
width = pdf.get_string_width(text)
pdf.link(
x=80,
y=250 - pdf.font_size,
w=width,
h=pdf.h - 250,
link="links.pdf",
)
assert_pdf_equal(pdf, HERE / "link_to_other_document.pdf", tmp_path)
def test_internal_links(tmp_path):
pdf = FPDF()
pdf.set_font("helvetica", size=24)
pdf.add_page()
pdf.y = 100
pdf.cell(text="Page 1", center=True)
pdf.add_page()
pdf.set_xy(80, 50)
pdf.cell(
text="Link defined with FPDF.cell",
border=1,
align="C",
link=pdf.add_link(page=1),
)
pdf.set_y(100)
pdf.multi_cell(
w=pdf.epw,
text="Link defined with FPDF.multi_cell",
border=1,
align="C",
link=pdf.add_link(page=1),
)
pdf.set_y(150)
pdf.multi_cell(
w=pdf.epw,
text="Link defined with FPDF.multi_cell and markdown=True: [page 1](1)",
border=1,
align="C",
markdown=True,
)
pdf.set_xy(60, 200)
pdf.write_html('<a href="1">Link defined with FPDF.write_html</a>')
text = "Link defined with FPDF.link"
pdf.text(x=80, y=250, text=text)
width = pdf.get_string_width(text)
pdf.link(
x=80,
y=250 - pdf.font_size,
w=width,
h=pdf.h - 250,
link=pdf.add_link(page=1),
)
assert_pdf_equal(pdf, HERE / "internal_links.pdf", tmp_path)
|
