.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Value 3pm"
.TH Value 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire 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
Lire::Config::Value \- Lire value containers for configuration variables
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use base qw/ Lire::Config::Value /;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Value containers for configuration variables. This is the abstract
superclass for the other Lire::Config::Value classes.
.ie n .SS "new( [\*(Aqspec\*(Aq => $spec], ... )"
.el .SS "new( [\*(Aqspec\*(Aq => \f(CW$spec\fP], ... )"
.IX Subsection "new( ['spec' => $spec], ... )"
This is the constructor for the value object. Lire::Config::Value
objects should be instantiated from the \fBinstance()\fR method defined in
the TypeSpec object.
.SS \fBname()\fP
.IX Subsection "name()"
Returns this configuration parameter\*(Aqs name.
.SS \fBspec()\fP
.IX Subsection "spec()"
Returns the specification for this parameter.
.SS \fBsummary()\fP
.IX Subsection "summary()"
Returns the specification\*(Aqs summary for this value.
.SS \fBdescription()\fP
.IX Subsection "description()"
Returns the specification\*(Aqs description for this value.
.SS \fBtext_description()\fP
.IX Subsection "text_description()"
Returns the specification\*(Aqs description (formatted in plain text) for this
value.
.SS \fBas_value()\fP
.IX Subsection "as_value()"
Returns this value as a perl native value. This will be either a
scalar value, or an hash or array references. The returned values
should be normalized.
.SS \fBas_label()\fP
.IX Subsection "as_label()"
Return the label of this object for displaying in GUI\*(Aqs.
.SS \fBas_shell_var()\fP
.IX Subsection "as_shell_var()"
Returns this configuration variable\*(Aqs value in a form that can be
evaled in a shell script.
.SS \fBclone()\fP
.IX Subsection "clone()"
Return a deep_copie\*(Aqd value of this instance. The reference to the spec is
kept but is not copied.
.ie n .SS "is_equals( $param )"
.el .SS "is_equals( \f(CW$param\fP )"
.IX Subsection "is_equals( $param )"
Returns if the \f(CW$param\fR instance is identifcal to this one.
.SS \fBis_valid()\fP
.IX Subsection "is_valid()"
Checks that the current value is valid according to the specification.
.SS \fBis_default()\fP
.IX Subsection "is_default()"
Returns true if this value is equals to its specification\*(Aqs default.
.ie n .SS "save_xml( $fh )"
.el .SS "save_xml( \f(CW$fh\fP )"
.IX Subsection "save_xml( $fh )"
Writes an XML  configuration of the variable recursively on \f(CW$fh\fR.
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 3
\&  Wessel Dankers <wsl@logreport.org>
\&  Francis J. Lacoste <flacoste@logreport.org>
\&  Wolfgang Sourdeau <wolfgang@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR Value.pm,v 1.18 2008/03/09 19:27:31 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2002\-2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
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.
.PP
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.
.PP
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.