Back to Seed Clases

Clutter

Classes

Interfaces

Structs

Unions

Event

Enums

GObject.Object
parent-child marker Clutter.Model

Class Clutter.Model

Import line:	Clutter = imports.gi.Clutter;
GIR File:	Clutter-1.0.gir
C documentation:	ClutterModel
Class :	Model
Implements:	Clutter.Scriptable
Subclasses:	Clutter.ListModel
Extends:	GObject.Object

Base class for list models. The ClutterModel structure contains
only private data and should be manipulated using the provided
API.

Properties
Properties		Defined By
	filter_set : gboolean read only Whether the ClutterModel has a filter set This property is set to TRUE if a filter function has been set using clutter_model_set_filter() Whether the ClutterModel has a filter set This property is set to TRUE if a filter function has been set using clutter_model_set_filter()	Clutter.Model
	parent_instance : GObject.Object read only	Clutter.Model
	priv : Clutter.ModelPrivate read only	Clutter.Model

Methods / Constructors
Method / Constructor		Defined By
	new Clutter.Model (Object *properties) Create a new Clutter.Model Create a new Clutter.Model Parameters: Object properties*
	appendv (guint32 *n_columns, Array columns, Array values) : none Creates and appends a new row to the ClutterModel, setting the row values for the given columns* upon creation. Creates and appends a new row to the ClutterModel, setting the row values for the given columns upon creation. Parameters: guint32 n_columns Required (not null) the number of columns and values Array columns Required (not null) a vector with the columns to set Array values Required (not null) a vector with the values Returns: none	Clutter.Model
	filter_iter (ModelIter *iter) : gboolean Checks whether the row pointer by iter* should be filtered or not using the filtering function set on model. Checks whether the row pointer by iter should be filtered or not using the filtering function set on model. This function should be used only by subclasses of ClutterModel. FALSE otherwise Parameters: Clutter.ModelIter iter Required (not null) the row to filter Returns: gboolean TRUE if the row should be displayed,	Clutter.Model
	filter_row (guint32 *row) : gboolean Checks whether row* should be filtered or not using the filtering function set on model. Checks whether row should be filtered or not using the filtering function set on model. This function should be used only by subclasses of ClutterModel. FALSE otherwise Parameters: guint32 row Required (not null) the row to filter Returns: gboolean TRUE if the row should be displayed,	Clutter.Model
	foreach (Function *func, void *user_data) : none Calls func* for each row in the model. Calls func for each row in the model. Parameters: Function (Model *model, ModelIter iter, void *user_data) : none Required (not null) a ClutterModelForeachFunc* void* user_data Required (not null) user data to pass to func Returns: none	Clutter.Model
	get_column_name (guint32 *column) : String Retrieves the name of the column* string, and it should not be modified or freed Retrieves the name of the column string, and it should not be modified or freed Parameters: guint32 column Required (not null) the column number Returns: String the name of the column. The model holds the returned	Clutter.Model
	get_column_type (guint32 *column) : Number Retrieves the type of the column. Retrieves the type of the column. Parameters: guint32 column* Required (not null) the column number Returns: Number the type of the column.	Clutter.Model
	get_filter_set () : gboolean Returns whether the model has a filter in place, set using clutter_model_set_filter() Returns whether the model has a filter in place, set using clutter_model_set_filter() Returns: gboolean TRUE if a filter is set	Clutter.Model
	get_first_iter () : Clutter.ModelIter Retrieves a ClutterModelIter representing the first non-filtered row in model. Retrieves a ClutterModelIter representing the first non-filtered row in model. Call g_object_unref() when done using it Returns: Clutter.ModelIter A new ClutterModelIter.	Clutter.Model
	get_id () : String Retrieves the id of scriptable set using clutter_scriptable_set_id(). Retrieves the id of scriptable set using clutter_scriptable_set_id(). the scriptable object and should never be modified of freed Returns: String the id of the object. The returned string is owned by	Clutter.Scriptable
	get_iter_at_row (guint32 *row) : Clutter.ModelIter Retrieves a ClutterModelIter* representing the row at the given index. Retrieves a ClutterModelIter representing the row at the given index. If a filter function has been set using clutter_model_set_filter() then the model implementation will return the first non filtered row. out of bounds. When done using the iterator object, call g_object_unref() to deallocate its resources Parameters: guint32 row Required (not null) position of the row to retrieve Returns: Clutter.ModelIter A new ClutterModelIter, or NULL if row was	Clutter.Model
	get_last_iter () : Clutter.ModelIter Retrieves a ClutterModelIter representing the last non-filtered row in model. Retrieves a ClutterModelIter representing the last non-filtered row in model. Call g_object_unref() when done using it Returns: Clutter.ModelIter A new ClutterModelIter.	Clutter.Model
	get_n_columns () : guint32 Retrieves the number of columns inside model. Retrieves the number of columns inside model. Returns: guint32 the number of columns	Clutter.Model
	get_n_rows () : guint32 Retrieves the number of rows inside model, eventually taking into account any filtering function set using clutter_model_set_filter(). Retrieves the number of rows inside model, eventually taking into account any filtering function set using clutter_model_set_filter(). the length of the filtered model is returned. Returns: guint32 The length of the model. If there is a filter set, then	Clutter.Model
	get_sorting_column () : gint32 Retrieves the number of column used for sorting the model. Retrieves the number of column used for sorting the model. Returns: gint32 a column number, or -1 if the model is not sorted	Clutter.Model
	insert_value (guint32 *row, guint32 column, Value value) : none Sets the data in the cell specified by iter* and column. Sets the data in the cell specified by iter and column. The type of not exist then it is created. Parameters: guint32 row Required (not null) position of the row to modify guint32 column Required (not null) column to modify GObject.Value value Required (not null) new value for the cell Returns: none	Clutter.Model
	insertv (guint32 *row, guint32 n_columns, Array columns, Array values) : none Inserts data at row* into the ClutterModel, setting the row values for the given columns upon creation. Inserts data at row into the ClutterModel, setting the row values for the given columns upon creation. Parameters: guint32 row Required (not null) row index guint32 n_columns Required (not null) the number of columns and values to set Array columns Required (not null) a vector containing the columns to set Array values Required (not null) a vector containing the values for the cells Returns: none	Clutter.Model
	parse_custom_node (Script *script, Value value, String name, Node node) : gboolean Parses the passed JSON node. Parses the passed JSON node. The implementation must set the type of the passed GValue* pointer using g_value_init(). Parameters: Clutter.Script script Required (not null) the ClutterScript creating the scriptable instance GObject.Value value Required (not null) the generic value to be set String name Required (not null) the name of the node Json.Node node Required (not null) the JSON node to be parsed Returns: gboolean TRUE if the node was successfully parsed, FALSE otherwise.	Clutter.Scriptable
	prependv (guint32 *n_columns, Array columns, Array values) : none Creates and prepends a new row to the ClutterModel, setting the row values for the given columns* upon creation. Creates and prepends a new row to the ClutterModel, setting the row values for the given columns upon creation. Parameters: guint32 n_columns Required (not null) the number of columns and values to set Array columns Required (not null) a vector containing the columns to set Array values Required (not null) a vector containing the values for the cells Returns: none	Clutter.Model
	remove (guint32 *row) : none Removes the row at the given position from the model. Removes the row at the given position from the model. Parameters: guint32 row* Required (not null) position of row to remove Returns: none	Clutter.Model
	resort () : none Force a resort on the model. Force a resort on the model. This function should only be used by subclasses of ClutterModel. Returns: none	Clutter.Model
	set_custom_property (Script *script, String name, Value value) : none Overrides the common properties setting. Overrides the common properties setting. The underlying virtual function should be used when implementing custom properties. Parameters: Clutter.Script script* Required (not null) the ClutterScript creating the scriptable instance String name Required (not null) the name of the property GObject.Value value Required (not null) the value of the property Returns: none	Clutter.Scriptable
	set_filter (Function *func, void *user_data, Function notify) : none Filters the model* using the given filtering function. Filters the model using the given filtering function. Parameters: Function (Model *model, ModelIter iter, void *user_data) : none a ClutterModelFilterFunc, or NULL* void* user_data Required (not null) user data to pass to func, or NULL Function (void* *data) : none Required (not null) destroy notifier of user_data, or NULL* Returns: none	Clutter.Model
	set_id (String *id_) : none Sets id as the unique Clutter script it for this instance of ClutterScriptableIface. Sets id as the unique Clutter script it for this instance of ClutterScriptableIface. This name can be used by user interface designer applications to define a unique name for an object constructable using the UI definition language parsed by ClutterScript. Parameters: String id_* Required (not null) Returns: none	Clutter.Scriptable
	set_names (guint32 *n_columns, Array names) : none Assigns a name to the columns of a ClutterModel. Assigns a name to the columns of a ClutterModel. This function is meant primarily for GObjects* that inherit from ClutterModel, and should only be used when contructing a ClutterModel. It will not work after the initial creation of the ClutterModel. Parameters: guint32 n_columns Required (not null) the number of column names Array names Required (not null) an array of strings Returns: none	Clutter.Model
	set_sort (gint32 *column, Function func, void *user_data, Function notify) : none Sorts model* using the given sorting function. Sorts model using the given sorting function. Parameters: gint32 column Required (not null) the column to sort on Function (Model *model, Value a, Value b, void *user_data) : none a ClutterModelSortFunc, or NULL* void* user_data Required (not null) user data to pass to func, or NULL Function (void* *data) : none Required (not null) destroy notifier of user_data, or NULL* Returns: none	Clutter.Model
	set_sorting_column (gint32 *column) : none Sets the model to sort by column. Sets the model to sort by column. If column* is a negative value the sorting column will be unset. Parameters: gint32 column Required (not null) the column of the model to sort, or -1 Returns: none	Clutter.Model
	set_types (guint32 *n_columns, Array types) : none Sets the types of the columns inside a ClutterModel. Sets the types of the columns inside a ClutterModel. This function is meant primarily for GObjects* that inherit from ClutterModel, and should only be used when contructing a ClutterModel. It will not work after the initial creation of the ClutterModel. Parameters: guint32 n_columns Required (not null) number of columns for the model Array types Required (not null) an array of GType types Returns: none	Clutter.Model

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	filter_changed (Model *self) : none The ::filter-changed signal is emitted when a new filter has been applied The ::filter-changed signal is emitted when a new filter has been applied Parameters: Clutter.Model self* Returns: {none}	Clutter.Model
	row_added (Model *self, ModelIter iter) : none The ::row-added signal is emitted when a new row has been added. The ::row-added signal is emitted when a new row has been added. The data on the row has already been set when the ::row-added signal has been emitted. Parameters: Clutter.Model self* Clutter.ModelIter iter Returns: {none}	Clutter.Model
	row_changed (Model *self, ModelIter iter) : none The ::row-removed signal is emitted when a row has been changed. The ::row-removed signal is emitted when a row has been changed. The data on the row has already been updated when the ::row-changed signal has been emitted. Parameters: Clutter.Model self* Clutter.ModelIter iter Returns: {none}	Clutter.Model
	row_removed (Model *self, ModelIter iter) : none The ::row-removed signal is emitted when a row has been removed. The ::row-removed signal is emitted when a row has been removed. The data on the row pointed by the passed iterator is still valid when the ::row-removed signal has been emitted. Parameters: Clutter.Model self* Clutter.ModelIter iter Returns: {none}	Clutter.Model
	sort_changed (Model *self) : none The ::sort-changed signal is emitted after the model has been sorted The ::sort-changed signal is emitted after the model has been sorted Parameters: Clutter.Model self* Returns: {none}	Clutter.Model

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Clutter.ListModel Method	Clutter.ListModel.newv (guint32 *n_columns, Number types, String names*) : Clutter.Model Non-vararg version of clutter_list_model_new().
Clutter.ModelIter Property	model : Clutter.Model A reference to the ClutterModel that this iter belongs to.
Clutter.ModelIter Method	get_model () : Clutter.Model Retrieves a pointer to the ClutterModel that this iter is part of.

Un-official Seed Documentation

Clutter

Classes

Interfaces

Structs

Unions

Enums

Class Clutter.Model