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

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libedata-book/html/EBookBackendSummary.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-11-13 10:59:20 UTC
  • mfrom: (1.1.38 upstream)
  • Revision ID: james.westby@ubuntu.com-20071113105920-nb6w14udvgx0ghi3
Tags: 2.21.2-0ubuntu1
* New upstream version:
  Bug Fixes:
  - #318842: Task lists should be sorted (LP: #23912)
  - #345135: Disable SSLv2 compatible HELLO on SSL stream when 
    SSLv2 is disabled
  - #359267: Not all memos are showed in calendar view
  - #430420: Returned size <= 0 is an error
  - #460649: Meeting UI Needs To Show Color Of Selected Calendar Source
  - #487229: Use GKeyFile instead of gnome-config to access stored passwords
  - #488156: Minimize use of the WITH_GNOME_KEYRING macro
  - #492130: ESourceSelector uses pointers to ESource
  - #494304: Fix leak
  Updated Translations
  New in 2.21.1:
  - Support for Google Calendar
  Bug Fixes:
  - #203480: (Novell Bugzilla) Compiler warning fix 
    for usage ofunintialized variable
  - #231178: New symbol 'set-label' defined and added corresponding callback
  - #271777: Keep character's case as user types
  - #417999: Don't use deprecated GTK+ symbols
  - #420167: e-d-s now exits with gnome-session
  - #469657: Better use of GHashTable
  - #474000: Use GLib's Base64 API instead of Camel's
  - #475487: When creating the default contact, print errors to the console
  - #475493: Use G_DEFINE_TYPE
  - #475494: Use G_LOCK instead of a static mutex for clearer code
  - #478404: Reset the id to zero
  - #483301: Remove an unused variable
  - #487270: Fix typo in documentation
  - #488173: Remove __FUNCTION__, which is a gcc-ism
  - #488351: Fix an addressbook error on a fresh install
  Other Contributors:
  - Protect against a NULL subject string. 
