GdaQueryField

typedef struct _GdaQueryField GdaQueryField;

enum GdaQueryFieldState

typedef enum {
	GDA_ENTITY_FIELD_VISIBLE   = 1 << 0,
	GDA_ENTITY_FIELD_INVISIBLE = 1 << 1,
	GDA_ENTITY_FIELD_ANY       = GDA_ENTITY_FIELD_VISIBLE | GDA_ENTITY_FIELD_INVISIBLE
} GdaQueryFieldState;

gda_query_field_new_from_xml ()

GdaQueryField *     gda_query_field_new_from_xml        (GdaQuery *query,
                                                         xmlNodePtr node,
                                                         GError **error);

This is an object factory which does create instances of class inheritants of the GnomeDbDfield class. Ths GdaQueryField object MUST then be attached to query

gda_query_field_new_copy ()

GdaQueryField *     gda_query_field_new_copy            (GdaQueryField *orig);

This is a copy constructor

gda_query_field_new_from_sql ()

GdaQueryField *     gda_query_field_new_from_sql        (GdaQuery *query,
                                                         const gchar *sqlfield,
                                                         GError **error);

Creates a new GdaQueryField from its SQL representation

gda_query_field_set_alias ()

void                gda_query_field_set_alias           (GdaQueryField *qfield,
                                                         const gchar *alias);

Sets qfield's alias

gda_query_field_get_alias ()

const gchar *       gda_query_field_get_alias           (GdaQueryField *qfield);

Get qfield's alias

gda_query_field_set_visible ()

void                gda_query_field_set_visible         (GdaQueryField *qfield,
                                                         gboolean visible);

Sets the visibility of qfield. A visible field will appear in the query's corresponding (virtual) entity, whereas a non visible one will be hidden (and possibly not taking part in the query).

gda_query_field_is_visible ()

gboolean            gda_query_field_is_visible          (GdaQueryField *qfield);

gda_query_field_set_internal ()

void                gda_query_field_set_internal        (GdaQueryField *qfield,
                                                         gboolean internal);

Sets weather qfield is internal or not. Internal fields in a query are fields added or changed by libgnomedb itself, such fields may or may not be visible.

gda_query_field_is_internal ()

gboolean            gda_query_field_is_internal         (GdaQueryField *qfield);

gda_query_field_get_dict_type ()

GdaDictType *       gda_query_field_get_dict_type       (GdaQueryField *qfield);

Get the GdaDictType represented by the qfield object: for a function it returns the return type, for a value, it returns its type, etc.

gda_query_field_get_parameters ()

GSList *            gda_query_field_get_parameters      (GdaQueryField *qfield);

Get a list of all the parameters needed to qfield to be rendered as a valid statement

gda_query_field_is_equal ()

gboolean            gda_query_field_is_equal            (GdaQueryField *qfield1,
                                                         GdaQueryField *qfield2);

Compares the qfield1 and qfield2. The name and aliases of the two fields are not compared, only the contents of the fields are.

gda_query_field_is_list ()

gboolean            gda_query_field_is_list             (GdaQueryField *qfield);

Tells if qfield can potentially represent a list of values.