← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

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

  • 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
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* 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:
docs/reference/addressbook/libebook/xml/e-book-query.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="libebook-e-book-query">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libebook-e-book-query.top_of_page">e-book-query</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEBOOK Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>e-book-query</refname>
14
 
<refpurpose>Handles queries of addressboook data.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libebook-e-book-query.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>typedef             <link linkend="EBookQuery">EBookQuery</link>;
21
 
enum                <link linkend="EBookQueryTest">EBookQueryTest</link>;
22
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-from-string">e_book_query_from_string</link>            (<parameter>const <link linkend="gchar"><type>gchar</type></link> *query_string</parameter>);
23
 
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-book-query-to-string">e_book_query_to_string</link>              (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>);
24
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-ref">e_book_query_ref</link>                    (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>);
25
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-query-unref">e_book_query_unref</link>                  (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>);
26
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-and">e_book_query_and</link>                    (<parameter><link linkend="gint"><type>gint</type></link> nqs</parameter>,
27
 
                                                         <parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> **qs</parameter>,
28
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> unref</parameter>);
29
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-andv">e_book_query_andv</link>                   (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>,
30
 
                                                         <parameter>...</parameter>);
31
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-or">e_book_query_or</link>                     (<parameter><link linkend="gint"><type>gint</type></link> nqs</parameter>,
32
 
                                                         <parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> **qs</parameter>,
33
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> unref</parameter>);
34
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-orv">e_book_query_orv</link>                    (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>,
35
 
                                                         <parameter>...</parameter>);
36
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-not">e_book_query_not</link>                    (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>,
37
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> unref</parameter>);
38
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-field-exists">e_book_query_field_exists</link>           (<parameter><link linkend="EContactField"><type>EContactField</type></link> field</parameter>);
39
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-vcard-field-exists">e_book_query_vcard_field_exists</link>     (<parameter>const <link linkend="gchar"><type>gchar</type></link> *field</parameter>);
40
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-field-test">e_book_query_field_test</link>             (<parameter><link linkend="EContactField"><type>EContactField</type></link> field</parameter>,
41
 
                                                         <parameter><link linkend="EBookQueryTest"><type>EBookQueryTest</type></link> test</parameter>,
42
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);
43
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-vcard-field-test">e_book_query_vcard_field_test</link>       (<parameter>const <link linkend="gchar"><type>gchar</type></link> *field</parameter>,
44
 
                                                         <parameter><link linkend="EBookQueryTest"><type>EBookQueryTest</type></link> test</parameter>,
45
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);
46
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-any-field-contains">e_book_query_any_field_contains</link>     (<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);
47
 
<link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         <link linkend="e-book-query-copy">e_book_query_copy</link>                   (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>);
48
 
</synopsis>
49
 
</refsynopsisdiv>
50
 
 
51
 
<refsect1 id="libebook-e-book-query.description" role="desc">
52
 
<title role="desc.title">Description</title>
53
 
<para>
54
 
</para>
55
 
</refsect1>
56
 
<refsect1 id="libebook-e-book-query.details" role="details">
57
 
<title role="details.title">Details</title>
58
 
<refsect2 id="EBookQuery" role="typedef">
59
 
<title>EBookQuery</title>
60
 
<indexterm zone="EBookQuery"><primary>EBookQuery</primary></indexterm>
61
 
<programlisting>typedef struct EBookQuery EBookQuery;
62
 
</programlisting>
63
 
<para>
64
 
</para></refsect2>
65
 
<refsect2 id="EBookQueryTest" role="enum">
66
 
<title>enum EBookQueryTest</title>
67
 
<indexterm zone="EBookQueryTest"><primary>EBookQueryTest</primary></indexterm>
68
 
<programlisting>typedef enum {
69
 
  E_BOOK_QUERY_IS,
70
 
  E_BOOK_QUERY_CONTAINS,
71
 
  E_BOOK_QUERY_BEGINS_WITH,
72
 
  E_BOOK_QUERY_ENDS_WITH
73
 
 
74
 
  /*
75
 
    Consider these "coming soon".
76
 
 
77
 
    E_BOOK_QUERY_LT,
78
 
    E_BOOK_QUERY_LE,
79
 
    E_BOOK_QUERY_GT,
80
 
    E_BOOK_QUERY_GE,
81
 
    E_BOOK_QUERY_EQ,
82
 
  */
83
 
} EBookQueryTest;
84
 
