![]() |
![]() |
![]() |
GNOME Data Access 4 manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
GdaDataModel columnsGdaDataModel columns — Management of GdaDataModel column attributes |
GdaColumn; GdaColumn * gda_column_new (void
); GdaColumn * gda_column_copy (GdaColumn *column
); const gchar * gda_column_get_name (GdaColumn *column
); const gchar * gda_column_get_description (GdaColumn *column
); const gchar * gda_column_get_dbms_type (GdaColumn *column
); GType gda_column_get_g_type (GdaColumn *column
); gboolean gda_column_get_allow_null (GdaColumn *column
); gboolean gda_column_get_auto_increment (GdaColumn *column
); gint gda_column_get_position (GdaColumn *column
); const GValue * gda_column_get_default_value (GdaColumn *column
); const GValue * gda_column_get_attribute (GdaColumn *column
,const gchar *attribute
); void gda_column_set_attribute (GdaColumn *column
,const gchar *attribute
,const GValue *value
,GDestroyNotify destroy
); #define gda_column_set_attribute_static (holder, attribute, value)
GdaColumn * gda_column_copy (GdaColumn *column
);
Creates a new GdaColumn object from an existing one.
|
column to get a copy from. |
Returns : |
a newly allocated GdaColumn with a copy of the data
in column . [transfer full]
|
const gchar * gda_column_get_name (GdaColumn *column
);
|
a GdaColumn. |
Returns : |
the name of column . |
const gchar * gda_column_get_description (GdaColumn *column
);
|
a GdaColumn. |
Returns : |
the column's description, in any |
const gchar * gda_column_get_dbms_type (GdaColumn *column
);
|
a GdaColumn. |
Returns : |
the database type of column . |
GType gda_column_get_g_type (GdaColumn *column
);
|
a GdaColumn. |
Returns : |
the type of column . |
gboolean gda_column_get_allow_null (GdaColumn *column
);
Gets the 'allow null' flag of the given column.
|
a GdaColumn. |
Returns : |
whether the given column allows null values or not (TRUE or FALSE ). |
gboolean gda_column_get_auto_increment (GdaColumn *column
);
|
a GdaColumn. |
Returns : |
whether the given column is an auto incremented one (TRUE or FALSE ). |
gint gda_column_get_position (GdaColumn *column
);
|
a GdaColumn. |
Returns : |
the position of the column refer to in the containing data model. |
const GValue * gda_column_get_default_value (GdaColumn *column
);
|
a GdaColumn. |
Returns : |
column 's default value, as a GValue object, or NULL if column does not have a default value. [allow-none]
|
const GValue * gda_column_get_attribute (GdaColumn *column
,const gchar *attribute
);
Get the value associated to a named attribute.
Attributes can have any name, but Libgda proposes some default names, see this section.
void gda_column_set_attribute (GdaColumn *column
,const gchar *attribute
,const GValue *value
,GDestroyNotify destroy
);
Set the value associated to a named attribute. The attribute
string is 'stolen' by this method, and
the memory it uses will be freed using the destroy
function when no longer needed (if destroy
is NULL
,
then the string will not be freed at all).
Attributes can have any name, but Libgda proposes some default names, see this section.
If there is already an attribute named attribute
set, then its value is replaced with the new value (value
is
copied), except if value
is NULL
, in which case the attribute is removed.
For example one would use it as:
gda_column_set_attribute (holder, g_strdup (my_attribute), g_free, my_value);
gda_column_set_attribute (holder, GDA_ATTRIBUTE_NAME, NULL, my_value);
Note: this method does not modify in any way the contents of the data model for which column
is a column (nor
does it modify the table definition of the tables used by a SELECT statement is the model was created from a
SELECT statement).
|
a GdaColumn |
|
attribute name as a static string |
|
a GValue, or NULL . [allow-none]
|
|
a function to be called when attribute is not needed anymore, or NULL . [allow-none]
|
#define gda_column_set_attribute_static(holder,attribute,value) gda_column_set_attribute((holder),(attribute),(value),NULL)
This function is similar to gda_column_set_attribute()
but for static strings
|
a GdaHolder |
|
attribute's name |
|
the value to set the attribute to, or NULL . [allow-none]
|
"g-type-changed"
signalvoid user_function (GdaColumn *column,
GType *old_type,
GType *new_type,
gpointer user_data) : Run Last
Gets emitted whenever column
's type has been changed
|
the GdaColumn object |
|
the column's previous type |
|
the column's new type |
|
user data set when the signal handler was connected. |