← Back to branch summary

~oem-solutions-group/unity-2d/clutter-1.0

« back to all changes in this revision

Viewing changes to doc/reference/clutter/xml/clutter-model-iter.xml

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2010-03-21 13:27:56 UTC
  • mto: (2.1.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20100321132756-nf8yd30yxo3zzwcm
Tags: upstream-1.2.2
Import upstream version 1.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/clutter/xml/clutter-model-iter.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY version "1.0.8">
5
 
]>
6
 
 
7
 
<refentry id="ClutterModelIter">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="ClutterModelIter.top_of_page">ClutterModelIter</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>CLUTTER Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>ClutterModelIter</refname>
16
 
<refpurpose>Iterates through a model</refpurpose>
17
 
</refnamediv>
18
 
 
19
 
<refsynopsisdiv id="ClutterModelIter.synopsis" role="synopsis">
20
 
<title role="synopsis.title">Synopsis</title>
21
 
 
22
 
<synopsis>
23
 
                    <link linkend="ClutterModelIter-struct">ClutterModelIter</link>;
24
 
                    <link linkend="ClutterModelIterClass">ClutterModelIterClass</link>;
25
 
<link linkend="ClutterModelIter">ClutterModelIter</link> *  <link linkend="clutter-model-iter-copy">clutter_model_iter_copy</link>             (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);
26
 
 
27
 
<link linkend="void">void</link>                <link linkend="clutter-model-iter-get">clutter_model_iter_get</link>              (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
28
 
                                                         ...);
29
 
<link linkend="void">void</link>                <link linkend="clutter-model-iter-get-valist">clutter_model_iter_get_valist</link>       (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
30
 
                                                         <link linkend="va-list">va_list</link> args);
31
 
<link linkend="void">void</link>                <link linkend="clutter-model-iter-get-value">clutter_model_iter_get_value</link>        (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
32
 
                                                         <link linkend="guint">guint</link> column,
33
 
                                                         <link linkend="GValue">GValue</link> *value);
34
 
<link linkend="void">void</link>                <link linkend="clutter-model-iter-set">clutter_model_iter_set</link>              (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
35
 
                                                         ...);
36
 
<link linkend="void">void</link>                <link linkend="clutter-model-iter-set-valist">clutter_model_iter_set_valist</link>       (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
37
 
                                                         <link linkend="va-list">va_list</link> args);
38
 
<link linkend="void">void</link>                <link linkend="clutter-model-iter-set-value">clutter_model_iter_set_value</link>        (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
39
 
                                                         <link linkend="guint">guint</link> column,
40
 
                                                         const <link linkend="GValue">GValue</link> *value);
41
 
 
42
 
<link linkend="gboolean">gboolean</link>            <link linkend="clutter-model-iter-is-first">clutter_model_iter_is_first</link>         (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);
43
 
<link linkend="gboolean">gboolean</link>            <link linkend="clutter-model-iter-is-last">clutter_model_iter_is_last</link>          (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);
44
 
<link linkend="ClutterModelIter">ClutterModelIter</link> *  <link linkend="clutter-model-iter-next">clutter_model_iter_next</link>             (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);
45
 
<link linkend="ClutterModelIter">ClutterModelIter</link> *  <link linkend="clutter-model-iter-prev">clutter_model_iter_prev</link>             (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);
46
 
 
47
 
<link linkend="ClutterModel">ClutterModel</link> *      <link linkend="clutter-model-iter-get-model">clutter_model_iter_get_model</link>        (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);
48
 
<link linkend="guint">guint</link>               <link linkend="clutter-model-iter-get-row">clutter_model_iter_get_row</link>          (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);
49
 
</synopsis>
50
 
</refsynopsisdiv>
51
 
 
52
 
<refsect1 id="ClutterModelIter.object-hierarchy" role="object_hierarchy">
53
 
<title role="object_hierarchy.title">Object Hierarchy</title>
54
 
<synopsis>
55
 
  <link linkend="GObject">GObject</link>
56
 
   +----ClutterModelIter
57
 
</synopsis>
58
 
</refsect1>
59
 
 
60
 
 
61
 
 
62
 
 
63
 
 
64
 
<refsect1 id="ClutterModelIter.properties" role="properties">
65
 
<title role="properties.title">Properties</title>
66
 
<synopsis>
67
 
  &quot;<link linkend="ClutterModelIter--model">model</link>&quot;                    <link linkend="ClutterModel">ClutterModel</link>*         : Read / Write
