← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libedata-book/xml/e-book-backend.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/addressbook/libedata-book/xml/e-book-backend.xml
5
5
<refmeta>
6
6
<refentrytitle role="top_of_page" id="EBookBackend.top_of_page">EBookBackend</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBEDATA-BOOK Library</refmiscinfo>
 
8
<refmiscinfo>
 
9
  LIBEDATA-BOOK Library
 
10
</refmiscinfo>
9
11
</refmeta>
10
 
 
11
12
<refnamediv>
12
13
<refname>EBookBackend</refname>
13
14
<refpurpose></refpurpose>
16
17
<refsynopsisdiv id="EBookBackend.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
18
19
 
19
 
<synopsis>
20
 
struct              <link linkend="EBookBackend-struct">EBookBackend</link>;
21
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-construct">e_book_backend_construct</link>            (<link linkend="EBookBackend">EBookBackend</link> *backend);
22
 
<link linkend="GNOME-Evolution-Addressbook-CallStatus">GNOME_Evolution_Addressbook_CallStatus</link>  <link linkend="e-book-backend-load-source">e_book_backend_load_source</link>
23
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend,
24
 
                                                         <link linkend="ESource">ESource</link> *source,
25
 
                                                         <link linkend="gboolean">gboolean</link> only_if_exists);
26
 
<link linkend="ESource">ESource</link> *           <link linkend="e-book-backend-get-source">e_book_backend_get_source</link>           (<link linkend="EBookBackend">EBookBackend</link> *backend);
27
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-add-client">e_book_backend_add_client</link>           (<link linkend="EBookBackend">EBookBackend</link> *backend,
28
 
                                                         <link linkend="EDataBook">EDataBook</link> *book);
29
 
<link linkend="void">void</link>                <link linkend="e-book-backend-remove-client">e_book_backend_remove_client</link>        (<link linkend="EBookBackend">EBookBackend</link> *backend,
30
 
                                                         <link linkend="EDataBook">EDataBook</link> *book);
31
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-has-out-of-proc-clients">e_book_backend_has_out_of_proc_clients</link>
32
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend);
33
 
<link linkend="gchar">gchar</link> *             <link linkend="e-book-backend-get-static-capabilities">e_book_backend_get_static_capabilities</link>
34
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend);
35
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-is-loaded">e_book_backend_is_loaded</link>            (<link linkend="EBookBackend">EBookBackend</link> *backend);
36
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-is-writable">e_book_backend_is_writable</link>          (<link linkend="EBookBackend">EBookBackend</link> *backend);
37
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-is-removed">e_book_backend_is_removed</link>           (<link linkend="EBookBackend">EBookBackend</link> *backend);
38
 
<link linkend="void">void</link>                <link linkend="e-book-backend-open">e_book_backend_open</link>                 (<link linkend="EBookBackend">EBookBackend</link> *backend,
39
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
40
 
                                                         <link linkend="guint32">guint32</link> opid,
41
 
                                                         <link linkend="gboolean">gboolean</link> only_if_exists);
42
 
<link linkend="void">void</link>                <link linkend="e-book-backend-remove">e_book_backend_remove</link>               (<link linkend="EBookBackend">EBookBackend</link> *backend,
43
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
44
 
                                                         <link linkend="guint32">guint32</link> opid);
45
 
<link linkend="void">void</link>                <link linkend="e-book-backend-create-contact">e_book_backend_create_contact</link>       (<link linkend="EBookBackend">EBookBackend</link> *backend,
46
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
47
 
                                                         <link linkend="guint32">guint32</link> opid,
48
 
                                                         const <link linkend="gchar">gchar</link> *vcard);
49
 
<link linkend="void">void</link>                <link linkend="e-book-backend-remove-contacts">e_book_backend_remove_contacts</link>      (<link linkend="EBookBackend">EBookBackend</link> *backend,
50
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
51
 
                                                         <link linkend="guint32">guint32</link> opid,
52
 
                                                         <link linkend="GList">GList</link> *id_list);
53
 
<link linkend="void">void</link>                <link linkend="e-book-backend-modify-contact">e_book_backend_modify_contact</link>       (<link linkend="EBookBackend">EBookBackend</link> *backend,
54
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
55
 
                                                         <link linkend="guint32">guint32</link> opid,
56
 
                                                         const <link linkend="gchar">gchar</link> *vcard);
57
 
<link linkend="void">void</link>                <link linkend="e-book-backend-get-contact">e_book_backend_get_contact</link>          (<link linkend="EBookBackend">EBookBackend</link> *backend,
58
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
59
 
                                                         <link linkend="guint32">guint32</link> opid,
60
 
                                                         const <link linkend="gchar">gchar</link> *id);
61
 
<link linkend="void">void</link>                <link linkend="e-book-backend-get-contact-list">e_book_backend_get_contact_list</link>     (<link linkend="EBookBackend">EBookBackend</link> *backend,
62
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
63
 
                                                         <link linkend="guint32">guint32</link> opid,
64
 
                                                         const <link linkend="gchar">gchar</link> *query);
65
 
<link linkend="void">void</link>                <link linkend="e-book-backend-get-changes">e_book_backend_get_changes</link>          (<link linkend="EBookBackend">EBookBackend</link> *backend,
66
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
67
 
                                                         <link linkend="guint32">guint32</link> opid,
68
 
                                                         const <link linkend="gchar">gchar</link> *change_id);
69
 
<link linkend="void">void</link>                <link linkend="e-book-backend-authenticate-user">e_book_backend_authenticate_user</link>    (<link linkend="EBookBackend">EBookBackend</link> *backend,
70
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
71
 
                                                         <link linkend="guint32">guint32</link> opid,
72
 
                                                         const <link linkend="gchar">gchar</link> *user,
73
 
                                                         const <link linkend="gchar">gchar</link> *passwd,
74
 
                                                         const <link linkend="gchar">gchar</link> *auth_method);
75
 
<link linkend="void">void</link>                <link linkend="e-book-backend-get-supported-fields">e_book_backend_get_supported_fields</link> (<link linkend="EBookBackend">EBookBackend</link> *backend,
76
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
77
 
                                                         <link linkend="guint32">guint32</link> opid);
78
 
<link linkend="void">void</link>                <link linkend="e-book-backend-get-required-fields">e_book_backend_get_required_fields</link>  (<link linkend="EBookBackend">EBookBackend</link> *backend,
79
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
80
 
                                                         <link linkend="guint32">guint32</link> opid);
81
 
<link linkend="void">void</link>                <link linkend="e-book-backend-get-supported-auth-methods">e_book_backend_get_supported_auth_methods</link>
82
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend,
83
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
84
 
                                                         <link linkend="guint32">guint32</link> opid);
85
 
<link linkend="GNOME-Evolution-Addressbook-CallStatus">GNOME_Evolution_Addressbook_CallStatus</link>  <link linkend="e-book-backend-cancel-operation">e_book_backend_cancel_operation</link>
86
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend,
87
 
                                                         <link linkend="EDataBook">EDataBook</link> *book);
88
 
<link linkend="void">void</link>                <link linkend="e-book-backend-set-mode">e_book_backend_set_mode</link>             (<link linkend="EBookBackend">EBookBackend</link> *backend,
89
 
                                                         <link linkend="GNOME-Evolution-Addressbook-BookMode">GNOME_Evolution_Addressbook_BookMode</link> mode);
90
 
<link linkend="void">void</link>                <link linkend="e-book-backend-start-book-view">e_book_backend_start_book_view</link>      (<link linkend="EBookBackend">EBookBackend</link> *backend,
91
 
                                                         <link linkend="EDataBookView">EDataBookView</link> *view);
92
 
<link linkend="void">void</link>                <link linkend="e-book-backend-stop-book-view">e_book_backend_stop_book_view</link>       (<link linkend="EBookBackend">EBookBackend</link> *backend,
93
 
                                                         <link linkend="EDataBookView">EDataBookView</link> *view);
94
 
<link linkend="void">void</link>                <link linkend="e-book-backend-add-book-view">e_book_backend_add_book_view</link>        (<link linkend="EBookBackend">EBookBackend</link> *backend,
95
 
                                                         <link linkend="EDataBookView">EDataBookView</link> *view);
96
 
<link linkend="void">void</link>                <link linkend="e-book-backend-remove-book-view">e_book_backend_remove_book_view</link>     (<link linkend="EBookBackend">EBookBackend</link> *backend,
97
 
                                                         <link linkend="EDataBookView">EDataBookView</link> *view);
98
 
<link linkend="EList">EList</link> *             <link linkend="e-book-backend-get-book-views">e_book_backend_get_book_views</link>       (<link linkend="EBookBackend">EBookBackend</link> *backend);
99
 
<link linkend="void">void</link>                <link linkend="e-book-backend-notify-update">e_book_backend_notify_update</link>        (<link linkend="EBookBackend">EBookBackend</link> *backend,
100
 
                                                         <link linkend="EContact">EContact</link> *contact);
101
 
<link linkend="void">void</link>                <link linkend="e-book-backend-notify-remove">e_book_backend_notify_remove</link>        (<link linkend="EBookBackend">EBookBackend</link> *backend,
102
 
                                                         const <link linkend="gchar">gchar</link> *id);
103
 
<link linkend="void">void</link>                <link linkend="e-book-backend-notify-complete">e_book_backend_notify_complete</link>      (<link linkend="EBookBackend">EBookBackend</link> *backend);
104
 
<link linkend="void">void</link>                <link linkend="e-book-backend-notify-writable">e_book_backend_notify_writable</link>      (<link linkend="EBookBackend">EBookBackend</link> *backend,
105
 
                                                         <link linkend="gboolean">gboolean</link> is_writable);
106
 
<link linkend="void">void</link>                <link linkend="e-book-backend-notify-connection-status">e_book_backend_notify_connection_status</link>
107
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend,
108
 
                                                         <link linkend="gboolean">gboolean</link> is_online);
