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

This file is indexed.

/usr/share/gtk-doc/html/eds/eds-EModule.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EModule: 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="ch06.html" title="Abstract Classes for Backends">
<link rel="prev" href="eds-EExtension.html" title="EExtension">
<link rel="next" href="ch07.html" title="Registry Service Classes">
<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-EModule.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="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="eds-EExtension.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch07.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-EModule"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-EModule.top_of_page"></a>EModule</span></h2>
<p>EModule — A module loader</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-EModule.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">
<a class="link" href="eds-EModule.html#EModule" title="struct EModule"><span class="returnvalue">EModule</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EModule.html#e-module-new" title="e_module_new ()">e_module_new</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-EModule.html#e-module-get-filename" title="e_module_get_filename ()">e_module_get_filename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EModule.html#e-module-load-all-in-directory" title="e_module_load_all_in_directory ()">e_module_load_all_in_directory</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-EModule.html#EModule" title="struct EModule"><span class="returnvalue">EModule</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EModule.html#e-module-load-file" title="e_module_load_file ()">e_module_load_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="eds-EModule.html#ETypeFunc" title="ETypeFunc ()">*ETypeFunc</a><span class="c_punctuation">)</span> <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-EModule.html#e-type-traverse" title="e_type_traverse ()">e_type_traverse</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EModule.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-EModule.html#EModule" title="struct EModule">EModule</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-EModule.html#EModuleClass" title="struct EModuleClass">EModuleClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EModule.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libedataserver/libedataserver.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="eds-EModule.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="eds-EModule.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-module-new"></a><h3>e_module_new ()</h3>
<pre class="programlisting"><a class="link" href="eds-EModule.html#EModule" title="struct EModule"><span class="returnvalue">EModule</span></a> *
e_module_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>Creates a new <a class="link" href="eds-EModule.html#EModule" title="struct EModule"><span class="type">EModule</span></a> that will load the specific shared library
when in use.</p>
<div class="refsect3">
<a name="id-1.4.2.8.7.2.5"></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>filename</p></td>
<td class="parameter_description"><p>filename of the shared library module</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.7.2.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="eds-EModule.html#EModule" title="struct EModule"><span class="type">EModule</span></a> for <em class="parameter"><code>filename</code></em>
</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-module-get-filename"></a><h3>e_module_get_filename ()</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_module_get_filename (<em class="parameter"><code><a class="link" href="eds-EModule.html#EModule" title="struct EModule"><span class="type">EModule</span></a> *module</code></em>);</pre>
<p>Returns the filename of the shared library for <em class="parameter"><code>module</code></em>
.  The
string is owned by <em class="parameter"><code>module</code></em>
 and should not be modified or freed.</p>
<div class="refsect3">
<a name="id-1.4.2.8.7.3.5"></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>module</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EModule.html#EModule" title="struct EModule"><span class="type">EModule</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.7.3.6"></a><h4>Returns</h4>
<p> the filename for <em class="parameter"><code>module</code></em>
</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-module-load-all-in-directory"></a><h3>e_module_load_all_in_directory ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
e_module_load_all_in_directory (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>);</pre>
<p>Loads all the modules in the specified directory into memory.  If
you want to unload them (enabling on-demand loading) you must call
<a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html#g-type-module-unuse"><code class="function">g_type_module_unuse()</code></a> on all the modules.  Free the returned list
with <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.7.4.5"></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>dirname</p></td>
<td class="parameter_description"><p>pathname for a directory containing modules to load</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.7.4.6"></a><h4>Returns</h4>
<p> a list of <a href="eds-EModule.html#EModule"><span class="type">EModules</span></a> loaded from <em class="parameter"><code>dirname</code></em>
</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-module-load-file"></a><h3>e_module_load_file ()</h3>
<pre class="programlisting"><a class="link" href="eds-EModule.html#EModule" title="struct EModule"><span class="returnvalue">EModule</span></a> *
e_module_load_file (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>Load the module from the specified filename into memory. If
you want to unload it (enabling on-demand loading) you must call
<a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html#g-type-module-unuse"><code class="function">g_type_module_unuse()</code></a> on the module.</p>
<div class="refsect3">
<a name="id-1.4.2.8.7.5.5"></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>filename</p></td>
<td class="parameter_description"><p>filename of the module to load</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.7.5.6"></a><h4>Returns</h4>
<p> an <a class="link" href="eds-EModule.html#EModule" title="struct EModule"><span class="type">EModule</span></a> loaded from <em class="parameter"><code>filename</code></em>
</p>
</div>
<p class="since">Since: 3.16</p>
</div>
<hr>
<div class="refsect2">
<a name="ETypeFunc"></a><h3>ETypeFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*ETypeFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>,
              <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Specifies the type of functions passed to <a class="link" href="eds-EModule.html#e-type-traverse" title="e_type_traverse ()"><code class="function">e_type_traverse()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.7.6.5"></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>type</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data passed to <a class="link" href="eds-EModule.html#e-type-traverse" title="e_type_traverse ()"><code class="function">e_type_traverse()</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-type-traverse"></a><h3>e_type_traverse ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_type_traverse (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> parent_type</code></em>,
                 <em class="parameter"><code><a class="link" href="eds-EModule.html#ETypeFunc" title="ETypeFunc ()"><span class="type">ETypeFunc</span></a> func</code></em>,
                 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Calls <em class="parameter"><code>func</code></em>
 for all instantiable subtypes of <em class="parameter"><code>parent_type</code></em>
.</p>
<p>This is often useful for extending functionality by way of <a class="link" href="eds-EModule.html#EModule" title="struct EModule"><span class="type">EModule</span></a>.
A module may register a subtype of <em class="parameter"><code>parent_type</code></em>
 in its <code class="function">e_module_load()</code>
function.  Then later on the application will call <a class="link" href="eds-EModule.html#e-type-traverse" title="e_type_traverse ()"><code class="function">e_type_traverse()</code></a>
to instantiate all registered subtypes of <em class="parameter"><code>parent_type</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.2.8.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>parent_type</p></td>
<td class="parameter_description"><p>the root <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> to traverse from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>the function to call for each visited <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data to pass to the function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="eds-EModule.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EModule"></a><h3>struct EModule</h3>
<pre class="programlisting">struct EModule {
	GTypeModule parent;
	EModulePrivate *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.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="EModuleClass"></a><h3>struct EModuleClass</h3>
<pre class="programlisting">struct EModuleClass {
	GTypeModuleClass parent_class;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.