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

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libebook/html/EBookView.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the 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=UTF-8">
5
5
<title>EBookView</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Address Book Client (libebook)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Address Book Client (libebook)">
9
9
<link rel="prev" href="libebook-e-book-types.html" title="e-book-types">
10
 
<link rel="next" href="EBookViewListener.html" title="EBookViewListener">
 
10
<link rel="next" href="EVCard.html" title="EVCard">
11
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
18
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
20
<th width="100%" align="center">Evolution-Data-Server Manual: Address Book Client (libebook)</th>
21
 
<td><a accesskey="n" href="EBookViewListener.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
21
<td><a accesskey="n" href="EVCard.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
22
</tr>
23
23
<tr><td colspan="5" class="shortcuts">
24
24
<a href="#EBookView.synopsis" class="shortcut">Top</a>
30
30
                  <a href="#EBookView.signals" class="shortcut">Signals</a>
31
31
</td></tr>
32
32
</table>
33
 
<div class="refentry" lang="en">
 
33
<div class="refentry" title="EBookView">
34
34
<a name="EBookView"></a><div class="titlepage"></div>
35
35
<div class="refnamediv"><table width="100%"><tr>
36
36
<td valign="top">
39
39
</td>
40
40
<td valign="top" align="right"></td>
41
41
</tr></table></div>
42
 
<div class="refsynopsisdiv">
 
42
<div class="refsynopsisdiv" title="Synopsis">
43
43
<a name="EBookView.synopsis"></a><h2>Synopsis</h2>
44
44
<pre class="synopsis">                    <a class="link" href="EBookView.html#EBookView-struct" title="EBookView">EBookView</a>;
45
 
<a class="link" href="EBookView.html" title="EBookView"><span class="returnvalue">EBookView</span></a> *         <a class="link" href="EBookView.html#e-book-view-new" title="e_book_view_new ()">e_book_view_new</a>                     (<em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_BookView</span> corba_book_view</code></em>,
46
 
                                                         <em class="parameter"><code><a class="link" href="EBookViewListener.html" title="EBookViewListener"><span class="type">EBookViewListener</span></a> *listener</code></em>);
47
45
<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>);
48
46
<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>);
49
 
<span class="returnvalue">void</span>                <a class="link" href="EBookView.html#e-book-view-set-book" title="e_book_view_set_book ()">e_book_view_set_book</a>                (<em class="parameter"><code><a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *book_view</code></em>,
50
 
                                                         <em class="parameter"><code><span class="type">struct _EBook</span> *book</code></em>);
51
47
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>);
52
48
</pre>
53
49
</div>
54
 
<div class="refsect1" lang="en">
 
50
<div class="refsect1" title="Object Hierarchy">
55
51
<a name="EBookView.object-hierarchy"></a><h2>Object Hierarchy</h2>
56
52
<pre class="synopsis">
57
53
  GObject
58
54
   +----EBookView
59
55
</pre>
60
56
</div>
61
 
<div class="refsect1" lang="en">
 
57
<div class="refsect1" title="Signals">
62
58
<a name="EBookView.signals"></a><h2>Signals</h2>
63
59
<pre class="synopsis">
64
60
  "<a class="link" href="EBookView.html#EBookView-contacts-added" title='The "contacts-added" signal'>contacts-added</a>"                                 : Run Last
68
64
  "<a class="link" href="EBookView.html#EBookView-status-message" title='The "status-message" signal'>status-message</a>"                                 : Run Last
69
65
</pre>
70
66
</div>
71
 
<div class="refsect1" lang="en">
 
67
<div class="refsect1" title="Description">
72
68
<a name="EBookView.description"></a><h2>Description</h2>
73
69
<p>
74
70
Event notifications and callbacks from <a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> go to the
75
 
<a class="link" href="EBookViewListener.html" title="EBookViewListener"><span class="type">EBookViewListener</span></a>. 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
 
71
<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
76
72
addressbook itself.
77
73
</p>
78
74
</div>
79
 
<div class="refsect1" lang="en">
 
75
<div class="refsect1" title="Details">
80
76
<a name="EBookView.details"></a><h2>Details</h2>
81
 
<div class="refsect2" lang="en">
 
