~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libebook/html/libebook-e-book-query.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>e-book-query</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Address Book Client (libebook)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Address Book Client (libebook)">
9
 
<link rel="prev" href="EBookListener.html" title="EBookListener">
 
9
<link rel="prev" href="EBook.html" title="EBook">
10
10
<link rel="next" href="libebook-e-book-types.html" title="e-book-types">
11
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
16
<tr valign="middle">
17
 
<td><a accesskey="p" href="EBookListener.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
17
<td><a accesskey="p" href="EBook.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
20
<th width="100%" align="center">Evolution-Data-Server Manual: Address Book Client (libebook)</th>
26
26
                  <a href="#libebook-e-book-query.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="e-book-query">
30
30
<a name="libebook-e-book-query"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="libebook-e-book-query.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">typedef             <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery">EBookQuery</a>;
41
41
enum                <a class="link" href="libebook-e-book-query.html#EBookQueryTest" title="enum EBookQueryTest">EBookQueryTest</a>;
67
67
<a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         <a class="link" href="libebook-e-book-query.html#e-book-query-copy" title="e_book_query_copy ()">e_book_query_copy</a>                   (<em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> *q</code></em>);
68
68
</pre>
69
69
</div>
70
 
<div class="refsect1" lang="en">
 
70
<div class="refsect1" title="Description">
71
71
<a name="libebook-e-book-query.description"></a><h2>Description</h2>
72
72
<p>
73
73
</p>
74
74
</div>
75
 
<div class="refsect1" lang="en">
 
75
<div class="refsect1" title="Details">
76
76
<a name="libebook-e-book-query.details"></a><h2>Details</h2>
77
 
<div class="refsect2" lang="en">
 
77
<div class="refsect2" title="EBookQuery">
78
78
<a name="EBookQuery"></a><h3>EBookQuery</h3>
79
79
<pre class="programlisting">typedef struct EBookQuery EBookQuery;
80
80
</pre>
82
82
</p>
83
83
</div>
84
84
<hr>
85
 
<div class="refsect2" lang="en">
 
