1PDF::API2::Basic::PDF::UPsaegresC(o3n)tributed Perl DocuPmDeFn:t:aAtPiIo2n::Basic::PDF::Pages(3)
2
3
4
6 PDF::API2::Basic::PDF::Pages - a PDF pages hierarchical element.
7 Inherits from PDF::API2::Basic::PDF::Dict
8
10 A Pages object is the parent to other pages objects or to page objects
11 themselves.
12
14 PDF::API2::Basic::PDF::Pages->new($pdf, $parent)
15 This creates a new Pages object in a PDF. Notice that $parent here is
16 not the file context for the object but the parent pages object for
17 this pages. If we are using this class to create a root node, then
18 $parent should point to the file context, which is identified by not
19 having a Type of Pages. $pdf is the file object (or a reference to an
20 array of file objects) in which to create the new Pages object.
21
22 $p->find_page($page_number)
23 Returns the given page, using the page count values in the pages tree.
24 Pages start at 0.
25
26 $p->add_page($page, $page_number)
27 Inserts the page before the given $page_number. $page_number can be
28 negative to count from the END of the document. -1 is after the last
29 page. Likewise $page_number can be greater than the number of pages
30 currently in the document, to append.
31
32 @objects = $p->get_pages()
33 Returns a list of page objects in the document in page order
34
35 $p->find_prop($key)
36 Searches up through the inheritance tree to find a property.
37
38 $p->add_font($pdf, $font)
39 Creates or edits the resource dictionary at this level in the
40 hierarchy. If the font is already supported even through the hierarchy,
41 then it is not added.
42
43 $p->bbox($xmin, $ymin, $xmax, $ymax, [$param])
44 Specifies the bounding box for this and all child pages. If the values
45 are identical to those inherited then no change is made. $param
46 specifies the attribute name so that other 'bounding box'es can be set
47 with this method.
48
49 $p->proc_set(@entries)
50 Ensures that the current resource contains all the entries in the
51 proc_sets listed. If necessary it creates a local resource dictionary
52 to achieve this.
53
54 $p->get_top
55 Returns the top of the pages tree
56
57
58
59perl v5.32.0 2020-07-28 PDF::API2::Basic::PDF::Pages(3)