GdaDataModel column indexes

Go to page content
Go to main menu
Go to the search field

GdaDataModel column indexes

GdaDataModel column indexes — Management of GdaDataModel column index attributes

Synopsis

                    GdaColumnIndex;
enum                GdaSorting;
                    GdaColumnIndex;
                    GdaColumnIndexClass;
                    GdaColumnIndexPrivate;
GdaColumnIndex*     gda_column_index_new                (void);
GdaColumnIndex*     gda_column_index_copy               (GdaColumnIndex *dmcia);
gboolean            gda_column_index_equal              (const GdaColumnIndex *lhs,
                                                         const GdaColumnIndex *rhs);
const gchar*        gda_column_index_get_column_name    (GdaColumnIndex *dmcia);
void                gda_column_index_set_column_name    (GdaColumnIndex *dmcia,
                                                         const gchar *column_name);
glong               gda_column_index_get_defined_size   (GdaColumnIndex *dmcia);
void                gda_column_index_set_defined_size   (GdaColumnIndex *dmcia,
                                                         glong size);
GdaSorting          gda_column_index_get_sorting        (GdaColumnIndex *dmcia);
void                gda_column_index_set_sorting        (GdaColumnIndex *dmcia,
                                                         GdaSorting sorting);
const gchar*        gda_column_index_get_references     (GdaColumnIndex *dmcia);
void                gda_column_index_set_references     (GdaColumnIndex *dmcia,
                                                         const gchar *ref);

Object Hierarchy

  GObject
   +----GdaColumnIndex

  GObject
   +----GdaColumnIndex

Description

Details

GdaColumnIndex

typedef struct _GdaColumnIndex GdaColumnIndex;

enum GdaSorting

typedef enum {
	GDA_SORTING_ASCENDING,
	GDA_SORTING_DESCENDING
} GdaSorting;

GdaColumnIndex

typedef struct _GdaColumnIndex GdaColumnIndex;

GdaColumnIndexClass

typedef struct {
	GObjectClass parent_class;
} GdaColumnIndexClass;

GdaColumnIndexPrivate

typedef struct _GdaColumnIndexPrivate GdaColumnIndexPrivate;

gda_column_index_new ()

GdaColumnIndex*     gda_column_index_new                (void);

Returns :

a newly allocated GdaColumnIndex object.

gda_column_index_copy ()

GdaColumnIndex*     gda_column_index_copy               (GdaColumnIndex *dmcia);

Creates a new GdaColumnIndex object from an existing one.

`dmcia` :	attributes to get a copy from.
Returns :	a newly allocated GdaColumnIndex with a copy of the data in `dmcia`.

gda_column_index_equal ()

gboolean            gda_column_index_equal              (const GdaColumnIndex *lhs,
                                                         const GdaColumnIndex *rhs);

Tests whether two field attributes are equal.

`lhs` :	a GdaColumnIndex
`rhs` :	another GdaColumnIndex
Returns :	`TRUE` if the field attributes contain the same information.

gda_column_index_get_column_name ()

const gchar*        gda_column_index_get_column_name    (GdaColumnIndex *dmcia);

`dmcia` :	a GdaColumnIndex.
Returns :	the column name of `dmcia`.

gda_column_index_set_column_name ()

void                gda_column_index_set_column_name    (GdaColumnIndex *dmcia,
                                                         const gchar *column_name);

Sets the name of dmcia to column_name.

`dmcia` :	a GdaColumnIndex.
`column_name` :	the new name of `dmcia`.

gda_column_index_get_defined_size ()

glong               gda_column_index_get_defined_size   (GdaColumnIndex *dmcia);

`dmcia` :	a `GdaColumnIndex`.
Returns :	the defined size of `dmcia`.

gda_column_index_set_defined_size ()

void                gda_column_index_set_defined_size   (GdaColumnIndex *dmcia,
                                                         glong size);

Sets the defined size of a GdaColumnIndex.

`dmcia` :	a GdaColumnIndex.
`size` :	the defined size we want to set.

gda_column_index_get_sorting ()

GdaSorting          gda_column_index_get_sorting        (GdaColumnIndex *dmcia);

`dmcia` :	a `GdaColumnIndex`.
Returns :	the sorting of `dmcia`.

gda_column_index_set_sorting ()

void                gda_column_index_set_sorting        (GdaColumnIndex *dmcia,
                                                         GdaSorting sorting);

Sets the sorting of a GdaColumnIndex.

`dmcia` :	a GdaColumnIndex.
`sorting` :	the new sorting of `dmcia`.

gda_column_index_get_references ()

const gchar*        gda_column_index_get_references     (GdaColumnIndex *dmcia);

`dmcia` :	a GdaColumnIndex.
Returns :	`dmcia`'s references.

gda_column_index_set_references ()

void                gda_column_index_set_references     (GdaColumnIndex *dmcia,
                                                         const gchar *ref);

Sets dmcia's references.

`dmcia` :	a GdaColumnIndex.
`ref` :	references.