109
 
<link linkend="void">void</link>                <link linkend="e-book-backend-notify-auth-required">e_book_backend_notify_auth_required</link> (<link linkend="EBookBackend">EBookBackend</link> *backend);
110
 
<link linkend="void">void</link>                <link linkend="e-book-backend-sync">e_book_backend_sync</link>                 (<link linkend="EBookBackend">EBookBackend</link> *backend);
111
 
<link linkend="void">void</link>                <link linkend="e-book-backend-set-is-loaded">e_book_backend_set_is_loaded</link>        (<link linkend="EBookBackend">EBookBackend</link> *backend,
112
 
                                                         <link linkend="gboolean">gboolean</link> is_loaded);
113
 
<link linkend="void">void</link>                <link linkend="e-book-backend-set-is-writable">e_book_backend_set_is_writable</link>      (<link linkend="EBookBackend">EBookBackend</link> *backend,
114
 
                                                         <link linkend="gboolean">gboolean</link> is_writable);
115
 
<link linkend="void">void</link>                <link linkend="e-book-backend-set-is-removed">e_book_backend_set_is_removed</link>       (<link linkend="EBookBackend">EBookBackend</link> *backend,
116
 
                                                         <link linkend="gboolean">gboolean</link> is_removed);
117
 
<link linkend="GNOME-Evolution-Addressbook-BookChangeItem">GNOME_Evolution_Addressbook_BookChangeItem</link>* <link linkend="e-book-backend-change-add-new">e_book_backend_change_add_new</link>
118
 
                                                        (const <link linkend="gchar">gchar</link> *vcard);
119
 
<link linkend="GNOME-Evolution-Addressbook-BookChangeItem">GNOME_Evolution_Addressbook_BookChangeItem</link>* <link linkend="e-book-backend-change-modify-new">e_book_backend_change_modify_new</link>
120
 
                                                        (const <link linkend="gchar">gchar</link> *vcard);
121
 
<link linkend="GNOME-Evolution-Addressbook-BookChangeItem">GNOME_Evolution_Addressbook_BookChangeItem</link>* <link linkend="e-book-backend-change-delete-new">e_book_backend_change_delete_new</link>
122
 
                                                        (const <link linkend="gchar">gchar</link> *id);
 
20
<synopsis>struct              <link linkend="EBookBackend-struct">EBookBackend</link>;
 
21
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-construct">e_book_backend_construct</link>            (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
 
22
<link linkend="GNOME-Evolution-Addressbook-CallStatus"><returnvalue>GNOME_Evolution_Addressbook_CallStatus</returnvalue></link>  <link linkend="e-book-backend-load-source">e_book_backend_load_source</link>
 
23
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
24
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
 
25
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>);
 
26
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           <link linkend="e-book-backend-get-source">e_book_backend_get_source</link>           (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
 
27
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-add-client">e_book_backend_add_client</link>           (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
28
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);
 
29
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-remove-client">e_book_backend_remove_client</link>        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
30
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);
 
31
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-has-out-of-proc-clients">e_book_backend_has_out_of_proc_clients</link>
 
32
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
 
33
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-book-backend-get-static-capabilities">e_book_backend_get_static_capabilities</link>
 
34
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
 
35
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-is-loaded">e_book_backend_is_loaded</link>            (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
 
36
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-is-writable">e_book_backend_is_writable</link>          (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
 
37
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-is-removed">e_book_backend_is_removed</link>           (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
 
38
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-open">e_book_backend_open</link>                 (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
39
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
40
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
41
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>);
 
42
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-remove">e_book_backend_remove</link>               (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
43
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
44
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);
 
45
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-create-contact">e_book_backend_create_contact</link>       (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
46
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
47
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
48
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);
 
49
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-remove-contacts">e_book_backend_remove_contacts</link>      (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
50
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
51
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
52
                                                         <parameter><link linkend="GList"><type>GList</type></link> *id_list</parameter>);
 
53
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-modify-contact">e_book_backend_modify_contact</link>       (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
54
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
55
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
56
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);
 
57
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-get-contact">e_book_backend_get_contact</link>          (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
58
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
59
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
60
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);
 
61
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-get-contact-list">e_book_backend_get_contact_list</link>     (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
62
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
63
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
64
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);
 
65
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-get-changes">e_book_backend_get_changes</link>          (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
66
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
67
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
68
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *change_id</parameter>);
 
69
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-authenticate-user">e_book_backend_authenticate_user</link>    (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
70
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
71
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
72
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *user</parameter>,
 
73
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *passwd</parameter>,
 
74
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *auth_method</parameter>);
 
75
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-get-supported-fields">e_book_backend_get_supported_fields</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
76
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
77
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);
 
78
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-get-required-fields">e_book_backend_get_required_fields</link>  (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
79
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
80
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);
 
81
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-get-supported-auth-methods">e_book_backend_get_supported_auth_methods</link>
 
82
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
83
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
84
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);
 
85
<link linkend="GNOME-Evolution-Addressbook-CallStatus"><returnvalue>GNOME_Evolution_Addressbook_CallStatus</returnvalue></link>  <link linkend="e-book-backend-cancel-operation">e_book_backend_cancel_operation</link>
 
86
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
87
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);
 
88
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-set-mode">e_book_backend_set_mode</link>             (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
89
                                                         <parameter><link linkend="GNOME-Evolution-Addressbook-BookMode"><type>GNOME_Evolution_Addressbook_BookMode</type></link> mode</parameter>);
 
90
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-start-book-view">e_book_backend_start_book_view</link>      (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
91
                                                         <parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);
 
92
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-stop-book-view">e_book_backend_stop_book_view</link>       (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
93
                                                         <parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);
 
94
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-add-book-view">e_book_backend_add_book_view</link>        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
95
                                                         <parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);
 
96
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-remove-book-view">e_book_backend_remove_book_view</link>     (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
97
                                                         <parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);
 
98
<link linkend="EList"><returnvalue>EList</returnvalue></link> *             <link linkend="e-book-backend-get-book-views">e_book_backend_get_book_views</link>       (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
 
99
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-notify-update">e_book_backend_notify_update</link>        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
100
                                                         <parameter><link linkend="EContact"><type>EContact</type></link> *contact</parameter>);
 
101
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-notify-remove">e_book_backend_notify_remove</link>        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
102
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);
 
103
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-notify-complete">e_book_backend_notify_complete</link>      (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
 
104
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-notify-writable">e_book_backend_notify_writable</link>      (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
105
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_writable</parameter>);
 
106
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-notify-connection-status">e_book_backend_notify_connection_status</link>
 
107
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
108
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_online</parameter>);
 
109
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-notify-auth-required">e_book_backend_notify_auth_required</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
 
110
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-sync">e_book_backend_sync</link>                 (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
 
111
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-set-is-loaded">e_book_backend_set_is_loaded</link>        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
112
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_loaded</parameter>);
 
113
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-set-is-writable">e_book_backend_set_is_writable</link>      (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
114
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_writable</parameter>);
 
115
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-set-is-removed">e_book_backend_set_is_removed</link>       (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
116
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_removed</parameter>);
 
117
<link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* <link linkend="e-book-backend-change-add-new">e_book_backend_change_add_new</link>
 
118
                                                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);
 
119
<link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* <link linkend="e-book-backend-change-modify-new">e_book_backend_change_modify_new</link>
 
120
                                                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);
 
121
<link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* <link linkend="e-book-backend-change-delete-new">e_book_backend_change_delete_new</link>
 
122
                                                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);
123
123
struct              <link linkend="EBookBackendClass">EBookBackendClass</link>;
124
124
</synopsis>
125
125
</refsynopsisdiv>
126
 
 
127
126
<refsect1 id="EBookBackend.object-hierarchy" role="object_hierarchy">
128
127
<title role="object_hierarchy.title">Object Hierarchy</title>
129
128
<synopsis>
132
131
         +----<link linkend="EBookBackendSync">EBookBackendSync</link>
133
132
</synopsis>
134
133
</refsect1>
135
 
 
136
 
 
137
 
 
138
 
 
139
 
 
140
 
 
141
134
<refsect1 id="EBookBackend.signals" role="signal_proto">
142
135
<title role="signal_proto.title">Signals</title>
143
136
<synopsis>
145
138
</synopsis>
146
139
</refsect1>
147
140
 
148
 
 
149
141
<refsect1 id="EBookBackend.description" role="desc">
150
142
<title role="desc.title">Description</title>
151
143
<para>
152
144
</para>
153
145
</refsect1>
154
 
 
155
146
<refsect1 id="EBookBackend.details" role="details">
156
147
<title role="details.title">Details</title>
157
148
<refsect2 id="EBookBackend-struct" role="struct">
158
149
<title>struct EBookBackend</title>
159
 
<indexterm zone="EBookBackend-struct"><primary sortas="EBookBackend">EBookBackend</primary></indexterm><programlisting>struct EBookBackend;</programlisting>
 
150
<indexterm zone="EBookBackend-struct"><primary>EBookBackend</primary></indexterm>
 
151
<programlisting>struct EBookBackend;</programlisting>
160
152
<para>
161
153
</para></refsect2>
162
154
<refsect2 id="e-book-backend-construct" role="function">
163
155
<title>e_book_backend_construct ()</title>
164
 
<indexterm zone="e-book-backend-construct"><primary sortas="e_book_backend_construct">e_book_backend_construct</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_construct            (<link linkend="EBookBackend">EBookBackend</link> *backend);</programlisting>
 
156
<indexterm zone="e-book-backend-construct"><primary>e_book_backend_construct</primary></indexterm>
 
