Current File : //home/strato/chroot/opt/RZperl536/man/man3/PDF::API2::Resource::XObject::Form.3

.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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" ''
.    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::API2::Resource::XObject::Form 3"
.TH PDF::API2::Resource::XObject::Form 3 "2014-02-20" "perl v5.36.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::API2::Resource::XObject::Form
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$res = PDF::API2::Resource::XObject::Form\->new $pdf" 4
.el .IP "\f(CW$res\fR = PDF::API2::Resource::XObject::Form\->new \f(CW$pdf\fR" 4
.IX Item "$res = PDF::API2::Resource::XObject::Form->new $pdf"
Returns a form-resource object. base class for all types of form-xobjects.
.ie n .IP "$res = PDF::API2::Resource::XObject::Form\->new_api $api, $name" 4
.el .IP "\f(CW$res\fR = PDF::API2::Resource::XObject::Form\->new_api \f(CW$api\fR, \f(CW$name\fR" 4
.IX Item "$res = PDF::API2::Resource::XObject::Form->new_api $api, $name"
Returns a form resource object. This method is different from 'new' that
it needs an PDF::API2\-object rather than a Text::PDF::File\-object.
.ie n .IP "($llx, $lly, $urx, $ury) = $res\->bbox $llx, $lly, $urx, $ury" 4
.el .IP "($llx, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR) = \f(CW$res\fR\->bbox \f(CW$llx\fR, \f(CW$lly\fR, \f(CW$urx\fR, \f(CW$ury\fR" 4
.IX Item "($llx, $lly, $urx, $ury) = $res->bbox $llx, $lly, $urx, $ury"
.PD 0
.ie n .IP "$res\->resource $type, $key, $obj" 4
.el .IP "\f(CW$res\fR\->resource \f(CW$type\fR, \f(CW$key\fR, \f(CW$obj\fR" 4
.IX Item "$res->resource $type, $key, $obj"
.PD
Adds a resource to the form.
.Sp
\&\fBExample:\fR
.Sp
.Vb 4
\&    $res\->resource(\*(AqFont\*(Aq,$fontkey,$fontobj);
\&    $res\->resource(\*(AqXObject\*(Aq,$imagekey,$imageobj);
\&    $res\->resource(\*(AqShading\*(Aq,$shadekey,$shadeobj);
\&    $res\->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