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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EPhotoSource: Evolution Utilities Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch17.html" title="(Unsorted Sections)">
<link rel="prev" href="EPhotoCache.html" title="EPhotoCache">
<link rel="next" href="EPictureGallery.html" title="EPictureGallery">
<meta name="generator" content="GTK-Doc V1.25 (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="#EPhotoSource.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#EPhotoSource.object-hierarchy" class="shortcut">Object Hierarchy</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="ch17.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="EPhotoCache.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="EPictureGallery.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="EPhotoSource"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EPhotoSource.top_of_page"></a>EPhotoSource</span></h2>
<p>EPhotoSource — A source of email address photos</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EPhotoSource.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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EPhotoSource.html#e-photo-source-get-photo" title="e_photo_source_get_photo ()">e_photo_source_get_photo</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EPhotoSource.html#e-photo-source-get-photo-finish" title="e_photo_source_get_photo_finish ()">e_photo_source_get_photo_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EPhotoSource.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="EPhotoSource.html#EPhotoSourceInterface" title="struct EPhotoSourceInterface">EPhotoSourceInterface</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EPhotoSource.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> EPhotoSource
</pre>
</div>
<div class="refsect1">
<a name="EPhotoSource.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <e-util/e-util.h>
</pre>
</div>
<div class="refsect1">
<a name="EPhotoSource.description"></a><h2>Description</h2>
<p><a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a> is an interface used to extend the functionality of
<a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a>. You can add an object implementing <a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a> to an
<a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> with <a class="link" href="EPhotoCache.html#e-photo-cache-add-photo-source" title="e_photo_cache_add_photo_source ()"><code class="function">e_photo_cache_add_photo_source()</code></a> and remove it with
<a class="link" href="EPhotoCache.html#e-photo-cache-remove-photo-source" title="e_photo_cache_remove_photo_source ()"><code class="function">e_photo_cache_remove_photo_source()</code></a>. When <a class="link" href="EPhotoCache.html" title="EPhotoCache"><span class="type">EPhotoCache</span></a> needs a photo
for an email address it will invoke <a class="link" href="EPhotoSource.html#e-photo-source-get-photo" title="e_photo_source_get_photo ()"><code class="function">e_photo_source_get_photo()</code></a> on all
available <a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a> objects simultaneously and select one photo.</p>
</div>
<div class="refsect1">
<a name="EPhotoSource.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-photo-source-get-photo"></a><h3>e_photo_source_get_photo ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_photo_source_get_photo (<em class="parameter"><code><a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a> *photo_source</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *email_address</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gioGAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Asynchronously searches for a photo for <em class="parameter"><code>email_address</code></em>
.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
will be called. You can then
call <a class="link" href="EPhotoSource.html#e-photo-source-get-photo-finish" title="e_photo_source_get_photo_finish ()"><code class="function">e_photo_source_get_photo_finish()</code></a> to get the result of the operation.</p>
<div class="refsect3">
<a name="e-photo-source-get-photo.parameters"></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>photo_source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>email_address</p></td>
<td class="parameter_description"><p>an email address</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <a href="/usr/share/gtk-doc/html/gioGCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gioGAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to pass to the callback function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-photo-source-get-photo-finish"></a><h3>e_photo_source_get_photo_finish ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_photo_source_get_photo_finish (<em class="parameter"><code><a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a> *photo_source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gioGAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gioGInputStream.html#GInputStream-struct"><span class="type">GInputStream</span></a> **out_stream</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a> *out_priority</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Finishes the operation started with <a class="link" href="EPhotoSource.html#e-photo-source-get-photo" title="e_photo_source_get_photo ()"><code class="function">e_photo_source_get_photo()</code></a>.</p>
<p>If a match was found, a <a href="/usr/share/gtk-doc/html/gioGInputStream.html#GInputStream-struct"><span class="type">GInputStream</span></a> from which to read image data is
returned through the <em class="parameter"><code>out_stream</code></em>
return location, and a suggested priority
value for the match is returned through the <em class="parameter"><code>out_priority</code></em>
return location.</p>
<p>You can use the <em class="parameter"><code>out_priority</code></em>
value to rank this result among other
<a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a> results. The value is usually <em class="parameter"><code>G_PRIORITY_DEFAULT</code></em>
, but
may be <em class="parameter"><code>G_PRIORITY_LOW</code></em>
if the result is a fallback image.</p>
<p>If no match was found, the <em class="parameter"><code>out_stream</code></em>
return location is set to <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
(the <em class="parameter"><code>out_priority</code></em>
return location will remain unset).</p>
<p>The return value indicates whether the search completed successfully,
not whether a match was found. If an error occurred, the function will
set <em class="parameter"><code>error</code></em>
and return <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<div class="refsect3">
<a name="e-photo-source-get-photo-finish.parameters"></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>photo_source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gioGAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_stream</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/gioGInputStream.html#GInputStream-struct"><span class="type">GInputStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_priority</p></td>
<td class="parameter_description"><p>return location for a priority value, or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></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/glibglib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-photo-source-get-photo-finish.returns"></a><h4>Returns</h4>
<p> whether the search completed successfully</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="EPhotoSource.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EPhotoSourceInterface"></a><h3>struct EPhotoSourceInterface</h3>
<pre class="programlisting">struct EPhotoSourceInterface {
GTypeInterface parent_interface;
void (*get_photo) (EPhotoSource *photo_source,
const gchar *email_address,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean (*get_photo_finish) (EPhotoSource *photo_source,
GAsyncResult *result,
GInputStream **out_stream,
gint *out_priority,
GError **error);
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|
