GdaReportEngine

GdaReportEngine

Synopsis

#include <libgda-report/gda-report-engine.h>

struct              GdaReportEngine;
GdaReportEngine *   gda_report_engine_new               (xmlNodePtr spec_node);
GdaReportEngine *   gda_report_engine_new_from_string   (const gchar *spec_string);
GdaReportEngine *   gda_report_engine_new_from_file     (const gchar *spec_file_name);
void                gda_report_engine_declare_object    (GdaReportEngine *engine,
                                                         GObject *object,
                                                         const gchar *obj_name);
GObject *           gda_report_engine_find_declared_object
                                                        (GdaReportEngine *engine,
                                                         GType obj_type,
                                                         const gchar *obj_name);
xmlNodePtr          gda_report_engine_run_as_node       (GdaReportEngine *engine,
                                                         GError **error);
xmlDocPtr           gda_report_engine_run_as_doc        (GdaReportEngine *engine,
                                                         GError **error);

Object Hierarchy

  GObject
   +----GdaReportEngine

Properties

  "spec"                     gpointer              : Read / Write
  "spec-filename"            gchar*                : Write
  "spec-string"              gchar*                : Write

Description

Details

struct GdaReportEngine

struct GdaReportEngine;


gda_report_engine_new ()

GdaReportEngine *   gda_report_engine_new               (xmlNodePtr spec_node);

Creates a new GdaReportEngine using spec_node as the specifications. Note that spec_node is not copied, but "stolen" by the new report engine object.

spec_node :

a xmlNodePtr node

Returns :

a new GdaReportEngine object

gda_report_engine_new_from_string ()

GdaReportEngine *   gda_report_engine_new_from_string   (const gchar *spec_string);

Creates a new GdaReportEngine using spec_string as the specifications.

spec_string :

an XML string

Returns :

a new GdaReportEngine object

gda_report_engine_new_from_file ()

GdaReportEngine *   gda_report_engine_new_from_file     (const gchar *spec_file_name);

Creates a new GdaReportEngine using the contents of spec_file_name as the specifications.

spec_file_name :

a file name

Returns :

a new GdaReportEngine object

gda_report_engine_declare_object ()

void                gda_report_engine_declare_object    (GdaReportEngine *engine,
                                                         GObject *object,
                                                         const gchar *obj_name);

Declares an object which will be used in engine, referenced by the obj_name name.

object must be of a supported types, that it must be a GdaConnection, GdaStatement or GdaHolder object.

engine :

a GdaReportEngine object

object :

a GObject to declare

obj_name :

the name to give to object within engine

gda_report_engine_find_declared_object ()

GObject *           gda_report_engine_find_declared_object
                                                        (GdaReportEngine *engine,
                                                         GType obj_type,
                                                         const gchar *obj_name);

Finds an object which has previously been declared using gda_report_engine_declare_object().

engine :

a GdaReportEngine object

obj_type :

the type of requested object

obj_name :

the name (in engine) of the object to find

Returns :

a pointer to the requested object, or NULL if not found

gda_report_engine_run_as_node ()

xmlNodePtr          gda_report_engine_run_as_node       (GdaReportEngine *engine,
                                                         GError **error);

Execute the engine engine and creates a new xmlNodePtr XML node

engine :

a GdaReportEngine object

error :

a place to store errors, or NULL

Returns :

a new xmlNodePtr or NULL if an error occurred

gda_report_engine_run_as_doc ()

xmlDocPtr           gda_report_engine_run_as_doc        (GdaReportEngine *engine,
                                                         GError **error);

Execute the engine engine and creates a new XML document

engine :

a GdaReportEngine object

error :

a place to store errors, or NULL

Returns :

a new xmlDocPtr or NULL if an error occurred

Property Details

The "spec" property

  "spec"                     gpointer              : Read / Write


The "spec-filename" property

  "spec-filename"            gchar*                : Write

Default value: NULL


The "spec-string" property

  "spec-string"              gchar*                : Write

Default value: NULL