GdaDataModel columns

GdaDataModel columns — Management of GdaDataModel column attributes

Functions

Properties

gchar * id Read / Write

Signals

void g-type-changed Run Last
void name-changed Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── GdaColumn

Description

Functions

gda_column_new ()

GdaColumn *
gda_column_new (void);

Returns

a newly allocated GdaColumn object.


gda_column_copy ()

GdaColumn *
gda_column_copy (GdaColumn *column);

Creates a new GdaColumn object from an existing one.

Parameters

column

column to get a copy from.

 

Returns

a newly allocated GdaColumn with a copy of the data in column .


gda_column_get_defined_size ()

glong
gda_column_get_defined_size (GdaColumn *column);

Parameters

column

a GdaColumn .

 

Returns

the defined size of column .


gda_column_set_defined_size ()

void
gda_column_set_defined_size (GdaColumn *column,
                             glong size);

Sets the defined size of a GdaColumn.

Parameters

column

a GdaColumn.

 

size

the defined size we want to set.

 

gda_column_get_name ()

const gchar *
gda_column_get_name (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

the name of column .


gda_column_set_name ()

void
gda_column_set_name (GdaColumn *column,
                     const gchar *name);

Sets the name of column to name .

Parameters

column

a GdaColumn.

 

name

the new name of column .

 

gda_column_get_title ()

const gchar *
gda_column_get_title (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

the column's title


gda_column_set_title ()

void
gda_column_set_title (GdaColumn *column,
                      const gchar *title);

Sets the column's title

Parameters

column

a GdaColumn.

 

title

title name.

 

gda_column_get_table ()

const gchar *
gda_column_get_table (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

the name of the table to which this column belongs.


gda_column_set_table ()

void
gda_column_set_table (GdaColumn *column,
                      const gchar *table);

Sets the name of the table to which the given column belongs.

Parameters

column

a GdaColumn.

 

table

table name.

 

gda_column_get_caption ()

const gchar *
gda_column_get_caption (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

column 's caption.


gda_column_set_caption ()

void
gda_column_set_caption (GdaColumn *column,
                        const gchar *caption);

Sets column 's caption .

Parameters

column

a GdaColumn.

 

caption

caption.

 

gda_column_get_scale ()

glong
gda_column_get_scale (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

the number of decimals of column .


gda_column_set_scale ()

void
gda_column_set_scale (GdaColumn *column,
                      glong scale);

Sets the scale of column to scale .

Parameters

column

a GdaColumn.

 

scale

number of decimals.

 

gda_column_get_dbms_type ()

const gchar *
gda_column_get_dbms_type (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

the dbms_type of column .


gda_column_set_dbms_type ()

void
gda_column_set_dbms_type (GdaColumn *column,
                          const gchar *dbms_type);


gda_column_get_g_type ()

GType
gda_column_get_g_type (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

the type of column .


gda_column_set_g_type ()

void
gda_column_set_g_type (GdaColumn *column,
                       GType type);

Sets the type of column to type .

Parameters

column

a GdaColumn.

 

type

the new type of column .

 

gda_column_get_allow_null ()

gboolean
gda_column_get_allow_null (GdaColumn *column);

Gets the 'allow null' flag of the given column.

Parameters

column

a GdaColumn.

 

Returns

whether the given column allows null values or not (TRUE or FALSE).


gda_column_set_allow_null ()

void
gda_column_set_allow_null (GdaColumn *column,
                           gboolean allow);

Sets the 'allow null' flag of the given column.

Parameters

column

a GdaColumn.

 

allow

whether the given column should allows null values or not.

 

gda_column_get_primary_key ()

gboolean
gda_column_get_primary_key (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

whether if the given column is a primary key (TRUE or FALSE).


gda_column_set_primary_key ()

void
gda_column_set_primary_key (GdaColumn *column,
                            gboolean pk);

Sets the 'primary key' flag of the given column.

Parameters

column

a GdaColumn.

 

pk

whether if the given column should be a primary key.

 

gda_column_get_unique_key ()

gboolean
gda_column_get_unique_key (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

whether if the given column is an unique key (TRUE or FALSE).


gda_column_set_unique_key ()

void
gda_column_set_unique_key (GdaColumn *column,
                           gboolean uk);

Sets the 'unique key' flag of the given column.

Parameters

column

a GdaColumn.

 

uk

whether if the given column should be an unique key.

 

gda_column_get_references ()

const gchar *
gda_column_get_references (GdaColumn *column);

Reference is returned in tablename.fieldname format. Do not free this variable, it is used internally within GdaColumn.

Parameters

column

a GdaColumn.

 

Returns

column 's references.


gda_column_set_references ()

void
gda_column_set_references (GdaColumn *column,
                           const gchar *ref);

Sets column 's references .

Parameters

column

a GdaColumn.

 

ref

references.

 

gda_column_get_auto_increment ()

gboolean
gda_column_get_auto_increment (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

whether the given column is an auto incremented one (TRUE or FALSE).


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.

Parameters

column

a GdaColumn.

 

is_auto

auto increment status.

 

gda_column_get_position ()

gint
gda_column_get_position (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

the position of the column refer to in the containing data model.


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_get_default_value ()

const GValue *
gda_column_get_default_value (GdaColumn *column);

Parameters

column

a GdaColumn.

 

Returns

column 's default value, as a GValue object.


gda_column_set_default_value ()

void
gda_column_set_default_value (GdaColumn *column,
                              const GValue *default_value);

Sets column 's default GValue.

Parameters

column

a GdaColumn.

 

default_value

default GValue for the column

 

Types and Values

GdaColumn

typedef struct _GdaColumn GdaColumn;

Property Details

The “id” property

  “id”                       gchar *

Flags: Read / Write

Default value: NULL

Signal Details

The “g-type-changed” signal

void
user_function (GdaColumn *gdacolumn,
               gint       arg1,
               gint       arg2,
               gpointer   user_data)

Parameters

gdacolumn

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “name-changed” signal

void
user_function (GdaColumn *gdacolumn,
               gchar     *arg1,
               gpointer   user_data)

Parameters

gdacolumn

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last