</programlisting>
85
 
<para>
86
 
</para></refsect2>
87
 
<refsect2 id="e-book-query-from-string" role="function">
88
 
<title>e_book_query_from_string ()</title>
89
 
<indexterm zone="e-book-query-from-string"><primary>e_book_query_from_string</primary></indexterm>
90
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_from_string            (<parameter>const <link linkend="gchar"><type>gchar</type></link> *query_string</parameter>);</programlisting>
91
 
<para>
92
 
Parse <parameter>query_string</parameter> and return a new <link linkend="EBookQuery"><type>EBookQuery</type></link> representing it.</para>
93
 
<variablelist role="params">
94
 
<varlistentry><term><parameter>query_string</parameter>&#160;:</term>
95
 
<listitem><simpara>the query
96
 
</simpara></listitem></varlistentry>
97
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="EBookQuery"><type>EBookQuery</type></link>.
98
 
</simpara></listitem></varlistentry>
99
 
</variablelist></refsect2>
100
 
<refsect2 id="e-book-query-to-string" role="function">
101
 
<title>e_book_query_to_string ()</title>
102
 
<indexterm zone="e-book-query-to-string"><primary>e_book_query_to_string</primary></indexterm>
103
 
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_book_query_to_string              (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>);</programlisting>
104
 
<para>
105
 
Return the string representation of <parameter>q</parameter>.</para>
106
 
<variablelist role="params">
107
 
<varlistentry><term><parameter>q</parameter>&#160;:</term>
108
 
<listitem><simpara>an <link linkend="EBookQuery"><type>EBookQuery</type></link>
109
 
</simpara></listitem></varlistentry>
110
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The string form of the query. This string should be freed when
111
 
finished with.
112
 
</simpara></listitem></varlistentry>
113
 
</variablelist></refsect2>
114
 
<refsect2 id="e-book-query-ref" role="function">
115
 
<title>e_book_query_ref ()</title>
116
 
<indexterm zone="e-book-query-ref"><primary>e_book_query_ref</primary></indexterm>
117
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_ref                    (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>);</programlisting>
118
 
<para>
119
 
Increment the reference count on <parameter>q</parameter>.</para>
120
 
<variablelist role="params">
121
 
<varlistentry><term><parameter>q</parameter>&#160;:</term>
122
 
<listitem><simpara>a <link linkend="EBookQuery"><type>EBookQuery</type></link>
123
 
</simpara></listitem></varlistentry>
124
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <parameter>q</parameter>
125
 
</simpara></listitem></varlistentry>
126
 
</variablelist></refsect2>
127
 
<refsect2 id="e-book-query-unref" role="function">
128
 
<title>e_book_query_unref ()</title>
129
 
<indexterm zone="e-book-query-unref"><primary>e_book_query_unref</primary></indexterm>
130
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_query_unref                  (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>);</programlisting>
131
 
<para>
132
 
Decrement the reference count on <parameter>q</parameter>. When the reference count reaches 0, <parameter>q</parameter>
133
 
will be freed and any child queries will have <link linkend="e-book-query-unref"><function>e_book_query_unref()</function></link> called.</para>
134
 
<variablelist role="params">
135
 
<varlistentry><term><parameter>q</parameter>&#160;:</term>
136
 
<listitem><simpara>an <link linkend="EBookQuery"><type>EBookQuery</type></link>
137
 
</simpara></listitem></varlistentry>
138
 
</variablelist></refsect2>
139
 
<refsect2 id="e-book-query-and" role="function">
140
 
<title>e_book_query_and ()</title>
141
 
<indexterm zone="e-book-query-and"><primary>e_book_query_and</primary></indexterm>
142
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_and                    (<parameter><link linkend="gint"><type>gint</type></link> nqs</parameter>,
143
 
                                                         <parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> **qs</parameter>,
144
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> unref</parameter>);</programlisting>
145
 
