← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-updates

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libedata-book/xml/e-book-backend-summary.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-summary.xml
5
5
<refmeta>
6
6
<refentrytitle role="top_of_page" id="EBookBackendSummary.top_of_page">EBookBackendSummary</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>EBookBackendSummary</refname>
13
14
<refpurpose></refpurpose>
16
17
<refsynopsisdiv id="EBookBackendSummary.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
18
19
 
19
 
<synopsis>
20
 
struct              <link linkend="EBookBackendSummary-struct">EBookBackendSummary</link>;
21
 
<link linkend="EBookBackendSummary">EBookBackendSummary</link>* <link linkend="e-book-backend-summary-new">e_book_backend_summary_new</link>         (const <link linkend="gchar">gchar</link> *summary_path,
22
 
                                                         <link linkend="gint">gint</link> flush_timeout_millis);
23
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-summary-load">e_book_backend_summary_load</link>         (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary);
24
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-summary-save">e_book_backend_summary_save</link>         (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary);
25
 
<link linkend="void">void</link>                <link linkend="e-book-backend-summary-add-contact">e_book_backend_summary_add_contact</link>  (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
26
 
                                                         <link linkend="EContact">EContact</link> *contact);
27
 
<link linkend="void">void</link>                <link linkend="e-book-backend-summary-remove-contact">e_book_backend_summary_remove_contact</link>
28
 
                                                        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
29
 
                                                         const <link linkend="gchar">gchar</link> *id);
30
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-summary-check-contact">e_book_backend_summary_check_contact</link>
31
 
                                                        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
32
 
                                                         const <link linkend="gchar">gchar</link> *id);
33
 
<link linkend="void">void</link>                <link linkend="e-book-backend-summary-touch">e_book_backend_summary_touch</link>        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary);
34
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-summary-is-up-to-date">e_book_backend_summary_is_up_to_date</link>
35
 
                                                        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
36
 
                                                         <link linkend="time-t">time_t</link> t);
37
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-book-backend-summary-is-summary-query">e_book_backend_summary_is_summary_query</link>
38
 
                                                        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
39
 
                                                         const <link linkend="gchar">gchar</link> *query);
40
 
<link linkend="GPtrArray">GPtrArray</link>*          <link linkend="e-book-backend-summary-search">e_book_backend_summary_search</link>       (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
41
 
                                                         const <link linkend="gchar">gchar</link> *query);
42
 
<link linkend="gchar">gchar</link> *             <link linkend="e-book-backend-summary-get-summary-vcard">e_book_backend_summary_get_summary_vcard</link>
43
 
                                                        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
44
 
                                                         const <link linkend="gchar">gchar</link> *id);
 
20
<synopsis>struct              <link linkend="EBookBackendSummary-struct">EBookBackendSummary</link>;
 
21
<link linkend="EBookBackendSummary"><returnvalue>EBookBackendSummary</returnvalue></link>* <link linkend="e-book-backend-summary-new">e_book_backend_summary_new</link>         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *summary_path</parameter>,
 
22
                                                         <parameter><link linkend="gint"><type>gint</type></link> flush_timeout_millis</parameter>);
 
23
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-summary-load">e_book_backend_summary_load</link>         (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>);
 
24
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-summary-save">e_book_backend_summary_save</link>         (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>);
 
25
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-summary-add-contact">e_book_backend_summary_add_contact</link>  (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
26
                                                         <parameter><link linkend="EContact"><type>EContact</type></link> *contact</parameter>);
 
27
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-summary-remove-contact">e_book_backend_summary_remove_contact</link>
 
28
                                                        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
29
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);
 
30
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-summary-check-contact">e_book_backend_summary_check_contact</link>
 
31
                                                        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
32
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);
 
33
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-book-backend-summary-touch">e_book_backend_summary_touch</link>        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>);
 
34
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-summary-is-up-to-date">e_book_backend_summary_is_up_to_date</link>
 
35
                                                        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
36
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> t</parameter>);
 
37
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-summary-is-summary-query">e_book_backend_summary_is_summary_query</link>
 
38
                                                        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
39
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);
 
40
<link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>*          <link linkend="e-book-backend-summary-search">e_book_backend_summary_search</link>       (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
41
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);
 
42
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-book-backend-summary-get-summary-vcard">e_book_backend_summary_get_summary_vcard</link>
 
