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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libedata-cal-EDataCalFactory">
<refmeta>
<refentrytitle role="top_of_page">EDataCalFactory</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATA-CAL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>EDataCalFactory</refname>
<refpurpose>Implementation of the calendar CORBA factory.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="EDataCalFactoryPrivate">EDataCalFactoryPrivate</link>;
<link linkend="EDataCalFactory">EDataCalFactory</link>* <link linkend="e-data-cal-factory-new">e_data_cal_factory_new</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="e-data-cal-factory-register-storage">e_data_cal_factory_register_storage</link>
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory,
const <link linkend="char">char</link> *iid);
<link linkend="void">void</link> <link linkend="e-data-cal-factory-register-backend">e_data_cal_factory_register_backend</link>
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory,
<link linkend="ECalBackendFactory">ECalBackendFactory</link> *backend_factory);
<link linkend="void">void</link> <link linkend="e-data-cal-factory-register-backends">e_data_cal_factory_register_backends</link>
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);
<link linkend="int">int</link> <link linkend="e-data-cal-factory-get-n-backends">e_data_cal_factory_get_n_backends</link>
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);
<link linkend="void">void</link> <link linkend="e-data-cal-factory-dump-active-backends">e_data_cal_factory_dump_active_backends</link>
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);
<link linkend="void">void</link> <link linkend="e-data-cal-factory-set-backend-mode">e_data_cal_factory_set_backend_mode</link>
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory,
<link linkend="int">int</link> mode);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="EDataCalFactoryPrivate" role="struct"/>EDataCalFactoryPrivate</title>
<indexterm><primary>EDataCalFactoryPrivate</primary></indexterm><programlisting>typedef struct _EDataCalFactoryPrivate EDataCalFactoryPrivate;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="e-data-cal-factory-new" role="function"/>e_data_cal_factory_new ()</title>
<indexterm><primary>e_data_cal_factory_new</primary></indexterm><programlisting><link linkend="EDataCalFactory">EDataCalFactory</link>* e_data_cal_factory_new (void);</programlisting>
<para>
Creates a new <link linkend="EDataCalFactory"><type>EDataCalFactory</type></link> object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly-created <link linkend="EDataCalFactory"><type>EDataCalFactory</type></link>, or NULL if its corresponding CORBA
object could not be created.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-data-cal-factory-register-storage" role="function"/>e_data_cal_factory_register_storage ()</title>
<indexterm><primary>e_data_cal_factory_register_storage</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_data_cal_factory_register_storage
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory,
const <link linkend="char">char</link> *iid);</programlisting>
<para>
Registers a calendar factory with the OAF object activation daemon. This
function must be called before any clients can activate the factory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter> :</term>
<listitem><simpara> A calendar factory.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iid</parameter> :</term>
<listitem><simpara> OAFIID for the factory to be registered.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-data-cal-factory-register-backend" role="function"/>e_data_cal_factory_register_backend ()</title>
<indexterm><primary>e_data_cal_factory_register_backend</primary></indexterm><programlisting><link linkend="void">void</link> e_data_cal_factory_register_backend
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory,
<link linkend="ECalBackendFactory">ECalBackendFactory</link> *backend_factory);</programlisting>
<para>
Registers an <link linkend="ECalBackend"><type>ECalBackend</type></link> subclass that will be used to handle URIs
with a particular method. When the factory is asked to open a
particular URI, it will look in its list of registered methods and
create a backend of the appropriate type.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter> :</term>
<listitem><simpara> A calendar factory.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>backend_factory</parameter> :</term>
<listitem><simpara> The object responsible for creating backends.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-data-cal-factory-register-backends" role="function"/>e_data_cal_factory_register_backends ()</title>
<indexterm><primary>e_data_cal_factory_register_backends</primary></indexterm><programlisting><link linkend="void">void</link> e_data_cal_factory_register_backends
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);</programlisting>
<para>
Register all backends for the given factory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-data-cal-factory-get-n-backends" role="function"/>e_data_cal_factory_get_n_backends ()</title>
<indexterm><primary>e_data_cal_factory_get_n_backends</primary></indexterm><programlisting><link linkend="int">int</link> e_data_cal_factory_get_n_backends
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);</programlisting>
<para>
Get the number of backends currently active in the given factory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter> :</term>
<listitem><simpara> A calendar factory.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of backends.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-data-cal-factory-dump-active-backends" role="function"/>e_data_cal_factory_dump_active_backends ()</title>
<indexterm><primary>e_data_cal_factory_dump_active_backends</primary></indexterm><programlisting><link linkend="void">void</link> e_data_cal_factory_dump_active_backends
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);</programlisting>
<para>
Dumps to standard output a list of all active backends for the given
factory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter> :</term>
<listitem><simpara> A calendar factory.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-data-cal-factory-set-backend-mode" role="function"/>e_data_cal_factory_set_backend_mode ()</title>
<indexterm><primary>e_data_cal_factory_set_backend_mode</primary></indexterm><programlisting><link linkend="void">void</link> e_data_cal_factory_set_backend_mode
(<link linkend="EDataCalFactory">EDataCalFactory</link> *factory,
<link linkend="int">int</link> mode);</programlisting>
<para>
Sets the online mode for all backends created by the given factory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter> :</term>
<listitem><simpara> A calendar factory.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter> :</term>
<listitem><simpara> Online mode to set.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