157
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_construct            (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
165
158
<para>
166
159
Does nothing.</para>
167
 
<para>
168
 
</para><variablelist role="params">
 
160
<variablelist role="params">
169
161
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
170
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
162
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
171
163
</simpara></listitem></varlistentry>
172
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.
 
164
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.
173
165
</simpara></listitem></varlistentry>
174
166
</variablelist></refsect2>
175
167
<refsect2 id="e-book-backend-load-source" role="function">
176
168
<title>e_book_backend_load_source ()</title>
177
 
<indexterm zone="e-book-backend-load-source"><primary sortas="e_book_backend_load_source">e_book_backend_load_source</primary></indexterm><programlisting><link linkend="GNOME-Evolution-Addressbook-CallStatus">GNOME_Evolution_Addressbook_CallStatus</link>  e_book_backend_load_source
178
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend,
179
 
                                                         <link linkend="ESource">ESource</link> *source,
180
 
                                                         <link linkend="gboolean">gboolean</link> only_if_exists);</programlisting>
 
169
<indexterm zone="e-book-backend-load-source"><primary>e_book_backend_load_source</primary></indexterm>
 
170
<programlisting><link linkend="GNOME-Evolution-Addressbook-CallStatus"><returnvalue>GNOME_Evolution_Addressbook_CallStatus</returnvalue></link>  e_book_backend_load_source
 
171
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
172
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
 
173
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>);</programlisting>
181
174
<para>
182
175
Loads <parameter>source</parameter> into <parameter>backend</parameter>.</para>
183
 
<para>
184
 
</para><variablelist role="params">
 
176
<variablelist role="params">
185
177
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
186
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
178
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
187
179
</simpara></listitem></varlistentry>
188
180
<varlistentry><term><parameter>source</parameter>&#160;:</term>
189
 
<listitem><simpara> an <link linkend="ESource"><type>ESource</type></link> to load
 
181
<listitem><simpara>an <link linkend="ESource"><type>ESource</type></link> to load
190
182
</simpara></listitem></varlistentry>
191
183
<varlistentry><term><parameter>only_if_exists</parameter>&#160;:</term>
192
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to prevent the creation of a new book
 
184
<listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to prevent the creation of a new book
193
185
</simpara></listitem></varlistentry>
194
186
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GNOME-Evolution-Addressbook-CallStatus"><type>GNOME_Evolution_Addressbook_CallStatus</type></link> indicating the outcome.
195
187
</simpara></listitem></varlistentry>
196
188
</variablelist></refsect2>
197
189
<refsect2 id="e-book-backend-get-source" role="function">
198
190
<title>e_book_backend_get_source ()</title>
199
 
<indexterm zone="e-book-backend-get-source"><primary sortas="e_book_backend_get_source">e_book_backend_get_source</primary></indexterm><programlisting><link linkend="ESource">ESource</link> *           e_book_backend_get_source           (<link linkend="EBookBackend">EBookBackend</link> *backend);</programlisting>
 
191
<indexterm zone="e-book-backend-get-source"><primary>e_book_backend_get_source</primary></indexterm>
 
192
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           e_book_backend_get_source           (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
200
193
<para>
201
194
Queries the source that an addressbook backend is serving.</para>
202
 
<para>
203
 
</para><variablelist role="params">
 
195
<variablelist role="params">
204
196
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
205
 
<listitem><simpara> An addressbook backend.
 
197
<listitem><simpara>An addressbook backend.
206
198
</simpara></listitem></varlistentry>
207
199
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> ESource for the backend.
208
200
</simpara></listitem></varlistentry>
209
201
</variablelist></refsect2>
210
202
<refsect2 id="e-book-backend-add-client" role="function">
211
203
<title>e_book_backend_add_client ()</title>
212
 
<indexterm zone="e-book-backend-add-client"><primary sortas="e_book_backend_add_client">e_book_backend_add_client</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_add_client           (<link linkend="EBookBackend">EBookBackend</link> *backend,
213
 
                                                         <link linkend="EDataBook">EDataBook</link> *book);</programlisting>
 
204
<indexterm zone="e-book-backend-add-client"><primary>e_book_backend_add_client</primary></indexterm>
 
205
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_add_client           (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
206
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);</programlisting>
214
207
<para>
215
208
Adds a client to an addressbook backend.</para>
216
 
<para>
217
 
</para><variablelist role="params">
 
209
<variablelist role="params">
218
210
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
219
 
<listitem><simpara> An addressbook backend.
 
211
<listitem><simpara>An addressbook backend.
220
212
</simpara></listitem></varlistentry>
221
213
<varlistentry><term><parameter>book</parameter>&#160;:</term>
222
 
<listitem><simpara> the corba object representing the client connection.
 
214
<listitem><simpara>the corba object representing the client connection.
223
215
</simpara></listitem></varlistentry>
224
216
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE on failure to add the client.
225
217
</simpara></listitem></varlistentry>
226
218
</variablelist></refsect2>
227
219
<refsect2 id="e-book-backend-remove-client" role="function">
228
220
<title>e_book_backend_remove_client ()</title>
229
 
<indexterm zone="e-book-backend-remove-client"><primary sortas="e_book_backend_remove_client">e_book_backend_remove_client</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_remove_client        (<link linkend="EBookBackend">EBookBackend</link> *backend,
230
 
                                                         <link linkend="EDataBook">EDataBook</link> *book);</programlisting>
 
221
<indexterm zone="e-book-backend-remove-client"><primary>e_book_backend_remove_client</primary></indexterm>
 
222
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_remove_client        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
223
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);</programlisting>
231
224
<para>
232
225
Removes <parameter>book</parameter> from the list of <parameter>backend</parameter>'s clients.</para>
233
 
<para>
234
 
</para><variablelist role="params">
 
226
<variablelist role="params">
235
227
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
236
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
228
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
237
229
</simpara></listitem></varlistentry>
238
230
<varlistentry><term><parameter>book</parameter>&#160;:</term>
239
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link> to remove
 
231
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link> to remove
240
232
</simpara></listitem></varlistentry>
241
233
</variablelist></refsect2>
242
234
<refsect2 id="e-book-backend-has-out-of-proc-clients" role="function">
243
235
<title>e_book_backend_has_out_of_proc_clients ()</title>
244
 
<indexterm zone="e-book-backend-has-out-of-proc-clients"><primary sortas="e_book_backend_has_out_of_proc_clients">e_book_backend_has_out_of_proc_clients</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_has_out_of_proc_clients
245
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend);</programlisting>
 
236
<indexterm zone="e-book-backend-has-out-of-proc-clients"><primary>e_book_backend_has_out_of_proc_clients</primary></indexterm>
 
237
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_has_out_of_proc_clients
 
238
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
246
239
<para>
247
240
Checks if <parameter>backend</parameter> has clients running in other system processes.</para>
248
 
<para>
249
 
</para><variablelist role="params">
 
241
<variablelist role="params">
250
242
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
251
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
243
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
252
244
</simpara></listitem></varlistentry>
253
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if there are clients in other processes, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
245
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if there are clients in other processes, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
254
246
</simpara></listitem></varlistentry>
255
247
</variablelist></refsect2>
256
248
<refsect2 id="e-book-backend-get-static-capabilities" role="function">
257
249
<title>e_book_backend_get_static_capabilities ()</title>
258
 
<indexterm zone="e-book-backend-get-static-capabilities"><primary sortas="e_book_backend_get_static_capabilities">e_book_backend_get_static_capabilities</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             e_book_backend_get_static_capabilities
259
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend);</programlisting>
 
250
<indexterm zone="e-book-backend-get-static-capabilities"><primary>e_book_backend_get_static_capabilities</primary></indexterm>
 
251
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_book_backend_get_static_capabilities
 
252
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
260
253
<para>
261
254
Gets the capabilities offered by this <parameter>backend</parameter>.</para>
262
 
<para>
263
 
</para><variablelist role="params">
 
255
<variablelist role="params">
264
256
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
265
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
257
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
266
258
</simpara></listitem></varlistentry>
267
259
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A string listing the capabilities.
268
260
</simpara></listitem></varlistentry>
269
261
</variablelist></refsect2>
270
262
<refsect2 id="e-book-backend-is-loaded" role="function">
271
263
<title>e_book_backend_is_loaded ()</title>
272
 
<indexterm zone="e-book-backend-is-loaded"><primary sortas="e_book_backend_is_loaded">e_book_backend_is_loaded</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_is_loaded            (<link linkend="EBookBackend">EBookBackend</link> *backend);</programlisting>
 
264
<indexterm zone="e-book-backend-is-loaded"><primary>e_book_backend_is_loaded</primary></indexterm>
 
