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