68
 
  &quot;<link linkend="ClutterModelIter--row">row</link>&quot;                      <link linkend="guint">guint</link>                 : Read / Write
69
 
</synopsis>
70
 
</refsect1>
71
 
 
72
 
 
73
 
 
74
 
<refsect1 id="ClutterModelIter.description" role="desc">
75
 
<title role="desc.title">Description</title>
76
 
<para>
77
 
<link linkend="ClutterModelIter"><type>ClutterModelIter</type></link> is an object used for iterating through all the rows
78
 
of a <link linkend="ClutterModel"><type>ClutterModel</type></link>. It allows setting and getting values on the row
79
 
which is currently pointing at.
80
 
</para>
81
 
<para>
82
 
A <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link> represents a position between two elements
83
 
of the sequence. For example, the iterator returned by
84
 
<link linkend="clutter-model-get-first-iter"><function>clutter_model_get_first_iter()</function></link> represents the gap immediately before
85
 
the first row of the <link linkend="ClutterModel"><type>ClutterModel</type></link>, and the iterator returned by
86
 
<link linkend="clutter-model-get-last-iter"><function>clutter_model_get_last_iter()</function></link> represents the gap immediately after the
87
 
last row.
88
 
</para>
89
 
<para>
90
 
A <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link> can only be created by a <link linkend="ClutterModel"><type>ClutterModel</type></link> implementation
91
 
and it is valid as long as the model does not change.
92
 
</para>
93
 
<para>
94
 
<link linkend="ClutterModelIter"><type>ClutterModelIter</type></link> is available since Clutter 0.6</para>
95
 
<para>
96
 
</para>
97
 
</refsect1>
98
 
 
99
 
<refsect1 id="ClutterModelIter.details" role="details">
100
 
<title role="details.title">Details</title>
101
 
<refsect2 id="ClutterModelIter-struct" role="struct">
102
 
<title>ClutterModelIter</title>
103
 
<indexterm zone="ClutterModelIter-struct" role="0.6"><primary sortas="ModelIter">ClutterModelIter</primary></indexterm><programlisting>typedef struct _ClutterModelIter ClutterModelIter;</programlisting>
104
 
<para>
105
 
Base class for list models iters. The <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link> structure
106
 
contains only private data and should be manipulated using the
107
 
provided API.</para>
108
 
<para>
109
 
</para><para role="since">Since 0.6</para></refsect2>
110
 
<refsect2 id="ClutterModelIterClass" role="struct" condition="since:0.6">
111
 
<title>ClutterModelIterClass</title>
112
 
<indexterm zone="ClutterModelIterClass" role="0.6"><primary sortas="ModelIterClass">ClutterModelIterClass</primary></indexterm><programlisting>typedef struct {
113
 
  /* vtable not signals */
114
 
  void              (* get_value) (ClutterModelIter *iter, 
115
 
                                   guint             column, 
116
 
                                   GValue           *value);
117
 
  void              (* set_value) (ClutterModelIter *iter, 
118
 
                                   guint             column, 
119
 
                                   const GValue     *value);
120
 
 
121
 
  gboolean          (* is_first)  (ClutterModelIter *iter);
122
 
  gboolean          (* is_last)   (ClutterModelIter *iter);
123
 
 
124
 
  ClutterModelIter *(* next)      (ClutterModelIter *iter);
125
 
  ClutterModelIter *(* prev)      (ClutterModelIter *iter);
126
 
 
127
 
  ClutterModel *    (* get_model) (ClutterModelIter *iter);
128
 
  guint             (* get_row)   (ClutterModelIter *iter);
129
 
 
130
 
  ClutterModelIter *(* copy)      (ClutterModelIter *iter);
131
 
} ClutterModelIterClass;
132
 
</programlisting>
133
 
<para>
134
 
Class for <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link> instances.</para>
135
 
<para>
136
 
</para><variablelist role="struct">
137
 
<varlistentry>
138
 
<term><structfield>get_value</structfield>&#160;()</term>
139
 
<listitem><simpara> Virtual function for retrieving the value at the given
140
 
  column of the row pointed by the iterator
141
 
</simpara></listitem>
142
 
</varlistentry>
143
 
<varlistentry>
144
 
<term><structfield>set_value</structfield>&#160;()</term>
145
 
<listitem><simpara> Virtual function for setting the value at the given
146
 
  column of the row pointer by the iterator
