.\" -*- 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 "Section 3pm"
.TH Section 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::Section \- Interface to the content of the section\*(Aqs element.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    my $section = Lire::ReportParser::ReportBuilder( "report.xml" );
\&
\&    foreach my $s ( $report\->sections() ) {
\&        print "Section: \*(Aq", $s\->title(), "\*(Aq has ", scalar $s\->subreports(),
\&            " subreports in it\en";
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class offers an API to the section\*(Aqs elements of a Lire report.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.SS "new( [$title] )"
.IX Subsection "new( [$title] )"
Creates a new Lire::Report::Section. The section\*(Aqs title will be set
to the \f(CW$title\fR parameter if present.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.SS "title( [$title] )"
.IX Subsection "title( [$title] )"
Returns the section\*(Aqs title, if it has one. The section\*(Aqs title will
be changed \f(CW$title\fR if that parameter is set.
.SS "description( [$description] )"
.IX Subsection "description( [$description] )"
Returns this section\*(Aqs description. The description is encoded in
DocBook XML.
.PP
If the \f(CW$description\fR parameter is set, this method will set this
section\*(Aqs description to this new value. If the \f(CW$description\fR parameter
is undef, that description will be removed.
.SS \fBsubreports()\fP
.IX Subsection "subreports()"
Returns the subreport\*(Aqs included in that section. This will be an array of
Lire::Report::Subreport objects.
.ie n .SS "add_subreport( $subreport )"
.el .SS "add_subreport( \f(CW$subreport\fP )"
.IX Subsection "add_subreport( $subreport )"
Adds a subreport to this report. The \f(CW$subreport\fR parameter should be a
Lire::Report::Subreport object.
.ie n .SS "subreports_by_type( $type )"
.el .SS "subreports_by_type( \f(CW$type\fP )"
.IX Subsection "subreports_by_type( $type )"
Returns all the subreports in this section of a the type \f(CW$type\fR. The
subreport\*(Aqs type is the id of the report specification used to compute
the reports. The subreports are returned as an array of
Lire::Report::Subreport objects.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::ReportParser::ReportBuilder\fR\|(3pm) \fBLire::Report\fR\|(3pm)
\&\fBLire::Report::Subreport\fR\|(3pm) \fBLire::Report::Entry\fR\|(3pm)
\&\fBLire::Report::Group\fR\|(3pm)
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR Section.pm,v 1.16 2006/07/23 13:16:31 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2002 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.
.SH AUTHOR
.IX Header "AUTHOR"
Francis J. Lacoste <flacoste@logreport.org>