/usr/share/gtk-doc/html/libgda-4.0/libgda-4.0-Subclassing-GdaDataSelect.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 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Subclassing GdaDataSelect</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="psupport.html" title="Providers' support API">
<link rel="prev" href="GdaServerProvider.html" title="GdaServerProvider">
<link rel="next" href="GdaPStmt.html" title="GdaPStmt">
<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="GdaServerProvider.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="psupport.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="GdaPStmt.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgda-4.0-Subclassing-GdaDataSelect.synopsis" class="shortcut">Top</a>
|
<a href="#libgda-4.0-Subclassing-GdaDataSelect.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgda-4.0-Subclassing-GdaDataSelect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-4.0-Subclassing-GdaDataSelect.top_of_page"></a>Subclassing GdaDataSelect</span></h2>
<p>Subclassing GdaDataSelect — Base class for all the data models returned by DBMS providers when a SELECT statement is executed</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgda-4.0-Subclassing-GdaDataSelect.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgda/providers-support/gda-data-select-priv.h>
struct <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#GdaDataSelectClass" title="struct GdaDataSelectClass">GdaDataSelectClass</a>;
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-data-select-take-row" title="gda_data_select_take_row ()">gda_data_select_take_row</a> (<em class="parameter"><code><a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> *model</code></em>,
<em class="parameter"><code><a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="type">GdaRow</span></a> *row</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> rownum</code></em>);
<a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="returnvalue">GdaRow</span></a> * <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-data-select-get-stored-row" title="gda_data_select_get_stored_row ()">gda_data_select_get_stored_row</a> (<em class="parameter"><code><a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> *model</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> rownum</code></em>);
<a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> * <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-data-select-get-connection" title="gda_data_select_get_connection ()">gda_data_select_get_connection</a> (<em class="parameter"><code><a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> *model</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-data-select-set-columns" title="gda_data_select_set_columns ()">gda_data_select_set_columns</a> (<em class="parameter"><code><a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> *model</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *columns</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-column-set-name" title="gda_column_set_name ()">gda_column_set_name</a> (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</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> *name</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-column-set-description" title="gda_column_set_description ()">gda_column_set_description</a> (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</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> *title</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-column-set-dbms-type" title="gda_column_set_dbms_type ()">gda_column_set_dbms_type</a> (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</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> *dbms_type</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-column-set-g-type" title="gda_column_set_g_type ()">gda_column_set_g_type</a> (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-column-set-allow-null" title="gda_column_set_allow_null ()">gda_column_set_allow_null</a> (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> allow</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-column-set-auto-increment" title="gda_column_set_auto_increment ()">gda_column_set_auto_increment</a> (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> is_auto</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-column-set-position" title="gda_column_set_position ()">gda_column_set_position</a> (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</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> position</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-column-set-default-value" title="gda_column_set_default_value ()">gda_column_set_default_value</a> (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</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> *default_value</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-alphanum-to-text" title="gda_alphanum_to_text ()">gda_alphanum_to_text</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-text-to-alphanum" title="gda_text_to_alphanum ()">gda_text_to_alphanum</a> (<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> *text</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="libgda-4.0-Subclassing-GdaDataSelect.html#gda-data-model-iter-move-next-default" title="gda_data_model_iter_move_next_default ()">gda_data_model_iter_move_next_default</a>
(<em class="parameter"><code><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *model</code></em>,
<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="libgda-4.0-Subclassing-GdaDataSelect.html#gda-data-model-iter-move-prev-default" title="gda_data_model_iter_move_prev_default ()">gda_data_model_iter_move_prev_default</a>
(<em class="parameter"><code><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *model</code></em>,
<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-row-invalidate-value" title="gda_row_invalidate_value ()">gda_row_invalidate_value</a> (<em class="parameter"><code><a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="type">GdaRow</span></a> *row</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</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="libgda-4.0-Subclassing-GdaDataSelect.html#gda-row-value-is-valid" title="gda_row_value_is_valid ()">gda_row_value_is_valid</a> (<em class="parameter"><code><a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="type">GdaRow</span></a> *row</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgda-4.0-Subclassing-GdaDataSelect.description"></a><h2>Description</h2>
<p>
All database providers should subclass this class when returning a data model after the execution of a SELECT
statement. Specifically it has the following features:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>Manages its list of <a class="link" href="GdaColumn.html" title="GdaDataModel columns">GdaColumn</a> using the list exported by the prepared statement object (<a class="link" href="GdaPStmt.html" title="GdaPStmt">GdaPStmt</a>)</p></li>
<li class="listitem"><p>Allows random or cursor based access</p></li>
<li class="listitem"><p>Allows for efficient memory usage allowing the subclass to finely tune its memory usage</p></li>
<li class="listitem"><p>Provides a generic mechanism for writable data models</p></li>
</ul></div>
<p>
</p>
<p>
See the <a class="link" href="libgda-provider-recordset.html" title="Virtual methods for recordsets">Virtual methods for recordsets</a> section for more information
about how to implement the virtual methods of the subclassed object.
</p>
<p>
This section documents the methods available for the database provider's implementations.
</p>
</div>
<div class="refsect1">
<a name="libgda-4.0-Subclassing-GdaDataSelect.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaDataSelectClass"></a><h3>struct GdaDataSelectClass</h3>
<pre class="programlisting">struct GdaDataSelectClass {
GObjectClass parent_class;
/* GDA_DATA_MODEL_ACCESS_RANDOM */
gint (*fetch_nb_rows) (GdaDataSelect *model);
gboolean (*fetch_random) (GdaDataSelect *model, GdaRow **prow, gint rownum, GError **error);
gboolean (*store_all) (GdaDataSelect *model, GError **error);
/* GDA_STATEMENT_MODEL_CURSOR_* */
gboolean (*fetch_next) (GdaDataSelect *model, GdaRow **prow, gint rownum, GError **error);
gboolean (*fetch_prev) (GdaDataSelect *model, GdaRow **prow, gint rownum, GError **error);
gboolean (*fetch_at) (GdaDataSelect *model, GdaRow **prow, gint rownum, GError **error);
/* Padding for future expansion */
void (*_gda_reserved1) (void);
void (*_gda_reserved2) (void);
void (*_gda_reserved3) (void);
void (*_gda_reserved4) (void);
};
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GdaDataSelectClass.parent-class"></a>parent_class</code></em>;</span></p></td>
<td>parent object class</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GdaDataSelectClass.fetch-nb-rows"></a>fetch_nb_rows</code></em> ()</span></p></td>
<td>virtual method which must be implemented when access method is GDA_DATA_MODEL_ACCESS_RANDOM</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GdaDataSelectClass.fetch-random"></a>fetch_random</code></em> ()</span></p></td>
<td>virtual method which must be implemented when access method is GDA_DATA_MODEL_ACCESS_RANDOM</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GdaDataSelectClass.store-all"></a>store_all</code></em> ()</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GdaDataSelectClass.fetch-next"></a>fetch_next</code></em> ()</span></p></td>
<td>virtual method which must be implemented when access method is GDA_DATA_MODEL_ACCESS_CURSOR_FORWARD</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GdaDataSelectClass.fetch-prev"></a>fetch_prev</code></em> ()</span></p></td>
<td>virtual method which must be implemented when access method is GDA_DATA_MODEL_ACCESS_CURSOR_BACKWARD</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GdaDataSelectClass.fetch-at"></a>fetch_at</code></em> ()</span></p></td>
<td>virtual method which can be implemented when access method is GDA_DATA_MODEL_ACCESS_CURSOR_FORWARD or GDA_DATA_MODEL_ACCESS_CURSOR_BACKWARD</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GdaDataSelectClass.-gda-reserved1"></a>_gda_reserved1</code></em> ()</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GdaDataSelectClass.-gda-reserved2"></a>_gda_reserved2</code></em> ()</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GdaDataSelectClass.-gda-reserved3"></a>_gda_reserved3</code></em> ()</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GdaDataSelectClass.-gda-reserved4"></a>_gda_reserved4</code></em> ()</span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-select-take-row"></a><h3>gda_data_select_take_row ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_data_select_take_row (<em class="parameter"><code><a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> *model</code></em>,
<em class="parameter"><code><a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="type">GdaRow</span></a> *row</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> rownum</code></em>);</pre>
<p>
Stores <em class="parameter"><code>row</code></em> into <em class="parameter"><code>model</code></em>, externally advertized at row number <em class="parameter"><code>rownum</code></em> (if no row has been removed).
The reference to <em class="parameter"><code>row</code></em> is stolen.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> data model</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>a <a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="type">GdaRow</span></a> row. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rownum</code></em> :</span></p></td>
<td>"external" advertized row number</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-select-get-stored-row"></a><h3>gda_data_select_get_stored_row ()</h3>
<pre class="programlisting"><a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="returnvalue">GdaRow</span></a> * gda_data_select_get_stored_row (<em class="parameter"><code><a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> *model</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> rownum</code></em>);</pre>
<p>
Get the <a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="type">GdaRow</span></a> object stored within <em class="parameter"><code>model</code></em> at row <em class="parameter"><code>rownum</code></em> (without taking care of removed rows)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> data model</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rownum</code></em> :</span></p></td>
<td>"external" advertized row number</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the requested <a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="type">GdaRow</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 not found. <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-select-get-connection"></a><h3>gda_data_select_get_connection ()</h3>
<pre class="programlisting"><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> * gda_data_select_get_connection (<em class="parameter"><code><a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> *model</code></em>);</pre>
<p>
Get a pointer to the <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object which was used when <em class="parameter"><code>model</code></em> was created
(and which may be used internally by <em class="parameter"><code>model</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>model</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> data model</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to the <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</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-select-set-columns"></a><h3>gda_data_select_set_columns ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_data_select_set_columns (<em class="parameter"><code><a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> *model</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *columns</code></em>);</pre>
<p>
Makes <em class="parameter"><code>columns</code></em> the list of columns for <em class="parameter"><code>model</code></em>. Both the list and each <a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> object in the
list are 'stolen' by <em class="parameter"><code>model</code></em> (ie. when this function returns the caller should not use anymore
the list or each column object in it). This method should not be used directly, it is used by
database provider's implementations.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataSelect.html" title="GdaDataSelect"><span class="type">GdaDataSelect</span></a> data model</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>columns</code></em> :</span></p></td>
<td>a lis of <a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> objects. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2.1</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-column-set-name"></a><h3>gda_column_set_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_column_set_name (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</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> *name</code></em>);</pre>
<p>
Sets the name of <em class="parameter"><code>column</code></em> to <em class="parameter"><code>name</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>column</code></em> :</span></p></td>
<td>a <a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the new name of <em class="parameter"><code>column</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-column-set-description"></a><h3>gda_column_set_description ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_column_set_description (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</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> *title</code></em>);</pre>
<p>
Sets the column's description
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>column</code></em> :</span></p></td>
<td>a <a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>title name.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-column-set-dbms-type"></a><h3>gda_column_set_dbms_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_column_set_dbms_type (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</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> *dbms_type</code></em>);</pre>
<p>
Defines <em class="parameter"><code>column</code></em>'s database type
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>column</code></em> :</span></p></td>
<td>a <a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dbms_type</code></em> :</span></p></td>
<td>a string</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-column-set-g-type"></a><h3>gda_column_set_g_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_column_set_g_type (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);</pre>
<p>
Sets the type of <em class="parameter"><code>column</code></em> to <em class="parameter"><code>type</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>column</code></em> :</span></p></td>
<td>a <a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>the new type of <em class="parameter"><code>column</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-column-set-allow-null"></a><h3>gda_column_set_allow_null ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_column_set_allow_null (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> allow</code></em>);</pre>
<p>
Sets the 'allow null' flag of the given column.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>column</code></em> :</span></p></td>
<td>a <a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>allow</code></em> :</span></p></td>
<td>whether the given column should allows null values or not.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-column-set-auto-increment"></a><h3>gda_column_set_auto_increment ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_column_set_auto_increment (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> is_auto</code></em>);</pre>
<p>
Sets the auto increment flag for the given column.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>column</code></em> :</span></p></td>
<td>a <a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>is_auto</code></em> :</span></p></td>
<td>auto increment status.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-column-set-position"></a><h3>gda_column_set_position ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_column_set_position (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</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> position</code></em>);</pre>
<p>
Sets the position of the column refer to in the containing
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>column</code></em> :</span></p></td>
<td>a <a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>the wanted position of the column in the containing data model.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-column-set-default-value"></a><h3>gda_column_set_default_value ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_column_set_default_value (<em class="parameter"><code><a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a> *column</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> *default_value</code></em>);</pre>
<p>
Sets <em class="parameter"><code>column</code></em>'s default <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>column</code></em> :</span></p></td>
<td>a <a class="link" href="GdaColumn.html" title="GdaDataModel columns"><span class="type">GdaColumn</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>default_value</code></em> :</span></p></td>
<td>default <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> for the column</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-alphanum-to-text"></a><h3>gda_alphanum_to_text ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gda_alphanum_to_text (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
<p>
Does the opposite of <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-text-to-alphanum" title="gda_text_to_alphanum ()"><code class="function">gda_text_to_alphanum()</code></a>, in the same string
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>a string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<em class="parameter"><code>text</code></em> if conversion succeeded 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</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-text-to-alphanum"></a><h3>gda_text_to_alphanum ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gda_text_to_alphanum (<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> *text</code></em>);</pre>
<p>
The "encoding" consists in replacing non
alphanumeric character with the string "__gdaXX" where XX is the hex. representation
of the non alphanumeric char.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>the text to convert</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new string</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-move-next-default"></a><h3>gda_data_model_iter_move_next_default ()</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_default
(<em class="parameter"><code><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *model</code></em>,
<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-iter-move-prev-default"></a><h3>gda_data_model_iter_move_prev_default ()</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_default
(<em class="parameter"><code><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *model</code></em>,
<em class="parameter"><code><a class="link" href="GdaDataModelIter.html" title="GdaDataModelIter"><span class="type">GdaDataModelIter</span></a> *iter</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gda-row-invalidate-value"></a><h3>gda_row_invalidate_value ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_row_invalidate_value (<em class="parameter"><code><a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="type">GdaRow</span></a> *row</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<p>
Marks <em class="parameter"><code>value</code></em> as being invalid. This method is mainly used by database
providers' implementations to report any error while reading a value from the database.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>a <a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="type">GdaRow</span></a>
</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> belonging to <em class="parameter"><code>row</code></em> (obtained with <a class="link" href="GdaRow.html#gda-row-get-value" title="gda_row_get_value ()"><code class="function">gda_row_get_value()</code></a>).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-row-value-is-valid"></a><h3>gda_row_value_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_row_value_is_valid (<em class="parameter"><code><a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="type">GdaRow</span></a> *row</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<p>
Tells if <em class="parameter"><code>value</code></em> has been marked as being invalid by <a class="link" href="libgda-4.0-Subclassing-GdaDataSelect.html#gda-row-invalidate-value" title="gda_row_invalidate_value ()"><code class="function">gda_row_invalidate_value()</code></a>.
This method is mainly used by database
providers' implementations to report any error while reading a value from the database.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>a <a class="link" href="GdaRow.html" title="GdaDataModelArray's rows"><span class="type">GdaRow</span></a>.</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> belonging to <em class="parameter"><code>row</code></em> (obtained with <a class="link" href="GdaRow.html#gda-row-get-value" title="gda_row_get_value ()"><code class="function">gda_row_get_value()</code></a>).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>value</code></em> is valid</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|