← Back to branch summary

~ubuntu-branches/ubuntu/trusty/dee/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/reference/dee-1.0/html/DeeResultSet.html

  • Committer: Package Import Robot
  • Author(s): Didier Roche
  • Date: 2012-04-12 11:33:08 UTC
  • mfrom: (1.1.19)
  • Revision ID: package-import@ubuntu.com-20120412113308-cr9nobarsigs0xak
Tags: 1.0.10-0ubuntu1
https://launchpad.net/bugs/963991
https://launchpad.net/bugs/938382
https://launchpad.net/bugs/953978
* New upstream release.
  - unity-music-daemon crashed with SIGSEGV in find_term_real() from
    dee_tree_index_lookup() from dee_index_lookup() from
    unity_music_lens_rhythmbox_collection_search() (LP: #963991)
  - unity-applications-daemon crashed with SIGSEGV in
    g_variant_get_type_info() (LP: #938382)
  - unity-applications-daemon crashed with SIGSEGV in
    g_variant_type_info_check() (LP: #953978)
* debian/control:
  - update Standards-Version to latest

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/dee-1.0/html/DeeResultSet.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>DeeResultSet</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
 
<link rel="home" href="index.html" title="Dee Reference Manual">
8
 
<link rel="up" href="ch03.html" title="Indexes">
9
 
<link rel="prev" href="dee-1.0-Model-Readers.html" title="Model Readers">
10
 
<link rel="next" href="DeeTermList.html" title="DeeTermList">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
</head>
14
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="dee-1.0-Model-Readers.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">Dee Reference Manual</th>
21
 
<td><a accesskey="n" href="DeeTermList.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#DeeResultSet.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#DeeResultSet.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#DeeResultSet.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
                   | 
30
 
                  <a href="#DeeResultSet.prerequisites" class="shortcut">Prerequisites</a>
31
 
                   | 
32
 
                  <a href="#DeeResultSet.implementations" class="shortcut">Known Implementations</a>
33
 
</td></tr>
34
 
</table>
35
 
<div class="refentry">
36
 
<a name="DeeResultSet"></a><div class="titlepage"></div>
37
 
<div class="refnamediv"><table width="100%"><tr>
38
 
<td valign="top">
39
 
<h2><span class="refentrytitle"><a name="DeeResultSet.top_of_page"></a>DeeResultSet</span></h2>
40
 
<p>DeeResultSet — Cursor-like interface for results sets</p>
41
 
</td>
42
 
<td valign="top" align="right"></td>
43
 
</tr></table></div>
44
 
<div class="refsynopsisdiv">
45
 
<a name="DeeResultSet.synopsis"></a><h2>Synopsis</h2>
46
 
<pre class="synopsis">
47
 
#include &lt;dee.h&gt;
48
 
 
49
 
                    <a class="link" href="DeeResultSet.html#DeeResultSet-struct" title="DeeResultSet">DeeResultSet</a>;
50
 
struct              <a class="link" href="DeeResultSet.html#DeeResultSetIface" title="struct DeeResultSetIface">DeeResultSetIface</a>;
51
 
<a class="link" href="DeeModel.html" title="DeeModel"><span class="returnvalue">DeeModel</span></a> *          <a class="link" href="DeeResultSet.html#dee-result-set-get-model" title="dee_result_set_get_model ()">dee_result_set_get_model</a>            (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);
52
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="DeeResultSet.html#dee-result-set-get-n-rows" title="dee_result_set_get_n_rows ()">dee_result_set_get_n_rows</a>           (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);
53
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="DeeResultSet.html#dee-result-set-has-next" title="dee_result_set_has_next ()">dee_result_set_has_next</a>             (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);
54
 
<a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *      <a class="link" href="DeeResultSet.html#dee-result-set-next" title="dee_result_set_next ()">dee_result_set_next</a>                 (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);
55
 
<a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *      <a class="link" href="DeeResultSet.html#dee-result-set-peek" title="dee_result_set_peek ()">dee_result_set_peek</a>                 (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);
56
 
<span class="returnvalue">void</span>                <a class="link" href="DeeResultSet.html#dee-result-set-seek" title="dee_result_set_seek ()">dee_result_set_seek</a>                 (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> pos</code></em>);
58
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="DeeResultSet.html#dee-result-set-tell" title="dee_result_set_tell ()">dee_result_set_tell</a>                 (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);
59
 
</pre>
60
 
</div>
61
 
<div class="refsect1">
62
 
<a name="DeeResultSet.object-hierarchy"></a><h2>Object Hierarchy</h2>
63
 
<pre class="synopsis">
64
 
  GInterface
65
 
   +----DeeResultSet
66
 
</pre>
67
 
</div>
68
 
<div class="refsect1">
69
 
<a name="DeeResultSet.prerequisites"></a><h2>Prerequisites</h2>
70
 
<p>
71
 
DeeResultSet requires
72
 
 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
73
 
</div>
74
 
<div class="refsect1">
75
 
<a name="DeeResultSet.implementations"></a><h2>Known Implementations</h2>
76
 
<p>
77
 
DeeResultSet is implemented by
78
 
 DeeGListResultSet.</p>
79
 
</div>
80
 
<div class="refsect1">
81
 
<a name="DeeResultSet.description"></a><h2>Description</h2>
82
 
<p>
83
 
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>.
84
 
</p>
85
 
<p>
86
 
This interface utilizes a cursor-like metaphor. You advance the cursor
87
 
by calling <a class="link" href="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
88
 
<a class="link" href="DeeResultSet.html#dee-result-set-seek" title="dee_result_set_seek ()"><code class="function">dee_result_set_seek()</code></a>.
89
 
</p>
90
 
<p>
91
 
Calling <a class="link" href="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
92
 
current cursor position. You may retrieve the current row without advancing
93
 
the cursor by calling <a class="link" href="DeeResultSet.html#dee-result-set-peek" title="dee_result_set_peek ()"><code class="function">dee_result_set_peek()</code></a>.
94
 
</p>
95
 
</div>
96
 
<div class="refsect1">
97
 
<a name="DeeResultSet.details"></a><h2>Details</h2>
98
 
<div class="refsect2">
99
 
<a name="DeeResultSet-struct"></a><h3>DeeResultSet</h3>
100
 
<pre class="programlisting">typedef struct _DeeResultSet DeeResultSet;</pre>
101
 
<p>
102
 
</p>
103
 
</div>
104
 
<hr>
105
 
<div class="refsect2">
106
 
<a name="DeeResultSetIface"></a><h3>struct DeeResultSetIface</h3>
107
 
<pre class="programlisting">struct DeeResultSetIface {
108
 
  GTypeInterface g_iface;
109
 
 
110
 
  guint           (*get_n_rows)        (DeeResultSet *self);
111
 
 
112
 
  DeeModelIter*   (*next)              (DeeResultSet *self);
113
 
 
114
 
  gboolean        (*has_next)          (DeeResultSet *self);
115
 
  
116
 
  DeeModelIter*   (*peek)              (DeeResultSet *self);
117
 
 
118
 
  void            (*seek)              (DeeResultSet *self,
119
 
                                        guint         pos);
120
 
 
121
 
  guint           (*tell)              (DeeResultSet *self);
122
 
 
123
 
  DeeModel*       (*get_model)         (DeeResultSet *self);
124
 
};
125
 
</pre>
126
 
<p>
127
 
</p>
128
 
</div>
129
 
<hr>
130
 
<div class="refsect2">
131
 
<a name="dee-result-set-get-model"></a><h3>dee_result_set_get_model ()</h3>
132
 
<pre class="programlisting"><a class="link" href="DeeModel.html" title="DeeModel"><span class="returnvalue">DeeModel</span></a> *          dee_result_set_get_model            (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);</pre>
133
 
<p>
134
 
Get the model associated with a result set
135
 
</p>
136
 
<div class="variablelist"><table border="0">
137
 
<col align="left" valign="top">
138
 
<tbody>
139
 
<tr>
140
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
141
 
<td>The <a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> to get the mode for</td>
142
 
</tr>
143
 
<tr>
144
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
145
 
<td>The model that the rows point into. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
146
 
</td>
147
 
</tr>
148
 
</tbody>
149
 
</table></div>
150
 
</div>
151
 
<hr>
152
 
<div class="refsect2">
153
 
<a name="dee-result-set-get-n-rows"></a><h3>dee_result_set_get_n_rows ()</h3>
154
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               dee_result_set_get_n_rows           (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);</pre>
155
 
<p>
156
 
Get the number of <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a>s held in a <a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a>.
157
 
</p>
158
 
<div class="variablelist"><table border="0">
159
 
<col align="left" valign="top">
160
 
<tbody>
161
 
<tr>
162
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
163
 
<td>The <a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> to get the size of</td>
164
 
</tr>
165
 
<tr>
166
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
167
 
<td>The number of rows held in the result set</td>
168
 
</tr>
169
 
</tbody>
170
 
</table></div>
171
 
</div>
172
 
<hr>
173
 
<div class="refsect2">
174
 
<a name="dee-result-set-has-next"></a><h3>dee_result_set_has_next ()</h3>
175
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            dee_result_set_has_next             (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);</pre>
176
 
<p>
177
 
Check if a call to <a class="link" href="DeeResultSet.html#dee-result-set-next" title="dee_result_set_next ()"><code class="function">dee_result_set_next()</code></a> will succeed.
178
 
</p>
179
 
<div class="variablelist"><table border="0">
180
 
<col align="left" valign="top">
181
 
<tbody>
182
 
<tr>
183
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
184
 
<td>The <a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> to check</td>
185
 
</tr>
186
 
<tr>
187
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
188
 
<td>
189
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if and only if more rows can be retrieved by calling
190
 
<a class="link" href="DeeResultSet.html#dee-result-set-next" title="dee_result_set_next ()"><code class="function">dee_result_set_next()</code></a>
191
 
</td>
192
 
</tr>
193
 
</tbody>
194
 
</table></div>
195
 
</div>
196
 
<hr>
197
 
<div class="refsect2">
198
 
<a name="dee-result-set-next"></a><h3>dee_result_set_next ()</h3>
199
 
<pre class="programlisting"><a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *      dee_result_set_next                 (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);</pre>
200
 
<p>
201
 
Get the current row from the result set and advance the cursor.
202
 
To ensure that calls to this method will succeed you can call
203
 
<a class="link" href="DeeResultSet.html#dee-result-set-has-next" title="dee_result_set_has_next ()"><code class="function">dee_result_set_has_next()</code></a>.
204
 
</p>
205
 
<p>
206
 
To retrieve the current row without advancing the cursor call
207
 
<a class="link" href="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.
208
 
</p>
209
 
<div class="variablelist"><table border="0">
210
 
<col align="left" valign="top">
211
 
<tbody>
212
 
<tr>
213
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
214
 
<td>The <a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> to get a row from</td>
215
 
</tr>
216
 
<tr>
217
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
218
 
<td>The <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> at the current cursor position. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
219
 
</td>
220
 
</tr>
221
 
</tbody>
222
 
</table></div>
223
 
</div>
224
 
<hr>
225
 
<div class="refsect2">
226
 
<a name="dee-result-set-peek"></a><h3>dee_result_set_peek ()</h3>
227
 
<pre class="programlisting"><a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *      dee_result_set_peek                 (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);</pre>
228
 
<p>
229
 
Get the row at the current cursor position.
230
 
</p>
231
 
<p>
232
 
To retrieve the current row and advance the cursor position call
233
 
<a class="link" href="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.
234
 
</p>
235
 
<div class="variablelist"><table border="0">
236
 
<col align="left" valign="top">
237
 
<tbody>
238
 
<tr>
239
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
240
 
<td>The <a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> to get a row from</td>
241
 
</tr>
242
 
<tr>
243
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
244
 
<td>The <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> at the current cursor position. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
245
 
</td>
246
 
</tr>
247
 
</tbody>
248
 
</table></div>
249
 
</div>
250
 
<hr>
251
 
<div class="refsect2">
252
 
<a name="dee-result-set-seek"></a><h3>dee_result_set_seek ()</h3>
253
 
<pre class="programlisting"><span class="returnvalue">void</span>                dee_result_set_seek                 (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>,
254
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> pos</code></em>);</pre>
255
 
<p>
256
 
Set the cursor position. Following calls to <a class="link" href="DeeResultSet.html#dee-result-set-peek" title="dee_result_set_peek ()"><code class="function">dee_result_set_peek()</code></a>
257
 
or <a class="link" href="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>.
258
 
</p>
259
 
<div class="variablelist"><table border="0">
260
 
<col align="left" valign="top">
261
 
<tbody>
262
 
<tr>
263
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
264
 
<td>The <a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> to seek in</td>
265
 
</tr>
266
 
<tr>
267
 
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
268
 
<td>The position to seek to</td>
269
 
</tr>
270
 
</tbody>
271
 
</table></div>
272
 
</div>
273
 
<hr>
274
 
<div class="refsect2">
275
 
<a name="dee-result-set-tell"></a><h3>dee_result_set_tell ()</h3>
276
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               dee_result_set_tell                 (<em class="parameter"><code><a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> *self</code></em>);</pre>
277
 
<p>
278
 
Get the current position of the cursor.
279
 
</p>
280
 
<div class="variablelist"><table border="0">
281
 
<col align="left" valign="top">
282
 
<tbody>
283
 
<tr>
284
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
285
 
<td>The <a class="link" href="DeeResultSet.html" title="DeeResultSet"><span class="type">DeeResultSet</span></a> to check the cursor position for</td>
286
 
</tr>
287
 
<tr>
288
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
289
 
<td>The current position of the cursor</td>
290
 
</tr>
291
 
</tbody>
292
 
</table></div>
293
 
</div>
294
 
</div>
295
 
</div>
296
 
<div class="footer">
297
 
<hr>
298
 
          Generated by GTK-Doc V1.18</div>
299
 
</body>
300
 
</html>
 
 
b'\\ No newline at end of file'