147
 
</simpara></listitem>
148
 
</varlistentry>
149
 
<varlistentry>
150
 
<term><structfield>is_first</structfield>&#160;()</term>
151
 
<listitem><simpara> Virtual function for knowing whether the iterator points
152
 
  at the first row in the model
153
 
</simpara></listitem>
154
 
</varlistentry>
155
 
<varlistentry>
156
 
<term><structfield>is_last</structfield>&#160;()</term>
157
 
<listitem><simpara> Virtual function for knowing whether the iterator points
158
 
  at the last row in the model
159
 
</simpara></listitem>
160
 
</varlistentry>
161
 
<varlistentry>
162
 
<term><structfield>next</structfield>&#160;()</term>
163
 
<listitem><simpara> Virtual function for moving the iterator to the following
164
 
  row in the model
165
 
</simpara></listitem>
166
 
</varlistentry>
167
 
<varlistentry>
168
 
<term><structfield>prev</structfield>&#160;()</term>
169
 
<listitem><simpara> Virtual function for moving the iterator toe the previous
170
 
  row in the model
171
 
</simpara></listitem>
172
 
</varlistentry>
173
 
<varlistentry>
174
 
<term><structfield>get_model</structfield>&#160;()</term>
175
 
<listitem><simpara> Virtual function for getting the model to which the
176
 
  iterator belongs to
177
 
</simpara></listitem>
178
 
</varlistentry>
179
 
<varlistentry>
180
 
<term><structfield>get_row</structfield>&#160;()</term>
181
 
<listitem><simpara> Virtual function for getting the row to which the iterator
182
 
  points
183
 
</simpara></listitem>
184
 
</varlistentry>
185
 
<varlistentry>
186
 
<term><structfield>copy</structfield>&#160;()</term>
187
 
<listitem><simpara> Virtual function for copying a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>.
188
 
</simpara></listitem>
189
 
</varlistentry>
190
 
</variablelist><para role="since">Since 0.6</para></refsect2>
191
 
<refsect2 id="clutter-model-iter-copy" role="function" condition="since:0.8">
192
 
<title>clutter_model_iter_copy ()</title>
193
 
<indexterm zone="clutter-model-iter-copy" role="0.8"><primary sortas="model_iter_copy">clutter_model_iter_copy</primary></indexterm><programlisting><link linkend="ClutterModelIter">ClutterModelIter</link> *  clutter_model_iter_copy             (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);</programlisting>
194
 
<para>
195
 
Copies the passed iterator.</para>
196
 
<para>
197
 
</para><variablelist role="params">
198
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
199
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
200
 
</simpara></listitem></varlistentry>
201
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a copy of the iterator, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
202
 
 
203
 
</simpara></listitem></varlistentry>
204
 
</variablelist><para role="since">Since 0.8</para></refsect2>
205
 
<refsect2 id="clutter-model-iter-get" role="function" condition="since:0.6">
206
 
<title>clutter_model_iter_get ()</title>
207
 
<indexterm zone="clutter-model-iter-get" role="0.6"><primary sortas="model_iter_get">clutter_model_iter_get</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_model_iter_get              (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
208
 
                                                         ...);</programlisting>
209
 
<para>
210
 
Gets the value of one or more cells in the row referenced by <parameter>iter</parameter>. The
211
 
variable argument list should contain integer column numbers, each column
212
 
column number followed by a place to store the value being retrieved. The
213
 
list is terminated by a -1.
214
 
</para>
215
 
<para>
216
 
For example, to get a value from column 0 with type <link linkend="G-TYPE-STRING--CAPS"><literal>G_TYPE_STRING</literal></link> use:
217
 
<informalexample><programlisting>
218
 
  clutter_model_iter_get (iter, 0, &amp;place_string_here, -1);
219
 
</programlisting></informalexample>
220
 
</para>
221
 
<para>
222
 
where place_string_here is a gchar* to be filled with the string. If
223
 
appropriate, the returned values have to be freed or unreferenced.</para>
224
 
<para>
225
 
</para><variablelist role="params">
226
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
227
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
228
 
</simpara></listitem></varlistentry>
229
 
<varlistentry><term><parameter>...</parameter>&#160;:</term>
230
 
<listitem><simpara> a list of column/return location pairs, terminated by -1
231
 
</simpara></listitem></varlistentry>
232
 
</variablelist><para role="since">Since 0.6</para></refsect2>
233
 