85
<div class="refsect2" title="enum EBookQueryTest">
86
86
<a name="EBookQueryTest"></a><h3>enum EBookQueryTest</h3>
87
87
<pre class="programlisting">typedef enum {
88
88
  E_BOOK_QUERY_IS,
105
105
</p>
106
106
</div>
107
107
<hr>
108
 
<div class="refsect2" lang="en">
 
108
<div class="refsect2" title="e_book_query_from_string ()">
109
109
<a name="e-book-query-from-string"></a><h3>e_book_query_from_string ()</h3>
110
110
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_from_string            (<em class="parameter"><code>const <span class="type">gchar</span> *query_string</code></em>);</pre>
111
111
<p>
112
 
Parse <em class="parameter"><code>query_string</code></em> and return a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> representing it.</p>
 
112
Parse <em class="parameter"><code>query_string</code></em> and return a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> representing it.
 
113
</p>
113
114
<div class="variablelist"><table border="0">
114
115
<col align="left" valign="top">
115
116
<tbody>
127
128
</table></div>
128
129
</div>
129
130
<hr>
130
 
<div class="refsect2" lang="en">
 
131
<div class="refsect2" title="e_book_query_to_string ()">
131
132
<a name="e-book-query-to-string"></a><h3>e_book_query_to_string ()</h3>
132
133
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_book_query_to_string              (<em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> *q</code></em>);</pre>
133
134
<p>
134
 
Return the string representation of <em class="parameter"><code>q</code></em>.</p>
 
135
Return the string representation of <em class="parameter"><code>q</code></em>.
 
136
</p>
135
137
<div class="variablelist"><table border="0">
136
138
<col align="left" valign="top">
137
139
<tbody>
150
152
</table></div>
151
153
</div>
152
154
<hr>
153
 
<div class="refsect2" lang="en">
 
155
<div class="refsect2" title="e_book_query_ref ()">
154
156
<a name="e-book-query-ref"></a><h3>e_book_query_ref ()</h3>
155
157
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_ref                    (<em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> *q</code></em>);</pre>
156
158
<p>
157
 
Increment the reference count on <em class="parameter"><code>q</code></em>.</p>
 
159
Increment the reference count on <em class="parameter"><code>q</code></em>.
 
160
</p>
158
161
<div class="variablelist"><table border="0">
159
162
<col align="left" valign="top">
160
163
<tbody>
172
175
</table></div>
173
176
</div>
174
177
<hr>
175
 
<div class="refsect2" lang="en">
 
178
<div class="refsect2" title="e_book_query_unref ()">
176
179
<a name="e-book-query-unref"></a><h3>e_book_query_unref ()</h3>
177
180
<pre class="programlisting"><span class="returnvalue">void</span>                e_book_query_unref                  (<em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> *q</code></em>);</pre>
178
181
<p>
179
182
Decrement the reference count on <em class="parameter"><code>q</code></em>. When the reference count reaches 0, <em class="parameter"><code>q</code></em>
180
 
will be freed and any child queries will have <a class="link" href="libebook-e-book-query.html#e-book-query-unref" title="e_book_query_unref ()"><code class="function">e_book_query_unref()</code></a> called.</p>
 
183
will be freed and any child queries will have <a class="link" href="libebook-e-book-query.html#e-book-query-unref" title="e_book_query_unref ()"><code class="function">e_book_query_unref()</code></a> called.
 
184
</p>
181
185
<div class="variablelist"><table border="0">
182
186
<col align="left" valign="top">
183
187
<tbody><tr>
188
192
</table></div>
189
193
</div>
190
194
<hr>
191
 
<div class="refsect2" lang="en">
 
195
<div class="refsect2" title="e_book_query_and ()">
192
196
<a name="e-book-query-and"></a><h3>e_book_query_and ()</h3>
193
197
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_and                    (<em class="parameter"><code><span class="type">gint</span> nqs</code></em>,
194
198
                                                         <em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> **qs</code></em>,
195
199
                                                         <em class="parameter"><code><span class="type">gboolean</span> unref</code></em>);</pre>
196
200
<p>
197
 
Create a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which is the logical AND of the queries in <span class="type">qs</span>.</p>
 
201
Create a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which is the logical AND of the queries in <span class="type">qs</span>.
 
202
</p>
198
203
<div class="variablelist"><table border="0">
199
204
<col align="left" valign="top">
200
205
<tbody>
222
227
</table></div>
223
228
</div>
224
229
<hr>
225
 
<div class="refsect2" lang="en">
 
230
<div class="refsect2" title="e_book_query_andv ()">
226
231
<a name="e-book-query-andv"></a><h3>e_book_query_andv ()</h3>
227
232
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_andv                   (<em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> *q</code></em>,
228
233
                                                         <em class="parameter"><code>...</code></em>);</pre>
229
234
<p>
230
 
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which is the logical AND of the queries specified.</p>
 
235
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which is the logical AND of the queries specified.
 
236
</p>
231
237
<div class="variablelist"><table border="0">
232
238
<col align="left" valign="top">
233
239
<tbody>
251
257
</table></div>
252
258
</div>
253
259
<hr>
254
 
<div class="refsect2" lang="en">
 
260
<div class="refsect2" title="e_book_query_or ()">
255
261
<a name="e-book-query-or"></a><h3>e_book_query_or ()</h3>
256
262
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_or                     (<em class="parameter"><code><span class="type">gint</span> nqs</code></em>,
257
263
                                                         <em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> **qs</code></em>,
258
264
                                                         <em class="parameter"><code><span class="type">gboolean</span> unref</code></em>);</pre>
259
265
<p>
260
 
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which is the logical OR of the queries in <span class="type">qs</span>.</p>
 
266
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which is the logical OR of the queries in <span class="type">qs</span>.
 
267
</p>
261
268
<div class="variablelist"><table border="0">
262
269
<col align="left" valign="top">
263
270
<tbody>
285
292
</table></div>
286
293
</div>
287
294
<hr>
288
 
<div class="refsect2" lang="en">
 
295
<div class="refsect2" title="e_book_query_orv ()">
289
296
<a name="e-book-query-orv"></a><h3>e_book_query_orv ()</h3>
290
297
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_orv                    (<em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> *q</code></em>,
291
298
                                                         <em class="parameter"><code>...</code></em>);</pre>
292
299
<p>
293
 
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which is the logical OR of the queries specified.</p>
 
300
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which is the logical OR of the queries specified.
 
301
</p>
294
302
<div class="variablelist"><table border="0">
295
303
<col align="left" valign="top">
296
304
<tbody>
314
322
</table></div>
315
323
</div>
316
324
<hr>
317
 
<div class="refsect2" lang="en">
 
325
<div class="refsect2" title="e_book_query_not ()">
318
326
<a name="e-book-query-not"></a><h3>e_book_query_not ()</h3>
319
327
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_not                    (<em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> *q</code></em>,
320
328
                                                         <em class="parameter"><code><span class="type">gboolean</span> unref</code></em>);</pre>
321
329
<p>
322
 
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which is the opposite of #q.</p>
 
330
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which is the opposite of #q.
 
331
</p>
323
332
<div class="variablelist"><table border="0">
324
333
<col align="left" valign="top">
325
334
<tbody>
342
351
</table></div>
343
352
</div>
344
353
<hr>
345
 
<div class="refsect2" lang="en">
 
354
<div class="refsect2" title="e_book_query_field_exists ()">
346
355
<a name="e-book-query-field-exists"></a><h3>e_book_query_field_exists ()</h3>
347
356
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_field_exists           (<em class="parameter"><code><a class="link" href="EContact.html#EContactField" title="enum EContactField"><span class="type">EContactField</span></a> field</code></em>);</pre>
348
357
<p>
349
 
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which tests if the field <em class="parameter"><code>field</code></em> exists.</p>
 
358
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which tests if the field <em class="parameter"><code>field</code></em> exists.
 
359
</p>
350
360
<div class="variablelist"><table border="0">
351
361
<col align="left" valign="top">
352
362
<tbody>
364
374
</table></div>
365
375
</div>
366
376
<hr>
367
 
<div class="refsect2" lang="en">
 
377
<div class="refsect2" title="e_book_query_vcard_field_exists ()">
368
378
<a name="e-book-query-vcard-field-exists"></a><h3>e_book_query_vcard_field_exists ()</h3>
369
379
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_vcard_field_exists     (<em class="parameter"><code>const <span class="type">gchar</span> *field</code></em>);</pre>
370
380
<p>
371
381
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which tests if the field <em class="parameter"><code>field</code></em> exists. <em class="parameter"><code>field</code></em>
372
 
should be a vCard field name, such as <span class="type">FN</span> or <span class="type">X-MSN</span>.</p>
 
382
should be a vCard field name, such as <span class="type">FN</span> or <span class="type">X-MSN</span>.
 
383
</p>
373
384
<div class="variablelist"><table border="0">
374
385
<col align="left" valign="top">
375
386
<tbody>
387
398
</table></div>
388
399
</div>
389
400
<hr>
390
 
<div class="refsect2" lang="en">
 
401
<div class="refsect2" title="e_book_query_field_test ()">
391
402
<a name="e-book-query-field-test"></a><h3>e_book_query_field_test ()</h3>
392
403
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_field_test             (<em class="parameter"><code><a class="link" href="EContact.html#EContactField" title="enum EContactField"><span class="type">EContactField</span></a> field</code></em>,
393
404
                                                         <em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQueryTest" title="enum EBookQueryTest"><span class="type">EBookQueryTest</span></a> test</code></em>,
394
405
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
395
406
<p>
396
 
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which tests <em class="parameter"><code>field</code></em> for <em class="parameter"><code>value</code></em> using the test <em class="parameter"><code>test</code></em>.</p>
 
407
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which tests <em class="parameter"><code>field</code></em> for <em class="parameter"><code>value</code></em> using the test <em class="parameter"><code>test</code></em>.
 
408
</p>
397
409
<div class="variablelist"><table border="0">
398
410
<col align="left" valign="top">
399
411
<tbody>
421
433
</table></div>
422
434
</div>
423
435
<hr>
424
 
<div class="refsect2" lang="en">
 
436
<div class="refsect2" title="e_book_query_vcard_field_test ()">
425
437
<a name="e-book-query-vcard-field-test"></a><h3>e_book_query_vcard_field_test ()</h3>
426
438
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_vcard_field_test       (<em class="parameter"><code>const <span class="type">gchar</span> *field</code></em>,
427
439
                                                         <em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQueryTest" title="enum EBookQueryTest"><span class="type">EBookQueryTest</span></a> test</code></em>,
428
440
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
429
441
<p>
430
 
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which tests <em class="parameter"><code>field</code></em> for <em class="parameter"><code>value</code></em> using the test <em class="parameter"><code>test</code></em>.</p>
 
442
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which tests <em class="parameter"><code>field</code></em> for <em class="parameter"><code>value</code></em> using the test <em class="parameter"><code>test</code></em>.
 
443
</p>
431
444
<div class="variablelist"><table border="0">
432
445
<col align="left" valign="top">
433
446
<tbody>
449
462
<tr>
450
463
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
451
464
<td> the new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a>
 
465
 
452
466
</td>
453
467
</tr>
454
468
</tbody>
455
469
</table></div>
 
470
<p class="since">Since 2.22</p>
456
471
</div>
457
472
<hr>
458
 
<div class="refsect2" lang="en">
 
473
<div class="refsect2" title="e_book_query_any_field_contains ()">
459
474
<a name="e-book-query-any-field-contains"></a><h3>e_book_query_any_field_contains ()</h3>
460
475
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_any_field_contains     (<em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
461
476
<p>
462
 
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which tests if any field contains <em class="parameter"><code>value</code></em>.</p>
 
477
Creates a new <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> which tests if any field contains <em class="parameter"><code>value</code></em>.
 
478
</p>
463
479
<div class="variablelist"><table border="0">
464
480
<col align="left" valign="top">
465
481
<tbody>
477
493
</table></div>
478
494
</div>
479
495
<hr>
480
 
<div class="refsect2" lang="en">
 
496
<div class="refsect2" title="e_book_query_copy ()">
481
497
<a name="e-book-query-copy"></a><h3>e_book_query_copy ()</h3>
482
498
<pre class="programlisting"><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="returnvalue">EBookQuery</span></a>*         e_book_query_copy                   (<em class="parameter"><code><a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a> *q</code></em>);</pre>
483
499
<p>