![]() |
![]() |
![]() |
GNOME Data Access manual | ![]() |
---|---|---|---|---|
Top | Description |
GdaFieldAttributes; GdaField; #define GDA_TYPE_FIELD_ATTRIBUTES GType gda_field_attributes_get_type (void); GdaFieldAttributes * gda_field_attributes_new (void); GdaFieldAttributes * gda_field_attributes_copy (GdaFieldAttributes *fa); void gda_field_attributes_free (GdaFieldAttributes *fa); gboolean gda_field_attributes_equal (const GdaFieldAttributes *lhs, const GdaFieldAttributes *rhs); glong gda_field_attributes_get_defined_size (GdaFieldAttributes *fa); void gda_field_attributes_set_defined_size (GdaFieldAttributes *fa, glong size); const gchar * gda_field_attributes_get_name (GdaFieldAttributes *fa); void gda_field_attributes_set_name (GdaFieldAttributes *fa, const gchar *name); const gchar * gda_field_attributes_get_table (GdaFieldAttributes *fa); void gda_field_attributes_set_table (GdaFieldAttributes *fa, const gchar *table); const gchar * gda_field_attributes_get_caption (GdaFieldAttributes *fa); void gda_field_attributes_set_caption (GdaFieldAttributes *fa, const gchar *caption); glong gda_field_attributes_get_scale (GdaFieldAttributes *fa); void gda_field_attributes_set_scale (GdaFieldAttributes *fa, glong scale); GdaValueType gda_field_attributes_get_gdatype (GdaFieldAttributes *fa); void gda_field_attributes_set_gdatype (GdaFieldAttributes *fa, GdaValueType type); gboolean gda_field_attributes_get_allow_null (GdaFieldAttributes *fa); void gda_field_attributes_set_allow_null (GdaFieldAttributes *fa, gboolean allow); gboolean gda_field_attributes_get_primary_key (GdaFieldAttributes *fa); void gda_field_attributes_set_primary_key (GdaFieldAttributes *fa, gboolean pk); gboolean gda_field_attributes_get_unique_key (GdaFieldAttributes *fa); void gda_field_attributes_set_unique_key (GdaFieldAttributes *fa, gboolean uk); const gchar * gda_field_attributes_get_references (GdaFieldAttributes *fa); void gda_field_attributes_set_references (GdaFieldAttributes *fa, const gchar *ref); gboolean gda_field_attributes_get_auto_increment (GdaFieldAttributes *fa); void gda_field_attributes_set_auto_increment (GdaFieldAttributes *fa, gboolean is_auto); gint gda_field_attributes_get_position (GdaFieldAttributes *fa); void gda_field_attributes_set_position (GdaFieldAttributes *fa, gint position); const GdaValue * gda_field_attributes_get_default_value (GdaFieldAttributes *fa); void gda_field_attributes_set_default_value (GdaFieldAttributes *fa, const GdaValue *default_value);
typedef struct { gint defined_size; gchar *name; gchar *table; gchar *caption; gint scale; GdaValueType gda_type; gboolean allow_null; gboolean primary_key; gboolean unique_key; gchar *references; gboolean auto_increment; glong auto_increment_start; glong auto_increment_step; gint position; GdaValue *default_value; } GdaFieldAttributes;
typedef struct { gint actual_size; GdaValue *value; GdaFieldAttributes *attributes; } GdaField;
GdaFieldAttributes * gda_field_attributes_new (void);
Returns : |
a newly allocated GdaFieldAttributes object. |
GdaFieldAttributes * gda_field_attributes_copy (GdaFieldAttributes *fa);
Creates a new GdaFieldAttributes object from an existing one.
|
attributes to get a copy from. |
Returns : |
a newly allocated GdaFieldAttributes with a copy of the data
in fa .
|
void gda_field_attributes_free (GdaFieldAttributes *fa);
Deallocates all memory associated to the given GdaFieldAttributes object.
|
the resource to free. |
gboolean gda_field_attributes_equal (const GdaFieldAttributes *lhs, const GdaFieldAttributes *rhs);
Tests whether two field attributes are equal.
|
a GdaFieldAttributes |
|
another GdaFieldAttributes |
Returns : |
TRUE if the field attributes contain the same information.
|
glong gda_field_attributes_get_defined_size (GdaFieldAttributes *fa);
|
a GdaFieldAttributes .
|
Returns : |
the defined size of fa .
|
void gda_field_attributes_set_defined_size (GdaFieldAttributes *fa, glong size);
Sets the defined size of a GdaFieldAttributes.
|
a GdaFieldAttributes. |
|
the defined size we want to set. |
const gchar * gda_field_attributes_get_name (GdaFieldAttributes *fa);
|
a GdaFieldAttributes. |
Returns : |
the name of fa .
|
void gda_field_attributes_set_name (GdaFieldAttributes *fa, const gchar *name);
Sets the name of fa
to name
.
|
a GdaFieldAttributes. |
|
the new name of fa .
|
const gchar * gda_field_attributes_get_table (GdaFieldAttributes *fa);
|
a GdaFieldAttributes. |
Returns : |
the name of the table to which this field belongs. |
void gda_field_attributes_set_table (GdaFieldAttributes *fa, const gchar *table);
Sets the name of the table to which the given field belongs.
|
a GdaFieldAttributes. |
|
table name. |
const gchar * gda_field_attributes_get_caption (GdaFieldAttributes *fa);
|
a GdaFieldAttributes. |
Returns : |
fa 's caption.
|
void gda_field_attributes_set_caption (GdaFieldAttributes *fa, const gchar *caption);
Sets fa
's caption
.
|
a GdaFieldAttributes. |
|
caption. |
glong gda_field_attributes_get_scale (GdaFieldAttributes *fa);
|
a GdaFieldAttributes. |
Returns : |
the number of decimals of fa .
|
void gda_field_attributes_set_scale (GdaFieldAttributes *fa, glong scale);
Sets the scale of fa
to scale
.
|
a GdaFieldAttributes. |
|
number of decimals. |
GdaValueType gda_field_attributes_get_gdatype (GdaFieldAttributes *fa);
|
a GdaFieldAttributes. |
Returns : |
the type of fa .
|
void gda_field_attributes_set_gdatype (GdaFieldAttributes *fa, GdaValueType type);
Sets the type of fa
to type
.
|
a GdaFieldAttributes. |
|
the new type of fa .
|
gboolean gda_field_attributes_get_allow_null (GdaFieldAttributes *fa);
Gets the 'allow null' flag of the given field attributes.
|
a GdaFieldAttributes. |
Returns : |
whether the given field allows null values or not (TRUE or FALSE ).
|
void gda_field_attributes_set_allow_null (GdaFieldAttributes *fa, gboolean allow);
Sets the 'allow null' flag of the given field attributes.
|
a GdaFieldAttributes. |
|
whether the given field should allows null values or not. |
gboolean gda_field_attributes_get_primary_key (GdaFieldAttributes *fa);
|
a GdaFieldAttributes. |
Returns : |
whether if the given field is a primary key (TRUE or FALSE ).
|
void gda_field_attributes_set_primary_key (GdaFieldAttributes *fa, gboolean pk);
Sets the 'primary key' flag of the given field attributes.
|
a GdaFieldAttributes. |
|
whether if the given field should be a primary key. |
gboolean gda_field_attributes_get_unique_key (GdaFieldAttributes *fa);
|
a GdaFieldAttributes. |
Returns : |
whether if the given field is an unique key (TRUE or FALSE ).
|
void gda_field_attributes_set_unique_key (GdaFieldAttributes *fa, gboolean uk);
Sets the 'unique key' flag of the given field attributes.
|
a GdaFieldAttributes. |
|
whether if the given field should be an unique key. |
const gchar * gda_field_attributes_get_references (GdaFieldAttributes *fa);
|
a GdaFieldAttributes. |
Returns : |
fa 's references.
|
void gda_field_attributes_set_references (GdaFieldAttributes *fa, const gchar *ref);
Sets fa
's references
.
|
a GdaFieldAttributes. |
|
references. |
gboolean gda_field_attributes_get_auto_increment (GdaFieldAttributes *fa);
|
a GdaFieldAttributes. |
Returns : |
whether the given field is an auto incremented one (TRUE or FALSE ).
|
void gda_field_attributes_set_auto_increment (GdaFieldAttributes *fa, gboolean is_auto);
Sets the auto increment flag for the given field.
|
a GdaFieldAttributes. |
|
auto increment status. |
gint gda_field_attributes_get_position (GdaFieldAttributes *fa);
|
a GdaFieldAttributes. |
Returns : |
the position of the field the attributes refer to in the containing data model. |
void gda_field_attributes_set_position (GdaFieldAttributes *fa, gint position);
Sets the position of the field the attributes refer to in the containing data model.
|
a GdaFieldAttributes. |
|
the wanted position of the field in the containing data model. |
const GdaValue * gda_field_attributes_get_default_value (GdaFieldAttributes *fa);
|
a GdaFieldAttributes. |
Returns : |
fa 's default value, as a GdaValue object.
|
void gda_field_attributes_set_default_value (GdaFieldAttributes *fa, const GdaValue *default_value);
Sets fa
's default GdaValue.
|
a GdaFieldAttributes. |
|
default GdaValue for the field |