diff options
| author | Ross Burton <rburton@src.gnome.org> | 2003-12-23 22:38:25 +0000 |
|---|---|---|
| committer | Ross Burton <rburton@src.gnome.org> | 2003-12-23 22:38:25 +0000 |
| commit | 9fc892bc755e79ee500b67b52d0f02da9d75a4af (patch) | |
| tree | 0e4a418a5915ba9eb66cc0e82b8e1ae450a1c388 | |
| parent | 411a480f6a5665b0de71fceb3e368e10f60ab823 (diff) | |
| download | evolution-data-server-9fc892bc755e79ee500b67b52d0f02da9d75a4af.tar.gz | |
Update libebook API documentation
29 files changed, 1050 insertions, 772 deletions
@@ -1,3 +1,11 @@ +2003-12-23 Ross Burton <ross@burtonini.com> + + * docs/reference/addressbook/libebook/tmpl/*: + * docs/reference/addressbook/libebook/libebook-docs.sgml: + * docs/reference/addressbook/libebook/libebook-sections.txt + * docs/reference/addressbook/libebook/libebook.types: + Updated API documentation. + 2003-12-21 JP Rosevear <jpr@ximian.com> * libedataserver/e-source-list.c (e_source_list_peek_source_any): diff --git a/addressbook/libebook/e-book-listener.c b/addressbook/libebook/e-book-listener.c index 058716fe7..8a66ab6a0 100644 --- a/addressbook/libebook/e-book-listener.c +++ b/addressbook/libebook/e-book-listener.c @@ -312,9 +312,8 @@ impl_BookListener_respond_progress (PortableServer_Servant servant, /** * e_book_listener_new: - * @book: the #EBook for which the listener is to be bound * - * Creates and returns a new #EBookListener for the book. + * Creates and returns a new #EBookListener. * * Returns: a new #EBookListener */ diff --git a/addressbook/libebook/e-book-listener.h b/addressbook/libebook/e-book-listener.h index 27d58451e..177da3f15 100644 --- a/addressbook/libebook/e-book-listener.h +++ b/addressbook/libebook/e-book-listener.h @@ -32,6 +32,7 @@ typedef struct _EBookListenerResponse EBookListenerResponse; struct _EBookListener { BonoboObject parent; + /*< private >*/ EBookListenerPrivate *priv; }; diff --git a/addressbook/libebook/e-book-query.c b/addressbook/libebook/e-book-query.c index 3de88817f..c6a6bd474 100644 --- a/addressbook/libebook/e-book-query.c +++ b/addressbook/libebook/e-book-query.c @@ -65,12 +65,32 @@ conjoin (EBookQueryType type, int nqs, EBookQuery **qs, gboolean unref) return ret; } +/** + * e_book_query_and: + * @nqs: the number of queries to AND + * @qs: pointer to an array of #EBookQuery items + * @unref: if #TRUE, the new query takes ownership of the existing queries + * + * Create a new #EBookQuery which is the logical AND of the queries in #qs. + * + * Return value: A new #EBookQuery + */ EBookQuery * e_book_query_and (int nqs, EBookQuery **qs, gboolean unref) { return conjoin (E_BOOK_QUERY_TYPE_AND, nqs, qs, unref); } +/** + * e_book_query_or: + * @nqs: the number of queries to OR + * @qs: pointer to an array of #EBookQuery items + * @unref: if #TRUE, the new query takes ownership of the existing queries + * + * Create a new #EBookQuery which is the logical OR of the queries in #qs. + * + * Return value: A new #EBookQuery + */ EBookQuery * e_book_query_or (int nqs, EBookQuery **qs, gboolean unref) { @@ -98,6 +118,15 @@ conjoinv (EBookQueryType type, EBookQuery *q, va_list ap) return ret; } +/** + * e_book_query_andv: + * @q: first #EBookQuery + * @Varargs: #NULL terminated list of #EBookQuery pointers + * + * Create a new #EBookQuery which is the logical AND of the queries specified. + * + * Return value: A new #EBookQuery + */ EBookQuery * e_book_query_andv (EBookQuery *q, ...) { @@ -107,6 +136,15 @@ e_book_query_andv (EBookQuery *q, ...) return conjoinv (E_BOOK_QUERY_TYPE_AND, q, ap); } +/** + * e_book_query_orv: + * @q: first #EBookQuery + * @Varargs: #NULL terminated list of #EBookQuery pointers + * + * Create a new #EBookQuery which is the logical OR of the queries specified. + * + * Return value: A new #EBookQuery + */ EBookQuery * e_book_query_orv (EBookQuery *q, ...) { @@ -116,6 +154,15 @@ e_book_query_orv (EBookQuery *q, ...) return conjoinv (E_BOOK_QUERY_TYPE_OR, q, ap); } +/** + * e_book_query_not: + * @q: an #EBookQuery + * @unref: if #TRUE, the new query takes ownership of the existing queries + * + * Create a new #EBookQuery which is the opposite of #q. + * + * Return value: the new #EBookQuery + */ EBookQuery * e_book_query_not (EBookQuery *q, gboolean unref) { @@ -129,6 +176,16 @@ e_book_query_not (EBookQuery *q, gboolean unref) return ret; } +/** + * e_book_query_field_test: + * @field: an #EContactField to test + * @test: the test to apply + * @value: the value to test for + * + * Create a new #EBookQuery which tests @field for @value using the test @test. + * + * Return value: the new #EBookQuery + */ EBookQuery * e_book_query_field_test (EContactField field, EBookQueryTest test, @@ -144,6 +201,13 @@ e_book_query_field_test (EContactField field, return ret; } +/** + * e_book_query_field_exists: + * @field: a #EContactField + * + * Create a new #EBookQuery which tests if the field @field exists. + * Return value: the new #EBookQuery + */ EBookQuery * e_book_query_field_exists (EContactField field) { @@ -155,6 +219,14 @@ e_book_query_field_exists (EContactField field) return ret; } +/** + * e_book_query_any_field_contains: + * @value: a value + * + * Create a new #EBookQuery which tests if any field contains @value. + * + * Return value: the new #EBookQuery + */ EBookQuery * e_book_query_any_field_contains (const char *value) { @@ -166,6 +238,13 @@ e_book_query_any_field_contains (const char *value) return ret; } +/** + * e_book_query_unref: + * @q: an #EBookQuery + * + * 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. + */ void e_book_query_unref (EBookQuery *q) { @@ -201,10 +280,18 @@ e_book_query_unref (EBookQuery *q) g_free (q); } -void +/** + * e_book_query_ref: + * @q: a #EBookQuery + * + * Increment the reference count on @q. + * Return value: @q + */ +EBookQuery * e_book_query_ref (EBookQuery *q) { q->ref_count++; + return q; } static ESExpResult * @@ -413,6 +500,14 @@ static struct { { "endswith", func_endswith, 0 }, }; +/** + * e_book_query_from_string: + * @query_string: the query + * + * Parse @query_string and return a new #EBookQuery representing it. + * + * Return value: the new #EBookValue + */ EBookQuery* e_book_query_from_string (const char *query_string) { @@ -461,6 +556,15 @@ e_book_query_from_string (const char *query_string) return retval; } +/** + * e_book_query_to_string: + * @q: an #EBookQuery + * + * Return the string representation of @q. + * + * Return value: The string form of the query. This string should be freed when + * finished with. + */ char* e_book_query_to_string (EBookQuery *q) { diff --git a/addressbook/libebook/e-book-query.h b/addressbook/libebook/e-book-query.h index 994c33bc4..ff3bf2b51 100644 --- a/addressbook/libebook/e-book-query.h +++ b/addressbook/libebook/e-book-query.h @@ -23,10 +23,10 @@ typedef enum { #endif } EBookQueryTest; -EBookQuery* e_book_query_from_string (const char *sexp); +EBookQuery* e_book_query_from_string (const char *query_string); char* e_book_query_to_string (EBookQuery *q); -void e_book_query_ref (EBookQuery *q); +EBookQuery* e_book_query_ref (EBookQuery *q); void e_book_query_unref (EBookQuery *q); EBookQuery* e_book_query_and (int nqs, EBookQuery **qs, gboolean unref); @@ -34,7 +34,7 @@ EBookQuery* e_book_query_andv (EBookQuery *q, ...); EBookQuery* e_book_query_or (int nqs, EBookQuery **qs, gboolean unref); EBookQuery* e_book_query_orv (EBookQuery *q, ...); -EBookQuery* e_book_query_not (EBookQuery *qs, gboolean unref); +EBookQuery* e_book_query_not (EBookQuery *q, gboolean unref); EBookQuery* e_book_query_field_exists (EContactField field); EBookQuery* e_book_query_field_test (EContactField field, diff --git a/addressbook/libebook/e-book-view-listener.c b/addressbook/libebook/e-book-view-listener.c index 3ab2ff270..11e1d10c7 100644 --- a/addressbook/libebook/e-book-view-listener.c +++ b/addressbook/libebook/e-book-view-listener.c @@ -231,9 +231,8 @@ e_book_view_listener_construct (EBookViewListener *listener) /** * e_book_view_listener_new: - * @book: the #EBookView for which the listener is to be bound * - * Creates and returns a new #EBookViewListener for the book. + * Creates and returns a new #EBookViewListener. * * Returns: a new #EBookViewListener */ diff --git a/addressbook/libebook/e-book-view-listener.h b/addressbook/libebook/e-book-view-listener.h index 1b75eff04..b1114a9a5 100644 --- a/addressbook/libebook/e-book-view-listener.h +++ b/addressbook/libebook/e-book-view-listener.h @@ -33,6 +33,7 @@ typedef struct _EBookViewListenerResponse EBookViewListenerResponse; struct _EBookViewListener { BonoboObject parent; + /*< private >*/ EBookViewListenerPrivate *priv; }; diff --git a/addressbook/libebook/e-book-view.c b/addressbook/libebook/e-book-view.c index e5828c186..1d0500a2b 100644 --- a/addressbook/libebook/e-book-view.c +++ b/addressbook/libebook/e-book-view.c @@ -155,9 +155,6 @@ e_book_view_construct (EBookView *book_view, GNOME_Evolution_Addressbook_BookVie return TRUE; } -/** - * e_book_view_new: - */ EBookView * e_book_view_new (GNOME_Evolution_Addressbook_BookView corba_book_view, EBookViewListener *listener) { diff --git a/addressbook/libebook/e-book-view.h b/addressbook/libebook/e-book-view.h index 41019ac6d..9804ef9c9 100644 --- a/addressbook/libebook/e-book-view.h +++ b/addressbook/libebook/e-book-view.h @@ -33,6 +33,7 @@ struct _EBook; /* Forward reference */ struct _EBookView { GObject parent; + /*< private >*/ EBookViewPrivate *priv; }; diff --git a/addressbook/libebook/e-book.c b/addressbook/libebook/e-book.c index 9eabd37ea..0df67d50f 100644 --- a/addressbook/libebook/e-book.c +++ b/addressbook/libebook/e-book.c @@ -181,13 +181,14 @@ e_book_clear_op (EBook *book, /** - * e_book_add_card: + * e_book_add_contact: * @book: an #EBook * @contact: an #EContact + * @error: a #GError to set on failure. * * adds @contact to @book. * - * Return value: a #EBookStatus value. + * Return value: #TRUE if successful, #FALSE otherwise. **/ gboolean e_book_add_contact (EBook *book, @@ -294,11 +295,12 @@ e_book_response_add_contact (EBook *book, * e_book_commit_contact: * @book: an #EBook * @contact: an #EContact + * @error: a #GError to set on failure * * applies the changes made to @contact to the stored version in * @book. * - * Return value: a #EBookStatus value. + * Return value: #TRUE if successful, #FALSE otherwise **/ gboolean e_book_commit_contact (EBook *book, @@ -377,11 +379,12 @@ e_book_commit_contact (EBook *book, * e_book_get_supported_fields: * @book: an #EBook * @fields: a #GList + * @error: a #GError to set on failure * - * queries @book for the list of fields it supports. mostly for use + * Queries @book for the list of fields it supports. Mostly for use * by the contact editor so it knows what fields to sensitize. * - * Return value: a #EBookStatus value. + * Return value: #TRUE if successful, #FALSE otherwise **/ gboolean e_book_get_supported_fields (EBook *book, @@ -477,10 +480,11 @@ e_book_response_get_supported_fields (EBook *book, * e_book_get_supported_auth_methods: * @book: an #EBook * @auth_methods: a #GList + * @error: a #GError to set on failure * - * queries @book for the list of authentication methods it supports. + * Queries @book for the list of authentication methods it supports. * - * Return value: a #EBookStatus value. + * Return value: #TRUE if successful, #FALSE otherwise **/ gboolean e_book_get_supported_auth_methods (EBook *book, @@ -580,12 +584,13 @@ e_book_response_get_supported_auth_methods (EBook *book, * @user: a string * @passwd: a string * @auth_method: a string + * @error: a #GError to set on failure * - * authenticates @user with @passwd, using the auth method + * Authenticates @user with @passwd, using the auth method * @auth_method. @auth_method must be one of the authentication * methods returned using e_book_get_supported_auth_methods. * - * Return value: a #EBookStatus value. + * Return value: #TRUE if successful, #FALSE otherwise **/ gboolean e_book_authenticate_user (EBook *book, @@ -664,11 +669,12 @@ e_book_authenticate_user (EBook *book, * @book: an #EBook * @id: a string * @contact: an #EContact + * @error: a #GError to set on failure * * Fills in @contact with the contents of the vcard in @book * corresponding to @id. * - * Return value: a #EBookStatus value. + * Return value: #TRUE if successful, #FALSE otherwise **/ gboolean e_book_get_contact (EBook *book, @@ -768,10 +774,11 @@ e_book_response_get_contact (EBook *book, * e_book_remove_contact: * @book: an #EBook * @id: a string + * @error: a #GError to set on failure * * Removes the contact with id @id from @book. * - * Return value: a #EBookStatus value. + * Return value: #TRUE if successful, #FALSE otherwise **/ gboolean e_book_remove_contact (EBook *book, @@ -813,13 +820,14 @@ e_book_remove_contact (EBook *book, * e_book_remove_contacts: * @book: an #EBook * @ids: an #GList of const char *id's + * @error: a #GError to set on failure * * Removes the contacts with ids from the list @ids from @book. This is * always more efficient than calling e_book_remove_contact_by_id if you * have more than one id to remove, as some backends can implement it * as a batch request. * - * Return value: a #EBookStatus value. + * Return value: #TRUE if successful, #FALSE otherwise **/ gboolean e_book_remove_contacts (EBook *book, @@ -902,12 +910,16 @@ e_book_remove_contacts (EBook *book, * e_book_get_book_view: * @book: an #EBook * @query: an #EBookQuery - * @requested_fields a #GList containing the names of fields to return, or NULL for all - * @max_results the maximum number of contacts to show (or 0 for all) + * @requested_fields: a #GList containing the names of fields to return, or NULL for all + * @max_results: the maximum number of contacts to show (or 0 for all) + * @book_view: A #EBookView pointer, will be set to the view + * @error: a #GError to set on failure * - * need docs here.. + * Query @book with @query, creating a #EBookView in @book_view with the fields + * specified by @requested_fields and limited at @max_results records. On an + * error, @error is set and #FALSE returned. * - * Return value: a #EBookStatus value. + * Return value: #TRUE if successful, #FALSE otherwise **/ gboolean e_book_get_book_view (EBook *book, @@ -1038,10 +1050,13 @@ e_book_response_get_book_view (EBook *book, * e_book_get_contacts: * @book: an #EBook * @query: an #EBookQuery + * @contacts: a #GList pointer, will be set to the list of contacts + * @error: a #GError to set on failure * - * need docs here.. + * Query @book with @query, setting @contacts to the list of contacts which + * matched. On failed, @error will be set and #FALSE returned. * - * Return value: a #EBookStatus value. + * Return value: #TRUE on success, #FALSE otherwise **/ gboolean e_book_get_contacts (EBook *book, @@ -1276,6 +1291,7 @@ e_book_response_generic (EBook *book, /** * e_book_cancel: * @book: an #EBook + * @error: a #GError to set on failure * * Used to cancel an already running operation on @book. This * function makes a synchronous CORBA to the backend telling it to @@ -1287,7 +1303,7 @@ e_book_response_generic (EBook *book, * blocked e_book function corresponding to current operation will * return with a status of E_BOOK_STATUS_CANCELLED. * - * Return value: a #EBookStatus value. + * Return value: #TRUE on success, #FALSE otherwise **/ gboolean e_book_cancel (EBook *book, @@ -1370,6 +1386,16 @@ e_book_response_open (EBook *book, +/** + * e_book_remove: + * @book: an #EBook + * @error: a #GError to set on failure + * + * Remove the backing data for this #EBook. For example, with the file backend this + * deletes the database file. You cannot get it back! + * + * Return value: #TRUE on success, #FALSE on failure. + */ gboolean e_book_remove (EBook *book, GError **error) @@ -1507,6 +1533,15 @@ e_book_handle_response (EBookListener *listener, EBookListenerResponse *resp, EB +/** + * e_book_unload_uri: + * @book: an #EBook + * @error: an #GError to set on failure + * + * Unload the URI that this book had previously loaded. + * + * Return value: #TRUE on success, #FALSE otherwise. + */ gboolean e_book_unload_uri (EBook *book, GError **error) @@ -1753,6 +1788,17 @@ fetch_corba_book (EBook *book, return rv; } +/** + * e_book_load_source: + * @book: an #EBook + * @source: the #ESource to load + * @only_if_exists: if #TRUE, fail if this source doesn't already exist otherwise create it first + * @error: a #GError to set on failure + * + * Load the specified source into the book. + * + * Return value: #TRUE if the source was loaded, #FALSE otherwise. + */ gboolean e_book_load_source (EBook *book, ESource *source, @@ -1768,6 +1814,17 @@ e_book_load_source (EBook *book, return fetch_corba_book (book, source, only_if_exists, error); } +/** + * e_book_load_uri: + * @book: an #EBook + * @uri: the URI to load + * @only_if_exists: if #TRUE, fail if this URI doesn't already exist otherwise create it first + * @error: a #GError to set on failure + * + * Create an #ESource from #url and load the source. See e_book_load_source(). + * + * Return value: #TRUE if the URI was loaded, #FALSE otherwise. + */ gboolean e_book_load_uri (EBook *book, const char *uri, @@ -1796,6 +1853,15 @@ e_book_load_uri (EBook *book, return rv; } +/** + * e_book_load_local_addressbook: + * @book: an #EBook + * @error: a #GError + * + * Load the local address book into #book. + * + * Return value: #TRUE on success, #FALSE otherwise. + */ gboolean e_book_load_local_addressbook (EBook *book, GError **error) @@ -1818,18 +1884,44 @@ e_book_load_local_addressbook (EBook *book, return rv; } +/** + * e_book_get_uri: + * @book: an #EBook + * + * Get the URI that this book has loaded. This string should not be freed. + * + * Return value: The URI. + */ const char * e_book_get_uri (EBook *book) { return book->priv->uri; } +/** + * e_book_get_source: + * @book: an #EBook + * + * Get the #ESource that this book has loaded. + * + * Return value: The source. + */ ESource * e_book_get_source (EBook *book) { return book->priv->source; } +/** + * e_book_get_static_capabilities: + * @book: an #EBook + * @error: an #GError to set on failure + * + * Get the list of capabilities which the backend for this address book + * supports. This string should not be freed. + * + * Return value: The capabilities list + */ const char * e_book_get_static_capabilities (EBook *book, GError **error) @@ -1865,6 +1957,16 @@ e_book_get_static_capabilities (EBook *book, return book->priv->cap; } +/** + * e_book_check_static_capability: + * @book: an #EBook + * @cap: A capability string + * + * Check to see if the backend for this address book supports the capability + * @cap. + * + * Return value: #TRUE if the backend supports @cap, #FALSE otherwise. + */ gboolean e_book_check_static_capability (EBook *book, const char *cap) @@ -1878,6 +1980,14 @@ e_book_check_static_capability (EBook *book, return FALSE; } +/** + * e_book_is_writable: + * @book: an #EBook + * + * Check if this book is writable. + * + * Return value: #TRUE if this book is writable, otherwise #FALSE. + */ gboolean e_book_is_writable (EBook *book) { @@ -1955,6 +2065,16 @@ e_book_is_self (EContact *contact) +/** + * e_book_get_default_addressbook: + * @book: The address of a pointer to an #EBook + * @error: A #GError pointer + * + * Convience function to open the default address book. Pass it the address of a + * #EBook* and if this returns #TRUE, #book is set to an opened #EBook. + * + * Return value: #TRUE if the default addressbook was opened, otherwise #FALSE. + */ gboolean e_book_get_default_addressbook (EBook **book, GError **error) { @@ -1984,6 +2104,16 @@ e_book_get_default_addressbook (EBook **book, GError **error) return rv; } +/** + * e_book_get_addressbooks: + * @addressbook_sources: A pointer to a ESourceList* to set + * @error: A pointer to a GError* to set on error + * + * Populate *addressbook_sources with the list of all sources which have been + * added to Evolution. + * + * Return value: #TRUE if @addressbook_sources was set, otherwise #FALSE. + */ gboolean e_book_get_addressbooks (ESourceList **addressbook_sources, GError **error) { @@ -2021,6 +2151,15 @@ e_book_activate() +/** + * e_book_new: + * + * Creates a new #EBook. Use e_book_load_uri() or + * e_book_load_local_addressbook() to access a data store. Alternatively use + * e_book_get_default_addressbook(). + * + * Return value: a new but unopened #EBook. + **/ EBook* e_book_new (void) { diff --git a/addressbook/libebook/e-book.h b/addressbook/libebook/e-book.h index 5a43ca719..015976256 100644 --- a/addressbook/libebook/e-book.h +++ b/addressbook/libebook/e-book.h @@ -37,6 +37,7 @@ typedef struct _EBookPrivate EBookPrivate; struct _EBook { GObject parent; + /*< private >*/ EBookPrivate *priv; }; @@ -108,7 +109,7 @@ gboolean e_book_remove_contact (EBook *book, GError **error); gboolean e_book_remove_contacts (EBook *book, - GList *id_list, + GList *ids, GError **error); /* Adding contacts. */ diff --git a/addressbook/libebook/e-contact.h b/addressbook/libebook/e-contact.h index 742f86d48..b6677497d 100644 --- a/addressbook/libebook/e-contact.h +++ b/addressbook/libebook/e-contact.h @@ -189,7 +189,7 @@ typedef struct { struct _EContact { EVCard parent; - + /*< private >*/ EContactPrivate *priv; }; diff --git a/addressbook/libebook/e-name-western.c b/addressbook/libebook/e-name-western.c index 36fa1932b..a769999c4 100644 --- a/addressbook/libebook/e-name-western.c +++ b/addressbook/libebook/e-name-western.c @@ -961,9 +961,9 @@ e_name_western_parse (const char *full_name) /** * e_name_western_free: - * @name: An ENameWestern object which needs to be freed. + * @w: An ENameWestern object which needs to be freed. * - * Deep-frees @name + * Deep-frees @w */ void e_name_western_free (ENameWestern *w) diff --git a/addressbook/libebook/e-vcard.h b/addressbook/libebook/e-vcard.h index 7b10aa6a9..ae6f12316 100644 --- a/addressbook/libebook/e-vcard.h +++ b/addressbook/libebook/e-vcard.h @@ -61,6 +61,7 @@ #define EVC_X_ASSISTANT "X-EVOLUTION-ASSISTANT" #define EVC_X_BIRTHDAY "X-EVOLUTION-BIRTHDAY" #define EVC_X_BLOG_URL "X-EVOLUTION-BLOG-URL" +#define EVC_X_VIDEO_URL "X-EVOLUTION-VIDEO-URL" #define EVC_X_CALLBACK "X-EVOLUTION-CALLBACK" #define EVC_X_FILE_AS "X-EVOLUTION-FILE-AS" #define EVC_X_ICQ "X-ICQ" @@ -96,7 +97,7 @@ typedef struct _EVCardAttributeParam EVCardAttributeParam; struct _EVCard { GObject parent; - + /*< private >*/ EVCardPrivate *priv; }; diff --git a/docs/reference/addressbook/libebook/libebook-docs.sgml b/docs/reference/addressbook/libebook/libebook-docs.sgml index a70abcbc6..c196b5cc6 100644 --- a/docs/reference/addressbook/libebook/libebook-docs.sgml +++ b/docs/reference/addressbook/libebook/libebook-docs.sgml @@ -3,19 +3,19 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> <book id="index" xmlns:xi="http://www.w3.org/2001/XInclude"> <bookinfo> -<title>Evolution API Reference: libebook, the Addressbook Library</title> + <title>Evolution API Reference: libebook, the Addressbook Library</title> </bookinfo> <chapter> <title>Evolution API Reference: libebook, the Addressbook Library</title> - <xi:include href="xml/e-book-listener.xml"/> - <xi:include href="xml/e-book-view-listener.xml"/> - <xi:include href="xml/e-book-view.xml"/> <xi:include href="xml/e-book.xml"/> + <xi:include href="xml/e-book-query.xml"/> <xi:include href="xml/e-contact.xml"/> <xi:include href="xml/e-vcard.xml"/> + <xi:include href="xml/e-book-listener.xml"/> + <xi:include href="xml/e-book-view.xml"/> + <xi:include href="xml/e-book-view-listener.xml"/> <xi:include href="xml/e-book-async.xml"/> - <xi:include href="xml/e-book-query.xml"/> <xi:include href="xml/e-book-types.xml"/> <xi:include href="xml/e-address-western.xml"/> <xi:include href="xml/e-name-western.xml"/> diff --git a/docs/reference/addressbook/libebook/libebook-sections.txt b/docs/reference/addressbook/libebook/libebook-sections.txt index 87ec972f9..061c2ceec 100644 --- a/docs/reference/addressbook/libebook/libebook-sections.txt +++ b/docs/reference/addressbook/libebook/libebook-sections.txt @@ -1,11 +1,13 @@ <SECTION> <FILE>e-book-listener</FILE> -EBookListenerResponse <TITLE>EBookListener</TITLE> +EBookListener +EBookListenerResponse EBookListenerOperation e_book_listener_new e_book_listener_stop <SUBSECTION Standard> +EBookListenerClass E_BOOK_LISTENER E_IS_BOOK_LISTENER E_TYPE_BOOK_LISTENER @@ -19,12 +21,14 @@ EBookListenerPrivate <SECTION> <FILE>e-book-view-listener</FILE> -EBookViewListenerResponse <TITLE>EBookViewListener</TITLE> +EBookViewListener +EBookViewListenerResponse EBookViewListenerOperation e_book_view_listener_new e_book_view_listener_stop <SUBSECTION Standard> +EBookViewListenerClass E_BOOK_VIEW_LISTENER E_IS_BOOK_VIEW_LISTENER E_TYPE_BOOK_VIEW_LISTENER @@ -39,11 +43,13 @@ EBookViewListenerPrivate <SECTION> <FILE>e-book-view</FILE> <TITLE>EBookView</TITLE> +EBookView e_book_view_new e_book_view_set_book e_book_view_start e_book_view_stop <SUBSECTION Standard> +EBookViewClass E_BOOK_VIEW E_IS_BOOK_VIEW E_TYPE_BOOK_VIEW @@ -58,7 +64,9 @@ EBookViewPrivate <SECTION> <FILE>e-book</FILE> <TITLE>EBook</TITLE> +EBook e_book_new +e_book_load_source e_book_load_uri e_book_unload_uri e_book_remove @@ -82,9 +90,11 @@ e_book_is_writable e_book_cancel e_book_get_self e_book_set_self +e_book_is_self e_book_get_default_addressbook e_book_get_addressbooks <SUBSECTION Standard> +EBookClass E_BOOK E_IS_BOOK E_TYPE_BOOK @@ -98,12 +108,13 @@ EBookPrivate <SECTION> <FILE>e-contact</FILE> +<TITLE>EContact</TITLE> +EContact EContactField EContactName EContactPhoto EContactAddress EContactDate -<TITLE>EContact</TITLE> e_contact_new e_contact_new_from_vcard e_contact_duplicate @@ -113,6 +124,7 @@ e_contact_set e_contact_date_new e_contact_date_from_string e_contact_date_to_string +e_contact_date_equal e_contact_name_new e_contact_name_to_string e_contact_name_from_string @@ -125,19 +137,65 @@ e_contact_field_name e_contact_pretty_name e_contact_field_id <SUBSECTION Standard> +EContactClass E_CONTACT E_IS_CONTACT E_TYPE_CONTACT -e_contact_get_type E_CONTACT_CLASS E_IS_CONTACT_CLASS E_CONTACT_GET_CLASS +e_contact_get_type +e_contact_address_get_type +e_contact_photo_get_type +e_contact_name_get_type +e_contact_date_get_type + <SUBSECTION Private> EContactPrivate </SECTION> <SECTION> <FILE>e-vcard</FILE> +<TITLE>EVCard</TITLE> +EVCard +EVCardFormat +EVCardAttribute +EVCardAttributeParam +e_vcard_construct +e_vcard_new +e_vcard_new_from_string +e_vcard_to_string +e_vcard_dump_structure +e_vcard_attribute_new +e_vcard_attribute_free +e_vcard_attribute_copy +e_vcard_remove_attributes +e_vcard_remove_attribute +e_vcard_add_attribute +e_vcard_add_attribute_with_value +e_vcard_add_attribute_with_values +e_vcard_attribute_add_value +e_vcard_attribute_add_value_decoded +e_vcard_attribute_add_values +e_vcard_attribute_remove_values +e_vcard_attribute_remove_params +e_vcard_attribute_param_new +e_vcard_attribute_param_free +e_vcard_attribute_param_copy +e_vcard_attribute_add_param +e_vcard_attribute_add_param_with_value +e_vcard_attribute_add_param_with_values +e_vcard_attribute_param_add_value +e_vcard_attribute_param_add_values +e_vcard_attribute_param_remove_values +e_vcard_get_attributes +e_vcard_attribute_get_group +e_vcard_attribute_get_name +e_vcard_attribute_get_values +e_vcard_attribute_get_values_decoded +e_vcard_attribute_get_params +e_vcard_attribute_param_get_name +e_vcard_attribute_param_get_values EVC_ADR EVC_BDAY EVC_CALURI @@ -181,46 +239,8 @@ EVC_X_MSN EVC_X_SPOUSE EVC_X_WANTS_HTML EVC_X_YAHOO -EVCardFormat -EVCardAttribute -EVCardAttributeParam -<TITLE>EVCard</TITLE> -e_vcard_construct -e_vcard_new -e_vcard_new_from_string -e_vcard_to_string -e_vcard_dump_structure -e_vcard_attribute_new -e_vcard_attribute_free -e_vcard_attribute_copy -e_vcard_remove_attributes -e_vcard_remove_attribute -e_vcard_add_attribute -e_vcard_add_attribute_with_value -e_vcard_add_attribute_with_values -e_vcard_attribute_add_value -e_vcard_attribute_add_value_decoded -e_vcard_attribute_add_values -e_vcard_attribute_remove_values -e_vcard_attribute_remove_params -e_vcard_attribute_param_new -e_vcard_attribute_param_free -e_vcard_attribute_param_copy -e_vcard_attribute_add_param -e_vcard_attribute_add_param_with_value -e_vcard_attribute_add_param_with_values -e_vcard_attribute_param_add_value -e_vcard_attribute_param_add_values -e_vcard_attribute_param_remove_values -e_vcard_get_attributes -e_vcard_attribute_get_group -e_vcard_attribute_get_name -e_vcard_attribute_get_values -e_vcard_attribute_get_values_decoded -e_vcard_attribute_get_params -e_vcard_attribute_param_get_name -e_vcard_attribute_param_get_values <SUBSECTION Standard> +EVCardClass E_VCARD E_IS_VCARD E_TYPE_VCARD @@ -242,6 +262,7 @@ EBookContactsCallback EBookBookViewCallback EBookFieldsCallback EBookAuthMethodsCallback +e_book_async_load_source e_book_async_load_uri e_book_async_get_default_addressbook e_book_async_unload_uri @@ -260,6 +281,7 @@ e_book_async_get_book_view <SECTION> <FILE>e-book-query</FILE> +EBookQuery EBookQueryTest e_book_query_from_string e_book_query_to_string @@ -287,6 +309,7 @@ EBookChange <SECTION> <FILE>e-address-western</FILE> +<TITLE>EAddressWestern</TITLE> EAddressWestern e_address_western_parse e_address_western_free @@ -298,6 +321,7 @@ e_address_western_free <SECTION> <FILE>e-name-western</FILE> +<TITLE>ENameWestern</TITLE> ENameWestern e_name_western_parse e_name_western_free diff --git a/docs/reference/addressbook/libebook/libebook.types b/docs/reference/addressbook/libebook/libebook.types index cb5150502..d59ca0a5a 100644 --- a/docs/reference/addressbook/libebook/libebook.types +++ b/docs/reference/addressbook/libebook/libebook.types @@ -4,4 +4,4 @@ e_book_view_listener_get_type e_book_view_get_type e_book_get_type e_contact_get_type -e_vcard_get_type
\ No newline at end of file +e_vcard_get_type diff --git a/docs/reference/addressbook/libebook/tmpl/e-address-western.sgml b/docs/reference/addressbook/libebook/tmpl/e-address-western.sgml index 5c2d9dc8e..cb27d98d9 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-address-western.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-address-western.sgml @@ -14,18 +14,11 @@ A physical address in the format used in the Western hemisphere. </para> -<!-- ##### STRUCT EAddressWestern ##### --> +<!-- ##### TYPEDEF EAddressWestern ##### --> <para> </para> -@po_box: -@extended: -@street: -@locality: -@region: -@postal_code: -@country: <!-- ##### FUNCTION e_address_western_parse ##### --> <para> diff --git a/docs/reference/addressbook/libebook/tmpl/e-book-async.sgml b/docs/reference/addressbook/libebook/tmpl/e-book-async.sgml index c3556fe9d..697ddf9c6 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-book-async.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-book-async.sgml @@ -102,6 +102,17 @@ Handles asynchronous interactions with the EBook. @closure: +<!-- ##### FUNCTION e_book_async_load_source ##### --> +<para> + +</para> + +@book: +@source: +@open_response: +@closure: + + <!-- ##### FUNCTION e_book_async_load_uri ##### --> <para> @@ -256,6 +267,8 @@ Handles asynchronous interactions with the EBook. @book: @query: +@requested_fields: +@max_results: @cb: @closure: @Returns: diff --git a/docs/reference/addressbook/libebook/tmpl/e-book-listener.sgml b/docs/reference/addressbook/libebook/tmpl/e-book-listener.sgml index 340d3c041..82994f8e8 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-book-listener.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-book-listener.sgml @@ -15,6 +15,12 @@ Exposes the Evolution:BookListener interface. Contrast with EBookViewListener. </para> +<!-- ##### STRUCT EBookListener ##### --> +<para> + +</para> + + <!-- ##### STRUCT EBookListenerResponse ##### --> <para> @@ -68,3 +74,11 @@ Exposes the Evolution:BookListener interface. Contrast with EBookViewListener. @listener: +<!-- ##### SIGNAL EBookListener::response ##### --> +<para> + +</para> + +@ebooklistener: the object which received the signal. +@arg1: + diff --git a/docs/reference/addressbook/libebook/tmpl/e-book-query.sgml b/docs/reference/addressbook/libebook/tmpl/e-book-query.sgml index a8eea07f0..0ecbd300f 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-book-query.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-book-query.sgml @@ -33,8 +33,10 @@ Handles queries of addressboook data. </para> -@sexp: +@query_string: @Returns: +<!-- # Unused Parameters # --> +@sexp: <!-- ##### FUNCTION e_book_query_to_string ##### --> @@ -52,6 +54,7 @@ Handles queries of addressboook data. </para> @q: +@Returns: <!-- ##### FUNCTION e_book_query_unref ##### --> @@ -109,9 +112,11 @@ Handles queries of addressboook data. </para> -@qs: +@q: @unref: @Returns: +<!-- # Unused Parameters # --> +@qs: <!-- ##### FUNCTION e_book_query_field_exists ##### --> diff --git a/docs/reference/addressbook/libebook/tmpl/e-book-types.sgml b/docs/reference/addressbook/libebook/tmpl/e-book-types.sgml index 149a2b240..ce583ee29 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-book-types.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-book-types.sgml @@ -77,11 +77,9 @@ Evolution:BookListener interface. @E_BOOK_CHANGE_CARD_DELETED: @E_BOOK_CHANGE_CARD_MODIFIED: -<!-- ##### STRUCT EBookChange ##### --> +<!-- ##### TYPEDEF EBookChange ##### --> <para> </para> -@change_type: -@contact: diff --git a/docs/reference/addressbook/libebook/tmpl/e-book-view-listener.sgml b/docs/reference/addressbook/libebook/tmpl/e-book-view-listener.sgml index bf3686099..2064a94fb 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-book-view-listener.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-book-view-listener.sgml @@ -15,6 +15,12 @@ EBookListener EBookTypes </para> +<!-- ##### STRUCT EBookViewListener ##### --> +<para> + +</para> + + <!-- ##### STRUCT EBookViewListenerResponse ##### --> <para> Data sent back to the e-book object. @@ -53,3 +59,11 @@ Stops the listener. @listener: +<!-- ##### SIGNAL EBookViewListener::response ##### --> +<para> + +</para> + +@ebookviewlistener: the object which received the signal. +@arg1: + diff --git a/docs/reference/addressbook/libebook/tmpl/e-book-view.sgml b/docs/reference/addressbook/libebook/tmpl/e-book-view.sgml index 8ecce0bf1..c8a2edd45 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-book-view.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-book-view.sgml @@ -16,6 +16,12 @@ addressbook itself. #e-book-view-listener, #e-book </para> +<!-- ##### STRUCT EBookView ##### --> +<para> + +</para> + + <!-- ##### FUNCTION e_book_view_new ##### --> <para> @@ -51,3 +57,45 @@ addressbook itself. @book_view: +<!-- ##### SIGNAL EBookView::contacts-added ##### --> +<para> +Fired when more contacts are found. Each contact in the list will be unref'd +when done, and the list freed, so simply reference any contacts you want to +keep. +</para> + +@ebookview: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EBookView::contacts-changed ##### --> +<para> + +</para> + +@ebookview: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EBookView::contacts-removed ##### --> +<para> + +</para> + +@ebookview: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EBookView::sequence-complete ##### --> +<para> + +</para> + +@ebookview: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EBookView::status-message ##### --> +<para> + +</para> + +@ebookview: the object which received the signal. +@arg1: + diff --git a/docs/reference/addressbook/libebook/tmpl/e-book.sgml b/docs/reference/addressbook/libebook/tmpl/e-book.sgml index 4a0d8f158..8df591606 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-book.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-book.sgml @@ -15,6 +15,12 @@ Represents a complete addressbook. Event notifications and callbacks go to the #e-book-listener, #e-book-view </para> +<!-- ##### STRUCT EBook ##### --> +<para> +#EBook has no publicly available members. +</para> + + <!-- ##### FUNCTION e_book_new ##### --> <para> @@ -23,6 +29,18 @@ Represents a complete addressbook. Event notifications and callbacks go to the @Returns: +<!-- ##### FUNCTION e_book_load_source ##### --> +<para> + +</para> + +@book: +@source: +@only_if_exists: +@error: +@Returns: + + <!-- ##### FUNCTION e_book_load_uri ##### --> <para> @@ -129,7 +147,7 @@ Represents a complete addressbook. Event notifications and callbacks go to the </para> @book: -@id_list: +@ids: @error: @Returns: @@ -252,7 +270,7 @@ Represents a complete addressbook. Event notifications and callbacks go to the <!-- ##### FUNCTION e_book_get_self ##### --> <para> -Gets the address information for the current Evolution user. + </para> @contact: @@ -274,6 +292,15 @@ Gets the address information for the current Evolution user. @id: +<!-- ##### FUNCTION e_book_is_self ##### --> +<para> + +</para> + +@contact: +@Returns: + + <!-- ##### FUNCTION e_book_get_default_addressbook ##### --> <para> @@ -294,3 +321,18 @@ Gets the address information for the current Evolution user. @Returns: +<!-- ##### SIGNAL EBook::backend-died ##### --> +<para> +The backend for this address book has died. +</para> + +@ebook: the object which received the signal. + +<!-- ##### SIGNAL EBook::writable-status ##### --> +<para> + +</para> + +@ebook: the object which received the signal. +@arg1: + diff --git a/docs/reference/addressbook/libebook/tmpl/e-contact.sgml b/docs/reference/addressbook/libebook/tmpl/e-contact.sgml index a6e5a680c..be7c295f7 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-contact.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-contact.sgml @@ -14,6 +14,12 @@ A convenient way of accessing the contact information in EVCard objects. #e-vcard </para> +<!-- ##### STRUCT EContact ##### --> +<para> + +</para> + + <!-- ##### ENUM EContactField ##### --> <para> @@ -64,6 +70,7 @@ A convenient way of accessing the contact information in EVCard objects. @E_CONTACT_CALENDAR_URI: @E_CONTACT_FREEBUSY_URL: @E_CONTACT_ICS_CALENDAR: +@E_CONTACT_VIDEO_URL: @E_CONTACT_SPOUSE: @E_CONTACT_NOTE: @E_CONTACT_IS_LIST: @@ -86,7 +93,6 @@ A convenient way of accessing the contact information in EVCard objects. @E_CONTACT_BIRTH_DATE: @E_CONTACT_ANNIVERSARY: @E_CONTACT_X509_CERT: -@E_CONTACT_X509_CERT_SHA1_FINGERPRINT: @E_CONTACT_NAME_OR_ORG: @E_CONTACT_FIELD_LAST: @E_CONTACT_LAST_SIMPLE_STRING: @@ -99,47 +105,29 @@ A convenient way of accessing the contact information in EVCard objects. @E_CONTACT_FIRST_LABEL_ID: @E_CONTACT_LAST_LABEL_ID: -<!-- ##### STRUCT EContactName ##### --> +<!-- ##### TYPEDEF EContactName ##### --> <para> </para> -@family: -@given: -@additional: -@prefixes: -@suffixes: -<!-- ##### STRUCT EContactPhoto ##### --> +<!-- ##### TYPEDEF EContactPhoto ##### --> <para> </para> -@length: -@data: -<!-- ##### STRUCT EContactAddress ##### --> +<!-- ##### TYPEDEF EContactAddress ##### --> <para> </para> -@address_format: -@po: -@ext: -@street: -@locality: -@region: -@code: -@country: -<!-- ##### STRUCT EContactDate ##### --> +<!-- ##### TYPEDEF EContactDate ##### --> <para> </para> -@year: -@month: -@day: <!-- ##### FUNCTION e_contact_new ##### --> <para> @@ -223,6 +211,16 @@ A convenient way of accessing the contact information in EVCard objects. @Returns: +<!-- ##### FUNCTION e_contact_date_equal ##### --> +<para> + +</para> + +@dt1: +@dt2: +@Returns: + + <!-- ##### FUNCTION e_contact_name_new ##### --> <para> @@ -317,3 +315,343 @@ A convenient way of accessing the contact information in EVCard objects. @Returns: +<!-- ##### ARG EContact:address ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:address-home ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:address-label-home ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:address-label-other ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:address-label-work ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:address-other ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:address-work ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:anniversary ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:assistant ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:assistant-phone ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:birth-date ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:blog-url ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:business-fax ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:business-phone ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:business-phone-2 ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:callback-phone ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:caluri ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:car-phone ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:categories ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:company-phone ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:email ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:email-1 ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:email-2 ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:email-3 ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:family-name ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:fburl ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:file-as ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:full-name ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:given-name ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:home-fax ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:home-phone ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:home-phone-2 ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:homepage-url ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:icscalendar ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:id ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:im-aim ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:im-icq ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:im-jabber ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:im-msn ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:im-yahoo ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:isdn-phone ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:list ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:list-show-addresses ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:logo ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:mailer ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:manager ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:mobile-phone ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:name ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:name-or-org ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:nickname ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:note ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:office ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:org ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:org-unit ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:other-fax ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:other-phone ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:pager ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:photo ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:primary-phone ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:radio ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:role ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:spouse ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:telex ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:title ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:tty ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:video-url ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:wants-html ##### --> +<para> + +</para> + +<!-- ##### ARG EContact:x509Cert ##### --> +<para> + +</para> + diff --git a/docs/reference/addressbook/libebook/tmpl/e-name-western.sgml b/docs/reference/addressbook/libebook/tmpl/e-name-western.sgml index daf37dd5b..d763c1138 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-name-western.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-name-western.sgml @@ -14,18 +14,11 @@ e-name-western </para> -<!-- ##### STRUCT ENameWestern ##### --> +<!-- ##### TYPEDEF ENameWestern ##### --> <para> </para> -@prefix: -@first: -@middle: -@nick: -@last: -@suffix: -@full: <!-- ##### FUNCTION e_name_western_parse ##### --> <para> diff --git a/docs/reference/addressbook/libebook/tmpl/e-vcard.sgml b/docs/reference/addressbook/libebook/tmpl/e-vcard.sgml index 44b59072c..2315e4f91 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-vcard.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-vcard.sgml @@ -14,640 +14,646 @@ Does the low-level parsing work for contact information. This data is more conve #e-contact </para> -<!-- ##### MACRO EVC_ADR ##### --> +<!-- ##### STRUCT EVCard ##### --> <para> </para> - -<!-- ##### MACRO EVC_BDAY ##### --> +<!-- ##### ENUM EVCardFormat ##### --> <para> </para> +@EVC_FORMAT_VCARD_21: +@EVC_FORMAT_VCARD_30: - -<!-- ##### MACRO EVC_CALURI ##### --> +<!-- ##### STRUCT EVCardAttribute ##### --> <para> </para> - -<!-- ##### MACRO EVC_CATEGORIES ##### --> +<!-- ##### STRUCT EVCardAttributeParam ##### --> <para> </para> - -<!-- ##### MACRO EVC_EMAIL ##### --> +<!-- ##### FUNCTION e_vcard_construct ##### --> <para> </para> +@evc: +@str: -<!-- ##### MACRO EVC_ENCODING ##### --> +<!-- ##### FUNCTION e_vcard_new ##### --> <para> </para> +@Returns: -<!-- ##### MACRO EVC_FBURL ##### --> +<!-- ##### FUNCTION e_vcard_new_from_string ##### --> <para> </para> +@str: +@Returns: -<!-- ##### MACRO EVC_FN ##### --> +<!-- ##### FUNCTION e_vcard_to_string ##### --> <para> </para> +@evc: +@format: +@Returns: -<!-- ##### MACRO EVC_ICSCALENDAR ##### --> +<!-- ##### FUNCTION e_vcard_dump_structure ##### --> <para> </para> +@evc: -<!-- ##### MACRO EVC_LABEL ##### --> +<!-- ##### FUNCTION e_vcard_attribute_new ##### --> <para> </para> +@attr_group: +@attr_name: +@Returns: -<!-- ##### MACRO EVC_LOGO ##### --> +<!-- ##### FUNCTION e_vcard_attribute_free ##### --> <para> </para> +@attr: -<!-- ##### MACRO EVC_MAILER ##### --> +<!-- ##### FUNCTION e_vcard_attribute_copy ##### --> <para> </para> +@attr: +@Returns: -<!-- ##### MACRO EVC_NICKNAME ##### --> +<!-- ##### FUNCTION e_vcard_remove_attributes ##### --> <para> </para> +@evcard: +@attr_group: +@attr_name: -<!-- ##### MACRO EVC_N ##### --> +<!-- ##### FUNCTION e_vcard_remove_attribute ##### --> <para> </para> +@evcard: +@attr: -<!-- ##### MACRO EVC_NOTE ##### --> +<!-- ##### FUNCTION e_vcard_add_attribute ##### --> <para> </para> +@evcard: +@attr: -<!-- ##### MACRO EVC_ORG ##### --> +<!-- ##### FUNCTION e_vcard_add_attribute_with_value ##### --> <para> </para> +@evcard: +@attr: +@value: -<!-- ##### MACRO EVC_PHOTO ##### --> +<!-- ##### FUNCTION e_vcard_add_attribute_with_values ##### --> <para> </para> +@evcard: +@attr: +@Varargs: -<!-- ##### MACRO EVC_PRODID ##### --> +<!-- ##### FUNCTION e_vcard_attribute_add_value ##### --> <para> </para> +@attr: +@value: -<!-- ##### MACRO EVC_QUOTEDPRINTABLE ##### --> +<!-- ##### FUNCTION e_vcard_attribute_add_value_decoded ##### --> <para> </para> +@attr: +@value: +@len: -<!-- ##### MACRO EVC_REV ##### --> +<!-- ##### FUNCTION e_vcard_attribute_add_values ##### --> <para> </para> +@attr: +@Varargs: -<!-- ##### MACRO EVC_ROLE ##### --> +<!-- ##### FUNCTION e_vcard_attribute_remove_values ##### --> <para> </para> +@attr: -<!-- ##### MACRO EVC_TEL ##### --> +<!-- ##### FUNCTION e_vcard_attribute_remove_params ##### --> <para> </para> +@attr: -<!-- ##### MACRO EVC_TITLE ##### --> +<!-- ##### FUNCTION e_vcard_attribute_param_new ##### --> <para> </para> +@param_name: +@Returns: -<!-- ##### MACRO EVC_TYPE ##### --> +<!-- ##### FUNCTION e_vcard_attribute_param_free ##### --> <para> </para> +@param: -<!-- ##### MACRO EVC_UID ##### --> +<!-- ##### FUNCTION e_vcard_attribute_param_copy ##### --> <para> </para> +@param: +@Returns: -<!-- ##### MACRO EVC_URL ##### --> +<!-- ##### FUNCTION e_vcard_attribute_add_param ##### --> <para> </para> +@attr: +@param: -<!-- ##### MACRO EVC_VALUE ##### --> +<!-- ##### FUNCTION e_vcard_attribute_add_param_with_value ##### --> <para> </para> +@attr: +@param: +@value: -<!-- ##### MACRO EVC_VERSION ##### --> +<!-- ##### FUNCTION e_vcard_attribute_add_param_with_values ##### --> <para> </para> +@attr: +@param: +@Varargs: -<!-- ##### MACRO EVC_X_AIM ##### --> +<!-- ##### FUNCTION e_vcard_attribute_param_add_value ##### --> <para> </para> +@param: +@value: -<!-- ##### MACRO EVC_X_ANNIVERSARY ##### --> +<!-- ##### FUNCTION e_vcard_attribute_param_add_values ##### --> <para> </para> +@param: +@Varargs: -<!-- ##### MACRO EVC_X_ASSISTANT ##### --> +<!-- ##### FUNCTION e_vcard_attribute_param_remove_values ##### --> <para> </para> +@param: -<!-- ##### MACRO EVC_X_BIRTHDAY ##### --> +<!-- ##### FUNCTION e_vcard_get_attributes ##### --> <para> </para> +@evcard: +@Returns: -<!-- ##### MACRO EVC_X_BLOG_URL ##### --> +<!-- ##### FUNCTION e_vcard_attribute_get_group ##### --> <para> </para> +@attr: +@Returns: -<!-- ##### MACRO EVC_X_FILE_AS ##### --> +<!-- ##### FUNCTION e_vcard_attribute_get_name ##### --> <para> </para> +@attr: +@Returns: -<!-- ##### MACRO EVC_X_ICQ ##### --> +<!-- ##### FUNCTION e_vcard_attribute_get_values ##### --> <para> </para> +@attr: +@Returns: -<!-- ##### MACRO EVC_X_JABBER ##### --> +<!-- ##### FUNCTION e_vcard_attribute_get_values_decoded ##### --> <para> </para> +@attr: +@Returns: -<!-- ##### MACRO EVC_X_LIST_SHOW_ADDRESSES ##### --> +<!-- ##### FUNCTION e_vcard_attribute_get_params ##### --> <para> </para> +@attr: +@Returns: -<!-- ##### MACRO EVC_X_LIST ##### --> +<!-- ##### FUNCTION e_vcard_attribute_param_get_name ##### --> <para> </para> +@param: +@Returns: -<!-- ##### MACRO EVC_X_MANAGER ##### --> +<!-- ##### FUNCTION e_vcard_attribute_param_get_values ##### --> <para> </para> +@param: +@Returns: -<!-- ##### MACRO EVC_X_MSN ##### --> +<!-- ##### MACRO EVC_ADR ##### --> <para> </para> -<!-- ##### MACRO EVC_X_SPOUSE ##### --> +<!-- ##### MACRO EVC_BDAY ##### --> <para> - +Birthday </para> -<!-- ##### MACRO EVC_X_WANTS_HTML ##### --> +<!-- ##### MACRO EVC_CALURI ##### --> <para> - +Calendar URL </para> -<!-- ##### MACRO EVC_X_YAHOO ##### --> +<!-- ##### MACRO EVC_CATEGORIES ##### --> <para> - +Categories </para> -<!-- ##### ENUM EVCardFormat ##### --> +<!-- ##### MACRO EVC_EMAIL ##### --> <para> - +Email address </para> -@EVC_FORMAT_VCARD_21: -@EVC_FORMAT_VCARD_30: -<!-- ##### STRUCT EVCardAttribute ##### --> + +<!-- ##### MACRO EVC_ENCODING ##### --> <para> </para> -<!-- ##### STRUCT EVCardAttributeParam ##### --> + +<!-- ##### MACRO EVC_FBURL ##### --> <para> </para> -<!-- ##### FUNCTION e_vcard_construct ##### --> + +<!-- ##### MACRO EVC_FN ##### --> <para> </para> -@evc: -@str: -<!-- ##### FUNCTION e_vcard_new ##### --> +<!-- ##### MACRO EVC_ICSCALENDAR ##### --> <para> </para> -@Returns: -<!-- ##### FUNCTION e_vcard_new_from_string ##### --> +<!-- ##### MACRO EVC_LABEL ##### --> <para> </para> -@str: -@Returns: -<!-- ##### FUNCTION e_vcard_to_string ##### --> +<!-- ##### MACRO EVC_LOGO ##### --> <para> </para> -@evc: -@format: -@Returns: -<!-- ##### FUNCTION e_vcard_dump_structure ##### --> +<!-- ##### MACRO EVC_MAILER ##### --> <para> </para> -@evc: -<!-- ##### FUNCTION e_vcard_attribute_new ##### --> +<!-- ##### MACRO EVC_NICKNAME ##### --> <para> - +Nickname </para> -@attr_group: -@attr_name: -@Returns: -<!-- ##### FUNCTION e_vcard_attribute_free ##### --> +<!-- ##### MACRO EVC_N ##### --> <para> </para> -@attr: -<!-- ##### FUNCTION e_vcard_attribute_copy ##### --> +<!-- ##### MACRO EVC_NOTE ##### --> <para> </para> -@attr: -@Returns: -<!-- ##### FUNCTION e_vcard_remove_attributes ##### --> +<!-- ##### MACRO EVC_ORG ##### --> <para> - +Organisation </para> -@evcard: -@attr_group: -@attr_name: -<!-- ##### FUNCTION e_vcard_remove_attribute ##### --> +<!-- ##### MACRO EVC_PHOTO ##### --> <para> - +Photo </para> -@evcard: -@attr: -<!-- ##### FUNCTION e_vcard_add_attribute ##### --> +<!-- ##### MACRO EVC_PRODID ##### --> <para> </para> -@evcard: -@attr: -<!-- ##### FUNCTION e_vcard_add_attribute_with_value ##### --> +<!-- ##### MACRO EVC_QUOTEDPRINTABLE ##### --> <para> </para> -@evcard: -@attr: -@value: -<!-- ##### FUNCTION e_vcard_add_attribute_with_values ##### --> +<!-- ##### MACRO EVC_REV ##### --> <para> </para> -@evcard: -@attr: -@Varargs: -<!-- ##### FUNCTION e_vcard_attribute_add_value ##### --> +<!-- ##### MACRO EVC_ROLE ##### --> <para> - +Role </para> -@attr: -@value: -<!-- ##### FUNCTION e_vcard_attribute_add_value_decoded ##### --> +<!-- ##### MACRO EVC_TEL ##### --> <para> - +Telephone </para> -@attr: -@value: -@len: -<!-- ##### FUNCTION e_vcard_attribute_add_values ##### --> +<!-- ##### MACRO EVC_TITLE ##### --> <para> - +Title </para> -@attr: -@Varargs: -<!-- ##### FUNCTION e_vcard_attribute_remove_values ##### --> +<!-- ##### MACRO EVC_TYPE ##### --> <para> </para> -@attr: -<!-- ##### FUNCTION e_vcard_attribute_remove_params ##### --> +<!-- ##### MACRO EVC_UID ##### --> <para> - +Unique ID </para> -@attr: -<!-- ##### FUNCTION e_vcard_attribute_param_new ##### --> +<!-- ##### MACRO EVC_URL ##### --> <para> - +Home page URL </para> -@param_name: -@Returns: -<!-- ##### FUNCTION e_vcard_attribute_param_free ##### --> +<!-- ##### MACRO EVC_VALUE ##### --> <para> </para> -@param: -<!-- ##### FUNCTION e_vcard_attribute_param_copy ##### --> +<!-- ##### MACRO EVC_VERSION ##### --> <para> </para> -@param: -@Returns: -<!-- ##### FUNCTION e_vcard_attribute_add_param ##### --> +<!-- ##### MACRO EVC_X_AIM ##### --> <para> - +AIM ID </para> -@attr: -@param: -<!-- ##### FUNCTION e_vcard_attribute_add_param_with_value ##### --> +<!-- ##### MACRO EVC_X_ANNIVERSARY ##### --> <para> - +Wedding anniversary </para> -@attr: -@param: -@value: -<!-- ##### FUNCTION e_vcard_attribute_add_param_with_values ##### --> +<!-- ##### MACRO EVC_X_ASSISTANT ##### --> <para> - +Assistant </para> -@attr: -@param: -@Varargs: -<!-- ##### FUNCTION e_vcard_attribute_param_add_value ##### --> +<!-- ##### MACRO EVC_X_BIRTHDAY ##### --> <para> - +Birthday </para> -@param: -@value: -<!-- ##### FUNCTION e_vcard_attribute_param_add_values ##### --> +<!-- ##### MACRO EVC_X_BLOG_URL ##### --> <para> - +Blog URL </para> -@param: -@Varargs: -<!-- ##### FUNCTION e_vcard_attribute_param_remove_values ##### --> +<!-- ##### MACRO EVC_X_FILE_AS ##### --> <para> - +File As </para> -@param: -<!-- ##### FUNCTION e_vcard_get_attributes ##### --> +<!-- ##### MACRO EVC_X_ICQ ##### --> <para> - +ICQ number </para> -@evcard: -@Returns: -<!-- ##### FUNCTION e_vcard_attribute_get_group ##### --> +<!-- ##### MACRO EVC_X_JABBER ##### --> <para> - +Jabber ID </para> -@attr: -@Returns: -<!-- ##### FUNCTION e_vcard_attribute_get_name ##### --> +<!-- ##### MACRO EVC_X_LIST_SHOW_ADDRESSES ##### --> <para> </para> -@attr: -@Returns: -<!-- ##### FUNCTION e_vcard_attribute_get_values ##### --> +<!-- ##### MACRO EVC_X_LIST ##### --> <para> </para> -@attr: -@Returns: -<!-- ##### FUNCTION e_vcard_attribute_get_values_decoded ##### --> +<!-- ##### MACRO EVC_X_MANAGER ##### --> <para> - +Mananger </para> -@attr: -@Returns: -<!-- ##### FUNCTION e_vcard_attribute_get_params ##### --> +<!-- ##### MACRO EVC_X_MSN ##### --> <para> - +MSN ID </para> -@attr: -@Returns: -<!-- ##### FUNCTION e_vcard_attribute_param_get_name ##### --> +<!-- ##### MACRO EVC_X_SPOUSE ##### --> <para> - +Spouse </para> -@param: -@Returns: -<!-- ##### FUNCTION e_vcard_attribute_param_get_values ##### --> +<!-- ##### MACRO EVC_X_WANTS_HTML ##### --> <para> +Wants HTML mail +</para> + + +<!-- ##### MACRO EVC_X_YAHOO ##### --> +<para> +Yahoo ID </para> -@param: -@Returns: diff --git a/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml b/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml index da304d273..70d05e6de 100644 --- a/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml +++ b/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml @@ -18,29 +18,6 @@ e-book-marshal -<!-- ##### SIGNAL EBook::backend-died ##### --> -<para> - -</para> - -@ebook: the object which received the signal. - -<!-- ##### SIGNAL EBook::writable-status ##### --> -<para> - -</para> - -@ebook: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EBookListener::response ##### --> -<para> - -</para> - -@ebooklistener: the object which received the signal. -@arg1: - <!-- ##### STRUCT EBookListenerPrivate ##### --> <para> @@ -53,54 +30,6 @@ e-book-marshal </para> -<!-- ##### SIGNAL EBookView::contacts-added ##### --> -<para> - -</para> - -@ebookview: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EBookView::contacts-changed ##### --> -<para> - -</para> - -@ebookview: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EBookView::contacts-removed ##### --> -<para> - -</para> - -@ebookview: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EBookView::sequence-complete ##### --> -<para> - -</para> - -@ebookview: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EBookView::status-message ##### --> -<para> - -</para> - -@ebookview: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EBookViewListener::response ##### --> -<para> - -</para> - -@ebookviewlistener: the object which received the signal. -@arg1: - <!-- ##### STRUCT EBookViewListenerPrivate ##### --> <para> @@ -113,396 +42,6 @@ e-book-marshal </para> -<!-- ##### ARG EContact:address ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:address-home ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:address-label-home ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:address-label-other ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:address-label-work ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:address-other ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:address-work ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:anniversary ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:assistant ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:assistant-phone ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:birth-date ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:blog-url ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:business-fax ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:business-phone ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:business-phone-2 ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:callback-phone ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:caluri ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:car-phone ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:categories ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:company-phone ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:email ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:email-1 ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:email-2 ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:email-3 ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:family-name ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:fburl ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:file-as ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:full-name ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:given-name ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:home-fax ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:home-phone ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:home-phone-2 ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:homepage-url ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:icscalendar ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:id ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:im-aim ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:im-icq ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:im-jabber ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:im-msn ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:im-yahoo ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:isdn-phone ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:list ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:list-show-addresses ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:logo ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:mailer ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:manager ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:mobile-phone ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:name ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:nickname ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:note ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:office ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:org ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:org-unit ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:other-fax ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:other-phone ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:pager ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:photo ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:primary-phone ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:radio ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:role ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:spouse ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:telex ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:title ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:tty ##### --> -<para> - -</para> - - -<!-- ##### ARG EContact:wants-html ##### --> -<para> - -</para> - - <!-- ##### STRUCT EContactPrivate ##### --> <para> |