<refsect2 id="clutter-model-iter-get-valist" role="function" condition="since:0.6">
234
 
<title>clutter_model_iter_get_valist ()</title>
235
 
<indexterm zone="clutter-model-iter-get-valist" role="0.6"><primary sortas="model_iter_get_valist">clutter_model_iter_get_valist</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_model_iter_get_valist       (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
236
 
                                                         <link linkend="va-list">va_list</link> args);</programlisting>
237
 
<para>
238
 
See <link linkend="clutter-model-iter-get"><function>clutter_model_iter_get()</function></link>. This version takes a va_list for language
239
 
bindings.</para>
240
 
<para>
241
 
</para><variablelist role="params">
242
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
243
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
244
 
</simpara></listitem></varlistentry>
245
 
<varlistentry><term><parameter>args</parameter>&#160;:</term>
246
 
<listitem><simpara> a list of column/return location pairs, terminated by -1
247
 
</simpara></listitem></varlistentry>
248
 
</variablelist><para role="since">Since 0.6</para></refsect2>
249
 
<refsect2 id="clutter-model-iter-get-value" role="function" condition="since:0.6">
250
 
<title>clutter_model_iter_get_value ()</title>
251
 
<indexterm zone="clutter-model-iter-get-value" role="0.6"><primary sortas="model_iter_get_value">clutter_model_iter_get_value</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_model_iter_get_value        (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
252
 
                                                         <link linkend="guint">guint</link> column,
253
 
                                                         <link linkend="GValue">GValue</link> *value);</programlisting>
254
 
<para>
255
 
Sets an initializes <parameter>value</parameter> to that at <parameter>column</parameter>. When done with <parameter>value</parameter>, 
256
 
<link linkend="g-value-unset"><function>g_value_unset()</function></link> needs to be called to free any allocated memory.</para>
257
 
<para>
258
 
</para><variablelist role="params">
259
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
260
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
261
 
</simpara></listitem></varlistentry>
262
 
<varlistentry><term><parameter>column</parameter>&#160;:</term>
263
 
<listitem><simpara> column number to retrieve the value from
264
 
</simpara></listitem></varlistentry>
265
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
266
 
<listitem><simpara> an empty <link linkend="GValue"><type>GValue</type></link> to set
267
 
</simpara></listitem></varlistentry>
268
 
</variablelist><para role="since">Since 0.6</para></refsect2>
269
 
<refsect2 id="clutter-model-iter-set" role="function" condition="since:0.6">
270
 
<title>clutter_model_iter_set ()</title>
271
 
<indexterm zone="clutter-model-iter-set" role="0.6"><primary sortas="model_iter_set">clutter_model_iter_set</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_model_iter_set              (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
272
 
                                                         ...);</programlisting>
273
 
<para>
274
 
Sets the value of one or more cells in the row referenced by <parameter>iter</parameter>. The
275
 
variable argument list should contain integer column numbers, each column
276
 
column number followed by the value to be set. The  list is terminated by a
277
 
-1.
278
 
</para>
279
 
<para>
280
 
For example, to set column 0 with type <link linkend="G-TYPE-STRING--CAPS"><literal>G_TYPE_STRING</literal></link>, use:
281
 
<informalexample><programlisting>
282
 
  clutter_model_iter_set (iter, 0, "foo", -1);
283
 
</programlisting></informalexample></para>
284
 
<para>
285
 
</para><variablelist role="params">
286
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
287
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
288
 
</simpara></listitem></varlistentry>
289
 
<varlistentry><term><parameter>...</parameter>&#160;:</term>
290
 
<listitem><simpara> a list of column/return location pairs, terminated by -1
291
 
</simpara></listitem></varlistentry>
292
 
</variablelist><para role="since">Since 0.6</para></refsect2>
293
 
<refsect2 id="clutter-model-iter-set-valist" role="function" condition="since:0.6">
294
 
<title>clutter_model_iter_set_valist ()</title>
295
 
<indexterm zone="clutter-model-iter-set-valist" role="0.6"><primary sortas="model_iter_set_valist">clutter_model_iter_set_valist</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_model_iter_set_valist       (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
296
 
                                                         <link linkend="va-list">va_list</link> args);</programlisting>
297
 
<para>
298
 
See <link linkend="clutter-model-iter-set"><function>clutter_model_iter_set()</function></link>; this version takes a va_list for language
299
 
