GdaDataModelIter

GdaDataModelIter

Functions

Properties

gint current-row Read / Write
GdaDataModel * data-model Read / Write / Construct Only
GdaDataModel * forced-model Read / Write
gboolean update-model Read / Write

Signals

void end-of-data Run First
void row-changed Run First
gboolean row-to-change Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── GdaObject
        ╰── GdaParameterList
            ╰── GdaDataModelIter

Description

Functions

gda_data_model_iter_new ()

GdaDataModelIter *
gda_data_model_iter_new (GdaDataModel *model);

Creates a new GdaDataModelIter object which represents a value or a parameter.

Parameters

model

Model used to create the GdaDataModelIter

 

Returns

the new object


gda_data_model_iter_is_valid ()

gboolean
gda_data_model_iter_is_valid (GdaDataModelIter *iter);

Tells if iter is a valid iterator (if it actually corresponds to a valid row in the model)

Parameters

iter

a GdaDataModelIter object

 

Returns

TRUE if iter is valid


gda_data_model_iter_set_at_row ()

gboolean
gda_data_model_iter_set_at_row (GdaDataModelIter *iter,
                                gint row);

Synchronizes the values of the parameters in iter with the values at the row row

If row < 0 then iter is not bound to any row of the data model it iters through.

Parameters

iter

a GdaDataModelIter object

 

row

the row to set iter to

 

Returns

TRUE if no error occurred


gda_data_model_iter_move_next ()

gboolean
gda_data_model_iter_move_next (GdaDataModelIter *iter);

Moves iter one row further than where it already is (synchronizes the values of the parameters in iter with the values at the new row).

Parameters

iter

a GdaDataModelIter object

 

Returns

TRUE if no error occurred


gda_data_model_iter_move_prev ()

gboolean
gda_data_model_iter_move_prev (GdaDataModelIter *iter);

Moves iter one row before where it already is (synchronizes the values of the parameters in iter with the values at the new row).

Parameters

iter

a GdaDataModelIter object

 

Returns

TRUE if no error occurred


gda_data_model_iter_get_row ()

gint
gda_data_model_iter_get_row (GdaDataModelIter *iter);

Get the row which iter represents in the data model

Parameters

iter

a GdaDataModelIter object

 

Returns

the row number, or -1 if not available


gda_data_model_iter_invalidate_contents ()

void
gda_data_model_iter_invalidate_contents
                               (GdaDataModelIter *iter);

Declare all the parameters in iter invalid, without modifying the GdaDataModel iter is for or changing the row it represents

Parameters

iter

a GdaDataModelIter object

 

gda_data_model_iter_get_column_for_param ()

gint
gda_data_model_iter_get_column_for_param
                               (GdaDataModelIter *iter,
                                GdaParameter *param);

Get the column number in the GdaDataModel for which iter is an iterator as represented by the param parameter

Parameters

iter

a GdaDataModelIter object

 

param

a GdaParameter object, listed in iter

 

Returns

the column number, or param is not valid


gda_data_model_iter_get_param_for_column ()

GdaParameter *
gda_data_model_iter_get_param_for_column
                               (GdaDataModelIter *iter,
                                gint col);

Fetch a pointer to the GdaParameter object which is synchronized with data at column col

Parameters

iter

a GdaDataModelIter object

 

col

the requested column

 

Returns

the GdaParameter, or NULL if an error occurred

Types and Values

GdaDataModelIter

typedef struct _GdaDataModelIter GdaDataModelIter;

Property Details

The “current-row” property

  “current-row”              gint

Flags: Read / Write

Allowed values: >= -1

Default value: -1


The “data-model” property

  “data-model”               GdaDataModel *

Flags: Read / Write / Construct Only


The “forced-model” property

  “forced-model”             GdaDataModel *

Flags: Read / Write


The “update-model” property

  “update-model”             gboolean

Flags: Read / Write

Default value: TRUE

Signal Details

The “end-of-data” signal

void
user_function (GdaDataModelIter *gdadatamodeliter,
               gpointer          user_data)

Parameters

gdadatamodeliter

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “row-changed” signal

void
user_function (GdaDataModelIter *gdadatamodeliter,
               gint              arg1,
               gpointer          user_data)

Parameters

gdadatamodeliter

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “row-to-change” signal

gboolean
user_function (GdaDataModelIter *gdadatamodeliter,
               gint              arg1,
               gpointer          user_data)

Parameters

gdadatamodeliter

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Returns

Flags: Run Last