evolution-data-server-doc 3.18.5-1ubuntu1 / usr / share / gtk-doc / html / eds / eds-ESourceCamel.html

This file is indexed.

/usr/share/gtk-doc/html/eds/eds-ESourceCamel.html is in evolution-data-server-doc 3.18.5-1ubuntu1.

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
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ESourceCamel: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch02.html" title="Data Source Extensions">
<link rel="prev" href="eds-ESourceCalendar.html" title="ESourceCalendar">
<link rel="next" href="eds-ESourceCollection.html" title="ESourceCollection">
<meta name="generator" content="GTK-Doc V1.24 (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="#eds-ESourceCamel.description" class="shortcut">Description</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="eds-ESourceCalendar.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="eds-ESourceCollection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-ESourceCamel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-ESourceCamel.top_of_page"></a>ESourceCamel</span></h2>
<p>ESourceCamel — <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> extension for <span class="type">CamelSettings</span></p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-ESourceCamel.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="eds-ESourceCamel.html#e-source-camel-register-types" title="e_source_camel_register_types ()">e_source_camel_register_types</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceCamel.html#e-source-camel-generate-subtype" title="e_source_camel_generate_subtype ()">e_source_camel_generate_subtype</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CamelSettings</span> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceCamel.html#e-source-camel-get-settings" title="e_source_camel_get_settings ()">e_source_camel_get_settings</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceCamel.html#e-source-camel-get-type-name" title="e_source_camel_get_type_name ()">e_source_camel_get_type_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceCamel.html#e-source-camel-get-extension-name" title="e_source_camel_get_extension_name ()">e_source_camel_get_extension_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceCamel.html#e-source-camel-configure-service" title="e_source_camel_configure_service ()">e_source_camel_configure_service</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-ESourceCamel.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="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel">ESourceCamel</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-ESourceCamel.html#ESourceCamelClass" title="struct ESourceCamelClass">ESourceCamelClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-ESourceCamel.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libedataserver/libedataserver.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="eds-ESourceCamel.description"></a><h2>Description</h2>
<p><a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> itself is abstract.  Its sole function is to
bridge <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> properties from the <span class="type">CamelSettings</span> framework to the
<a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> framework.  It does this by procedurally registering an
<a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> subtype for each available <span class="type">CamelService</span> subtype,
and then registering <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> properties to proxy the properties in the
corresponding <span class="type">CamelSettings</span> subtype.  The <a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> owns an
instance of the appropriate <span class="type">CamelSettings</span> subtype, and redirects all
get/set operations on its own <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> properties to its <span class="type">CamelSettings</span>
instance.  The <span class="type">CamelSettings</span> instance, now fully initialized from a key
file, can then be inserted into a new <span class="type">CamelService</span> instance using
<code class="function">camel_service_set_settings()</code>.</p>
<p>Ultimately, this is all just implementation detail for glueing two
unrelated class hierarchies together.  If you need to access provider
specific settings, use the <span class="type">CamelSettings</span> API, not this.</p>
</div>
<div class="refsect1">
<a name="eds-ESourceCamel.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-source-camel-register-types"></a><h3>e_source_camel_register_types ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_camel_register_types (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates and registers subclasses of <a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> for each available
<span class="type">CamelProvider</span>.  This function should be called once during application
or library initialization.</p>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-camel-generate-subtype"></a><h3>e_source_camel_generate_subtype ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
e_source_camel_generate_subtype (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>,
                                 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> settings_type</code></em>);</pre>
<p>Generates a custom <a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> subtype for <em class="parameter"><code>protocol</code></em>
.  Instances of the
new subtype will contain a <span class="type">CamelSettings</span> instance of type <em class="parameter"><code>settings_type</code></em>
.</p>
<p>This function is called as part of <a class="link" href="eds-ESourceCamel.html#e-source-camel-register-types" title="e_source_camel_register_types ()"><code class="function">e_source_camel_register_types()</code></a> and
should not be called explicitly, except by some groupware packages that
need to share package-specific settings across their mail, calendar and
address book components.  In that case the groupware package may choose
to subclass <span class="type">CamelSettings</span> rather than <a class="link" href="eds-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> since libcamel
is the lowest common denominator across all components.  This function
provides a way for the calendar and address book components of such a
package to generate an <a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> subtype for its <span class="type">CamelSettings</span>
subtype without having to load all available <span class="type">CamelProvider</span> modules.</p>
<div class="refsect3">
<a name="id-1.2.3.10.7.3.6"></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>protocol</p></td>
<td class="parameter_description"><p>a <span class="type">CamelProvider</span> protocol</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>settings_type</p></td>
<td class="parameter_description"><p>a subtype of <span class="type">CamelSettings</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.10.7.3.7"></a><h4>Returns</h4>
<p> the <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the generated <a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> subtype</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-camel-get-settings"></a><h3>e_source_camel_get_settings ()</h3>
<pre class="programlisting"><span class="returnvalue">CamelSettings</span> *
e_source_camel_get_settings (<em class="parameter"><code><a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> *extension</code></em>);</pre>
<p>Returns <em class="parameter"><code>extension</code></em>
's <span class="type">“settings”</span> instance, pre-configured
from the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> to which <em class="parameter"><code>extension</code></em>
 belongs.  Changes to the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>
will automatically propagate to the <span class="type">“settings”</span> instance and
vice versa.</p>
<p>This is essentially the glue that binds <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> to <span class="type">CamelService</span>.
See <a class="link" href="eds-ESourceCamel.html#e-source-camel-configure-service" title="e_source_camel_configure_service ()"><code class="function">e_source_camel_configure_service()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.3.10.7.4.6"></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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.10.7.4.7"></a><h4>Returns</h4>
<p> a configured <span class="type">CamelSettings</span> instance</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-camel-get-type-name"></a><h3>e_source_camel_get_type_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_source_camel_get_type_name (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>);</pre>
<p>Returns the <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> name of the registered <a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> subtype for
<em class="parameter"><code>protocol</code></em>
.</p>
<p>For example, given a protocol named "imap" the function would return
"ESourceCamelImap".</p>
<div class="refsect3">
<a name="id-1.2.3.10.7.5.6"></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>protocol</p></td>
<td class="parameter_description"><p>a <span class="type">CamelProvider</span> protocol</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.10.7.5.7"></a><h4>Returns</h4>
<p> the <a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> type name for <em class="parameter"><code>protocol</code></em>
</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-camel-get-extension-name"></a><h3>e_source_camel_get_extension_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_source_camel_get_extension_name (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>);</pre>
<p>Returns the extension name for the <a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> subtype for <em class="parameter"><code>protocol</code></em>
.
The extension name can then be passed to <a class="link" href="eds-ESource.html#e-source-get-extension" title="e_source_get_extension ()"><code class="function">e_source_get_extension()</code></a> to
obtain an instance of the <a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> subtype.</p>
<p>For example, given a protocol named "imap" the function would return
"Imap Backend".</p>
<div class="refsect3">
<a name="id-1.2.3.10.7.6.6"></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>protocol</p></td>
<td class="parameter_description"><p>a <span class="type">CamelProvider</span> protocol</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.10.7.6.7"></a><h4>Returns</h4>
<p> the <a class="link" href="eds-ESourceCamel.html#ESourceCamel" title="struct ESourceCamel"><span class="type">ESourceCamel</span></a> extension name for <em class="parameter"><code>protocol</code></em>
</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-camel-configure-service"></a><h3>e_source_camel_configure_service ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_camel_configure_service (<em class="parameter"><code><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> *source</code></em>,
                                  <em class="parameter"><code><span class="type">CamelService</span> *service</code></em>);</pre>
<p>This function essentially glues together <em class="parameter"><code>source</code></em>
 and <em class="parameter"><code>serivce</code></em>
 so their
configuration settings stay synchronized.  The glue itself is a shared
<span class="type">CamelSettings</span> instance.</p>
<p>Call this function immediately after creating a new <span class="type">CamelService</span> with
<code class="function">camel_session_add_service()</code>.</p>
<div class="refsect3">
<a name="id-1.2.3.10.7.7.6"></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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>service</p></td>
<td class="parameter_description"><p>a <span class="type">CamelService</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="eds-ESourceCamel.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ESourceCamel"></a><h3>struct ESourceCamel</h3>
<pre class="programlisting">struct ESourceCamel {
	ESourceExtension parent;
	ESourceCamelPrivate *priv;
};
</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceCamelClass"></a><h3>struct ESourceCamelClass</h3>
<pre class="programlisting">struct ESourceCamelClass {
	ESourceExtensionClass parent_class;

	/* Same idea as in CamelServiceClass. */
	GType settings_type;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.