List(3pm)						  LogReport's Lire Documentation						 List(3pm)

NAME

       Lire::Config::List - List Value Object.

DESCRIPTION

       Used for configuration parameters which contains a list of values.

   elements()
       Returns this list's values as an array of Lire::Config::Value object.

   get( $idx )
       Returns the value stored at index $idx of this list. An exception is thrown if the index is out-of-bounds.

   remove( $idx )
       Removes the value stored at index $idx of this list. An exception is thrown if the index is out-of-bounds. It returns the deleted element.

   clear()
       Removes all elements from this list

   append( $val, [ $idx ] )
       Adds $val to after element $idx. If $idx is omitted, the element will be added at the end of the array. A negative index is interpreted
       relative to the end of the array.

   move( $idx, $new_idx )
       Moves element $idx at position $new_idx. Indices can be negative and are interpreted as position relative to the end of the array.

   set( $idx, $value )
       Replaces value at index $idx with $value.

AUTHOR

	 Wessel Dankers <wsl@logreport.org>

VERSION

       $Id: List.pm,v 1.16 2006/07/23 13:16:30 vanbaal Exp $

COPYRIGHT

       Copyright (C) 2002-2004 Stichting LogReport Foundation LogReport@LogReport.org

       This file is part of Lire.

       Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with
       http://www.gnu.org/copyleft/gpl.html.

Lire 2.1.1							    2006-07-23								 List(3pm)