bindings.</para>
300
 
<para>
301
 
</para><variablelist role="params">
302
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
303
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
304
 
</simpara></listitem></varlistentry>
305
 
<varlistentry><term><parameter>args</parameter>&#160;:</term>
306
 
<listitem><simpara> va_list of column/value pairs, terminiated by -1
307
 
</simpara></listitem></varlistentry>
308
 
</variablelist><para role="since">Since 0.6</para></refsect2>
309
 
<refsect2 id="clutter-model-iter-set-value" role="function" condition="since:0.6">
310
 
<title>clutter_model_iter_set_value ()</title>
311
 
<indexterm zone="clutter-model-iter-set-value" role="0.6"><primary sortas="model_iter_set_value">clutter_model_iter_set_value</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_model_iter_set_value        (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter,
312
 
                                                         <link linkend="guint">guint</link> column,
313
 
                                                         const <link linkend="GValue">GValue</link> *value);</programlisting>
314
 
<para>
315
 
Sets the data in the cell specified by <parameter>iter</parameter> and <parameter>column</parameter>. The type of
316
 
<parameter>value</parameter> must be convertable to the type of the column.</para>
317
 
<para>
318
 
</para><variablelist role="params">
319
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
320
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
321
 
</simpara></listitem></varlistentry>
322
 
<varlistentry><term><parameter>column</parameter>&#160;:</term>
323
 
<listitem><simpara> column number to retrieve the value from
324
 
</simpara></listitem></varlistentry>
325
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
326
 
<listitem><simpara> new value for the cell
327
 
</simpara></listitem></varlistentry>
328
 
</variablelist><para role="since">Since 0.6</para></refsect2>
329
 
<refsect2 id="clutter-model-iter-is-first" role="function" condition="since:0.6">
330
 
<title>clutter_model_iter_is_first ()</title>
331
 
<indexterm zone="clutter-model-iter-is-first" role="0.6"><primary sortas="model_iter_is_first">clutter_model_iter_is_first</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            clutter_model_iter_is_first         (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);</programlisting>
332
 
<para>
333
 
Gets whether the current iterator is at the beginning of the model
334
 
to which it belongs.</para>
335
 
<para>
336
 
</para><variablelist role="params">
337
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
338
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
339
 
</simpara></listitem></varlistentry>
340
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if <parameter>iter</parameter> is the first iter in the filtered model
341
 
 
342
 
</simpara></listitem></varlistentry>
343
 
</variablelist><para role="since">Since 0.6</para></refsect2>
344
 
<refsect2 id="clutter-model-iter-is-last" role="function" condition="since:0.6">
345
 
<title>clutter_model_iter_is_last ()</title>
346
 
<indexterm zone="clutter-model-iter-is-last" role="0.6"><primary sortas="model_iter_is_last">clutter_model_iter_is_last</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            clutter_model_iter_is_last          (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);</programlisting>
347
 
<para>
348
 
Gets whether the iterator is at the end of the model to which it
349
 
belongs.</para>
350
 
<para>
351
 
</para><variablelist role="params">
352
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
353
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
354
 
</simpara></listitem></varlistentry>
355
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if <parameter>iter</parameter> is the last iter in the filtered model.
356
 
 
357
 
</simpara></listitem></varlistentry>
358
 
</variablelist><para role="since">Since 0.6</para></refsect2>
359
 
<refsect2 id="clutter-model-iter-next" role="function" condition="since:0.6">
360
 
<title>clutter_model_iter_next ()</title>
361
 
<indexterm zone="clutter-model-iter-next" role="0.6"><primary sortas="model_iter_next">clutter_model_iter_next</primary></indexterm><programlisting><link linkend="ClutterModelIter">ClutterModelIter</link> *  clutter_model_iter_next             (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);</programlisting>
362
 
<para>
363
 
Updates the <parameter>iter</parameter> to point at the next position in the model.
364
 
The model implementation should take into account the presence of
365
 
a filter function.</para>
366
 
<para>
367
 
</para><variablelist role="params">
368
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
369
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
370
 
</simpara></listitem></varlistentry>
371
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>transfer none. <acronym>transfer</acronym> none. </simpara></listitem></varlistentry>
372
 
</variablelist><para role="since">Since 0.6</para></refsect2>
373
 
<refsect2 id="clutter-model-iter-prev" role="function" condition="since:0.6">
374
 
<title>clutter_model_iter_prev ()</title>
375
 