* debian/*.preinst:
  - On upgrades from Gutsy, remove the symlinks introduced in Gutsy. They
    break upgrades all over, and current cdbs just symlinks individual files.
* Sync with Debian
* debian/control:
  - evolution-data-server Breaks evolution (<< 2.9), 
    evolution-exchange (<= 2.8.1-0ubuntu1),
    evolution-jescs (<= 2.8.2-0ubuntu3), 
    evolution-scalix (<= 10.0.0.357-0ubuntu6)
  - updated maintainer to desktop team
* debian/rules:
  - don't specify the paths for nspr and nss since the package is built 
    with firefox
  - don't build documentation, it's distributed in the upstream tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>EBookBackendSummary</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
7
7
<link rel="start" href="index.html" title="Evolution API Reference: libedata-book, the Addressbook backend library">
8
8
<link rel="up" href="ch01.html" title="Evolution API Reference: libedata-book, the Addressbook backend library">
9
9
<link rel="prev" href="EBookBackendSExp.html" title="EBookBackendSExp">
10
10
<link rel="next" href="EBookBackendSync.html" title="EBookBackendSync">
11
 
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="Evolution API Reference: libedata-book, the Addressbook backend library">
14
14
<link rel="index" href="ix01.html" title="Index">
22
22
<th width="100%" align="center">Evolution API Reference: libedata-book, the Addressbook backend library</th>
23
23
<td><a accesskey="n" href="EBookBackendSync.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
24
24
</tr>
25
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2558049" class="shortcut">Top</a>
26
 
                  &#160;|&#160;
27
 
                  <a href="#id2564734" class="shortcut">Description</a>
28
 
                  &#160;|&#160;
29
 
                  <a href="#id2564710" class="shortcut">Object Hierarchy</a></nobr></td></tr>
 
25
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2613858" class="shortcut">Top</a>
 
26
                  &#160;|&#160;
 
27
                  <a href="#id2620557" class="shortcut">Description</a>
 
28
                  &#160;|&#160;
 
29
                  <a href="#id2620533" class="shortcut">Object Hierarchy</a></nobr></td></tr>
30
30
</table>
31
31
<div class="refentry" lang="en">
32
32
<a name="EBookBackendSummary"></a><div class="titlepage"></div>
33
33
<div class="refnamediv"><table width="100%"><tr>
34
34
<td valign="top">
35
35
<h2>
36
 
<a name="id2558049"></a><span class="refentrytitle">EBookBackendSummary</span>
 
36
<a name="id2613858"></a><span class="refentrytitle">EBookBackendSummary</span>
37
37
</h2>
38
38
<p>EBookBackendSummary</p>
39
39
</td>
45
45
 
46
46
 
47
47
 
48
 
struct              <a href="EBookBackendSummary.html#EBookBackendSummary-struct">EBookBackendSummary</a>;
49
 
<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a>* <a href="EBookBackendSummary.html#e-book-backend-summary-new">e_book_backend_summary_new</a>         (const char *summary_path,
 
48
struct              <a class="link" href="EBookBackendSummary.html#EBookBackendSummary-struct">EBookBackendSummary</a>;
 
49
<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a>* <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-new">e_book_backend_summary_new</a>         (const char *summary_path,
50
50
                                                         int flush_timeout_millis);
51
 
<a
52
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
53
 
>gboolean</a>            <a href="EBookBackendSummary.html#e-book-backend-summary-load">e_book_backend_summary_load</a>         (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
54
 
<a
55
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
56
 
>gboolean</a>            <a href="EBookBackendSummary.html#e-book-backend-summary-save">e_book_backend_summary_save</a>         (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
57
 
void                <a href="EBookBackendSummary.html#e-book-backend-summary-add-contact">e_book_backend_summary_add_contact</a>  (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
51
gboolean            <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-load">e_book_backend_summary_load</a>         (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
 
52
gboolean            <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-save">e_book_backend_summary_save</a>         (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
 
53
void                <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-add-contact">e_book_backend_summary_add_contact</a>  (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
58
54
                                                         EContact *contact);
59
 
void                <a href="EBookBackendSummary.html#e-book-backend-summary-remove-contact">e_book_backend_summary_remove_contact</a>
60
 
                                                        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
61
 
                                                         const char *id);
62
 
<a
63
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
64
 
>gboolean</a>            <a href="EBookBackendSummary.html#e-book-backend-summary-check-contact">e_book_backend_summary_check_contact</a>
65
 
                                                        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
66
 
                                                         const char *id);
67
 
void                <a href="EBookBackendSummary.html#e-book-backend-summary-touch">e_book_backend_summary_touch</a>        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
68
 
<a
69
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
70
 
>gboolean</a>            <a href="EBookBackendSummary.html#e-book-backend-summary-is-up-to-date">e_book_backend_summary_is_up_to_date</a>
71
 
                                                        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
55
void                <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-remove-contact">e_book_backend_summary_remove_contact</a>
 
56
                                                        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
57
                                                         const char *id);
 
58
gboolean            <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-check-contact">e_book_backend_summary_check_contact</a>
 
59
                                                        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
60
                                                         const char *id);
 
61
void                <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-touch">e_book_backend_summary_touch</a>        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);
 
62
gboolean            <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-is-up-to-date">e_book_backend_summary_is_up_to_date</a>
 
63
                                                        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
72
64
                                                         time_t t);
73
 
<a
74
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
75
 
>gboolean</a>            <a href="EBookBackendSummary.html#e-book-backend-summary-is-summary-query">e_book_backend_summary_is_summary_query</a>
76
 
                                                        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
77
 
                                                         const char *query);
78
 
<a
79
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
80
 
>GPtrArray</a>*          <a href="EBookBackendSummary.html#e-book-backend-summary-search">e_book_backend_summary_search</a>       (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
81
 
                                                         const char *query);
82
 
char*               <a href="EBookBackendSummary.html#e-book-backend-summary-get-summary-vcard">e_book_backend_summary_get_summary_vcard</a>
83
 
                                                        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
65
gboolean            <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-is-summary-query">e_book_backend_summary_is_summary_query</a>
 
66
                                                        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
67
                                                         const char *query);
 
68
GPtrArray*          <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-search">e_book_backend_summary_search</a>       (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
69
                                                         const char *query);
 
70
char*               <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-get-summary-vcard">e_book_backend_summary_get_summary_vcard</a>
 
71
                                                        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
84
72
                                                         const char *id);
85
73
 
86
74
 
87
75
</pre>
88
76
</div>
89
77
<div class="refsect1" lang="en">
90
 
<a name="id2564710"></a><h2>Object Hierarchy</h2>
 
78
<a name="id2620533"></a><h2>Object Hierarchy</h2>
91
79
<pre class="synopsis">
92
80
 
93
 
  <a
94
 
href="/opt/gnome/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
95
 
>GObject</a>
 
81
  GObject
96
82
   +----EBookBackendSummary
97
83
</pre>
98
84
</div>
99
85
<div class="refsect1" lang="en">
100
 
<a name="id2564734"></a><h2>Description</h2>
 
86
<a name="id2620557"></a><h2>Description</h2>
101
87
<p>
102
88
 
103
89
</p>
104
90
</div>
105
91
<div class="refsect1" lang="en">
106
 
<a name="id2564749"></a><h2>Details</h2>
 
92
<a name="id2620573"></a><h2>Details</h2>
107
93
<div class="refsect2" lang="en">
108
 
<a name="id2564760"></a><h3>
 
94
<a name="id2620584"></a><h3>
109
95
<a name="EBookBackendSummary-struct"></a>struct EBookBackendSummary</h3>
110
 
<a class="indexterm" name="id2554098"></a><pre class="programlisting">struct EBookBackendSummary;</pre>
 
96
<a class="indexterm" name="id2587520"></a><pre class="programlisting">struct EBookBackendSummary;</pre>
111
97
<p>
112
98
 
113
99
</p>
114
100
</div>
115
101
<hr>
116
102
<div class="refsect2" lang="en">
117
 
<a name="id2554114"></a><h3>
 
103
<a name="id2587536"></a><h3>
118
104
<a name="e-book-backend-summary-new"></a>e_book_backend_summary_new ()</h3>
119
 
<a class="indexterm" name="id2554125"></a><pre class="programlisting"><a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a>* e_book_backend_summary_new         (const char *summary_path,
 
105
<a class="indexterm" name="id2587547"></a><pre class="programlisting"><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a>* e_book_backend_summary_new         (const char *summary_path,
120
106
                                                         int flush_timeout_millis);</pre>
121
107
<p>
122
 
Creates an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> object without loading it
 
108
Creates an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> object without loading it
123
109
or otherwise affecting the file. <em class="parameter"><code>flush_timeout_millis</code></em>
124
110
specifies how much time should elapse, at a minimum, from
125
111
the summary is changed until it is flushed to disk.</p>
130
116
<col align="left" valign="top">
131
117
<tbody>
132
118
<tr>
133
 
<td><span class="term"><em class="parameter"><code>summary_path</code></em>&#160;:</span></td>
 
119
<td><p><span class="term"><em class="parameter"><code>summary_path</code></em>&#160;:</span></p></td>
134
120
<td> a local file system path
135
121
</td>
136
122
</tr>
137
123
<tr>
138
 
<td><span class="term"><em class="parameter"><code>flush_timeout_millis</code></em>&#160;:</span></td>
 
124
<td><p><span class="term"><em class="parameter"><code>flush_timeout_millis</code></em>&#160;:</span></p></td>
139
125
<td> a flush interval, in milliseconds
140
126
</td>
141
127
</tr>
142
128
<tr>
143
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
144
 
<td> A new <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>.
 
129
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
130
<td> A new <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>.
145
131
</td>
146
132
</tr>
147
133
</tbody>
149
135
</div>
150
136
<hr>
151
137
<div class="refsect2" lang="en">
152
 
<a name="id2554228"></a><h3>
 
138
<a name="id2587650"></a><h3>
153
139
<a name="e-book-backend-summary-load"></a>e_book_backend_summary_load ()</h3>
154
 
<a class="indexterm" name="id2554239"></a><pre class="programlisting"><a
155
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
156
 
>gboolean</a>            e_book_backend_summary_load         (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);</pre>
 
140
<a class="indexterm" name="id2587661"></a><pre class="programlisting">gboolean            e_book_backend_summary_load         (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);</pre>
157
141
<p>
158
142
Attempts to load <em class="parameter"><code>summary</code></em> from disk. The load is successful if
159
143
the file was located, it was in the correct format, and it was
165
149
<col align="left" valign="top">
166
150
<tbody>
167
151
<tr>
168
 
<td><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></td>
169
 
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
152
<td><p><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></p></td>
 
153
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
170
154
</td>
171
155
</tr>
172
156
<tr>
173
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
174
 
<td> <a
175
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
176
 
><code class="literal">TRUE</code></a> if the load succeeded, <a
177
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
178
 
><code class="literal">FALSE</code></a> if it failed.
 
157
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
158
<td> <code class="literal">TRUE</code> if the load succeeded, <code class="literal">FALSE</code> if it failed.
179
159
</td>
180
160
</tr>
181
161
</tbody>
183
163
</div>
184
164
<hr>
185
165
<div class="refsect2" lang="en">
186
 
<a name="id2554333"></a><h3>
 
166
<a name="id2587755"></a><h3>
187
167
<a name="e-book-backend-summary-save"></a>e_book_backend_summary_save ()</h3>
188
 
<a class="indexterm" name="id2554344"></a><pre class="programlisting"><a
189
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
190
 
>gboolean</a>            e_book_backend_summary_save         (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);</pre>
 
168
<a class="indexterm" name="id2587766"></a><pre class="programlisting">gboolean            e_book_backend_summary_save         (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);</pre>
191
169
<p>
192
170
Attempts to save <em class="parameter"><code>summary</code></em> to disk.</p>
193
171
<p>
197
175
<col align="left" valign="top">
198
176
<tbody>
199
177
<tr>
200
 
<td><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></td>
201
 
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
178
<td><p><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></p></td>
 
179
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
202
180
</td>
203
181
</tr>
204
182
<tr>
205
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
206
 
<td> <a
207
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
208
 
><code class="literal">TRUE</code></a> if the save succeeded, <a
209
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
210
 
><code class="literal">FALSE</code></a> otherwise.
 
183
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
184
<td> <code class="literal">TRUE</code> if the save succeeded, <code class="literal">FALSE</code> otherwise.
211
185
</td>
212
186
</tr>
213
187
</tbody>
215
189
</div>
216
190
<hr>
217
191
<div class="refsect2" lang="en">
218
 
<a name="id2590389"></a><h3>
 
192
<a name="id2581146"></a><h3>
219
193
<a name="e-book-backend-summary-add-contact"></a>e_book_backend_summary_add_contact ()</h3>
220
 
<a class="indexterm" name="id2590401"></a><pre class="programlisting">void                e_book_backend_summary_add_contact  (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
194
<a class="indexterm" name="id2581158"></a><pre class="programlisting">void                e_book_backend_summary_add_contact  (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
221
195
                                                         EContact *contact);</pre>
222
196
<p>
223
197
Adds a summary of <em class="parameter"><code>contact</code></em> to <em class="parameter"><code>summary</code></em>. Does not check if
229
203
<col align="left" valign="top">
230
204
<tbody>
231
205
<tr>
232
 
<td><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></td>
233
 
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
206
<td><p><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></p></td>
 
207
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
234
208
</td>
235
209
</tr>
236
210
<tr>
237
 
<td><span class="term"><em class="parameter"><code>contact</code></em>&#160;:</span></td>
 
211
<td><p><span class="term"><em class="parameter"><code>contact</code></em>&#160;:</span></p></td>
238
212
<td> an <span class="type">EContact</span> to add
239
213
</td>
240
214
</tr>
243
217
</div>
244
218
<hr>
245
219
<div class="refsect2" lang="en">
246
 
<a name="id2590500"></a><h3>
 
220
<a name="id2581256"></a><h3>
247
221
<a name="e-book-backend-summary-remove-contact"></a>e_book_backend_summary_remove_contact ()</h3>
248
 
<a class="indexterm" name="id2590513"></a><pre class="programlisting">void                e_book_backend_summary_remove_contact
249
 
                                                        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
222
<a class="indexterm" name="id2581270"></a><pre class="programlisting">void                e_book_backend_summary_remove_contact
 
223
                                                        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
250
224
                                                         const char *id);</pre>
251
225
<p>
252
226
Removes the summary of the contact identified by <em class="parameter"><code>id</code></em> from <em class="parameter"><code>summary</code></em>.</p>
257
231
<col align="left" valign="top">
258
232
<tbody>
259
233
<tr>
260
 
<td><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></td>
261
 
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
234
<td><p><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></p></td>
 
235
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
262
236
</td>
263
237
</tr>
264
238
<tr>
265
 
<td><span class="term"><em class="parameter"><code>id</code></em>&#160;:</span></td>
 
239
<td><p><span class="term"><em class="parameter"><code>id</code></em>&#160;:</span></p></td>
266
240
<td> a unique contact ID string
267
241
</td>
268
242
</tr>
271
245
</div>
272
246
<hr>
273
247
<div class="refsect2" lang="en">
274
 
<a name="id2600549"></a><h3>
 
248
<a name="id2626873"></a><h3>
275
249
<a name="e-book-backend-summary-check-contact"></a>e_book_backend_summary_check_contact ()</h3>
276
 
<a class="indexterm" name="id2600561"></a><pre class="programlisting"><a
277
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
278
 
>gboolean</a>            e_book_backend_summary_check_contact
279
 
                                                        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
250
<a class="indexterm" name="id2626886"></a><pre class="programlisting">gboolean            e_book_backend_summary_check_contact
 
251
                                                        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
280
252
                                                         const char *id);</pre>
281
253
<p>
282
254
Checks if a summary of the contact identified by <em class="parameter"><code>id</code></em>
288
260
<col align="left" valign="top">
289
261
<tbody>
290
262
<tr>
291
 
<td><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></td>
292
 
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
263
<td><p><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></p></td>
 
264
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
293
265
</td>
294
266
</tr>
295
267
<tr>
296
 
<td><span class="term"><em class="parameter"><code>id</code></em>&#160;:</span></td>
 
268
<td><p><span class="term"><em class="parameter"><code>id</code></em>&#160;:</span></p></td>
297
269
<td> a unique contact ID string
298
270
</td>
299
271
</tr>
300
272
<tr>
301
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
302
 
<td> <a
303
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
304
 
><code class="literal">TRUE</code></a> if the summary exists, <a
305
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
306
 
><code class="literal">FALSE</code></a> otherwise.
 
273
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
274
<td> <code class="literal">TRUE</code> if the summary exists, <code class="literal">FALSE</code> otherwise.
307
275
</td>
308
276
</tr>
309
277
</tbody>
311
279
</div>
312
280
<hr>
313
281
<div class="refsect2" lang="en">
314
 
<a name="id2600672"></a><h3>
 
282
<a name="id2626998"></a><h3>
315
283
<a name="e-book-backend-summary-touch"></a>e_book_backend_summary_touch ()</h3>
316
 
<a class="indexterm" name="id2600685"></a><pre class="programlisting">void                e_book_backend_summary_touch        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);</pre>
 
284
<a class="indexterm" name="id2627011"></a><pre class="programlisting">void                e_book_backend_summary_touch        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary);</pre>
317
285
<p>
318
286
Indicates that <em class="parameter"><code>summary</code></em> has changed and should be flushed to disk.</p>
319
287
<p>
322
290
<div class="variablelist"><table border="0">
323
291
<col align="left" valign="top">
324
292
<tbody><tr>
325
 
<td><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></td>
326
 
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
293
<td><p><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></p></td>
 
294
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
327
295
</td>
328
296
</tr></tbody>
329
297
</table></div>
330
298
</div>
331
299
<hr>
332
300
<div class="refsect2" lang="en">
333
 
<a name="id2600750"></a><h3>
 
301
<a name="id2627075"></a><h3>
334
302
<a name="e-book-backend-summary-is-up-to-date"></a>e_book_backend_summary_is_up_to_date ()</h3>
335
 
<a class="indexterm" name="id2600763"></a><pre class="programlisting"><a
336
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
337
 
>gboolean</a>            e_book_backend_summary_is_up_to_date
338
 
                                                        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
303
<a class="indexterm" name="id2627089"></a><pre class="programlisting">gboolean            e_book_backend_summary_is_up_to_date
 
304
                                                        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
339
305
                                                         time_t t);</pre>
340
306
<p>
341
307
Checks if <em class="parameter"><code>summary</code></em> is more recent than <em class="parameter"><code>t</code></em>.</p>
346
312
<col align="left" valign="top">
347
313
<tbody>
348
314
<tr>
349
 
<td><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></td>
350
 
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
315
<td><p><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></p></td>
 
316
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
351
317
</td>
352
318
</tr>
353
319
<tr>
354
 
<td><span class="term"><em class="parameter"><code>t</code></em>&#160;:</span></td>
 
320
<td><p><span class="term"><em class="parameter"><code>t</code></em>&#160;:</span></p></td>
355
321
<td> the time to compare with
356
322
</td>
357
323
</tr>
358
324
<tr>
359
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
360
 
<td> <a
361
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
362
 
><code class="literal">TRUE</code></a> if the summary is up to date, <a
363
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
364
 
><code class="literal">FALSE</code></a> otherwise.
 
325
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
326
<td> <code class="literal">TRUE</code> if the summary is up to date, <code class="literal">FALSE</code> otherwise.
365
327
</td>
366
328
</tr>
367
329
</tbody>
369
331
</div>
370
332
<hr>
371
333
<div class="refsect2" lang="en">
372
 
<a name="id2600884"></a><h3>
 
334
<a name="id2627210"></a><h3>
373
335
<a name="e-book-backend-summary-is-summary-query"></a>e_book_backend_summary_is_summary_query ()</h3>
374
 
<a class="indexterm" name="id2600898"></a><pre class="programlisting"><a
375
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
376
 
>gboolean</a>            e_book_backend_summary_is_summary_query
377
 
                                                        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
336
<a class="indexterm" name="id2627224"></a><pre class="programlisting">gboolean            e_book_backend_summary_is_summary_query
 
337
                                                        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
378
338
                                                         const char *query);</pre>
379
339
<p>
380
340
Checks if <em class="parameter"><code>query</code></em> can be satisfied by searching only the fields
386
346
<col align="left" valign="top">
387
347
<tbody>
388
348
<tr>
389
 
<td><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></td>
390
 
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
349
<td><p><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></p></td>
 
350
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
391
351
</td>
392
352
</tr>
393
353
<tr>
394
 
<td><span class="term"><em class="parameter"><code>query</code></em>&#160;:</span></td>
 
354
<td><p><span class="term"><em class="parameter"><code>query</code></em>&#160;:</span></p></td>
395
355
<td> an s-expression to check
396
356
</td>
397
357
</tr>
398
358
<tr>
399
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
400
 
<td> <a
401
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
402
 
><code class="literal">TRUE</code></a> if the query can be satisfied, <a
403
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
404
 
><code class="literal">FALSE</code></a> otherwise.
 
359
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
360
<td> <code class="literal">TRUE</code> if the query can be satisfied, <code class="literal">FALSE</code> otherwise.
405
361
</td>
406
362
</tr>
407
363
</tbody>
409
365
</div>
410
366
<hr>
411
367
<div class="refsect2" lang="en">
412
 
<a name="id2601021"></a><h3>
 
368
<a name="id2627346"></a><h3>
413
369
<a name="e-book-backend-summary-search"></a>e_book_backend_summary_search ()</h3>
414
 
<a class="indexterm" name="id2601034"></a><pre class="programlisting"><a
415
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
416
 
>GPtrArray</a>*          e_book_backend_summary_search       (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
370
<a class="indexterm" name="id2627360"></a><pre class="programlisting">GPtrArray*          e_book_backend_summary_search       (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
417
371
                                                         const char *query);</pre>
418
372
<p>
419
373
Searches <em class="parameter"><code>summary</code></em> for contacts matching <em class="parameter"><code>query</code></em>.</p>
424
378
<col align="left" valign="top">
425
379
<tbody>
426
380
<tr>
427
 
<td><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></td>
428
 
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
381
<td><p><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></p></td>
 
382
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
429
383
</td>
430
384
</tr>
431
385
<tr>
432
 
<td><span class="term"><em class="parameter"><code>query</code></em>&#160;:</span></td>
 
386
<td><p><span class="term"><em class="parameter"><code>query</code></em>&#160;:</span></p></td>
433
387
<td> an s-expression
434
388
</td>
435
389
</tr>
436
390
<tr>
437
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
438
 
<td> A <a
439
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"
440
 
><span class="type">GPtrArray</span></a> of pointers to contact ID strings.
 
391
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
392
<td> A <span class="type">GPtrArray</span> of pointers to contact ID strings.
441
393
</td>
442
394
</tr>
443
395
</tbody>
445
397
</div>
446
398
<hr>
447
399
<div class="refsect2" lang="en">
448
 
<a name="id2601143"></a><h3>
 
400
<a name="id2627469"></a><h3>
449
401
<a name="e-book-backend-summary-get-summary-vcard"></a>e_book_backend_summary_get_summary_vcard ()</h3>
450
 
<a class="indexterm" name="id2601156"></a><pre class="programlisting">char*               e_book_backend_summary_get_summary_vcard
451
 
                                                        (<a href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
 
402
<a class="indexterm" name="id2627482"></a><pre class="programlisting">char*               e_book_backend_summary_get_summary_vcard
 
403
                                                        (<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary">EBookBackendSummary</a> *summary,
452
404
                                                         const char *id);</pre>
453
405
<p>
454
406
Constructs and returns a VCard from the contact summary specified
460
412
<col align="left" valign="top">
461
413
<tbody>
462
414
<tr>
463
 
<td><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></td>
464
 
<td> an <a href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
415
<td><p><span class="term"><em class="parameter"><code>summary</code></em>&#160;:</span></p></td>
 
416
<td> an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
465
417
</td>
466
418
</tr>
467
419
<tr>
468
 
<td><span class="term"><em class="parameter"><code>id</code></em>&#160;:</span></td>
 
420
<td><p><span class="term"><em class="parameter"><code>id</code></em>&#160;:</span></p></td>
469
421
<td> a unique contact ID
470
422
</td>
471
423
</tr>
472
424
<tr>
473
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
474
 
<td> A new VCard, or <a
475
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
476
 
><code class="literal">NULL</code></a> if the contact summary didn't exist.
 
425
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
426
<td> A new VCard, or <code class="literal">NULL</code> if the contact summary didn't exist.
477
427
</td>
478
428
</tr>
479
429
</tbody>
481
431
</div>
482
432
</div>
483
433
<div class="refsect1" lang="en">
484
 
<a name="id2601265"></a><div class="refsect2" lang="en"><a name="id2601266"></a></div>
 
434
<a name="id2627591"></a><div class="refsect2" lang="en"><a name="id2627592"></a></div>
485
435
<hr>
486
 
<div class="refsect2" lang="en"><a name="id2601268"></a></div>
 
436
<div class="refsect2" lang="en"><a name="id2627593"></a></div>
487
437
</div>
488
438
</div>
489
439
</body>