.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PDF::API2::Page 3pm"
.TH PDF::API2::Page 3pm "2014-03-09" "perl v5.14.2" "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::API2::Page \- page management
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$page = PDF::API2::Page\->new $pdf, $parent, $index" 4
.el .IP "\f(CW$page\fR = PDF::API2::Page\->new \f(CW$pdf\fR, \f(CW$parent\fR, \f(CW$index\fR" 4
.IX Item "$page = PDF::API2::Page->new $pdf, $parent, $index"
Returns a page object (called from \f(CW$pdf\fR\->page).
.ie n .IP "$page = PDF::API2::Page\->coerce $pdf, $pdfpage" 4
.el .IP "\f(CW$page\fR = PDF::API2::Page\->coerce \f(CW$pdf\fR, \f(CW$pdfpage\fR" 4
.IX Item "$page = PDF::API2::Page->coerce $pdf, $pdfpage"
Returns a page object converted from \f(CW$pdfpage\fR (called from \f(CW$pdf\fR\->openpage).
.ie n .IP "$page\->update" 4
.el .IP "\f(CW$page\fR\->update" 4
.IX Item "$page->update"
Marks a page to be updated (by \f(CW$pdf\fR\->update).
.ie n .IP "$page\->mediabox $w, $h" 4
.el .IP "\f(CW$page\fR\->mediabox \f(CW$w\fR, \f(CW$h\fR" 4
.IX Item "$page->mediabox $w, $h"
.PD 0
.ie n .IP "$page\->mediabox $llx, $lly, $urx, $ury" 4
.el .IP "\f(CW$page\fR\->mediabox \f(CW$llx\fR, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR" 4
.IX Item "$page->mediabox $llx, $lly, $urx, $ury"
.ie n .IP "$page\->mediabox $alias" 4
.el .IP "\f(CW$page\fR\->mediabox \f(CW$alias\fR" 4
.IX Item "$page->mediabox $alias"
.PD
Sets the mediabox.  This method supports the following aliases:
\&'4A', '2A', 'A0', 'A1', 'A2', 'A3', 'A4', 'A5', 'A6',
\&'4B', '2B', 'B0', 'B1', 'B2', 'B3', 'B4', 'B5', 'B6',
\&'\s-1LETTER\s0', '\s-1BROADSHEET\s0', '\s-1LEDGER\s0', '\s-1TABLOID\s0', '\s-1LEGAL\s0',
\&'\s-1EXECUTIVE\s0', and '36X36'.
.ie n .IP "($llx, $lly, $urx, $ury) = $page\->get_mediabox" 4
.el .IP "($llx, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR) = \f(CW$page\fR\->get_mediabox" 4
.IX Item "($llx, $lly, $urx, $ury) = $page->get_mediabox"
Gets the mediabox based one best estimates or the default.
.ie n .IP "$page\->cropbox $w, $h" 4
.el .IP "\f(CW$page\fR\->cropbox \f(CW$w\fR, \f(CW$h\fR" 4
.IX Item "$page->cropbox $w, $h"
.PD 0
.ie n .IP "$page\->cropbox $llx, $lly, $urx, $ury" 4
.el .IP "\f(CW$page\fR\->cropbox \f(CW$llx\fR, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR" 4
.IX Item "$page->cropbox $llx, $lly, $urx, $ury"
.ie n .IP "$page\->cropbox $alias" 4
.el .IP "\f(CW$page\fR\->cropbox \f(CW$alias\fR" 4
.IX Item "$page->cropbox $alias"
.PD
Sets the cropbox.  This method supports the same aliases as mediabox.
.ie n .IP "($llx, $lly, $urx, $ury) = $page\->get_cropbox" 4
.el .IP "($llx, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR) = \f(CW$page\fR\->get_cropbox" 4
.IX Item "($llx, $lly, $urx, $ury) = $page->get_cropbox"
Gets the cropbox based one best estimates or the default.
.ie n .IP "$page\->bleedbox $w, $h" 4
.el .IP "\f(CW$page\fR\->bleedbox \f(CW$w\fR, \f(CW$h\fR" 4
.IX Item "$page->bleedbox $w, $h"
.PD 0
.ie n .IP "$page\->bleedbox $llx, $lly, $urx, $ury" 4
.el .IP "\f(CW$page\fR\->bleedbox \f(CW$llx\fR, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR" 4
.IX Item "$page->bleedbox $llx, $lly, $urx, $ury"
.ie n .IP "$page\->bleedbox $alias" 4
.el .IP "\f(CW$page\fR\->bleedbox \f(CW$alias\fR" 4
.IX Item "$page->bleedbox $alias"
.PD
Sets the bleedbox.  This method supports the same aliases as mediabox.
.ie n .IP "($llx, $lly, $urx, $ury) = $page\->get_bleedbox" 4
.el .IP "($llx, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR) = \f(CW$page\fR\->get_bleedbox" 4
.IX Item "($llx, $lly, $urx, $ury) = $page->get_bleedbox"
Gets the bleedbox based one best estimates or the default.
.ie n .IP "$page\->trimbox $w, $h" 4
.el .IP "\f(CW$page\fR\->trimbox \f(CW$w\fR, \f(CW$h\fR" 4
.IX Item "$page->trimbox $w, $h"
.PD 0
.ie n .IP "$page\->trimbox $llx, $lly, $urx, $ury" 4
.el .IP "\f(CW$page\fR\->trimbox \f(CW$llx\fR, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR" 4
.IX Item "$page->trimbox $llx, $lly, $urx, $ury"
.PD
Sets the trimbox.  This method supports the same aliases as mediabox.
.ie n .IP "($llx, $lly, $urx, $ury) = $page\->get_trimbox" 4
.el .IP "($llx, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR) = \f(CW$page\fR\->get_trimbox" 4
.IX Item "($llx, $lly, $urx, $ury) = $page->get_trimbox"
Gets the trimbox based one best estimates or the default.
.ie n .IP "$page\->artbox $w, $h" 4
.el .IP "\f(CW$page\fR\->artbox \f(CW$w\fR, \f(CW$h\fR" 4
.IX Item "$page->artbox $w, $h"
.PD 0
.ie n .IP "$page\->artbox $llx, $lly, $urx, $ury" 4
.el .IP "\f(CW$page\fR\->artbox \f(CW$llx\fR, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR" 4
.IX Item "$page->artbox $llx, $lly, $urx, $ury"
.ie n .IP "$page\->artbox $alias" 4
.el .IP "\f(CW$page\fR\->artbox \f(CW$alias\fR" 4
.IX Item "$page->artbox $alias"
.PD
Sets the artbox.  This method supports the same aliases as mediabox.
.ie n .IP "($llx, $lly, $urx, $ury) = $page\->get_artbox" 4
.el .IP "($llx, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR) = \f(CW$page\fR\->get_artbox" 4
.IX Item "($llx, $lly, $urx, $ury) = $page->get_artbox"
Gets the artbox based one best estimates or the default.
.ie n .IP "$page\->rotate $deg" 4
.el .IP "\f(CW$page\fR\->rotate \f(CW$deg\fR" 4
.IX Item "$page->rotate $deg"
Rotates the page by the given degrees, which must be a multiple of 90.
.Sp
(This allows you to auto-rotate to landscape without changing the mediabox!)
.ie n .IP "$gfx = $page\->gfx $prepend" 4
.el .IP "\f(CW$gfx\fR = \f(CW$page\fR\->gfx \f(CW$prepend\fR" 4
.IX Item "$gfx = $page->gfx $prepend"
Returns a graphics content object. If \f(CW$prepend\fR is true the content
will be prepended to the page description.
.ie n .IP "$txt = $page\->text $prepend" 4
.el .IP "\f(CW$txt\fR = \f(CW$page\fR\->text \f(CW$prepend\fR" 4
.IX Item "$txt = $page->text $prepend"
Returns a text content object. If \f(CW$prepend\fR is true the content
will be prepended to the page description.
.ie n .IP "$ant = $page\->annotation" 4
.el .IP "\f(CW$ant\fR = \f(CW$page\fR\->annotation" 4
.IX Item "$ant = $page->annotation"
Returns a new annotation object.
.ie n .IP "$page\->resource $type, $key, $obj" 4
.el .IP "\f(CW$page\fR\->resource \f(CW$type\fR, \f(CW$key\fR, \f(CW$obj\fR" 4
.IX Item "$page->resource $type, $key, $obj"
Adds a resource to the page-inheritance tree.
.Sp
\&\fBExample:\fR
.Sp
.Vb 4
\&    $co\->resource(\*(AqFont\*(Aq,$fontkey,$fontobj);
\&    $co\->resource(\*(AqXObject\*(Aq,$imagekey,$imageobj);
\&    $co\->resource(\*(AqShading\*(Aq,$shadekey,$shadeobj);
\&    $co\->resource(\*(AqColorSpace\*(Aq,$spacekey,$speceobj);
.Ve
.Sp
\&\fBNote:\fR You only have to add the required resources, if
they are \s-1NOT\s0 handled by the *font*, *image*, *shade* or *space*
methods.
.SH "AUTHOR"
.IX Header "AUTHOR"
Alfred Reibenschuh