.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PDF::Builder::Basic::PDF::Page 3"
.TH PDF::Builder::Basic::PDF::Page 3 2023-12-21 "perl v5.38.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
PDF::Builder::Basic::PDF::Page \- Represents a PDF page, inherits from PDF::Builder::Basic::PDF::Pages
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Represents a page of output in PDF. It also keeps track of the content stream,
any resources (such as fonts) being switched, etc.
.PP
Page inherits from Pages due to a number of shared methods. They are really
structurally quite different.
.SH "INSTANCE VARIABLES"
.IX Header "INSTANCE VARIABLES"
A page has various working variables:
.IP "' curstrm'" 4
.IX Item "' curstrm'"
The currently open stream
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 1
\&    PDF::Builder::Basic::PDF::Page\->new($pdf, $parent, $index)
.Ve
.Sp
.RS 4
Creates a new page based on a pages object (perhaps the root object).
.Sp
The page is also added to the parent at this point, so pages are ordered in
a PDF document in the order in which they are created rather than in the order
they are closed.
.Sp
Only the essential elements in the page dictionary are created here, all others
are either optional or can be inherited.
.Sp
The optional index value indicates the index in the parent list that this page
should be inserted (so that new pages need not be appended)
.RE
.SS ship_out
.IX Subsection "ship_out"
.Vb 1
\&    $p\->ship_out($pdf)
.Ve
.Sp
.RS 4
Ships the page out to the given output file context
.RE