.\" -*- 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 "TableInfo 3pm" .TH TableInfo 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::Report::TableInfo \- Object that holds all the GroupInfo and ColumnInfo for one subreport .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 2 \& my $info = $subreport\->table_info; \& my $col_info = $info\->colum_info( "request_total" ); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" The Lire::Report::TableInfo object holds the ColumnInfo and GroupInfo objects for one subreport.. .SH CONSTRUCTOR .IX Header "CONSTRUCTOR" .SS \fBnew()\fP .IX Subsection "new()" Creates a new Lire::Report::TableInfo object. .ie n .SS "column_info_by_name( $name )" .el .SS "column_info_by_name( \f(CW$name\fP )" .IX Subsection "column_info_by_name( $name )" Returns the Lire::Report::ColumnInfo object that has the name \f(CW$name\fR. .PP Contrary to the method in Lire::Report::GroupInfo, this one will throw an exception if there is no column named \f(CW$name\fR. .ie n .SS "column_info_by_col_start( $idx )" .el .SS "column_info_by_col_start( \f(CW$idx\fP )" .IX Subsection "column_info_by_col_start( $idx )" Returns the Lire::Report::ColumnInfo object that is starts at column index \f(CW$idx\fR. .PP Contrary to the method in Lire::Report::GroupInfo, this one will throw an exception if this column is out of bounds. .ie n .SS "group_info( $name )" .el .SS "group_info( \f(CW$name\fP )" .IX Subsection "group_info( $name )" Returns the Lire::Report::GroupInfo object that has the name \f(CW$name\fR. .PP Contrary to the method in Lire::Report::GroupInfo, this one will throw an exception if there is no column named \f(CW$name\fR. .SS \fBncols()\fP .IX Subsection "ncols()" Returns the number of columns there is in this table. .SS \fBcolumn_infos()\fP .IX Subsection "column_infos()" Returns an array containing all the columns of the table. Each element is a Lire::Report::ColumnInfo object. .SS \fBgroups()\fP .IX Subsection "groups()" Returns an array containing all the groups of the table. Each element is a Lire::Report::GroupInfo object. .SS \fBcolumns_width()\fP .IX Subsection "columns_width()" Returns an array where each element represents the suggested columns\*(Aq width in characters. .SS \fBheader_rows()\fP .IX Subsection "header_rows()" Returns an array reference containing one array reference for each rows in the header. Each row contains the ColumnInfo that should appear on the header line. The first row contains all the numerical columns and the categorical columns appear based on their nesting. The indices of the column is always equals to its column\*(Aqs start. .SS \fBset_variables_indices()\fP .IX Subsection "set_variables_indices()" Registers this TableInfo\*(Aqs variables using Lire::Config::VariableIndex. .SS \fBreset_variable_indices()\fP .IX Subsection "reset_variable_indices()" Removes the variables indices. This can be called to undo the effect of \fBset_variables_indices()\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBLire::Report::Subreport\fR\|(3pm) \fBLire::Report::ColumnInfo\fR\|(3pm) .SH VERSION .IX Header "VERSION" \&\f(CW$Id:\fR TableInfo.pm,v 1.26 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