<para>
146
 
Create a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which is the logical AND of the queries in <link linkend="qs"><type>qs</type></link>.</para>
147
 
<variablelist role="params">
148
 
<varlistentry><term><parameter>nqs</parameter>&#160;:</term>
149
 
<listitem><simpara>the number of queries to AND
150
 
</simpara></listitem></varlistentry>
151
 
<varlistentry><term><parameter>qs</parameter>&#160;:</term>
152
 
<listitem><simpara>pointer to an array of <link linkend="EBookQuery"><type>EBookQuery</type></link> items
153
 
</simpara></listitem></varlistentry>
154
 
<varlistentry><term><parameter>unref</parameter>&#160;:</term>
155
 
<listitem><simpara>if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the new query takes ownership of the existing queries
156
 
</simpara></listitem></varlistentry>
157
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="EBookQuery"><type>EBookQuery</type></link>
158
 
</simpara></listitem></varlistentry>
159
 
</variablelist></refsect2>
160
 
<refsect2 id="e-book-query-andv" role="function">
161
 
<title>e_book_query_andv ()</title>
162
 
<indexterm zone="e-book-query-andv"><primary>e_book_query_andv</primary></indexterm>
163
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_andv                   (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>,
164
 
                                                         <parameter>...</parameter>);</programlisting>
165
 
<para>
166
 
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which is the logical AND of the queries specified.</para>
167
 
<variablelist role="params">
168
 
<varlistentry><term><parameter>q</parameter>&#160;:</term>
169
 
<listitem><simpara>first <link linkend="EBookQuery"><type>EBookQuery</type></link>
170
 
</simpara></listitem></varlistentry>
171
 
<varlistentry><term><parameter>...</parameter>&#160;:</term>
172
 
<listitem><simpara><link linkend="NULL:CAPS"><type>NULL</type></link> terminated list of <link linkend="EBookQuery"><type>EBookQuery</type></link> pointers
173
 
</simpara></listitem></varlistentry>
174
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="EBookQuery"><type>EBookQuery</type></link>
175
 
</simpara></listitem></varlistentry>
176
 
</variablelist></refsect2>
177
 
<refsect2 id="e-book-query-or" role="function">
178
 
<title>e_book_query_or ()</title>
179
 
<indexterm zone="e-book-query-or"><primary>e_book_query_or</primary></indexterm>
180
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_or                     (<parameter><link linkend="gint"><type>gint</type></link> nqs</parameter>,
181
 
                                                         <parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> **qs</parameter>,
182
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> unref</parameter>);</programlisting>
183
 
<para>
184
 
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which is the logical OR of the queries in <link linkend="qs"><type>qs</type></link>.</para>
185
 
<variablelist role="params">
186
 
<varlistentry><term><parameter>nqs</parameter>&#160;:</term>
187
 
<listitem><simpara>the number of queries to OR
188
 
</simpara></listitem></varlistentry>
189
 
<varlistentry><term><parameter>qs</parameter>&#160;:</term>
190
 
<listitem><simpara>pointer to an array of <link linkend="EBookQuery"><type>EBookQuery</type></link> items
191
 
</simpara></listitem></varlistentry>
192
 
<varlistentry><term><parameter>unref</parameter>&#160;:</term>
193
 
<listitem><simpara>if <link linkend="TRUE:CAPS"><type>TRUE</type></link>, the new query takes ownership of the existing queries
194
 
</simpara></listitem></varlistentry>
195
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="EBookQuery"><type>EBookQuery</type></link>
196
 
</simpara></listitem></varlistentry>
197
 
</variablelist></refsect2>
198
 
<refsect2 id="e-book-query-orv" role="function">
199
 
<title>e_book_query_orv ()</title>
200
 
<indexterm zone="e-book-query-orv"><primary>e_book_query_orv</primary></indexterm>
201
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_orv                    (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>,
202
 
                                                         <parameter>...</parameter>);</programlisting>
203
 
