rhythmbox-doc 3.0.2-0ubuntu1 / usr / share / gtk-doc / html / rhythmbox / RhythmDBQueryResults.html

This file is indexed.

/usr/share/gtk-doc/html/rhythmbox/RhythmDBQueryResults.html is in rhythmbox-doc 3.0.2-0ubuntu1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Rhythmbox Development Reference Manual: RhythmDBQueryResults</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch04.html" title="RhythmDB">
<link rel="prev" href="RhythmDBQueryModel.html" title="RhythmDBQueryModel">
<link rel="next" href="RhythmDB.html" title="RhythmDB">
<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="#RhythmDBQueryResults.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#RhythmDBQueryResults.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations"> <span class="dim">|</span> 
                  <a href="#RhythmDBQueryResults.implementations" class="shortcut">Known Implementations</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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="RhythmDBQueryModel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="RhythmDB.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="RhythmDBQueryResults"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RhythmDBQueryResults.top_of_page"></a>RhythmDBQueryResults</span></h2>
<p>RhythmDBQueryResults — interface for receiving query results from RhythmDB</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="RhythmDBQueryResults.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">void</span>
</td>
<td class="function_name">
<a class="link" href="RhythmDBQueryResults.html#rhythmdb-query-results-set-query" title="rhythmdb_query_results_set_query ()">rhythmdb_query_results_set_query</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="RhythmDBQueryResults.html#rhythmdb-query-results-add-results" title="rhythmdb_query_results_add_results ()">rhythmdb_query_results_add_results</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="RhythmDBQueryResults.html#rhythmdb-query-results-query-complete" title="rhythmdb_query_results_query_complete ()">rhythmdb_query_results_query_complete</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RhythmDBQueryResults.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"> </td>
<td class="function_name"><a class="link" href="RhythmDBQueryResults.html#RhythmDBQueryResults-struct" title="RhythmDBQueryResults">RhythmDBQueryResults</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RhythmDBQueryResults.html#RhythmDBQueryResultsIface" title="struct RhythmDBQueryResultsIface">RhythmDBQueryResultsIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RhythmDBQueryResults.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GInterface
    <span class="lineart">╰──</span> RhythmDBQueryResults
</pre>
</div>
<div class="refsect1">
<a name="RhythmDBQueryResults.implementations"></a><h2>Known Implementations</h2>
<p>
RhythmDBQueryResults is implemented by
 <a class="link" href="RhythmDBQueryModel.html" title="RhythmDBQueryModel">RhythmDBQueryModel</a>.</p>
</div>
<div class="refsect1">
<a name="RhythmDBQueryResults.description"></a><h2>Description</h2>
<p>This is the interface that <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> uses to report results of database
queries.  When running a query, it first calls rhythmdb_query_results_set_query,
then passes entries matching the query to rhythmdb_query_results_add_results
in batches, and finally calls rhythmdb_query_results_query_complete.
There are no guarantees as to which threads the calls are made from.</p>
</div>
<div class="refsect1">
<a name="RhythmDBQueryResults.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rhythmdb-query-results-set-query"></a><h3>rhythmdb_query_results_set_query ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rhythmdb_query_results_set_query (<em class="parameter"><code><a class="link" href="RhythmDBQueryResults.html" title="RhythmDBQueryResults"><span class="type">RhythmDBQueryResults</span></a> *results</code></em>,
                                  <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *query</code></em>);</pre>
<p>When a new query is run, this method is invoked to give the
object implementing this interface a chance to take a copy of the
query criteria, so that it can evaluate the query for newly added
or changed entries once the query is complete.</p>
<div class="refsect3">
<a name="id-1.5.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>results</p></td>
<td class="parameter_description"><p>the <a class="link" href="RhythmDBQueryResults.html" title="RhythmDBQueryResults"><span class="type">RhythmDBQueryResults</span></a> implementation</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>query</p></td>
<td class="parameter_description"><p>the new query</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-query-results-add-results"></a><h3>rhythmdb_query_results_add_results ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rhythmdb_query_results_add_results (<em class="parameter"><code><a class="link" href="RhythmDBQueryResults.html" title="RhythmDBQueryResults"><span class="type">RhythmDBQueryResults</span></a> *results</code></em>,
                                    <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *entries</code></em>);</pre>
<p>Provides a new set of query results.  References must be taken on the
entries.</p>
<div class="refsect3">
<a name="id-1.5.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>results</p></td>
<td class="parameter_description"><p>the <a class="link" href="RhythmDBQueryResults.html" title="RhythmDBQueryResults"><span class="type">RhythmDBQueryResults</span></a> implementation</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entries</p></td>
<td class="parameter_description"><p> <a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing <span class="type">RhythmDBEntry</span> results. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> RB.RhythmDBEntry]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-query-results-query-complete"></a><h3>rhythmdb_query_results_query_complete ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rhythmdb_query_results_query_complete (<em class="parameter"><code><a class="link" href="RhythmDBQueryResults.html" title="RhythmDBQueryResults"><span class="type">RhythmDBQueryResults</span></a> *results</code></em>);</pre>
<p>Called when the query is complete and all entries that match the query
have been supplied to rhythmdb_query_results_add_results.  If the object
implementing this interface needs to identify newly added or changed entries
that match the query, it needs to use the entry-added, entry-deleted and
entry-changed signals from <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a>.</p>
<div class="refsect3">
<a name="id-1.5.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>results</p></td>
<td class="parameter_description"><p>the <a class="link" href="RhythmDBQueryResults.html" title="RhythmDBQueryResults"><span class="type">RhythmDBQueryResults</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="RhythmDBQueryResults.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RhythmDBQueryResults-struct"></a><h3>RhythmDBQueryResults</h3>
<pre class="programlisting">typedef struct _RhythmDBQueryResults RhythmDBQueryResults;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RhythmDBQueryResultsIface"></a><h3>struct RhythmDBQueryResultsIface</h3>
<pre class="programlisting">struct RhythmDBQueryResultsIface {
	GTypeInterface g_iface;

	/* vtable */
	void (*set_query)		(RhythmDBQueryResults *results,
				 	 GPtrArray *query);

	void (*add_results)		(RhythmDBQueryResults *results,
				 	 GPtrArray *entries);

	void 	(*query_complete) (RhythmDBQueryResults *results);
};
</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.