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

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libebook/html/EBookListener.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:
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>EBookListener</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
7
 
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Address Book Client (libebook)">
8
 
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Address Book Client (libebook)">
9
 
<link rel="prev" href="EBook.html" title="EBook">
10
 
<link rel="next" href="libebook-e-book-query.html" title="e-book-query">
11
 
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
</head>
14
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="EBook.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">Evolution-Data-Server Manual: Address Book Client (libebook)</th>
21
 
<td><a accesskey="n" href="libebook-e-book-query.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#EBookListener.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#EBookListener.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#EBookListener.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
                   | 
30
 
                  <a href="#EBookListener.signals" class="shortcut">Signals</a>
31
 
</td></tr>
32
 
</table>
33
 
<div class="refentry" lang="en">
34
 
<a name="EBookListener"></a><div class="titlepage"></div>
35
 
<div class="refnamediv"><table width="100%"><tr>
36
 
<td valign="top">
37
 
<h2><span class="refentrytitle"><a name="EBookListener.top_of_page"></a>EBookListener</span></h2>
38
 
<p>EBookListener — Listens for call responses and event notifications from EBook objects.</p>
39
 
</td>
40
 
<td valign="top" align="right"></td>
41
 
</tr></table></div>
42
 
<div class="refsynopsisdiv">
43
 
<a name="EBookListener.synopsis"></a><h2>Synopsis</h2>
44
 
<pre class="synopsis">                    <a class="link" href="EBookListener.html#EBookListener-struct" title="EBookListener">EBookListener</a>;
45
 
                    <a class="link" href="EBookListener.html#EBookListenerResponse" title="EBookListenerResponse">EBookListenerResponse</a>;
46
 
enum                <a class="link" href="EBookListener.html#EBookListenerOperation" title="enum EBookListenerOperation">EBookListenerOperation</a>;
47
 
<a class="link" href="EBookListener.html" title="EBookListener"><span class="returnvalue">EBookListener</span></a> *     <a class="link" href="EBookListener.html#e-book-listener-new" title="e_book_listener_new ()">e_book_listener_new</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
48
 
<span class="returnvalue">void</span>                <a class="link" href="EBookListener.html#e-book-listener-stop" title="e_book_listener_stop ()">e_book_listener_stop</a>                (<em class="parameter"><code><a class="link" href="EBookListener.html" title="EBookListener"><span class="type">EBookListener</span></a> *listener</code></em>);
49
 
</pre>
50
 
</div>
51
 
<div class="refsect1" lang="en">
52
 
<a name="EBookListener.object-hierarchy"></a><h2>Object Hierarchy</h2>
53
 
<pre class="synopsis">
54
 
  GObject
55
 
   +----BonoboObject
56
 
         +----EBookListener
57
 
</pre>
58
 
</div>
59
 
<div class="refsect1" lang="en">
60
 
<a name="EBookListener.signals"></a><h2>Signals</h2>
61
 
<pre class="synopsis">
62
 
  "<a class="link" href="EBookListener.html#EBookListener-response" title='The "response" signal'>response</a>"                                       : Run Last
63
 
</pre>
64
 
</div>
65
 
<div class="refsect1" lang="en">
66
 
<a name="EBookListener.description"></a><h2>Description</h2>
67
 
<p>
68
 
Exposes the Evolution:BookListener interface. Contrast with EBookViewListener.
69
 
</p>
70
 
</div>
71
 
<div class="refsect1" lang="en">
72
 
<a name="EBookListener.details"></a><h2>Details</h2>
73
 
<div class="refsect2" lang="en">
74
 
<a name="EBookListener-struct"></a><h3>EBookListener</h3>
75
 
<pre class="programlisting">typedef struct _EBookListener EBookListener;</pre>
76
 
<p>
77
 
</p>
78
 
</div>
79
 
<hr>
80
 
<div class="refsect2" lang="en">
81
 
<a name="EBookListenerResponse"></a><h3>EBookListenerResponse</h3>
82
 
<pre class="programlisting">typedef struct {
83
 
        EBookListenerOperation  op;
84
 
 
85
 
        /* The tag that e_book_* assigned to the operation this is a
86
 
           response for */
87
 
        guint32                 opid;
88
 
 
89
 
        /* For most Response notifications */
90
 
        EBookStatus             status;
91
 
 
92
 
        /* For GetBookViewReponse */
93
 
        GNOME_Evolution_Addressbook_BookView      book_view;
94
 
 
95
 
        /* For GetSupportedFields/GetSupportedAuthMethods */
96
 
        GList                                    *list;
97
 
 
98
 
        /* For ProgressEvent */
99
 
        gchar                   *msg;
100
 
        short                   percent;
101
 
 
102
 
        /* For LinkStatusEvent */
103
 
        gboolean                connected;
104
 
 
105
 
        /* For WritableStatusEvent */
106
 
        gboolean                writable;
107
 
 
108
 
        /* For Card[Added|Removed|Modified]Event */
109
 
        gchar                   *id;
110
 
        gchar                   *vcard;
111
 
} EBookListenerResponse;
112
 
