/usr/share/gtk-doc/html/evolution-util/EPhotoSource.html is in evolution-dev 3.10.4-0ubuntu1.
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 | <!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch15.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.19 (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="EPhotoCache.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch15.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 Utilities Reference Manual</th>
<td><a accesskey="n" href="EPictureGallery.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EPhotoSource.synopsis" class="shortcut">Top</a>
|
<a href="#EPhotoSource.description" class="shortcut">Description</a>
|
<a href="#EPhotoSource.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EPhotoSource.prerequisites" class="shortcut">Prerequisites</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EPhotoSource.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <e-util/e-util.h>
<a class="link" href="EPhotoSource.html#EPhotoSource-struct" title="EPhotoSource">EPhotoSource</a>;
struct <a class="link" href="EPhotoSource.html#EPhotoSourceInterface" title="struct EPhotoSourceInterface">EPhotoSourceInterface</a>;
<span class="returnvalue">void</span> <a class="link" href="EPhotoSource.html#e-photo-source-get-photo" title="e_photo_source_get_photo ()">e_photo_source_get_photo</a> (<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 <span class="type">gchar</span> *email_address</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">gboolean</span> <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> (<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><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GInputStream</span> **out_stream</code></em>,
<em class="parameter"><code><span class="type">gint</span> *out_priority</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EPhotoSource.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----EPhotoSource
</pre>
</div>
<div class="refsect1">
<a name="EPhotoSource.prerequisites"></a><h2>Prerequisites</h2>
<p>
EPhotoSource requires
GObject.</p>
</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.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EPhotoSource-struct"></a><h3>EPhotoSource</h3>
<pre class="programlisting">typedef struct _EPhotoSource EPhotoSource;</pre>
</div>
<hr>
<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>
<hr>
<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 <span class="type">gchar</span> *email_address</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> 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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_source</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>email_address</code></em> :</span></p></td>
<td>an email address</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to the callback function</td>
</tr>
</tbody>
</table></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"><span class="returnvalue">gboolean</span> 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><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GInputStream</span> **out_stream</code></em>,
<em class="parameter"><code><span class="type">gint</span> *out_priority</code></em>,
<em class="parameter"><code><span class="type">GError</span> **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 <span class="type">GInputStream</span> 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 <code class="literal">NULL</code>
(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 <code class="literal">FALSE</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>photo_source</code></em> :</span></p></td>
<td>an <a class="link" href="EPhotoSource.html" title="EPhotoSource"><span class="type">EPhotoSource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <span class="type">GAsyncResult</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_stream</code></em> :</span></p></td>
<td>return location for a <span class="type">GInputStream</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_priority</code></em> :</span></p></td>
<td>return location for a priority value, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether the search completed successfully</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|