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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
|
% \iffalse meta-comment
%
%% File: l3pdffield.dtx
%
% Copyright (C) 2021-2024 The LaTeX Project
%
% It may be distributed and/or modified under the conditions of the
% LaTeX Project Public License (LPPL), either version 1.3c of this
% license or (at your option) any later version. The latest version
% of this license is in the file
%
% http://www.latex-project.org/lppl.txt
%
% This file is part of the "LaTeX PDF management testphase bundle" (The Work in LPPL)
% and all files in that bundle must be distributed together.
%
% -----------------------------------------------------------------------
%
% The development version of the bundle can be found at
%
% https://github.com/latex3/pdfresources
%
% for those people who are interested.
%
%<*driver>
\DocumentMetadata{}
\documentclass{l3doc}
\usepackage{array,booktabs,caption}
\usepackage{l3pdffield-testphase,tikz}
\hypersetup{pdfauthor=The LaTeX Project,
pdftitle=l3pdffield (LaTeX PDF management testphase bundle)}
\begin{document}
\DocInput{\jobname.dtx}
\end{document}
%</driver>
% \fi
% \NewDocElement[
% idxgroup=checkbox keys,
% idxtype = {checkbox key},
% printtype= \textit{checkbox key}
% ]{Checkboxkey}{checkboxkey}
% \NewDocElement[
% idxgroup=field keys,
% idxtype = {field key},
% printtype= \textit{field key}
% ]{Fieldkey}{fieldkey}
% \NewDocElement[
% idxgroup=setup keys,
% idxtype = {setup key},
% printtype= \textit{setup key}
% ]{Fieldsetupkey}{fieldsetupkey}
% \NewDocElement[
% idxgroup=annot keys,
% idxtype = {annot key},
% printtype= \textit{annot key}
% ]{Annotkey}{annotkey}%
% \providecommand\hook[1]{\texttt{#1}}
% \title{^^A
% The \pkg{l3pdffield} module\\ Commands to create form fields ^^A
% \\ \LaTeX{} PDF management testphase bundle
% }
%
% \author{^^A
% The \LaTeX{} Project\thanks
% {^^A
% E-mail:
% \href{mailto:latex-team@latex-project.org}
% {latex-team@latex-project.org}^^A
% }^^A
% }
%
% \date{Version 0.96g, released 2024-03-26}
%
% \maketitle
% \begin{documentation}
% \section{\pkg{l3pdffield} Introduction}
% The implementation of form fields in hyperref has some bugs\footnote{see for example
% \url{https://github.com/latex3/hyperref/issues/94}}. This package is a first step
% towards the goal to review and improve the code of form fields.
%
% Like the \pkg{pdfmanagement-testphase} package itself it is a temporary package:
% the definite home of the code is not yet decided, and during the development
% changes in the interfaces are possible.
%
% The package itself is currently loaded with
% \begin{verbatim}
% \usepackage{l3pdffield-testphase}
% \end{verbatim}
%
% The source code is splitted into various submodules. All code is combined in the
% sty, but the documentation is in individual PDF.
% \begin{description}
% \item[\texttt{l3pdffield}] This contains the basic commands and keys
% to create a form field.
% \item[\texttt{l3pdffield-checkbox}] The code to created checkboxes.
% \item[\texttt{l3pdffield-textfield}] The code to created text fields.
% \item[\texttt{l3pdffield-radiobutton}] The code to create radio buttons.
% \item[\texttt{l3pdffield-pushbutton}] The code to create push buttons.
% \item[\texttt{l3pdffield-choice}] The code to create choice fields (lists and drop-down/combo
% fields.
% \item[\texttt{l3pdffield-action}]
% Code related to actions, mostly submit and reset actions.
% \item[\texttt{l3pdffield-signature}] (not done yet) Code for signature fields
% \item[Form initialization] (not done yet) The |\Form| command/environment
% of \pkg{hyperref} initialize a few things like fonts
% for text fields which should be moved. It is not strictly necessary to
% have this code, most examples works without it, but in case of problems it is
% possible to do the initialization by using the \pkg{hyperref} command.
% \end{description}
%
% The code requires the new PDF management. The code makes use of
% \pkg{l3pdfxform} to create the form Xobjects of the appearances.
% This code doesn't support yet the the dvips backend.
%
% The code targets PDF~2.0. This doesn't mean that it won't work in older
% PDF versions, but it tries to implement requirements needed or recommended
% for 2.0; most importantly appearances are used by default everywhere and it
% deprecates |/NeedAppearances|.
%
% Please keep in mind
% \begin{itemize}
% \item Not every PDF viewer supports form fields or all types and features.
% \item The handling can depend on settings in the PDF viewer. In adobe reader for
% example I had to disable an option to avoid that it tries to create an appearance
% itself.
% \item Standards like pdf/A disable some features of form fields like javascript actions
% (as you typically can't change the PDF).
% \end{itemize}
%
% If \pkg{hyperref} is loaded before
% the package will suppress the deprecated |/NeedAppearances| setting. If \pkg{hyperref}
% is loaded later you should do it in the \cs{Form} options.
%
% So a typical use together with hyperref could look like this
%
% \begin{verbatim}
% \DocumentMetadata{}
% \documentclass{article}
% \usepackage{hyperref}
% \usepackage{l3pdffield-testphase}
% \begin{document}
% \Form
% \end{verbatim}
%
% \section{Some background}
%
% A document can contain a arbitrary number of fields which can be organized in trees.
% The leaf fields in such a tree, the \emph{terminal fields}, typically have
% widget annotations as kids which are then the actual, visual instances of the field,
% and allow to interact with the field. I will call such a
% tree a \emph{fieldset}, nodes \emph{fields} and the widget annotation
% \emph{field annotations}.
%
% If a field has only one child annotation the content of the field dictionary and the
% widget annotation dictionary can be merged---some examples in the PDF reference
% show such merged dictionaries---but the code here keeps them separate, at the end
% this is clearer.
%
% A simple example would look like this
%
% \begin{tikzpicture}[level 2/.style={level distance=7mm},
% level 1/.style={sibling distance=25mm},
% level 2/.style={sibling distance=15mm}]
% \node[draw] {week}
% child {node[draw] {mon}
% child {node[draw,dashed] {annot}}
% }
% child {node[draw] {tue}
% child {node[draw,dashed] {annot}}
% }
% child {node[draw] {wen}
% child {node[draw,dashed] {annot}}
% child {node[draw,dashed] {annot}}
% }
% ;
% \end{tikzpicture}
%
% In many cases a fieldset consists of only one field along with its field annotation(s),
% but larger sets can be needed to build more complex interactions with javascript code.
% For example a datepicker can be built as a fieldset with various fields to represent
% the month and year choice and to select days.
%
% Fields in a fieldset should have a name, for example |wen| or |week| in the example
% above. This name is the \emph{partial name} of the field, the \emph{full name}
% is than built from it by adding the names of the parents separated by periods.
% In the example above the partial name is \texttt{mon} and the full name
% \texttt{week.mon}.
% Partial names shouldn't contain periods. If two fields have the same name they will
% work in unison: if you enter text in one field, the text appears also in the other, such
% fields must have the same type and the same value and default value entry.
% If a field has no name it is considered to be a simple widget annotation and so
% only another representation of its parent.
%
%
% All terminal fields should also have a type, e.g. \texttt{Btn} for a button field,
% or \texttt{Tx} for a textfield. The type can be set for the parent and then inherited.
% The fields in a fieldset can have different types.
%
% \subsection{The look of a field: Appearances and other settings}
%
% The look of widget annotation of a field can be set with various keys. The keys developed over
% time and some of them superseed older ones. There is for example the simple
% |/Border|, the more sophisticated |/BS| (\enquote{border style dictionary}),
% the \enquote{dynamic appearance dictionary} |MK|, with lots of keys,
% and the appearance dictionary |/AP| which
% may define as many as three separate appearances:
% the normal appearance (required), the rollover appearance and the down appearance.
% Such an appearance can be a simple form XObjects%
% \footnote{Such form XObjects are small pictures stored in the PDF which
% can be referenced in various part of the PDF. They can be
% created with the commands of the \pkg{l3pdfxform} package.}%
% , but in some cases the annotation can have different \emph{appearance states}:
% a checkbox
% for example can be checked or unchecked, in this case the appearances
% are dictionaries which
% maps state names like |/Yes| and |/Off| to form XObjects.
%
% The annotations cover a rectangular area on
% the page and form XObjects appearances are squeezed into this rectangle.
% So for the best result
% both should have the same ratio of width and height. Simple plain backgrounds can
% also be created in large size and reused for various annotations.
% Form XObjects used as appearances can not be rotated, if needed one has to
% create a new appearance.
%
%
% In PDF 2.0 widget annotations must have at least a normal |/AP| appearance
% (unless the size of the annotation is zero) and the keys \enquote{\itshape C, IC, Border,
% BS, BE, BM, CA, ca, H, DA, Q,
% DS, LE, LL, LLE, and Sy shall be ignored}. But it is quite unclear if
% PDF Viewer honor this, and if this make sense e.g. for text fields which require
% a DA entry. It is also not clear how appearances and the entries of the MK dictionary
% are related in a form field. Tests with some PDF viewers
% are needed here.
%
% \subsection{Tagged PDF}
%
% Field annotations are (like link annotations) not part of the page stream. But
% they are obviously nevertheless meaningful content and must be consider if
% a PDF is \enquote{tagged}, that means if a structure is added.
%
% According to the PDF references fields should be tagged by adding a |Form| structure
% element containing the object reference to a field annotations. Fields with more than
% one annotation like radio buttons need a |Form| structure for every one.
% Additional some cross references to structure relevant object like the parent tree
% are needed, for more info check the documentation of the \pkg{tagpdf} package.
%
% The commands of this module already contain the needed support. So if
% \pkg{tagpdf} is used and tagging activated the fields will be added as |Form| element
% to the structure where they are created. It is possible to deactivate tagging for
% a field annotation by setting the |tag| to false as described below.
%
% If lualatex is used tagging require either that \pkg{tagpdf} is used with the
% option |global-mc|, or mc-chunks must be correctly closed manually, as the automatic
% code can't escape the grouping.
%
% It is recommended to use the |TU|/|altname| key to give the field a readable
% name.
%
%
% \section{Commands}
% \begin{function}{\pdffield_field:nn,\pdffield_field:Vn}
% \begin{syntax}
% \cs{pdffield_field:nn}\Arg{key val list}\Arg{field ID}
% \end{syntax}
% This creates a new field. \meta{field ID} will be used to create and
% reference the needed objects but it is not the direct object name, so
% |pdf_object_ref:n| can not be used to access (and there will not
% clash with object names). It is recommended to start
% the name with a module prefix to avoid name clashes, so e.g. |mymodule/field/1| or
% |mymodule/field/week|.
%
% The list of handled keys is described below.
% Typically the \meta{key val list} should at least set the name |T|, fields that
% are kids in a fieldset must set the |parent| key, this should point to a field
% declared before.
%
% The command is meant as a basic command to build more complex variants like
% checkbox or textfields. For this reason it doesn't check if
% the combination of values and flags are sensible, and it uses as key names the
% names from the PDF reference.
% If you create a button field (Btn) and set MaxLen (which is only known for text
% fields), it will not complain.
%
% Root fields (fields without parent) are added automatically to the
% Catalog/AcroForm dictionary with
%
%
% \begin{verbatim}
% \pdfmanagement_add:nne{Catalog/AcroForm}{Fields}{<obj ref>}
% \end{verbatim}
%
% \end{function}
%
% \begin{function}{\pdffield_annot:n,\pdffield_annot:V}
% \begin{syntax}
% \cs{pdffield_annot:n}\Arg{key val list}
% \end{syntax}
% This creates a new field annotation.
% It is a widget annotation box created with \cs{pdfannot_widget_box:nnn}, and
% it is possible to add values to its dictionary
% by using |\pdfannot_dict_put:nnn {widget}...|.
% But to correctly setup the parent/kid relationship some additional wrapper code is needed.
% The command also setup dictionaries to fill the |AP|, |MK| and |AA| dictionaries.
% \end{function}
%
% \begin{function}{\pdffield_annot_ref_last:}
% \begin{syntax}
% \cs{pdffield_annot_ref_last:}
% \end{syntax}
% If a tagged PDF should be created, the object
% of the annotation of a field should be referenced in the Form structure element.
% This command allows to retrieve the reference to this object.
% \end{function}
% \begin{function}{\pdffield_appearance:nn}
% \begin{syntax}
% \cs{pdffield_appearance:nn}\Arg{name}\Arg{content}
% \end{syntax}
% This is a small wrapper around \cs{pdfxform_new:nnn} (which could be used too)
% to create an appearance. To avoid name clashes \meta{name} should start with
% a module part, e.g. |mymodule/appearance/cross|.
% \end{function}
%
% \begin{function}{\pdffield_setup:n}
% \begin{syntax}
% \cs{pdffield_setup:n}\Arg{key-val}
% \end{syntax}
% This command allows to preset some field settings.
% \end{function}
% It knows currently two keys:
%
% \begin{function}{create-style}
% \begin{syntax}
% |create-style| = \Arg{name}\Arg{key-val}
% \end{syntax}
% This defines a style which can then be used with the |style| key.
% \Arg{key-val} can be an arbitrary collection of the keys of the module.
% \end{function}
%
% \begin{function}{style}
% \begin{syntax}
% |style| = \Arg{style}
% \end{syntax}
% This uses a style define with the previous |create-style|.
% \end{function}
%
% \begin{function}{preset-checkbox}
% \begin{syntax}
% |preset-checkbox|=\Arg{key-val}
% \end{syntax}
% This allows to set default keys for a checkbox.
% \end{function}
%
% \begin{function}{preset-radio}
% \begin{syntax}
% |preset-radio|=\Arg{key-val}
% \end{syntax}
% This allows to set default keys for a radio button.
% \end{function}
%
% \begin{function}{preset-textfield}
% \begin{syntax}
% |preset-textfield|=\Arg{key-val}
% \end{syntax}
% This allows to set default keys for a text field.
% \end{function}
%
% \section{Special keys}
%
% \begin{function}{value,default}
% \begin{syntax}
% |value| =\Arg{value}\\
% |default|=\Arg{value}
% \end{syntax}
% These two keys pass the value to a handler which can be redefined.
% Their exact behaviour depends on field type. Please check their documentation.
% \end{function}
%
% \section{Field Keys}
%
% Table~\ref{tab:fieldkeys} summarize the keys which can be used.
% A number of keys have two names, the second is normally the name used by hyperref.
% Where is makes sense an empty value \enquote{unsets} a key.
%
% \begin{table}
% \caption{Keys for fields}\label{tab:fieldkeys}
% \centering
% \begin{tabular}{>{\ttfamily}lllll}
% \toprule
% key & value & required & inheritable &remark\\\midrule
% parent & field ID & for non-root fields & \\
% style & style name & & defined with |create-style| \\
% T, name & string & mostly & \\
% TU, altname & string & & \\
% TM, mappingname & string & & \\
% FT & name & terminal fields & yes \\
% setFf, & list of flags & & yes\\
% setfieldflags\\
% unsetFf, & list of flags & & yes \\
% unsetfieldflags \\
% V & various & & yes \\
% DV & various & & yes \\
% MaxLen & integer & with Comb & yes & only textfields\\
% Lock & object name & & & signature field\\
% SV & object name & & & signature field\\
% Opt & object name & & & buttons and choice fields\\
% TI & integer & & & list fields\\
% I & object name& & & list fields\\
% AA/K, keystroke & javascript \\
% AA/F, format & javascript\\
% AA/V, validate & javascript\\
% AA/C, calculate & javascript\\
% DA & string & yes & yes & variable text \\
% Q & 0, 1 or 2 & & yes &variable text \\
% DS & & & & (ignored) \\
% RV & & & & (ignored) \\\bottomrule
% \end{tabular}
% \end{table}
%
% \begin{function}{parent}
% \begin{syntax}
% |parent| = \meta{field ID}\\
% \end{syntax}
% This declares the parent of the field. It is required if
% the field is not the root of the fieldset. The value is the field ID
% of the parent, the parent should have been already declared.
% It will add the reference to the parent field to the |/Parent| key, and also
% add reference of the kid as |/Kid| in the parent field.
% \end{function}
%
% \begin{function}{name,T}
% \begin{syntax}
% |name| = \meta{partial name}\\
% |T| = \meta{partial name}
% \end{syntax}
% This sets the partial name of the field. It shouldn't contain
% a period, be not empty and sensibly consist of simple ascii chars.
% It is normally required, see above. The value is passed through \cs{pdf_string_from_unicode:nnN}.
% \end{function}
%
% \begin{function}{altname,TU}
% \begin{syntax}
% |altname| = \meta{string}\\
% |TU| = \meta{string}\\
% \end{syntax}
% This sets an alternative name for user interaction.
% Unlike the name field it can use unicode or periods.
% The value is passed through \cs{pdf_string_from_unicode:nnN}
% \end{function}
%
% \begin{function}{mappingname,TM}
% \begin{syntax}
% |mappingname| = \meta{string}\\
% |TM| = \meta{string}\\
% \end{syntax}
% This sets an alternative name for the export.
% The value is passed through \cs{pdf_string_from_unicode:nnN}
% \end{function}
%
% \begin{function}{FT}
% \begin{syntax}
% |FT| = |Btn|\verb"|"|Tx|\verb"|"|Ch|\verb"|"|Sig|
% \end{syntax}
% This sets the type of the field, the value should be one of
% \texttt{Btn} (button), \texttt{Tx} (text), \texttt{Ch} (choice), \texttt{Sig} (signature).
% The value is of relevance only for terminal fields, but it can be set in a parent
% and then inherited.
% \end{function}
%
% \begin{function}{setfieldflags,setFf,unsetfieldflags,unsetFf}
% \begin{syntax}
% |setfieldflags| = \meta{comma list of flags}\\
% |setFf| = \meta{comma list of flags}\\
% |unsetfieldflags| = |all| \verb"|" \meta{comma list of flags}\\
% |unsetFf| = |all| \verb"|" \meta{comma list of flags}
% \end{syntax}
% These keys accept a list of flag names and then sets or unsets them, the resulting value
% is then used with the \texttt{/Ff} key. Depending
% on the field type some flags must be set or unset, other are optional or are ignored.
% The flag name can be given in PDF spelling (\texttt{RadiosInUnison}),
% in lowercase (\texttt{radiosinunison}), and as number. |unsetFf| and its
% alias |unsetfieldflags| know the special value |all| which clears all the fields.
%
% The list of flags are:
% |ReadOnly|, |Required|,
% |NoExport|, |Multiline|, |Password|, |NoToggleToOff|, |Radio|, |Pushbotton|,
% |Combo|, |Edit|, |Sort|, |FileSelect|, |MultiSelect|, |DoNotSpellCheck|,
% |DoNotScroll|, |Comb|, |RadiosInUnison|, |RichText|, |CommitOnSelChange|.
%
% \end{function}
%
% \begin{function}{V}
% \begin{syntax}
% |V| = \meta{various}
% \end{syntax}
% This sets the value of the field. Its
% format varies depending on the field type, so typically
% commands for the various type will have to preprocess and sanitize it.
% The value given here is x-expanded and then added to the dictionary!
% See the descriptions of individual field types for further information.
% (Pushbuttons for example don't have a value).
% \end{function}
%
% \begin{function}{DV}
% \begin{syntax}
% |DV| = \meta{various}
% \end{syntax}
% The default value, to which the field reverts
% when a reset-form action is executed. The format of this value is the
% same as that of \texttt{DV}.
% \end{function}
%
% \begin{function}{MaxLen}
% \begin{syntax}
% |MaxLen| = \meta{integer}
% \end{syntax}
% Only relevant for textfields.
% The value is an integer and describes the maximum length of the field’s text in characters.
% Required if the |Comb| flag is used.
% \end{function}
%
% \begin{function}{Lock}
% \begin{syntax}
% |MaxLen| = \meta{object name}
% \end{syntax}
% Only relevant for signature fields. The value is an object name
% which should point to a dictionary that specifies a set of form fields
% that shall be locked when this signature field is signed. The exact format of
% the dictionary is described in the PDF reference.
% \end{function}
%
% \begin{function}{SV}
% \begin{syntax}
% |SV| = \meta{object name}
% \end{syntax}
% Only relevant for signature fields. The value is an object name
% which should point to a seed value dictionary. The exact format of
% the dictionary is described in the PDF reference.
% \end{function}
%
% \begin{function}{Opt}
% \begin{syntax}
% |Opt| = \meta{object name}
% \end{syntax}
% Only relevant for checkboxes, radiobuttons and choice fields.
% The value is an object name
% which should point to a array. The exact format of
% the array is described in the PDF reference.
% \end{function}
%
% \begin{function}{TI}
% \begin{syntax}
% |TI| = \meta{integer}
% \end{syntax}
% Only relevant for scrollable list boxes.
% The value is an integer, the top index (the index in the Opt array
% of the first option visible in the list). Default value: 0
% \end{function}
%
% \begin{function}{I}
% \begin{syntax}
% |I| = \meta{object name}
% \end{syntax}
% For choice fields that allow
% multiple selection (MultiSelect flag set). The value is an object name
% which should point to a array. The exact format of
% the array is described in the PDF reference
% (I have no idea what exactly should be added there, perhaps some future test will make
% it more understandable.)
% \end{function}
%
% The following four keys are used to add javascript (\enquote{ECMAScript}) code.
% The values are expanded. It is recommended to store
% the javascript in a stream object and to pass the object reference, but passing
% a string (including parentheses) is possible too.
% The keys will be ignored if a pdfstandard
% is used that prohibits such actions.
%
% \begin{function}{AA/K,keystroke}
% \begin{syntax}
% |AA/K| = \meta{ECMAScript}\\
% |keystroke| = \meta{ECMAScript}
% \end{syntax}
% This adds a keystroke action to the
% additional action dictionary. The action is meant for text and choice fields.
% It is quite unclear if such an action
% make sense for non-terminal fields.
% \end{function}
%
% \begin{function}{AA/F,format}
% \begin{syntax}
% |AA/F| = \meta{ECMAScript}\\
% |format| = \meta{ECMAScript}
% \end{syntax}
% This adds a format action to the
% additional action dictionary. The action is meant for text and choice fields.
% It is quite unclear if such an action
% make sense for non-terminal fields.
% \end{function}
%
% \begin{function}{AA/V,validate}
% \begin{syntax}
% |AA/V| = \meta{ECMAScript}\\
% |validate| = \meta{ECMAScript}
% \end{syntax}
% This adds a validate action to the
% additional action dictionary. It is quite unclear if such an action
% make sense for non-terminal fields.
% \end{function}
%
% \begin{function}{AA/C,calculate}
% \begin{syntax}
% |AA/C| = \meta{string (ECMAScript)}\\
% |calculate| = \meta{string (ECMAScript)}
% \end{syntax}
% This adds a calculate action to the
% additional action dictionary. It is quite unclear if such an action
% make sense for non-terminal fields.
% If an calculate action is used, the field will be added to the
% AcroForm/CO array to define the calculation order. The order can
% be controlled through the following key |sortkey|.
% \end{function}
%
% \begin{function}{sortkey}
% \begin{syntax}
% |sortkey| = \meta{string}
% \end{syntax}
% This sets a sortkey for fields with calculate action.
% The sortkeys are sorted lexically with |\str_compare:nNnTF|.
% fields without sortkey will get an empty sortkey and so be at the begin,
% the order of fields with the same sortkey is not defined.
% The module only sorts fields created with the commands of this module, the
% sorting of fields created by \pkg{hyperref} is independant.
% \end{function}
%
% \begin{function}{DA}
% \begin{syntax}
% |DA| = \meta{string}
% \end{syntax}
% This contains instructions for the text in text fields.
% It is stored expanded and parentheses are added around the value.
% \end{function}
%
% \begin{function}{Q,align}
% \begin{syntax}
% |Q| = |left|\verb"|"|center|\verb"|"|right|\\
% |align| = |left|\verb"|"|center|\verb"|"|right|
% \end{syntax}
% The justification of the text.
% \end{function}
%
% \begin{function}{DS,RV}
% These two keys are currently not implemented
% as it is unclear if there are of any use.
% \end{function}
%
% \begin{function}{fieldID}
% \begin{syntax}
% |fieldID| = \meta{field ID}\\
% \end{syntax}
% \emph{For experts only!}
% This stores \meta{field ID} in an internal variable.
% The variable is not used by the basic commands,
% but by the commands to create the various field types.
% Check their documentation for use cases.
% \end{function}
% \section{Annot keys}
%
% Table~\ref{tab:annotkeys} summarize the keys which can be used.
% A number of keys have alias names which are mentioned in the descriptions.
%
% \begin{table}
% \caption{Keys for field annotations}\label{tab:annotkeys}
% \centering
% \begin{tabular}{>{\ttfamily}lllll}
% \toprule
% key & value & required &remark\\\midrule
% parent & field ID & yes \\
% width & dim expression & (yes) & default is 0pt \\
% height & dim expression & (yes) & default is 0pt \\
% depth & dim expression & (yes) & default is 0pt \\
% AP/N & appearance name & yes (in PDF 2.0) \\
% AP/R & appearance name & yes (in PDF 2.0) \\
% AP/D & appearance name & yes (in PDF 2.0) \\
% AS & name & yes (in PDF 2.0) \\
% setF & list of flags \\
% unsetF & list of flags \\
% AA/* & javascript & *= F, Bl, D, U, E, \\
% & & X, PO, PC,PV, PI\\
% MK/* & various & *= R, BC, BG, CA, RC, \\
% & & AC, I, RI, IX, IF, TP\\ \bottomrule
%
% \end{tabular}
% \end{table}
%
% \begin{function}{width,height,depth}
% \begin{syntax}
% |width| = \meta{dim expression}\\
% |height| = \meta{dim expression}\\
% |depth| = \meta{dim expression}
% \end{syntax}
% These keys allow to set the dimensions of the annotation.
% The value should be a command that expands to a dimension expression. By default
% all values are zero.
% \end{function}
%
% \begin{function}{tag}
% \begin{syntax}
% |tag| = |true|\verb+|+|false|
% \end{syntax}
% This key is related to tagging and enables/disables the tagging.
% \end{function}
%
% \begin{function}{parent}
% \begin{syntax}
% |parent| = \meta{field ID}\\
% \end{syntax}
% This sets the parent. The value should be field ID of
% an already declared field.
% \end{function}
%
% \begin{function}{AP/N,appearance,AP/R,rollover-appearance,AP/D,down-appearance}
% \begin{syntax}
% |AP/N| = \meta{appearance name}\\
% |appearance| = \meta{appearance name}\\
% |AP/R| = \meta{rollover appearance name}\\
% |rollover-appearance| = \meta{rollover appearance name}\\
% |AP/D| = \meta{down appearance name}\\
% |down appearance| = \meta{down appearance name}\\
% \end{syntax}
% This keys set the normal, rollover and down appearance. The names
% |appearance|, |rollover-appearance| and |down-appearance| are aliases.
% The value is by default a simple name of an appearance/form Xobject but
% modules like \pkg{l3pdffield-checkbox} change this to allow to add appearances for
% various states. So check the documentation for the various field types for the
% exact format of the value.
% \end{function}
%
% \begin{function}{AS}
% \begin{syntax}
% |AS| = \meta{appearance state name}
% \end{syntax}
% This key sets the default appearance state.
% The value is a name \emph{without} the starting slash
% (it is passed through |\pdf_name_from_unicode_e:n|),
% for checkbox for example |Yes|. If used it should typically have the same value
% as the V and DV key of the field.
% \end{function}
%
%\begin{function}{setannotflags,setF,unsetannotflags,unsetF}
% \begin{syntax}
% |setannotflags| = \meta{comma list of flags}\\
% |setF| = \meta{comma list of flags}\\
% |unsetannotflags| = |all| \verb"|" \meta{comma list of flags}\\
% |unsetF| = |all| \verb"|" \meta{comma list of flags}
% \end{syntax}
% These keys allow to set or unset the annot flags. They expect a comma lists of
% flag names. Allowed names |Invisible|, |Hidden|,
% |Print|, |NoZoom|,|NoRotate|, |NoView|, |ReadOnly|, |Locked|, |ToggleNoView|,
% |LockedContents|, or the lowercase variants or numbers.
% \end{function}
%
% \begin{function}{AA/*}
% \begin{syntax}
% |AA/*| = \meta{ECMAScript}
% \end{syntax}
% * should be one of |Fo|, |Bl|, |D|, |U|, |E|, |X|, |PO|, |PC|, |PV|, |PI|.
% Alias names for the first six keys are
% |onfocus|, |onblur|, |onmousedown|, |onmouseup|, |onenter|, |onexit|.
% These keys adds then the respective key to the |/AA| dictionary
% of the field annotation object.
% Their value should be javascript code. The value is expanded but not escaped.
% It is recommended to
% store the code in a stream object and to use the object reference as value.
% The |/AA| dictionary
% is suppressed if a pdf/A standard is set.
%
% For example
% \begin{verbatim}
% onenter={(app.alert('Hello');)}
% \end{verbatim}
% \end{function}
%
% The following keys add values to the \emph{dynamic appearance dictionary}
% |MK| directory. This is only relevant for
% annotations with dynamic content, like e.g. textfields.
% The settings can also affect checkboxes and radio buttons if the (deprecated)
% |NeedAppearances| is set to true.
%
% The |MK| dictionary can also be added by using |\pdfannot_dict_put:nnn{Widget}{MK}{...}|
% but the two methods should not be mixed.
%
% \begin{function}{MK/R,rotate}
% \begin{syntax}
% |MK/R| = |0| \verb"|" |90| \verb"|" |180| \verb"|" |270|\\
% |rotate| = |0| \verb"|" |90| \verb"|" |180| \verb"|" |270|
% \end{syntax}
% These rotates the content of the annotation.
% \end{function}
%
% \begin{function}{MK/BC,bordercolor}
% \begin{syntax}
% |MK/BC| = \meta{color expression} \verb"|" [\meta{model}]\Arg{values}\\
% |bordercolor| = \meta{color expression} \verb"|" [\meta{model}]\Arg{values}
% \end{syntax}
% These colors the border. Internally currently RGB is used.
% The colors used in
% \meta{color expression} must be known to the \pkg{l3color} commands.
% \end{function}
%
% \begin{function}{MK/BG,backgroundcolor}
% \begin{syntax}
% |MK/BG| = \meta{color expression} \verb"|" [\meta{model}]\Arg{values}\\
% |backgroundcolor| = \meta{color expression} \verb"|" [\meta{model}]\Arg{values}
% \end{syntax}
% These colors the background. Internally currently RGB is used.
% The colors used in
% \meta{color expression} must be known to the \pkg{l3color} commands.
% \end{function}
%
% \begin{function}{MK/CA,caption}
% \begin{syntax}
% |MK/CA| = \meta{string}\\
% |caption| = \meta{string}
% \end{syntax}
% This sets a text for the caption. \meta{string} is passed through \cs{pdf_string_from_unicode:nnN}
% and parentheses are added automatically. The font used seems to depend on
% the whims of the PDF reader: At least for checkboxes adobe reader quite insists to
% always use a symbol font and not a text font. It also shows always
% only one symbol, regardless how much one put in the string.
% hyperref uses the key names |checkboxsymbol| and
% |radiosymbol| for this setting.
% \end{function}
%
% \begin{function}{MK/RC,rollover-caption}
% \begin{syntax}
% |MK/RC| = \meta{string}\\
% |rollover-caption| = \meta{string}
% \end{syntax}
% This sets a text for the rollover-caption. \meta{string} is passed through \cs{pdf_string_from_unicode:nnN}
% and parentheses are added automatically. The key should be used only with
% pushbuttons. It is unclear if is actually used by the PDF viewer, but the
% pushbuttons modules uses the argument also to setup the appearance.
% \end{function}
%
% \begin{function}{MK/AC,down-caption}
% \begin{syntax}
% |MK/AC| = \meta{string}\\
% |down-caption| = \meta{string}
% \end{syntax}
% This sets a text for the down-caption.
% \meta{string} is passed through \cs{pdf_string_from_unicode:nnN}
% and parentheses are added automatically. The key should be used only with
% pushbuttons. It is unclear if is actually used by the PDF viewer, but the
% pushbuttons modules uses the argument also to setup the appearance.
% \end{function}
%
% The remaining key are like the two above useful for pushbuttons only.
% Currently no special syntax support
% is implemented. They will be handled if needed when the code for
% push buttons is developed and tested.
% \begin{function}{MK/I,MK/RI,MK/IX,MK/IF,MK/TP}
% \begin{syntax}
% |MK/*| = \meta{various}
% \end{syntax}
% These keys adds the various entries in the \emph{dynamic appearance dictionary}.
% * should be one of |I|, |RI|, |IX|, |IF|, |TP|.
% The |MK| dictionary can also be added by using |\pdfannot_dict_put:nnn{Widget}{MK}{...}|
% but the two methods should not be mixed.
% \end{function}
%
% \end{documentation}
%
% \begin{implementation}
% \DoNotIndex
% {
% \\
% ,\bitset_clear:N
% ,\bitset_new:Nn
% ,\bitset_set_false:Nn
% ,\bitset_set_true:Nn
% ,\bitset_to_arabic:N
% ,\bool_new:N
% ,\clist_map_inline:nn
% ,\color_export:nnN
% ,\color_set:nn
% ,\color_set:nnn
% ,\cs_new_protected:Npn
% ,\cs_set_eq:NN
% ,\cs_set_protected:Npn
% ,\cs_if_exist:NTF
% ,\cs_if_exist:NT
% ,\cs_new:Npn
% ,\csname
% ,\dim_eval:n
% ,\dim_new:N
% ,\endcsname
% ,\exp_args:Ne
% ,\exp_args:Nne
% ,\exp_args:NV
% ,\group_begin:
% ,\group_end:
% ,\hbox_to_wd:nn
% ,\hfill
% ,\hook_gput_code:nnn
% ,\int_eval:n
% ,\l_keys_choice_int
% ,\keys_define:nn
% ,\keys_set:nn
% ,\mode_leave_vertical:
% ,\msg_error:nnnn
% ,\msg_error:nne
% ,\msg_new:nnn
% ,\msg_warning:nn
% ,\msg_warning:nnn
% ,\msg_info:nnn
% ,\msg_warning:nnnnn
% ,\NeedsTeXFormat
% ,\pdf_name_from_unicode_e:n
% ,\pdf_object_if_exist:nTF
% ,\pdf_object_new:n
% ,\pdf_object_ref:n
% ,\pdf_object_ref_last:
% ,\pdf_object_unnamed_write:ne
% ,\pdf_object_write:nne
% ,\pdf_string_from_unicode:nnN
% ,\pdfannot_box_ref_last:
% ,\pdfannot_dict_put:nnn
% ,\pdfannot_dict_put:nne
% ,\pdfannot_dict_remove:nn
% ,\pdfannot_widget_box:nnn
% ,\pdfdict_if_empty:nTF
% ,\pdfdict_if_empty:nF
% ,\pdfdict_new:n
% ,\pdfdict_put:nnn
% ,\pdfdict_put:nne
% ,\pdfdict_remove:nn
% ,\pdfdict_use:n
% ,\pdfmanagement_add:nnn
% ,\pdfmanagement_add:nne
% ,\pdfmeta_standard_verify:nTF
% ,\pdfmeta_standard_verify:nT
% ,\pdfmeta_standard_verify:nF
% ,\pdfxform_if_exist:nTF
% ,\pdfxform_new:nnn
% ,\pdfxform_ref:n
% ,\ProvidesExplPackage
% ,\rule
% ,\seq_gput_right:Nn
% ,\seq_gput_right:ce
% ,\seq_if_exist:NTF
% ,\seq_if_exist:cTF
% ,\seq_new:N
% ,\seq_new:c
% ,\seq_use:Nn
% ,\seq_use:cn
% ,\str_if_empty:NTF
% ,\str_if_in:NnTF
% ,\str_if_in:NnT
% ,\str_new:N
% ,\tl_if_empty:NTF
% ,\tl_if_empty:NF
% ,\tl_if_empty:nTF
% ,\tl_if_head_eq_charcode:nNTF
% ,\tl_new:N
% ,\tl_set:Nn
% ,\tl_to_str:n
% }
% \section{\pkg{l3pdffield} Implementation}
% \begin{macrocode}
%<*package>
%<@@=pdffield>
\NeedsTeXFormat{LaTeX2e}
\ProvidesExplPackage{l3pdffield-testphase}{2024-03-26}{0.96g}%
{form fields}
% \end{macrocode}
% \subsection{hyperref specific command}
% hyperref sets NeedAppearances by default. As this is deprecated we disable this.
% \begin{macrocode}
\csname HyField@NeedAppearancesfalse\endcsname % suppress NeedAppearances
% \end{macrocode}
%
% \subsection{local variables}
%
% \begin{variable}
% {
% \l_@@_tmpa_str
% ,\l_@@_tmpb_str
% ,\l_@@_tmpa_tl
% ,\l_@@_tmpa_keys_tl
% ,\l_@@_currentparent_tl
% ,\l_@@_fieldID_tl
% ,\l_@@_caption_tl
% ,\l_@@_rollover_caption_tl
% ,\l_@@_down_caption_tl
% ,\g_@@_CO_sortkeys_prop
% ,\l_@@_CO_sortkey_str
% ,\g_@@_annot_ref_last_tl
% ,\l_@@_tag_bool
% }
% Some tmp variables, and a variable for the current parent and the
% current fieldID.
% \begin{macrocode}
\str_new:N \l_@@_tmpa_str
\str_new:N \l_@@_tmpb_str
\tl_new:N \l_@@_tmpa_tl
\tl_new:N \l_@@_tmpa_keys_tl
\tl_new:N \l_@@_currentparent_tl
\tl_new:N \l_@@_fieldID_tl
\tl_new:N \l_@@_caption_tl
\tl_new:N \l_@@_rollover_caption_tl
\tl_new:N \l_@@_down_caption_tl
\prop_new:N \g_@@_CO_sortkeys_prop
\seq_new:N \g_@@_CO_sortkeys_seq
\str_new:N \l_@@_CO_sortkey_str
\tl_new:N \g_@@_annot_ref_last_tl
\bool_new:N \l_@@_tag_bool
\bool_set_true:N \l_@@_tag_bool
% \end{macrocode}
% \end{variable}
%
% \begin{macrocode}
\cs_new_protected:Npn \@@_tmpa:n #1 {}
\cs_new_protected:Npn \@@_tmpa:nn #1 #2 {}
% \end{macrocode}
% \subsection{messages}
% \begin{macrocode}
\msg_new:nnn {pdffield}{no-period}
{
The~field~name~'#1'~contains~a~period. \\
This~is~not~allowed.
}
\msg_new:nnn {pdffield}{empty-name}
{
The~field~name~is~empty. \\
This~is~not~allowed.
}
\msg_new:nnn {pdffield}{appearance-missing}
{
The~appearance~definition~'#1'~is~missing~for~the~#2~appearance.
}
\msg_new:nnn {pdffield}{not-implemented}
{
Support~for~'/#1'~is~not~implemented\\
The~key~is~ignored.
}
\msg_new:nnn {pdffield}{key-disabled}
{
key~'#2'~is~disabled~and~ignored~in~the~'#1'~command.\\
Use~key~'#3'~instead.
}
\msg_new:nnn {pdffield}{parent-field-missing}
{
The~parent~field~'#1'~doesn't~exist\\
Create~it~with~\tl_to_str:n{\pdffield_field:nn}
}
\msg_new:nnn {pdffield}{key-ignored}
{
key~'#1'~has~no~function~and~is~ignored
}
% \end{macrocode}
% An auxiliary command to disable some keys
% \begin{macro}{\@@_key_disable:nnn}
% \begin{macrocode}
\cs_new_protected:Npn \@@_key_disable:nnn #1#2#3
{
\keys_define:nn {pdffield}
{
#2 .code:n =
{
\msg_warning:nnnnn {pdffield}{key-disabled}{#1}{#2}{#3}
}
}
}
% \end{macrocode}
% \end{macro}
% \subsection{bitsets}
% \begin{macro}{\l_@@_Ff_bitset,\l_@@_F_bitset}
% The field and the annot bitset.
% \begin{macrocode}
\bitset_new:Nn \l_@@_Ff_bitset
{
ReadOnly = 1,
Required = 2,
NoExport = 3,
Multiline = 13,%Tx
Password = 14,
NoToggleToOff = 15,%Btn, radio button
Radio = 16,%Btn: Radio: 15=1, 16=0
Pushbutton = 17,%Btn: Checkbox: 15=0, 16=0
%Btn: Pushbutton: 16=1
Combo = 18,%Ch: Combo=1 List=0
Edit = 19,%Ch, Combo=1 -> + edit field
Sort = 20,%Ch, not relevant for view...
FileSelect = 21,%Tx
MultiSelect = 22,%Ch
DoNotSpellCheck = 23,%Tx, Ch (if Combo + Edit set)
DoNotScroll = 24,%Tx
Comb = 25,%Tx, requires MaxLen in dict
RadiosInUnison = 26,%Btn Radio
RichText = 26,%Tx
CommitOnSelChange = 27,
readonly = 1,
required = 2,
noexport = 3,
multiline = 13,%Tx
password = 14,
notoggletooff = 15,%Btn, radio button
radio = 16,%Btn: Radio: 15=1, 16=0
pushbutton = 17,%Btn: Checkbox: 15=0, 16=0
%Btn: Pushbutton: 16=1
combo = 18,%Ch: Combo=1 List=0
edit = 19,%Ch, Combo=1 -> + edit field
sort = 20,%Ch, not relevant for view...
fileselect = 21,%Tx
multiselect = 22,%Ch
donotspellcheck = 23,%Tx, Ch (if Combo + Edit set)
donotscroll = 24,%Tx
comb = 25,%Tx, requires MaxLen in dict
radiosinunison = 26,%Btn Radio
richtext = 26,%Tx
commitonselchange = 27
}
\bitset_new:Nn \l_@@_F_bitset
{
Invisible = 1,
Hidden = 2,
Print = 3,
NoZoom = 4,
NoRotate = 5,
NoView = 6,
ReadOnly = 7,
Locked = 8,
ToggleNoView = 9,
LockedContents = 10,
invisible = 1,
hidden = 2,
print = 3,
nozoom = 4,
norotate = 5,
noview = 6,
readonly = 7,
locked = 8,
togglenoview = 9,
lockedcontents = 10
}
% \end{macrocode}
% \end{macro}
% \subsection{The field dictionary}
% The field dictionary is the main object.
% To be able to set values from the outside it will use a
% dictionary which can be filled by key-val.
% \begin{macrocode}
\pdfdict_new:n {l_@@/field}
\pdfdict_new:n {l_@@/field/AA}
% \end{macrocode}
% \begin{macro}{\@@_field:n,\pdffield_field:nn}
% \begin{syntax}
% \cs{@@_field:n}\Arg{field ID}
% \end{syntax}
% \begin{macrocode}
\cs_new_protected:Npn \@@_field:n #1
{
\pdf_object_new:n {@@/field/#1}
\pdf_object_new:n {@@/field/Kids/#1}
\tl_if_empty:NTF \l_@@_currentparent_tl
{
\pdfmanagement_add:nne
{ Catalog / AcroForm }
{ Fields }
{\pdf_object_ref:n {@@/field/#1} }
}
{
\exp_args:Ne
\pdf_object_if_exist:nTF {@@/field/\l_@@_currentparent_tl}
{
\pdfdict_put:nne { l_@@/field }{Parent}
{\exp_args:Ne \pdf_object_ref:n{@@/field/\l_@@_currentparent_tl}}
\seq_gput_right:ce {g_@@_field/Kids/\l_@@_currentparent_tl _seq}
{ \exp_args:Ne \pdf_object_ref:n{@@/field/#1}}
}
{
\msg_error:nne {pdffield}{parent-field-missing}{\l_@@_currentparent_tl}
}
}
\seq_new:c {g_@@_field/Kids/#1_seq}
\pdfdict_put:nne {l_@@/field}
{Kids}
{
\pdf_object_ref:n {@@/field/Kids/#1}
}
\pdfdict_put:nne {l_@@/field}
{Ff}
{\bitset_to_arabic:N \l_@@_Ff_bitset }
\pdfdict_if_empty:nF{l_@@/field/AA}
{
\pdfmeta_standard_verify:nT
{annot_widget_no_AA}
{
\pdf_object_unnamed_write:ne {dict}{\pdfdict_use:n {l_@@/field/AA}}
\pdfdict_put:nne
{l_@@/field}
{AA}
{\pdf_object_ref_last:}
\pdfdict_get:nnN {l_@@/field/AA}{C}\l_@@_tmpa_tl
\quark_if_no_value:NF \l_@@_tmpa_tl
{
\prop_gput:Nee\g_@@_CO_sortkeys_prop
{ \pdf_object_ref:n {@@/field/#1} }{ \l_@@_CO_sortkey_str }
\seq_gput_right:Ne\g_@@_CO_sortkeys_seq
{ \pdf_object_ref:n {@@/field/#1} }
}
}
}
\hook_gput_code:nnn {shipout/lastpage}{pdffield} %xetex needs this ...
{
\pdf_object_write:nne {@@/field/Kids/#1} { array }
{
\seq_use:cn{g_@@_field/Kids/#1_seq}{~}
}
}
\pdf_object_write:nne {@@/field/#1} { dict } { \pdfdict_use:n {l_@@/field} }
}
\hook_gput_code:nnn {shipout/lastpage}{pdffield}
{
\prop_if_empty:NF \g_@@_CO_sortkeys_prop
{
\seq_gsort:Nn \g_@@_CO_sortkeys_seq
{
\str_compare:eNeTF
{ \prop_item:Nn \g_@@_CO_sortkeys_prop {#1} }
>
{ \prop_item:Nn \g_@@_CO_sortkeys_prop {#2} }
{ \sort_return_swapped: }
{ \sort_return_same: }
}
\pdfmanagement_add:nne
{ Catalog / AcroForm }
{ CO }
{ \seq_use:Nn \g_@@_CO_sortkeys_seq{~} }
}
}
\cs_new_protected:Npn \pdffield_field:nn #1 #2
{
\group_begin:
\keys_set:nn { pdffield } {#1}
\@@_field:n {#2}
\group_end:
}
% \end{macrocode}
% \end{macro}
%
% \subsection{The annot dictionary}
% We assume that the annotation should really occupy space on the page and
% leave vertical mode.
%
% \begin{macro}{\@@_annot:,\pdffield_annot:n}
% The command doesn't add grouping, so should only be used inside a group.
%
% \begin{macrocode}
\cs_new_protected:Npn \@@_annot:
{
\pdfmeta_standard_verify:nF
{annot_flags}
{
\bitset_set_true:Nn \l_@@_F_bitset {Print}
\bitset_set_false:Nn \l_@@_F_bitset {Hidden}
\bitset_set_false:Nn \l_@@_F_bitset {Invisible}
\bitset_set_false:Nn \l_@@_F_bitset {NoView}
}
\pdfannot_dict_put:nne {widget}{F}{ \bitset_to_arabic:N \l_@@_F_bitset }
\@@_tag_add_struct_parent:
\tl_if_empty:NF \l_@@_currentparent_tl
{
\exp_args:Ne
\pdf_object_if_exist:nTF { @@/field/\l_@@_currentparent_tl }
{
\pdfannot_dict_put:nne {widget}{Parent}
{
\exp_args:Ne
\pdf_object_ref:n{@@/field/\l_@@_currentparent_tl}
}
}
{
\msg_error:nne { pdffield }{parent-field-missing}{\l_@@_currentparent_tl}
}
}
\mode_leave_vertical:
\@@_tag_struct_begin:
\hbox_to_wd:nn
{ \l_@@_annot_wd_dim }
{
\rule [-\l_@@_annot_dp_dim]{0pt}{\dim_eval:n{\l_@@_annot_ht_dim+\l_@@_annot_dp_dim} }
\pdfannot_widget_box:nnn
{ \l_@@_annot_wd_dim }
{ \l_@@_annot_ht_dim }
{ \l_@@_annot_dp_dim }
\hfill
}
\tl_gset:Ne \g_@@_annot_ref_last_tl { \pdfannot_box_ref_last: }
\exp_args:NV \@@_tag_add_objr:n \g_@@_annot_ref_last_tl
\@@_tag_struct_end:
\tl_if_empty:NF \l_@@_currentparent_tl
{
\seq_if_exist:cTF {g_@@_field/Kids/\l_@@_currentparent_tl _seq}
{
\seq_gput_right:ce
{g_@@_field/Kids/\l_@@_currentparent_tl _seq}
{ \g_@@_annot_ref_last_tl }
}
{
\msg_error:nne { pdffield}{parent-field-missing}{\l_@@_currentparent_tl}
}
}
}
\cs_new_protected:Npn \pdffield_annot:n #1
{
\group_begin:
\keys_set:nn { pdffield } {#1}
\@@_annot:
\group_end:
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\pdffield_annot_ref_last:}
% \begin{macrocode}
\cs_new:Npn \pdffield_annot_ref_last: { \g_@@_annot_ref_last_tl }
% \end{macrocode}
% \end{macro}
% \subsection{Tagging}
% \begin{macro}
% {
% \@@_tag_add_struct_parent:,
% \@@_tag_add_objr:n,
% \@@_tag_struct_begin:
% \@@_tag_struct_end:
% }
% \begin{macrocode}
\cs_new_protected:Npn \@@_tag_add_struct_parent: {}
\cs_new_protected:Npn \@@_tag_add_objr:n #1 {}
\cs_new_protected:Npn \@@_tag_struct_begin: {}
\cs_new_protected:Npn \@@_tag_struct_end: {}
\hook_gput_code:nnn {begindocument} { l3pdffield }
{
\cs_if_exist:NT \tag_if_active:T
{
\tag_if_active:T
{
\cs_set_protected:Npn \@@_tag_add_struct_parent:
{
\bool_if:NT \l_@@_tag_bool
{
\pdfannot_dict_put:nne {widget}{StructParent}{ \tag_struct_parent_int: }
}
}
\cs_set_protected:Npn \@@_tag_add_objr:n #1
{
\bool_if:NT \l_@@_tag_bool
{
\exp_args:Nne
\tag_struct_insert_annot:nn {#1}{ \tag_struct_parent_int: }
}
}
\cs_set_protected:Npn \@@_tag_struct_begin:
{
\bool_if:NT \l_@@_tag_bool
{
\tag_mc_end_push:
\tag_struct_begin:n{tag=Form}
}
}
\cs_set_protected:Npn \@@_tag_struct_end:
{
\bool_if:NT \l_@@_tag_bool
{
\tag_struct_end:
\tag_mc_begin_pop:n{}
}
}
}
}
}
% \end{macrocode}
% \end{macro}
% \subsection{auxiliary command for color keys}
% \begin{macro}{\@@_color_set:nn }
% \begin{macrocode}
\cs_new_protected:Npn \@@_color_set:nn #1 #2
{
\tl_if_head_eq_charcode:nNTF {#2}[ %]
{
\@@_color_set_aux:nwn { #1 } #2
}
{
\color_set:nn {#1} {#2}
}
}
\cs_new_protected:Npn \@@_color_set_aux:nwn #1 [#2] #3
{
\color_set:nnn {#1}{#2}{#3}
}
% \end{macrocode}
% \end{macro}
% \subsection{Field keys}
% The names. The main name should not be empty, it is added to the dictionary
% when the field is created. A new name means a new field.
% The other names can only be set when the field is created,
% so we put them in the field group.
% \begin{macro}{\@@_V_handler:nN}
% Values (V and DV) need different handling in the various field types. So
% it uses a handler which can be redefined locally. By default it simply stores
% the value in a tl var.
% \begin{macrocode}
\cs_new_protected:Npn \@@_V_handler:nN #1#2
{
\tl_set:Nn #2 {#1}
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{parent,T,name,TU,altname,TM,mappingname}
% \begin{macrocode}
\keys_define:nn { pdffield }
{
,parent .tl_set:N = \l_@@_currentparent_tl
,parent .groups:n = {field,annot}
,T .code:n =
{
\pdf_string_from_unicode:nnN {utf8/string-raw}{#1}\l_@@_tmpa_str
\str_if_in:NnT \l_@@_tmpa_str {.}
{
\msg_error:nne {pdffield}{no-period}{\l_@@_tmpa_str}
}
\str_if_empty:NTF\l_@@_tmpa_str
{
\msg_warning:nn {pdffield}{empty-name}
\pdfdict_remove:nn { l_@@/field }{T}
}
{
\pdfdict_put:nne { l_@@/field }{T}{(\l_@@_tmpa_str)}
}
}
,T .value_required:n = true
,T .groups:n = {field}
,name .meta:n = {T={#1}}
,name .value_required:n = true
,name .groups:n = {field}
,TU .groups:n = {field}
,TU .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn { l_@@/field }{TU}
}
{
\pdf_string_from_unicode:nnN {utf16/hex}{#1}\l_@@_tmpa_str
\pdfdict_put:nne { l_@@/field }{TU}{\l_@@_tmpa_str}
}
}
,TU .groups:n = {field}
,altname .meta:n = {TU={#1}}
,altname .groups:n = {field}
,TM .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn { l_@@/field }{TM}
}
{
\pdf_string_from_unicode:nnN {utf16/hex}{#1}\l_@@_tmpa_str
\pdfdict_put:nne { l_@@/field }{TM}{\l_@@_tmpa_str}
}
}
,TM .groups:n = {field}
,mappingname .meta:n = {TM={#1}}
,mappingname .groups:n = {field}
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{fieldID}
% For some field types we need a fieldID.
%
% \begin{macrocode}
\keys_define:nn { pdffield }
{
fieldID .tl_set:N = \l_@@_fieldID_tl
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{FT,V,DV,MaxLen,Lock,SV,Opt,TI,I}
% \begin{macrocode}
\keys_define:nn{pdffield}
{
,FT .choices:nn =
{ Btn, Tx, Ch, Sig }
{
\pdfdict_put:nnn { l_@@/field }{FT}{ /#1 }
}
,FT .groups:n = {field}
,V .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn { l_@@/field }{V}
}
{
\@@_V_handler:nN{#1}\l_@@_tmpa_str
\pdfdict_put:nne { l_@@/field }{V}{ \l_@@_tmpa_str }
}
}
,V .groups:n = {field}
,DV .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn { l_@@/field }{DV}
}
{
\@@_V_handler:nN{#1}\l_@@_tmpa_str
\pdfdict_put:nne { l_@@/field }{DV}{ \l_@@_tmpa_str }
}
}
,DV .groups:n = {field}
,MaxLen .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn { l_@@/field }{MaxLen}
}
{
\pdfdict_put:nne { l_@@/field }{MaxLen}{ #1 }
}
}
,MaxLen .groups:n = {field}
,Lock .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn { l_@@/field }{Lock}
}
{
\pdfdict_put:nne { l_@@/field }{Lock}{ \pdf_object_ref:n{#1} }
}
}
,Lock .groups:n = {field}
,SV .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn { l_@@/field }{SV}
}
{
\pdfdict_put:nne { l_@@/field }{SV}{ \pdf_object_ref:n{#1} }
}
}
,SV .groups:n = {field}
,Opt .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn { l_@@/field }{Opt}
}
{
\pdfdict_put:nne { l_@@/field }{Opt}{ \pdf_object_ref:n{#1} }
}
}
,Opt .groups:n = {field}
,TI .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn { l_@@/field }{TI}
}
{
\pdfdict_put:nne { l_@@/field }{TI}{ #1 }
}
}
,TI .groups:n = {field}
,I .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn { l_@@/field }{I}
}
{
\pdfdict_put:nne { l_@@/field }{I}{ \pdf_object_ref:n{#1} }
}
}
,I .groups:n = {field}
}
% \end{macrocode}
% \end{macro}
% Flags. We don't add lots of individual keys but map the key names directly
% \begin{macro}{setFf,setfieldflags,unsetFf,unsetfieldflags}
% \begin{macrocode}
\keys_define:nn { pdffield }
{
,setFf .code:n =
{
\clist_map_inline:nn {#1}
{
\bitset_set_true:Nn \l_@@_Ff_bitset {##1}
}
}
,setFf .groups:n = {field}
,setfieldflags .meta:n =
{setFf={#1}}
,setfieldflags .groups:n = {field}
,unsetFf .multichoice:
,unsetFf / all .code:n = { \bitset_clear:N \l_@@_Ff_bitset}
,unsetFf / unknown .code:n =
{
\bitset_set_false:Nn \l_@@_Ff_bitset {#1}
}
,unsetFf .groups:n = {field}
,unsetfieldflags .meta:n = {unsetFf={#1}}
,unsetfieldflags .groups:n = {field}
}
% \end{macrocode}
% \end{macro}
% \begin{macro}
% {
% AA/K,keystroke,AA/F,format,
% AA/V,validate,AA/C,calculate
% }
% Keys for the AA dictionary. They all trigger a javascript option.
% K=keystroke, F=format, V=validate, C=calculate
% \begin{macrocode}
\cs_set_protected:Npn \@@_tmpa:n #1 %
{
\keys_define:nn { pdffield }
{
AA/#1 .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn {l_@@/field/AA}{#1}
}
{
\pdfdict_put:nne {l_@@/field/AA}
{#1}
{<</S/JavaScript/JS\c_space_tl ##1>>}
}
},
AA/#1 .groups:n = {field}
}
}
\clist_map_inline:nn {K,F,V,C}{\@@_tmpa:n{#1}}
\cs_set_protected:Npn \@@_tmpa:nn #1 #2
{
\keys_define:nn { pdffield }
{
#1 .meta:nn =
{ pdffield }{AA/#2={##1}},
#1 .groups:n = {field}
}
}
\@@_tmpa:nn {keystroke}{K}
\@@_tmpa:nn {format} {F}
\@@_tmpa:nn {validate} {V}
\@@_tmpa:nn {calculate}{C}
\keys_define:nn {pdffield}
{
sortkey .code:n = {\str_set:Ne \l_@@_CO_sortkey_str {\tl_to_str:n{#1}}}
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{DA,Q,align,DS,RV}
% The following keys are related to textfield and their format.
% \begin{macrocode}
\keys_define:nn { pdffield }
{
DA .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfdict_remove:nn { l_@@/field }{DA}
}
{
\pdfdict_put:nne { l_@@/field }{DA}{ (#1) }
}
}
,DA .groups:n = {field}
,Q .choices:nn = {left,center,right}
{
\pdfdict_put:nne { l_@@/field }{Q}{ \int_eval:n{\l_keys_choice_int-1} }
}
,Q / .code:n = { \pdfdict_remove:nn { l_@@/field }{Q} }
,Q .groups:n = {field}
,align .meta:n={Q=#1}
,DS .code:n =
{
\msg_warning:nnn {pdffield}{not-implemented}{DS}
}
,DS .groups:n = {field}
,RV .code:n =
{
\msg_warning:nnn {pdffield}{not-implemented}{RV}
}
,RV .groups:n = {field}
}
% \end{macrocode}
% \end{macro}
% \subsection{Annotation keys}
% The size of the field annotation
% \begin{variable}
% {
% \l_@@_annot_ht_dim,
% \l_@@_annot_wd_dim,
% \l_@@_annot_dp_dim
% }
% \begin{macrocode}
\dim_new:N \l_@@_annot_ht_dim
\dim_new:N \l_@@_annot_wd_dim
\dim_new:N \l_@@_annot_dp_dim
% \end{macrocode}
% \end{variable}
% \begin{macro}{width,height,depth}
% The size of the field annotation.
% \begin{macrocode}
\keys_define:nn { pdffield }
{
,width .dim_set:N = \l_@@_annot_wd_dim
,height .dim_set:N = \l_@@_annot_ht_dim
,depth .dim_set:N = \l_@@_annot_dp_dim
,width .initial:n = 0pt
,height .initial:n = 0pt
,depth .initial:n = 0pt
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{tag}
% to disable tagging locally
% \begin{macrocode}
\keys_define:nn { pdffield }
{
,tag .bool_set:N = \l_@@_tag_bool
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{\@@_appearance_handler:nnn}
% Appearances have to be handled in various ways, so we use a handler, that
% the field types can redefine if needed.
% \begin{macrocode}
\cs_new_protected:Npn \@@_appearance_handler:nnn #1#2#3
{
\pdfxform_if_exist:nTF { #1 }
{
\pdfannot_dict_put:nne {widget/AP}{#2}
{
\pdfxform_ref:n {#1}
}
}
{
\msg_error:nnnn{pdffield}{appearance-missing}{#1}{#3}
}
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{AS,AP/N,appearance,AP/R,rollover-appearance,AP/D,down-appearance}
% The key for the default appearance and the various types.
% \begin{macrocode}
\keys_define:nn { pdffield }
{
%parent is defined in field
,AS .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfannot_dict_remove:nn { widget }{AS}
}
{
\pdfannot_dict_put:nne {widget}{AS}{\pdf_name_from_unicode_e:n{#1}}
}
}
,AS .groups:n = annot
}
\keys_define:nn { pdffield }
{
AP/N .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfannot_dict_remove:nn { widget/AP }{N}
}
{
\@@_appearance_handler:nnn {#1}{N}{normal}
}
}
,AP/N .groups:n = annot
,appearance .meta:n = {AP/N={#1}}
,appearance .groups:n = annot
}
\keys_define:nn { pdffield }
{
AP/R .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfannot_dict_remove:nn { widget/AP }{R}
}
{
\@@_appearance_handler:nnn {#1}{R}{rollover}
}
}
,AP/R .groups:n = annot
,rollover-appearance .meta:n = {AP/R={#1}}
,rollover-appearance .groups:n = annot
}
\keys_define:nn { pdffield }
{
AP/D .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfannot_dict_remove:nn { widget/AP }{D}
}
{
\@@_appearance_handler:nnn {#1}{D}{down}
}
}
,AP/D .groups:n = annot
,down-appearance .meta:n = {AP/D={#1}}
,down-appearance .groups:n = annot
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{MK/R,rotate,MK/BC,bordercolor,MK/BG,backgroundcolor,MK/CA,caption}
% This are the keys for the dynamic appearance. A number are not handled yet fully.
% \begin{macrocode}
\keys_define:nn { pdffield }
{
MK/R .choices:nn = {0,90,180,270}
{
\pdfannot_dict_put:nne {widget/MK}{R}{#1}
}
,MK/R / .code:n =
{
\pdfannot_dict_remove:nn { widget/MK }{R}
}
,MK/R .groups:n = annot
,rotate .meta:n = {MK/R=#1}
}
\keys_define:nn { pdffield }
{
MK/BC .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfannot_dict_remove:nn { widget/MK }{BC}
}
{
\@@_color_set:nn {@@/tmp}{#1}
\color_export:nnN{@@/tmp}{space-sep-rgb}\l_@@_tmpa_tl
\pdfannot_dict_put:nne {widget/MK}{BC}{[\l_@@_tmpa_tl]}
}
}
,MK/BC .groups:n = annot
,bordercolor .meta:n = {MK/BC=#1}
}
\keys_define:nn { pdffield }
{
MK/BG .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfannot_dict_remove:nn { widget/MK }{BG}
}
{
\@@_color_set:nn {@@/tmp}{#1}
\color_export:nnN{@@/tmp}{space-sep-rgb}\l_@@_tmpa_tl
\pdfannot_dict_put:nne {widget/MK}{BG}{[\l_@@_tmpa_tl]}
}
}
,MK/BG .groups:n = annot
,backgroundcolor .meta:n = {MK/BG=#1}
}
\keys_define:nn { pdffield }
{
MK/CA .code:n =
{
\tl_set:Nn \l_@@_caption_tl {#1}
\tl_if_empty:nTF {#1}
{
\pdfannot_dict_remove:nn { widget/MK }{CA}
}
{
\pdf_string_from_unicode:nnN {utf8/string}{#1}\l_@@_tmpa_str
\pdfannot_dict_put:nne {widget/MK}{CA}{\l_@@_tmpa_str}
}
}
,MK/CA .groups:n = annot
,caption .meta:n = {MK/CA=#1}
}
\keys_define:nn { pdffield }
{
MK/RC .code:n =
{
\tl_set:Nn \l_@@_rollover_caption_tl {#1}
\tl_if_empty:nTF {#1}
{
\pdfannot_dict_remove:nn { widget/MK }{RC}
}
{
\pdf_string_from_unicode:nnN {utf8/string}{#1}\l_@@_tmpa_str
\pdfannot_dict_put:nne {widget/MK}{RC}{\l_@@_tmpa_str}
}
}
,MK/RC .groups:n = annot
,rollover-caption .meta:n = {MK/RC=#1}
}
\keys_define:nn { pdffield }
{
MK/AC .code:n =
{
\tl_set:Nn \l_@@_down_caption_tl {#1}
\tl_if_empty:nTF {#1}
{
\pdfannot_dict_remove:nn { widget/MK }{AC}
}
{
\pdf_string_from_unicode:nnN {utf8/string}{#1}\l_@@_tmpa_str
\pdfannot_dict_put:nne {widget/MK}{AC}{\l_@@_tmpa_str}
}
}
,MK/AC .groups:n = annot
,down-caption .meta:n = {MK/AC=#1}
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{MK/I,MK/RI,MK/IX,MK/IF,MK/TP}
% The following keys are pushputtons only. Currently there is no special handling
% involved as it is unclear if they are useful.
% \begin{macrocode}
\cs_set_protected:Npn \@@_tmpa:n #1
{
\keys_define:nn { pdffield }
{
MK/#1 .code:n =
{
\tl_if_empty:nTF {##1}
{
\pdfannot_dict_remove:nn { widget/MK }{#1}
}
{
\pdfannot_dict_put:nne {widget/MK}{#1}{##1}
}
}
,MK/#1 .groups:n = annot
}
}
\clist_map_inline:nn {I,RI,IX,IF,TP}
{ \@@_tmpa:n {#1} }
% \end{macrocode}
% \end{macro}
%
% Flags.
% \begin{macro}{setF,setannotflags,unsetF,unsetannotflags}
% \begin{macrocode}
\keys_define:nn { pdffield }
{
,setF .code:n =
{
\clist_map_inline:nn {#1}
{
\bitset_set_true:Nn \l_@@_F_bitset {##1}
}
}
,setF .groups:n = annot
,setannotflags .meta:nn =
{ pdffield }{setF={#1}}
,setannotflags .groups:n = annot
,unsetF .multichoice:
,unsetF / all .code:n = { \bitset_clear:N \l_@@_F_bitset}
,unsetF / unknown .code:n =
{
\bitset_set_false:Nn \l_@@_F_bitset {#1}
}
,unsetF .groups:n = annot
,unsetannotflags .meta:nn =
{ pdffield }{unsetF= {#1} }
,unsetannotflags .groups:n = annot
}
% \end{macrocode}
% \end{macro}
% Keys for the AA dictionary. They all trigger a javascript option.
% Fo = onfocus, Bl = onblur, D = onmousedown, U = onmouseup,
% E = onenter, X = onexit, PO = pageopen, PC = pageclose,
% PV = pagevisible, PI = pageinvisible
% \begin{macro}
% {
% AA/Fo,onfocus, AA/Bl,onblur, AA/D,onmousedown, AA/U,onmouseup,
% AA/E,onenter, AA/X,onexit, AA/PO,pageopen, AA/PC,pageclose,
% AA/PV,pagevisible, AA/PI,pageinvisible
% }
% \begin{macrocode}
\cs_set_protected:Npn \@@_tmpa:n #1 %
{
\keys_define:nn { pdffield }
{
AA/#1 .code:n =
{
\tl_if_empty:nTF {#1}
{
\pdfannot_dict_remove:nn {widget/AA}{#1}
}
{
\pdfannot_dict_put:nne {widget/AA}
{#1}
{<</S/JavaScript/JS\c_space_tl##1>>}
}
},
,AA/#1 .groups:n = annot
}
}
\clist_map_inline:nn {Fo,Bl,D,U,E,X,PO,PC,PV,PI}{\@@_tmpa:n{#1}}
\cs_set_protected:Npn \@@_tmpa:nn #1 #2
{
\keys_define:nn { pdffield }
{
#1 .meta:nn =
{ pdffield }{AA/#2={##1}},
#1 .groups:n = {annot}
}
}
\@@_tmpa:nn {onfocus} {Fo}
\@@_tmpa:nn {onblur} {Bl}
\@@_tmpa:nn {onmousedown}{D}
\@@_tmpa:nn {onmouseup}{U}
\@@_tmpa:nn {onenter} {E}
\@@_tmpa:nn {onexit} {X}
% \end{macrocode}
% \end{macro}
% \subsection{Appearances}
% \begin{macro}{\pdffield_appearance:nn,\pdffield_store_appearance:nn}
% \begin{macrocode}
\cs_new_protected:Npn \pdffield_appearance:nn #1 #2
{
\pdfxform_new:nnn {#1}{}{#2}
}
\cs_set_eq:NN \pdffield_store_appearance:nn\pdffield_appearance:nn
% \end{macrocode}
% \end{macro}
% \subsection{Setup command}
% \begin{macro}{create-style,preset-checkbox,preset-radio,preset-textfield}
% \begin{macrocode}
\keys_define:nn { pdffield / setup }
{
,create-style .code:n = { \@@_style_create:nn #1 }
,preset-checkbox .code:n =
{
\keys_define:nn { pdffield }
{
@@/preset/checkbox .meta:n = {#1},
}
}
,preset-radiobutton .code:n =
{
\keys_define:nn { pdffield }
{
@@/preset/radiobutton .meta:n = {#1},
}
}
,preset-textfield .code:n =
{
\keys_define:nn { pdffield }
{
@@/preset/textfield .meta:n = {#1},
}
}
,preset-pushbutton .code:n =
{
\keys_define:nn { pdffield }
{
@@/preset/pushbutton .meta:n = {#1},
}
}
,preset-choice .code:n =
{
\keys_define:nn { pdffield }
{
@@/preset/choice .meta:n = {#1},
}
}
}
\keys_set:nn{ pdffield / setup }{preset-checkbox={}}
\keys_set:nn{ pdffield / setup }{preset-textfield={}}
\keys_set:nn{ pdffield / setup }{preset-radiobutton={}}
\keys_set:nn{ pdffield / setup }{preset-pushbutton={}}
\keys_set:nn{ pdffield / setup }{preset-choice={}}
% \end{macrocode}
% \end{macro}
% \begin{macro}{\@@_style_create:nn}
% \begin{macrocode}
\cs_new_protected:Npn \@@_style_create:nn #1#2
{
\keys_define:nn { pdffield }
{
@@/style/#1 .meta:n = {#2},
}
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{\pdffield_setup:n,style}
% \begin{macrocode}
\cs_new_protected:Npn \pdffield_setup:n #1
{
\keys_set:nn{ pdffield / setup }{#1}
}
\keys_define:nn { pdffield }
{
style .code:n = {\keys_set:nn {pdffield}{@@/style/#1={#1}}}
}
% \end{macrocode}
% \end{macro}
% \section{Value keys}
% \begin{macro}{value,default,\@@_value_handler:n,\@@_default_handler:n}
% \begin{macrocode}
\cs_new_protected:Npn \@@_value_handler:n #1
{
\msg_info:nnn {pdffield}{key-ignored}{value}
}
\cs_new_protected:Npn \@@_default_handler:n #1
{
\msg_info:nnn {pdffield}{key-ignored}{default}
}
\keys_define:nn {pdffield}
{
value .code:n = { \@@_value_handler:n {#1} }
,default .code:n = { \@@_default_handler:n {#1}}
}
% \end{macrocode}
% \end{macro}
% \begin{macrocode}
%</package>
% \end{macrocode}
%\end{implementation}
%
% \PrintIndex
|