</pre>
113
 
<p>
114
 
</p>
115
 
</div>
116
 
<hr>
117
 
<div class="refsect2" lang="en">
118
 
<a name="EBookListenerOperation"></a><h3>enum EBookListenerOperation</h3>
119
 
<pre class="programlisting">typedef enum {
120
 
        /* Async responses */
121
 
        OpenBookResponse,
122
 
        RemoveBookResponse,
123
 
        CreateContactResponse,
124
 
        RemoveContactResponse,
125
 
        ModifyContactResponse,
126
 
        GetContactResponse,
127
 
        GetContactListResponse,
128
 
        GetBookViewResponse,
129
 
        GetChangesResponse,
130
 
        AuthenticationResponse,
131
 
        GetSupportedFieldsResponse,
132
 
        GetRequiredFieldsResponse,
133
 
        GetSupportedAuthMethodsResponse,
134
 
 
135
 
        /* Async events */
136
 
        LinkStatusEvent,
137
 
        WritableStatusEvent,
138
 
        AuthRequiredEvent,
139
 
        ProgressEvent
140
 
} EBookListenerOperation;
141
 
</pre>
142
 
<p>
143
 
</p>
144
 
</div>
145
 
<hr>
146
 
<div class="refsect2" lang="en">
147
 
<a name="e-book-listener-new"></a><h3>e_book_listener_new ()</h3>
148
 
<pre class="programlisting"><a class="link" href="EBookListener.html" title="EBookListener"><span class="returnvalue">EBookListener</span></a> *     e_book_listener_new                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
149
 
<p>
150
 
Creates and returns a new <a class="link" href="EBookListener.html" title="EBookListener"><span class="type">EBookListener</span></a>.</p>
151
 
<div class="variablelist"><table border="0">
152
 
<col align="left" valign="top">
153
 
<tbody><tr>
154
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
155
 
<td> a new <a class="link" href="EBookListener.html" title="EBookListener"><span class="type">EBookListener</span></a>
156
 
</td>
157
 
</tr></tbody>
158
 
</table></div>
159
 
</div>
160
 
<hr>
161
 
<div class="refsect2" lang="en">
162
 
<a name="e-book-listener-stop"></a><h3>e_book_listener_stop ()</h3>
163
 
<pre class="programlisting"><span class="returnvalue">void</span>                e_book_listener_stop                (<em class="parameter"><code><a class="link" href="EBookListener.html" title="EBookListener"><span class="type">EBookListener</span></a> *listener</code></em>);</pre>
164
 
<p>
165
 
Stops <em class="parameter"><code>listener</code></em> from generating events.</p>
166
 
<div class="variablelist"><table border="0">
167
 
<col align="left" valign="top">
168
 
<tbody><tr>
169
 
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
170
 
<td>an <a class="link" href="EBookListener.html" title="EBookListener"><span class="type">EBookListener</span></a>
171
 
</td>
172
 
</tr></tbody>
173
 
</table></div>
174
 
</div>
175
 
</div>
176
 
<div class="refsect1" lang="en">
177
 
<a name="EBookListener.signal-details"></a><h2>Signal Details</h2>
178
 
<div class="refsect2" lang="en">
179
 
<a name="EBookListener-response"></a><h3>The <code class="literal">"response"</code> signal</h3>
180
 
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="EBookListener.html" title="EBookListener"><span class="type">EBookListener</span></a> *ebooklistener,
181
 
                                                        <span class="type">gpointer</span>       arg1,
182
 
                                                        <span class="type">gpointer</span>       user_data)          : Run Last</pre>
183
 
<p>
184
 
</p>
185
 
<div class="variablelist"><table border="0">
186
 
<col align="left" valign="top">
187
 
<tbody>
188
 
<tr>
189
 
<td><p><span class="term"><em class="parameter"><code>ebooklistener</code></em> :</span></p></td>
190
 
<td>the object which received the signal.
191
 
</td>
192
 
</tr>
193
 
<tr>
194
 
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
195
 
<td>
196
 
</td>
197
 
</tr>
198
 
<tr>
199
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
200
 
<td>user data set when the signal handler was connected.</td>
201
 
</tr>
202
 
</tbody>
203
 
</table></div>
204
 
</div>
205
 
</div>
206
 
</div>
207
 
<div class="footer">
208
 
<hr>
209
 
          Generated by GTK-Doc V1.14</div>
210
 
</body>
211
 
</html>
 
 
b'\\ No newline at end of file'