← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/calendar/libedata-cal/html/EDataCalFactory.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/calendar/libedata-cal/html/EDataCalFactory.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>EDataCalFactory</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
7
 
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Calendar Backend (libedata-cal)">
8
 
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Calendar Backend (libedata-cal)">
9
 
<link rel="prev" href="EDataCal.html" title="EDataCal">
10
 
<link rel="next" href="EDataCalView.html" title="EDataCalView">
11
 
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
</head>
14
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="EDataCal.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">Evolution-Data-Server Manual: Calendar Backend (libedata-cal)</th>
21
 
<td><a accesskey="n" href="EDataCalView.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#EDataCalFactory.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#EDataCalFactory.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#EDataCalFactory.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
                   | 
30
 
                  <a href="#EDataCalFactory.signals" class="shortcut">Signals</a>
31
 
</td></tr>
32
 
</table>
33
 
<div class="refentry" lang="en">
34
 
<a name="EDataCalFactory"></a><div class="titlepage"></div>
35
 
<div class="refnamediv"><table width="100%"><tr>
36
 
<td valign="top">
37
 
<h2><span class="refentrytitle"><a name="EDataCalFactory.top_of_page"></a>EDataCalFactory</span></h2>
38
 
<p>EDataCalFactory — Implementation of the calendar CORBA factory.</p>
39
 
</td>
40
 
<td valign="top" align="right"></td>
41
 
</tr></table></div>
42
 
<div class="refsynopsisdiv">
43
 
<a name="EDataCalFactory.synopsis"></a><h2>Synopsis</h2>
44
 
<pre class="synopsis">                    <a class="link" href="EDataCalFactory.html#EDataCalFactory-struct" title="EDataCalFactory">EDataCalFactory</a>;
45
 
<a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="returnvalue">EDataCalFactory</span></a> *   <a class="link" href="EDataCalFactory.html#e-data-cal-factory-new" title="e_data_cal_factory_new ()">e_data_cal_factory_new</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
46
 
<span class="returnvalue">gboolean</span>            <a class="link" href="EDataCalFactory.html#e-data-cal-factory-register-storage" title="e_data_cal_factory_register_storage ()">e_data_cal_factory_register_storage</a> (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>,
47
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *iid</code></em>);
48
 
<span class="returnvalue">void</span>                <a class="link" href="EDataCalFactory.html#e-data-cal-factory-register-backend" title="e_data_cal_factory_register_backend ()">e_data_cal_factory_register_backend</a> (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>,
49
 
                                                         <em class="parameter"><code><a class="link" href="ECalBackendFactory.html" title="ECalBackendFactory"><span class="type">ECalBackendFactory</span></a> *backend_factory</code></em>);
50
 
<span class="returnvalue">void</span>                <a class="link" href="EDataCalFactory.html#e-data-cal-factory-register-backends" title="e_data_cal_factory_register_backends ()">e_data_cal_factory_register_backends</a>
51
 
                                                        (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>);
52
 
<span class="returnvalue">gint</span>                <a class="link" href="EDataCalFactory.html#e-data-cal-factory-get-n-backends" title="e_data_cal_factory_get_n_backends ()">e_data_cal_factory_get_n_backends</a>   (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>);
53
 
<span class="returnvalue">void</span>                <a class="link" href="EDataCalFactory.html#e-data-cal-factory-dump-active-backends" title="e_data_cal_factory_dump_active_backends ()">e_data_cal_factory_dump_active_backends</a>
54
 
                                                        (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>);
55
 
<span class="returnvalue">void</span>                <a class="link" href="EDataCalFactory.html#e-data-cal-factory-set-backend-mode" title="e_data_cal_factory_set_backend_mode ()">e_data_cal_factory_set_backend_mode</a> (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>,
56
 
                                                         <em class="parameter"><code><span class="type">gint</span> mode</code></em>);
57
 
</pre>
58
 
</div>
59
 
<div class="refsect1" lang="en">
60
 
<a name="EDataCalFactory.object-hierarchy"></a><h2>Object Hierarchy</h2>
61
 
<pre class="synopsis">
62
 
  GObject
63
 
   +----BonoboObject
64
 
         +----EDataCalFactory
65
 
</pre>
66
 
</div>
67
 
<div class="refsect1" lang="en">
68
 
