Class: Clutter::ModelIter

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Overview

Class for Clutter::ModelIter instances.

Instance Method Summary collapse

Instance Method Details

#copy ⇒ Clutter::ModelIter

Copies the passed iterator.

Returns:

#get(array) ⇒ nil

Gets the value of one or more cells in the row referenced by iter. The variable argument list should contain integer column numbers, each column column number followed by a place to store the value being retrieved. The list is terminated by a -1.

For example, to get a value from column 0 with type %G_TYPE_STRING use: clutter_model_iter_get (iter, 0, &place_string_here, -1);

where place_string_here is a gchar* to be filled with the string. If appropriate, the returned values have to be freed or unreferenced.

Parameters:

  • array (Array) —

    a list of column/return location pairs, terminated by -1

Returns:

  • (nil)

#get_valist(args) ⇒ nil

See clutter_model_iter_get(). This version takes a va_list for language bindings.

Parameters:

  • args (Clutter::va_list) —

    a list of column/return location pairs, terminated by -1

Returns:

  • (nil)

#get_value(column, value) ⇒ nil

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

Parameters:

  • column (Integer) —

    column number to retrieve the value from

  • value (GObject::Value) —

    an empty #GValue to set

Returns:

  • (nil)

#is_first ⇒ Boolean

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

Returns:

  • (Boolean) —

    #TRUE if iter is the first iter in the filtered model

#is_last ⇒ Boolean

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

Returns:

  • (Boolean) —

    #TRUE if iter is the last iter in the filtered model.

#model ⇒ Clutter::Model

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

Returns:

#model=(model) ⇒ Clutter::Model

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

Parameters:

Returns:

#next ⇒ 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.

Returns:

  • (Clutter::ModelIter) —

    The passed iterator, updated to point at the next row in the model.

#prev ⇒ 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.

Returns:

  • (Clutter::ModelIter) —

    The passed iterator, updated to point at the previous row in the model.

#row ⇒ Integer

The row number to which this iter points to.

Returns:

  • (Integer) —

    row

#row=(row) ⇒ Integer

The row number to which this iter points to.

Parameters:

  • row (Integer)

Returns:

  • (Integer) —

    row

  • (Integer) —

    row

#set(array) ⇒ nil

Sets the value of one or more cells in the row referenced by iter. The variable argument list should contain integer column numbers, each column column number followed by the value to be set. The list is terminated by a -1.

For example, to set column 0 with type %G_TYPE_STRING, use: clutter_model_iter_set (iter, 0, "foo", -1);

Parameters:

  • array (Array) —

    a list of column/return location pairs, terminated by -1

Returns:

  • (nil)

#set_value(column, value) ⇒ nil

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

Parameters:

  • column (Integer) —

    column number to retrieve the value from

  • value (GObject::Value) —

    new value for the cell

Returns:

  • (nil)

#valist=(args) ⇒ nil

See clutter_model_iter_set(); this version takes a va_list for language bindings.

Parameters:

  • args (Clutter::va_list) —

    va_list of column/value pairs, terminiated by -1

Returns:

  • (nil)