![]() |
![]() |
![]() |
Libgnomedb Reference Manual | ![]() |
---|---|---|---|---|
GnomeDbRendererGnomeDbRenderer — Interface to get representations of objects as SQL statements, XML nodes or human readable text |
GnomeDbRenderer; enum GnomeDbRendererOptions; GType gnome_db_renderer_get_type (void); gchar* gnome_db_renderer_render_as_sql (GnomeDbRenderer *iface, GnomeDbDataSet *context, guint options, GError **error); gchar* gnome_db_renderer_render_as_str (GnomeDbRenderer *iface, GnomeDbDataSet *context); gboolean gnome_db_renderer_is_valid (GnomeDbRenderer *iface, GnomeDbDataSet *context, GError **error);
GnomeDbRenderer is implemented by GnomeDbQfAll, GnomeDbQfValue, GnomeDbTarget, GnomeDbQuery, GnomeDbCondition, GnomeDbQfFunc, GnomeDbQfAgg, GnomeDbTableField and GnomeDbQfField.
typedef enum { GNOME_DB_RENDERER_EXTRA_PRETTY_SQL = 1 << 0, GNOME_DB_RENDERER_EXTRA_VAL_ATTRS = 1 << 1, GNOME_DB_RENDERER_ERROR_IF_DEFAULT = 1 << 2 } GnomeDbRendererOptions;
gchar* gnome_db_renderer_render_as_sql (GnomeDbRenderer *iface, GnomeDbDataSet *context, guint options, GError **error);
Build a SQL statement representing the object, in the specified context.
If context
is NULL
, then no error related to missing parameters (which should be in the
context) is returned, and missing values are replaced by 'human readable' SQL.
iface : |
an object which implements the GnomeDbRenderer interface |
context : |
rendering context |
options : |
OR'ed flags from GnomeDbRendererOptions to give some rendering options |
error : |
location to store error, or NULL
|
Returns : | the new SQL statement (new string), or NULL in case of error
|
gchar* gnome_db_renderer_render_as_str (GnomeDbRenderer *iface, GnomeDbDataSet *context);
Build a human readable string representing the object, in the specified context.
iface : |
an object which implements the GnomeDbRenderer interface |
context : |
rendering context |
Returns : | the new string |
gboolean gnome_db_renderer_is_valid (GnomeDbRenderer *iface, GnomeDbDataSet *context, GError **error);
Tells if iface
has all the necessary information in context
to be rendered
into a valid statement (which can be executed).
iface : |
an object which implements the GnomeDbRenderer interface |
context : |
rendering context |
error : |
location to store error, or NULL
|
Returns : | TRUE if iface can be rendered with context
|