beta-0.89.2
[luatex.git] / manual / old / fdata_epdf.lua
blob991b6223b397d3b8d904231852eff63d6dd8baa9
1 -- $Id: fdata_epdf.lua 4559 2013-01-20 19:58:26Z hhenkel $
3 local fdata_epdf = {
4 functions = {
5 open = {
6 type = "function",
7 shortdesc = "Construct a PDFDoc object by opening a PDF document.",
8 arguments = {
9 {type = "string", name = "filename", optional = false, },
11 returnvalues = {
12 {type = "PDFDoc", name = "var", optional = false, },
15 Annot = {
16 type = "function",
17 shortdesc = "Construct an Annot object.",
18 arguments = {
19 {type = "XRef", name = "xref", optional = false, },
20 {type = "Dict", name = "dict", optional = false, },
21 {type = "Catalog", name = "catalog", optional = false, },
22 {type = "Ref", name = "ref", optional = false, },
24 returnvalues = {
25 {type = "Annot", name = "var", optional = false, },
28 Annots = {
29 type = "function",
30 shortdesc = "Construct an Annots object.",
31 arguments = {
32 {type = "XRef", name = "xref", optional = false, },
33 {type = "Catalog", name = "catalog", optional = false, },
34 {type = "Object", name = "object", optional = false, },
36 returnvalues = {
37 {type = "Annots", name = "var", optional = false, },
40 Array = {
41 type = "function",
42 shortdesc = "Construct an Array object.",
43 arguments = {
44 {type = "XRef", name = "xref", optional = false, },
46 returnvalues = {
47 {type = "Array", name = "var", optional = false, },
50 Dict = {
51 type = "function",
52 shortdesc = "Construct a Dict object.",
53 arguments = {
54 {type = "XRef", name = "xref", optional = false, },
56 returnvalues = {
57 {type = "Dict", name = "var", optional = false, },
60 Object = {
61 type = "function",
62 shortdesc = "Construct an Object object.",
63 arguments = {
65 returnvalues = {
66 {type = "Object", name = "var", optional = false, },
69 PDFRectangle = {
70 type = "function",
71 shortdesc = "Construct a PDFRectangle object.",
72 arguments = {
74 returnvalues = {
75 {type = "PDFRectangle", name = "var", optional = false, },
79 methods = {
80 ------------------------------------------------------------------------
81 Annot = {
82 isOK = {
83 type = "function",
84 shortdesc = "Check if Annot object is ok.",
85 arguments = {
86 {type = "Annot", name = "annot", optional = false, },
88 returnvalues = {
89 {type = "boolean", name = "var", optional = false, },
92 getAppearance = {
93 type = "function",
94 shortdesc = "Get Appearance object.",
95 arguments = {
96 {type = "Annot", name = "annot", optional = false, },
98 returnvalues = {
99 {type = "Object", name = "var", optional = false, },
102 getBorder = {
103 type = "function",
104 shortdesc = "Get AnnotBorder object.",
105 arguments = {
106 {type = "Annot", name = "annot", optional = false, },
108 returnvalues = {
109 {type = "AnnotBorder", name = "var", optional = false, },
112 match = {
113 type = "function",
114 shortdesc = "Check if object number and generation matches Ref.",
115 arguments = {
116 {type = "Annot", name = "annot", optional = false, },
117 {type = "Ref", name = "ref", optional = false, },
119 returnvalues = {
120 {type = "boolean", name = "var", optional = false, },
124 ------------------------------------------------------------------------
125 AnnotBorderStyle = {
126 getWidth = {
127 type = "function",
128 shortdesc = "Get border width.",
129 arguments = {
130 {type = "AnnotBorderStyle", name = "annotborderstyle", optional = false, },
132 returnvalues = {
133 {type = "number", name = "var", optional = false, },
137 ------------------------------------------------------------------------
138 Annots = {
139 getNumAnnots = {
140 type = "function",
141 shortdesc = "Get number of Annots objects.",
142 arguments = {
143 {type = "Annots", name = "annots", optional = false, },
145 returnvalues = {
146 {type = "integer", name = "var", optional = false, },
149 getAnnot = {
150 type = "function",
151 shortdesc = "Get Annot object.",
152 arguments = {
153 {type = "Annots", name = "annots", optional = false, },
154 {type = "integer", name = "integer", optional = false, },
156 returnvalues = {
157 {type = "Annot", name = "var", optional = false, },
161 ------------------------------------------------------------------------
162 Array = {
163 incRef = {
164 type = "function",
165 shortdesc = "Increment reference count to Array.",
166 arguments = {
167 {type = "Array", name = "array", optional = false, },
169 returnvalues = {
172 decRef = {
173 type = "function",
174 shortdesc = "Decrement reference count to Array.",
175 arguments = {
176 {type = "Array", name = "array", optional = false, },
178 returnvalues = {
181 getLength = {
182 type = "function",
183 shortdesc = "Get Array length.",
184 arguments = {
185 {type = "Array", name = "array", optional = false, },
187 returnvalues = {
188 {type = "integer", name = "var", optional = false, },
191 add = {
192 type = "function",
193 shortdesc = "Add Object to Array.",
194 arguments = {
195 {type = "Array", name = "array", optional = false, },
196 {type = "Object", name = "object", optional = false, },
198 returnvalues = {
201 get = {
202 type = "function",
203 shortdesc = "Get Object from Array.",
204 arguments = {
205 {type = "Array", name = "array", optional = false, },
206 {type = "integer", name = "integer", optional = false, },
208 returnvalues = {
209 {type = "Object", name = "var", optional = false, },
212 getNF = {
213 type = "function",
214 shortdesc = "Get Object from Array, not resolving indirection.",
215 arguments = {
216 {type = "Array", name = "array", optional = false, },
217 {type = "integer", name = "integer", optional = false, },
219 returnvalues = {
220 {type = "Object", name = "var", optional = false, },
223 getString = {
224 type = "function",
225 shortdesc = "Get String from Array.",
226 arguments = {
227 {type = "Array", name = "array", optional = false, },
228 {type = "integer", name = "integer", optional = false, },
230 returnvalues = {
231 {type = "string", name = "var", optional = false, },
235 ------------------------------------------------------------------------
236 Catalog = {
237 isOK = {
238 type = "function",
239 shortdesc = "Check if Catalog object is ok.",
240 arguments = {
241 {type = "Catalog", name = "catalog", optional = false, },
243 returnvalues = {
244 {type = "boolean", name = "var", optional = false, },
247 getNumPages = {
248 type = "function",
249 shortdesc = "Get total number of pages.",
250 arguments = {
251 {type = "Catalog", name = "catalog", optional = false, },
253 returnvalues = {
254 {type = "integer", name = "var", optional = false, },
257 getPage = {
258 type = "function",
259 shortdesc = "Get Page.",
260 arguments = {
261 {type = "Catalog", name = "catalog", optional = false, },
262 {type = "integer", name = "integer", optional = false, },
264 returnvalues = {
265 {type = "Page", name = "var", optional = false, },
268 getPageRef = {
269 type = "function",
270 shortdesc = "Get the reference to a Page object.",
271 arguments = {
272 {type = "Catalog", name = "catalog", optional = false, },
273 {type = "integer", name = "integer", optional = false, },
275 returnvalues = {
276 {type = "Ref", name = "var", optional = false, },
279 getBaseURI = {
280 type = "function",
281 shortdesc = "Get base URI, if any.",
282 arguments = {
283 {type = "Catalog", name = "catalog", optional = false, },
285 returnvalues = {
286 {type = "string", name = "var", optional = false, },
289 readMetadata = {
290 type = "function",
291 shortdesc = "Get the contents of the Metadata stream.",
292 arguments = {
293 {type = "Catalog", name = "catalog", optional = false, },
295 returnvalues = {
296 {type = "string", name = "var", optional = false, },
299 getStructTreeRoot = {
300 type = "function",
301 shortdesc = "Get the structure tree root object.",
302 arguments = {
303 {type = "Catalog", name = "catalog", optional = false, },
305 returnvalues = {
306 {type = "Object", name = "var", optional = false, },
309 findPage = {
310 type = "function",
311 shortdesc = "Get a Page number by object number and generation.",
312 arguments = {
313 {type = "Catalog", name = "catalog", optional = false, },
314 {type = "integer", name = "object number", optional = false, },
315 {type = "integer", name = "object generation", optional = false, },
317 returnvalues = {
318 {type = "integer", name = "var", optional = false, },
321 findDest = {
322 type = "function",
323 shortdesc = "Find a named destination.",
324 arguments = {
325 {type = "Catalog", name = "catalog", optional = false, },
326 {type = "string", name = "string", optional = false, },
328 returnvalues = {
329 {type = "LinkDest", name = "var", optional = false, },
332 getDests = {
333 type = "function",
334 shortdesc = "Get destinations object.",
335 arguments = {
336 {type = "Catalog", name = "catalog", optional = false, },
338 returnvalues = {
339 {type = "Object", name = "var", optional = false, },
342 numEmbeddedFiles = {
343 type = "function",
344 shortdesc = "Get number of embedded files.",
345 arguments = {
346 {type = "Catalog", name = "catalog", optional = false, },
348 returnvalues = {
349 {type = "integer", name = "var", optional = false, },
352 embeddedFile = {
353 type = "function",
354 shortdesc = "Get file spec of embedded file.",
355 arguments = {
356 {type = "Catalog", name = "catalog", optional = false, },
357 {type = "integer", name = "integer", optional = false, },
359 returnvalues = {
360 {type = "FileSpec", name = "var", optional = false, },
363 numJS = {
364 type = "function",
365 shortdesc = "Get number of javascript scripts.",
366 arguments = {
367 {type = "Catalog", name = "catalog", optional = false, },
369 returnvalues = {
370 {type = "integer", name = "var", optional = false, },
373 getJS = {
374 type = "function",
375 shortdesc = "Get javascript script.",
376 arguments = {
377 {type = "Catalog", name = "catalog", optional = false, },
378 {type = "integer", name = "integer", optional = false, },
380 returnvalues = {
381 {type = "string", name = "var", optional = false, },
384 getOutline = {
385 type = "function",
386 shortdesc = "Get Outline object.",
387 arguments = {
388 {type = "Catalog", name = "catalog", optional = false, },
390 returnvalues = {
391 {type = "Object", name = "var", optional = false, },
394 getAcroForm = {
395 type = "function",
396 shortdesc = "Get AcroForm object.",
397 arguments = {
398 {type = "Catalog", name = "catalog", optional = false, },
400 returnvalues = {
401 {type = "Object", name = "var", optional = false, },
405 ------------------------------------------------------------------------
406 EmbFile = {
407 name = {
408 type = "function",
409 shortdesc = "Get name of embedded file.",
410 arguments = {
411 {type = "EmbFile", name = "embfile", optional = false, },
413 returnvalues = {
414 {type = "string", name = "var", optional = false, },
417 description = {
418 type = "function",
419 shortdesc = "Get description of embedded file.",
420 arguments = {
421 {type = "EmbFile", name = "embfile", optional = false, },
423 returnvalues = {
424 {type = "string", name = "var", optional = false, },
427 size = {
428 type = "function",
429 shortdesc = "Get size of embedded file.",
430 arguments = {
431 {type = "EmbFile", name = "embfile", optional = false, },
433 returnvalues = {
434 {type = "integer", name = "var", optional = false, },
437 modDate = {
438 type = "function",
439 shortdesc = "Get modification date of embedded file.",
440 arguments = {
441 {type = "EmbFile", name = "embfile", optional = false, },
443 returnvalues = {
444 {type = "string", name = "var", optional = false, },
447 createDate = {
448 type = "function",
449 shortdesc = "Get creation date of embedded file.",
450 arguments = {
451 {type = "EmbFile", name = "embfile", optional = false, },
453 returnvalues = {
454 {type = "string", name = "var", optional = false, },
457 checksum = {
458 type = "function",
459 shortdesc = "Get checksum of embedded file.",
460 arguments = {
461 {type = "EmbFile", name = "embfile", optional = false, },
463 returnvalues = {
464 {type = "string", name = "var", optional = false, },
467 mimeType = {
468 type = "function",
469 shortdesc = "Get mime type of embedded file.",
470 arguments = {
471 {type = "EmbFile", name = "embfile", optional = false, },
473 returnvalues = {
474 {type = "string", name = "var", optional = false, },
477 streamObject = {
478 type = "function",
479 shortdesc = "Get stream object of embedded file.",
480 arguments = {
481 {type = "EmbFile", name = "embfile", optional = false, },
483 returnvalues = {
484 {type = "Object", name = "var", optional = false, },
487 isOk = {
488 type = "function",
489 shortdesc = "Check if embedded file is ok.",
490 arguments = {
491 {type = "EmbFile", name = "embfile", optional = false, },
493 returnvalues = {
494 {type = "boolean", name = "var", optional = false, },
497 save = {
498 type = "function",
499 shortdesc = "Save embedded file to disk.",
500 arguments = {
501 {type = "EmbFile", name = "embfile", optional = false, },
502 {type = "string", name = "var", optional = false, },
504 returnvalues = {
505 {type = "boolean", name = "var", optional = false, },
509 ------------------------------------------------------------------------
510 FileSpec = {
511 isOk = {
512 type = "function",
513 shortdesc = "Check if filespec is ok.",
514 arguments = {
515 {type = "FileSpec", name = "filespec", optional = false, },
517 returnvalues = {
518 {type = "boolean", name = "var", optional = false, },
521 getFileName = {
522 type = "function",
523 shortdesc = "Get file name of filespec.",
524 arguments = {
525 {type = "FileSpec", name = "filespec", optional = false, },
527 returnvalues = {
528 {type = "string", name = "string", optional = false, },
531 getFileNameForPlatform = {
532 type = "function",
533 shortdesc = "Get file name for platform of filespec.",
534 arguments = {
535 {type = "FileSpec", name = "filespec", optional = false, },
537 returnvalues = {
538 {type = "string", name = "string", optional = false, },
541 getDescription = {
542 type = "function",
543 shortdesc = "Get description of filespec.",
544 arguments = {
545 {type = "FileSpec", name = "filespec", optional = false, },
547 returnvalues = {
548 {type = "string", name = "string", optional = false, },
551 getEmbeddedFile = {
552 type = "function",
553 shortdesc = "Get embedded file of filespec.",
554 arguments = {
555 {type = "FileSpec", name = "filespec", optional = false, },
557 returnvalues = {
558 {type = "EmbFile", name = "embfile", optional = false, },
562 ------------------------------------------------------------------------
563 Dict = {
564 incRef = {
565 type = "function",
566 shortdesc = "Increment reference count to Dict.",
567 arguments = {
568 {type = "Dict", name = "dict", optional = false, },
570 returnvalues = {
573 decRef = {
574 type = "function",
575 shortdesc = "Decrement reference count to Dict.",
576 arguments = {
577 {type = "Dict", name = "dict", optional = false, },
579 returnvalues = {
582 getLength = {
583 type = "function",
584 shortdesc = "Get Dict length.",
585 arguments = {
586 {type = "Dict", name = "dict", optional = false, },
588 returnvalues = {
589 {type = "integer", name = "var", optional = false, },
592 add = {
593 type = "function",
594 shortdesc = "Add Object to Dict.",
595 arguments = {
596 {type = "Dict", name = "dict", optional = false, },
597 {type = "string", name = "string", optional = false, },
598 {type = "Object", name = "object", optional = false, },
600 returnvalues = {
603 set = {
604 type = "function",
605 shortdesc = "Set Object in Dict.",
606 arguments = {
607 {type = "Dict", name = "dict", optional = false, },
608 {type = "string", name = "string", optional = false, },
609 {type = "Object", name = "object", optional = false, },
611 returnvalues = {
614 remove = {
615 type = "function",
616 shortdesc = "Remove entry from Dict.",
617 arguments = {
618 {type = "Dict", name = "dict", optional = false, },
619 {type = "string", name = "string", optional = false, },
621 returnvalues = {
624 is = {
625 type = "function",
626 shortdesc = "Check if Dict is of given /Type.",
627 arguments = {
628 {type = "Dict", name = "dict", optional = false, },
629 {type = "string", name = "string", optional = false, },
631 returnvalues = {
632 {type = "boolean", name = "var", optional = false, },
635 lookup = {
636 type = "function",
637 shortdesc = "Look up Dict entry.",
638 arguments = {
639 {type = "Dict", name = "dict", optional = false, },
640 {type = "string", name = "string", optional = false, },
642 returnvalues = {
643 {type = "Object", name = "var", optional = false, },
646 lookupNF = {
647 type = "function",
648 shortdesc = "Look up Dict entry, not resolving indirection.",
649 arguments = {
650 {type = "Dict", name = "dict", optional = false, },
651 {type = "string", name = "string", optional = false, },
653 returnvalues = {
654 {type = "Object", name = "var", optional = false, },
657 lookupInt = {
658 type = "function",
659 shortdesc = "TODO",
660 arguments = {
661 {type = "Dict", name = "dict", optional = false, },
662 {type = "string", name = "string", optional = false, },
663 {type = "string", name = "string", optional = false, },
665 returnvalues = {
666 {type = "integer", name = "var", optional = false, },
669 getKey = {
670 type = "function",
671 shortdesc = "Get key from Dict by number.",
672 arguments = {
673 {type = "Dict", name = "dict", optional = false, },
674 {type = "integer", name = "integer", optional = false, },
676 returnvalues = {
677 {type = "string", name = "var", optional = false, },
680 getVal = {
681 type = "function",
682 shortdesc = "Get value from Dict by number.",
683 arguments = {
684 {type = "Dict", name = "dict", optional = false, },
685 {type = "integer", name = "integer", optional = false, },
687 returnvalues = {
688 {type = "Object", name = "var", optional = false, },
691 getValNF = {
692 type = "function",
693 shortdesc = "Get value from Dict by number, not resolving indirection.",
694 arguments = {
695 {type = "Dict", name = "dict", optional = false, },
696 {type = "integer", name = "integer", optional = false, },
698 returnvalues = {
699 {type = "Object", name = "var", optional = false, },
702 hasKey = {
703 type = "function",
704 shortdesc = "Check if Dict contains /Key.",
705 arguments = {
706 {type = "Dict", name = "dict", optional = false, },
707 {type = "string", name = "string", optional = false, },
709 returnvalues = {
710 {type = "boolean", name = "var", optional = false, },
714 ------------------------------------------------------------------------
715 Link = {
716 isOK = {
717 type = "function",
718 shortdesc = "Check if Link object is ok.",
719 arguments = {
720 {type = "Link", name = "link", optional = false, },
722 returnvalues = {
723 {type = "boolean", name = "var", optional = false, },
726 inRect = {
727 type = "function",
728 shortdesc = "Check if point is inside the link rectangle.",
729 arguments = {
730 {type = "Link", name = "link", optional = false, },
731 {type = "number", name = "number", optional = false, },
732 {type = "number", name = "number", optional = false, },
734 returnvalues = {
735 {type = "boolean", name = "var", optional = false, },
739 ------------------------------------------------------------------------
740 LinkDest = {
741 isOK = {
742 type = "function",
743 shortdesc = "Check if LinkDest object is ok.",
744 arguments = {
745 {type = "LinkDest", name = "linkdest", optional = false, },
747 returnvalues = {
748 {type = "boolean", name = "var", optional = false, },
751 getKind = {
752 type = "function",
753 shortdesc = "Get number of LinkDest kind.",
754 arguments = {
755 {type = "LinkDest", name = "linkdest", optional = false, },
757 returnvalues = {
758 {type = "integer", name = "var", optional = false, },
761 getKindName = {
762 type = "function",
763 shortdesc = "Get name of LinkDest kind.",
764 arguments = {
765 {type = "LinkDest", name = "linkdest", optional = false, },
767 returnvalues = {
768 {type = "string", name = "var", optional = false, },
771 isPageRef = {
772 type = "function",
773 shortdesc = "TODO",
774 arguments = {
775 {type = "LinkDest", name = "linkdest", optional = false, },
777 returnvalues = {
778 {type = "boolean", name = "var", optional = false, },
781 getPageNum = {
782 type = "function",
783 shortdesc = "TODO",
784 arguments = {
785 {type = "LinkDest", name = "linkdest", optional = false, },
787 returnvalues = {
788 {type = "integer", name = "var", optional = false, },
791 getPageRef = {
792 type = "function",
793 shortdesc = "TODO",
794 arguments = {
795 {type = "LinkDest", name = "linkdest", optional = false, },
797 returnvalues = {
798 {type = "Ref", name = "var", optional = false, },
801 getLeft = {
802 type = "function",
803 shortdesc = "TODO",
804 arguments = {
805 {type = "LinkDest", name = "linkdest", optional = false, },
807 returnvalues = {
808 {type = "number", name = "var", optional = false, },
811 getBottom = {
812 type = "function",
813 shortdesc = "TODO",
814 arguments = {
815 {type = "LinkDest", name = "linkdest", optional = false, },
817 returnvalues = {
818 {type = "number", name = "var", optional = false, },
821 getRight = {
822 type = "function",
823 shortdesc = "TODO",
824 arguments = {
825 {type = "LinkDest", name = "linkdest", optional = false, },
827 returnvalues = {
828 {type = "number", name = "var", optional = false, },
831 getTop = {
832 type = "function",
833 shortdesc = "TODO",
834 arguments = {
835 {type = "LinkDest", name = "linkdest", optional = false, },
837 returnvalues = {
838 {type = "number", name = "var", optional = false, },
841 getZoom = {
842 type = "function",
843 shortdesc = "TODO",
844 arguments = {
845 {type = "LinkDest", name = "linkdest", optional = false, },
847 returnvalues = {
848 {type = "number", name = "var", optional = false, },
851 getChangeLeft = {
852 type = "function",
853 shortdesc = "TODO",
854 arguments = {
855 {type = "LinkDest", name = "linkdest", optional = false, },
857 returnvalues = {
858 {type = "boolean", name = "var", optional = false, },
861 getChangeTop = {
862 type = "function",
863 shortdesc = "TODO",
864 arguments = {
865 {type = "LinkDest", name = "linkdest", optional = false, },
867 returnvalues = {
868 {type = "boolean", name = "var", optional = false, },
871 getChangeZoom = {
872 type = "function",
873 shortdesc = "TODO",
874 arguments = {
875 {type = "LinkDest", name = "linkdest", optional = false, },
877 returnvalues = {
878 {type = "boolean", name = "var", optional = false, },
882 ------------------------------------------------------------------------
883 Links = {
884 getNumLinks = {
885 type = "function",
886 shortdesc = "Get number of links.",
887 arguments = {
888 {type = "Links", name = "links", optional = false, },
890 returnvalues = {
891 {type = "integer", name = "var", optional = false, },
894 getLink = {
895 type = "function",
896 shortdesc = "Get link by number.",
897 arguments = {
898 {type = "Links", name = "links", optional = false, },
899 {type = "integer", name = "integer", optional = false, },
901 returnvalues = {
902 {type = "Link", name = "var", optional = false, },
906 ------------------------------------------------------------------------
907 Object = {
908 initBool = {
909 type = "function",
910 shortdesc = "Initialize a Bool-type object.",
911 arguments = {
912 {type = "Object", name = "object", optional = false, },
913 {type = "boolean", name = "boolean", optional = false, },
915 returnvalues = {
918 initInt = {
919 type = "function",
920 shortdesc = "Initialize an Int-type object.",
921 arguments = {
922 {type = "Object", name = "object", optional = false, },
923 {type = "integer", name = "integer", optional = false, },
925 returnvalues = {
928 initReal = {
929 type = "function",
930 shortdesc = "Initialize a Real-type object.",
931 arguments = {
932 {type = "Object", name = "object", optional = false, },
933 {type = "number", name = "number", optional = false, },
935 returnvalues = {
938 initString = {
939 type = "function",
940 shortdesc = "Initialize a String-type object.",
941 arguments = {
942 {type = "Object", name = "object", optional = false, },
943 {type = "string", name = "string", optional = false, },
945 returnvalues = {
948 initName = {
949 type = "function",
950 shortdesc = "Initialize a Name-type object.",
951 arguments = {
952 {type = "Object", name = "object", optional = false, },
953 {type = "string", name = "string", optional = false, },
955 returnvalues = {
958 initNull = {
959 type = "function",
960 shortdesc = "Initialize a Null-type object.",
961 arguments = {
962 {type = "Object", name = "object", optional = false, },
964 returnvalues = {
967 initArray = {
968 type = "function",
969 shortdesc = "Initialize an Array-type object with an empty array.",
970 arguments = {
971 {type = "Object", name = "object", optional = false, },
972 {type = "XRef", name = "xref", optional = false, },
974 returnvalues = {
977 initDict = {
978 type = "function",
979 shortdesc = "Initialize a Dict-type object with an empty dictionary.",
980 arguments = {
981 {type = "Object", name = "object", optional = false, },
982 {type = "XRef", name = "xref", optional = false, },
984 returnvalues = {
987 initStream = {
988 type = "function",
989 shortdesc = "Initialize a Stream-type object.",
990 arguments = {
991 {type = "Object", name = "object", optional = false, },
992 {type = "Stream", name = "stream", optional = false, },
994 returnvalues = {
997 initRef = {
998 type = "function",
999 shortdesc = "Initialize a Ref-type object by object number and generation.",
1000 arguments = {
1001 {type = "Object", name = "object", optional = false, },
1002 {type = "integer", name = "object number", optional = false, },
1003 {type = "integer", name = "object generation", optional = false, },
1005 returnvalues = {
1008 initCmd = {
1009 type = "function",
1010 shortdesc = "Initialize a Cmd-type object.",
1011 arguments = {
1012 {type = "Object", name = "object", optional = false, },
1013 {type = "string", name = "string", optional = false, },
1015 returnvalues = {
1018 initError = {
1019 type = "function",
1020 shortdesc = "Initialize an Error-type object.",
1021 arguments = {
1022 {type = "Object", name = "object", optional = false, },
1024 returnvalues = {
1027 initEOF = {
1028 type = "function",
1029 shortdesc = "Initialize an EOF-type object.",
1030 arguments = {
1031 {type = "Object", name = "object", optional = false, },
1033 returnvalues = {
1036 fetch = {
1037 type = "function",
1038 shortdesc = "If object is of type Ref, fetch and return the referenced object. Otherwise, return a copy of the object.",
1039 arguments = {
1040 {type = "Object", name = "object", optional = false, },
1041 {type = "XRef", name = "xref", optional = false, },
1043 returnvalues = {
1044 {type = "Object", name = "var", optional = false, },
1047 getType = {
1048 type = "function",
1049 shortdesc = "Get object type as a number (enum ObjType).",
1050 arguments = {
1051 {type = "Object", name = "object", optional = false, },
1053 returnvalues = {
1054 {type = "integer", name = "var", optional = false, },
1057 getTypeName = {
1058 type = "function",
1059 shortdesc = "Get object type name.",
1060 arguments = {
1061 {type = "Object", name = "object", optional = false, },
1063 returnvalues = {
1064 {type = "string", name = "var", optional = false, },
1067 isBool = {
1068 type = "function",
1069 shortdesc = "Check if object is of type Bool.",
1070 arguments = {
1071 {type = "Object", name = "object", optional = false, },
1073 returnvalues = {
1074 {type = "boolean", name = "var", optional = false, },
1077 isInt = {
1078 type = "function",
1079 shortdesc = "Check if object is of type Int.",
1080 arguments = {
1081 {type = "Object", name = "object", optional = false, },
1083 returnvalues = {
1084 {type = "boolean", name = "var", optional = false, },
1087 isReal = {
1088 type = "function",
1089 shortdesc = "Check if object is of type Real.",
1090 arguments = {
1091 {type = "Object", name = "object", optional = false, },
1093 returnvalues = {
1094 {type = "boolean", name = "var", optional = false, },
1097 isNum = {
1098 type = "function",
1099 shortdesc = "Check if object is of type Num.",
1100 arguments = {
1101 {type = "Object", name = "object", optional = false, },
1103 returnvalues = {
1104 {type = "boolean", name = "var", optional = false, },
1107 isString = {
1108 type = "function",
1109 shortdesc = "Check if object is of type String.",
1110 arguments = {
1111 {type = "Object", name = "object", optional = false, },
1113 returnvalues = {
1114 {type = "boolean", name = "var", optional = false, },
1117 isName = {
1118 type = "function",
1119 shortdesc = "Check if object is of type Name.",
1120 arguments = {
1121 {type = "Object", name = "object", optional = false, },
1123 returnvalues = {
1124 {type = "boolean", name = "var", optional = false, },
1127 isNull = {
1128 type = "function",
1129 shortdesc = "Check if object is of type Null.",
1130 arguments = {
1131 {type = "Object", name = "object", optional = false, },
1133 returnvalues = {
1134 {type = "boolean", name = "var", optional = false, },
1137 isArray = {
1138 type = "function",
1139 shortdesc = "Check if object is of type Array.",
1140 arguments = {
1141 {type = "Object", name = "object", optional = false, },
1143 returnvalues = {
1144 {type = "boolean", name = "var", optional = false, },
1147 isDict = {
1148 type = "function",
1149 shortdesc = "Check if object is of type Dict.",
1150 arguments = {
1151 {type = "Object", name = "object", optional = false, },
1153 returnvalues = {
1154 {type = "boolean", name = "var", optional = false, },
1157 isStream = {
1158 type = "function",
1159 shortdesc = "Check if object is of type Stream.",
1160 arguments = {
1161 {type = "Object", name = "object", optional = false, },
1163 returnvalues = {
1164 {type = "boolean", name = "var", optional = false, },
1167 isRef = {
1168 type = "function",
1169 shortdesc = "Check if object is of type Ref.",
1170 arguments = {
1171 {type = "Object", name = "object", optional = false, },
1173 returnvalues = {
1174 {type = "boolean", name = "var", optional = false, },
1177 isCmd = {
1178 type = "function",
1179 shortdesc = "Check if object is of type Cmd.",
1180 arguments = {
1181 {type = "Object", name = "object", optional = false, },
1183 returnvalues = {
1184 {type = "boolean", name = "var", optional = false, },
1187 isError = {
1188 type = "function",
1189 shortdesc = "Check if object is of type Error.",
1190 arguments = {
1191 {type = "Object", name = "object", optional = false, },
1193 returnvalues = {
1194 {type = "boolean", name = "var", optional = false, },
1197 isEOF = {
1198 type = "function",
1199 shortdesc = "Check if object is of type EOF.",
1200 arguments = {
1201 {type = "Object", name = "object", optional = false, },
1203 returnvalues = {
1204 {type = "boolean", name = "var", optional = false, },
1207 isNone = {
1208 type = "function",
1209 shortdesc = "Check if object is of type None.",
1210 arguments = {
1211 {type = "Object", name = "object", optional = false, },
1213 returnvalues = {
1214 {type = "boolean", name = "var", optional = false, },
1217 getBool = {
1218 type = "function",
1219 shortdesc = "Get boolean from Bool-type object.",
1220 arguments = {
1221 {type = "Object", name = "object", optional = false, },
1223 returnvalues = {
1224 {type = "boolean", name = "var", optional = false, },
1227 getInt = {
1228 type = "function",
1229 shortdesc = "Get integer from Int-type object.",
1230 arguments = {
1231 {type = "Object", name = "object", optional = false, },
1233 returnvalues = {
1234 {type = "integer", name = "var", optional = false, },
1237 getReal = {
1238 type = "function",
1239 shortdesc = "Get number from Real-type object.",
1240 arguments = {
1241 {type = "Object", name = "object", optional = false, },
1243 returnvalues = {
1244 {type = "number", name = "var", optional = false, },
1247 getNum = {
1248 type = "function",
1249 shortdesc = "Get number from Num-type object.",
1250 arguments = {
1251 {type = "Object", name = "object", optional = false, },
1253 returnvalues = {
1254 {type = "number", name = "var", optional = false, },
1257 getString = {
1258 type = "function",
1259 shortdesc = "Get string from String-type object.",
1260 arguments = {
1261 {type = "Object", name = "object", optional = false, },
1263 returnvalues = {
1264 {type = "string", name = "var", optional = false, },
1267 getName = {
1268 type = "function",
1269 shortdesc = "Get name from Name-type object as a string.",
1270 arguments = {
1271 {type = "Object", name = "object", optional = false, },
1273 returnvalues = {
1274 {type = "string", name = "var", optional = false, },
1277 getArray = {
1278 type = "function",
1279 shortdesc = "Get Array from Array-type object.",
1280 arguments = {
1281 {type = "Object", name = "object", optional = false, },
1283 returnvalues = {
1284 {type = "Array", name = "var", optional = false, },
1287 getDict = {
1288 type = "function",
1289 shortdesc = "Get Dict from Dict-type object.",
1290 arguments = {
1291 {type = "Object", name = "object", optional = false, },
1293 returnvalues = {
1294 {type = "Dict", name = "var", optional = false, },
1297 getStream = {
1298 type = "function",
1299 shortdesc = "Get Stream from Stream-type object.",
1300 arguments = {
1301 {type = "Object", name = "object", optional = false, },
1303 returnvalues = {
1304 {type = "Stream", name = "var", optional = false, },
1307 getRef = {
1308 type = "function",
1309 shortdesc = "Get Ref from Ref-type object.",
1310 arguments = {
1311 {type = "Object", name = "object", optional = false, },
1313 returnvalues = {
1314 {type = "Ref", name = "var", optional = false, },
1317 getRefNum = {
1318 type = "function",
1319 shortdesc = "Get object number from Ref-type object.",
1320 arguments = {
1321 {type = "Object", name = "object", optional = false, },
1323 returnvalues = {
1324 {type = "integer", name = "var", optional = false, },
1327 getRefGen = {
1328 type = "function",
1329 shortdesc = "Get object generation from Ref-type object.",
1330 arguments = {
1331 {type = "Object", name = "object", optional = false, },
1333 returnvalues = {
1334 {type = "integer", name = "var", optional = false, },
1337 getCmd = {
1338 shortdesc = "Get command from Cmd-type object as a string.",
1339 shortdesc = "TODO",
1340 arguments = {
1341 {type = "Object", name = "object", optional = false, },
1343 returnvalues = {
1344 {type = "string", name = "var", optional = false, },
1347 arrayGetLength = {
1348 type = "function",
1349 shortdesc = "Get array length from Array-type object.",
1350 arguments = {
1351 {type = "Object", name = "object", optional = false, },
1353 returnvalues = {
1354 {type = "integer", name = "var", optional = false, },
1357 arrayAdd = {
1358 type = "function",
1359 shortdesc = "Add Object to Array-type object.",
1360 arguments = {
1361 {type = "Object", name = "object", optional = false, },
1362 {type = "Object", name = "object", optional = false, },
1364 returnvalues = {
1367 arrayGet = {
1368 type = "function",
1369 shortdesc = "Get Object from Array-type object.",
1370 arguments = {
1371 {type = "Object", name = "object", optional = false, },
1372 {type = "integer", name = "integer", optional = false, },
1374 returnvalues = {
1375 {type = "Object", name = "var", optional = false, },
1378 arrayGetNF = {
1379 type = "function",
1380 shortdesc = "Get Object from Array-type object, not resolving indirection.",
1381 arguments = {
1382 {type = "Object", name = "object", optional = false, },
1383 {type = "integer", name = "integer", optional = false, },
1385 returnvalues = {
1386 {type = "Object", name = "var", optional = false, },
1389 dictGetLength = {
1390 type = "function",
1391 shortdesc = "Get dictionary length from Dict-type object.",
1392 arguments = {
1393 {type = "Object", name = "object", optional = false, },
1394 {type = "integer", name = "integer", optional = false, },
1396 returnvalues = {
1397 {type = "integer", name = "var", optional = false, },
1400 dictAdd = {
1401 type = "function",
1402 shortdesc = "Add Object to Dict-type object.",
1403 arguments = {
1404 {type = "Object", name = "object", optional = false, },
1405 {type = "string", name = "string", optional = false, },
1406 {type = "Object", name = "object", optional = false, },
1408 returnvalues = {
1411 dictSet = {
1412 type = "function",
1413 shortdesc = "TODO",
1414 arguments = {
1415 {type = "Object", name = "object", optional = false, },
1416 {type = "string", name = "string", optional = false, },
1417 {type = "Object", name = "object", optional = false, },
1419 returnvalues = {
1422 dictLookup = {
1423 type = "function",
1424 shortdesc = "TODO",
1425 arguments = {
1426 {type = "Object", name = "object", optional = false, },
1427 {type = "string", name = "string", optional = false, },
1429 returnvalues = {
1430 {type = "Object", name = "var", optional = false, },
1433 dictLookupNF = {
1434 type = "function",
1435 shortdesc = "TODO",
1436 arguments = {
1437 {type = "Object", name = "object", optional = false, },
1438 {type = "string", name = "string", optional = false, },
1440 returnvalues = {
1441 {type = "Object", name = "var", optional = false, },
1444 dictGetKey = {
1445 type = "function",
1446 shortdesc = "Get Dict key of Dict-type object by number.",
1447 arguments = {
1448 {type = "Object", name = "object", optional = false, },
1449 {type = "integer", name = "integer", optional = false, },
1451 returnvalues = {
1452 {type = "string", name = "var", optional = false, },
1455 dictGetVal = {
1456 type = "function",
1457 shortdesc = "Get Dict value of Dict-type object by number.",
1458 arguments = {
1459 {type = "Object", name = "object", optional = false, },
1460 {type = "integer", name = "integer", optional = false, },
1462 returnvalues = {
1463 {type = "Object", name = "var", optional = false, },
1466 dictGetValNF = {
1467 type = "function",
1468 shortdesc = "Get Dict value of Dict-type object by number, not resolving indirection.",
1469 arguments = {
1470 {type = "Object", name = "object", optional = false, },
1471 {type = "integer", name = "integer", optional = false, },
1473 returnvalues = {
1474 {type = "Object", name = "var", optional = false, },
1477 streamIs = {
1478 type = "function",
1479 shortdesc = "Check if object contains a stream whose dictionary is of given /Type.",
1480 arguments = {
1481 {type = "Object", name = "object", optional = false, },
1482 {type = "string", name = "string", optional = false, },
1484 returnvalues = {
1485 {type = "boolean", name = "var", optional = false, },
1488 streamReset = {
1489 type = "function",
1490 shortdesc = "TODO",
1491 arguments = {
1492 {type = "Object", name = "object", optional = false, },
1494 returnvalues = {
1497 streamGetChar = {
1498 type = "function",
1499 shortdesc = "TODO",
1500 arguments = {
1501 {type = "Object", name = "object", optional = false, },
1503 returnvalues = {
1504 {type = "integer", name = "var", optional = false, },
1507 streamLookChar = {
1508 type = "function",
1509 shortdesc = "TODO",
1510 arguments = {
1511 {type = "Object", name = "object", optional = false, },
1513 returnvalues = {
1514 {type = "integer", name = "var", optional = false, },
1517 streamGetPos = {
1518 type = "function",
1519 shortdesc = "TODO",
1520 arguments = {
1521 {type = "Object", name = "object", optional = false, },
1523 returnvalues = {
1524 {type = "integer", name = "var", optional = false, },
1527 streamSetPos = {
1528 type = "function",
1529 shortdesc = "TODO",
1530 arguments = {
1531 {type = "Object", name = "object", optional = false, },
1532 {type = "integer", name = "integer", optional = false, },
1534 returnvalues = {
1537 streamGetDict = {
1538 type = "function",
1539 shortdesc = "TODO",
1540 arguments = {
1541 {type = "Object", name = "object", optional = false, },
1543 returnvalues = {
1544 {type = "Dict", name = "var", optional = false, },
1548 ------------------------------------------------------------------------
1549 Page = {
1550 isOK = {
1551 type = "function",
1552 shortdesc = "Check if Page object is ok.",
1553 arguments = {
1554 {type = "Page", name = "page", optional = false, },
1556 returnvalues = {
1557 {type = "boolean", name = "var", optional = false, },
1560 getNum = {
1561 type = "function",
1562 shortdesc = "TODO",
1563 arguments = {
1564 {type = "Page", name = "page", optional = false, },
1566 returnvalues = {
1567 {type = "integer", name = "var", optional = false, },
1570 getMediaBox = {
1571 type = "function",
1572 shortdesc = "TODO",
1573 arguments = {
1574 {type = "Page", name = "page", optional = false, },
1576 returnvalues = {
1577 {type = "PDFRectangle", name = "var", optional = false, },
1580 getCropBox = {
1581 type = "function",
1582 shortdesc = "TODO",
1583 arguments = {
1584 {type = "Page", name = "page", optional = false, },
1586 returnvalues = {
1587 {type = "PDFRectangle", name = "var", optional = false, },
1590 isCropped = {
1591 type = "function",
1592 shortdesc = "TODO",
1593 arguments = {
1594 {type = "Page", name = "page", optional = false, },
1596 returnvalues = {
1597 {type = "boolean", name = "var", optional = false, },
1600 getMediaWidth = {
1601 type = "function",
1602 shortdesc = "TODO",
1603 arguments = {
1604 {type = "Page", name = "page", optional = false, },
1606 returnvalues = {
1607 {type = "number", name = "var", optional = false, },
1610 getMediaHeight = {
1611 type = "function",
1612 shortdesc = "TODO",
1613 arguments = {
1614 {type = "Page", name = "page", optional = false, },
1616 returnvalues = {
1617 {type = "number", name = "var", optional = false, },
1620 getCropWidth = {
1621 type = "function",
1622 shortdesc = "TODO",
1623 arguments = {
1624 {type = "Page", name = "page", optional = false, },
1626 returnvalues = {
1627 {type = "number", name = "var", optional = false, },
1630 getCropHeight = {
1631 type = "function",
1632 shortdesc = "TODO",
1633 arguments = {
1634 {type = "Page", name = "page", optional = false, },
1636 returnvalues = {
1637 {type = "number", name = "var", optional = false, },
1640 getBleedBox = {
1641 type = "function",
1642 shortdesc = "TODO",
1643 arguments = {
1644 {type = "Page", name = "page", optional = false, },
1646 returnvalues = {
1647 {type = "PDFRectangle", name = "var", optional = false, },
1650 getTrimBox = {
1651 type = "function",
1652 shortdesc = "TODO",
1653 arguments = {
1654 {type = "Page", name = "page", optional = false, },
1656 returnvalues = {
1657 {type = "PDFRectangle", name = "var", optional = false, },
1660 getArtBox = {
1661 type = "function",
1662 shortdesc = "TODO",
1663 arguments = {
1664 {type = "Page", name = "page", optional = false, },
1666 returnvalues = {
1667 {type = "PDFRectangle", name = "var", optional = false, },
1670 getRotate = {
1671 type = "function",
1672 shortdesc = "TODO",
1673 arguments = {
1674 {type = "Page", name = "page", optional = false, },
1676 returnvalues = {
1677 {type = "number", name = "var", optional = false, },
1680 getLastModified = {
1681 type = "function",
1682 shortdesc = "TODO",
1683 arguments = {
1684 {type = "Page", name = "page", optional = false, },
1686 returnvalues = {
1687 {type = "string", name = "var", optional = false, },
1690 getBoxColorInfo = {
1691 type = "function",
1692 shortdesc = "TODO",
1693 arguments = {
1694 {type = "Page", name = "page", optional = false, },
1696 returnvalues = {
1697 {type = "Dict", name = "var", optional = false, },
1700 getGroup = {
1701 type = "function",
1702 shortdesc = "TODO",
1703 arguments = {
1704 {type = "Page", name = "page", optional = false, },
1706 returnvalues = {
1707 {type = "Dict", name = "var", optional = false, },
1710 getMetadata = {
1711 type = "function",
1712 shortdesc = "TODO",
1713 arguments = {
1714 {type = "Page", name = "page", optional = false, },
1716 returnvalues = {
1717 {type = "Stream", name = "var", optional = false, },
1720 getPieceInfo = {
1721 type = "function",
1722 shortdesc = "TODO",
1723 arguments = {
1724 {type = "Page", name = "page", optional = false, },
1726 returnvalues = {
1727 {type = "Dict", name = "var", optional = false, },
1730 getSeparationInfo = {
1731 type = "function",
1732 shortdesc = "TODO",
1733 arguments = {
1734 {type = "Page", name = "page", optional = false, },
1736 returnvalues = {
1737 {type = "Dict", name = "var", optional = false, },
1740 getResourceDict = {
1741 type = "function",
1742 shortdesc = "TODO",
1743 arguments = {
1744 {type = "Page", name = "page", optional = false, },
1746 returnvalues = {
1747 {type = "Dict", name = "var", optional = false, },
1750 getAnnots = {
1751 type = "function",
1752 shortdesc = "TODO",
1753 arguments = {
1754 {type = "Page", name = "page", optional = false, },
1756 returnvalues = {
1757 {type = "Object", name = "var", optional = false, },
1760 getLinks = {
1761 type = "function",
1762 shortdesc = "TODO",
1763 arguments = {
1764 {type = "Page", name = "page", optional = false, },
1765 {type = "Catalog", name = "catalog", optional = false, },
1767 returnvalues = {
1768 {type = "Links", name = "var", optional = false, },
1771 getContents = {
1772 type = "function",
1773 shortdesc = "TODO",
1774 arguments = {
1775 {type = "Page", name = "page", optional = false, },
1777 returnvalues = {
1778 {type = "Object", name = "var", optional = false, },
1782 ------------------------------------------------------------------------
1783 PDFDoc = {
1784 isOK = {
1785 type = "function",
1786 shortdesc = "Check if PDFDoc object is ok.",
1787 arguments = {
1788 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1790 returnvalues = {
1791 {type = "boolean", name = "var", optional = false, },
1794 getErrorCode = {
1795 type = "function",
1796 shortdesc = "TODO",
1797 arguments = {
1798 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1800 returnvalues = {
1801 {type = "integer", name = "var", optional = false, },
1804 getErrorCodeName = {
1805 type = "function",
1806 shortdesc = "TODO",
1807 arguments = {
1808 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1810 returnvalues = {
1811 {type = "string", name = "var", optional = false, },
1814 getFileName = {
1815 type = "function",
1816 shortdesc = "TODO",
1817 arguments = {
1818 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1820 returnvalues = {
1821 {type = "string", name = "var", optional = false, },
1824 getXRef = {
1825 type = "function",
1826 shortdesc = "TODO",
1827 arguments = {
1828 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1830 returnvalues = {
1831 {type = "XRef", name = "var", optional = false, },
1834 getCatalog = {
1835 type = "function",
1836 shortdesc = "TODO",
1837 arguments = {
1838 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1840 returnvalues = {
1841 {type = "Catalog", name = "var", optional = false, },
1844 getPageMediaWidth = {
1845 type = "function",
1846 shortdesc = "TODO",
1847 arguments = {
1848 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1850 returnvalues = {
1851 {type = "number", name = "var", optional = false, },
1854 getPageMediaHeight = {
1855 type = "function",
1856 shortdesc = "TODO",
1857 arguments = {
1858 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1860 returnvalues = {
1861 {type = "number", name = "var", optional = false, },
1864 getPageCropWidth = {
1865 type = "function",
1866 shortdesc = "TODO",
1867 arguments = {
1868 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1870 returnvalues = {
1871 {type = "number", name = "var", optional = false, },
1874 getPageCropHeight = {
1875 type = "function",
1876 shortdesc = "TODO",
1877 arguments = {
1878 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1880 returnvalues = {
1881 {type = "number", name = "var", optional = false, },
1884 getNumPages = {
1885 type = "function",
1886 shortdesc = "TODO",
1887 arguments = {
1888 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1890 returnvalues = {
1891 {type = "integer", name = "var", optional = false, },
1894 readMetadata = {
1895 type = "function",
1896 shortdesc = "TODO",
1897 arguments = {
1898 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1900 returnvalues = {
1901 {type = "string", name = "var", optional = false, },
1904 getStructTreeRoot = {
1905 type = "function",
1906 shortdesc = "TODO",
1907 arguments = {
1908 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1910 returnvalues = {
1911 {type = "Object", name = "var", optional = false, },
1914 findPage = {
1915 type = "function",
1916 shortdesc = "Get a Page number by object number and generation.",
1917 arguments = {
1918 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1919 {type = "integer", name = "object number", optional = false, },
1920 {type = "integer", name = "object generation", optional = false, },
1922 returnvalues = {
1923 {type = "integer", name = "var", optional = false, },
1926 getLinks = {
1927 type = "function",
1928 shortdesc = "TODO",
1929 arguments = {
1930 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1931 {type = "integer", name = "integer", optional = false, },
1933 returnvalues = {
1934 {type = "Links", name = "var", optional = false, },
1937 findDest = {
1938 type = "function",
1939 shortdesc = "TODO",
1940 arguments = {
1941 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1942 {type = "string", name = "string", optional = false, },
1944 returnvalues = {
1945 {type = "LinkDest", name = "var", optional = false, },
1948 isEncrypted = {
1949 type = "function",
1950 shortdesc = "TODO",
1951 arguments = {
1952 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1954 returnvalues = {
1955 {type = "boolean", name = "var", optional = false, },
1958 okToPrint = {
1959 type = "function",
1960 shortdesc = "TODO",
1961 arguments = {
1962 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1964 returnvalues = {
1965 {type = "boolean", name = "var", optional = false, },
1968 okToChange = {
1969 type = "function",
1970 shortdesc = "TODO",
1971 arguments = {
1972 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1974 returnvalues = {
1975 {type = "boolean", name = "var", optional = false, },
1978 okToCopy = {
1979 type = "function",
1980 shortdesc = "TODO",
1981 arguments = {
1982 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1984 returnvalues = {
1985 {type = "boolean", name = "var", optional = false, },
1988 okToAddNotes = {
1989 type = "function",
1990 shortdesc = "TODO",
1991 arguments = {
1992 {type = "PDFDoc", name = "pdfdoc", optional = false, },
1994 returnvalues = {
1995 {type = "boolean", name = "var", optional = false, },
1998 isLinearized = {
1999 type = "function",
2000 shortdesc = "TODO",
2001 arguments = {
2002 {type = "PDFDoc", name = "pdfdoc", optional = false, },
2004 returnvalues = {
2005 {type = "boolean", name = "var", optional = false, },
2008 getDocInfo = {
2009 type = "function",
2010 shortdesc = "TODO",
2011 arguments = {
2012 {type = "PDFDoc", name = "pdfdoc", optional = false, },
2014 returnvalues = {
2015 {type = "Object", name = "var", optional = false, },
2018 getDocInfoNF = {
2019 type = "function",
2020 shortdesc = "TODO",
2021 arguments = {
2022 {type = "PDFDoc", name = "pdfdoc", optional = false, },
2024 returnvalues = {
2025 {type = "Object", name = "var", optional = false, },
2028 getPDFMajorVersion = {
2029 type = "function",
2030 shortdesc = "TODO",
2031 arguments = {
2032 {type = "PDFDoc", name = "pdfdoc", optional = false, },
2034 returnvalues = {
2035 {type = "integer", name = "var", optional = false, },
2038 getPDFMinorVersion = {
2039 type = "function",
2040 shortdesc = "TODO",
2041 arguments = {
2042 {type = "PDFDoc", name = "pdfdoc", optional = false, },
2044 returnvalues = {
2045 {type = "integer", name = "var", optional = false, },
2049 ------------------------------------------------------------------------
2050 PDFRectangle = {
2051 isValid = {
2052 type = "function",
2053 shortdesc = "TODO",
2054 arguments = {
2055 {type = "PDFRectangle", name = "pdfrectangle", optional = false, },
2057 returnvalues = {
2058 {type = "boolean", name = "var", optional = false, },
2062 ------------------------------------------------------------------------
2063 Stream = {
2064 getKind = {
2065 type = "function",
2066 shortdesc = "TODO",
2067 arguments = {
2068 {type = "Stream", name = "stream", optional = false, },
2070 returnvalues = {
2071 {type = "integer", name = "var", optional = false, },
2074 getKindName = {
2075 type = "function",
2076 shortdesc = "TODO",
2077 arguments = {
2078 {type = "Stream", name = "stream", optional = false, },
2080 returnvalues = {
2081 {type = "string", name = "var", optional = false, },
2084 reset = {
2085 type = "function",
2086 shortdesc = "TODO",
2087 arguments = {
2088 {type = "Stream", name = "stream", optional = false, },
2090 returnvalues = {
2093 close = {
2094 type = "function",
2095 shortdesc = "TODO",
2096 arguments = {
2097 {type = "Stream", name = "stream", optional = false, },
2099 returnvalues = {
2102 getChar = {
2103 type = "function",
2104 shortdesc = "TODO",
2105 arguments = {
2106 {type = "Stream", name = "stream", optional = false, },
2108 returnvalues = {
2109 {type = "integer", name = "var", optional = false, },
2112 lookChar = {
2113 type = "function",
2114 shortdesc = "TODO",
2115 arguments = {
2116 {type = "Stream", name = "stream", optional = false, },
2118 returnvalues = {
2119 {type = "integer", name = "var", optional = false, },
2122 getRawChar = {
2123 type = "function",
2124 shortdesc = "TODO",
2125 arguments = {
2126 {type = "Stream", name = "stream", optional = false, },
2128 returnvalues = {
2129 {type = "integer", name = "var", optional = false, },
2132 getUnfilteredChar = {
2133 type = "function",
2134 shortdesc = "TODO",
2135 arguments = {
2136 {type = "Stream", name = "stream", optional = false, },
2138 returnvalues = {
2139 {type = "integer", name = "var", optional = false, },
2142 unfilteredReset = {
2143 type = "function",
2144 shortdesc = "TODO",
2145 arguments = {
2146 {type = "Stream", name = "stream", optional = false, },
2148 returnvalues = {
2151 getPos = {
2152 type = "function",
2153 shortdesc = "TODO",
2154 arguments = {
2155 {type = "Stream", name = "stream", optional = false, },
2157 returnvalues = {
2158 {type = "integer", name = "var", optional = false, },
2161 isBinary = {
2162 type = "function",
2163 shortdesc = "TODO",
2164 arguments = {
2165 {type = "Stream", name = "stream", optional = false, },
2167 returnvalues = {
2168 {type = "boolean", name = "var", optional = false, },
2171 getUndecodedStream = {
2172 type = "function",
2173 shortdesc = "TODO",
2174 arguments = {
2175 {type = "Stream", name = "stream", optional = false, },
2177 returnvalues = {
2178 {type = "Stream", name = "var", optional = false, },
2181 getDict = {
2182 type = "function",
2183 shortdesc = "TODO",
2184 arguments = {
2185 {type = "Stream", name = "stream", optional = false, },
2187 returnvalues = {
2188 {type = "Dict", name = "var", optional = false, },
2192 ------------------------------------------------------------------------
2193 XRef = {
2194 isOK = {
2195 type = "function",
2196 shortdesc = "Check if XRef object is ok.",
2197 arguments = {
2198 {type = "XRef", name = "xref", optional = false, },
2200 returnvalues = {
2201 {type = "boolean", name = "var", optional = false, },
2204 getErrorCode = {
2205 type = "function",
2206 shortdesc = "TODO",
2207 arguments = {
2208 {type = "XRef", name = "xref", optional = false, },
2210 returnvalues = {
2211 {type = "integer", name = "var", optional = false, },
2214 isEncrypted = {
2215 type = "function",
2216 shortdesc = "TODO",
2217 arguments = {
2218 {type = "XRef", name = "xref", optional = false, },
2220 returnvalues = {
2221 {type = "boolean", name = "var", optional = false, },
2224 okToPrint = {
2225 type = "function",
2226 shortdesc = "TODO",
2227 arguments = {
2228 {type = "XRef", name = "xref", optional = false, },
2230 returnvalues = {
2231 {type = "boolean", name = "var", optional = false, },
2234 okToPrintHighRes = {
2235 type = "function",
2236 shortdesc = "TODO",
2237 arguments = {
2238 {type = "XRef", name = "xref", optional = false, },
2240 returnvalues = {
2241 {type = "boolean", name = "var", optional = false, },
2244 okToChange = {
2245 type = "function",
2246 shortdesc = "TODO",
2247 arguments = {
2248 {type = "XRef", name = "xref", optional = false, },
2250 returnvalues = {
2251 {type = "boolean", name = "var", optional = false, },
2254 okToCopy = {
2255 type = "function",
2256 shortdesc = "TODO",
2257 arguments = {
2258 {type = "XRef", name = "xref", optional = false, },
2260 returnvalues = {
2261 {type = "boolean", name = "var", optional = false, },
2264 okToAddNotes = {
2265 type = "function",
2266 shortdesc = "TODO",
2267 arguments = {
2268 {type = "XRef", name = "xref", optional = false, },
2270 returnvalues = {
2271 {type = "boolean", name = "var", optional = false, },
2274 okToFillForm = {
2275 type = "function",
2276 shortdesc = "TODO",
2277 arguments = {
2278 {type = "XRef", name = "xref", optional = false, },
2280 returnvalues = {
2281 {type = "boolean", name = "var", optional = false, },
2284 okToAccessibility = {
2285 type = "function",
2286 shortdesc = "TODO",
2287 arguments = {
2288 {type = "XRef", name = "xref", optional = false, },
2290 returnvalues = {
2291 {type = "boolean", name = "var", optional = false, },
2294 okToAssemble = {
2295 type = "function",
2296 shortdesc = "TODO",
2297 arguments = {
2298 {type = "XRef", name = "xref", optional = false, },
2300 returnvalues = {
2301 {type = "boolean", name = "var", optional = false, },
2304 getCatalog = {
2305 type = "function",
2306 shortdesc = "TODO",
2307 arguments = {
2308 {type = "XRef", name = "xref", optional = false, },
2310 returnvalues = {
2311 {type = "Object", name = "var", optional = false, },
2314 fetch = {
2315 type = "function",
2316 shortdesc = "TODO",
2317 arguments = {
2318 {type = "XRef", name = "xref", optional = false, },
2319 {type = "integer", name = "integer", optional = false, },
2320 {type = "integer", name = "integer", optional = false, },
2322 returnvalues = {
2323 {type = "Object", name = "var", optional = false, },
2326 getDocInfo = {
2327 type = "function",
2328 shortdesc = "TODO",
2329 arguments = {
2330 {type = "XRef", name = "xref", optional = false, },
2332 returnvalues = {
2333 {type = "Object", name = "var", optional = false, },
2336 getDocInfoNF = {
2337 type = "function",
2338 shortdesc = "TODO",
2339 arguments = {
2340 {type = "XRef", name = "xref", optional = false, },
2342 returnvalues = {
2343 {type = "Object", name = "var", optional = false, },
2346 getNumObjects = {
2347 type = "function",
2348 shortdesc = "TODO",
2349 arguments = {
2350 {type = "XRef", name = "xref", optional = false, },
2352 returnvalues = {
2353 {type = "integer", name = "var", optional = false, },
2356 getRootNum = {
2357 type = "function",
2358 shortdesc = "TODO",
2359 arguments = {
2360 {type = "XRef", name = "xref", optional = false, },
2362 returnvalues = {
2363 {type = "integer", name = "var", optional = false, },
2366 getRootGen = {
2367 type = "function",
2368 shortdesc = "TODO",
2369 arguments = {
2370 {type = "XRef", name = "xref", optional = false, },
2372 returnvalues = {
2373 {type = "integer", name = "var", optional = false, },
2376 getSize = {
2377 type = "function",
2378 shortdesc = "TODO",
2379 arguments = {
2380 {type = "XRef", name = "xref", optional = false, },
2382 returnvalues = {
2383 {type = "integer", name = "var", optional = false, },
2386 getTrailerDict = {
2387 type = "function",
2388 shortdesc = "TODO",
2389 arguments = {
2390 {type = "XRef", name = "xref", optional = false, },
2392 returnvalues = {
2393 {type = "Object", name = "var", optional = false, },
2397 ------------------------------------------------------------------------
2401 return fdata_epdf