43
                                                        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
44
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);
45
45
</synopsis>
46
46
</refsynopsisdiv>
47
 
 
48
47
<refsect1 id="EBookBackendSummary.object-hierarchy" role="object_hierarchy">
49
48
<title role="object_hierarchy.title">Object Hierarchy</title>
50
49
<synopsis>
53
52
</synopsis>
54
53
</refsect1>
55
54
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
 
 
62
 
 
63
55
<refsect1 id="EBookBackendSummary.description" role="desc">
64
56
<title role="desc.title">Description</title>
65
57
<para>
66
58
</para>
67
59
</refsect1>
68
 
 
69
60
<refsect1 id="EBookBackendSummary.details" role="details">
70
61
<title role="details.title">Details</title>
71
62
<refsect2 id="EBookBackendSummary-struct" role="struct">
72
63
<title>struct EBookBackendSummary</title>
73
 
<indexterm zone="EBookBackendSummary-struct"><primary sortas="EBookBackendSummary">EBookBackendSummary</primary></indexterm><programlisting>struct EBookBackendSummary;</programlisting>
 
64
<indexterm zone="EBookBackendSummary-struct"><primary>EBookBackendSummary</primary></indexterm>
 
65
<programlisting>struct EBookBackendSummary;</programlisting>
74
66
<para>
75
67
</para></refsect2>
76
68
<refsect2 id="e-book-backend-summary-new" role="function">
77
69
<title>e_book_backend_summary_new ()</title>
78
 
<indexterm zone="e-book-backend-summary-new"><primary sortas="e_book_backend_summary_new">e_book_backend_summary_new</primary></indexterm><programlisting><link linkend="EBookBackendSummary">EBookBackendSummary</link>* e_book_backend_summary_new         (const <link linkend="gchar">gchar</link> *summary_path,
79
 
                                                         <link linkend="gint">gint</link> flush_timeout_millis);</programlisting>
 
70
<indexterm zone="e-book-backend-summary-new"><primary>e_book_backend_summary_new</primary></indexterm>
 
71
<programlisting><link linkend="EBookBackendSummary"><returnvalue>EBookBackendSummary</returnvalue></link>* e_book_backend_summary_new         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *summary_path</parameter>,
 
72
                                                         <parameter><link linkend="gint"><type>gint</type></link> flush_timeout_millis</parameter>);</programlisting>
80
73
<para>
81
74
Creates an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> object without loading it
82
75
or otherwise affecting the file. <parameter>flush_timeout_millis</parameter>
83
76
specifies how much time should elapse, at a minimum, from
84
77
the summary is changed until it is flushed to disk.</para>
85
 
<para>
86
 
</para><variablelist role="params">
 
78
<variablelist role="params">
87
79
<varlistentry><term><parameter>summary_path</parameter>&#160;:</term>
88
 
<listitem><simpara> a local file system path
 
80
<listitem><simpara>a local file system path
89
81
</simpara></listitem></varlistentry>
90
82
<varlistentry><term><parameter>flush_timeout_millis</parameter>&#160;:</term>
91
 
<listitem><simpara> a flush interval, in milliseconds
 
83
<listitem><simpara>a flush interval, in milliseconds
92
84
</simpara></listitem></varlistentry>
93
85
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>.
94
86
</simpara></listitem></varlistentry>
95
87
</variablelist></refsect2>
96
88
<refsect2 id="e-book-backend-summary-load" role="function">
97
89
<title>e_book_backend_summary_load ()</title>
98
 
<indexterm zone="e-book-backend-summary-load"><primary sortas="e_book_backend_summary_load">e_book_backend_summary_load</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_summary_load         (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary);</programlisting>
 
90
<indexterm zone="e-book-backend-summary-load"><primary>e_book_backend_summary_load</primary></indexterm>
 
91
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_summary_load         (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>);</programlisting>
99
92
<para>
100
93
Attempts to load <parameter>summary</parameter> from disk. The load is successful if
101
94
the file was located, it was in the correct format, and it was
102
95
not out of date.</para>
103
 
<para>
104
 
</para><variablelist role="params">
 
96
<variablelist role="params">
105
97
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
106
 
<listitem><simpara> an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
 
