Back to Seed Clases

Gda

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gda.DataModelArray

Class Gda.DataModelArray

Import line:	Gda = imports.gi.Gda;
GIR File:	Gda-4.0.gir
C documentation:	GdaDataModelArray
Class :	DataModelArray
Implements:	Gda.DataModel
Extends:	GObject.Object
	Show / Hide Inherited methods, properties and signals

Properties
Properties		Defined By
	n_columns : Number	Gda.DataModelArray
	object : GObject.Object read only	Gda.DataModelArray
	priv : Gda.DataModelArrayPrivate read only	Gda.DataModelArray
	read_only : Boolean	Gda.DataModelArray

Methods / Constructors
Method / Constructor		Defined By
	new Gda.DataModelArray (Object *properties) Create a new Gda.DataModelArray Create a new Gda.DataModelArray Parameters: Object properties*
	new Gda.DataModelArray.c_new (Number *cols) : Gda.DataModelArray Create a new Gda.DataModelArray Create a new Gda.DataModelArray Parameters: Number cols* Required (not null) Returns: Gda.DataModelArray
	add_data_from_xml_node (Node *node) : Boolean Adds the data from an XML node to the given data model (see the DTD for that node in the $prefix/share/libgda/dtd/libgda-array.dtd file). Adds the data from an XML node to the given data model (see the DTD for that node in the $prefix/share/libgda/dtd/libgda-array.dtd file). Parameters: libxml2.Node node* Required (not null) Returns: Boolean	Gda.DataModel
	append_row () : Number Appends a row to the data model (the new row will possibly have NULL values for all columns, or some other values depending on the data model implementation) Appends a row to the data model (the new row will possibly have NULL values for all columns, or some other values depending on the data model implementation) Returns: Number	Gda.DataModel
	append_values (Array *values) : Number Appends a row to the given data model. Appends a row to the given data model. If any value in values* is actually NULL, then it is considered as a default value. Parameters: Array values Required (not null) GList of GValue* representing the row to add. The length must match model's column count. These GValue are value-copied (the user is still responsible for freeing them). Returns: Number	Gda.DataModel
	array_copy_model () : Gda.DataModelArray Makes a copy of src into a new GdaDataModelArray object Makes a copy of src into a new GdaDataModelArray object Returns: Gda.DataModelArray	Gda.DataModel
	clear () : none Frees all the rows in model. Frees all the rows in model. Returns: none	Gda.DataModelArray
	create_iter () : Gda.DataModelIter Creates a new iterator object GdaDataModelIter object which can be used to iterate through rows in model. Creates a new iterator object GdaDataModelIter object which can be used to iterate through rows in model. Depending on the data model's implementation, a new GdaDataModelIter object may be created, or a reference to an already existing GdaDataModelIter may be returned. If a new GdaDataModelIter is created, then the row it represents is undefined. For models which can be accessed randomly, any row can be set using gda_data_model_iter_move_to_row(), and for models which are accessible sequentially only then use gda_data_model_iter_move_next() (and gda_data_model_iter_move_prev() if supported). Returns: Gda.DataModelIter a GdaDataModelIter object, or NULL if an error occurred	Gda.DataModel
	describe_column (Number *col) : Gda.Column Queries the underlying data model implementation for a description of a given column. Queries the underlying data model implementation for a description of a given column. That description is returned in the form of a GdaColumn* structure, which contains all the information about the given column in the data model. and should not be destroyed; any modification will affect the whole data model. Parameters: Number col Required (not null) Returns: Gda.Column the description of the column.	Gda.DataModel
	dump_as_string () : String Dumps a textual representation of the model into a new string The following environment variables can affect the resulting output: Dumps a textual representation of the model into a new string The following environment variables can affect the resulting output: Returns: String	Gda.DataModel
	export_to_file (DataModelIOFormat *format, String file, Array cols, Number nb_cols, Array rows, Number nb_rows, Set options) : Boolean Exports data contained in model* to the file file; the format is specified using the format argument. Exports data contained in model to the file file; the format is specified using the format argument. Specifically, the parameters in the options list can be: Parameters: Gda.DataModelIOFormat format Required (not null) String file Required (not null) Array cols Required (not null) an array containing which columns of model will be exported, or NULL for all columns Number nb_cols Required (not null) Array rows Required (not null) an array containing which rows of model will be exported, or NULL for all rows Number nb_rows Required (not null) Gda.Set options Required (not null) Returns: Boolean	Gda.DataModel
	export_to_string (DataModelIOFormat *format, Array cols, Number nb_cols, Array rows, Number nb_rows, Set options) : String Exports data contained in model* to a string; the format is specified using the format argument, see the gda_data_model_export_to_file() documentation for more information about the options argument (except for the "OVERWRITE" option). Exports data contained in model to a string; the format is specified using the format argument, see the gda_data_model_export_to_file() documentation for more information about the options argument (except for the "OVERWRITE" option). Parameters: Gda.DataModelIOFormat format Required (not null) Array cols Required (not null) an array containing which columns of model will be exported, or NULL for all columns Number nb_cols Required (not null) Array rows Required (not null) an array containing which rows of model will be exported, or NULL for all rows Number nb_rows Required (not null) Gda.Set options Required (not null) Returns: String	Gda.DataModel
	freeze () : none Disables notifications of changes on the given data model. Disables notifications of changes on the given data model. To re-enable notifications again, you should call the gda_data_model_thaw function. Returns: none	Gda.DataModel
	get_access_flags () : Gda.DataModelAccessFlags Get the attributes of model such as how to access the data it contains if it's modifiable, etc. Get the attributes of model such as how to access the data it contains if it's modifiable, etc. Returns: Gda.DataModelAccessFlags an ORed value of GdaDataModelAccessFlags flags	Gda.DataModel
	get_attributes_at (Number *col, Number row) : Gda.ValueAttribute Get the attributes of the value stored at (row, col) in model, which is an ORed value of GdaValueAttribute* flags. Get the attributes of the value stored at (row, col) in model, which is an ORed value of GdaValueAttribute flags. As a special case, if if a row was added to model. Parameters: Number col Required (not null) Number row Required (not null) Returns: Gda.ValueAttribute the attributes as an ORed value of GdaValueAttribute	Gda.DataModel
	get_column_index (String *name) : Number Get the index of the first column named name* in model. Get the index of the first column named name in model. Parameters: String name Required (not null) Returns: Number	Gda.DataModel
	get_column_name (Number *col) : String Parameters: Number col* Required (not null) Returns: String	Gda.DataModel
	get_column_title (Number *col) : String Parameters: Number col* Required (not null) Returns: String	Gda.DataModel
	get_n_columns () : Number Returns: Number	Gda.DataModel
	get_n_rows () : Number Returns: Number	Gda.DataModel
	get_row (Number *row) : Gda.Row Get a pointer to a row in model* Get a pointer to a row in model Parameters: Number row Required (not null) Returns: Gda.Row the GdaRow, or NULL if an error occurred	Gda.DataModelArray
	get_row_from_values (Array *values, Array cols_index) : Number Returns the first row where all the values in values* at the columns identified at Returns the first row where all the values in values at the columns identified at Parameters: Array values Required (not null) Array cols_index Required (not null) an array of gint containing the column number to match each value of values Returns: Number	Gda.DataModel
	get_typed_value_at (Number *col, Number row, Number expected_type, Boolean nullok) : GObject.Value This method is similar to gda_data_model_get_value_at(), except that it also allows one to specify the expected this method returns NULL* and an error code. This method is similar to gda_data_model_get_value_at(), except that it also allows one to specify the expected this method returns NULL and an error code. position, or NULL on error (out-of-bound position, wrong data type, etc). Parameters: Number col Required (not null) Number row Required (not null) Number expected_type Required (not null) Boolean nullok Required (not null) will not generate any error Returns: GObject.Value	Gda.DataModel
	get_value_at (Number *col, Number row) : GObject.Value Retrieves the data stored in the given position (identified by the col* and row parameters) on a data model. Retrieves the data stored in the given position (identified by the col and row parameters) on a data model. This is the main function for accessing data in a model which allows random access to its data. To access data in a data model using a cursor, use a GdaDataModelIter object, obtained using gda_data_model_create_iter(). occur if you do so). which means if you want to keep the value, a copy must be made, however it will remain valid as long as the only Libgda usage is calling gda_data_model_get_value_at() for different values of the same row. If you want to modify a value stored in a GdaDataModel, use the gda_data_model_set_value_at() or gda_data_model_set_values() methods. position, or NULL on error (out-of-bound position, etc). Parameters: Number col Required (not null) Number row Required (not null) Returns: GObject.Value a GValue containing the value stored in the given	Gda.DataModel
	import_from_file (String *file, Object cols_trans, Set options) : Boolean Imports data contained in the file* file into model; the format is detected. Imports data contained in the file file into model; the format is detected. Parameters: String file Required (not null) Object cols_trans Required (not null) Gda.Set options Required (not null) Returns: Boolean	Gda.DataModel
	import_from_model (DataModel *from, Boolean overwrite, Object cols_trans) : Boolean Copy the contents of the from* data model to the to data model. Copy the contents of the from data model to the to data model. The copy stops as soon as an error orrurs. The cols_trans is a hash table for which keys are to columns numbers and the values are the corresponding column numbers in the from data model. To set the values of a column in to to NULL, create an entry in the hash table with a negative value. Parameters: Gda.DataModel from Required (not null) Boolean overwrite Required (not null) Object cols_trans Required (not null) a GHashTable for columns translating, or NULL Returns: Boolean	Gda.DataModel
	import_from_string (String *string, Object cols_trans, Set options) : Boolean Loads the data from string* into model. Loads the data from string into model. Parameters: String string Required (not null) Object cols_trans Required (not null) Gda.Set options Required (not null) Returns: Boolean	Gda.DataModel
	iter_move_next_default (DataModelIter *iter) : Boolean Parameters: Gda.DataModelIter iter* Required (not null) Returns: Boolean	Gda.DataModel
	iter_move_prev_default (DataModelIter *iter) : Boolean Parameters: Gda.DataModelIter iter* Required (not null) Returns: Boolean	Gda.DataModel
	iter_move_to_row_default (DataModelIter *iter, Number row) : Boolean Parameters: Gda.DataModelIter iter* Required (not null) Number row Required (not null) Returns: Boolean	Gda.DataModel
	remove_row (Number *row) : Boolean Removes a row from the data model. Removes a row from the data model. Parameters: Number row* Required (not null) Returns: Boolean	Gda.DataModel
	reset () : none Emits the 'reset' and 'changed' signal on model. Emits the 'reset' and 'changed' signal on model. Returns: none	Gda.DataModel
	row_inserted (Number *row) : none Emits the 'row_inserted' and 'changed' signals on model. Emits the 'row_inserted' and 'changed' signals on model. This method should only be used by GdaDataModel* implementations to signal that a row has been inserted. Parameters: Number row Required (not null) Returns: none	Gda.DataModel
	row_removed (Number *row) : none Emits the 'row_removed' and 'changed' signal on model. Emits the 'row_removed' and 'changed' signal on model. This method should only be used by GdaDataModel* implementations to signal that a row has been removed Parameters: Number row Required (not null) Returns: none	Gda.DataModel
	row_updated (Number *row) : none Emits the 'row_updated' and 'changed' signals on model. Emits the 'row_updated' and 'changed' signals on model. This method should only be used by GdaDataModel* implementations to signal that a row has been updated. Parameters: Number row Required (not null) Returns: none	Gda.DataModel
	send_hint (DataModelHint *hint, Value hint_value) : none Sends a hint to the data model. Sends a hint to the data model. The hint may or may not be handled by the data model, depending on its implementation Parameters: Gda.DataModelHint hint* Required (not null) a hint to send to the model GObject.Value hint_value Required (not null) Returns: none	Gda.DataModel
	set_column_name (Number *col, String name) : none Sets the name* of the given col in model, and if its title is not set, also sets the title to name. Sets the name of the given col in model, and if its title is not set, also sets the title to name. Parameters: Number col Required (not null) String name Required (not null) Returns: none	Gda.DataModel
	set_column_title (Number *col, String title) : none Sets the title* of the given col in model. Sets the title of the given col in model. Parameters: Number col Required (not null) String title Required (not null) Returns: none	Gda.DataModel
	set_n_columns (Number *cols) : none Sets the number of columns for rows inserted in this model. Sets the number of columns for rows inserted in this model. Also clears model's contents. Parameters: Number cols* Required (not null) Returns: none	Gda.DataModelArray
	set_value_at (Number *col, Number row, Value value) : Boolean Modifies a value in model, at (col, row). Modifies a value in model, at (col, row). Parameters: Number col* Required (not null) Number row Required (not null) GObject.Value value Required (not null) Returns: Boolean	Gda.DataModel
	set_values (Number *row, Array values) : Boolean In a similar way to gda_data_model_set_value_at(), this method modifies a data model's contents by setting several values at once. In a similar way to gda_data_model_set_value_at(), this method modifies a data model's contents by setting several values at once. If any value in values* is actually NULL, then the value in the corresponding column is left unchanged. Parameters: Number row Required (not null) Array values Required (not null) a list of GValue, one for at most the number of columns of model Returns: Boolean	Gda.DataModel
	thaw () : none Re-enables notifications of changes on the given data model. Re-enables notifications of changes on the given data model. Returns: none	Gda.DataModel

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	changed (DataModel *self) : none Parameters: Gda.DataModel self* Returns: {none}	Gda.DataModel
	reset (DataModel *self) : none Parameters: Gda.DataModel self* Returns: {none}	Gda.DataModel
	row_inserted (DataModel *self, Number object) : none Parameters: Gda.DataModel self* Number object Returns: {none}	Gda.DataModel
	row_removed (DataModel *self, Number object) : none Parameters: Gda.DataModel self* Number object Returns: {none}	Gda.DataModel
	row_updated (DataModel *self, Number object) : none Parameters: Gda.DataModel self* Number object Returns: {none}	Gda.DataModel

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gda.DataModel Method	array_copy_model () : Gda.DataModelArray Makes a copy of src into a new GdaDataModelArray object

Un-official Seed Documentation

Gda

Classes

Interfaces

Structs

Unions

Enums

Class Gda.DataModelArray