<indexterm zone="clutter-model-iter-prev" role="0.6"><primary sortas="model_iter_prev">clutter_model_iter_prev</primary></indexterm><programlisting><link linkend="ClutterModelIter">ClutterModelIter</link> *  clutter_model_iter_prev             (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);</programlisting>
376
 
<para>
377
 
Sets the <parameter>iter</parameter> to point at the previous position in the model.
378
 
The model implementation should take into account the presence of
379
 
a filter function.</para>
380
 
<para>
381
 
</para><variablelist role="params">
382
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
383
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
384
 
</simpara></listitem></varlistentry>
385
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>transfer none. <acronym>transfer</acronym> none. </simpara></listitem></varlistentry>
386
 
</variablelist><para role="since">Since 0.6</para></refsect2>
387
 
<refsect2 id="clutter-model-iter-get-model" role="function" condition="since:0.6">
388
 
<title>clutter_model_iter_get_model ()</title>
389
 
<indexterm zone="clutter-model-iter-get-model" role="0.6"><primary sortas="model_iter_get_model">clutter_model_iter_get_model</primary></indexterm><programlisting><link linkend="ClutterModel">ClutterModel</link> *      clutter_model_iter_get_model        (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);</programlisting>
390
 
<para>
391
 
Retrieves a pointer to the <link linkend="ClutterModel"><type>ClutterModel</type></link> that this iter is part of.</para>
392
 
<para>
393
 
</para><variablelist role="params">
394
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
395
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
396
 
</simpara></listitem></varlistentry>
397
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a pointer to a <link linkend="ClutterModel"><type>ClutterModel</type></link>.. <acronym>transfer</acronym> none. </simpara></listitem></varlistentry>
398
 
</variablelist><para role="since">Since 0.6</para></refsect2>
399
 
<refsect2 id="clutter-model-iter-get-row" role="function" condition="since:0.6">
400
 
<title>clutter_model_iter_get_row ()</title>
401
 
<indexterm zone="clutter-model-iter-get-row" role="0.6"><primary sortas="model_iter_get_row">clutter_model_iter_get_row</primary></indexterm><programlisting><link linkend="guint">guint</link>               clutter_model_iter_get_row          (<link linkend="ClutterModelIter">ClutterModelIter</link> *iter);</programlisting>
402
 
<para>
403
 
Retrieves the position of the row that the <parameter>iter</parameter> points to.</para>
404
 
<para>
405
 
</para><variablelist role="params">
406
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
407
 
<listitem><simpara> a <link linkend="ClutterModelIter"><type>ClutterModelIter</type></link>
408
 
</simpara></listitem></varlistentry>
409
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the position of the <parameter>iter</parameter> in the model
410
 
 
411
 
</simpara></listitem></varlistentry>
412
 
</variablelist><para role="since">Since 0.6</para></refsect2>
413
 
 
414
 
</refsect1>
415
 
<refsect1 id="ClutterModelIter.property-details" role="property_details">
416
 
<title role="property_details.title">Property Details</title>
417
 
<refsect2 id="ClutterModelIter--model" role="property"><title>The <literal>&quot;model&quot;</literal> property</title>
418
 
<indexterm zone="ClutterModelIter--model" role="0.6"><primary sortas="ModelIter:model">ClutterModelIter:model</primary></indexterm><programlisting>  &quot;model&quot;                    <link linkend="ClutterModel">ClutterModel</link>*         : Read / Write</programlisting>
419
 
<para>
420
 
A reference to the <link linkend="ClutterModel"><type>ClutterModel</type></link> that this iter belongs to.</para>
421
 
<para>
422
 
</para><para>Since 0.6</para>
423
 
</refsect2>
424
 
<refsect2 id="ClutterModelIter--row" role="property"><title>The <literal>&quot;row&quot;</literal> property</title>
425
 
<indexterm zone="ClutterModelIter--row" role="0.6"><primary sortas="ModelIter:row">ClutterModelIter:row</primary></indexterm><programlisting>  &quot;row&quot;                      <link linkend="guint">guint</link>                 : Read / Write</programlisting>
426
 
<para>
427
 
The row number to which this iter points to.</para>
428
 
<para>
429
 
</para><para>Default value: 0</para>
430
 
<para>Since 0.6</para>
431
 
</refsect2>
432
 
</refsect1>
433
 
 
434
 
 
435
 
 
436
 
 
437
 
</refentry>