/usr/share/perl5/Spreadsheet/ParseExcel/Cell.pm is in libspreadsheet-parseexcel-perl 0.5800-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 | package Spreadsheet::ParseExcel::Cell;
###############################################################################
#
# Spreadsheet::ParseExcel::Cell - A class for Cell data and formatting.
#
# Used in conjunction with Spreadsheet::ParseExcel.
#
# Copyright (c) 2009 John McNamara
# Copyright (c) 2006-2008 Gabor Szabo
# Copyright (c) 2000-2006 Kawai Takanori
#
# perltidy with standard settings.
#
# Documentation after __END__
#
use strict;
use warnings;
our $VERSION = '0.58';
###############################################################################
#
# new()
#
# Constructor.
#
sub new {
my ( $package, %properties ) = @_;
my $self = \%properties;
bless $self, $package;
}
###############################################################################
#
# value()
#
# Returns the formatted value of the cell.
#
sub value {
my $self = shift;
return $self->{_Value};
}
###############################################################################
#
# unformatted()
#
# Returns the unformatted value of the cell.
#
sub unformatted {
my $self = shift;
return $self->{Val};
}
###############################################################################
#
# get_format()
#
# Returns the Format object for the cell.
#
sub get_format {
my $self = shift;
return $self->{Format};
}
###############################################################################
#
# type()
#
# Returns the type of cell such as Text, Numeric or Date.
#
sub type {
my $self = shift;
return $self->{Type};
}
###############################################################################
#
# encoding()
#
# Returns the character encoding of the cell.
#
sub encoding {
my $self = shift;
if ( !defined $self->{Code} ) {
return 1;
}
elsif ( $self->{Code} eq 'ucs2' ) {
return 2;
}
elsif ( $self->{Code} eq '_native_' ) {
return 3;
}
else {
return 0;
}
return $self->{Code};
}
###############################################################################
#
# is_merged()
#
# Returns true if the cell is merged.
#
sub is_merged {
my $self = shift;
return $self->{Merged};
}
###############################################################################
#
# get_rich_text()
#
# Returns an array ref of font information about each string block in a "rich",
# i.e. multi-format, string.
#
sub get_rich_text {
my $self = shift;
return $self->{Rich};
}
###############################################################################
#
# Mapping between legacy method names and new names.
#
{
no warnings; # Ignore warnings about variables used only once.
*Value = *value;
}
1;
__END__
=pod
=head1 NAME
Spreadsheet::ParseExcel::Cell - A class for Cell data and formatting.
=head1 SYNOPSIS
See the documentation for Spreadsheet::ParseExcel.
=head1 DESCRIPTION
This module is used in conjunction with Spreadsheet::ParseExcel. See the documentation for Spreadsheet::ParseExcel.
=head1 Methods
The following Cell methods are available:
$cell->value()
$cell->unformatted()
$cell->get_format()
$cell->type()
$cell->encoding()
$cell->is_merged()
$cell->get_rich_text()
=head2 value()
The C<value()> method returns the formatted value of the cell.
my $value = $cell->value();
Formatted in this sense refers to the numeric format of the cell value. For example a number such as 40177 might be formatted as 40,117, 40117.000 or even as the date 2009/12/30.
If the cell doesn't contain a numeric format then the formatted and unformatted cell values are the same, see the C<unformatted()> method below.
For a defined C<$cell> the C<value()> method will always return a value.
In the case of a cell with formatting but no numeric or string contents the method will return the empty string C<''>.
=head2 unformatted()
The C<unformatted()> method returns the unformatted value of the cell.
my $unformatted = $cell->unformatted();
Returns the cell value without a numeric format. See the C<value()> method above.
=head2 get_format()
The C<get_format()> method returns the L<Spreadsheet::ParseExcel::Format> object for the cell.
my $format = $cell->get_format();
If a user defined format hasn't been applied to the cell then the default cell format is returned.
=head2 type()
The C<type()> method returns the type of cell such as Text, Numeric or Date. If the type was detected as Numeric, and the Cell Format matches C<m{^[dmy][-\\/dmy]*$}i>, it will be treated as a Date type.
my $type = $cell->type();
See also L<Dates and Time in Excel>.
=head2 encoding()
The C<encoding()> method returns the character encoding of the cell.
my $encoding = $cell->encoding();
This method is only of interest to developers. In general Spreadsheet::ParseExcel will return all character strings in UTF-8 regardless of the encoding used by Excel.
The C<encoding()> method returns one of the following values:
=over
=item * 0: Unknown format. This shouldn't happen. In the default case the format should be 1.
=item * 1: 8bit ASCII or single byte UTF-16. This indicates that the characters are encoded in a single byte. In Excel 95 and earlier This usually meant ASCII or an international variant. In Excel 97 it refers to a compressed UTF-16 character string where all of the high order bytes are 0 and are omitted to save space.
=item * 2: UTF-16BE.
=item * 3: Native encoding. In Excel 95 and earlier this encoding was used to represent multi-byte character encodings such as SJIS.
=back
=head2 is_merged()
The C<is_merged()> method returns true if the cell is merged.
my $is_merged = $cell->is_merged();
Returns C<undef> if the property isn't set.
=head2 get_rich_text()
The C<get_rich_text()> method returns an array ref of font information about each string block in a "rich", i.e. multi-format, string.
my $rich_text = $cell->get_rich_text();
The return value is an arrayref of arrayrefs in the form:
[
[ $start_position, $font_object ],
...,
]
Returns undef if the property isn't set.
=head1 Dates and Time in Excel
Dates and times in Excel are represented by real numbers, for example "Jan 1 2001 12:30 PM" is represented by the number 36892.521.
The integer part of the number stores the number of days since the epoch and the fractional part stores the percentage of the day.
A date or time in Excel is just like any other number. The way in which it is displayed is controlled by the number format:
Number format $cell->value() $cell->unformatted()
============= ============== ==============
'dd/mm/yy' '28/02/08' 39506.5
'mm/dd/yy' '02/28/08' 39506.5
'd-m-yyyy' '28-2-2008' 39506.5
'dd/mm/yy hh:mm' '28/02/08 12:00' 39506.5
'd mmm yyyy' '28 Feb 2008' 39506.5
'mmm d yyyy hh:mm AM/PM' 'Feb 28 2008 12:00 PM' 39506.5
The L<Spreadsheet::ParseExcel::Utility> module contains a function called C<ExcelLocaltime> which will convert between an unformatted Excel date/time number and a C<localtime()> like array.
For date conversions using the CPAN C<DateTime> framework see L<DateTime::Format::Excel> http://search.cpan.org/search?dist=DateTime-Format-Excel
=head1 AUTHOR
Maintainer 0.40+: John McNamara jmcnamara@cpan.org
Maintainer 0.27-0.33: Gabor Szabo szabgab@cpan.org
Original author: Kawai Takanori kwitknr@cpan.org
=head1 COPYRIGHT
Copyright (c) 2009-2010 John McNamara
Copyright (c) 2006-2008 Gabor Szabo
Copyright (c) 2000-2006 Kawai Takanori
All rights reserved.
You may distribute under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file.
=cut
|