59
49
<refsect1 id="libebook-e-book-query.description" role="desc">
60
50
<title role="desc.title">Description</title>
65
54
<refsect1 id="libebook-e-book-query.details" role="details">
66
55
<title role="details.title">Details</title>
67
56
<refsect2 id="EBookQuery" role="typedef">
68
57
<title>EBookQuery</title>
69
<indexterm zone="EBookQuery"><primary sortas="EBookQuery">EBookQuery</primary></indexterm><programlisting>typedef struct EBookQuery EBookQuery;
58
<indexterm zone="EBookQuery"><primary>EBookQuery</primary></indexterm>
59
<programlisting>typedef struct EBookQuery EBookQuery;
73
63
<refsect2 id="EBookQueryTest" role="enum">
74
64
<title>enum EBookQueryTest</title>
75
<indexterm zone="EBookQueryTest"><primary sortas="EBookQueryTest">EBookQueryTest</primary></indexterm><programlisting>typedef enum {
65
<indexterm zone="EBookQueryTest"><primary>EBookQueryTest</primary></indexterm>
66
<programlisting>typedef enum {
77
68
E_BOOK_QUERY_CONTAINS,
78
69
E_BOOK_QUERY_BEGINS_WITH,
94
85
<refsect2 id="e-book-query-from-string" role="function">
95
86
<title>e_book_query_from_string ()</title>
96
<indexterm zone="e-book-query-from-string"><primary sortas="e_book_query_from_string">e_book_query_from_string</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_from_string (const <link linkend="gchar">gchar</link> *query_string);</programlisting>
87
<indexterm zone="e-book-query-from-string"><primary>e_book_query_from_string</primary></indexterm>
88
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_from_string (const <link linkend="gchar">gchar</link> *query_string);</programlisting>
98
90
Parse <parameter>query_string</parameter> and return a new <link linkend="EBookQuery"><type>EBookQuery</type></link> representing it.</para>
100
</para><variablelist role="params">
91
<variablelist role="params">
101
92
<varlistentry><term><parameter>query_string</parameter> :</term>
102
93
<listitem><simpara> the query
103
94
</simpara></listitem></varlistentry>
106
97
</variablelist></refsect2>
107
98
<refsect2 id="e-book-query-to-string" role="function">
108
99
<title>e_book_query_to_string ()</title>
109
<indexterm zone="e-book-query-to-string"><primary sortas="e_book_query_to_string">e_book_query_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> * e_book_query_to_string (<link linkend="EBookQuery">EBookQuery</link> *q);</programlisting>
100
<indexterm zone="e-book-query-to-string"><primary>e_book_query_to_string</primary></indexterm>
101
<programlisting><link linkend="gchar">gchar</link> * e_book_query_to_string (<link linkend="EBookQuery">EBookQuery</link> *q);</programlisting>
111
103
Return the string representation of <parameter>q</parameter>.</para>
113
</para><variablelist role="params">
104
<variablelist role="params">
114
105
<varlistentry><term><parameter>q</parameter> :</term>
115
106
<listitem><simpara> an <link linkend="EBookQuery"><type>EBookQuery</type></link>
116
107
</simpara></listitem></varlistentry>
120
111
</variablelist></refsect2>
121
112
<refsect2 id="e-book-query-ref" role="function">
122
113
<title>e_book_query_ref ()</title>
123
<indexterm zone="e-book-query-ref"><primary sortas="e_book_query_ref">e_book_query_ref</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_ref (<link linkend="EBookQuery">EBookQuery</link> *q);</programlisting>
114
<indexterm zone="e-book-query-ref"><primary>e_book_query_ref</primary></indexterm>
115
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_ref (<link linkend="EBookQuery">EBookQuery</link> *q);</programlisting>
125
117
Increment the reference count on <parameter>q</parameter>.</para>
127
</para><variablelist role="params">
118
<variablelist role="params">
128
119
<varlistentry><term><parameter>q</parameter> :</term>
129
120
<listitem><simpara> a <link linkend="EBookQuery"><type>EBookQuery</type></link>
130
121
</simpara></listitem></varlistentry>
133
124
</variablelist></refsect2>
134
125
<refsect2 id="e-book-query-unref" role="function">
135
126
<title>e_book_query_unref ()</title>
136
<indexterm zone="e-book-query-unref"><primary sortas="e_book_query_unref">e_book_query_unref</primary></indexterm><programlisting><link linkend="void">void</link> e_book_query_unref (<link linkend="EBookQuery">EBookQuery</link> *q);</programlisting>
127
<indexterm zone="e-book-query-unref"><primary>e_book_query_unref</primary></indexterm>
128
<programlisting><link linkend="void">void</link> e_book_query_unref (<link linkend="EBookQuery">EBookQuery</link> *q);</programlisting>
138
130
Decrement the reference count on <parameter>q</parameter>. When the reference count reaches 0, <parameter>q</parameter>
139
131
will be freed and any child queries will have <link linkend="e-book-query-unref"><function>e_book_query_unref()</function></link> called.</para>
141
</para><variablelist role="params">
132
<variablelist role="params">
142
133
<varlistentry><term><parameter>q</parameter> :</term>
143
134
<listitem><simpara> an <link linkend="EBookQuery"><type>EBookQuery</type></link>
144
135
</simpara></listitem></varlistentry>
145
136
</variablelist></refsect2>
146
137
<refsect2 id="e-book-query-and" role="function">
147
138
<title>e_book_query_and ()</title>
148
<indexterm zone="e-book-query-and"><primary sortas="e_book_query_and">e_book_query_and</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_and (<link linkend="gint">gint</link> nqs,
139
<indexterm zone="e-book-query-and"><primary>e_book_query_and</primary></indexterm>
140
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_and (<link linkend="gint">gint</link> nqs,
149
141
<link linkend="EBookQuery">EBookQuery</link> **qs,
150
142
<link linkend="gboolean">gboolean</link> unref);</programlisting>
152
144
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>
154
</para><variablelist role="params">
145
<variablelist role="params">
155
146
<varlistentry><term><parameter>nqs</parameter> :</term>
156
147
<listitem><simpara> the number of queries to AND
157
148
</simpara></listitem></varlistentry>
159
150
<listitem><simpara> pointer to an array of <link linkend="EBookQuery"><type>EBookQuery</type></link> items
160
151
</simpara></listitem></varlistentry>
161
152
<varlistentry><term><parameter>unref</parameter> :</term>
162
<listitem><simpara> if <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, the new query takes ownership of the existing queries
153
<listitem><simpara> if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the new query takes ownership of the existing queries
163
154
</simpara></listitem></varlistentry>
164
155
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="EBookQuery"><type>EBookQuery</type></link>
165
156
</simpara></listitem></varlistentry>
166
157
</variablelist></refsect2>
167
158
<refsect2 id="e-book-query-andv" role="function">
168
159
<title>e_book_query_andv ()</title>
169
<indexterm zone="e-book-query-andv"><primary sortas="e_book_query_andv">e_book_query_andv</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_andv (<link linkend="EBookQuery">EBookQuery</link> *q,
160
<indexterm zone="e-book-query-andv"><primary>e_book_query_andv</primary></indexterm>
161
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_andv (<link linkend="EBookQuery">EBookQuery</link> *q,
170
162
...);</programlisting>
172
164
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which is the logical AND of the queries specified.</para>
174
</para><variablelist role="params">
165
<variablelist role="params">
175
166
<varlistentry><term><parameter>q</parameter> :</term>
176
167
<listitem><simpara> first <link linkend="EBookQuery"><type>EBookQuery</type></link>
177
168
</simpara></listitem></varlistentry>
178
169
<varlistentry><term><parameter>...</parameter> :</term>
179
<listitem><simpara> <link linkend="NULL--CAPS"><type>NULL</type></link> terminated list of <link linkend="EBookQuery"><type>EBookQuery</type></link> pointers
170
<listitem><simpara> <link linkend="NULL:CAPS"><type>NULL</type></link> terminated list of <link linkend="EBookQuery"><type>EBookQuery</type></link> pointers
180
171
</simpara></listitem></varlistentry>
181
172
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="EBookQuery"><type>EBookQuery</type></link>
182
173
</simpara></listitem></varlistentry>
183
174
</variablelist></refsect2>
184
175
<refsect2 id="e-book-query-or" role="function">
185
176
<title>e_book_query_or ()</title>
186
<indexterm zone="e-book-query-or"><primary sortas="e_book_query_or">e_book_query_or</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_or (<link linkend="gint">gint</link> nqs,
177
<indexterm zone="e-book-query-or"><primary>e_book_query_or</primary></indexterm>
178
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_or (<link linkend="gint">gint</link> nqs,
187
179
<link linkend="EBookQuery">EBookQuery</link> **qs,
188
180
<link linkend="gboolean">gboolean</link> unref);</programlisting>
190
182
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>
192
</para><variablelist role="params">
183
<variablelist role="params">
193
184
<varlistentry><term><parameter>nqs</parameter> :</term>
194
185
<listitem><simpara> the number of queries to OR
195
186
</simpara></listitem></varlistentry>
197
188
<listitem><simpara> pointer to an array of <link linkend="EBookQuery"><type>EBookQuery</type></link> items
198
189
</simpara></listitem></varlistentry>
199
190
<varlistentry><term><parameter>unref</parameter> :</term>
200
<listitem><simpara> if <link linkend="TRUE--CAPS"><type>TRUE</type></link>, the new query takes ownership of the existing queries
191
<listitem><simpara> if <link linkend="TRUE:CAPS"><type>TRUE</type></link>, the new query takes ownership of the existing queries
201
192
</simpara></listitem></varlistentry>
202
193
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="EBookQuery"><type>EBookQuery</type></link>
203
194
</simpara></listitem></varlistentry>
204
195
</variablelist></refsect2>
205
196
<refsect2 id="e-book-query-orv" role="function">
206
197
<title>e_book_query_orv ()</title>
207
<indexterm zone="e-book-query-orv"><primary sortas="e_book_query_orv">e_book_query_orv</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_orv (<link linkend="EBookQuery">EBookQuery</link> *q,
198
<indexterm zone="e-book-query-orv"><primary>e_book_query_orv</primary></indexterm>
199
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_orv (<link linkend="EBookQuery">EBookQuery</link> *q,
208
200
...);</programlisting>
210
202
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which is the logical OR of the queries specified.</para>
212
</para><variablelist role="params">
203
<variablelist role="params">
213
204
<varlistentry><term><parameter>q</parameter> :</term>
214
205
<listitem><simpara> first <link linkend="EBookQuery"><type>EBookQuery</type></link>
215
206
</simpara></listitem></varlistentry>
216
207
<varlistentry><term><parameter>...</parameter> :</term>
217
<listitem><simpara> <link linkend="NULL--CAPS"><type>NULL</type></link> terminated list of <link linkend="EBookQuery"><type>EBookQuery</type></link> pointers
208
<listitem><simpara> <link linkend="NULL:CAPS"><type>NULL</type></link> terminated list of <link linkend="EBookQuery"><type>EBookQuery</type></link> pointers
218
209
</simpara></listitem></varlistentry>
219
210
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="EBookQuery"><type>EBookQuery</type></link>
220
211
</simpara></listitem></varlistentry>
221
212
</variablelist></refsect2>
222
213
<refsect2 id="e-book-query-not" role="function">
223
214
<title>e_book_query_not ()</title>
224
<indexterm zone="e-book-query-not"><primary sortas="e_book_query_not">e_book_query_not</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_not (<link linkend="EBookQuery">EBookQuery</link> *q,
215
<indexterm zone="e-book-query-not"><primary>e_book_query_not</primary></indexterm>
216
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_not (<link linkend="EBookQuery">EBookQuery</link> *q,
225
217
<link linkend="gboolean">gboolean</link> unref);</programlisting>
227
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which is the opposite of <link linkend="q"><type>q</type></link>.</para>
229
</para><variablelist role="params">
219
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which is the opposite of #q.</para>
220
<variablelist role="params">
230
221
<varlistentry><term><parameter>q</parameter> :</term>
231
222
<listitem><simpara> an <link linkend="EBookQuery"><type>EBookQuery</type></link>
232
223
</simpara></listitem></varlistentry>
233
224
<varlistentry><term><parameter>unref</parameter> :</term>
234
<listitem><simpara> if <link linkend="TRUE--CAPS"><type>TRUE</type></link>, the new query takes ownership of the existing queries
225
<listitem><simpara> if <link linkend="TRUE:CAPS"><type>TRUE</type></link>, the new query takes ownership of the existing queries
235
226
</simpara></listitem></varlistentry>
236
227
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="EBookQuery"><type>EBookQuery</type></link>
237
228
</simpara></listitem></varlistentry>
238
229
</variablelist></refsect2>
239
230
<refsect2 id="e-book-query-field-exists" role="function">
240
231
<title>e_book_query_field_exists ()</title>
241
<indexterm zone="e-book-query-field-exists"><primary sortas="e_book_query_field_exists">e_book_query_field_exists</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_field_exists (<link linkend="EContactField">EContactField</link> field);</programlisting>
232
<indexterm zone="e-book-query-field-exists"><primary>e_book_query_field_exists</primary></indexterm>
233
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_field_exists (<link linkend="EContactField">EContactField</link> field);</programlisting>
243
235
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which tests if the field <parameter>field</parameter> exists.</para>
245
</para><variablelist role="params">
236
<variablelist role="params">
246
237
<varlistentry><term><parameter>field</parameter> :</term>
247
238
<listitem><simpara> a <link linkend="EContactField"><type>EContactField</type></link>
248
239
</simpara></listitem></varlistentry>
251
242
</variablelist></refsect2>
252
243
<refsect2 id="e-book-query-vcard-field-exists" role="function">
253
244
<title>e_book_query_vcard_field_exists ()</title>
254
<indexterm zone="e-book-query-vcard-field-exists"><primary sortas="e_book_query_vcard_field_exists">e_book_query_vcard_field_exists</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_vcard_field_exists (const <link linkend="gchar">gchar</link> *field);</programlisting>
245
<indexterm zone="e-book-query-vcard-field-exists"><primary>e_book_query_vcard_field_exists</primary></indexterm>
246
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_vcard_field_exists (const <link linkend="gchar">gchar</link> *field);</programlisting>
256
248
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which tests if the field <parameter>field</parameter> exists. <parameter>field</parameter>
257
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>
259
</para><variablelist role="params">
249
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>
250
<variablelist role="params">
260
251
<varlistentry><term><parameter>field</parameter> :</term>
261
252
<listitem><simpara> a field name
262
253
</simpara></listitem></varlistentry>
265
256
</variablelist></refsect2>
266
257
<refsect2 id="e-book-query-field-test" role="function">
267
258
<title>e_book_query_field_test ()</title>
268
<indexterm zone="e-book-query-field-test"><primary sortas="e_book_query_field_test">e_book_query_field_test</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_field_test (<link linkend="EContactField">EContactField</link> field,
259
<indexterm zone="e-book-query-field-test"><primary>e_book_query_field_test</primary></indexterm>
260
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_field_test (<link linkend="EContactField">EContactField</link> field,
269
261
<link linkend="EBookQueryTest">EBookQueryTest</link> test,
270
262
const <link linkend="gchar">gchar</link> *value);</programlisting>
272
264
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>
274
</para><variablelist role="params">
265
<variablelist role="params">
275
266
<varlistentry><term><parameter>field</parameter> :</term>
276
267
<listitem><simpara> an <link linkend="EContactField"><type>EContactField</type></link> to test
277
268
</simpara></listitem></varlistentry>
286
277
</variablelist></refsect2>
287
278
<refsect2 id="e-book-query-vcard-field-test" role="function">
288
279
<title>e_book_query_vcard_field_test ()</title>
289
<indexterm zone="e-book-query-vcard-field-test"><primary sortas="e_book_query_vcard_field_test">e_book_query_vcard_field_test</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_vcard_field_test (const <link linkend="gchar">gchar</link> *field,
280
<indexterm zone="e-book-query-vcard-field-test"><primary>e_book_query_vcard_field_test</primary></indexterm>
281
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_vcard_field_test (const <link linkend="gchar">gchar</link> *field,
290
282
<link linkend="EBookQueryTest">EBookQueryTest</link> test,
291
283
const <link linkend="gchar">gchar</link> *value);</programlisting>
293
285
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>
295
</para><variablelist role="params">
286
<variablelist role="params">
296
287
<varlistentry><term><parameter>field</parameter> :</term>
297
288
<listitem><simpara> a EVCard field name to test
298
289
</simpara></listitem></varlistentry>
307
298
</variablelist></refsect2>
308
299
<refsect2 id="e-book-query-any-field-contains" role="function">
309
300
<title>e_book_query_any_field_contains ()</title>
310
<indexterm zone="e-book-query-any-field-contains"><primary sortas="e_book_query_any_field_contains">e_book_query_any_field_contains</primary></indexterm><programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_any_field_contains (const <link linkend="gchar">gchar</link> *value);</programlisting>
301
<indexterm zone="e-book-query-any-field-contains"><primary>e_book_query_any_field_contains</primary></indexterm>
302
<programlisting><link linkend="EBookQuery">EBookQuery</link>* e_book_query_any_field_contains (const <link linkend="gchar">gchar</link> *value);</programlisting>
312
304
Creates a new <link linkend="EBookQuery"><type>EBookQuery</type></link> which tests if any field contains <parameter>value</parameter>.</para>
314
</para><variablelist role="params">
305
<variablelist role="params">
315
306
<varlistentry><term><parameter>value</parameter> :</term>
316
307
<listitem><simpara> a value
317
308
</simpara></listitem></varlistentry>