Clutter.ModelIter¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`copy` ()
	`get_model` ()
	`get_row` ()
	`get_value` (column)
	`is_first` ()
	`is_last` ()
	`next` ()
	`prev` ()
	`set_value` (column, value)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_copy` ()
	`do_get_model` ()
	`do_get_row` ()
	`do_get_value` (column)
	`do_is_first` ()
	`do_is_last` ()
	`do_next` ()
	`do_prev` ()
	`do_set_value` (column, value)

Properties¶

Name	Type	Flags	Short Description
`model`	`Clutter.Model`	r/w	The model to which the iterator belongs to `deprecated`
`row`	`int`	r/w	The row to which the iterator points to `deprecated`

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Clutter.ModelIter(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: Clutter.ModelIterClass

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

New in version 0.6.

Deprecated since version 1.24: Use custom iterators for Gio.ListModel

copy()¶

Returns:: a copy of the iterator, or None
Return type:: Clutter.ModelIter

Copies the passed iterator.

New in version 0.8.

Deprecated since version 1.24: Use Gio.ListModel instead

get_model()¶

Returns:: a pointer to a Clutter.Model.
Return type:: Clutter.Model

Retrieves a pointer to the Clutter.Model that this iter is part of.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

get_row()¶

Returns:: the position of the self in the model
Return type:: int

Retrieves the position of the row that the self points to.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

get_value(column)¶

Parameters:: column (int) – column number to retrieve the value from
Returns:: an empty GObject.Value to set
Return type:: value: GObject.Value

Sets an initializes value to that at column. When done with value, GObject.Value.unset() needs to be called to free any allocated memory.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

is_first()¶

Returns:: True if self is the first iter in the filtered model
Return type:: bool

Gets whether the current iterator is at the beginning of the model to which it belongs.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

is_last()¶

Returns:: True if self is the last iter in the filtered model.
Return type:: bool

Gets whether the iterator is at the end of the model to which it belongs.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

next()¶

Returns:: The passed iterator, updated to point at the next row in the model.
Return type:: Clutter.ModelIter

Updates the self to point at the next position in the model. The model implementation should take into account the presence of a filter function.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

prev()¶

Returns:: The passed iterator, updated to point at the previous row in the model.
Return type:: Clutter.ModelIter

Sets the self to point at the previous position in the model. The model implementation should take into account the presence of a filter function.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

set_value(column, value)¶

Parameters:

column (int) – column number to retrieve the value from
value (GObject.Value) – new value for the cell

Sets the data in the cell specified by self and column. The type of value must be convertable to the type of the column.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

do_copy() virtual¶

Returns:: a copy of the iterator, or None
Return type:: Clutter.ModelIter

Copies the passed iterator.

New in version 0.8.

Deprecated since version 1.24: Use Gio.ListModel instead

do_get_model() virtual¶

Returns:: a pointer to a Clutter.Model.
Return type:: Clutter.Model

Retrieves a pointer to the Clutter.Model that this iter is part of.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

do_get_row() virtual¶

Returns:: the position of the iter in the model
Return type:: int

Retrieves the position of the row that the iter points to.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

do_get_value(column) virtual¶

Parameters:: column (int) – column number to retrieve the value from
Returns:: an empty GObject.Value to set
Return type:: value: GObject.Value

Sets an initializes value to that at column. When done with value, GObject.Value.unset() needs to be called to free any allocated memory.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

do_is_first() virtual¶

Returns:: True if iter is the first iter in the filtered model
Return type:: bool

Gets whether the current iterator is at the beginning of the model to which it belongs.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

do_is_last() virtual¶

Returns:: True if iter is the last iter in the filtered model.
Return type:: bool

Gets whether the iterator is at the end of the model to which it belongs.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

do_next() virtual¶

Returns:: The passed iterator, updated to point at the next row in the model.
Return type:: Clutter.ModelIter

Updates the iter to point at the next position in the model. The model implementation should take into account the presence of a filter function.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

do_prev() virtual¶

Returns:: The passed iterator, updated to point at the previous row in the model.
Return type:: Clutter.ModelIter

Sets the iter to point at the previous position in the model. The model implementation should take into account the presence of a filter function.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

do_set_value(column, value) virtual¶

Parameters:

column (int) – column number to retrieve the value from
value (GObject.Value) – new value for the cell

Sets the data in the cell specified by iter and column. The type of value must be convertable to the type of the column.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

Property Details¶

Clutter.ModelIter.props.model¶

Name:: model
Type:: Clutter.Model
Default Value:: None
Flags:: READABLE, WRITABLE

A reference to the Clutter.Model that this iter belongs to.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead

Clutter.ModelIter.props.row¶

Name:: row
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

The row number to which this iter points to.

New in version 0.6.

Deprecated since version 1.24: Use Gio.ListModel instead