<para>
204
 
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which is the logical OR of the queries specified.</para>
205
 
<variablelist role="params">
206
 
<varlistentry><term><parameter>q</parameter>&#160;:</term>
207
 
<listitem><simpara>first <link linkend="EBookQuery"><type>EBookQuery</type></link>
208
 
</simpara></listitem></varlistentry>
209
 
<varlistentry><term><parameter>...</parameter>&#160;:</term>
210
 
<listitem><simpara><link linkend="NULL:CAPS"><type>NULL</type></link> terminated list of <link linkend="EBookQuery"><type>EBookQuery</type></link> pointers
211
 
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="EBookQuery"><type>EBookQuery</type></link>
213
 
</simpara></listitem></varlistentry>
214
 
</variablelist></refsect2>
215
 
<refsect2 id="e-book-query-not" role="function">
216
 
<title>e_book_query_not ()</title>
217
 
<indexterm zone="e-book-query-not"><primary>e_book_query_not</primary></indexterm>
218
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_not                    (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>,
219
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> unref</parameter>);</programlisting>
220
 
<para>
221
 
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which is the opposite of #q.</para>
222
 
<variablelist role="params">
223
 
<varlistentry><term><parameter>q</parameter>&#160;:</term>
224
 
<listitem><simpara>an <link linkend="EBookQuery"><type>EBookQuery</type></link>
225
 
</simpara></listitem></varlistentry>
226
 
<varlistentry><term><parameter>unref</parameter>&#160;:</term>
227
 
<listitem><simpara>if <link linkend="TRUE:CAPS"><type>TRUE</type></link>, the new query takes ownership of the existing queries
228
 
</simpara></listitem></varlistentry>
229
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="EBookQuery"><type>EBookQuery</type></link>
230
 
</simpara></listitem></varlistentry>
231
 
</variablelist></refsect2>
232
 
<refsect2 id="e-book-query-field-exists" role="function">
233
 
<title>e_book_query_field_exists ()</title>
234
 
<indexterm zone="e-book-query-field-exists"><primary>e_book_query_field_exists</primary></indexterm>
235
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_field_exists           (<parameter><link linkend="EContactField"><type>EContactField</type></link> field</parameter>);</programlisting>
236
 
<para>
237
 
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which tests if the field <parameter>field</parameter> exists.</para>
238
 
<variablelist role="params">
239
 
<varlistentry><term><parameter>field</parameter>&#160;:</term>
240
 
<listitem><simpara>a <link linkend="EContactField"><type>EContactField</type></link>
241
 
</simpara></listitem></varlistentry>
242
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="EBookQuery"><type>EBookQuery</type></link>
243
 
</simpara></listitem></varlistentry>
244
 
</variablelist></refsect2>
245
 
<refsect2 id="e-book-query-vcard-field-exists" role="function">
246
 
<title>e_book_query_vcard_field_exists ()</title>
247
 
<indexterm zone="e-book-query-vcard-field-exists"><primary>e_book_query_vcard_field_exists</primary></indexterm>
248
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_vcard_field_exists     (<parameter>const <link linkend="gchar"><type>gchar</type></link> *field</parameter>);</programlisting>
249
 
<para>
250
 
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which tests if the field <parameter>field</parameter> exists. <parameter>field</parameter>
251
 
should be a vCard field name, such as <link linkend="FN:CAPS"><type>FN</type></link> or <link linkend="X-MSN:CAPS"><type>X-MSN</type></link>.</para>
252
 
<variablelist role="params">
253
 
<varlistentry><term><parameter>field</parameter>&#160;:</term>
254
 
<listitem><simpara>a field name
255
 
</simpara></listitem></varlistentry>
256
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="EBookQuery"><type>EBookQuery</type></link>
257
 
</simpara></listitem></varlistentry>
258
 
</variablelist></refsect2>
259
 
<refsect2 id="e-book-query-field-test" role="function">
260
 
<title>e_book_query_field_test ()</title>
261
 
