1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>ZeitgeistResultSet</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
<link rel="home" href="index.html" title="API Documentation for the Zeitgeist Client Library">
8
<link rel="up" href="ch01.html" title="Classes">
9
<link rel="prev" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor">
10
<link rel="next" href="ZeitgeistSubject.html" title="ZeitgeistSubject">
11
<meta name="generator" content="GTK-Doc V1.16 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
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">
17
<td><a accesskey="p" href="ZeitgeistMonitor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="ch01.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">API Documentation for the Zeitgeist Client Library</th>
21
<td><a accesskey="n" href="ZeitgeistSubject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#ZeitgeistResultSet.synopsis" class="shortcut">Top</a>
26
<a href="#ZeitgeistResultSet.description" class="shortcut">Description</a>
28
<a href="#ZeitgeistResultSet.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#ZeitgeistResultSet.prerequisites" class="shortcut">Prerequisites</a>
33
<div class="refentry">
34
<a name="ZeitgeistResultSet"></a><div class="titlepage"></div>
35
<div class="refnamediv"><table width="100%"><tr>
37
<h2><span class="refentrytitle"><a name="ZeitgeistResultSet.top_of_page"></a>ZeitgeistResultSet</span></h2>
38
<p>ZeitgeistResultSet — Cursor-like interface for results sets</p>
40
<td valign="top" align="right"></td>
42
<div class="refsynopsisdiv">
43
<a name="ZeitgeistResultSet.synopsis"></a><h2>Synopsis</h2>
44
<pre class="synopsis">
45
#include <zeitgeist.h>
47
struct <a class="link" href="ZeitgeistResultSet.html#ZeitgeistResultSetIface" title="struct ZeitgeistResultSetIface">ZeitgeistResultSetIface</a>;
48
<a class="link" href="ZeitgeistResultSet.html#ZeitgeistResultSet-struct" title="ZeitgeistResultSet">ZeitgeistResultSet</a>;
49
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-size" title="zeitgeist_result_set_size ()">zeitgeist_result_set_size</a> (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>);
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-estimated-matches" title="zeitgeist_result_set_estimated_matches ()">zeitgeist_result_set_estimated_matches</a>
51
(<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>);
52
<a class="link" href="ZeitgeistEvent.html" title="ZeitgeistEvent"><span class="returnvalue">ZeitgeistEvent</span></a> * <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-next" title="zeitgeist_result_set_next ()">zeitgeist_result_set_next</a> (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</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="ZeitgeistResultSet.html#zeitgeist-result-set-has-next" title="zeitgeist_result_set_has_next ()">zeitgeist_result_set_has_next</a> (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>);
54
<a class="link" href="ZeitgeistEvent.html" title="ZeitgeistEvent"><span class="returnvalue">ZeitgeistEvent</span></a> * <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-peek" title="zeitgeist_result_set_peek ()">zeitgeist_result_set_peek</a> (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>);
55
<span class="returnvalue">void</span> <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-seek" title="zeitgeist_result_set_seek ()">zeitgeist_result_set_seek</a> (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>,
56
<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>);
57
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-tell" title="zeitgeist_result_set_tell ()">zeitgeist_result_set_tell</a> (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>);
60
<div class="refsect1">
61
<a name="ZeitgeistResultSet.object-hierarchy"></a><h2>Object Hierarchy</h2>
62
<pre class="synopsis">
64
+----ZeitgeistResultSet
67
<div class="refsect1">
68
<a name="ZeitgeistResultSet.prerequisites"></a><h2>Prerequisites</h2>
70
ZeitgeistResultSet requires
71
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
73
<div class="refsect1">
74
<a name="ZeitgeistResultSet.description"></a><h2>Description</h2>
76
Interface for results returned by <a class="link" href="ZeitgeistLog.html#zeitgeist-log-find-events" title="zeitgeist_log_find_events ()"><code class="function">zeitgeist_log_find_events()</code></a>,
77
<a class="link" href="ZeitgeistLog.html#zeitgeist-log-get-events" title="zeitgeist_log_get_events ()"><code class="function">zeitgeist_log_get_events()</code></a>, and <a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search" title="zeitgeist_index_search ()"><code class="function">zeitgeist_index_search()</code></a>.
80
This interface utilizes a cursor-like metaphor. You advance the cursor
81
by calling <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-next" title="zeitgeist_result_set_next ()"><code class="function">zeitgeist_result_set_next()</code></a> or adjust it manually by calling
82
<a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-seek" title="zeitgeist_result_set_seek ()"><code class="function">zeitgeist_result_set_seek()</code></a>.
85
Calling <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-next" title="zeitgeist_result_set_next ()"><code class="function">zeitgeist_result_set_next()</code></a> will also return the event at the
86
current cursor position. You may retrieve the current event without advancing
87
the cursor by calling <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-peek" title="zeitgeist_result_set_peek ()"><code class="function">zeitgeist_result_set_peek()</code></a>.
90
<div class="refsect1">
91
<a name="ZeitgeistResultSet.details"></a><h2>Details</h2>
92
<div class="refsect2">
93
<a name="ZeitgeistResultSetIface"></a><h3>struct ZeitgeistResultSetIface</h3>
94
<pre class="programlisting">struct ZeitgeistResultSetIface {
95
GTypeInterface g_iface;
97
guint (*size) (ZeitgeistResultSet *self);
99
guint (*estimated_matches) (ZeitgeistResultSet *self);
101
ZeitgeistEvent* (*next) (ZeitgeistResultSet *self);
103
gboolean (*has_next) (ZeitgeistResultSet *self);
105
ZeitgeistEvent* (*peek) (ZeitgeistResultSet *self);
107
void (*seek) (ZeitgeistResultSet *self,
110
guint (*tell) (ZeitgeistResultSet *self);
117
<div class="refsect2">
118
<a name="ZeitgeistResultSet-struct"></a><h3>ZeitgeistResultSet</h3>
119
<pre class="programlisting">typedef struct _ZeitgeistResultSet ZeitgeistResultSet;</pre>
124
<div class="refsect2">
125
<a name="zeitgeist-result-set-size"></a><h3>zeitgeist_result_set_size ()</h3>
126
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> zeitgeist_result_set_size (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>);</pre>
128
Get the number of <a class="link" href="ZeitgeistEvent.html" title="ZeitgeistEvent"><span class="type">ZeitgeistEvent</span></a>s held in a <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a>.
129
Unlike the number obtained from <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-estimated-matches" title="zeitgeist_result_set_estimated_matches ()"><code class="function">zeitgeist_result_set_estimated_matches()</code></a> the
130
size of the result set is always equal to the number of times you can call
131
<a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-next" title="zeitgeist_result_set_next ()"><code class="function">zeitgeist_result_set_next()</code></a>.
133
<div class="variablelist"><table border="0">
134
<col align="left" valign="top">
137
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
138
<td>The <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> to get the size of</td>
141
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
142
<td>The number of events held in the result set</td>
148
<div class="refsect2">
149
<a name="zeitgeist-result-set-estimated-matches"></a><h3>zeitgeist_result_set_estimated_matches ()</h3>
150
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> zeitgeist_result_set_estimated_matches
151
(<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>);</pre>
153
Get an estimated total number of matches that would have been for the query
154
that generated the result set had it not been restricted in size.
157
For <a class="link" href="ZeitgeistLog.html#zeitgeist-log-find-events" title="zeitgeist_log_find_events ()"><code class="function">zeitgeist_log_find_events()</code></a> and <a class="link" href="ZeitgeistLog.html#zeitgeist-log-get-events" title="zeitgeist_log_get_events ()"><code class="function">zeitgeist_log_get_events()</code></a> this will
158
always be the same as <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-size" title="zeitgeist_result_set_size ()"><code class="function">zeitgeist_result_set_size()</code></a>. For cases like
159
<a class="link" href="ZeitgeistIndex.html#zeitgeist-index-search" title="zeitgeist_index_search ()"><code class="function">zeitgeist_index_search()</code></a> where you specify a subset of the hits to retrieve
160
the estimated match count will often be bigger than the result set size.
162
<div class="variablelist"><table border="0">
163
<col align="left" valign="top">
166
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
167
<td>The <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> to get the number of estimated matches on</td>
170
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
171
<td>The number of events that matched the query</td>
177
<div class="refsect2">
178
<a name="zeitgeist-result-set-next"></a><h3>zeitgeist_result_set_next ()</h3>
179
<pre class="programlisting"><a class="link" href="ZeitgeistEvent.html" title="ZeitgeistEvent"><span class="returnvalue">ZeitgeistEvent</span></a> * zeitgeist_result_set_next (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>);</pre>
181
Get the current event from the result set and advance the cursor.
182
To ensure that calls to this method will succeed you can call
183
<a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-has-next" title="zeitgeist_result_set_has_next ()"><code class="function">zeitgeist_result_set_has_next()</code></a>.
186
To retrieve the current event without advancing the cursor call
187
<a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-peek" title="zeitgeist_result_set_peek ()"><code class="function">zeitgeist_result_set_peek()</code></a> in stead of this method.
189
<div class="variablelist"><table border="0">
190
<col align="left" valign="top">
193
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
194
<td>The <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> to get an event from</td>
197
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
198
<td>The <a class="link" href="ZeitgeistEvent.html" title="ZeitgeistEvent"><span class="type">ZeitgeistEvent</span></a> at the current cursor position</td>
204
<div class="refsect2">
205
<a name="zeitgeist-result-set-has-next"></a><h3>zeitgeist_result_set_has_next ()</h3>
206
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> zeitgeist_result_set_has_next (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>);</pre>
208
Check if a call to <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-next" title="zeitgeist_result_set_next ()"><code class="function">zeitgeist_result_set_next()</code></a> will succeed.
210
<div class="variablelist"><table border="0">
211
<col align="left" valign="top">
214
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
215
<td>The <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> to check</td>
218
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
220
<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 events can be retrieved by calling
221
<a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-next" title="zeitgeist_result_set_next ()"><code class="function">zeitgeist_result_set_next()</code></a>
228
<div class="refsect2">
229
<a name="zeitgeist-result-set-peek"></a><h3>zeitgeist_result_set_peek ()</h3>
230
<pre class="programlisting"><a class="link" href="ZeitgeistEvent.html" title="ZeitgeistEvent"><span class="returnvalue">ZeitgeistEvent</span></a> * zeitgeist_result_set_peek (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>);</pre>
232
Get the event at the current cursor position.
235
To retrieve the current event and advance the cursor position call
236
<a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-next" title="zeitgeist_result_set_next ()"><code class="function">zeitgeist_result_set_next()</code></a> in stead of this method.
238
<div class="variablelist"><table border="0">
239
<col align="left" valign="top">
242
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
243
<td>The <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> to get an event from</td>
246
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
247
<td>The <a class="link" href="ZeitgeistEvent.html" title="ZeitgeistEvent"><span class="type">ZeitgeistEvent</span></a> at the current cursor position</td>
253
<div class="refsect2">
254
<a name="zeitgeist-result-set-seek"></a><h3>zeitgeist_result_set_seek ()</h3>
255
<pre class="programlisting"><span class="returnvalue">void</span> zeitgeist_result_set_seek (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>,
256
<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>
258
Set the cursor position. Following calls to <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-peek" title="zeitgeist_result_set_peek ()"><code class="function">zeitgeist_result_set_peek()</code></a>
259
or <a class="link" href="ZeitgeistResultSet.html#zeitgeist-result-set-next" title="zeitgeist_result_set_next ()"><code class="function">zeitgeist_result_set_next()</code></a> will read the event at position <em class="parameter"><code>pos</code></em>.
261
<div class="variablelist"><table border="0">
262
<col align="left" valign="top">
265
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
266
<td>The <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> to seek in</td>
269
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
270
<td>The position to seek to</td>
276
<div class="refsect2">
277
<a name="zeitgeist-result-set-tell"></a><h3>zeitgeist_result_set_tell ()</h3>
278
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> zeitgeist_result_set_tell (<em class="parameter"><code><a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *self</code></em>);</pre>
280
Get the current position of the cursor.
282
<div class="variablelist"><table border="0">
283
<col align="left" valign="top">
286
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
287
<td>The <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> to check the cursor position for</td>
290
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
291
<td>The current position of the cursor</td>
300
Generated by GTK-Doc V1.16</div>
b'\\ No newline at end of file'