cluttermm: Clutter::ModelIter Class Reference

Inheritance diagram for Clutter::ModelIter:
Collaboration diagram for Clutter::ModelIter:

Public Member Functions

virtual ~ModelIter ()
 
ClutterModelIter* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterModelIter* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterModelIter* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
void get_value (guint column, const Glib::ValueBase& value)
 Sets an initializes value to that at column. More...

 
void set_valist (va_list args)
 See set(); this version takes a va_list for language bindings. More...

 
void set_value (guint column, const Glib::ValueBase& value)
 Sets the data in the cell specified by iter and column. More...

 
bool is_first () const
 Gets whether the current iterator is at the beginning of the model to which it belongs. More...

 
bool is_last () const
 Gets whether the iterator is at the end of the model to which it belongs. More...

 
Glib::RefPtr< ModelIternext ()
 Updates the iter to point at the next position in the model. More...

 
Glib::RefPtr< ModelIterprev ()
 Sets the iter to point at the previous position in the model. More...

 
Glib::RefPtr< Modelget_model ()
 Retrieves a pointer to the Clutter::Model that this iter is part of. More...

 
guint get_row () const
 Retrieves the position of the row that the iter points to. More...

 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 

Protected Member Functions

 ModelIter ()
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Clutter::ModelIterwrap (ClutterModelIter* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Constructor & Destructor Documentation

virtual Clutter::ModelIter::~ModelIter ( )
virtual
Clutter::ModelIter::ModelIter ( )
protected

Member Function Documentation

Glib::RefPtr<Model> Clutter::ModelIter::get_model ( )

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

Since cluttermm 0.6:
Returns
A pointer to a Clutter::Model.
guint Clutter::ModelIter::get_row ( ) const

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

Since cluttermm 0.6:
Returns
The position of the iter in the model.
static GType Clutter::ModelIter::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

void Clutter::ModelIter::get_value ( guint  column,
const Glib::ValueBase value 
)

Sets an initializes value to that at column.

When done with value, Glib::value_unset() needs to be called to free any allocated memory.

Since cluttermm 0.6:
Parameters
columnColumn number to retrieve the value from.
valueAn empty Value to set.
ClutterModelIter* Clutter::ModelIter::gobj ( )
inline

Provides access to the underlying C GObject.

const ClutterModelIter* Clutter::ModelIter::gobj ( ) const
inline

Provides access to the underlying C GObject.

ClutterModelIter* Clutter::ModelIter::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

bool Clutter::ModelIter::is_first ( ) const

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

Since cluttermm 0.6:
Returns
#true if iter is the first iter in the filtered model.
bool Clutter::ModelIter::is_last ( ) const

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

Since cluttermm 0.6:
Returns
#true if iter is the last iter in the filtered model.
Glib::RefPtr<ModelIter> Clutter::ModelIter::next ( )

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.

Since cluttermm 0.6:
Returns
The passed iterator, updated to point at the next row in the model.
Glib::RefPtr<ModelIter> Clutter::ModelIter::prev ( )

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.

Since cluttermm 0.6:
Returns
The passed iterator, updated to point at the previous row in the model.
void Clutter::ModelIter::set_valist ( va_list  args)

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

Since cluttermm 0.6:
Parameters
argsVa_list of column/value pairs, terminiated by -1.
void Clutter::ModelIter::set_value ( guint  column,
const Glib::ValueBase value 
)

Sets the data in the cell specified by iter and column.

The type of value must be convertable to the type of the column.

Since cluttermm 0.6:
Parameters
columnColumn number to retrieve the value from.
valueNew value for the cell.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::ModelIter > wrap ( ClutterModelIter *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file:
  • cluttermm/model-iter.h