265
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_is_loaded            (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
273
266
<para>
274
267
Checks if <parameter>backend</parameter>'s storage has been opened and the backend
275
268
itself is ready for accessing.</para>
276
 
<para>
277
 
</para><variablelist role="params">
 
269
<variablelist role="params">
278
270
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
279
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
271
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
280
272
</simpara></listitem></varlistentry>
281
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if loaded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
273
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if loaded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
282
274
</simpara></listitem></varlistentry>
283
275
</variablelist></refsect2>
284
276
<refsect2 id="e-book-backend-is-writable" role="function">
285
277
<title>e_book_backend_is_writable ()</title>
286
 
<indexterm zone="e-book-backend-is-writable"><primary sortas="e_book_backend_is_writable">e_book_backend_is_writable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_is_writable          (<link linkend="EBookBackend">EBookBackend</link> *backend);</programlisting>
 
278
<indexterm zone="e-book-backend-is-writable"><primary>e_book_backend_is_writable</primary></indexterm>
 
279
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_is_writable          (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
287
280
<para>
288
281
Checks if we can write to <parameter>backend</parameter>.</para>
289
 
<para>
290
 
</para><variablelist role="params">
 
282
<variablelist role="params">
291
283
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
292
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
284
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
293
285
</simpara></listitem></varlistentry>
294
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if writeable, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if not.
 
286
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if writeable, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not.
295
287
</simpara></listitem></varlistentry>
296
288
</variablelist></refsect2>
297
289
<refsect2 id="e-book-backend-is-removed" role="function">
298
290
<title>e_book_backend_is_removed ()</title>
299
 
<indexterm zone="e-book-backend-is-removed"><primary sortas="e_book_backend_is_removed">e_book_backend_is_removed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_is_removed           (<link linkend="EBookBackend">EBookBackend</link> *backend);</programlisting>
 
291
<indexterm zone="e-book-backend-is-removed"><primary>e_book_backend_is_removed</primary></indexterm>
 
292
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_is_removed           (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
300
293
<para>
301
294
Checks if <parameter>backend</parameter> has been removed from its physical storage.</para>
302
 
<para>
303
 
</para><variablelist role="params">
 
295
<variablelist role="params">
304
296
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
305
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
297
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
306
298
</simpara></listitem></varlistentry>
307
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>backend</parameter> has been removed, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
299
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>backend</parameter> has been removed, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
308
300
</simpara></listitem></varlistentry>
309
301
</variablelist></refsect2>
310
302
<refsect2 id="e-book-backend-open" role="function">
311
303
<title>e_book_backend_open ()</title>
312
 
<indexterm zone="e-book-backend-open"><primary sortas="e_book_backend_open">e_book_backend_open</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_open                 (<link linkend="EBookBackend">EBookBackend</link> *backend,
313
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
314
 
                                                         <link linkend="guint32">guint32</link> opid,
315
 
                                                         <link linkend="gboolean">gboolean</link> only_if_exists);</programlisting>
 
304
<indexterm zone="e-book-backend-open"><primary>e_book_backend_open</primary></indexterm>
 
305
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_open                 (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
306
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
307
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
308
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>);</programlisting>
316
309
<para>
317
310
Executes an 'open' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
318
311
using <parameter>backend</parameter>.</para>
319
 
<para>
320
 
</para><variablelist role="params">
 
312
<variablelist role="params">
321
313
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
322
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
314
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
323
315
</simpara></listitem></varlistentry>
324
316
<varlistentry><term><parameter>book</parameter>&#160;:</term>
325
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
317
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
326
318
</simpara></listitem></varlistentry>
327
319
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
328
 
<listitem><simpara> the ID to use for this operation
 
320
<listitem><simpara>the ID to use for this operation
329
321
</simpara></listitem></varlistentry>
330
322
<varlistentry><term><parameter>only_if_exists</parameter>&#160;:</term>
331
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to prevent the creation of a new book
 
323
<listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to prevent the creation of a new book
332
324
</simpara></listitem></varlistentry>
333
325
</variablelist></refsect2>
334
326
<refsect2 id="e-book-backend-remove" role="function">
335
327
<title>e_book_backend_remove ()</title>
336
 
<indexterm zone="e-book-backend-remove"><primary sortas="e_book_backend_remove">e_book_backend_remove</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_remove               (<link linkend="EBookBackend">EBookBackend</link> *backend,
337
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
338
 
                                                         <link linkend="guint32">guint32</link> opid);</programlisting>
 
328
<indexterm zone="e-book-backend-remove"><primary>e_book_backend_remove</primary></indexterm>
 
329
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_remove               (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
330
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
331
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);</programlisting>
339
332
<para>
340
333
Executes a 'remove' request to remove all of <parameter>backend</parameter>'s data,
341
334
specified by <parameter>opid</parameter> on <parameter>book</parameter>.</para>
342
 
<para>
343
 
</para><variablelist role="params">
 
335
<variablelist role="params">
344
336
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
345
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
337
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
346
338
</simpara></listitem></varlistentry>
347
339
<varlistentry><term><parameter>book</parameter>&#160;:</term>
348
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
340
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
349
341
</simpara></listitem></varlistentry>
350
342
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
351
 
<listitem><simpara> the ID to use for this operation
 
343
<listitem><simpara>the ID to use for this operation
352
344
</simpara></listitem></varlistentry>
353
345
</variablelist></refsect2>
354
346
<refsect2 id="e-book-backend-create-contact" role="function">
355
347
<title>e_book_backend_create_contact ()</title>
356
 
<indexterm zone="e-book-backend-create-contact"><primary sortas="e_book_backend_create_contact">e_book_backend_create_contact</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_create_contact       (<link linkend="EBookBackend">EBookBackend</link> *backend,
357
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
358
 
                                                         <link linkend="guint32">guint32</link> opid,
359
 
                                                         const <link linkend="gchar">gchar</link> *vcard);</programlisting>
 
348
<indexterm zone="e-book-backend-create-contact"><primary>e_book_backend_create_contact</primary></indexterm>
 
349
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_create_contact       (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
350
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
351
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
352
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);</programlisting>
360
353
<para>
361
354
Executes a 'create contact' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
362
355
using <parameter>backend</parameter>.</para>
363
 
<para>
364
 
</para><variablelist role="params">
 
356
<variablelist role="params">
365
357
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
366
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
358
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
367
359
</simpara></listitem></varlistentry>
368
360
<varlistentry><term><parameter>book</parameter>&#160;:</term>
369
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
361
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
370
362
</simpara></listitem></varlistentry>
371
363
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
372
 
<listitem><simpara> the ID to use for this operation
 
364
<listitem><simpara>the ID to use for this operation
373
365
</simpara></listitem></varlistentry>
374
366
<varlistentry><term><parameter>vcard</parameter>&#160;:</term>
375
 
<listitem><simpara> the VCard to add
 
367
<listitem><simpara>the VCard to add
376
368
</simpara></listitem></varlistentry>
377
369
</variablelist></refsect2>
378
370
<refsect2 id="e-book-backend-remove-contacts" role="function">
379
371
<title>e_book_backend_remove_contacts ()</title>
380
 
<indexterm zone="e-book-backend-remove-contacts"><primary sortas="e_book_backend_remove_contacts">e_book_backend_remove_contacts</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_remove_contacts      (<link linkend="EBookBackend">EBookBackend</link> *backend,
381
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
382
 
                                                         <link linkend="guint32">guint32</link> opid,
383
 
                                                         <link linkend="GList">GList</link> *id_list);</programlisting>
 
372
<indexterm zone="e-book-backend-remove-contacts"><primary>e_book_backend_remove_contacts</primary></indexterm>
 
373
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_remove_contacts      (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
374
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
375
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
376
                                                         <parameter><link linkend="GList"><type>GList</type></link> *id_list</parameter>);</programlisting>
384
377
<para>
385
378
Executes a 'remove contacts' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
386
379
using <parameter>backend</parameter>.</para>
387
 
<para>
388
 
</para><variablelist role="params">
 
380
<variablelist role="params">
389
381
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
390
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
382
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
391
383
</simpara></listitem></varlistentry>
392
384
<varlistentry><term><parameter>book</parameter>&#160;:</term>
393
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
385
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
394
386
</simpara></listitem></varlistentry>
395
387
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
396
 
<listitem><simpara> the ID to use for this operation
 
388
<listitem><simpara>the ID to use for this operation
397
389
</simpara></listitem></varlistentry>
398
390
<varlistentry><term><parameter>id_list</parameter>&#160;:</term>
399
 
<listitem><simpara> list of string IDs to remove
 
391
<listitem><simpara>list of string IDs to remove
400
392
</simpara></listitem></varlistentry>
401
393
</variablelist></refsect2>
402
394
<refsect2 id="e-book-backend-modify-contact" role="function">
403
395
<title>e_book_backend_modify_contact ()</title>
404
 
<indexterm zone="e-book-backend-modify-contact"><primary sortas="e_book_backend_modify_contact">e_book_backend_modify_contact</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_modify_contact       (<link linkend="EBookBackend">EBookBackend</link> *backend,
405
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
406
 
                                                         <link linkend="guint32">guint32</link> opid,
407
 
                                                         const <link linkend="gchar">gchar</link> *vcard);</programlisting>
 
396
<indexterm zone="e-book-backend-modify-contact"><primary>e_book_backend_modify_contact</primary></indexterm>
 
397
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_modify_contact       (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
398
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
399
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
400
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);</programlisting>
408
401
<para>
409
402
Executes a 'modify contact' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
410
403
using <parameter>backend</parameter>.</para>
411
 
<para>
412
 
</para><variablelist role="params">
 
404
<variablelist role="params">
413
405
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
414
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
406
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
415
407
</simpara></listitem></varlistentry>
416
408
<varlistentry><term><parameter>book</parameter>&#160;:</term>
417
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
409
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
418
410
</simpara></listitem></varlistentry>
419
411
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
420
 
<listitem><simpara> the ID to use for this operation
 
412
<listitem><simpara>the ID to use for this operation
421
413
</simpara></listitem></varlistentry>
422
414
<varlistentry><term><parameter>vcard</parameter>&#160;:</term>
423
 
<listitem><simpara> the VCard to update
 
415
<listitem><simpara>the VCard to update
424
416
</simpara></listitem></varlistentry>
425
417
</variablelist></refsect2>
426
418
<refsect2 id="e-book-backend-get-contact" role="function">
427
419
<title>e_book_backend_get_contact ()</title>
428
 
<indexterm zone="e-book-backend-get-contact"><primary sortas="e_book_backend_get_contact">e_book_backend_get_contact</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_get_contact          (<link linkend="EBookBackend">EBookBackend</link> *backend,
429
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
430
 
                                                         <link linkend="guint32">guint32</link> opid,
431
 
                                                         const <link linkend="gchar">gchar</link> *id);</programlisting>
 
420
<indexterm zone="e-book-backend-get-contact"><primary>e_book_backend_get_contact</primary></indexterm>
 
421
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_get_contact          (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
422
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
423
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
424
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);</programlisting>
432
425
<para>
433
426
Executes a 'get contact' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
434
427
using <parameter>backend</parameter>.</para>
435
 
<para>
436
 
</para><variablelist role="params">
 
428
<variablelist role="params">
437
429
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
438
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
430
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
439
431
</simpara></listitem></varlistentry>
440
432
<varlistentry><term><parameter>book</parameter>&#160;:</term>
441
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
433
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
442
434
</simpara></listitem></varlistentry>
443
435
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
444
 
<listitem><simpara> the ID to use for this operation
 
436
<listitem><simpara>the ID to use for this operation
445
437
</simpara></listitem></varlistentry>
446
438
<varlistentry><term><parameter>id</parameter>&#160;:</term>
447
 
<listitem><simpara> the ID of the contact to get
 
439
<listitem><simpara>the ID of the contact to get
448
440
</simpara></listitem></varlistentry>
449
441
</variablelist></refsect2>
450
442
<refsect2 id="e-book-backend-get-contact-list" role="function">
451
443
<title>e_book_backend_get_contact_list ()</title>
452
 
<indexterm zone="e-book-backend-get-contact-list"><primary sortas="e_book_backend_get_contact_list">e_book_backend_get_contact_list</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_get_contact_list     (<link linkend="EBookBackend">EBookBackend</link> *backend,
453
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
454
 
                                                         <link linkend="guint32">guint32</link> opid,
455
 
                                                         const <link linkend="gchar">gchar</link> *query);</programlisting>
 
444
<indexterm zone="e-book-backend-get-contact-list"><primary>e_book_backend_get_contact_list</primary></indexterm>
 
445
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_get_contact_list     (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
446
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
447
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
448
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);</programlisting>
456
449
<para>
457
450
Executes a 'get contact list' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
458
451
using <parameter>backend</parameter>.</para>
459
 
<para>
460
 
</para><variablelist role="params">
 
452
<variablelist role="params">
461
453
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
462
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
454
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
463
455
</simpara></listitem></varlistentry>
464
456
<varlistentry><term><parameter>book</parameter>&#160;:</term>
465
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
457
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
466
458
</simpara></listitem></varlistentry>
467
459
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
468
 
<listitem><simpara> the ID to use for this operation
 
460
<listitem><simpara>the ID to use for this operation
469
461
</simpara></listitem></varlistentry>
470
462
<varlistentry><term><parameter>query</parameter>&#160;:</term>
471
 
<listitem><simpara> the s-expression to match
 
463
<listitem><simpara>the s-expression to match
472
464
</simpara></listitem></varlistentry>
473
465
</variablelist></refsect2>
474
466
<refsect2 id="e-book-backend-get-changes" role="function">
475
467
<title>e_book_backend_get_changes ()</title>
476
 
<indexterm zone="e-book-backend-get-changes"><primary sortas="e_book_backend_get_changes">e_book_backend_get_changes</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_get_changes          (<link linkend="EBookBackend">EBookBackend</link> *backend,
477
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
478
 
                                                         <link linkend="guint32">guint32</link> opid,
479
 
                                                         const <link linkend="gchar">gchar</link> *change_id);</programlisting>
 
468
<indexterm zone="e-book-backend-get-changes"><primary>e_book_backend_get_changes</primary></indexterm>
 
469
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_get_changes          (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
470
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
471
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
472
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *change_id</parameter>);</programlisting>
480
473
<para>
481
474
Executes a 'get changes' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
482
475
using <parameter>backend</parameter>.</para>
483
 
<para>
484
 
</para><variablelist role="params">
 
476
<variablelist role="params">
485
477
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
486
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
478
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
487
479
</simpara></listitem></varlistentry>
488
480
<varlistentry><term><parameter>book</parameter>&#160;:</term>
489
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
481
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
490
482
</simpara></listitem></varlistentry>
491
483
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
492
 
<listitem><simpara> the ID to use for this operation
 
484
<listitem><simpara>the ID to use for this operation
493
485
</simpara></listitem></varlistentry>
494
486
<varlistentry><term><parameter>change_id</parameter>&#160;:</term>
495
 
<listitem><simpara> the ID of the changeset
 
487
<listitem><simpara>the ID of the changeset
496
488
</simpara></listitem></varlistentry>
497
489
</variablelist></refsect2>
498
490
<refsect2 id="e-book-backend-authenticate-user" role="function">
499
491
<title>e_book_backend_authenticate_user ()</title>
500
 
<indexterm zone="e-book-backend-authenticate-user"><primary sortas="e_book_backend_authenticate_user">e_book_backend_authenticate_user</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_authenticate_user    (<link linkend="EBookBackend">EBookBackend</link> *backend,
501
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
502
 
                                                         <link linkend="guint32">guint32</link> opid,
503
 
                                                         const <link linkend="gchar">gchar</link> *user,
504
 
                                                         const <link linkend="gchar">gchar</link> *passwd,
505
 
                                                         const <link linkend="gchar">gchar</link> *auth_method);</programlisting>
 
492
<indexterm zone="e-book-backend-authenticate-user"><primary>e_book_backend_authenticate_user</primary></indexterm>
 
493
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_authenticate_user    (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
494
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
495
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
 
496
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *user</parameter>,
 
497
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *passwd</parameter>,
 
498
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *auth_method</parameter>);</programlisting>
506
499
<para>
507
500
Executes an 'authenticate' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
508
501
using <parameter>backend</parameter>.</para>
509
 
<para>
510
 
</para><variablelist role="params">
 
502
<variablelist role="params">
511
503
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
512
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
504
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
513
505
</simpara></listitem></varlistentry>
514
506
<varlistentry><term><parameter>book</parameter>&#160;:</term>
515
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
507
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
516
508
</simpara></listitem></varlistentry>
517
509
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
518
 
<listitem><simpara> the ID to use for this operation
 
510
<listitem><simpara>the ID to use for this operation
519
511
</simpara></listitem></varlistentry>
520
512
<varlistentry><term><parameter>user</parameter>&#160;:</term>
521
 
<listitem><simpara> the name of the user account
 
513
<listitem><simpara>the name of the user account
522
514
</simpara></listitem></varlistentry>
523
515
<varlistentry><term><parameter>passwd</parameter>&#160;:</term>
524
 
<listitem><simpara> the user's password
 
516
<listitem><simpara>the user's password
525
517
</simpara></listitem></varlistentry>
526
518
<varlistentry><term><parameter>auth_method</parameter>&#160;:</term>
527
 
<listitem><simpara> the authentication method to use
 
519
<listitem><simpara>the authentication method to use
528
520
</simpara></listitem></varlistentry>
529
521
</variablelist></refsect2>
530
522
<refsect2 id="e-book-backend-get-supported-fields" role="function">
531
523
<title>e_book_backend_get_supported_fields ()</title>
532
 
<indexterm zone="e-book-backend-get-supported-fields"><primary sortas="e_book_backend_get_supported_fields">e_book_backend_get_supported_fields</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_get_supported_fields (<link linkend="EBookBackend">EBookBackend</link> *backend,
533
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
534
 
                                                         <link linkend="guint32">guint32</link> opid);</programlisting>
 
524
<indexterm zone="e-book-backend-get-supported-fields"><primary>e_book_backend_get_supported_fields</primary></indexterm>
 
525
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_get_supported_fields (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
526
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
527
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);</programlisting>
535
528
<para>
536
529
Executes a 'get supported fields' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
537
530
using <parameter>backend</parameter>.</para>
538
 
<para>
539
 
</para><variablelist role="params">
 
531
<variablelist role="params">
540
532
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
541
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
533
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
542
534
</simpara></listitem></varlistentry>
543
535
<varlistentry><term><parameter>book</parameter>&#160;:</term>
544
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
536
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
545
537
</simpara></listitem></varlistentry>
546
538
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
547
 
<listitem><simpara> the ID to use for this operation
 
539
<listitem><simpara>the ID to use for this operation
548
540
</simpara></listitem></varlistentry>
549
541
</variablelist></refsect2>
550
542
<refsect2 id="e-book-backend-get-required-fields" role="function">
551
543
<title>e_book_backend_get_required_fields ()</title>
552
 
<indexterm zone="e-book-backend-get-required-fields"><primary sortas="e_book_backend_get_required_fields">e_book_backend_get_required_fields</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_get_required_fields  (<link linkend="EBookBackend">EBookBackend</link> *backend,
553
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
554
 
                                                         <link linkend="guint32">guint32</link> opid);</programlisting>
 
544
<indexterm zone="e-book-backend-get-required-fields"><primary>e_book_backend_get_required_fields</primary></indexterm>
 
545
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_get_required_fields  (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
546
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
547
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);</programlisting>
555
548
<para>
556
549
Executes a 'get required fields' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
557
550
using <parameter>backend</parameter>.</para>
558
 
<para>
559
 
</para><variablelist role="params">
 
551
<variablelist role="params">
560
552
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
561
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
553
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
562
554
</simpara></listitem></varlistentry>
563
555
<varlistentry><term><parameter>book</parameter>&#160;:</term>
564
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
556
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
565
557
</simpara></listitem></varlistentry>
566
558
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
567
 
<listitem><simpara> the ID to use for this operation
 
559
<listitem><simpara>the ID to use for this operation
568
560
</simpara></listitem></varlistentry>
569
561
</variablelist></refsect2>
570
562
<refsect2 id="e-book-backend-get-supported-auth-methods" role="function">
571
563
<title>e_book_backend_get_supported_auth_methods ()</title>
572
 
<indexterm zone="e-book-backend-get-supported-auth-methods"><primary sortas="e_book_backend_get_supported_auth_methods">e_book_backend_get_supported_auth_methods</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_get_supported_auth_methods
573
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend,
574
 
                                                         <link linkend="EDataBook">EDataBook</link> *book,
575
 
                                                         <link linkend="guint32">guint32</link> opid);</programlisting>
 
564
<indexterm zone="e-book-backend-get-supported-auth-methods"><primary>e_book_backend_get_supported_auth_methods</primary></indexterm>
 
565
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_get_supported_auth_methods
 
566
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
567
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
 
568
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);</programlisting>
576
569
<para>
577
570
Executes a 'get supported auth methods' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
578
571
using <parameter>backend</parameter>.</para>
579
 
<para>
580
 
</para><variablelist role="params">
 
572
<variablelist role="params">
581
573
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
582
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
574
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
583
575
</simpara></listitem></varlistentry>
584
576
<varlistentry><term><parameter>book</parameter>&#160;:</term>
585
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
 
577
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
586
578
</simpara></listitem></varlistentry>
587
579
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
588
 
<listitem><simpara> the ID to use for this operation
 
580
<listitem><simpara>the ID to use for this operation
589
581
</simpara></listitem></varlistentry>
590
582
</variablelist></refsect2>
591
583
<refsect2 id="e-book-backend-cancel-operation" role="function">
592
584
<title>e_book_backend_cancel_operation ()</title>
593
 
<indexterm zone="e-book-backend-cancel-operation"><primary sortas="e_book_backend_cancel_operation">e_book_backend_cancel_operation</primary></indexterm><programlisting><link linkend="GNOME-Evolution-Addressbook-CallStatus">GNOME_Evolution_Addressbook_CallStatus</link>  e_book_backend_cancel_operation
594
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend,
595
 
                                                         <link linkend="EDataBook">EDataBook</link> *book);</programlisting>
 