98
<listitem><simpara>an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
107
99
</simpara></listitem></varlistentry>
108
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the load succeeded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if it failed.
 
100
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the load succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if it failed.
109
101
</simpara></listitem></varlistentry>
110
102
</variablelist></refsect2>
111
103
<refsect2 id="e-book-backend-summary-save" role="function">
112
104
<title>e_book_backend_summary_save ()</title>
113
 
<indexterm zone="e-book-backend-summary-save"><primary sortas="e_book_backend_summary_save">e_book_backend_summary_save</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_summary_save         (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary);</programlisting>
 
105
<indexterm zone="e-book-backend-summary-save"><primary>e_book_backend_summary_save</primary></indexterm>
 
106
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_summary_save         (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>);</programlisting>
114
107
<para>
115
108
Attempts to save <parameter>summary</parameter> to disk.</para>
116
 
<para>
117
 
</para><variablelist role="params">
 
109
<variablelist role="params">
118
110
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
119
 
<listitem><simpara> an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
 
111
<listitem><simpara>an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
120
112
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the save succeeded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
113
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the save succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
122
114
</simpara></listitem></varlistentry>
123
115
</variablelist></refsect2>
124
116
<refsect2 id="e-book-backend-summary-add-contact" role="function">
125
117
<title>e_book_backend_summary_add_contact ()</title>
126
 
<indexterm zone="e-book-backend-summary-add-contact"><primary sortas="e_book_backend_summary_add_contact">e_book_backend_summary_add_contact</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_summary_add_contact  (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
127
 
                                                         <link linkend="EContact">EContact</link> *contact);</programlisting>
 
118
<indexterm zone="e-book-backend-summary-add-contact"><primary>e_book_backend_summary_add_contact</primary></indexterm>
 
119
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_summary_add_contact  (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
120
                                                         <parameter><link linkend="EContact"><type>EContact</type></link> *contact</parameter>);</programlisting>
128
121
<para>
129
122
Adds a summary of <parameter>contact</parameter> to <parameter>summary</parameter>. Does not check if
130
123
the contact already has a summary.</para>
131
 
<para>
132
 
</para><variablelist role="params">
 
124
<variablelist role="params">
133
125
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
134
 
<listitem><simpara> an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
 
126
<listitem><simpara>an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
135
127
</simpara></listitem></varlistentry>
136
128
<varlistentry><term><parameter>contact</parameter>&#160;:</term>
137
 
<listitem><simpara> an <link linkend="EContact"><type>EContact</type></link> to add
 
129
<listitem><simpara>an <link linkend="EContact"><type>EContact</type></link> to add
138
130
</simpara></listitem></varlistentry>
139
131
</variablelist></refsect2>
140
132
<refsect2 id="e-book-backend-summary-remove-contact" role="function">
141
133
<title>e_book_backend_summary_remove_contact ()</title>
142
 
<indexterm zone="e-book-backend-summary-remove-contact"><primary sortas="e_book_backend_summary_remove_contact">e_book_backend_summary_remove_contact</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_summary_remove_contact
143
 
                                                        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
144
 
                                                         const <link linkend="gchar">gchar</link> *id);</programlisting>
 
134
<indexterm zone="e-book-backend-summary-remove-contact"><primary>e_book_backend_summary_remove_contact</primary></indexterm>
 
135
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_summary_remove_contact
 
136
                                                        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
137
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);</programlisting>
145
138
<para>
146
139
Removes the summary of the contact identified by <parameter>id</parameter> from <parameter>summary</parameter>.</para>
147
 
<para>
148
 
</para><variablelist role="params">
 
140
<variablelist role="params">
149
141
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
150
 
<listitem><simpara> an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
 
142
<listitem><simpara>an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
151
143
</simpara></listitem></varlistentry>
152
144
<varlistentry><term><parameter>id</parameter>&#160;:</term>
153
 
<listitem><simpara> a unique contact ID string
 
145
<listitem><simpara>a unique contact ID string
154
146
</simpara></listitem></varlistentry>
155
147
</variablelist></refsect2>
156
148
<refsect2 id="e-book-backend-summary-check-contact" role="function">
157
149
<title>e_book_backend_summary_check_contact ()</title>
158
 
<indexterm zone="e-book-backend-summary-check-contact"><primary sortas="e_book_backend_summary_check_contact">e_book_backend_summary_check_contact</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_summary_check_contact
159
 
                                                        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
