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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBQueryCreator</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch07.html" title="Widgets">
<link rel="prev" href="RBPropertyView.html" title="RBPropertyView">
<link rel="next" href="rhythmbox-rb-rating-helper.html" title="rb-rating-helper">
<meta name="generator" content="GTK-Doc V1.18 (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="RBPropertyView.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch07.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">Rhythmbox Development Reference Manual</th>
<td><a accesskey="n" href="rhythmbox-rb-rating-helper.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#RBQueryCreator.synopsis" class="shortcut">Top</a>
|
<a href="#RBQueryCreator.description" class="shortcut">Description</a>
|
<a href="#RBQueryCreator.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#RBQueryCreator.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#RBQueryCreator.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="RBQueryCreator"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBQueryCreator.top_of_page"></a>RBQueryCreator</span></h2>
<p>RBQueryCreator — database query creator widget</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="RBQueryCreator.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="RBQueryCreator.html#RBQueryCreator-struct" title="struct RBQueryCreator">RBQueryCreator</a>;
struct <a class="link" href="RBQueryCreator.html#RBQueryCreatorClass" title="struct RBQueryCreatorClass">RBQueryCreatorClass</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="RBQueryCreator.html#rb-query-creator-new" title="rb_query_creator_new ()">rb_query_creator_new</a> (<em class="parameter"><code><a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> *db</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="RBQueryCreator.html#rb-query-creator-new-from-query" title="rb_query_creator_new_from_query ()">rb_query_creator_new_from_query</a> (<em class="parameter"><code><a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> *db</code></em>,
<em class="parameter"><code><span class="type">GPtrArray</span> *query</code></em>,
<em class="parameter"><code><a class="link" href="RhythmDBQueryModel.html#RhythmDBQueryModelLimitType"><span class="type">RhythmDBQueryModelLimitType</span></a> limit_type</code></em>,
<em class="parameter"><code><span class="type">GValueArray</span> *limit_value</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *sort_column</code></em>,
<em class="parameter"><code><span class="type">gint</span> sort_direction</code></em>);
<span class="returnvalue">GPtrArray</span> * <a class="link" href="RBQueryCreator.html#rb-query-creator-get-query" title="rb_query_creator_get_query ()">rb_query_creator_get_query</a> (<em class="parameter"><code><a class="link" href="RBQueryCreator.html" title="RBQueryCreator"><span class="type">RBQueryCreator</span></a> *creator</code></em>);
<span class="returnvalue">void</span> <a class="link" href="RBQueryCreator.html#rb-query-creator-get-limit" title="rb_query_creator_get_limit ()">rb_query_creator_get_limit</a> (<em class="parameter"><code><a class="link" href="RBQueryCreator.html" title="RBQueryCreator"><span class="type">RBQueryCreator</span></a> *creator</code></em>,
<em class="parameter"><code><a class="link" href="RhythmDBQueryModel.html#RhythmDBQueryModelLimitType"><span class="type">RhythmDBQueryModelLimitType</span></a> *type</code></em>,
<em class="parameter"><code><span class="type">GValueArray</span> **limit</code></em>);
<span class="returnvalue">void</span> <a class="link" href="RBQueryCreator.html#rb-query-creator-get-sort-order" title="rb_query_creator_get_sort_order ()">rb_query_creator_get_sort_order</a> (<em class="parameter"><code><a class="link" href="RBQueryCreator.html" title="RBQueryCreator"><span class="type">RBQueryCreator</span></a> *creator</code></em>,
<em class="parameter"><code>const <span class="type">char</span> **sort_key</code></em>,
<em class="parameter"><code><span class="type">gint</span> *sort_direction</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="RBQueryCreator.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkWidget
+----GtkContainer
+----GtkBin
+----GtkWindow
+----GtkDialog
+----RBQueryCreator
</pre>
</div>
<div class="refsect1">
<a name="RBQueryCreator.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
RBQueryCreator implements
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1">
<a name="RBQueryCreator.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="RBQueryCreator.html#RBQueryCreator--creating" title='The "creating" property'>creating</a>" <span class="type">gboolean</span> : Read / Write / Construct Only
"<a class="link" href="RBQueryCreator.html#RBQueryCreator--db" title='The "db" property'>db</a>" <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="RBQueryCreator.description"></a><h2>Description</h2>
<p>
The query creator is used to create and edit automatic playlists.
It is only capable of constructing queries that consist of a flat
list of criteria. It cannot nested criteria or represent full
boolean logic expressions.
</p>
<p>
In addition to query criteria, the query creator also allows the user
to specify limits on the size of the result set, in terms of the number
of entries, the total duration, or the total file size; and also the
order in which the results are to be sorted.
</p>
<p>
The structure of the query creator is defined in the builder file
create-playlist.ui.
</p>
</div>
<div class="refsect1">
<a name="RBQueryCreator.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="RBQueryCreator-struct"></a><h3>struct RBQueryCreator</h3>
<pre class="programlisting">struct RBQueryCreator;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBQueryCreatorClass"></a><h3>struct RBQueryCreatorClass</h3>
<pre class="programlisting">struct RBQueryCreatorClass {
GtkDialogClass parent_class;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-query-creator-new"></a><h3>rb_query_creator_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * rb_query_creator_new (<em class="parameter"><code><a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> *db</code></em>);</pre>
<p>
Creates a new query creator widget.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>db</code></em> :</span></p></td>
<td>the <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>new query creator widget</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-query-creator-new-from-query"></a><h3>rb_query_creator_new_from_query ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * rb_query_creator_new_from_query (<em class="parameter"><code><a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> *db</code></em>,
<em class="parameter"><code><span class="type">GPtrArray</span> *query</code></em>,
<em class="parameter"><code><a class="link" href="RhythmDBQueryModel.html#RhythmDBQueryModelLimitType"><span class="type">RhythmDBQueryModelLimitType</span></a> limit_type</code></em>,
<em class="parameter"><code><span class="type">GValueArray</span> *limit_value</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *sort_column</code></em>,
<em class="parameter"><code><span class="type">gint</span> sort_direction</code></em>);</pre>
<p>
Constructs a new query creator with an existing query and limit and sort
settings.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>db</code></em> :</span></p></td>
<td>the <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
<td>an existing query to start from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>limit_type</code></em> :</span></p></td>
<td>the type of result set limit</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>limit_value</code></em> :</span></p></td>
<td>the result set limit value</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sort_column</code></em> :</span></p></td>
<td>the column on which to sort query results</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sort_direction</code></em> :</span></p></td>
<td>the direction in which to sort query results</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>new query creator widget</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-query-creator-get-query"></a><h3>rb_query_creator_get_query ()</h3>
<pre class="programlisting"><span class="returnvalue">GPtrArray</span> * rb_query_creator_get_query (<em class="parameter"><code><a class="link" href="RBQueryCreator.html" title="RBQueryCreator"><span class="type">RBQueryCreator</span></a> *creator</code></em>);</pre>
<p>
Constructs a database query that represents the criteria in the query creator.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>creator</code></em> :</span></p></td>
<td>
<a class="link" href="RBQueryCreator.html" title="RBQueryCreator"><span class="type">RBQueryCreator</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>database query array. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-query-creator-get-limit"></a><h3>rb_query_creator_get_limit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_query_creator_get_limit (<em class="parameter"><code><a class="link" href="RBQueryCreator.html" title="RBQueryCreator"><span class="type">RBQueryCreator</span></a> *creator</code></em>,
<em class="parameter"><code><a class="link" href="RhythmDBQueryModel.html#RhythmDBQueryModelLimitType"><span class="type">RhythmDBQueryModelLimitType</span></a> *type</code></em>,
<em class="parameter"><code><span class="type">GValueArray</span> **limit</code></em>);</pre>
<p>
Retrieves the limit type and value from the query creator.
The limit value is returned as the first element in a
<span class="type">GValueArray</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>creator</code></em> :</span></p></td>
<td>
<a class="link" href="RBQueryCreator.html" title="RBQueryCreator"><span class="type">RBQueryCreator</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>used to return the limit type. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>limit</code></em> :</span></p></td>
<td>used to return the limit value. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-query-creator-get-sort-order"></a><h3>rb_query_creator_get_sort_order ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_query_creator_get_sort_order (<em class="parameter"><code><a class="link" href="RBQueryCreator.html" title="RBQueryCreator"><span class="type">RBQueryCreator</span></a> *creator</code></em>,
<em class="parameter"><code>const <span class="type">char</span> **sort_key</code></em>,
<em class="parameter"><code><span class="type">gint</span> *sort_direction</code></em>);</pre>
<p>
Retrieves the sort settings from the query creator.
The sort direction is returned as a <span class="type">GtkSortType</span> value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>creator</code></em> :</span></p></td>
<td>
<a class="link" href="RBQueryCreator.html" title="RBQueryCreator"><span class="type">RBQueryCreator</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sort_key</code></em> :</span></p></td>
<td>returns the sort key name. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sort_direction</code></em> :</span></p></td>
<td>returns the sort direction. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="RBQueryCreator.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="RBQueryCreator--creating"></a><h3>The <code class="literal">"creating"</code> property</h3>
<pre class="programlisting"> "creating" <span class="type">gboolean</span> : Read / Write / Construct Only</pre>
<p>
TRUE if a new playlist is being created.
</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="RBQueryCreator--db"></a><h3>The <code class="literal">"db"</code> property</h3>
<pre class="programlisting"> "db" <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a>* : Read / Write / Construct Only</pre>
<p>
The <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> instance
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
