Creates a new ReportGenerator object, sets all given options, and returns it.
-=item set_columns @columns
+=item set_columns %columns
Sets the columns available to this report.
=item add_data \%data
Adds data to the report. A given hash_ref is interpreted as a single line of data, every array_ref as a collection of lines.
-Every line will be expected to be in a kay => value format. Note that this data has to be already sorted.
-ReportGenerator does no sorting on its own, only provides links to sorting and visual cue as to which column was sorted by.
+Every line will be expected to be in a kay => value format. Note that the rows have to be already sorted.
+ReportGenerator does only colum sorting on its own, and provides links to sorting and visual cue as to which column was sorted by.
=item add_separator
=item generate_pdf_content
-The PDF generation function. Is invoked by the pdf render functions.
+The PDF generation function. It is invoked by generate_with_headers, tests whether or not the Perl module PDF::API2 is installed and calls render_pdf_with_pdf_api2 if it is and render_pdf_with_html2ps otherwise.
=item generate_csv_content
=item render_pdf_with_pdf_api2
-PDF render function. Uses PDF module.
+PDF render function using the Perl module PDF::API2.
=item render_pdf_with_html2ps
-PDF render function. Uses html2ps to render.
+PDF render function using the external application html2ps.
=back
=item allow_pdf_export
-Used to determine if a button for PDF export should be displayed. Default is yes.
+Used to determine if a button for PDF export should be displayed. Default is yes. The PDF button is hidden if neither the Perl module PDF::API2 nor the external applications html2ps and Ghostscript are available regardless of this parameter's value.
=item allow_csv_export
=item paper_size
-Paper size. Default is a4.
+Paper size. Default is a4. Supported paper sizes are a3, a4, a5, letter and legal.
=item orientation (landscape)
=item font_name
-Default is Verdana.
+Default is Verdana. Supported font names are Courier, Georgia, Helvetica, Times and Verdana. This option only affects the rendering with PDF::API2.
=item font_size
-Default is 7.
+Default is 7. This option only affects the rendering with PDF::API2.
=item margin_top
=item margin_right
-Default all to 1.5.
+The paper margins in cm. They all default to 1.5.
=item number
-Default is 1.
+Set to a true value if the pages should be numbered. Default is 1.
=item print
-Print or not? Default is no.
+If set then the resulting PDF will be output to a printer. If not it will be downloaded by the user. Default is no.
=item printer_id
=item escape_char
-Character to escape the quote_char. Default is souble quote (").
+Character to escape the quote_char. Default is double quote (").
=item eol_style