File: EModule.html

package info (click to toggle)
evolution-data-server 3.4.4-3%2Bdeb7u1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 47,788 kB
  • sloc: ansic: 248,622; sh: 12,008; makefile: 2,874; xml: 428; perl: 204; python: 30
file content (246 lines) | stat: -rw-r--r-- 15,064 bytes parent folder | download 
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
 
<!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="prev" href="EExtension.html" title="EExtension">
<link rel="next" href="EFileCache.html" title="EFileCache">
<meta name="generator" content="GTK-Doc V1.18 (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="EExtension.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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-Data-Server Manual: Backend Utilities (libebackend)</th>
<td><a accesskey="n" href="EFileCache.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EModule.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#EModule.description" class="shortcut">Description</a>
                   | 
                  <a href="#EModule.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#EModule.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#EModule.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="EModule"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EModule.top_of_page"></a>EModule</span></h2>
<p>EModule — a module loader</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EModule.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libebackend/e-module.h&gt;

struct              <a class="link" href="EModule.html#EModule-struct" title="struct EModule">EModule</a>;
<a class="link" href="EModule.html" title="EModule"><span class="returnvalue">EModule</span></a> *           <a class="link" href="EModule.html#e-module-new" title="e_module_new ()">e_module_new</a>                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="EModule.html#e-module-get-filename" title="e_module_get_filename ()">e_module_get_filename</a>               (<em class="parameter"><code><a class="link" href="EModule.html" title="EModule"><span class="type">EModule</span></a> *module</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="EModule.html#e-module-load-all-in-directory" title="e_module_load_all_in_directory ()">e_module_load_all_in_directory</a>      (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>);
<span class="returnvalue">void</span>                (<a class="link" href="EModule.html#ETypeFunc" title="ETypeFunc ()">*ETypeFunc</a>)                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="EModule.html#e-type-traverse" title="e_type_traverse ()">e_type_traverse</a>                     (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> parent_type</code></em>,
                                                         <em class="parameter"><code><a class="link" href="EModule.html#ETypeFunc" title="ETypeFunc ()"><span class="type">ETypeFunc</span></a> func</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EModule.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html">GTypeModule</a>
         +----EModule
</pre>
</div>
<div class="refsect1">
<a name="EModule.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EModule implements
 <a href="http://library.gnome.org/devel/gobject/unstable/GTypePlugin.html">GTypePlugin</a>.</p>
</div>
<div class="refsect1">
<a name="EModule.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="EModule.html#EModule--filename" title='The "filename" property'>filename</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="EModule.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EModule.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EModule-struct"></a><h3>struct EModule</h3>
<pre class="programlisting">struct EModule;</pre>
<p>
Contains only private data that should be read and manipulated using the
functions below.
</p>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="e-module-new"></a><h3>e_module_new ()</h3>
<pre class="programlisting"><a class="link" href="EModule.html" title="EModule"><span class="returnvalue">EModule</span></a> *           e_module_new                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>
Creates a new <a class="link" href="EModule.html" title="EModule"><span class="type">EModule</span></a> that will load the specific shared library
when in use.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>filename of the shared library module</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="EModule.html" title="EModule"><span class="type">EModule</span></a> for <em class="parameter"><code>filename</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       e_module_get_filename               (<em class="parameter"><code><a class="link" href="EModule.html" title="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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
<td>an <a class="link" href="EModule.html" title="EModule"><span class="type">EModule</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the filename for <em class="parameter"><code>module</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/gobject/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dirname</code></em> :</span></p></td>
<td>pathname for a directory containing modules to load</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of <a href="EModule.html"><span class="type">EModules</span></a> loaded from <em class="parameter"><code>dirname</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ETypeFunc"></a><h3>ETypeFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                (*ETypeFunc)                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/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="EModule.html#e-type-traverse" title="e_type_traverse ()"><code class="function">e_type_traverse()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data passed to <a class="link" href="EModule.html#e-type-traverse" title="e_type_traverse ()"><code class="function">e_type_traverse()</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</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="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> parent_type</code></em>,
                                                         <em class="parameter"><code><a class="link" href="EModule.html#ETypeFunc" title="ETypeFunc ()"><span class="type">ETypeFunc</span></a> func</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/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="EModule.html" title="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="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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent_type</code></em> :</span></p></td>
<td>the root <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> to traverse from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>the function to call for each visited <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data to pass to the function</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
</div>
<div class="refsect1">
<a name="EModule.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EModule--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
<pre class="programlisting">  "filename"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
<p>
The filename of the module.
</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>