This file is indexed.

/usr/share/gtk-doc/html/eds/eds-EBookClientView.html is in evolution-data-server-doc 3.18.5-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EBookClientView: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch04.html" title="Addressbook">
<link rel="prev" href="eds-EBookClient.html" title="EBookClient">
<link rel="next" href="eds-EBookClientCursor.html" title="EBookClientCursor">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#eds-EBookClientView.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="eds-EBookClient.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="eds-EBookClientCursor.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-EBookClientView"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-EBookClientView.top_of_page"></a>EBookClientView</span></h2>
<p>EBookClientView — Recieving change notifications on addressbooks</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-EBookClientView.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">struct <a class="link" href="eds-EBookClient.html#EBookClient" title="struct EBookClient"><span class="returnvalue">_EBookClient</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EBookClientView.html#e-book-client-view-ref-client" title="e_book_client_view_ref_client ()">e_book_client_view_ref_client</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gio/GDBusConnection.html"><span class="returnvalue">GDBusConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EBookClientView.html#e-book-client-view-get-connection" title="e_book_client_view_get_connection ()">e_book_client_view_get_connection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EBookClientView.html#e-book-client-view-get-object-path" title="e_book_client_view_get_object_path ()">e_book_client_view_get_object_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookClientView.html#e-book-client-view-is-running" title="e_book_client_view_is_running ()">e_book_client_view_is_running</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-EBookClientView.html#e-book-client-view-set-fields-of-interest" title="e_book_client_view_set_fields_of_interest ()">e_book_client_view_set_fields_of_interest</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-EBookClientView.html#e-book-client-view-start" title="e_book_client_view_start ()">e_book_client_view_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-EBookClientView.html#e-book-client-view-stop" title="e_book_client_view_stop ()">e_book_client_view_stop</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-EBookClientView.html#e-book-client-view-set-flags" title="e_book_client_view_set_flags ()">e_book_client_view_set_flags</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <a class="link" href="eds-EBookClient.html#EBookClient" title="struct EBookClient"><span class="returnvalue">_EBookClient</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EBookClientView.html#e-book-client-view-get-client" title="e_book_client_view_get_client ()">e_book_client_view_get_client</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EBookClientView.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView">EBookClientView</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-EBookClientView.html#EBookClientViewClass" title="struct EBookClientViewClass">EBookClientViewClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EBookClientView.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libebook/libebook.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="eds-EBookClientView.description"></a><h2>Description</h2>
<p>This class provides functionality for watching for changes on a
given addressbook opened with an <a class="link" href="eds-EBookClient.html#EBookClient" title="struct EBookClient"><span class="type">EBookClient</span></a>. Use <a class="link" href="eds-EBookClient.html#e-book-client-get-view" title="e_book_client_get_view ()"><code class="function">e_book_client_get_view()</code></a>
to create an <a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a>.</p>
</div>
<div class="refsect1">
<a name="eds-EBookClientView.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-book-client-view-ref-client"></a><h3>e_book_client_view_ref_client ()</h3>
<pre class="programlisting">struct <a class="link" href="eds-EBookClient.html#EBookClient" title="struct EBookClient"><span class="returnvalue">_EBookClient</span></a> *
e_book_client_view_ref_client (<em class="parameter"><code><a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *client_view</code></em>);</pre>
<p>Returns the <span class="type">“client”</span> associated with <em class="parameter"><code>client_view</code></em>
.</p>
<p>The returned <a class="link" href="eds-EBookClient.html#EBookClient" title="struct EBookClient"><span class="type">EBookClient</span></a> is referenced for thread-safety.  Unreference
the <a class="link" href="eds-EBookClient.html#EBookClient" title="struct EBookClient"><span class="type">EBookClient</span></a> with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="id-1.3.3.3.7.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>client_view</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.3.7.2.7"></a><h4>Returns</h4>
<p> an <a class="link" href="eds-EBookClient.html#EBookClient" title="struct EBookClient"><span class="type">EBookClient</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.10.html" title="Index of new symbols in 3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-get-connection"></a><h3>e_book_client_view_get_connection ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GDBusConnection.html"><span class="returnvalue">GDBusConnection</span></a> *
e_book_client_view_get_connection (<em class="parameter"><code><a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *client_view</code></em>);</pre>
<p>Returns the <a href="/usr/share/gtk-doc/html/gio/GDBusConnection.html"><span class="type">GDBusConnection</span></a> used to create the D-Bus proxy.</p>
<div class="refsect3">
<a name="id-1.3.3.3.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>client_view</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.3.7.3.6"></a><h4>Returns</h4>
<p> the <a href="/usr/share/gtk-doc/html/gio/GDBusConnection.html"><span class="type">GDBusConnection</span></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-get-object-path"></a><h3>e_book_client_view_get_object_path ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_book_client_view_get_object_path (<em class="parameter"><code><a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *client_view</code></em>);</pre>
<p>Returns the object path used to create the D-Bus proxy.</p>
<div class="refsect3">
<a name="id-1.3.3.3.7.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>client_view</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.3.7.4.6"></a><h4>Returns</h4>
<p> the object path</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-is-running"></a><h3>e_book_client_view_is_running ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_client_view_is_running (<em class="parameter"><code><a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *client_view</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-set-fields-of-interest"></a><h3>e_book_client_view_set_fields_of_interest ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_book_client_view_set_fields_of_interest
                               (<em class="parameter"><code><a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *client_view</code></em>,
                                <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *fields_of_interest</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Client can instruct server to which fields it is interested in only, thus
the server can return less data over the wire. The server can still return
complete objects, this is just a hint to it that the listed fields will
be used only. The UID field is returned always. Initial views has no fields
of interest and using <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>fields_of_interest</code></em>
 will unset any previous
changes.</p>
<p>Some backends can use summary information of its cache to create artifical
objects, which will omit stored object parsing. If this cannot be done then
it will simply return object as is stored in the cache.</p>
<div class="refsect3">
<a name="id-1.3.3.3.7.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>client_view</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fields_of_interest</p></td>
<td class="parameter_description"><p> List of field names in which
the client is interested. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-start"></a><h3>e_book_client_view_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_book_client_view_start (<em class="parameter"><code><a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *client_view</code></em>,
                          <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Tells <em class="parameter"><code>client_view</code></em>
 to start processing events.</p>
<div class="refsect3">
<a name="id-1.3.3.3.7.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>client_view</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-stop"></a><h3>e_book_client_view_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_book_client_view_stop (<em class="parameter"><code><a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *client_view</code></em>,
                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Tells <em class="parameter"><code>client_view</code></em>
 to stop processing events.</p>
<div class="refsect3">
<a name="id-1.3.3.3.7.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>client_view</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-set-flags"></a><h3>e_book_client_view_set_flags ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_book_client_view_set_flags (<em class="parameter"><code><a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *client_view</code></em>,
                              <em class="parameter"><code><a class="link" href="eds-Addressbook-related-types.html#EBookClientViewFlags" title="enum EBookClientViewFlags"><span class="type">EBookClientViewFlags</span></a> flags</code></em>,
                              <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Sets the <em class="parameter"><code>flags</code></em>
 which control the behaviour of <em class="parameter"><code>client_view</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.3.3.7.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>client_view</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>the <a class="link" href="eds-Addressbook-related-types.html#EBookClientViewFlags" title="enum EBookClientViewFlags"><span class="type">EBookClientViewFlags</span></a> for <em class="parameter"><code>client_view</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-get-client"></a><h3>e_book_client_view_get_client ()</h3>
<pre class="programlisting">struct <a class="link" href="eds-EBookClient.html#EBookClient" title="struct EBookClient"><span class="returnvalue">_EBookClient</span></a> *
e_book_client_view_get_client (<em class="parameter"><code><a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *client_view</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_book_client_view_get_client</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="eds-EBookClientView.html#e-book-client-view-ref-client" title="e_book_client_view_ref_client ()"><code class="function">e_book_client_view_ref_client()</code></a> instead.</p>
</div>
<p>Returns the <span class="type">“client”</span> associated with <em class="parameter"><code>client_view</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.3.3.7.10.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>client_view</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.3.7.10.7"></a><h4>Returns</h4>
<p> an <a class="link" href="eds-EBookClient.html#EBookClient" title="struct EBookClient"><span class="type">EBookClient</span></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="eds-EBookClientView.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EBookClientView"></a><h3>struct EBookClientView</h3>
<pre class="programlisting">struct EBookClientView {
};
</pre>
<p>Contains only private data the should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3.2.html" title="Index of new symbols in 3.2">3.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="EBookClientViewClass"></a><h3>struct EBookClientViewClass</h3>
<pre class="programlisting">struct EBookClientViewClass {
	/* Signals */
	void		(*objects_added) (EBookClientView *client_view,
						 const GSList *objects);
	void		(*objects_modified) (EBookClientView *client_view,
						 const GSList *objects);
	void		(*objects_removed) (EBookClientView *client_view,
						 const GSList *uids);
	void		(*progress)		(EBookClientView *client_view,
						 guint percent,
						 const gchar *message);
	void		(*complete)		(EBookClientView *client_view,
						 const GError *error);
};
</pre>
<p>Class structure for the <a class="link" href="eds-EBookClient.html#EBookClient" title="struct EBookClient"><span class="type">EBookClient</span></a> class.</p>
<div class="refsect3">
<a name="id-1.3.3.3.8.3.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="EBookClientViewClass.objects-added"></a>objects_added</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal emitted when contacts are added in the view</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="EBookClientViewClass.objects-modified"></a>objects_modified</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal emitted when contacts in the view are modified</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="EBookClientViewClass.objects-removed"></a>objects_removed</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal emitted when contacts are removed from the view</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="EBookClientViewClass.progress"></a>progress</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal emitted intermittently while loading a view after calling <a class="link" href="eds-EBookClientView.html#e-book-client-view-start" title="e_book_client_view_start ()"><code class="function">e_book_client_view_start()</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="EBookClientViewClass.complete"></a>complete</code></em> ()</p></td>
<td class="struct_member_description"><p>Notification that loading a view has completed, after calling <a class="link" href="eds-EBookClientView.html#e-book-client-view-start" title="e_book_client_view_start ()"><code class="function">e_book_client_view_start()</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.2.html" title="Index of new symbols in 3.2">3.2</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>