160
 
                                                         const <link linkend="gchar">gchar</link> *id);</programlisting>
 
150
<indexterm zone="e-book-backend-summary-check-contact"><primary>e_book_backend_summary_check_contact</primary></indexterm>
 
151
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_summary_check_contact
 
152
                                                        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
153
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);</programlisting>
161
154
<para>
162
155
Checks if a summary of the contact identified by <parameter>id</parameter>
163
156
exists in <parameter>summary</parameter>.</para>
164
 
<para>
165
 
</para><variablelist role="params">
 
157
<variablelist role="params">
166
158
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
167
 
<listitem><simpara> an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
 
159
<listitem><simpara>an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
168
160
</simpara></listitem></varlistentry>
169
161
<varlistentry><term><parameter>id</parameter>&#160;:</term>
170
 
<listitem><simpara> a unique contact ID string
 
162
<listitem><simpara>a unique contact ID string
171
163
</simpara></listitem></varlistentry>
172
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the summary exists, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
164
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the summary exists, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
173
165
</simpara></listitem></varlistentry>
174
166
</variablelist></refsect2>
175
167
<refsect2 id="e-book-backend-summary-touch" role="function">
176
168
<title>e_book_backend_summary_touch ()</title>
177
 
<indexterm zone="e-book-backend-summary-touch"><primary sortas="e_book_backend_summary_touch">e_book_backend_summary_touch</primary></indexterm><programlisting><link linkend="void">void</link>                e_book_backend_summary_touch        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary);</programlisting>
 
169
<indexterm zone="e-book-backend-summary-touch"><primary>e_book_backend_summary_touch</primary></indexterm>
 
170
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_book_backend_summary_touch        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>);</programlisting>
178
171
<para>
179
172
Indicates that <parameter>summary</parameter> has changed and should be flushed to disk.</para>
180
 
<para>
181
 
</para><variablelist role="params">
 
173
<variablelist role="params">
182
174
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
183
 
<listitem><simpara> an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
 
175
<listitem><simpara>an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
184
176
</simpara></listitem></varlistentry>
185
177
</variablelist></refsect2>
186
178
<refsect2 id="e-book-backend-summary-is-up-to-date" role="function">
187
179
<title>e_book_backend_summary_is_up_to_date ()</title>
188
 
<indexterm zone="e-book-backend-summary-is-up-to-date"><primary sortas="e_book_backend_summary_is_up_to_date">e_book_backend_summary_is_up_to_date</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_summary_is_up_to_date
189
 
                                                        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
190
 
                                                         <link linkend="time-t">time_t</link> t);</programlisting>
 
180
<indexterm zone="e-book-backend-summary-is-up-to-date"><primary>e_book_backend_summary_is_up_to_date</primary></indexterm>
 
181
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_summary_is_up_to_date
 
182
                                                        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
183
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> t</parameter>);</programlisting>
191
184
<para>
192
185
Checks if <parameter>summary</parameter> is more recent than <parameter>t</parameter>.</para>
193
 
<para>
194
 
</para><variablelist role="params">
 
186
<variablelist role="params">
195
187
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
196
 
<listitem><simpara> an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
 
188
<listitem><simpara>an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
197
189
</simpara></listitem></varlistentry>
198
190
<varlistentry><term><parameter>t</parameter>&#160;:</term>
199
 
<listitem><simpara> the time to compare with
 
191
<listitem><simpara>the time to compare with
200
192
</simpara></listitem></varlistentry>
201
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the summary is up to date, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
193
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the summary is up to date, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
202
194
</simpara></listitem></varlistentry>
203
195
</variablelist></refsect2>
204
196
<refsect2 id="e-book-backend-summary-is-summary-query" role="function">
205
197
<title>e_book_backend_summary_is_summary_query ()</title>
206
 
<indexterm zone="e-book-backend-summary-is-summary-query"><primary sortas="e_book_backend_summary_is_summary_query">e_book_backend_summary_is_summary_query</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_book_backend_summary_is_summary_query
207
 
                                                        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
208
 
                                                         const <link linkend="gchar">gchar</link> *query);</programlisting>
 
198
<indexterm zone="e-book-backend-summary-is-summary-query"><primary>e_book_backend_summary_is_summary_query</primary></indexterm>
 
