/usr/share/gtk-doc/html/dee-1.0/dee-1.0-DeeResultSet.html is in libdee-doc 1.0.10-3.1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Dee Reference Manual: DeeResultSet</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Dee Reference Manual">
<link rel="up" href="ch03.html" title="Indexes">
<link rel="prev" href="dee-1.0-Model-Readers.html" title="Model Readers">
<link rel="next" href="DeeTermList.html" title="DeeTermList">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#dee-1.0-DeeResultSet.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#dee-1.0-DeeResultSet.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="dee-1.0-Model-Readers.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="DeeTermList.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="dee-1.0-DeeResultSet"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="dee-1.0-DeeResultSet.top_of_page"></a>DeeResultSet</span></h2>
<p>DeeResultSet — Cursor-like interface for results sets</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="dee-1.0-DeeResultSet.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">DeeModel</span> *
</td>
<td class="function_name">
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-get-model" title="dee_result_set_get_model ()">dee_result_set_get_model</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-get-n-rows" title="dee_result_set_get_n_rows ()">dee_result_set_get_n_rows</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-has-next" title="dee_result_set_has_next ()">dee_result_set_has_next</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *
</td>
<td class="function_name">
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-next" title="dee_result_set_next ()">dee_result_set_next</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *
</td>
<td class="function_name">
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-peek" title="dee_result_set_peek ()">dee_result_set_peek</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-seek" title="dee_result_set_seek ()">dee_result_set_seek</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-tell" title="dee_result_set_tell ()">dee_result_set_tell</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="dee-1.0-DeeResultSet.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="dee-1.0-DeeResultSet.html#DeeResultSetIface" title="struct DeeResultSetIface">DeeResultSetIface</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="dee-1.0-DeeResultSet.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="dee-1.0-DeeResultSet.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <dee.h>
</pre>
</div>
<div class="refsect1">
<a name="dee-1.0-DeeResultSet.description"></a><h2>Description</h2>
<p>Interface for results returned by <a class="link" href="DeeIndex.html#dee-index-lookup" title="dee_index_lookup ()"><code class="function">dee_index_lookup()</code></a>.</p>
<p>This interface utilizes a cursor-like metaphor. You advance the cursor
by calling <a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-next" title="dee_result_set_next ()"><code class="function">dee_result_set_next()</code></a> or adjust it manually by calling
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-seek" title="dee_result_set_seek ()"><code class="function">dee_result_set_seek()</code></a>.</p>
<p>Calling <a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-next" title="dee_result_set_next ()"><code class="function">dee_result_set_next()</code></a> will also return the row at the
current cursor position. You may retrieve the current row without advancing
the cursor by calling <a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-peek" title="dee_result_set_peek ()"><code class="function">dee_result_set_peek()</code></a>.</p>
</div>
<div class="refsect1">
<a name="dee-1.0-DeeResultSet.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dee-result-set-get-model"></a><h3>dee_result_set_get_model ()</h3>
<pre class="programlisting"><span class="returnvalue">DeeModel</span> *
dee_result_set_get_model (<em class="parameter"><code><span class="type">DeeResultSet</span> *self</code></em>);</pre>
<p>Get the model associated with a result set</p>
<div class="refsect3">
<a name="id-1.4.6.8.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The <span class="type">DeeResultSet</span> to get the mode for</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.6.8.2.6"></a><h4>Returns</h4>
<p> The model that the rows point into. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-result-set-get-n-rows"></a><h3>dee_result_set_get_n_rows ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dee_result_set_get_n_rows (<em class="parameter"><code><span class="type">DeeResultSet</span> *self</code></em>);</pre>
<p>Get the number of <a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="type">DeeModelIter</span></a>s held in a <span class="type">DeeResultSet</span>.</p>
<div class="refsect3">
<a name="id-1.4.6.8.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The <span class="type">DeeResultSet</span> to get the size of</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.6.8.3.6"></a><h4>Returns</h4>
<p> The number of rows held in the result set</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-result-set-has-next"></a><h3>dee_result_set_has_next ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
dee_result_set_has_next (<em class="parameter"><code><span class="type">DeeResultSet</span> *self</code></em>);</pre>
<p>Check if a call to <a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-next" title="dee_result_set_next ()"><code class="function">dee_result_set_next()</code></a> will succeed.</p>
<div class="refsect3">
<a name="id-1.4.6.8.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The <span class="type">DeeResultSet</span> to check</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.6.8.4.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if and only if more rows can be retrieved by calling
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-next" title="dee_result_set_next ()"><code class="function">dee_result_set_next()</code></a></p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-result-set-next"></a><h3>dee_result_set_next ()</h3>
<pre class="programlisting"><a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *
dee_result_set_next (<em class="parameter"><code><span class="type">DeeResultSet</span> *self</code></em>);</pre>
<p>Get the current row from the result set and advance the cursor.
To ensure that calls to this method will succeed you can call
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-has-next" title="dee_result_set_has_next ()"><code class="function">dee_result_set_has_next()</code></a>.</p>
<p>To retrieve the current row without advancing the cursor call
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-peek" title="dee_result_set_peek ()"><code class="function">dee_result_set_peek()</code></a> in stead of this method.</p>
<div class="refsect3">
<a name="id-1.4.6.8.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The <span class="type">DeeResultSet</span> to get a row from</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.6.8.5.7"></a><h4>Returns</h4>
<p>The <a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="type">DeeModelIter</span></a> at the current cursor position. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-result-set-peek"></a><h3>dee_result_set_peek ()</h3>
<pre class="programlisting"><a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *
dee_result_set_peek (<em class="parameter"><code><span class="type">DeeResultSet</span> *self</code></em>);</pre>
<p>Get the row at the current cursor position.</p>
<p>To retrieve the current row and advance the cursor position call
<a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-next" title="dee_result_set_next ()"><code class="function">dee_result_set_next()</code></a> in stead of this method.</p>
<div class="refsect3">
<a name="id-1.4.6.8.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The <span class="type">DeeResultSet</span> to get a row from</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.6.8.6.7"></a><h4>Returns</h4>
<p>The <a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="type">DeeModelIter</span></a> at the current cursor position. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-result-set-seek"></a><h3>dee_result_set_seek ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dee_result_set_seek (<em class="parameter"><code><span class="type">DeeResultSet</span> *self</code></em>,
<em class="parameter"><code><span class="type">guint</span> pos</code></em>);</pre>
<p>Set the cursor position. Following calls to <a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-peek" title="dee_result_set_peek ()"><code class="function">dee_result_set_peek()</code></a>
or <a class="link" href="dee-1.0-DeeResultSet.html#dee-result-set-next" title="dee_result_set_next ()"><code class="function">dee_result_set_next()</code></a> will read the row at position <em class="parameter"><code>pos</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.6.8.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The <span class="type">DeeResultSet</span> to seek in</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pos</p></td>
<td class="parameter_description"><p>The position to seek to</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-result-set-tell"></a><h3>dee_result_set_tell ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dee_result_set_tell (<em class="parameter"><code><span class="type">DeeResultSet</span> *self</code></em>);</pre>
<p>Get the current position of the cursor.</p>
<div class="refsect3">
<a name="id-1.4.6.8.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The <span class="type">DeeResultSet</span> to check the cursor position for</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.6.8.8.6"></a><h4>Returns</h4>
<p> The current position of the cursor</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="dee-1.0-DeeResultSet.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DeeResultSetIface"></a><h3>struct DeeResultSetIface</h3>
<pre class="programlisting">struct DeeResultSetIface {
GTypeInterface g_iface;
guint (*get_n_rows) (DeeResultSet *self);
DeeModelIter* (*next) (DeeResultSet *self);
gboolean (*has_next) (DeeResultSet *self);
DeeModelIter* (*peek) (DeeResultSet *self);
void (*seek) (DeeResultSet *self,
guint pos);
guint (*tell) (DeeResultSet *self);
DeeModel* (*get_model) (DeeResultSet *self);
};
</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|