doc/reference/clutter/html/ClutterModelIter.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   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">
  13 </head>
  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">
  16 <tr valign="middle">
  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>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#ClutterModelIter.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterModelIter.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterModelIter.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterModelIter.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="ClutterModelIter"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="ClutterModelIter.top_of_page"></a>ClutterModelIter</span></h2>
  38 <p>ClutterModelIter — Iterates through a model</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  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>);
  47
  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><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> column</code></em>,
  54                                                          <em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *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><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> column</code></em>,
  61                                                          <em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
  62
  63 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>);
  67
  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 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <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>);
  70 </pre>
  71 </div>
  72 <div class="refsect1">
  73 <a name="ClutterModelIter.object-hierarchy"></a><h2>Object Hierarchy</h2>
  74 <pre class="synopsis">
  75   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  76    +----ClutterModelIter
  77 </pre>
  78 </div>
  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>"                      <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  84 </pre>
  85 </div>
  86 <div class="refsect1">
  87 <a name="ClutterModelIter.description"></a><h2>Description</h2>
  88 <p>
  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.
  92 </p>
  93 <p>
  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
  99 last row.
 100 </p>
 101 <p>
 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.
 104 </p>
 105 <p>
 106 <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> is available since Clutter 0.6
 107 </p>
 108 </div>
 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>
 114 <p>
 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
 117 provided API.
 118 </p>
 119 <p class="since">Since 0.6</p>
 120 </div>
 121 <hr>
 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,
 127                                    guint             column,
 128                                    GValue           *value);
 129   void              (* set_value) (ClutterModelIter *iter,
 130                                    guint             column,
 131                                    const GValue     *value);
 132
 133   gboolean          (* is_first)  (ClutterModelIter *iter);
 134   gboolean          (* is_last)   (ClutterModelIter *iter);
 135
 136   ClutterModelIter *(* next)      (ClutterModelIter *iter);
 137   ClutterModelIter *(* prev)      (ClutterModelIter *iter);
 138
 139   ClutterModel *    (* get_model) (ClutterModelIter *iter);
 140   guint             (* get_row)   (ClutterModelIter *iter);
 141
 142   ClutterModelIter *(* copy)      (ClutterModelIter *iter);
 143 };
 144 </pre>
 145 <p>
 146 Class for <a class="link" href="ClutterModelIter.html" title="ClutterModelIter"><span class="type">ClutterModelIter</span></a> instances.
 147 </p>
 148 <div class="variablelist"><table border="0">
 149 <col align="left" valign="top">
 150 <tbody>
 151 <tr>
 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>
 155 </tr>
 156 <tr>
 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>
 160 </tr>
 161 <tr>
 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>
 165 </tr>
 166 <tr>
 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>
 170 </tr>
 171 <tr>
 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>
 175 </tr>
 176 <tr>
 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>
 180 </tr>
 181 <tr>
 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>
 185 </tr>
 186 <tr>
 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
 189 points</td>
 190 </tr>
 191 <tr>
 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>
 194 </tr>
 195 </tbody>
 196 </table></div>
 197 <p class="since">Since 0.6</p>
 198 </div>
 199 <hr>
 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>
 203 <p>
 204 Copies the passed iterator.
 205 </p>
 206 <div class="variablelist"><table border="0">
 207 <col align="left" valign="top">
 208 <tbody>
 209 <tr>
 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>
 212 </td>
 213 </tr>
 214 <tr>
 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>
 217 </td>
 218 </tr>
 219 </tbody>
 220 </table></div>
 221 <p class="since">Since 0.8</p>
 222 </div>
 223 <hr>
 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>
 228 <p>
 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.
 233 </p>
 234 <p>
 235 For example, to get a value from column 0 with type <a href="../gobject/gobject-Type-Information.html#G-TYPE-STRING:CAPS"><code class="literal">G_TYPE_STRING</code></a> use:
 236 </p>
 237 <div class="informalexample">
 238   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 239     <tbody>
 240       <tr>
 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">&amp;</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>
 243       </tr>
 244     </tbody>
 245   </table>
 246 </div>
 247
 248 <p>
 249 </p>
 250 <p>
 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.
 253 </p>
 254 <div class="variablelist"><table border="0">
 255 <col align="left" valign="top">
 256 <tbody>
 257 <tr>
 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>
 260 </td>
 261 </tr>
 262 <tr>
 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>
 265 </tr>
 266 </tbody>
 267 </table></div>
 268 <p class="since">Since 0.6</p>
 269 </div>
 270 <hr>
 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>
 275 <p>
 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
 277 bindings.
 278 </p>
 279 <div class="variablelist"><table border="0">
 280 <col align="left" valign="top">
 281 <tbody>
 282 <tr>
 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>
 285 </td>
 286 </tr>
 287 <tr>
 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>
 290 </tr>
 291 </tbody>
 292 </table></div>
 293 <p class="since">Since 0.6</p>
 294 </div>
 295 <hr>
 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><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> column</code></em>,
 300                                                          <em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
 301 <p>
 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 <a href="../gobject/gobject-Generic-values.html#g-value-unset"><code class="function">g_value_unset()</code></a> needs to be called to free any allocated memory.
 304 </p>
 305 <div class="variablelist"><table border="0">
 306 <col align="left" valign="top">
 307 <tbody>
 308 <tr>
 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>
 311 </td>
 312 </tr>
 313 <tr>
 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>
 316 </tr>
 317 <tr>
 318 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 319 <td>an empty <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> to set. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 320 </td>
 321 </tr>
 322 </tbody>
 323 </table></div>
 324 <p class="since">Since 0.6</p>
 325 </div>
 326 <hr>
 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>
 331 <p>
 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
 335 -1.
 336 </p>
 337 <p>
 338 For example, to set column 0 with type <a href="../gobject/gobject-Type-Information.html#G-TYPE-STRING:CAPS"><code class="literal">G_TYPE_STRING</code></a>, use:
 339 </p>
 340 <div class="informalexample">
 341   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 342     <tbody>
 343       <tr>
 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>
 346       </tr>
 347     </tbody>
 348   </table>
 349 </div>
 350
 351 <p>
 352 </p>
 353 <div class="variablelist"><table border="0">
 354 <col align="left" valign="top">
 355 <tbody>
 356 <tr>
 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>
 359 </td>
 360 </tr>
 361 <tr>
 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>
 364 </tr>
 365 </tbody>
 366 </table></div>
 367 <p class="since">Since 0.6</p>
 368 </div>
 369 <hr>
 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>
 374 <p>
 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
 376 bindings.
 377 </p>
 378 <div class="variablelist"><table border="0">
 379 <col align="left" valign="top">
 380 <tbody>
 381 <tr>
 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>
 384 </td>
 385 </tr>
 386 <tr>
 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>
 389 </tr>
 390 </tbody>
 391 </table></div>
 392 <p class="since">Since 0.6</p>
 393 </div>
 394 <hr>
 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><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> column</code></em>,
 399                                                          <em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
 400 <p>
 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.
 403 </p>
 404 <div class="variablelist"><table border="0">
 405 <col align="left" valign="top">
 406 <tbody>
 407 <tr>
 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>
 410 </td>
 411 </tr>
 412 <tr>
 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>
 415 </tr>
 416 <tr>
 417 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 418 <td>new value for the cell</td>
 419 </tr>
 420 </tbody>
 421 </table></div>
 422 <p class="since">Since 0.6</p>
 423 </div>
 424 <hr>
 425 <div class="refsect2">
 426 <a name="clutter-model-iter-is-first"></a><h3>clutter_model_iter_is_first ()</h3>
 427 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>
 428 <p>
 429 Gets whether the current iterator is at the beginning of the model
 430 to which it belongs.
 431 </p>
 432 <div class="variablelist"><table border="0">
 433 <col align="left" valign="top">
 434 <tbody>
 435 <tr>
 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>
 438 </td>
 439 </tr>
 440 <tr>
 441 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 442 <td>
 443 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if <em class="parameter"><code>iter</code></em> is the first iter in the filtered model</td>
 444 </tr>
 445 </tbody>
 446 </table></div>
 447 <p class="since">Since 0.6</p>
 448 </div>
 449 <hr>
 450 <div class="refsect2">
 451 <a name="clutter-model-iter-is-last"></a><h3>clutter_model_iter_is_last ()</h3>
 452 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>
 453 <p>
 454 Gets whether the iterator is at the end of the model to which it
 455 belongs.
 456 </p>
 457 <div class="variablelist"><table border="0">
 458 <col align="left" valign="top">
 459 <tbody>
 460 <tr>
 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>
 463 </td>
 464 </tr>
 465 <tr>
 466 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 467 <td>
 468 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if <em class="parameter"><code>iter</code></em> is the last iter in the filtered model.</td>
 469 </tr>
 470 </tbody>
 471 </table></div>
 472 <p class="since">Since 0.6</p>
 473 </div>
 474 <hr>
 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>
 478 <p>
 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
 481 a filter function.
 482 </p>
 483 <div class="variablelist"><table border="0">
 484 <col align="left" valign="top">
 485 <tbody>
 486 <tr>
 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>
 489 </td>
 490 </tr>
 491 <tr>
 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>
 495 </td>
 496 </tr>
 497 </tbody>
 498 </table></div>
 499 <p class="since">Since 0.6</p>
 500 </div>
 501 <hr>
 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>
 505 <p>
 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
 508 a filter function.
 509 </p>
 510 <div class="variablelist"><table border="0">
 511 <col align="left" valign="top">
 512 <tbody>
 513 <tr>
 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>
 516 </td>
 517 </tr>
 518 <tr>
 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>
 522 </td>
 523 </tr>
 524 </tbody>
 525 </table></div>
 526 <p class="since">Since 0.6</p>
 527 </div>
 528 <hr>
 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>
 532 <p>
 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.
 534 </p>
 535 <div class="variablelist"><table border="0">
 536 <col align="left" valign="top">
 537 <tbody>
 538 <tr>
 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>
 541 </td>
 542 </tr>
 543 <tr>
 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>
 546 </td>
 547 </tr>
 548 </tbody>
 549 </table></div>
 550 <p class="since">Since 0.6</p>
 551 </div>
 552 <hr>
 553 <div class="refsect2">
 554 <a name="clutter-model-iter-get-row"></a><h3>clutter_model_iter_get_row ()</h3>
 555 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               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>
 556 <p>
 557 Retrieves the position of the row that the <em class="parameter"><code>iter</code></em> points to.
 558 </p>
 559 <div class="variablelist"><table border="0">
 560 <col align="left" valign="top">
 561 <tbody>
 562 <tr>
 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>
 565 </td>
 566 </tr>
 567 <tr>
 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>
 570 </tr>
 571 </tbody>
 572 </table></div>
 573 <p class="since">Since 0.6</p>
 574 </div>
 575 </div>
 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>
 581 <p>
 582 A reference to the <a class="link" href="ClutterModel.html" title="ClutterModel"><span class="type">ClutterModel</span></a> that this iter belongs to.
 583 </p>
 584 <p class="since">Since 0.6</p>
 585 </div>
 586 <hr>
 587 <div class="refsect2">
 588 <a name="ClutterModelIter--row"></a><h3>The <code class="literal">"row"</code> property</h3>
 589 <pre class="programlisting">  "row"                      <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 590 <p>
 591 The row number to which this iter points to.
 592 </p>
 593 <p>Default value: 0</p>
 594 <p class="since">Since 0.6</p>
 595 </div>
 596 </div>
 597 </div>
 598 <div class="footer">
 599 <hr>
 600           Generated by GTK-Doc V1.18.1</div>
 601 </body>
 602 </html>