1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>ClutterModelIter</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="ch13.html" title="Generic list model">
9 <link rel="prev" href="ClutterModel.html" title="ClutterModel">
10 <link rel="next" href="ClutterListModel.html" title="ClutterListModel">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="ClutterModel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch13.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="ClutterListModel.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterModelIter.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterModelIter.description" class="shortcut">Description</a>
28 <a href="#ClutterModelIter.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterModelIter.properties" class="shortcut">Properties</a>
33 <div class="refentry">
34 <a name="ClutterModelIter"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="ClutterModelIter.top_of_page"></a>ClutterModelIter</span></h2>
38 <p>ClutterModelIter — Iterates through a model</p>
40 <td valign="top" align="right"></td>
42 <div class="refsynopsisdiv">
43 <a name="ClutterModelIter.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis">struct <a class="link" href="ClutterModelIter.html#ClutterModelIter-struct" title="struct ClutterModelIter">ClutterModelIter</a>;
45 struct <a class="link" href="ClutterModelIter.html#ClutterModelIterClass" title="struct ClutterModelIterClass">ClutterModelIterClass</a>;
46 <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="returnvalue">ClutterModelIter</span></a> * <a class="link" href="ClutterModelIter.html#clutter-model-iter-copy" title="clutter_model_iter_copy ()">clutter_model_iter_copy</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);
48 <span class="returnvalue">void</span> <a class="link" href="ClutterModelIter.html#clutter-model-iter-get" title="clutter_model_iter_get ()">clutter_model_iter_get</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
49 <em class="parameter"><code>...</code></em>);
50 <span class="returnvalue">void</span> <a class="link" href="ClutterModelIter.html#clutter-model-iter-get-valist" title="clutter_model_iter_get_valist ()">clutter_model_iter_get_valist</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
51 <em class="parameter"><code><span class="type">va_list</span> args</code></em>);
52 <span class="returnvalue">void</span> <a class="link" href="ClutterModelIter.html#clutter-model-iter-get-value" title="clutter_model_iter_get_value ()">clutter_model_iter_get_value</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
53 <em class="parameter"><code><span class="type">guint</span> column</code></em>,
54 <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);
55 <span class="returnvalue">void</span> <a class="link" href="ClutterModelIter.html#clutter-model-iter-set" title="clutter_model_iter_set ()">clutter_model_iter_set</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
56 <em class="parameter"><code>...</code></em>);
57 <span class="returnvalue">void</span> <a class="link" href="ClutterModelIter.html#clutter-model-iter-set-valist" title="clutter_model_iter_set_valist ()">clutter_model_iter_set_valist</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
58 <em class="parameter"><code><span class="type">va_list</span> args</code></em>);
59 <span class="returnvalue">void</span> <a class="link" href="ClutterModelIter.html#clutter-model-iter-set-value" title="clutter_model_iter_set_value ()">clutter_model_iter_set_value</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>,
60 <em class="parameter"><code><span class="type">guint</span> column</code></em>,
61 <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);
63 <span class="returnvalue">gboolean</span> <a class="link" href="ClutterModelIter.html#clutter-model-iter-is-first" title="clutter_model_iter_is_first ()">clutter_model_iter_is_first</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);
64 <span class="returnvalue">gboolean</span> <a class="link" href="ClutterModelIter.html#clutter-model-iter-is-last" title="clutter_model_iter_is_last ()">clutter_model_iter_is_last</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);
65 <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="returnvalue">ClutterModelIter</span></a> * <a class="link" href="ClutterModelIter.html#clutter-model-iter-next" title="clutter_model_iter_next ()">clutter_model_iter_next</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);
66 <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="returnvalue">ClutterModelIter</span></a> * <a class="link" href="ClutterModelIter.html#clutter-model-iter-prev" title="clutter_model_iter_prev ()">clutter_model_iter_prev</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);
68 <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="returnvalue">ClutterModel</span></a> * <a class="link" href="ClutterModelIter.html#clutter-model-iter-get-model" title="clutter_model_iter_get_model ()">clutter_model_iter_get_model</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);
69 <span class="returnvalue">guint</span> <a class="link" href="ClutterModelIter.html#clutter-model-iter-get-row" title="clutter_model_iter_get_row ()">clutter_model_iter_get_row</a> (<em class="parameter"><code><a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> *iter</code></em>);
72 <div class="refsect1">
73 <a name="ClutterModelIter.object-hierarchy"></a><h2>Object Hierarchy</h2>
74 <pre class="synopsis">
79 <div class="refsect1">
80 <a name="ClutterModelIter.properties"></a><h2>Properties</h2>
81 <pre class="synopsis">
82 "<a class="link" href="ClutterModelIter.html#ClutterModelIter--model" title='The "model" property'>model</a>" <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a>* : Read / Write
83 "<a class="link" href="ClutterModelIter.html#ClutterModelIter--row" title='The "row" property'>row</a>" <span class="type">guint</span> : Read / Write
86 <div class="refsect1">
87 <a name="ClutterModelIter.description"></a><h2>Description</h2>
89 <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> is an object used for iterating through all the rows
90 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
91 which is currently pointing at.
94 A <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> represents a position between two elements
95 of the sequence. For example, the iterator returned by
96 <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
97 the first row of the <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a>, and the iterator returned by
98 <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
102 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
103 and it is valid as long as the model does not change.
106 <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> is available since Clutter 0.6
109 <div class="refsect1">
110 <a name="ClutterModelIter.details"></a><h2>Details</h2>
111 <div class="refsect2">
112 <a name="ClutterModelIter-struct"></a><h3>struct ClutterModelIter</h3>
113 <pre class="programlisting">struct ClutterModelIter;</pre>
115 Base class for list models iters. The <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> structure
116 contains only private data and should be manipulated using the
119 <p class="since">Since 0.6</p>
122 <div class="refsect2">
123 <a name="ClutterModelIterClass"></a><h3>struct ClutterModelIterClass</h3>
124 <pre class="programlisting">struct ClutterModelIterClass {
125 /* vtable not signals */
126 void (* get_value) (ClutterModelIter *iter,
129 void (* set_value) (ClutterModelIter *iter,
131 const GValue *value);
133 gboolean (* is_first) (ClutterModelIter *iter);
134 gboolean (* is_last) (ClutterModelIter *iter);
136 ClutterModelIter *(* next) (ClutterModelIter *iter);
137 ClutterModelIter *(* prev) (ClutterModelIter *iter);
139 ClutterModel * (* get_model) (ClutterModelIter *iter);
140 guint (* get_row) (ClutterModelIter *iter);
142 ClutterModelIter *(* copy) (ClutterModelIter *iter);
146 Class for <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> instances.
148 <div class="variablelist"><table border="0">
149 <col align="left" valign="top">
152 <td><p><span class="term"><em class="structfield"><code><a name="ClutterModelIterClass.get-value"></a>get_value</code></em> ()</span></p></td>
153 <td>Virtual function for retrieving the value at the given
154 column of the row pointed by the iterator</td>
157 <td><p><span class="term"><em class="structfield"><code><a name="ClutterModelIterClass.set-value"></a>set_value</code></em> ()</span></p></td>
158 <td>Virtual function for setting the value at the given
159 column of the row pointer by the iterator</td>
162 <td><p><span class="term"><em class="structfield"><code><a name="ClutterModelIterClass.is-first"></a>is_first</code></em> ()</span></p></td>
163 <td>Virtual function for knowing whether the iterator points
164 at the first row in the model</td>
167 <td><p><span class="term"><em class="structfield"><code><a name="ClutterModelIterClass.is-last"></a>is_last</code></em> ()</span></p></td>
168 <td>Virtual function for knowing whether the iterator points
169 at the last row in the model</td>
172 <td><p><span class="term"><em class="structfield"><code><a name="ClutterModelIterClass.next"></a>next</code></em> ()</span></p></td>
173 <td>Virtual function for moving the iterator to the following
174 row in the model</td>
177 <td><p><span class="term"><em class="structfield"><code><a name="ClutterModelIterClass.prev"></a>prev</code></em> ()</span></p></td>
178 <td>Virtual function for moving the iterator toe the previous
179 row in the model</td>
182 <td><p><span class="term"><em class="structfield"><code><a name="ClutterModelIterClass.get-model"></a>get_model</code></em> ()</span></p></td>
183 <td>Virtual function for getting the model to which the
184 iterator belongs to</td>
187 <td><p><span class="term"><em class="structfield"><code><a name="ClutterModelIterClass.get-row"></a>get_row</code></em> ()</span></p></td>
188 <td>Virtual function for getting the row to which the iterator
192 <td><p><span class="term"><em class="structfield"><code><a name="ClutterModelIterClass.copy"></a>copy</code></em> ()</span></p></td>
193 <td>Virtual function for copying a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>.</td>
197 <p class="since">Since 0.6</p>
200 <div class="refsect2">
201 <a name="clutter-model-iter-copy"></a><h3>clutter_model_iter_copy ()</h3>
202 <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>
204 Copies the passed iterator.
206 <div class="variablelist"><table border="0">
207 <col align="left" valign="top">
210 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
211 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
215 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
216 <td>a copy of the iterator, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
221 <p class="since">Since 0.8</p>
224 <div class="refsect2">
225 <a name="clutter-model-iter-get"></a><h3>clutter_model_iter_get ()</h3>
226 <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>,
227 <em class="parameter"><code>...</code></em>);</pre>
229 Gets the value of one or more cells in the row referenced by <em class="parameter"><code>iter</code></em>. The
230 variable argument list should contain integer column numbers, each column
231 column number followed by a place to store the value being retrieved. The
232 list is terminated by a -1.
235 For example, to get a value from column 0 with type <code class="literal">G_TYPE_STRING</code> use:
237 <div class="informalexample">
238 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
241 <td class="listing_lines" align="right"><pre>1</pre></td>
242 <td class="listing_code"><pre class="programlisting"><span class="function"><a href="ClutterModelIter.html#clutter-model-iter-get">clutter_model_iter_get</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">iter</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">place_string_here</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">-</span><span class="number">1</span><span class="symbol">);</span></pre></td>
251 where place_string_here is a gchar* to be filled with the string. If
252 appropriate, the returned values have to be freed or unreferenced.
254 <div class="variablelist"><table border="0">
255 <col align="left" valign="top">
258 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
259 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
263 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
264 <td>a list of column/return location pairs, terminated by -1</td>
268 <p class="since">Since 0.6</p>
271 <div class="refsect2">
272 <a name="clutter-model-iter-get-valist"></a><h3>clutter_model_iter_get_valist ()</h3>
273 <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>,
274 <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
276 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
279 <div class="variablelist"><table border="0">
280 <col align="left" valign="top">
283 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
284 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
288 <td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
289 <td>a list of column/return location pairs, terminated by -1</td>
293 <p class="since">Since 0.6</p>
296 <div class="refsect2">
297 <a name="clutter-model-iter-get-value"></a><h3>clutter_model_iter_get_value ()</h3>
298 <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>,
299 <em class="parameter"><code><span class="type">guint</span> column</code></em>,
300 <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
302 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>,
303 <code class="function">g_value_unset()</code> needs to be called to free any allocated memory.
305 <div class="variablelist"><table border="0">
306 <col align="left" valign="top">
309 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
310 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
314 <td><p><span class="term"><em class="parameter"><code>column</code></em> :</span></p></td>
315 <td>column number to retrieve the value from</td>
318 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
319 <td>an empty <span class="type">GValue</span> to set. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
324 <p class="since">Since 0.6</p>
327 <div class="refsect2">
328 <a name="clutter-model-iter-set"></a><h3>clutter_model_iter_set ()</h3>
329 <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>,
330 <em class="parameter"><code>...</code></em>);</pre>
332 Sets the value of one or more cells in the row referenced by <em class="parameter"><code>iter</code></em>. The
333 variable argument list should contain integer column numbers, each column
334 column number followed by the value to be set. The list is terminated by a
338 For example, to set column 0 with type <code class="literal">G_TYPE_STRING</code>, use:
340 <div class="informalexample">
341 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
344 <td class="listing_lines" align="right"><pre>1</pre></td>
345 <td class="listing_code"><pre class="programlisting"><span class="function"><a href="ClutterModelIter.html#clutter-model-iter-set">clutter_model_iter_set</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">iter</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"foo"</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">-</span><span class="number">1</span><span class="symbol">);</span></pre></td>
353 <div class="variablelist"><table border="0">
354 <col align="left" valign="top">
357 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
358 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
362 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
363 <td>a list of column/return location pairs, terminated by -1</td>
367 <p class="since">Since 0.6</p>
370 <div class="refsect2">
371 <a name="clutter-model-iter-set-valist"></a><h3>clutter_model_iter_set_valist ()</h3>
372 <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>,
373 <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
375 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
378 <div class="variablelist"><table border="0">
379 <col align="left" valign="top">
382 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
383 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
387 <td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
388 <td>va_list of column/value pairs, terminiated by -1</td>
392 <p class="since">Since 0.6</p>
395 <div class="refsect2">
396 <a name="clutter-model-iter-set-value"></a><h3>clutter_model_iter_set_value ()</h3>
397 <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>,
398 <em class="parameter"><code><span class="type">guint</span> column</code></em>,
399 <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
401 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
402 <em class="parameter"><code>value</code></em> must be convertable to the type of the column.
404 <div class="variablelist"><table border="0">
405 <col align="left" valign="top">
408 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
409 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
413 <td><p><span class="term"><em class="parameter"><code>column</code></em> :</span></p></td>
414 <td>column number to retrieve the value from</td>
417 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
418 <td>new value for the cell</td>
422 <p class="since">Since 0.6</p>
425 <div class="refsect2">
426 <a name="clutter-model-iter-is-first"></a><h3>clutter_model_iter_is_first ()</h3>
427 <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>
429 Gets whether the current iterator is at the beginning of the model
432 <div class="variablelist"><table border="0">
433 <col align="left" valign="top">
436 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
437 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
441 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
443 <span class="type">TRUE</span> if <em class="parameter"><code>iter</code></em> is the first iter in the filtered model</td>
447 <p class="since">Since 0.6</p>
450 <div class="refsect2">
451 <a name="clutter-model-iter-is-last"></a><h3>clutter_model_iter_is_last ()</h3>
452 <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>
454 Gets whether the iterator is at the end of the model to which it
457 <div class="variablelist"><table border="0">
458 <col align="left" valign="top">
461 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
462 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
466 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
468 <span class="type">TRUE</span> if <em class="parameter"><code>iter</code></em> is the last iter in the filtered model.</td>
472 <p class="since">Since 0.6</p>
475 <div class="refsect2">
476 <a name="clutter-model-iter-next"></a><h3>clutter_model_iter_next ()</h3>
477 <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>
479 Updates the <em class="parameter"><code>iter</code></em> to point at the next position in the model.
480 The model implementation should take into account the presence of
483 <div class="variablelist"><table border="0">
484 <col align="left" valign="top">
487 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
488 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
492 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
493 <td>The passed iterator, updated to point at the next
494 row in the model. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
499 <p class="since">Since 0.6</p>
502 <div class="refsect2">
503 <a name="clutter-model-iter-prev"></a><h3>clutter_model_iter_prev ()</h3>
504 <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>
506 Sets the <em class="parameter"><code>iter</code></em> to point at the previous position in the model.
507 The model implementation should take into account the presence of
510 <div class="variablelist"><table border="0">
511 <col align="left" valign="top">
514 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
515 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
519 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
520 <td>The passed iterator, updated to point at the previous
521 row in the model. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
526 <p class="since">Since 0.6</p>
529 <div class="refsect2">
530 <a name="clutter-model-iter-get-model"></a><h3>clutter_model_iter_get_model ()</h3>
531 <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>
533 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.
535 <div class="variablelist"><table border="0">
536 <col align="left" valign="top">
539 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
540 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
544 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
545 <td>a pointer to a <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
550 <p class="since">Since 0.6</p>
553 <div class="refsect2">
554 <a name="clutter-model-iter-get-row"></a><h3>clutter_model_iter_get_row ()</h3>
555 <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>
557 Retrieves the position of the row that the <em class="parameter"><code>iter</code></em> points to.
559 <div class="variablelist"><table border="0">
560 <col align="left" valign="top">
563 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
564 <td>a <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a>
568 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
569 <td>the position of the <em class="parameter"><code>iter</code></em> in the model</td>
573 <p class="since">Since 0.6</p>
576 <div class="refsect1">
577 <a name="ClutterModelIter.property-details"></a><h2>Property Details</h2>
578 <div class="refsect2">
579 <a name="ClutterModelIter--model"></a><h3>The <code class="literal">"model"</code> property</h3>
580 <pre class="programlisting"> "model" <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a>* : Read / Write</pre>
582 A reference to the <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a> that this iter belongs to.
584 <p class="since">Since 0.6</p>
587 <div class="refsect2">
588 <a name="ClutterModelIter--row"></a><h3>The <code class="literal">"row"</code> property</h3>
589 <pre class="programlisting"> "row" <span class="type">guint</span> : Read / Write</pre>
591 The row number to which this iter points to.
593 <p>Default value: 0</p>
594 <p class="since">Since 0.6</p>
600 Generated by GTK-Doc V1.18.1</div>