585
<indexterm zone="e-book-backend-cancel-operation"><primary>e_book_backend_cancel_operation</primary></indexterm>
 
586
<programlisting><link linkend="GNOME-Evolution-Addressbook-CallStatus"><returnvalue>GNOME_Evolution_Addressbook_CallStatus</returnvalue></link>  e_book_backend_cancel_operation
 
587
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
588
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);</programlisting>
596
589
<para>
597
590
Cancel <parameter>book</parameter>'s running operation on <parameter>backend</parameter>.</para>
598
 
<para>
599
 
</para><variablelist role="params">
 
591
<variablelist role="params">
600
592
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
601
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
593
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
602
594
</simpara></listitem></varlistentry>
603
595
<varlistentry><term><parameter>book</parameter>&#160;:</term>
604
 
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link> whose operation should be cancelled
 
596
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link> whose operation should be cancelled
605
597
</simpara></listitem></varlistentry>
606
598
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A GNOME_Evolution_Addressbook_CallStatus indicating the outcome.
607
599
</simpara></listitem></varlistentry>
608
600
</variablelist></refsect2>
609
601
<refsect2 id="e-book-backend-set-mode" role="function">
610
602
<title>e_book_backend_set_mode ()</title>
611
 
<indexterm zone="e-book-backend-set-mode"><primary sortas="e_book_backend_set_mode">e_book_backend_set_mode</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_set_mode             (<link linkend="EBookBackend">EBookBackend</link> *backend,
612
 
                                                         <link linkend="GNOME-Evolution-Addressbook-BookMode">GNOME_Evolution_Addressbook_BookMode</link> mode);</programlisting>
 
