GdaReportDocument

## GdaReportDocument GdaReportDocument — Report document |

## Stability Level

Stable, unless otherwise indicated

## Synopsis

    struct              GdaReportDocument;
    void                gda_report_document_set_template    (GdaReportDocument *doc,
                                                             const gchar *file);
    gboolean            gda_report_document_run_as_html     (GdaReportDocument *doc,
                                                             const gchar *filename,
                                                             GError **error);
    gboolean            gda_report_document_run_as_pdf      (GdaReportDocument *doc,
                                                             const gchar *filename,
                                                             GError **error);

## Object Hierarchy

      GObject
       +----GdaReportDocument
             +----GdaReportRmlDocument
             +----GdaReportDocbookDocument

## Properties

      "engine"                   GdaReportEngine*      : Read / Write
      "template"                 gchar*                : Write

## Description

The GdaReportDocument wraps the usage of a GdaReportEngine for specific HTML or PDF targets. This class is abstract (no instance be created directly), and one of its subclasses has to be used.

## Details

### struct GdaReportDocument

    struct GdaReportDocument;

### gda_report_document_set_template ()

    void                gda_report_document_set_template    (GdaReportDocument *doc,
                                                             const gchar *file);

Instructs `doc` to use the `file` RML file as a template

`doc` : | a GdaReportDocument object
`file` : | a RML file name, or `NULL`

### gda_report_document_run_as_html ()

    gboolean            gda_report_document_run_as_html     (GdaReportDocument *doc,
                                                             const gchar *filename,
                                                             GError **error);

Creates the report document and saves it as an HTML file into `filename`

`doc` : | a GdaReportDocument object
`filename` : | the name of a filename to save to
`error` : | a place to store errors, or `NULL`
Returns : | TRUE if no error occurred

### gda_report_document_run_as_pdf ()

    gboolean            gda_report_document_run_as_pdf      (GdaReportDocument *doc,
                                                             const gchar *filename,
                                                             GError **error);

Creates the report document and saves it as a PDF file into `filename`

`doc` : | a GdaReportDocument object
`filename` : | the name of a filename to save to
`error` : | a place to store errors, or `NULL`
Returns : | TRUE if no error occurred

## Property Details

### The `"engine"` property

      "engine"                   GdaReportEngine*      : Read / Write

### The `"template"` property

      "template"                 gchar*                : Write

Default value: NULL