1PDF::Builder::Basic::PDUFs:e:rPaCgoenst(r3i)buted Perl DPoDcFu:m:eBnutialtdieorn::Basic::PDF::Pages(3)
2
3
4

NAME

6       PDF::Builder::Basic::PDF::Pages - a PDF pages hierarchical element.
7       Inherits from PDF::Builder::Basic::PDF::Dict
8

DESCRIPTION

10       A Pages object is the parent to other pages objects or to page objects
11       themselves.
12

METHODS

14   PDF::Builder::Basic::PDF::Pages->new($pdf, $parent)
15       This creates a new Pages object in a PDF. Notice that the $parent here
16       is not the file context for the object, but the parent pages object for
17       these pages. If we are using this class to create a root node, $parent
18       should point to the file context, which is identified by not having a
19       Type of Pages. $pdf is the file object (or a reference to an array of
20       one file object [3.016 and later, or multiple file objects earlier]) in
21       which to create the new Pages object.
22
23   $p->find_page($page_number)
24       Returns the given page, using the page count values in the pages tree.
25       Pages start at 0.
26
27   $p->add_page($page, $page_number)
28       Inserts the page before the given $page_number. $page_number can be
29       negative to count backwards from the END of the document. -1 is after
30       the last page. Likewise $page_number can be greater than the number of
31       pages currently in the document, to append.
32
33       This method only guarantees to provide a reasonable pages tree if pages
34       are appended or prepended to the document. Pages inserted in the middle
35       of the document may simply be inserted in the appropriate leaf in the
36       pages tree without adding any new branches or leaves, leaving it
37       unbalanced (slower performance, but still usable).
38
39   @objects = $p->get_pages()
40       Returns a list of page objects in the document, in page order.
41
42   $p->find_prop($key)
43       Searches up through the inheritance tree to find a property (key).
44
45   $p->add_font($pdf, $font)
46       Creates or edits the resource dictionary at this level in the
47       hierarchy. If the font is already supported, even through the
48       hierarchy, then it is not added.
49
50       CAUTION: if this method was used in older releases, the code may have
51       swapped the order of $pdf and $font, requiring ad hoc swapping of
52       parameters in user code, contrary to the POD definition above. Now the
53       code matches the documentation.
54
55   $p->bbox($xmin,$ymin, $xmax,$ymax, $param)
56   $p->bbox($xmin,$ymin, $xmax,$ymax)
57       Specifies the bounding box for this and all child pages. If the values
58       are identical to those inherited, no change is made. $param specifies
59       the attribute name so that other 'bounding box'es can be set with this
60       method.
61
62   $p->proc_set(@entries)
63       Ensures that the current resource contains all the entries in the
64       proc_sets listed. If necessary, it creates a local resource dictionary
65       to achieve this.
66
67   $p->get_top()
68       Returns the top of the pages tree.
69
70
71
72perl v5.34.0                      2022-01-21PDF::Builder::Basic::PDF::Pages(3)
Impressum