Top |
GdaDataModel columnsGdaDataModel columns — Management of GdaDataModel column attributes |
Functions
GdaColumn * | gda_column_new () |
GdaColumn * | gda_column_copy () |
const gchar * | gda_column_get_description () |
void | gda_column_set_description () |
const gchar * | gda_column_get_name () |
void | gda_column_set_name () |
const gchar * | gda_column_get_dbms_type () |
void | gda_column_set_dbms_type () |
GType | gda_column_get_g_type () |
void | gda_column_set_g_type () |
gboolean | gda_column_get_allow_null () |
void | gda_column_set_allow_null () |
gboolean | gda_column_get_auto_increment () |
void | gda_column_set_auto_increment () |
gint | gda_column_get_position () |
void | gda_column_set_position () |
const GValue * | gda_column_get_default_value () |
void | gda_column_set_default_value () |
const GValue * | gda_column_get_attribute () |
void | gda_column_set_attribute () |
#define | gda_column_set_attribute_static() |
Functions
gda_column_copy ()
GdaColumn *
gda_column_copy (GdaColumn *column
);
Creates a new GdaColumn object from an existing one.
gda_column_set_description ()
void gda_column_set_description (GdaColumn *column
,const gchar *title
);
Sets the column's description
gda_column_set_name ()
void gda_column_set_name (GdaColumn *column
,const gchar *name
);
Sets the name of column
to name
.
gda_column_set_dbms_type ()
void gda_column_set_dbms_type (GdaColumn *column
,const gchar *dbms_type
);
Defines column
's database type
gda_column_set_g_type ()
void gda_column_set_g_type (GdaColumn *column
,GType type
);
Sets the type of column
to type
.
gda_column_get_allow_null ()
gboolean
gda_column_get_allow_null (GdaColumn *column
);
Gets the 'allow null' flag of the given column.
gda_column_set_allow_null ()
void gda_column_set_allow_null (GdaColumn *column
,gboolean allow
);
Sets the 'allow null' flag of the given column.
gda_column_set_auto_increment ()
void gda_column_set_auto_increment (GdaColumn *column
,gboolean is_auto
);
Sets the auto increment flag for the given column.
gda_column_set_position ()
void gda_column_set_position (GdaColumn *column
,gint position
);
Sets the position of the column refer to in the containing data model.
Parameters
column |
a GdaColumn. |
|
position |
the wanted position of the column in the containing data model. |
gda_column_set_default_value ()
void gda_column_set_default_value (GdaColumn *column
,const GValue *default_value
);
Sets column
's default GValue.
gda_column_get_attribute ()
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.
gda_column_set_attribute ()
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).
gda_column_set_attribute_static()
#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
Property Details
The “id”
property
“id” gchar *
Column's Id (warning: the column's ID is not guaranteed to be unique in a GdaDataModel).
Flags: Read / Write
Default value: NULL
Signal Details
The “g-type-changed”
signal
void user_function (GdaColumn *column, GType *old_type, GType *new_type, gpointer user_data)
Gets emitted whenever column
's type has been changed
Parameters
column |
the GdaColumn object |
|
old_type |
the column's previous type |
|
new_type |
the column's new type |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
The “name-changed”
signal
void user_function (GdaColumn *column, gchar *old_name, gpointer user_data)
Gets emitted whenever column
's name has been changed
Parameters
column |
the GdaColumn object |
|
old_name |
the column's previous name |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last