603
<indexterm zone="e-book-backend-set-mode"><primary>e_book_backend_set_mode</primary></indexterm>
 
604
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_set_mode             (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
605
                                                         <parameter><link linkend="GNOME-Evolution-Addressbook-BookMode"><type>GNOME_Evolution_Addressbook_BookMode</type></link> mode</parameter>);</programlisting>
613
606
<para>
614
607
Sets <parameter>backend</parameter>'s online/offline mode to <parameter>mode</parameter>. Mode can be 1 for offline
615
608
or 2 indicating that it is connected and online.</para>
616
 
<para>
617
 
</para><variablelist role="params">
 
609
<variablelist role="params">
618
610
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
619
 
<listitem><simpara> an <link linkend="EBookbackend"><type>EBookbackend</type></link>
 
611
<listitem><simpara>an <link linkend="EBookbackend"><type>EBookbackend</type></link>
620
612
</simpara></listitem></varlistentry>
621
613
<varlistentry><term><parameter>mode</parameter>&#160;:</term>
622
 
<listitem><simpara> a mode indicating the online/offline status of the backend
 
614
<listitem><simpara>a mode indicating the online/offline status of the backend
623
615
</simpara></listitem></varlistentry>
624
616
</variablelist></refsect2>
625
617
<refsect2 id="e-book-backend-start-book-view" role="function">
626
618
<title>e_book_backend_start_book_view ()</title>
627
 
<indexterm zone="e-book-backend-start-book-view"><primary sortas="e_book_backend_start_book_view">e_book_backend_start_book_view</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_start_book_view      (<link linkend="EBookBackend">EBookBackend</link> *backend,
628
 
                                                         <link linkend="EDataBookView">EDataBookView</link> *view);</programlisting>
 
619
<indexterm zone="e-book-backend-start-book-view"><primary>e_book_backend_start_book_view</primary></indexterm>
 
620
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_start_book_view      (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
621
                                                         <parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);</programlisting>
629
622
<para>
630
623
Starts running the query specified by <parameter>book_view</parameter>, emitting
631
624
signals for matching contacts.</para>
632
 
<para>
633
 
</para><variablelist role="params">
 
625
<variablelist role="params">
634
626
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
635
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
627
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
636
628
</simpara></listitem></varlistentry>
637
629
<varlistentry><term><parameter>view</parameter>&#160;:</term>
638
630
<listitem><simpara>
640
632
</variablelist></refsect2>
641
633
<refsect2 id="e-book-backend-stop-book-view" role="function">
642
634
<title>e_book_backend_stop_book_view ()</title>
643
 
<indexterm zone="e-book-backend-stop-book-view"><primary sortas="e_book_backend_stop_book_view">e_book_backend_stop_book_view</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_stop_book_view       (<link linkend="EBookBackend">EBookBackend</link> *backend,
644
 
                                                         <link linkend="EDataBookView">EDataBookView</link> *view);</programlisting>
 
635
<indexterm zone="e-book-backend-stop-book-view"><primary>e_book_backend_stop_book_view</primary></indexterm>
 
636
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_stop_book_view       (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
637
                                                         <parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);</programlisting>
645
638
<para>
646
639
Stops running the query specified by <parameter>book_view</parameter>, emitting
647
640
no more signals.</para>
648
 
<para>
649
 
</para><variablelist role="params">
 
641
<variablelist role="params">
650
642
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
651
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
643
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
652
644
</simpara></listitem></varlistentry>
653
645
<varlistentry><term><parameter>view</parameter>&#160;:</term>
654
646
<listitem><simpara>
656
648
</variablelist></refsect2>
657
649
<refsect2 id="e-book-backend-add-book-view" role="function">
658
650
<title>e_book_backend_add_book_view ()</title>
659
 
<indexterm zone="e-book-backend-add-book-view"><primary sortas="e_book_backend_add_book_view">e_book_backend_add_book_view</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_add_book_view        (<link linkend="EBookBackend">EBookBackend</link> *backend,
660
 
                                                         <link linkend="EDataBookView">EDataBookView</link> *view);</programlisting>
 
651
<indexterm zone="e-book-backend-add-book-view"><primary>e_book_backend_add_book_view</primary></indexterm>
 
652
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_add_book_view        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
653
                                                         <parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);</programlisting>
661
654
<para>
662
655
Adds <parameter>view</parameter> to <parameter>backend</parameter> for querying.</para>
663
 
<para>
664
 
</para><variablelist role="params">
 
656
<variablelist role="params">
665
657
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
666
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
658
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
667
659
</simpara></listitem></varlistentry>
668
660
<varlistentry><term><parameter>view</parameter>&#160;:</term>
669
 
<listitem><simpara> an <link linkend="EDataBookView"><type>EDataBookView</type></link>
 
661
<listitem><simpara>an <link linkend="EDataBookView"><type>EDataBookView</type></link>
670
662
</simpara></listitem></varlistentry>
671
663
</variablelist></refsect2>
672
664
<refsect2 id="e-book-backend-remove-book-view" role="function">
673
665
<title>e_book_backend_remove_book_view ()</title>
674
 
<indexterm zone="e-book-backend-remove-book-view"><primary sortas="e_book_backend_remove_book_view">e_book_backend_remove_book_view</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_remove_book_view     (<link linkend="EBookBackend">EBookBackend</link> *backend,
675
 
                                                         <link linkend="EDataBookView">EDataBookView</link> *view);</programlisting>
 
666
<indexterm zone="e-book-backend-remove-book-view"><primary>e_book_backend_remove_book_view</primary></indexterm>
 
667
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_remove_book_view     (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
668
                                                         <parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);</programlisting>
676
669
<para>
677
670
Removes <parameter>view</parameter> from <parameter>backend</parameter>.</para>
678
 
<para>
679
 
</para><variablelist role="params">
 
671
<variablelist role="params">
680
672
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
681
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
673
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
682
674
</simpara></listitem></varlistentry>
683
675
<varlistentry><term><parameter>view</parameter>&#160;:</term>
684
 
<listitem><simpara> an <link linkend="EDataBookView"><type>EDataBookView</type></link>
 
676
<listitem><simpara>an <link linkend="EDataBookView"><type>EDataBookView</type></link>
685
677
</simpara></listitem></varlistentry>
686
678
</variablelist></refsect2>
687
679
<refsect2 id="e-book-backend-get-book-views" role="function">
688
680
<title>e_book_backend_get_book_views ()</title>
689
 
<indexterm zone="e-book-backend-get-book-views"><primary sortas="e_book_backend_get_book_views">e_book_backend_get_book_views</primary></indexterm><programlisting><link linkend="EList">EList</link> *             e_book_backend_get_book_views       (<link linkend="EBookBackend">EBookBackend</link> *backend);</programlisting>
 
681
<indexterm zone="e-book-backend-get-book-views"><primary>e_book_backend_get_book_views</primary></indexterm>
 
