| Evolution-Data-Server Manual: Address Book Client (libebook) | ||||
|---|---|---|---|---|
| Top | Description | ||||
typedef EBookQuery; enum EBookQueryTest; EBookQuery * e_book_query_from_string (const gchar *query_string); gchar * e_book_query_to_string (EBookQuery *q); EBookQuery * e_book_query_ref (EBookQuery *q); void e_book_query_unref (EBookQuery *q); EBookQuery * e_book_query_and (gint nqs,EBookQuery **qs,gboolean unref); EBookQuery * e_book_query_andv (EBookQuery *q,...); EBookQuery * e_book_query_or (gint nqs,EBookQuery **qs,gboolean unref); EBookQuery * e_book_query_orv (EBookQuery *q,...); EBookQuery * e_book_query_not (EBookQuery *q,gboolean unref); EBookQuery * e_book_query_field_exists (EContactField field); EBookQuery * e_book_query_vcard_field_exists (const gchar *field); EBookQuery * e_book_query_field_test (EContactField field,EBookQueryTest test,const gchar *value); EBookQuery * e_book_query_vcard_field_test (const gchar *field,EBookQueryTest test,const gchar *value); EBookQuery * e_book_query_any_field_contains (const gchar *value); EBookQuery * e_book_query_copy (EBookQuery *q);
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;
EBookQuery * e_book_query_from_string (const gchar *query_string);
Parse query_string and return a new EBookQuery representing it.
|
the query |
Returns : |
the new EBookQuery. |
gchar * e_book_query_to_string (EBookQuery *q);
Return the string representation of q.
|
an EBookQuery |
Returns : |
The string form of the query. This string should be freed when finished with. |
EBookQuery * e_book_query_ref (EBookQuery *q);
Increment the reference count on q.
|
a EBookQuery |
Returns : |
q |
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.
|
an EBookQuery |
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.
|
the number of queries to AND |
|
pointer to an array of EBookQuery items |
|
if TRUE, the new query takes ownership of the existing queries |
Returns : |
A new EBookQuery |
EBookQuery * e_book_query_andv (EBookQuery *q,...);
Creates a new EBookQuery which is the logical AND of the queries specified.
|
first EBookQuery |
|
NULL terminated list of EBookQuery pointers |
Returns : |
A new EBookQuery |
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.
|
the number of queries to OR |
|
pointer to an array of EBookQuery items |
|
if TRUE, the new query takes ownership of the existing queries |
Returns : |
A new EBookQuery |
EBookQuery * e_book_query_orv (EBookQuery *q,...);
Creates a new EBookQuery which is the logical OR of the queries specified.
|
first EBookQuery |
|
NULL terminated list of EBookQuery pointers |
Returns : |
A new EBookQuery |
EBookQuery * e_book_query_not (EBookQuery *q,gboolean unref);
Creates a new EBookQuery which is the opposite of #q.
|
an EBookQuery |
|
if TRUE, the new query takes ownership of the existing queries |
Returns : |
the new EBookQuery |
EBookQuery * e_book_query_field_exists (EContactField field);
Creates a new EBookQuery which tests if the field field exists.
|
a EContactField |
Returns : |
the new EBookQuery |
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.
|
a field name |
Returns : |
the new EBookQuery |
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.
|
an EContactField to test |
|
the test to apply |
|
the value to test for |
Returns : |
the new EBookQuery |
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.
|
a EVCard field name to test |
|
the test to apply |
|
the value to test for |
Returns : |
the new EBookQuery |
Since 2.22
EBookQuery * e_book_query_any_field_contains (const gchar *value);
Creates a new EBookQuery which tests if any field contains value.
|
a value |
Returns : |
the new EBookQuery |