77
<div class="refsect2" title="EBookView">
82
78
<a name="EBookView-struct"></a><h3>EBookView</h3>
83
79
<pre class="programlisting">typedef struct _EBookView EBookView;</pre>
84
80
<p>
86
82
</p>
87
83
</div>
88
84
<hr>
89
 
<div class="refsect2" lang="en">
90
 
<a name="e-book-view-new"></a><h3>e_book_view_new ()</h3>
91
 
<pre class="programlisting"><a class="link" href="EBookView.html" title="EBookView"><span class="returnvalue">EBookView</span></a> *         e_book_view_new                     (<em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_BookView</span> corba_book_view</code></em>,
92
 
                                                         <em class="parameter"><code><a class="link" href="EBookViewListener.html" title="EBookViewListener"><span class="type">EBookViewListener</span></a> *listener</code></em>);</pre>
93
 
<p>
94
 
Creates a new <a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> based on <em class="parameter"><code>corba_book_view</code></em> and listening to
95
 
<em class="parameter"><code>listener</code></em>.  This is a private function, applications should call
96
 
<a class="link" href="EBook.html#e-book-get-book-view" title="e_book_get_book_view ()"><span class="type">e_book_get_book_view</span></a> or <a class="link" href="EBook.html#e-book-async-get-book-view" title="e_book_async_get_book_view ()"><span class="type">e_book_async_get_book_view</span></a>.</p>
97
 
<div class="variablelist"><table border="0">
98
 
<col align="left" valign="top">
99
 
<tbody>
100
 
<tr>
101
 
<td><p><span class="term"><em class="parameter"><code>corba_book_view</code></em> :</span></p></td>
102
 
<td>a CORBA BookView object
103
 
</td>
104
 
</tr>
105
 
<tr>
106
 
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
107
 
<td>an <a class="link" href="EBookViewListener.html" title="EBookViewListener"><span class="type">EBookViewListener</span></a>
108
 
</td>
109
 
</tr>
110
 
<tr>
111
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
112
 
<td> A new <a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a>.
113
 
</td>
114
 
</tr>
115
 
</tbody>
116
 
</table></div>
117
 
</div>
118
 
<hr>
119
 
<div class="refsect2" lang="en">
 
85
<div class="refsect2" title="e_book_view_start ()">
120
86
<a name="e-book-view-start"></a><h3>e_book_view_start ()</h3>
121
87
<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>
122
88
<p>
123
 
Tells <em class="parameter"><code>book_view</code></em> to start processing events.</p>
 
89
Tells <em class="parameter"><code>book_view</code></em> to start processing events.
 
90
</p>
124
91
<div class="variablelist"><table border="0">
125
92
<col align="left" valign="top">
126
93
<tbody><tr>
131
98
</table></div>
132
99
</div>
133
100
<hr>
134
 
<div class="refsect2" lang="en">
 
101
<div class="refsect2" title="e_book_view_stop ()">
135
102
<a name="e-book-view-stop"></a><h3>e_book_view_stop ()</h3>
136
103
<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>
137
104
<p>
138
 
Tells <em class="parameter"><code>book_view</code></em> to stop processing events.</p>
 
105
Tells <em class="parameter"><code>book_view</code></em> to stop processing events.
 
106
</p>
139
107
<div class="variablelist"><table border="0">
140
108
<col align="left" valign="top">
141
109
<tbody><tr>
146
114
</table></div>
147
115
</div>
148
116
<hr>
149
 
<div class="refsect2" lang="en">
150
 
<a name="e-book-view-set-book"></a><h3>e_book_view_set_book ()</h3>
151
 
<pre class="programlisting"><span class="returnvalue">void</span>                e_book_view_set_book                (<em class="parameter"><code><a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a> *book_view</code></em>,
152
 
                                                         <em class="parameter"><code><span class="type">struct _EBook</span> *book</code></em>);</pre>
153
 
<p>
154
 
Makes <em class="parameter"><code>book_view</code></em> listen to changes in <em class="parameter"><code>book</code></em>. This function apparently
155
 
has no effect for the time being.</p>
156
 
<div class="variablelist"><table border="0">
157
 
<col align="left" valign="top">
158
 
<tbody>
159
 
<tr>
160
 
<td><p><span class="term"><em class="parameter"><code>book_view</code></em> :</span></p></td>
161
 
