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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>e-book-query</title><meta name="generator" content="DocBook XSL Stylesheets V1.64.1"><link rel="home" href="index.html" title="Evolution API Reference: libebook, the Addressbook Library"><link rel="up" href="ch01.html" title="Evolution API Reference: libebook, the Addressbook Library"><link rel="previous" href="EBook.html" title="EBook"><link rel="next" href="EContact.html" title="EContact"><link rel="chapter" href="ch01.html" title="Evolution API Reference: libebook, the Addressbook Library"><link rel="refentry" href="EBook.html" title="EBook"><link rel="refentry" href="libebook-e-book-query.html" title="e-book-query"><link rel="refentry" href="EContact.html" title="EContact"><link rel="refentry" href="EVCard.html" title="EVCard"><link rel="refentry" href="EBookListener.html" title="EBookListener"><link rel="refentry" href="EBookView.html" title="EBookView"><link rel="refentry" href="EBookViewListener.html" title="EBookViewListener"><link rel="refentry" href="libebook-e-book-async.html" title="e-book-async"><link rel="refentry" href="libebook-e-book-types.html" title="e-book-types"><link rel="refentry" href="libebook-EAddressWestern.html" title="e-address-western"><link rel="refentry" href="libebook-ENameWestern.html" title="e-name-western"><link rel="section" href="libebook-e-book-query.html#id2508746" title="Description"><link rel="section" href="libebook-e-book-query.html#id2508755" title="Details"><meta name="generator" content="GTK-Doc V1.2 (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" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="EBook.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch01.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">Evolution API Reference: libebook, the Addressbook Library</th><td><a accesskey="n" href="EContact.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="libebook-e-book-query"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">e-book-query</span></h2><p>e-book-query — Handles queries of addressboook data.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
enum <a href="libebook-e-book-query.html#EBookQueryTest">EBookQueryTest</a>;
EBookQuery* <a href="libebook-e-book-query.html#e-book-query-from-string">e_book_query_from_string</a> (const char *query_string);
char* <a href="libebook-e-book-query.html#e-book-query-to-string">e_book_query_to_string</a> (EBookQuery *q);
EBookQuery* <a href="libebook-e-book-query.html#e-book-query-ref">e_book_query_ref</a> (EBookQuery *q);
void <a href="libebook-e-book-query.html#e-book-query-unref">e_book_query_unref</a> (EBookQuery *q);
EBookQuery* <a href="libebook-e-book-query.html#e-book-query-and">e_book_query_and</a> (int nqs,
EBookQuery **qs,
gboolean unref);
EBookQuery* <a href="libebook-e-book-query.html#e-book-query-andv">e_book_query_andv</a> (EBookQuery *q,
...);
EBookQuery* <a href="libebook-e-book-query.html#e-book-query-or">e_book_query_or</a> (int nqs,
EBookQuery **qs,
gboolean unref);
EBookQuery* <a href="libebook-e-book-query.html#e-book-query-orv">e_book_query_orv</a> (EBookQuery *q,
...);
EBookQuery* <a href="libebook-e-book-query.html#e-book-query-not">e_book_query_not</a> (EBookQuery *q,
gboolean unref);
EBookQuery* <a href="libebook-e-book-query.html#e-book-query-field-exists">e_book_query_field_exists</a> (<a href="EContact.html#EContactField">EContactField</a> field);
EBookQuery* <a href="libebook-e-book-query.html#e-book-query-field-test">e_book_query_field_test</a> (<a href="EContact.html#EContactField">EContactField</a> field,
<a href="libebook-e-book-query.html#EBookQueryTest">EBookQueryTest</a> test,
const char *value);
EBookQuery* <a href="libebook-e-book-query.html#e-book-query-any-field-contains">e_book_query_any_field_contains</a> (const char *value);
</pre></div><div class="refsect1" lang="en"><a name="id2508746"></a><h2>Description</h2><p>
</p></div><div class="refsect1" lang="en"><a name="id2508755"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2508760"></a><h3><a name="EBookQueryTest"></a>enum EBookQueryTest</h3><a class="indexterm" name="id2508769"></a><pre class="programlisting">typedef enum {
E_BOOK_QUERY_IS,
E_BOOK_QUERY_CONTAINS,
E_BOOK_QUERY_BEGINS_WITH,
E_BOOK_QUERY_ENDS_WITH,
/*
Consider these "coming soon".
E_BOOK_QUERY_LT,
E_BOOK_QUERY_LE,
E_BOOK_QUERY_GT,
E_BOOK_QUERY_GE,
E_BOOK_QUERY_EQ,
*/
} EBookQueryTest;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2508783"></a><h3><a name="e-book-query-from-string"></a>e_book_query_from_string ()</h3><a class="indexterm" name="id2508792"></a><pre class="programlisting">EBookQuery* e_book_query_from_string (const char *query_string);</pre><p>
Parse <i class="parameter"><tt>query_string</tt></i> and return a new <span class="type">EBookQuery</span> representing it.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>query_string</tt></i>:</span></td><td> the query
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the new <span class="type">EBookValue</span>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2508854"></a><h3><a name="e-book-query-to-string"></a>e_book_query_to_string ()</h3><a class="indexterm" name="id2508862"></a><pre class="programlisting">char* e_book_query_to_string (EBookQuery *q);</pre><p>
Return the string representation of <i class="parameter"><tt>q</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>q</tt></i>:</span></td><td> an <span class="type">EBookQuery</span>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The string form of the query. This string should be freed when
finished with.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2508920"></a><h3><a name="e-book-query-ref"></a>e_book_query_ref ()</h3><a class="indexterm" name="id2508928"></a><pre class="programlisting">EBookQuery* e_book_query_ref (EBookQuery *q);</pre><p>
Increment the reference count on <i class="parameter"><tt>q</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>q</tt></i>:</span></td><td> a <span class="type">EBookQuery</span>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <i class="parameter"><tt>q</tt></i>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2508987"></a><h3><a name="e-book-query-unref"></a>e_book_query_unref ()</h3><a class="indexterm" name="id2508996"></a><pre class="programlisting">void e_book_query_unref (EBookQuery *q);</pre><p>
Decrement the reference count on <i class="parameter"><tt>q</tt></i>. When the reference count reaches 0, <i class="parameter"><tt>q</tt></i>
will be freed and any child queries will have <a href="libebook-e-book-query.html#e-book-query-unref"><tt class="function">e_book_query_unref()</tt></a> called.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>q</tt></i>:</span></td><td> an <span class="type">EBookQuery</span>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2509055"></a><h3><a name="e-book-query-and"></a>e_book_query_and ()</h3><a class="indexterm" name="id2509063"></a><pre class="programlisting">EBookQuery* e_book_query_and (int nqs,
EBookQuery **qs,
gboolean unref);</pre><p>
Create a new <span class="type">EBookQuery</span> which is the logical AND of the queries in <span class="type">qs</span>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>nqs</tt></i>:</span></td><td> the number of queries to AND
</td></tr><tr><td><span class="term"><i class="parameter"><tt>qs</tt></i>:</span></td><td> pointer to an array of <span class="type">EBookQuery</span> items
</td></tr><tr><td><span class="term"><i class="parameter"><tt>unref</tt></i>:</span></td><td> if <span class="type">TRUE</span>, the new query takes ownership of the existing queries
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A new <span class="type">EBookQuery</span>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2509178"></a><h3><a name="e-book-query-andv"></a>e_book_query_andv ()</h3><a class="indexterm" name="id2509187"></a><pre class="programlisting">EBookQuery* e_book_query_andv (EBookQuery *q,
...);</pre><p>
Create a new <span class="type">EBookQuery</span> which is the logical AND of the queries specified.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>q</tt></i>:</span></td><td> first <span class="type">EBookQuery</span>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i>:</span></td><td> <span class="type">NULL</span> terminated list of <span class="type">EBookQuery</span> pointers
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A new <span class="type">EBookQuery</span>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2537640"></a><h3><a name="e-book-query-or"></a>e_book_query_or ()</h3><a class="indexterm" name="id2473203"></a><pre class="programlisting">EBookQuery* e_book_query_or (int nqs,
EBookQuery **qs,
gboolean unref);</pre><p>
Create a new <span class="type">EBookQuery</span> which is the logical OR of the queries in <span class="type">qs</span>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>nqs</tt></i>:</span></td><td> the number of queries to OR
</td></tr><tr><td><span class="term"><i class="parameter"><tt>qs</tt></i>:</span></td><td> pointer to an array of <span class="type">EBookQuery</span> items
</td></tr><tr><td><span class="term"><i class="parameter"><tt>unref</tt></i>:</span></td><td> if <span class="type">TRUE</span>, the new query takes ownership of the existing queries
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A new <span class="type">EBookQuery</span>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2473315"></a><h3><a name="e-book-query-orv"></a>e_book_query_orv ()</h3><a class="indexterm" name="id2524914"></a><pre class="programlisting">EBookQuery* e_book_query_orv (EBookQuery *q,
...);</pre><p>
Create a new <span class="type">EBookQuery</span> which is the logical OR of the queries specified.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>q</tt></i>:</span></td><td> first <span class="type">EBookQuery</span>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i>:</span></td><td> <span class="type">NULL</span> terminated list of <span class="type">EBookQuery</span> pointers
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A new <span class="type">EBookQuery</span>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2525005"></a><h3><a name="e-book-query-not"></a>e_book_query_not ()</h3><a class="indexterm" name="id2525013"></a><pre class="programlisting">EBookQuery* e_book_query_not (EBookQuery *q,
gboolean unref);</pre><p>
Create a new <span class="type">EBookQuery</span> which is the opposite of <span class="type">q</span>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>q</tt></i>:</span></td><td> an <span class="type">EBookQuery</span>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>unref</tt></i>:</span></td><td> if <span class="type">TRUE</span>, the new query takes ownership of the existing queries
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the new <span class="type">EBookQuery</span>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2510041"></a><h3><a name="e-book-query-field-exists"></a>e_book_query_field_exists ()</h3><a class="indexterm" name="id2510050"></a><pre class="programlisting">EBookQuery* e_book_query_field_exists (<a href="EContact.html#EContactField">EContactField</a> field);</pre><p>
Create a new <span class="type">EBookQuery</span> which tests if the field <i class="parameter"><tt>field</tt></i> exists.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>:</span></td><td> a <a href="EContact.html#EContactField"><span class="type">EContactField</span></a>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the new <span class="type">EBookQuery</span>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2510119"></a><h3><a name="e-book-query-field-test"></a>e_book_query_field_test ()</h3><a class="indexterm" name="id2510128"></a><pre class="programlisting">EBookQuery* e_book_query_field_test (<a href="EContact.html#EContactField">EContactField</a> field,
<a href="libebook-e-book-query.html#EBookQueryTest">EBookQueryTest</a> test,
const char *value);</pre><p>
Create a new <span class="type">EBookQuery</span> which tests <i class="parameter"><tt>field</tt></i> for <i class="parameter"><tt>value</tt></i> using the test <i class="parameter"><tt>test</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>:</span></td><td> an <a href="EContact.html#EContactField"><span class="type">EContactField</span></a> to test
</td></tr><tr><td><span class="term"><i class="parameter"><tt>test</tt></i>:</span></td><td> the test to apply
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i>:</span></td><td> the value to test for
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the new <span class="type">EBookQuery</span>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2446021"></a><h3><a name="e-book-query-any-field-contains"></a>e_book_query_any_field_contains ()</h3><a class="indexterm" name="id2446032"></a><pre class="programlisting">EBookQuery* e_book_query_any_field_contains (const char *value);</pre><p>
Create a new <span class="type">EBookQuery</span> which tests if any field contains <i class="parameter"><tt>value</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>value</tt></i>:</span></td><td> a value
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the new <span class="type">EBookQuery</span>
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="EBook.html"><b><<EBook</b></a></td><td align="right"><a accesskey="n" href="EContact.html"><b>EContact>></b></a></td></tr></table></body></html>
|
