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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EBookView</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Address Book Client (libebook)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Address Book Client (libebook)">
<link rel="prev" href="libebook-e-book-types.html" title="e-book-types">
<link rel="next" href="EVCard.html" title="EVCard">
<meta name="generator" content="GTK-Doc V1.14 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libebook-e-book-types.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution-Data-Server Manual: Address Book Client (libebook)</th>
<td><a accesskey="n" href="EVCard.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EBookView.synopsis" class="shortcut">Top</a>
|
<a href="#EBookView.description" class="shortcut">Description</a>
|
<a href="#EBookView.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EBookView.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="EBookView">
<a name="EBookView"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EBookView.top_of_page"></a>EBookView</span></h2>
<p>EBookView — Represents a search against an <a class="link" href="EBook.html" title="EBook"><span class="type">EBook</span></a>.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="EBookView.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="EBookView.html#EBookView-struct" title="EBookView">EBookView</a>;
<span class="returnvalue">void</span> <a class="link" href="EBookView.html#e-book-view-start" title="e_book_view_start ()">e_book_view_start</a> (<em class="parameter"><code><a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *book_view</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EBookView.html#e-book-view-stop" title="e_book_view_stop ()">e_book_view_stop</a> (<em class="parameter"><code><a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *book_view</code></em>);
struct <a class="link" href="EBook.html" title="EBook"><span class="returnvalue">_EBook</span></a> * <a class="link" href="EBookView.html#e-book-view-get-book" title="e_book_view_get_book ()">e_book_view_get_book</a> (<em class="parameter"><code><a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *book_view</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="EBookView.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----EBookView
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="EBookView.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="EBookView.html#EBookView-contacts-added" title='The "contacts-added" signal'>contacts-added</a>" : Run Last
"<a class="link" href="EBookView.html#EBookView-contacts-changed" title='The "contacts-changed" signal'>contacts-changed</a>" : Run Last
"<a class="link" href="EBookView.html#EBookView-contacts-removed" title='The "contacts-removed" signal'>contacts-removed</a>" : Run Last
"<a class="link" href="EBookView.html#EBookView-sequence-complete" title='The "sequence-complete" signal'>sequence-complete</a>" : Run Last
"<a class="link" href="EBookView.html#EBookView-status-message" title='The "status-message" signal'>status-message</a>" : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="EBookView.description"></a><h2>Description</h2>
<p>
Event notifications and callbacks from <a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> go to the
<span class="type">EBookViewListener</span>. Contrast <a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> with <a class="link" href="EBook.html" title="EBook"><span class="type">EBook</span></a>, which represents the
addressbook itself.
</p>
</div>
<div class="refsect1" title="Details">
<a name="EBookView.details"></a><h2>Details</h2>
<div class="refsect2" title="EBookView">
<a name="EBookView-struct"></a><h3>EBookView</h3>
<pre class="programlisting">typedef struct _EBookView EBookView;</pre>
<p>
<a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> has no publicly available members.
</p>
</div>
<hr>
<div class="refsect2" title="e_book_view_start ()">
<a name="e-book-view-start"></a><h3>e_book_view_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_book_view_start (<em class="parameter"><code><a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *book_view</code></em>);</pre>
<p>
Tells <em class="parameter"><code>book_view</code></em> to start processing events.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>book_view</code></em> :</span></p></td>
<td>an <a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_view_stop ()">
<a name="e-book-view-stop"></a><h3>e_book_view_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_book_view_stop (<em class="parameter"><code><a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *book_view</code></em>);</pre>
<p>
Tells <em class="parameter"><code>book_view</code></em> to stop processing events.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>book_view</code></em> :</span></p></td>
<td>an <a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_view_get_book ()">
<a name="e-book-view-get-book"></a><h3>e_book_view_get_book ()</h3>
<pre class="programlisting">struct <a class="link" href="EBook.html" title="EBook"><span class="returnvalue">_EBook</span></a> * e_book_view_get_book (<em class="parameter"><code><a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *book_view</code></em>);</pre>
<p>
Returns the <a class="link" href="EBook.html" title="EBook"><span class="type">EBook</span></a> that this book view is monitoring.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>book_view</code></em> :</span></p></td>
<td>an <a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an <a class="link" href="EBook.html" title="EBook"><span class="type">EBook</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="EBookView.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "contacts-added" signal'>
<a name="EBookView-contacts-added"></a><h3>The <code class="literal">"contacts-added"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *ebookview,
<span class="type">gpointer</span> arg1,
<span class="type">gpointer</span> user_data) : Run Last</pre>
<p>
Fired when more contacts are found. Each contact in the list will be unref'd
when done, and the list freed, so simply reference any contacts you want to
keep.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ebookview</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>a <span class="type">GList</span> of <a class="link" href="EContact.html" title="EContact"><span class="type">EContact</span></a> objects that were added to the view
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title='The "contacts-changed" signal'>
<a name="EBookView-contacts-changed"></a><h3>The <code class="literal">"contacts-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *ebookview,
<span class="type">gpointer</span> arg1,
<span class="type">gpointer</span> user_data) : Run Last</pre>
<p>
Fired when contacts are changed. Each contact in the list will be unref'd
when done, and the list freed, so simply reference any contacts you want to
keep.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ebookview</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>a <span class="type">GList</span> of <a class="link" href="EContact.html" title="EContact"><span class="type">EContact</span></a> objects that were modified
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title='The "contacts-removed" signal'>
<a name="EBookView-contacts-removed"></a><h3>The <code class="literal">"contacts-removed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *ebookview,
<span class="type">gpointer</span> arg1,
<span class="type">gpointer</span> user_data) : Run Last</pre>
<p>
Fired when contacts are removed from the view. The IDs and the list will be
freed, so copy any IDs you want to keep.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ebookview</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>a <span class="type">GList</span> of contact IDs (char*) that were removed from the view
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title='The "sequence-complete" signal'>
<a name="EBookView-sequence-complete"></a><h3>The <code class="literal">"sequence-complete"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *ebookview,
<span class="type">gint</span> arg1,
<span class="type">gpointer</span> user_data) : Run Last</pre>
<p>
Fired when there are currently no more contacts to send. This is fired once
after the initial set of <span class="type">contacts-added</span> signals, and after every future change.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ebookview</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>an <a class="link" href="libebook-e-book-types.html#EBookViewStatus" title="enum EBookViewStatus"><span class="type">EBookViewStatus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title='The "status-message" signal'>
<a name="EBookView-status-message"></a><h3>The <code class="literal">"status-message"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *ebookview,
<span class="type">gchar</span> *arg1,
<span class="type">gpointer</span> user_data) : Run Last</pre>
<p>
Fired with a status message reporting the progress of the view.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ebookview</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>a const char* message
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="EBookView.see-also"></a><h2>See Also</h2>
<p>
<span class="type">EBookViewListener</span>, <a class="link" href="EBook.html" title="EBook"><span class="type">EBook</span></a>.
</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
