jammy (3) PDF::Builder::Basic::PDF::Pages.3pm.gz

NAME

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

DESCRIPTION

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

METHODS

   PDF::Builder::Basic::PDF::Pages->new($pdf, $parent)
       This creates a new Pages object in a PDF. Notice that the $parent here is not the file context for the
       object, but the parent pages object for these pages. If we are using this class to create a root node,
       $parent should point to the file context, which is identified by not having a Type of Pages. $pdf is the
       file object (or a reference to an array of one file object [3.016 and later, or multiple file objects
       earlier]) in which to create the new Pages object.

   $p->find_page($page_number)
       Returns the given page, using the page count values in the pages tree. Pages start at 0.

   $p->add_page($page, $page_number)
       Inserts the page before the given $page_number. $page_number can be negative to count backwards from the
       END of the document. -1 is after the last page. Likewise $page_number can be greater than the number of
       pages currently in the document, to append.

       This method only guarantees to provide a reasonable pages tree if pages are appended or prepended to the
       document. Pages inserted in the middle of the document may simply be inserted in the appropriate leaf in
       the pages tree without adding any new branches or leaves, leaving it unbalanced (slower performance, but
       still usable).

   @objects = $p->get_pages()
       Returns a list of page objects in the document, in page order.

   $p->find_prop($key)
       Searches up through the inheritance tree to find a property (key).

   $p->add_font($pdf, $font)
       Creates or edits the resource dictionary at this level in the hierarchy. If the font is already
       supported, even through the hierarchy, then it is not added.

       CAUTION: if this method was used in older releases, the code may have swapped the order of $pdf and
       $font, requiring ad hoc swapping of parameters in user code, contrary to the POD definition above. Now
       the code matches the documentation.

   $p->bbox($xmin,$ymin, $xmax,$ymax, $param)
   $p->bbox($xmin,$ymin, $xmax,$ymax)
       Specifies the bounding box for this and all child pages. If the values are identical to those inherited,
       no change is made. $param specifies the attribute name so that other 'bounding box'es can be set with
       this method.

   $p->proc_set(@entries)
       Ensures that the current resource contains all the entries in the proc_sets listed. If necessary, it
       creates a local resource dictionary to achieve this.

   $p->get_top()
       Returns the top of the pages tree.