.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "WWWdb::List 3"
.TH WWWdb::List 3 "2003-04-15" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
WWWdb::List \- Lists for WWWdb
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use WWWdb::List;
.Ve
.PP
.Vb 1
\& $oList     = List->new([FillAtInsert => $bFill]);
.Ve
.PP
.Vb 1
\& $cResult   = $oList->Append($cValue);
.Ve
.PP
.Vb 1
\& $cResult   = $oList->Get($iIndex);
.Ve
.PP
.Vb 1
\& $cResult   = $oList->Set($iIndex, $cValue);
.Ve
.PP
.Vb 1
\& $cResult   = $oList->Insert($iIndex, $cValue);
.Ve
.PP
.Vb 1
\& $cResult   = $oList->Delete($iIndex);
.Ve
.PP
.Vb 1
\& $iResult   = $oList->Count();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SH "The List class"
.IX Header "The List class"
Perl is a good language for list\-manipulation. Neverthless I wished
some funktionality for imbedded class-elements in list\-form. That was
the main reason, for developing this class.
.Sh "Note"
.IX Subsection "Note"
.RS 4
none
.RE
.Sh "Class Methods"
.IX Subsection "Class Methods"
.IP "\fBnew\fR" 4
.IX Item "new"
.Vb 1
\& $oList     = List->new([FillAtInsert => $bFill]);
.Ve
.Sp
Create a new empty list. If the insertion of an element with an index
greater then the actual number of elements should be done, you have to
decide, if the elements between have to be created, or not. This can
be done with the FillAtInsert\-argument. True means, that elements with
the value \fIundef\fR will be inserted. Otherwise the new element will be
appended to the list.
.IP "\fBAppend\fR" 4
.IX Item "Append"
.Vb 1
\& $cResult   = $oList->Append($cValue);
.Ve
.Sp
Appends the value \fIcValue\fR at the end of the list. The appended value
will be returned.
.IP "\fBGet\fR" 4
.IX Item "Get"
.Vb 1
\& $bResult   = $oList->Get($iIndex);
.Ve
.Sp
Returns the element with the Index \fIiIndex\fR. Negative numbers take
elements from the end of the list, like in Perl.
.IP "\fBSet\fR" 4
.IX Item "Set"
.Vb 1
\& $cResult   = $oList->Set($iIndex, $cValue);
.Ve
.Sp
Sets the value of the element with the Index \fIiIndex\fR. Negative
numbers will use elements from the end of the list, like in Perl.
The value, that has been set will be returned.
.Sp
See also the attribute \fIFillAtInsert\fR.
.IP "\fBInsert\fR" 4
.IX Item "Insert"
.Vb 1
\& $cResult   = $oList->Insert($iIndex, $cValue);
.Ve
.Sp
Works like \fBSet\fR, but \fIinserts\fR the value into the list. This
means, that all values with a greater index will be shifted.
.Sp
See also the attribute \fIFillAtInsert\fR.
.IP "\fBDelete\fR" 4
.IX Item "Delete"
.Vb 1
\& $cResult   = $oList->Delete($iIndex);
.Ve
.Sp
Deletes the element at Index \fIiIndex\fR. The deleted element will be
returned.
.IP "\fBCount\fR" 4
.IX Item "Count"
.Vb 1
\& $iResult   = $oList->Count();
.Ve
.Sp
Returns the number of elements, the list contains.
.Sh "Class Attributes"
.IX Subsection "Class Attributes"
.IP "\fBName\fR" 4
.IX Item "Name"
.Vb 2
\& $bFill = $oList->getFillAtInsert();
\& $oList->setFillAtInsert($bFill);
.Ve
.Sp
If empty space should be filled at the insertion of elements, then this
attribute should be set.