![]() |
![]() |
![]() |
GNOME Data Access 4 manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#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
);
"spec" gpointer : Read / Write "spec-filename" gchar* : Write "spec-string" gchar* : Write
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.
|
a xmlNodePtr node |
Returns : |
a new GdaReportEngine object |
GdaReportEngine * gda_report_engine_new_from_string (const gchar *spec_string
);
Creates a new GdaReportEngine using spec_string
as the specifications.
|
an XML string |
Returns : |
a new GdaReportEngine object |
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.
|
a file name |
Returns : |
a new GdaReportEngine 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.
|
a GdaReportEngine object |
|
a GObject to declare |
|
the name to give to object within engine
|
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()
.
|
a GdaReportEngine object |
|
the type of requested object |
|
the name (in engine ) of the object to find |
Returns : |
a pointer to the requested object, or NULL if not found |
xmlNodePtr gda_report_engine_run_as_node (GdaReportEngine *engine
,GError **error
);
Execute the engine
engine and creates a new xmlNodePtr XML node
|
a GdaReportEngine object |
|
a place to store errors, or NULL
|
Returns : |
a new xmlNodePtr or NULL if an error occurred |
xmlDocPtr gda_report_engine_run_as_doc (GdaReportEngine *engine
,GError **error
);
Execute the engine
engine and creates a new XML document
|
a GdaReportEngine object |
|
a place to store errors, or NULL
|
Returns : |
a new xmlDocPtr or NULL if an error occurred |