<td>an <a class="link" href="EBookView.html" title="EBookView"><span class="type">EBookView</span></a>
162
 
</td>
163
 
</tr>
164
 
<tr>
165
 
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
166
 
<td>an <a class="link" href="EBook.html" title="EBook"><span class="type">EBook</span></a>
167
 
</td>
168
 
</tr>
169
 
</tbody>
170
 
</table></div>
171
 
</div>
172
 
<hr>
173
 
<div class="refsect2" lang="en">
 
117
<div class="refsect2" title="e_book_view_get_book ()">
174
118
<a name="e-book-view-get-book"></a><h3>e_book_view_get_book ()</h3>
175
119
<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>
176
120
<p>
177
 
Returns the <a class="link" href="EBook.html" title="EBook"><span class="type">EBook</span></a> that this book view is monitoring.</p>
 
121
Returns the <a class="link" href="EBook.html" title="EBook"><span class="type">EBook</span></a> that this book view is monitoring.
 
122
</p>
178
123
<div class="variablelist"><table border="0">
179
124
<col align="left" valign="top">
180
125
<tbody>
186
131
<tr>
187
132
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
188
133
<td> an <a class="link" href="EBook.html" title="EBook"><span class="type">EBook</span></a>.
 
134
 
189
135
</td>
190
136
</tr>
191
137
</tbody>
192
138
</table></div>
193
 
</div>
194
 
</div>
195
 
<div class="refsect1" lang="en">
 
139
<p class="since">Since 2.22</p>
 
140
</div>
 
141
</div>
 
142
<div class="refsect1" title="Signal Details">
196
143
<a name="EBookView.signal-details"></a><h2>Signal Details</h2>
197
 
<div class="refsect2" lang="en">
 
144
<div class="refsect2" title='The "contacts-added" signal'>
198
145
<a name="EBookView-contacts-added"></a><h3>The <code class="literal">"contacts-added"</code> signal</h3>
199
146
<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,
200
147
                                                        <span class="type">gpointer</span>   arg1,
225
172
</table></div>
226
173
</div>
227
174
<hr>
228
 
<div class="refsect2" lang="en">
 
175
<div class="refsect2" title='The "contacts-changed" signal'>
229
176
<a name="EBookView-contacts-changed"></a><h3>The <code class="literal">"contacts-changed"</code> signal</h3>
230
177
<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,
231
178
                                                        <span class="type">gpointer</span>   arg1,
256
203
</table></div>
257
204
</div>
258
205
<hr>
259
 
<div class="refsect2" lang="en">
 
206
<div class="refsect2" title='The "contacts-removed" signal'>
260
207
<a name="EBookView-contacts-removed"></a><h3>The <code class="literal">"contacts-removed"</code> signal</h3>
261
208
<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,
262
209
                                                        <span class="type">gpointer</span>   arg1,
286
233
</table></div>
287
234
</div>
288
235
<hr>
289
 
<div class="refsect2" lang="en">
 
236
<div class="refsect2" title='The "sequence-complete" signal'>
290
237
<a name="EBookView-sequence-complete"></a><h3>The <code class="literal">"sequence-complete"</code> signal</h3>
291
238
<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,
292
239
                                                        <span class="type">gint</span>       arg1,
316
263
</table></div>
317
264
</div>
318
265
<hr>
319
 
<div class="refsect2" lang="en">
 
266
<div class="refsect2" title='The "status-message" signal'>
320
267
<a name="EBookView-status-message"></a><h3>The <code class="literal">"status-message"</code> signal</h3>
321
268
<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,
322
269
                                                        <span class="type">gchar</span>     *arg1,
345
292
</table></div>
346
293
</div>
347
294
</div>
348
 
<div class="refsect1" lang="en">
 
295
<div class="refsect1" title="See Also">
349
296
<a name="EBookView.see-also"></a><h2>See Also</h2>
350
297
<p>
351
 
<a class="link" href="EBookViewListener.html" title="EBookViewListener"><span class="type">EBookViewListener</span></a>, <a class="link" href="EBook.html" title="EBook"><span class="type">EBook</span></a>.
 
298
<span class="type">EBookViewListener</span>, <a class="link" href="EBook.html" title="EBook"><span class="type">EBook</span></a>.
352
299
</p>
353
300
</div>
354
301
</div>