.\" -*- 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::Array 3"
.TH PDF::Builder::Basic::PDF::Array 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::Array \- Corresponds to a PDF array. 
Inherits from PDF::Builder::Basic::PDF::Objind
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 1
\&    PDF::Array\->new($parent, @values)
.Ve
.Sp
.RS 4
Creates an array with the given storage parent and an optional list of values to
initialise the array with.
.RE
.SS outobjdeep
.IX Subsection "outobjdeep"
.Vb 1
\&    $a\->outobjdeep($fh, $pdf)
.Ve
.Sp
.RS 4
Outputs an array as a PDF array to the given filehandle. It's unusual to
need to call this method from user code.
.RE
.SS elements
.IX Subsection "elements"
.Vb 1
\&    $a\->elements()
.Ve
.Sp
.RS 4
Returns the contents of the array.
.RE
.SS add_elements
.IX Subsection "add_elements"
.Vb 1
\&    $a\->add_elements(@elements)
.Ve
.Sp
.RS 4
Appends the given elements to the array. An element is only added if it
is defined.
.RE
.SS remove_element
.IX Subsection "remove_element"
.Vb 1
\&    $a\->remove_element($element)
.Ve
.Sp
.RS 4
Removes all occurrences of an element from an array.
.RE
.SS val
.IX Subsection "val"
.Vb 1
\&    $a\->val()
.Ve
.Sp
.RS 4
Returns a reference to the contents of the array.
.RE
.SS copy
.IX Subsection "copy"
.Vb 1
\&    $a\->copy($pdf)
.Ve
.Sp
.RS 4
Copies the array with deep-copy on elements which are not full PDF objects
with respect to a particular \f(CW$pdf\fR output context.
.RE