<indexterm zone="e-book-query-field-test"><primary>e_book_query_field_test</primary></indexterm>
262
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_field_test             (<parameter><link linkend="EContactField"><type>EContactField</type></link> field</parameter>,
263
 
                                                         <parameter><link linkend="EBookQueryTest"><type>EBookQueryTest</type></link> test</parameter>,
264
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting>
265
 
<para>
266
 
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which tests <parameter>field</parameter> for <parameter>value</parameter> using the test <parameter>test</parameter>.</para>
267
 
<variablelist role="params">
268
 
<varlistentry><term><parameter>field</parameter>&#160;:</term>
269
 
<listitem><simpara>an <link linkend="EContactField"><type>EContactField</type></link> to test
270
 
</simpara></listitem></varlistentry>
271
 
<varlistentry><term><parameter>test</parameter>&#160;:</term>
272
 
<listitem><simpara>the test to apply
273
 
</simpara></listitem></varlistentry>
274
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
275
 
<listitem><simpara>the value to test for
276
 
</simpara></listitem></varlistentry>
277
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="EBookQuery"><type>EBookQuery</type></link>
278
 
</simpara></listitem></varlistentry>
279
 
</variablelist></refsect2>
280
 
<refsect2 id="e-book-query-vcard-field-test" role="function">
281
 
<title>e_book_query_vcard_field_test ()</title>
282
 
<indexterm zone="e-book-query-vcard-field-test"><primary>e_book_query_vcard_field_test</primary></indexterm>
283
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_vcard_field_test       (<parameter>const <link linkend="gchar"><type>gchar</type></link> *field</parameter>,
284
 
                                                         <parameter><link linkend="EBookQueryTest"><type>EBookQueryTest</type></link> test</parameter>,
285
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting>
286
 
<para>
287
 
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which tests <parameter>field</parameter> for <parameter>value</parameter> using the test <parameter>test</parameter>.</para>
288
 
<variablelist role="params">
289
 
<varlistentry><term><parameter>field</parameter>&#160;:</term>
290
 
<listitem><simpara>a EVCard field name to test
291
 
</simpara></listitem></varlistentry>
292
 
<varlistentry><term><parameter>test</parameter>&#160;:</term>
293
 
<listitem><simpara>the test to apply
294
 
</simpara></listitem></varlistentry>
295
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
296
 
<listitem><simpara>the value to test for
297
 
</simpara></listitem></varlistentry>
298
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="EBookQuery"><type>EBookQuery</type></link>
299
 
</simpara></listitem></varlistentry>
300
 
</variablelist></refsect2>
301
 
<refsect2 id="e-book-query-any-field-contains" role="function">
302
 
<title>e_book_query_any_field_contains ()</title>
303
 
<indexterm zone="e-book-query-any-field-contains"><primary>e_book_query_any_field_contains</primary></indexterm>
304
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_any_field_contains     (<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting>
305
 
<para>
306
 
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which tests if any field contains <parameter>value</parameter>.</para>
307
 
<variablelist role="params">
308
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
309
 
<listitem><simpara>a value
310
 
</simpara></listitem></varlistentry>
311
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="EBookQuery"><type>EBookQuery</type></link>
312
 
</simpara></listitem></varlistentry>
313
 
</variablelist></refsect2>
314
 
<refsect2 id="e-book-query-copy" role="function">
315
 
<title>e_book_query_copy ()</title>
316
 
<indexterm zone="e-book-query-copy"><primary>e_book_query_copy</primary></indexterm>
317
 
<programlisting><link linkend="EBookQuery"><returnvalue>EBookQuery</returnvalue></link>*         e_book_query_copy                   (<parameter><link linkend="EBookQuery"><type>EBookQuery</type></link> *q</parameter>);</programlisting>
318
 
<para>
319
 
</para><variablelist role="params">
320
 
<varlistentry><term><parameter>q</parameter>&#160;:</term>
321
 
<listitem><simpara>
322
 
</simpara></listitem></varlistentry>
323
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
324
 
</simpara></listitem></varlistentry>
325
 
</variablelist></refsect2>
326
 
 
327
 
</refsect1>
328
 
 
329
 
</refentry>