682
<programlisting><link linkend="EList"><returnvalue>EList</returnvalue></link> *             e_book_backend_get_book_views       (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
690
683
<para>
691
684
Gets the list of <link linkend="EDataBookView"><type>EDataBookView</type></link> views running on this backend.</para>
692
 
<para>
693
 
</para><variablelist role="params">
 
685
<variablelist role="params">
694
686
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
695
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
687
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
696
688
</simpara></listitem></varlistentry>
697
689
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EList"><type>EList</type></link> of <link linkend="EDataBookView"><type>EDataBookView</type></link> objects.
698
690
</simpara></listitem></varlistentry>
699
691
</variablelist></refsect2>
700
692
<refsect2 id="e-book-backend-notify-update" role="function">
701
693
<title>e_book_backend_notify_update ()</title>
702
 
<indexterm zone="e-book-backend-notify-update"><primary sortas="e_book_backend_notify_update">e_book_backend_notify_update</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_notify_update        (<link linkend="EBookBackend">EBookBackend</link> *backend,
703
 
                                                         <link linkend="EContact">EContact</link> *contact);</programlisting>
 
694
<indexterm zone="e-book-backend-notify-update"><primary>e_book_backend_notify_update</primary></indexterm>
 
695
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_notify_update        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
696
                                                         <parameter><link linkend="EContact"><type>EContact</type></link> *contact</parameter>);</programlisting>
704
697
<para>
705
698
Notifies all of <parameter>backend</parameter>'s book views about the new or modified
706
699
contacts <parameter>contact</parameter>.
709
702
<link linkend="e-data-book-respond-create"><function>e_data_book_respond_create()</function></link> and <link linkend="e-data-book-respond-modify"><function>e_data_book_respond_modify()</function></link> call this
710
703
function for you. You only need to call this from your backend if
711
704
contacts are created or modified by another (non-PAS-using) client.</para>
712
 
<para>
713
 
</para><variablelist role="params">
 
705
<variablelist role="params">
714
706
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
715
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
707
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
716
708
</simpara></listitem></varlistentry>
717
709
<varlistentry><term><parameter>contact</parameter>&#160;:</term>
718
 
<listitem><simpara> a new or modified contact
 
710
<listitem><simpara>a new or modified contact
719
711
</simpara></listitem></varlistentry>
720
712
</variablelist></refsect2>
721
713
<refsect2 id="e-book-backend-notify-remove" role="function">
722
714
<title>e_book_backend_notify_remove ()</title>
723
 
<indexterm zone="e-book-backend-notify-remove"><primary sortas="e_book_backend_notify_remove">e_book_backend_notify_remove</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_notify_remove        (<link linkend="EBookBackend">EBookBackend</link> *backend,
724
 
                                                         const <link linkend="gchar">gchar</link> *id);</programlisting>
 
715
<indexterm zone="e-book-backend-notify-remove"><primary>e_book_backend_notify_remove</primary></indexterm>
 
716
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_notify_remove        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
717
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);</programlisting>
725
718
<para>
726
719
Notifies all of <parameter>backend</parameter>'s book views that the contact with UID
727
720
<parameter>id</parameter> has been removed.
730
723
<link linkend="e-data-book-respond-remove-contacts"><function>e_data_book_respond_remove_contacts()</function></link> calls this function for you. You
731
724
only need to call this from your backend if contacts are removed by
732
725
another (non-PAS-using) client.</para>
733
 
<para>
734
 
</para><variablelist role="params">
 
726
<variablelist role="params">
735
727
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
736
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
728
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
737
729
</simpara></listitem></varlistentry>
738
730
<varlistentry><term><parameter>id</parameter>&#160;:</term>
739
 
<listitem><simpara> a contact id
 
731
<listitem><simpara>a contact id
740
732
</simpara></listitem></varlistentry>
741
733
</variablelist></refsect2>
742
734
<refsect2 id="e-book-backend-notify-complete" role="function">
743
735
<title>e_book_backend_notify_complete ()</title>
744
 
<indexterm zone="e-book-backend-notify-complete"><primary sortas="e_book_backend_notify_complete">e_book_backend_notify_complete</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_notify_complete      (<link linkend="EBookBackend">EBookBackend</link> *backend);</programlisting>
 
736
<indexterm zone="e-book-backend-notify-complete"><primary>e_book_backend_notify_complete</primary></indexterm>
 
737
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_notify_complete      (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
745
738
<para>
746
739
Notifies all of <parameter>backend</parameter>'s book views that the current set of
747
740
notifications is complete; use this after a series of
748
741
<link linkend="e-book-backend-notify-update"><function>e_book_backend_notify_update()</function></link> and <link linkend="e-book-backend-notify-remove"><function>e_book_backend_notify_remove()</function></link> calls.</para>
749
 
<para>
750
 
</para><variablelist role="params">
 
742
<variablelist role="params">
751
743
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
752
 
<listitem><simpara> an <link linkend="EBookbackend"><type>EBookbackend</type></link>
 
744
<listitem><simpara>an <link linkend="EBookbackend"><type>EBookbackend</type></link>
753
745
</simpara></listitem></varlistentry>
754
746
</variablelist></refsect2>
755
747
<refsect2 id="e-book-backend-notify-writable" role="function">
756
748
<title>e_book_backend_notify_writable ()</title>
757
 
<indexterm zone="e-book-backend-notify-writable"><primary sortas="e_book_backend_notify_writable">e_book_backend_notify_writable</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_notify_writable      (<link linkend="EBookBackend">EBookBackend</link> *backend,
758
 
                                                         <link linkend="gboolean">gboolean</link> is_writable);</programlisting>
 
749
<indexterm zone="e-book-backend-notify-writable"><primary>e_book_backend_notify_writable</primary></indexterm>
 
750
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_notify_writable      (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
751
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_writable</parameter>);</programlisting>
759
752
<para>
760
753
Notifies all backends clients about the current writable state.</para>
761
 
<para>
762
 
</para><variablelist role="params">
 
754
<variablelist role="params">
763
755
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
764
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
756
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
765
757
</simpara></listitem></varlistentry>
766
758
<varlistentry><term><parameter>is_writable</parameter>&#160;:</term>
767
 
<listitem><simpara> flag indicating writable status
 
759
<listitem><simpara>flag indicating writable status
768
760
</simpara></listitem></varlistentry>
769
761
</variablelist></refsect2>
770
762
<refsect2 id="e-book-backend-notify-connection-status" role="function">
771
763
<title>e_book_backend_notify_connection_status ()</title>
772
 
<indexterm zone="e-book-backend-notify-connection-status"><primary sortas="e_book_backend_notify_connection_status">e_book_backend_notify_connection_status</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_notify_connection_status
773
 
                                                        (<link linkend="EBookBackend">EBookBackend</link> *backend,
774
 
                                                         <link linkend="gboolean">gboolean</link> is_online);</programlisting>
 
764
<indexterm zone="e-book-backend-notify-connection-status"><primary>e_book_backend_notify_connection_status</primary></indexterm>
 
765
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_notify_connection_status
 
766
                                                        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
767
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_online</parameter>);</programlisting>
775
768
<para>
776
769
Notifies clients of <parameter>backend</parameter>'s connection status indicated by <parameter>is_online</parameter>.
777
770
Meant to be used by backend implementations.</para>
778
 
<para>
779
 
</para><variablelist role="params">
 
771
<variablelist role="params">
780
772
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
781
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
773
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
782
774
</simpara></listitem></varlistentry>
783
775
<varlistentry><term><parameter>is_online</parameter>&#160;:</term>
784
 
<listitem><simpara> flag indicating whether <parameter>backend</parameter> is connected and online
 
776
<listitem><simpara>flag indicating whether <parameter>backend</parameter> is connected and online
785
777
</simpara></listitem></varlistentry>
786
778
</variablelist></refsect2>
787
779
<refsect2 id="e-book-backend-notify-auth-required" role="function">
788
780
<title>e_book_backend_notify_auth_required ()</title>
789
 
<indexterm zone="e-book-backend-notify-auth-required"><primary sortas="e_book_backend_notify_auth_required">e_book_backend_notify_auth_required</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_notify_auth_required (<link linkend="EBookBackend">EBookBackend</link> *backend);</programlisting>
 
781
<indexterm zone="e-book-backend-notify-auth-required"><primary>e_book_backend_notify_auth_required</primary></indexterm>
 
