GnomeDbQfField

GnomeDbQfField — Represents one field of an entity (through a GnomeDbTarget object)

Synopsis




            GnomeDbQfField;
GType       gnome_db_qf_field_get_type      (void);
GObject*    gnome_db_qf_field_new_with_objects
                                            (GnomeDbQuery *query,
                                             GnomeDbTarget *target,
                                             GnomeDbField *field);
GObject*    gnome_db_qf_field_new_with_xml_ids
                                            (GnomeDbQuery *query,
                                             const gchar *target_xml_id,
                                             const gchar *field_xml_id);
GnomeDbField* gnome_db_qf_field_get_ref_field
                                            (GnomeDbQfField *field);
GnomeDbTarget* gnome_db_qf_field_get_target (GnomeDbQfField *field);

Object Hierarchy


  GObject
   +----GnomeDbBase
         +----GnomeDbQfield
               +----GnomeDbQfField

Implemented Interfaces

GnomeDbQfField implements GnomeDbXmlStorage, GnomeDbRenderer, GnomeDbReferer and GnomeDbField.

Properties


  "handler-plugin"       gchararray            : Read / Write
  "query"                gpointer              : Read / Write
  "value-provider"       gpointer              : Read / Write
  "value-provider-xml-id" gchararray            : Read / Write

Signals


"templ-signal"
            void        user_function      (GnomeDbQfField *dbqffield,
                                            gpointer        user_data)      : Run first

Description

Details

GnomeDbQfField

typedef struct _GnomeDbQfField GnomeDbQfField;


gnome_db_qf_field_get_type ()

GType       gnome_db_qf_field_get_type      (void);

Returns :

gnome_db_qf_field_new_with_objects ()

GObject*    gnome_db_qf_field_new_with_objects
                                            (GnomeDbQuery *query,
                                             GnomeDbTarget *target,
                                             GnomeDbField *field);

Creates a new GnomeDbQfField object which represents the field of the entity represented by target. For example if target represents my_table, and field represents the "name" field, then the created object would represent 'my_table.name' in SQL notation

REM: field MUST belong to the GnomeDbEntity represented by target (we need the target since an entity can appear several times within a query, for self joins for example).

query : a GnomeDbQuery in which the new object will be
target : a GnomeDbTarget object
field : an object which implements the GnomeDbField interface
Returns : the new object

gnome_db_qf_field_new_with_xml_ids ()

GObject*    gnome_db_qf_field_new_with_xml_ids
                                            (GnomeDbQuery *query,
                                             const gchar *target_xml_id,
                                             const gchar *field_xml_id);

Creates a new GnomeDbQfField object which represents a given field of the entity represented by the target identified by target_xml_id.

REM: the aimed field MUST belong the the entity represented by the aimed target. This test is not done here but when this object will be activated (activation wll be refused if that test fails).

query : a GnomeDbQuery in which the new object will be
target_xml_id : the XML Id of a GnomeDbTarget object
field_xml_id : the XML Id of an object which implements the GnomeDbField interface
Returns : the new object

gnome_db_qf_field_get_ref_field ()

GnomeDbField* gnome_db_qf_field_get_ref_field
                                            (GnomeDbQfField *field);

Get the real GnomeDbField object (well, the object which implements that interface) referenced by field

field : a GnomeDbQfField object
Returns : the GnomeDbField object, or NULL if field is not active

gnome_db_qf_field_get_target ()

GnomeDbTarget* gnome_db_qf_field_get_target (GnomeDbQfField *field);

Get the GnomeDbTarget object field 'belongs' to

field : a GnomeDbQfField object
Returns : the GnomeDbTarget object

Property Details

The "handler-plugin" property

  "handler-plugin"       gchararray            : Read / Write

Default value: NULL


The "query" property

  "query"                gpointer              : Read / Write


The "value-provider" property

  "value-provider"       gpointer              : Read / Write


The "value-provider-xml-id" property

  "value-provider-xml-id" gchararray            : Read / Write

Default value: NULL

Signal Details

The "templ-signal" signal

void        user_function                  (GnomeDbQfField *dbqffield,
                                            gpointer        user_data)      : Run first

dbqffield : the object which received the signal.
user_data : user data set when the signal handler was connected.