/usr/share/gtk-doc/html/libgda-4.0/GdaDataModelIter.html is in libgda-4.0-doc 4.2.8-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaDataModelIter</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GNOME Data Access 4 manual">
<link rel="up" href="data_models.html" title="Data handling">
<link rel="prev" href="GdaColumn.html" title="GdaDataModel columns">
<link rel="next" href="GdaDataModelImport.html" title="GdaDataModelImport">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GdaColumn.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="data_models.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Data Access 4 manual</th>
<td><a accesskey="n" href="GdaDataModelImport.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdaDataModelIter.synopsis" class="shortcut">Top</a>
|
<a href="#GdaDataModelIter.description" class="shortcut">Description</a>
|
<a href="#GdaDataModelIter.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdaDataModelIter.properties" class="shortcut">Properties</a>
|
<a href="#GdaDataModelIter.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdaDataModelIter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaDataModelIter.top_of_page"></a>GdaDataModelIter</span></h2>
<p>GdaDataModelIter — Data model iterator</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdaDataModelIter.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GdaDataModelIter.html#GdaDataModelIter-struct" title="GdaDataModelIter">GdaDataModelIter</a>;
const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-get-value-at" title="gda_data_model_iter_get_value_at ()">gda_data_model_iter_get_value_at</a> (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>);
const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-get-value-for-field" title="gda_data_model_iter_get_value_for_field ()">gda_data_model_iter_get_value_for_field</a>
(<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *field_name</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-set-value-at" title="gda_data_model_iter_set_value_at ()">gda_data_model_iter_set_value_at</a> (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-is-valid" title="gda_data_model_iter_is_valid ()">gda_data_model_iter_is_valid</a> (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-move-to-row" title="gda_data_model_iter_move_to_row ()">gda_data_model_iter_move_to_row</a> (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-move-next" title="gda_data_model_iter_move_next ()">gda_data_model_iter_move_next</a> (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-move-prev" title="gda_data_model_iter_move_prev ()">gda_data_model_iter_move_prev</a> (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-get-row" title="gda_data_model_iter_get_row ()">gda_data_model_iter_get_row</a> (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);
<a class="link" href="GdaHolder.html" title="GdaHolder"><span class="returnvalue">GdaHolder</span></a> * <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-get-holder-for-field" title="gda_data_model_iter_get_holder_for_field ()">gda_data_model_iter_get_holder_for_field</a>
(<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-invalidate-contents" title="gda_data_model_iter_invalidate_contents ()">gda_data_model_iter_invalidate_contents</a>
(<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdaDataModelIter.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="GdaSet.html" title="GdaSet">GdaSet</a>
+----GdaDataModelIter
</pre>
</div>
<div class="refsect1">
<a name="GdaDataModelIter.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GdaDataModelIter.html#GdaDataModelIter--current-row" title='The "current-row" property'>current-row</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="GdaDataModelIter.html#GdaDataModelIter--data-model" title='The "data-model" property'>data-model</a>" <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a>* : Read / Write / Construct Only
"<a class="link" href="GdaDataModelIter.html#GdaDataModelIter--forced-model" title='The "forced-model" property'>forced-model</a>" <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a>* : Read / Write
"<a class="link" href="GdaDataModelIter.html#GdaDataModelIter--update-model" title='The "update-model" property'>update-model</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="GdaDataModelIter.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GdaDataModelIter.html#GdaDataModelIter-end-of-data" title='The "end-of-data" signal'>end-of-data</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="GdaDataModelIter.html#GdaDataModelIter-row-changed" title='The "row-changed" signal'>row-changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GdaDataModelIter.description"></a><h2>Description</h2>
<p>
A <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> object is used to iterate through the rows of a <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a>. If the data model is accessible
in a random access way then any number of <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> objects can be created on the same data model, and
if the data model only supports a cursor based access then only one <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> can be created. In any case
creating a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> should be done using the <a class="link" href="GdaDataModel.html#gda-data-model-create-iter" title="gda_data_model_create_iter ()"><code class="function">gda_data_model_create_iter()</code></a> method. Note that if
the data model only supports a cursor based access, then calling this method several times will always return
the same <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a>, but with its reference count increased by 1 (so you should call <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when
finished with it).
</p>
<p>
When a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> is valid (that is when it points to an existing row in the data model it iterates through),
the individual values (corresponding to each column of the data model, at the pointer row) can be accessed
using the <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-get-value-at" title="gda_data_model_iter_get_value_at ()"><code class="function">gda_data_model_iter_get_value_at()</code></a> or <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-get-value-for-field" title="gda_data_model_iter_get_value_for_field ()"><code class="function">gda_data_model_iter_get_value_for_field()</code></a> methods
(or in the same way <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a>'s values are accessed as <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> inherits the <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a>).
</p>
<p>
Right after being created, a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> is invalid (does not point to any row of its data model). To read the
first row of the data model, use the <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-move-next" title="gda_data_model_iter_move_next ()"><code class="function">gda_data_model_iter_move_next()</code></a> method. Calling this method several times will
move the iterator forward, up to when the data model has no more rows and the <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> will be declared invalid
(and <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-move-next" title="gda_data_model_iter_move_next ()"><code class="function">gda_data_model_iter_move_next()</code></a> has returned FALSE). Note that at this point, the number of rows in the data
model will be known.
</p>
<p>
If the data model supports it, a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> can be moved backwards using the <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-move-prev" title="gda_data_model_iter_move_prev ()"><code class="function">gda_data_model_iter_move_prev()</code></a>
method. However if the iterator is invalid, moving backwards will not be possible (on the contrary to
<a class="link" href="GdaDataModelIter.html#gda-data-model-iter-move-next" title="gda_data_model_iter_move_next ()"><code class="function">gda_data_model_iter_move_next()</code></a> which moves to the first row).
</p>
<p>
The <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-move-to-row" title="gda_data_model_iter_move_to_row ()"><code class="function">gda_data_model_iter_move_to_row()</code></a> method, if the iterator can be moved both forward and backwards, can move the
iterator to a specific row (sometimes faster than moving it forward or backwards a number of times).
</p>
<p>
The following figure illustrates the <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> usage:
</p>
<div class="mediaobject"><img src="GdaDataModelIter.png" width="637.795275590551" alt="GdaDataModelIter's usage"></div>
<p>
Note: the new <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> does not hold any reference to the data model it iterates through (ie.
if this data model is destroyed at some point, the new iterator will become useless but in
any case it will not prevent the data model from being destroyed).
</p>
</div>
<div class="refsect1">
<a name="GdaDataModelIter.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaDataModelIter-struct"></a><h3>GdaDataModelIter</h3>
<pre class="programlisting">typedef struct _GdaDataModelIter GdaDataModelIter;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-get-value-at"></a><h3>gda_data_model_iter_get_value_at ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * gda_data_model_iter_get_value_at (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>);</pre>
<p>
Get the value stored at the column <em class="parameter"><code>col</code></em> in <em class="parameter"><code>iter</code></em>. The returned value must not be modified.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>the requested column</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the value could not be fetched. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-get-value-for-field"></a><h3>gda_data_model_iter_get_value_for_field ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * gda_data_model_iter_get_value_for_field
(<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *field_name</code></em>);</pre>
<p>
Get the value stored at the column <em class="parameter"><code>field_name</code></em> in <em class="parameter"><code>iter</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>field_name</code></em> :</span></p></td>
<td>the requested column name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-set-value-at"></a><h3>gda_data_model_iter_set_value_at ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_data_model_iter_set_value_at (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Sets a value in <em class="parameter"><code>iter</code></em>, at the column specified by <em class="parameter"><code>col</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>the column number</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> (not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if no error occurred</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-is-valid"></a><h3>gda_data_model_iter_is_valid ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_data_model_iter_is_valid (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);</pre>
<p>
Tells if <em class="parameter"><code>iter</code></em> is a valid iterator (if it actually corresponds to a valid row in the model)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if <em class="parameter"><code>iter</code></em> is valid</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-move-to-row"></a><h3>gda_data_model_iter_move_to_row ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_data_model_iter_move_to_row (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row</code></em>);</pre>
<p>
Synchronizes the values of the parameters in <em class="parameter"><code>iter</code></em> with the values at the <em class="parameter"><code>row</code></em> row.
</p>
<p>
If <em class="parameter"><code>row</code></em> is not a valid row, then the returned value is FALSE, and the "current-row"
property is set to -1 (which means that <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-is-valid" title="gda_data_model_iter_is_valid ()"><code class="function">gda_data_model_iter_is_valid()</code></a> would return FALSE)
</p>
<p>
If any other error occurred then the returned value is FALSE, but the "current-row"
property is set to the <em class="parameter"><code>row</code></em> row. In this case
each <a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> composing <em class="parameter"><code>iter</code></em> for which an error occurred will be invalid (see <a class="link" href="GdaHolder.html#gda-holder-is-valid" title="gda_holder_is_valid ()"><code class="function">gda_holder_is_valid()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>the row to set <em class="parameter"><code>iter</code></em> to</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if no error occurred</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-move-next"></a><h3>gda_data_model_iter_move_next ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_data_model_iter_move_next (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);</pre>
<p>
Moves <em class="parameter"><code>iter</code></em> one row further than where it already is
(synchronizes the values of the parameters in <em class="parameter"><code>iter</code></em> with the values at the new row).
</p>
<p>
If the iterator was on the data model's last row, then it can't be moved forward
anymore, and the returned value is FALSE; nore also that the "current-row" property
is set to -1 (which means that <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-is-valid" title="gda_data_model_iter_is_valid ()"><code class="function">gda_data_model_iter_is_valid()</code></a> would return FALSE)
</p>
<p>
If any other error occurred then the returned value is FALSE, but the "current-row"
property is set to the new current row (one row more than it was before the call). In this case
each <a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> composing <em class="parameter"><code>iter</code></em> for which an error occurred will be invalid (see <a class="link" href="GdaHolder.html#gda-holder-is-valid" title="gda_holder_is_valid ()"><code class="function">gda_holder_is_valid()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the iterator is now at the next row</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-move-prev"></a><h3>gda_data_model_iter_move_prev ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_data_model_iter_move_prev (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);</pre>
<p>
Moves <em class="parameter"><code>iter</code></em> one row before where it already is (synchronizes the values of the parameters in <em class="parameter"><code>iter</code></em>
with the values at the new row).
</p>
<p>
If the iterator was on the data model's first row, then it can't be moved backwards
anymore, and the returned value is FALSE; note also that the "current-row" property
is set to -1 (which means that <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-is-valid" title="gda_data_model_iter_is_valid ()"><code class="function">gda_data_model_iter_is_valid()</code></a> would return FALSE).
</p>
<p>
If any other error occurred then the returned value is FALSE, but the "current-row"
property is set to the new current row (one row less than it was before the call). In this case
each <a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> composing <em class="parameter"><code>iter</code></em> for which an error occurred will be invalid (see <a class="link" href="GdaHolder.html#gda-holder-is-valid" title="gda_holder_is_valid ()"><code class="function">gda_holder_is_valid()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the iterator is now at the previous row</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-get-row"></a><h3>gda_data_model_iter_get_row ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gda_data_model_iter_get_row (<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);</pre>
<p>
Get the row which <em class="parameter"><code>iter</code></em> represents in the data model
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the row number, or -1 if <em class="parameter"><code>iter</code></em> is invalid</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-get-holder-for-field"></a><h3>gda_data_model_iter_get_holder_for_field ()</h3>
<pre class="programlisting"><a class="link" href="GdaHolder.html" title="GdaHolder"><span class="returnvalue">GdaHolder</span></a> * gda_data_model_iter_get_holder_for_field
(<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>);</pre>
<p>
Fetch a pointer to the <a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> object which is synchronized with data at
column <em class="parameter"><code>col</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>the requested column</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-invalidate-contents"></a><h3>gda_data_model_iter_invalidate_contents ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_data_model_iter_invalidate_contents
(<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);</pre>
<p>
Declare all the parameters in <em class="parameter"><code>iter</code></em> invalid, without modifying the
<a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> <em class="parameter"><code>iter</code></em> is for or changing the row it represents. This method
is for internal usage. Note that for <a class="link" href="GdaDataModelIter.html#gda-data-model-iter-is-valid" title="gda_data_model_iter_is_valid ()"><code class="function">gda_data_model_iter_is_valid()</code></a> to return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>,
it is also necessary to set the "current-row" property to -1.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> object</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GdaDataModelIter.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdaDataModelIter--current-row"></a><h3>The <code class="literal">"current-row"</code> property</h3>
<pre class="programlisting"> "current-row" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
<p>Current represented row in the data model.</p>
<p>Allowed values: >= G_MAXULONG</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataModelIter--data-model"></a><h3>The <code class="literal">"data-model"</code> property</h3>
<pre class="programlisting"> "data-model" <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a>* : Read / Write / Construct Only</pre>
<p>Data model for which the iter is for.</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataModelIter--forced-model"></a><h3>The <code class="literal">"forced-model"</code> property</h3>
<pre class="programlisting"> "forced-model" <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a>* : Read / Write</pre>
<p>Overrides the data model the iter is attached to (reserved for internal usage).</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataModelIter--update-model"></a><h3>The <code class="literal">"update-model"</code> property</h3>
<pre class="programlisting"> "update-model" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p></p>
<p>Default value: TRUE</p>
</div>
</div>
<div class="refsect1">
<a name="GdaDataModelIter.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GdaDataModelIter-end-of-data"></a><h3>The <code class="literal">"end-of-data"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Gets emitted when <em class="parameter"><code>iter</code></em> has reached the end of available data (which means the previous
row it was on was the last one).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>the <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataModelIter-row-changed"></a><h3>The <code class="literal">"row-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Gets emitted when the row <em class="parameter"><code>iter</code></em> is currently pointing has changed
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>the <a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>the new iter's row</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|