RubyGems - clutter - Versions diffs - 2.2.4-x64-mingw32 - Mend

clutter 2.2.4-x64-mingw32

Files changed (744) hide show

data/vendor/local/share/gtk-doc/html/clutter/ClutterModelIter.html ADDED Viewed

@@ -0,0 +1,779 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Clutter Reference Manual: ClutterModelIter</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="index.html" title="Clutter Reference Manual">
+<link rel="up" href="ch12.html" title="Generic list model">
+<link rel="prev" href="ClutterModel.html" title="ClutterModel">
+<link rel="next" href="ClutterListModel.html" title="ClutterListModel">
+<meta name="generator" content="GTK-Doc V1.20.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
+                  <a href="#ClutterModelIter.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
+                  <a href="#ClutterModelIter.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span>
+                  <a href="#ClutterModelIter.properties" class="shortcut">Properties</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="ch12.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="ClutterModel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="ClutterListModel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="ClutterModelIter"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ClutterModelIter.top_of_page"></a>ClutterModelIter</span></h2>
+<p>ClutterModelIter — Iterates through a model</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="ClutterModelIter.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="returnvalue">ClutterModelIter</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-copy" title="clutter_model_iter_copy ()">clutter_model_iter_copy</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-get" title="clutter_model_iter_get ()">clutter_model_iter_get</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-get-valist" title="clutter_model_iter_get_valist ()">clutter_model_iter_get_valist</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-get-value" title="clutter_model_iter_get_value ()">clutter_model_iter_get_value</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-set" title="clutter_model_iter_set ()">clutter_model_iter_set</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-set-valist" title="clutter_model_iter_set_valist ()">clutter_model_iter_set_valist</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-set-value" title="clutter_model_iter_set_value ()">clutter_model_iter_set_value</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-is-first" title="clutter_model_iter_is_first ()">clutter_model_iter_is_first</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-is-last" title="clutter_model_iter_is_last ()">clutter_model_iter_is_last</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="returnvalue">ClutterModelIter</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-next" title="clutter_model_iter_next ()">clutter_model_iter_next</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="returnvalue">ClutterModelIter</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-prev" title="clutter_model_iter_prev ()">clutter_model_iter_prev</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="ClutterModel.html" title="ClutterModel"><span class="returnvalue">ClutterModel</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-get-model" title="clutter_model_iter_get_model ()">clutter_model_iter_get_model</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">guint</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterModelIter.html#clutter-model-iter-get-row" title="clutter_model_iter_get_row ()">clutter_model_iter_get_row</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterModelIter.properties"></a><h2>Properties</h2>
+<div class="informaltable"><table border="0">
+<colgroup>
+<col width="150px" class="properties_type">
+<col width="300px" class="properties_name">
+<col width="200px" class="properties_flags">
+</colgroup>
+<tbody>
+<tr>
+<td class="property_type">
+<a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a> *</td>
+<td class="property_name"><a class="link" href="ClutterModelIter.html#ClutterModelIter--model" title="The “model” property">model</a></td>
+<td class="property_flags">Read / Write</td>
+</tr>
+<tr>
+<td class="property_type"><span class="type">guint</span></td>
+<td class="property_name"><a class="link" href="ClutterModelIter.html#ClutterModelIter--row" title="The “row” property">row</a></td>
+<td class="property_flags">Read / Write</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterModelIter.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="ClutterModelIter.html#ClutterModelIter-struct" title="struct ClutterModelIter">ClutterModelIter</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="ClutterModelIter.html#ClutterModelIterClass" title="struct ClutterModelIterClass">ClutterModelIterClass</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterModelIter.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    GObject
+    <span class="lineart">╰──</span> ClutterModelIter
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterModelIter.description"></a><h2>Description</h2>
+<p><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> is an object used for iterating through all the rows
+of a <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a>. It allows setting and getting values on the row
+which is currently pointing at.</p>
+<p>A <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> represents a position between two elements
+of the sequence. For example, the iterator returned by
+<a class="link" href="ClutterModel.html#clutter-model-get-first-iter" title="clutter_model_get_first_iter ()"><code class="function">clutter_model_get_first_iter()</code></a> represents the gap immediately before
+the first row of the <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a>, and the iterator returned by
+<a class="link" href="ClutterModel.html#clutter-model-get-last-iter" title="clutter_model_get_last_iter ()"><code class="function">clutter_model_get_last_iter()</code></a> represents the gap immediately after the
+last row.</p>
+<p>A <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> can only be created by a <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a> implementation
+and it is valid as long as the model does not change.</p>
+<p><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> is available since Clutter 0.6</p>
+</div>
+<div class="refsect1">
+<a name="ClutterModelIter.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="clutter-model-iter-copy"></a><h3>clutter_model_iter_copy ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="returnvalue">ClutterModelIter</span></a> *
+clutter_model_iter_copy (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);</pre>
+<p>Copies the passed iterator.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.2.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.2.6"></a><h4>Returns</h4>
+<p> a copy of the iterator, or <code class="literal">NULL</code>. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+<p class="since">Since 0.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-get"></a><h3>clutter_model_iter_get ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_model_iter_get (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
+                        <em class="parameter"><code>...</code></em>);</pre>
+<p>Gets the value of one or more cells in the row referenced by <em class="parameter"><code>iter</code></em>
+. 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.</p>
+<p>For example, to get a value from column 0 with type <code class="literal">G_TYPE_STRING</code> use:
+&lt;informalexample&gt;&lt;programlisting&gt;
+  clutter_model_iter_get (iter, 0, &amp;place_string_here, -1);
+&lt;/programlisting&gt;&lt;/informalexample&gt;</p>
+<p>where place_string_here is a gchar* to be filled with the string. If
+appropriate, the returned values have to be freed or unreferenced.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.3.7"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>...</p></td>
+<td class="parameter_description"><p>a list of column/return location pairs, terminated by -1</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-get-valist"></a><h3>clutter_model_iter_get_valist ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_model_iter_get_valist (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
+                               <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
+<p>See <a class="link" href="ClutterModelIter.html#clutter-model-iter-get" title="clutter_model_iter_get ()"><code class="function">clutter_model_iter_get()</code></a>. This version takes a va_list for language
+bindings.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.4.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>args</p></td>
+<td class="parameter_description"><p>a list of column/return location pairs, terminated by -1</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-get-value"></a><h3>clutter_model_iter_get_value ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_model_iter_get_value (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
+                              <em class="parameter"><code><span class="type">guint</span> column</code></em>,
+                              <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
+<p>Sets an initializes <em class="parameter"><code>value</code></em>
+ to that at <em class="parameter"><code>column</code></em>
+. When done with <em class="parameter"><code>value</code></em>
+,
+<code class="function">g_value_unset()</code> needs to be called to free any allocated memory.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.5.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>column</p></td>
+<td class="parameter_description"><p>column number to retrieve the value from</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>value</p></td>
+<td class="parameter_description"><p> an empty <span class="type">GValue</span> to set. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-set"></a><h3>clutter_model_iter_set ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_model_iter_set (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
+                        <em class="parameter"><code>...</code></em>);</pre>
+<p>Sets the value of one or more cells in the row referenced by <em class="parameter"><code>iter</code></em>
+. 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.</p>
+<p>For example, to set column 0 with type <code class="literal">G_TYPE_STRING</code>, use:
+&lt;informalexample&gt;&lt;programlisting&gt;
+  clutter_model_iter_set (iter, 0, "foo", -1);
+&lt;/programlisting&gt;&lt;/informalexample&gt;</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.6.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>...</p></td>
+<td class="parameter_description"><p>a list of column/return location pairs, terminated by -1</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-set-valist"></a><h3>clutter_model_iter_set_valist ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_model_iter_set_valist (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
+                               <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
+<p>See <a class="link" href="ClutterModelIter.html#clutter-model-iter-set" title="clutter_model_iter_set ()"><code class="function">clutter_model_iter_set()</code></a>; this version takes a va_list for language
+bindings.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.7.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>args</p></td>
+<td class="parameter_description"><p>va_list of column/value pairs, terminiated by -1</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-set-value"></a><h3>clutter_model_iter_set_value ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_model_iter_set_value (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
+                              <em class="parameter"><code><span class="type">guint</span> column</code></em>,
+                              <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
+<p>Sets the data in the cell specified by <em class="parameter"><code>iter</code></em>
+ and <em class="parameter"><code>column</code></em>
+. The type of
+<em class="parameter"><code>value</code></em>
+ must be convertable to the type of the column.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.8.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>column</p></td>
+<td class="parameter_description"><p>column number to retrieve the value from</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>value</p></td>
+<td class="parameter_description"><p>new value for the cell</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-is-first"></a><h3>clutter_model_iter_is_first ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+clutter_model_iter_is_first (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);</pre>
+<p>Gets whether the current iterator is at the beginning of the model
+to which it belongs.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.9.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.9.6"></a><h4>Returns</h4>
+<p> <span class="type">TRUE</span> if <em class="parameter"><code>iter</code></em>
+is the first iter in the filtered model</p>
+<p></p>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-is-last"></a><h3>clutter_model_iter_is_last ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+clutter_model_iter_is_last (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);</pre>
+<p>Gets whether the iterator is at the end of the model to which it
+belongs.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.10.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.10.6"></a><h4>Returns</h4>
+<p> <span class="type">TRUE</span> if <em class="parameter"><code>iter</code></em>
+is the last iter in the filtered model.</p>
+<p></p>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-next"></a><h3>clutter_model_iter_next ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="returnvalue">ClutterModelIter</span></a> *
+clutter_model_iter_next (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);</pre>
+<p>Updates the <em class="parameter"><code>iter</code></em>
+ to point at the next position in the model.
+The model implementation should take into account the presence of
+a filter function.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.11.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.11.6"></a><h4>Returns</h4>
+<p> The passed iterator, updated to point at the next
+row in the model. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-prev"></a><h3>clutter_model_iter_prev ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="returnvalue">ClutterModelIter</span></a> *
+clutter_model_iter_prev (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);</pre>
+<p>Sets the <em class="parameter"><code>iter</code></em>
+ to point at the previous position in the model.
+The model implementation should take into account the presence of
+a filter function.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.12.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.12.6"></a><h4>Returns</h4>
+<p> The passed iterator, updated to point at the previous
+row in the model. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-get-model"></a><h3>clutter_model_iter_get_model ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterModel.html" title="ClutterModel"><span class="returnvalue">ClutterModel</span></a> *
+clutter_model_iter_get_model (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);</pre>
+<p>Retrieves a pointer to the <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a> that this iter is part of.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.13.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.13.6"></a><h4>Returns</h4>
+<p> a pointer to a <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a>. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-model-iter-get-row"></a><h3>clutter_model_iter_get_row ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+clutter_model_iter_get_row (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);</pre>
+<p>Retrieves the position of the row that the <em class="parameter"><code>iter</code></em>
+ points to.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.14.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.4.3.8.14.6"></a><h4>Returns</h4>
+<p> the position of the <em class="parameter"><code>iter</code></em>
+in the model</p>
+<p></p>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterModelIter.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="ClutterModelIter-struct"></a><h3>struct ClutterModelIter</h3>
+<pre class="programlisting">struct ClutterModelIter;</pre>
+<p>Base class for list models iters. The <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> structure
+contains only private data and should be manipulated using the
+provided API.</p>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterModelIterClass"></a><h3>struct ClutterModelIterClass</h3>
+<pre class="programlisting">struct ClutterModelIterClass {
+  /* vtable not signals */
+  void              (* get_value) (ClutterModelIter *iter,
+                                   guint             column,
+                                   GValue           *value);
+  void              (* set_value) (ClutterModelIter *iter,
+                                   guint             column,
+                                   const GValue     *value);
+  gboolean          (* is_first)  (ClutterModelIter *iter);
+  gboolean          (* is_last)   (ClutterModelIter *iter);
+  ClutterModelIter *(* next)      (ClutterModelIter *iter);
+  ClutterModelIter *(* prev)      (ClutterModelIter *iter);
+  ClutterModel *    (* get_model) (ClutterModelIter *iter);
+  guint             (* get_row)   (ClutterModelIter *iter);
+  ClutterModelIter *(* copy)      (ClutterModelIter *iter);
+};
+</pre>
+<p>Class for <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> instances.</p>
+<div class="refsect3">
+<a name="id-1.7.4.3.9.3.5"></a><h4>Members</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="300px" class="struct_members_name">
+<col class="struct_members_description">
+<col width="200px" class="struct_members_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterModelIterClass.get-value"></a>get_value</code></em> ()</p></td>
+<td class="struct_member_description"><p>Virtual function for retrieving the value at the given
+column of the row pointed by the iterator</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterModelIterClass.set-value"></a>set_value</code></em> ()</p></td>
+<td class="struct_member_description"><p>Virtual function for setting the value at the given
+column of the row pointer by the iterator</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterModelIterClass.is-first"></a>is_first</code></em> ()</p></td>
+<td class="struct_member_description"><p>Virtual function for knowing whether the iterator points
+at the first row in the model</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterModelIterClass.is-last"></a>is_last</code></em> ()</p></td>
+<td class="struct_member_description"><p>Virtual function for knowing whether the iterator points
+at the last row in the model</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterModelIterClass.next"></a>next</code></em> ()</p></td>
+<td class="struct_member_description"><p>Virtual function for moving the iterator to the following
+row in the model</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterModelIterClass.prev"></a>prev</code></em> ()</p></td>
+<td class="struct_member_description"><p>Virtual function for moving the iterator toe the previous
+row in the model</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterModelIterClass.get-model"></a>get_model</code></em> ()</p></td>
+<td class="struct_member_description"><p>Virtual function for getting the model to which the
+iterator belongs to</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterModelIterClass.get-row"></a>get_row</code></em> ()</p></td>
+<td class="struct_member_description"><p>Virtual function for getting the row to which the iterator
+points</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterModelIterClass.copy"></a>copy</code></em> ()</p></td>
+<td class="struct_member_description"><p>Virtual function for copying a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>.</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterModelIter.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="ClutterModelIter--model"></a><h3>The <code class="literal">“model”</code> property</h3>
+<pre class="programlisting">  “model”                    <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a> *</pre>
+<p>A reference to the <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a> that this iter belongs to.</p>
+<p>Flags: Read / Write</p>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterModelIter--row"></a><h3>The <code class="literal">“row”</code> property</h3>
+<pre class="programlisting">  “row”                      <span class="type">guint</span></pre>
+<p>The row number to which this iter points to.</p>
+<p>Flags: Read / Write</p>
+<p>Default value: 0</p>
+<p class="since">Since 0.6</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20.1</div>
+</body>
+</html>