.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\" ========================================================================
.\"
.IX Title "Simple 3pm"
.TH Simple 3pm "2019-01-22" "perl v5.28.1" "User Contributed Perl 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"
Spreadsheet::WriteExcel::Simple \- A simple single\-sheet Excel document
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  my $ss = Spreadsheet::WriteExcel::Simple\->new;
\&     $ss\->write_bold_row(\e@headings);
\&     $ss\->write_row(\e@data);
\&
\&  print $ss\->data;
\&        # or
\&        $ss\->save("filename.xls");
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This provides an abstraction to the Spreadsheet::WriteExcel module
for easier creation of simple single-sheet Excel documents.
.PP
In its most basic form it provides two methods for writing data:
write_row and write_bold_row which write the data supplied to
the next row of the spreadsheet.
.PP
However, you can also use \f(CW$ss\fR\->book and \f(CW$ss\fR\->sheet to get at the
underlying workbook and worksheet from Spreadsheet::WriteExcel if you
wish to manipulate these directly.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&  my $ss = Spreadsheet::WriteExcel::Simple\->new;
.Ve
.PP
Create a new single-sheet Excel document. You should not supply this
a filename or filehandle. The data is stored internally, and can be
retrieved later through the 'data' method or saved using the 'save'
method.
.SS "write_row / write_bold_row"
.IX Subsection "write_row / write_bold_row"
.Vb 2
\&  $ss\->write_bold_row(\e@headings);
\&  $ss\->write_row(\e@data);
.Ve
.PP
These write the list of data into the next row of the spreadsheet.
.PP
Caveat: An internal counter is kept as to which row is being written
to, so if you mix these functions with direct writes of your own,
these functions will continue where they left off, not where you have
written to.
.SS "data"
.IX Subsection "data"
.Vb 1
\&  print $ss\->data;
.Ve
.PP
This returns the data of the spreadsheet. If you're planning to print this
to a web-browser, be sure to print an 'application/excel' header first.
.SS "book / sheet"
.IX Subsection "book / sheet"
.Vb 2
\&  my $workbook  = $ss\->book;
\&  my $worksheet = $ss\->sheet;
.Ve
.PP
These return the underlying Spreadsheet::WriteExcel objects representing
the workbook and worksheet respectively. If you find yourself making
more that a trivial amount of use of these, you probably shouldn't be
using this module, but using Spreadsheet::WriteExcel directly.
.SS "save"
.IX Subsection "save"
.Vb 1
\&        $ss\->save("filename.xls");
.Ve
.PP
Save the spreadsheet with the given filename.
.SH "BUGS"
.IX Header "BUGS"
This can't yet handle dates in a sensible manner.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tony Bowden
.SH "BUGS and QUERIES"
.IX Header "BUGS and QUERIES"
Please direct all correspondence regarding this module to:
  bug\-Spreadsheet\-WriteExcel\-Simple@rt.cpan.org
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Spreadsheet::WriteExcel. John McNamara has done a great job with
this module.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2001\-2005 Tony Bowden. All rights reserved.
.PP
This module is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.