<a name="EDataCalFactory.signals"></a><h2>Signals</h2>
69
 
<pre class="synopsis">
70
 
  "<a class="link" href="EDataCalFactory.html#EDataCalFactory-last-calendar-gone" title='The "last-calendar-gone" signal'>last-calendar-gone</a>"                             : Run First
71
 
</pre>
72
 
</div>
73
 
<div class="refsect1" lang="en">
74
 
<a name="EDataCalFactory.description"></a><h2>Description</h2>
75
 
<p>
76
 
</p>
77
 
</div>
78
 
<div class="refsect1" lang="en">
79
 
<a name="EDataCalFactory.details"></a><h2>Details</h2>
80
 
<div class="refsect2" lang="en">
81
 
<a name="EDataCalFactory-struct"></a><h3>EDataCalFactory</h3>
82
 
<pre class="programlisting">typedef struct _EDataCalFactory EDataCalFactory;</pre>
83
 
<p>
84
 
</p>
85
 
</div>
86
 
<hr>
87
 
<div class="refsect2" lang="en">
88
 
<a name="e-data-cal-factory-new"></a><h3>e_data_cal_factory_new ()</h3>
89
 
<pre class="programlisting"><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="returnvalue">EDataCalFactory</span></a> *   e_data_cal_factory_new              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
90
 
<p>
91
 
Creates a new <a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> object.</p>
92
 
<div class="variablelist"><table border="0">
93
 
<col align="left" valign="top">
94
 
<tbody><tr>
95
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
96
 
<td> A newly-created <a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a>, or NULL if its corresponding CORBA
97
 
object could not be created.
98
 
</td>
99
 
</tr></tbody>
100
 
</table></div>
101
 
</div>
102
 
<hr>
103
 
<div class="refsect2" lang="en">
104
 
<a name="e-data-cal-factory-register-storage"></a><h3>e_data_cal_factory_register_storage ()</h3>
105
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_data_cal_factory_register_storage (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>,
106
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *iid</code></em>);</pre>
107
 
<p>
108
 
Registers a calendar factory with the OAF object activation daemon.  This
109
 
function must be called before any clients can activate the factory.</p>
110
 
<div class="variablelist"><table border="0">
111
 
<col align="left" valign="top">
112
 
<tbody>
113
 
<tr>
114
 
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
115
 
<td>A calendar factory.
116
 
</td>
117
 
</tr>
118
 
<tr>
119
 
<td><p><span class="term"><em class="parameter"><code>iid</code></em> :</span></p></td>
120
 
<td>OAFIID for the factory to be registered.
121
 
</td>
122
 
</tr>
123
 
<tr>
124
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
125
 
<td> TRUE on success, FALSE otherwise.
126
 
</td>
127
 
</tr>
128
 
</tbody>
129
 
</table></div>
130
 
</div>
131
 
<hr>
132
 
<div class="refsect2" lang="en">
133
 
<a name="e-data-cal-factory-register-backend"></a><h3>e_data_cal_factory_register_backend ()</h3>
134
 
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_cal_factory_register_backend (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>,
135
 
                                                         <em class="parameter"><code><a class="link" href="ECalBackendFactory.html" title="ECalBackendFactory"><span class="type">ECalBackendFactory</span></a> *backend_factory</code></em>);</pre>
136
 
<p>
137
 
Registers an <a class="link" href="ECalBackend.html" title="ECalBackend"><span class="type">ECalBackend</span></a> subclass that will be used to handle URIs
138
 
with a particular method.  When the factory is asked to open a
139
 
particular URI, it will look in its list of registered methods and
140
 
create a backend of the appropriate type.</p>
141
 
<div class="variablelist"><table border="0">
142
 
<col align="left" valign="top">
143
 
<tbody>
144
 
<tr>
145
 
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
146
 
<td>A calendar factory.
147
 
</td>
148
 
</tr>
149
 
<tr>
150
 
<td><p><span class="term"><em class="parameter"><code>backend_factory</code></em> :</span></p></td>
151
 
<td>The object responsible for creating backends.
152
 
</td>
153
 
</tr>
154
 
</tbody>
155
 
</table></div>
156
 
</div>
157
 
<hr>
158
 
<div class="refsect2" lang="en">
159
 