782
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_notify_auth_required (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
790
783
<para>
791
784
Notifies clients that <parameter>backend</parameter> requires authentication in order to
792
785
connect. Means to be used by backend implementations.</para>
793
 
<para>
794
 
</para><variablelist role="params">
 
786
<variablelist role="params">
795
787
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
796
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
788
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
797
789
</simpara></listitem></varlistentry>
798
790
</variablelist></refsect2>
799
791
<refsect2 id="e-book-backend-sync" role="function">
800
792
<title>e_book_backend_sync ()</title>
801
 
<indexterm zone="e-book-backend-sync"><primary sortas="e_book_backend_sync">e_book_backend_sync</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_sync                 (<link linkend="EBookBackend">EBookBackend</link> *backend);</programlisting>
 
793
<indexterm zone="e-book-backend-sync"><primary>e_book_backend_sync</primary></indexterm>
 
794
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_sync                 (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
802
795
<para>
803
796
Write all pending data to disk.  This is only required under special
804
797
circumstances (for example before a live backup) and should not be used in
805
798
normal use.</para>
806
 
<para>
807
 
</para><variablelist role="params">
 
799
<variablelist role="params">
808
800
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
809
 
<listitem><simpara> an <link linkend="EBookbackend"><type>EBookbackend</type></link>
 
801
<listitem><simpara>an <link linkend="EBookbackend"><type>EBookbackend</type></link>
810
802
</simpara></listitem></varlistentry>
811
803
</variablelist></refsect2>
812
804
<refsect2 id="e-book-backend-set-is-loaded" role="function">
813
805
<title>e_book_backend_set_is_loaded ()</title>
814
 
<indexterm zone="e-book-backend-set-is-loaded"><primary sortas="e_book_backend_set_is_loaded">e_book_backend_set_is_loaded</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_set_is_loaded        (<link linkend="EBookBackend">EBookBackend</link> *backend,
815
 
                                                         <link linkend="gboolean">gboolean</link> is_loaded);</programlisting>
 
806
<indexterm zone="e-book-backend-set-is-loaded"><primary>e_book_backend_set_is_loaded</primary></indexterm>
 
807
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_set_is_loaded        (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
808
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_loaded</parameter>);</programlisting>
816
809
<para>
817
810
Sets the flag indicating whether <parameter>backend</parameter> is loaded to <parameter>is_loaded</parameter>.
818
811
Meant to be used by backend implementations.</para>
819
 
<para>
820
 
</para><variablelist role="params">
 
812
<variablelist role="params">
821
813
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
822
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
814
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
823
815
</simpara></listitem></varlistentry>
824
816
<varlistentry><term><parameter>is_loaded</parameter>&#160;:</term>
825
 
<listitem><simpara> A flag indicating whether the backend is loaded
 
817
<listitem><simpara>A flag indicating whether the backend is loaded
826
818
</simpara></listitem></varlistentry>
827
819
</variablelist></refsect2>
828
820
<refsect2 id="e-book-backend-set-is-writable" role="function">
829
821
<title>e_book_backend_set_is_writable ()</title>
830
 
<indexterm zone="e-book-backend-set-is-writable"><primary sortas="e_book_backend_set_is_writable">e_book_backend_set_is_writable</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_set_is_writable      (<link linkend="EBookBackend">EBookBackend</link> *backend,
831
 
                                                         <link linkend="gboolean">gboolean</link> is_writable);</programlisting>
 
822
<indexterm zone="e-book-backend-set-is-writable"><primary>e_book_backend_set_is_writable</primary></indexterm>
 
823
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_set_is_writable      (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
824
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_writable</parameter>);</programlisting>
832
825
<para>
833
826
Sets the flag indicating whether <parameter>backend</parameter> is writeable to <parameter>is_writeable</parameter>.
834
827
Meant to be used by backend implementations.</para>
835
 
<para>
836
 
</para><variablelist role="params">
 
828
<variablelist role="params">
837
829
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
838
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
830
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
839
831
</simpara></listitem></varlistentry>
840
832
<varlistentry><term><parameter>is_writable</parameter>&#160;:</term>
841
 
<listitem><simpara> A flag indicating whether the backend is writeable
 
833
<listitem><simpara>A flag indicating whether the backend is writeable
842
834
</simpara></listitem></varlistentry>
843
835
</variablelist></refsect2>
844
836
<refsect2 id="e-book-backend-set-is-removed" role="function">
845
837
<title>e_book_backend_set_is_removed ()</title>
846
 
<indexterm zone="e-book-backend-set-is-removed"><primary sortas="e_book_backend_set_is_removed">e_book_backend_set_is_removed</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_set_is_removed       (<link linkend="EBookBackend">EBookBackend</link> *backend,
847
 
                                                         <link linkend="gboolean">gboolean</link> is_removed);</programlisting>
 
838
<indexterm zone="e-book-backend-set-is-removed"><primary>e_book_backend_set_is_removed</primary></indexterm>
 
839
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_set_is_removed       (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
 
840
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_removed</parameter>);</programlisting>
848
841
<para>
849
842
Sets the flag indicating whether <parameter>backend</parameter> was removed to <parameter>is_removed</parameter>.
850
843
Meant to be used by backend implementations.</para>
851
 
<para>
852
 
</para><variablelist role="params">
 
844
<variablelist role="params">
853
845
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
854
 
<listitem><simpara> an <link linkend="EBookBackend"><type>EBookBackend</type></link>
 
846
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
855
847
</simpara></listitem></varlistentry>
856
848
<varlistentry><term><parameter>is_removed</parameter>&#160;:</term>
857
 
<listitem><simpara> A flag indicating whether the backend's storage was removed
 
849
<listitem><simpara>A flag indicating whether the backend's storage was removed
858
850
</simpara></listitem></varlistentry>
859
851
</variablelist></refsect2>
860
852
<refsect2 id="e-book-backend-change-add-new" role="function">
861
853
<title>e_book_backend_change_add_new ()</title>
862
 
<indexterm zone="e-book-backend-change-add-new"><primary sortas="e_book_backend_change_add_new">e_book_backend_change_add_new</primary></indexterm><programlisting><link linkend="GNOME-Evolution-Addressbook-BookChangeItem">GNOME_Evolution_Addressbook_BookChangeItem</link>* e_book_backend_change_add_new
863
 
                                                        (const <link linkend="gchar">gchar</link> *vcard);</programlisting>
 
854
<indexterm zone="e-book-backend-change-add-new"><primary>e_book_backend_change_add_new</primary></indexterm>
 
855
<programlisting><link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* e_book_backend_change_add_new
 
856
                                                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);</programlisting>
864
857
<para>
865
858
Creates a new change item indicating <parameter>vcard</parameter> was added.
866
859
Meant to be used by backend implementations.</para>
867
 
<para>
868
 
</para><variablelist role="params">
 
860
<variablelist role="params">
869
861
<varlistentry><term><parameter>vcard</parameter>&#160;:</term>
870
 
<listitem><simpara> a VCard string
 
862
<listitem><simpara>a VCard string
871
863
</simpara></listitem></varlistentry>
872
864
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><type>GNOME_Evolution_Addressbook_BookChangeItem</type></link>.
873
865
</simpara></listitem></varlistentry>
874
866
</variablelist></refsect2>
875
867
<refsect2 id="e-book-backend-change-modify-new" role="function">
876
868
<title>e_book_backend_change_modify_new ()</title>
877
 
<indexterm zone="e-book-backend-change-modify-new"><primary sortas="e_book_backend_change_modify_new">e_book_backend_change_modify_new</primary></indexterm><programlisting><link linkend="GNOME-Evolution-Addressbook-BookChangeItem">GNOME_Evolution_Addressbook_BookChangeItem</link>* e_book_backend_change_modify_new
878
 
                                                        (const <link linkend="gchar">gchar</link> *vcard);</programlisting>
 
869
<indexterm zone="e-book-backend-change-modify-new"><primary>e_book_backend_change_modify_new</primary></indexterm>
 
870
<programlisting><link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* e_book_backend_change_modify_new
 
871
                                                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);</programlisting>
879
872
<para>
880
873
Creates a new change item indicating <parameter>vcard</parameter> was modified.
881
874
Meant to be used by backend implementations.</para>
882
 
<para>
883
 
</para><variablelist role="params">
 
875
<variablelist role="params">
884
876
<varlistentry><term><parameter>vcard</parameter>&#160;:</term>
885
 
<listitem><simpara> a VCard string
 
877
<listitem><simpara>a VCard string
886
878
</simpara></listitem></varlistentry>
887
879
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><type>GNOME_Evolution_Addressbook_BookChangeItem</type></link>.
888
880
</simpara></listitem></varlistentry>
889
881
</variablelist></refsect2>
890
882
<refsect2 id="e-book-backend-change-delete-new" role="function">
891
883
<title>e_book_backend_change_delete_new ()</title>
892
 
<indexterm zone="e-book-backend-change-delete-new"><primary sortas="e_book_backend_change_delete_new">e_book_backend_change_delete_new</primary></indexterm><programlisting><link linkend="GNOME-Evolution-Addressbook-BookChangeItem">GNOME_Evolution_Addressbook_BookChangeItem</link>* e_book_backend_change_delete_new
893
 
                                                        (const <link linkend="gchar">gchar</link> *id);</programlisting>
 
884
<indexterm zone="e-book-backend-change-delete-new"><primary>e_book_backend_change_delete_new</primary></indexterm>
 
885
<programlisting><link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* e_book_backend_change_delete_new
 
886
                                                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);</programlisting>
894
887
<para>
895
888
Creates a new change item indicating <parameter>vcard</parameter> was deleted.
896
889
Meant to be used by backend implementations.</para>
897
 
<para>
898
 
</para><variablelist role="params">
 
890
<variablelist role="params">
899
891
<varlistentry><term><parameter>id</parameter>&#160;:</term>
900
892
<listitem><simpara>
901
893
</simpara></listitem></varlistentry>
904
896
</variablelist></refsect2>
905
897
<refsect2 id="EBookBackendClass" role="struct">
906
898
<title>struct EBookBackendClass</title>
907
 
<indexterm zone="EBookBackendClass"><primary sortas="EBookBackendClass">EBookBackendClass</primary></indexterm><programlisting>struct EBookBackendClass {
 
899
<indexterm zone="EBookBackendClass"><primary>EBookBackendClass</primary></indexterm>
 
900
<programlisting>struct EBookBackendClass {
908
901
        GObjectClass parent_class;
909
902
 
910
903
        /* Virtual methods */
943
936
</para></refsect2>
944
937
 
945
938
</refsect1>
946
 
 
947
939
<refsect1 id="EBookBackend.signal-details" role="signals">
948
940
<title role="signals.title">Signal Details</title>
949
941
<refsect2 id="EBookBackend-last-client-gone" role="signal"><title>The <literal>&quot;last-client-gone&quot;</literal> signal</title>
950
 
<indexterm zone="EBookBackend-last-client-gone"><primary sortas="EBookBackend::last-client-gone">EBookBackend::last-client-gone</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EBookBackend">EBookBackend</link> *ebookbackend,
951
 
                                                        <link linkend="gpointer">gpointer</link>      user_data)         : Run First</programlisting>
 
942
<indexterm zone="EBookBackend-last-client-gone"><primary>EBookBackend::last-client-gone</primary></indexterm>
 
943
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="EBookBackend"><type>EBookBackend</type></link> *ebookbackend,
 
944
                                                        <link linkend="gpointer"><type>gpointer</type></link>      user_data)         : Run First</programlisting>
952
945
<para>
953
946
</para><variablelist role="params">
954
947
<varlistentry><term><parameter>ebookbackend</parameter>&#160;:</term>
959
952
</variablelist></refsect2>
960
953
</refsect1>
961
954
 
962
 
 
963
 
 
964
955
</refentry>