Top |
Functions
Description
This utility can be used to conveniently create search expressions which can later be used to query and filter results in the EBookClient, EBookClientView and EBookClientCursor interfaces.
Functions
e_book_query_from_string ()
EBookQuery *
e_book_query_from_string (const gchar *query_string
);
Parse query_string
and return a new EBookQuery representing it.
e_book_query_to_string ()
gchar *
e_book_query_to_string (EBookQuery *q
);
Return the string representation of q
.
e_book_query_ref ()
EBookQuery *
e_book_query_ref (EBookQuery *q
);
Increment the reference count on q
.
e_book_query_unref ()
void
e_book_query_unref (EBookQuery *q
);
Decrement the reference count on q
. When the reference count reaches 0, q
will be freed and any child queries will have e_book_query_unref()
called.
e_book_query_and ()
EBookQuery * e_book_query_and (gint nqs
,EBookQuery **qs
,gboolean unref
);
Create a new EBookQuery which is the logical AND of the queries in qs.
Parameters
nqs |
the number of queries to AND |
|
qs |
pointer to an array of EBookQuery items |
|
unref |
if |
e_book_query_andv ()
EBookQuery * e_book_query_andv (EBookQuery *q
,...
);
Creates a new EBookQuery which is the logical AND of the queries specified.
e_book_query_or ()
EBookQuery * e_book_query_or (gint nqs
,EBookQuery **qs
,gboolean unref
);
Creates a new EBookQuery which is the logical OR of the queries in qs.
Parameters
nqs |
the number of queries to OR |
|
qs |
pointer to an array of EBookQuery items |
|
unref |
if |
e_book_query_orv ()
EBookQuery * e_book_query_orv (EBookQuery *q
,...
);
Creates a new EBookQuery which is the logical OR of the queries specified.
e_book_query_not ()
EBookQuery * e_book_query_not (EBookQuery *q
,gboolean unref
);
Creates a new EBookQuery which is the opposite of #q.
e_book_query_field_exists ()
EBookQuery *
e_book_query_field_exists (EContactField field
);
Creates a new EBookQuery which tests if the field field
exists.
e_book_query_vcard_field_exists ()
EBookQuery *
e_book_query_vcard_field_exists (const gchar *field
);
Creates a new EBookQuery which tests if the field field
exists. field
should be a vCard field name, such as FN or X-MSN.
e_book_query_field_test ()
EBookQuery * e_book_query_field_test (EContactField field
,EBookQueryTest test
,const gchar *value
);
Creates a new EBookQuery which tests field
for value
using the test test
.
e_book_query_vcard_field_test ()
EBookQuery * e_book_query_vcard_field_test (const gchar *field
,EBookQueryTest test
,const gchar *value
);
Creates a new EBookQuery which tests field
for value
using the test test
.
Since: 2.22
e_book_query_any_field_contains ()
EBookQuery *
e_book_query_any_field_contains (const gchar *value
);
Creates a new EBookQuery which tests if any field contains value
.
Types and Values
enum EBookQueryTest
The kind of test a query created by e_book_query_field_test()
shall perform.
See also: e_phone_number_compare_strings()
.
Members
look for exact match of the supplied test value |
||
check if a field contains the test value |
||
check if a field starts with the test value |
||
check if a field ends with the test value |
||
check if a field matches with a value tested
using |
||
check if a field matches with a value tested
using |
||
check if a field matches with a value tested
using |
||
A regular expression query against contact data normalized with |
||
A regular expression query against raw contact data, this is usually slower than
a |
||
End marker for the EBookQueryTest enumeration, not a valid query test. |