199
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_summary_is_summary_query
 
200
                                                        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
201
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);</programlisting>
209
202
<para>
210
203
Checks if <parameter>query</parameter> can be satisfied by searching only the fields
211
204
stored by <parameter>summary</parameter>.</para>
212
 
<para>
213
 
</para><variablelist role="params">
 
205
<variablelist role="params">
214
206
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
215
 
<listitem><simpara> an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
 
207
<listitem><simpara>an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
216
208
</simpara></listitem></varlistentry>
217
209
<varlistentry><term><parameter>query</parameter>&#160;:</term>
218
 
<listitem><simpara> an s-expression to check
 
210
<listitem><simpara>an s-expression to check
219
211
</simpara></listitem></varlistentry>
220
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the query can be satisfied, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
212
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the query can be satisfied, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
221
213
</simpara></listitem></varlistentry>
222
214
</variablelist></refsect2>
223
215
<refsect2 id="e-book-backend-summary-search" role="function">
224
216
<title>e_book_backend_summary_search ()</title>
225
 
<indexterm zone="e-book-backend-summary-search"><primary sortas="e_book_backend_summary_search">e_book_backend_summary_search</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link>*          e_book_backend_summary_search       (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
226
 
                                                         const <link linkend="gchar">gchar</link> *query);</programlisting>
 
217
<indexterm zone="e-book-backend-summary-search"><primary>e_book_backend_summary_search</primary></indexterm>
 
218
<programlisting><link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>*          e_book_backend_summary_search       (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
219
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);</programlisting>
227
220
<para>
228
221
Searches <parameter>summary</parameter> for contacts matching <parameter>query</parameter>.</para>
229
 
<para>
230
 
</para><variablelist role="params">
 
222
<variablelist role="params">
231
223
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
232
 
<listitem><simpara> an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
 
224
<listitem><simpara>an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
233
225
</simpara></listitem></varlistentry>
234
226
<varlistentry><term><parameter>query</parameter>&#160;:</term>
235
 
<listitem><simpara> an s-expression
 
227
<listitem><simpara>an s-expression
236
228
</simpara></listitem></varlistentry>
237
229
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GPtrArray"><type>GPtrArray</type></link> of pointers to contact ID strings.
238
230
</simpara></listitem></varlistentry>
239
231
</variablelist></refsect2>
240
232
<refsect2 id="e-book-backend-summary-get-summary-vcard" role="function">
241
233
<title>e_book_backend_summary_get_summary_vcard ()</title>
242
 
<indexterm zone="e-book-backend-summary-get-summary-vcard"><primary sortas="e_book_backend_summary_get_summary_vcard">e_book_backend_summary_get_summary_vcard</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             e_book_backend_summary_get_summary_vcard
243
 
                                                        (<link linkend="EBookBackendSummary">EBookBackendSummary</link> *summary,
244
 
                                                         const <link linkend="gchar">gchar</link> *id);</programlisting>
 
234
<indexterm zone="e-book-backend-summary-get-summary-vcard"><primary>e_book_backend_summary_get_summary_vcard</primary></indexterm>
 
235
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_book_backend_summary_get_summary_vcard
 
236
                                                        (<parameter><link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link> *summary</parameter>,
 
237
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);</programlisting>
245
238
<para>
246
239
Constructs and returns a VCard from the contact summary specified
247
240
by <parameter>id</parameter>.</para>
248
 
<para>
249
 
</para><variablelist role="params">
 
241
<variablelist role="params">
250
242
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
251
 
<listitem><simpara> an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
 
243
<listitem><simpara>an <link linkend="EBookBackendSummary"><type>EBookBackendSummary</type></link>
252
244
</simpara></listitem></varlistentry>
253
245
<varlistentry><term><parameter>id</parameter>&#160;:</term>
254
 
<listitem><simpara> a unique contact ID
 
246
<listitem><simpara>a unique contact ID
255
247
</simpara></listitem></varlistentry>
256
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new VCard, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the contact summary didn't exist.
 
248
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new VCard, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the contact summary didn't exist.
257
249
</simpara></listitem></varlistentry>
258
250
</variablelist></refsect2>
259
251
 
260
252
</refsect1>
261
253
 
262
 
 
263
 
 
264
 
 
265
254
</refentry>