.\" -*- 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 "ColumnInfo 3pm" .TH ColumnInfo 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::ColumnInfo \- Object that holds column meta\-data. .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 5 \& my $info = $subreport\->column_info_by_idx( 0 ); \& print "Column\*(Aqs name: ", $info\->name(), "\en"; \& print "Column\*(Aqs index: ", $info\->index(), "\en"; \& print "Column\*(Aqs type: ", $info\->type(), "\en"; \& print "Column\*(Aqs label: ", $info\->label(), "\en"; .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" The Lire::Report::ColumnInfo object contains meta\-data information on the columns of a subreport. .SH CONSTRUCTOR .IX Header "CONSTRUCTOR" .ie n .SS "new( $group, $name, $class, $type, [$label]])" .el .SS "new( \f(CW$group\fP, \f(CW$name\fP, \f(CW$class\fP, \f(CW$type\fP, [$label]])" .IX Subsection "new( $group, $name, $class, $type, [$label]])" Creates a new Lire::Report::ColumnInfo object. The column info attributes are initialized based on \f(CW$name\fR, \f(CW$class\fR, \f(CW$type\fR and \f(CW$label\fR. .SH "OBJECT METHODS" .IX Header "OBJECT METHODS" .SS \fBname()\fP .IX Subsection "name()" Returns the name of this column. This name can be used to find the group operation (from the report specification) that is responsible for the column\*(Aqs content. .SS \fBclass()\fP .IX Subsection "class()" Returns the column\*(Aqs class of data. This will be either \*(Aqnumerical\*(Aq or \&\*(Aqcategorical\*(Aq. .SS \fBtype()\fP .IX Subsection "type()" Returns the column\*(Aqs type. This referes to the type of the DLF field that was usd to generate this column\*(Aqs values. .SS \fBgroup_info()\fP .IX Subsection "group_info()" Returns the GroupInfo object which contains this column. .SS \fBindex()\fP .IX Subsection "index()" Returns the column\*(Aqs index in the table. This will be undef until the column info object is added to a Lire::Subreport or Lire::Group object. .SS \fBcol_start()\fP .IX Subsection "col_start()" Returns the display column which is the start of the cell span that should be used to render this column\*(Aqs values. .SS \fBcol_end()\fP .IX Subsection "col_end()" Returns the display column which is the end of the cell span that should be used to render this column\*(Aqs values. .SS \fBcol_width()\fP .IX Subsection "col_width()" Returns the suggested column width for this column in characters. .SS \fBmax_chars()\fP .IX Subsection "max_chars()" This method returns the length of the longest string in that column (including the label). .SS \fBavg_chars()\fP .IX Subsection "avg_chars()" This method returns the average length of strings in that column (including the label). This will be round up to the next integer (1.3 \&\-> 2). .SS "label( [$label] )" .IX Subsection "label( [$label] )" Returns the column\*(Aqs label. If the \f(CW$label\fR parameter is defined, the column\*(Aqs label will be set to this new value. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBLire::Report::Subreport\fR\|(3pm) \fBLire::Report::GroupInfo\fR\|(3pm) .SH VERSION .IX Header "VERSION" \&\f(CW$Id:\fR ColumnInfo.pm,v 1.15 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