<a name="e-data-cal-factory-register-backends"></a><h3>e_data_cal_factory_register_backends ()</h3>
160
 
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_cal_factory_register_backends
161
 
                                                        (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>);</pre>
162
 
<p>
163
 
Register all backends for the given factory.</p>
164
 
<div class="variablelist"><table border="0">
165
 
<col align="left" valign="top">
166
 
<tbody><tr>
167
 
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
168
 
<td>
169
 
</td>
170
 
</tr></tbody>
171
 
</table></div>
172
 
</div>
173
 
<hr>
174
 
<div class="refsect2" lang="en">
175
 
<a name="e-data-cal-factory-get-n-backends"></a><h3>e_data_cal_factory_get_n_backends ()</h3>
176
 
<pre class="programlisting"><span class="returnvalue">gint</span>                e_data_cal_factory_get_n_backends   (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>);</pre>
177
 
<p>
178
 
Get the number of backends currently active in the given factory.</p>
179
 
<div class="variablelist"><table border="0">
180
 
<col align="left" valign="top">
181
 
<tbody>
182
 
<tr>
183
 
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
184
 
<td>A calendar factory.
185
 
</td>
186
 
</tr>
187
 
<tr>
188
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
189
 
<td> the number of backends.
190
 
</td>
191
 
</tr>
192
 
</tbody>
193
 
</table></div>
194
 
</div>
195
 
<hr>
196
 
<div class="refsect2" lang="en">
197
 
<a name="e-data-cal-factory-dump-active-backends"></a><h3>e_data_cal_factory_dump_active_backends ()</h3>
198
 
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_cal_factory_dump_active_backends
199
 
                                                        (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>);</pre>
200
 
<p>
201
 
Dumps to standard output a list of all active backends for the given
202
 
factory.</p>
203
 
<div class="variablelist"><table border="0">
204
 
<col align="left" valign="top">
205
 
<tbody><tr>
206
 
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
207
 
<td>A calendar factory.
208
 
</td>
209
 
</tr></tbody>
210
 
</table></div>
211
 
</div>
212
 
<hr>
213
 
<div class="refsect2" lang="en">
214
 
<a name="e-data-cal-factory-set-backend-mode"></a><h3>e_data_cal_factory_set_backend_mode ()</h3>
215
 
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_cal_factory_set_backend_mode (<em class="parameter"><code><a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *factory</code></em>,
216
 
                                                         <em class="parameter"><code><span class="type">gint</span> mode</code></em>);</pre>
217
 
<p>
218
 
Sets the online mode for all backends created by the given factory.</p>
219
 
<div class="variablelist"><table border="0">
220
 
<col align="left" valign="top">
221
 
<tbody>
222
 
<tr>
223
 
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
224
 
<td>A calendar factory.
225
 
</td>
226
 
</tr>
227
 
<tr>
228
 
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
229
 
<td>Online mode to set.
230
 
</td>
231
 
</tr>
232
 
</tbody>
233
 
</table></div>
234
 
</div>
235
 
</div>
236
 
<div class="refsect1" lang="en">
237
 
<a name="EDataCalFactory.signal-details"></a><h2>Signal Details</h2>
238
 
<div class="refsect2" lang="en">
239
 
<a name="EDataCalFactory-last-calendar-gone"></a><h3>The <code class="literal">"last-calendar-gone"</code> signal</h3>
240
 
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="EDataCalFactory.html" title="EDataCalFactory"><span class="type">EDataCalFactory</span></a> *edatacalfactory,
241
 
                                                        <span class="type">gpointer</span>         user_data)            : Run First</pre>
242
 
<p>
243
 
</p>
244
 
<div class="variablelist"><table border="0">
245
 
<col align="left" valign="top">
246
 
<tbody>
247
 
<tr>
248
 
<td><p><span class="term"><em class="parameter"><code>edatacalfactory</code></em> :</span></p></td>
249
 
<td>the object which received the signal.
250
 
</td>
251
 
</tr>
252
 
<tr>
253
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
254
 
<td>user data set when the signal handler was connected.</td>
255
 
</tr>
256
 
</tbody>
257
 
</table></div>
258
 
</div>
259
 
</div>
260
 
</div>
261
 
<div class="footer">
262
 
<hr>
263
 
          Generated by GTK-Doc V1.14</div>
264
 
</body>
265
 
</html>
 
 
b'\\ No newline at end of file'