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
|
<?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-e-data-cal-common">
<refmeta>
<refentrytitle role="top_of_page">e-data-cal-common</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATA-CAL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>e-data-cal-common</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="ECalBackend"/><anchor id="EDataCal"/><anchor id="EDataCalView"/><anchor id="ECalBackendSExp"/>
<synopsis>
<link linkend="ECalBackend-struct">ECalBackend</link>;
<link linkend="ECalBackendClass">ECalBackendClass</link>;
<link linkend="EDataCal-struct">EDataCal</link>;
<link linkend="EDataCalClass">EDataCalClass</link>;
<link linkend="EDataCalView-struct">EDataCalView</link>;
<link linkend="EDataCalViewClass">EDataCalViewClass</link>;
<link linkend="ECalBackendSExp-struct">ECalBackendSExp</link>;
<link linkend="ECalBackendSExpClass">ECalBackendSExpClass</link>;
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----ECalBackend
</synopsis>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="BonoboObject">BonoboObject</link>
+----EDataCal
</synopsis>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="BonoboObject">BonoboObject</link>
+----EDataCalView
</synopsis>
<synopsis>
<link linkend="GObject">GObject</link>
+----ECalBackendSExp
</synopsis>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="ECalBackend--kind">kind</link>" <link linkend="gulong">gulong</link> : Read / Write / Construct Only
"<link linkend="ECalBackend--source">source</link>" <link linkend="ESource">ESource</link> : Read / Write / Construct Only
"<link linkend="ECalBackend--uri">uri</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
"<link linkend="EDataCalView--backend">backend</link>" <link linkend="ECalBackend">ECalBackend</link> : Read / Write / Construct Only
"<link linkend="EDataCalView--listener">listener</link>" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only
"<link linkend="EDataCalView--sexp">sexp</link>" <link linkend="ECalBackendSExp">ECalBackendSExp</link> : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="ECalBackend-last-client-gone">last-client-gone</link>"
<link linkend="void">void</link> user_function (<link linkend="ECalBackend">ECalBackend</link> *ecalbackend,
<link linkend="gpointer">gpointer</link> user_data) : Run first
"<link linkend="ECalBackend-opened">opened</link>" <link linkend="void">void</link> user_function (<link linkend="ECalBackend">ECalBackend</link> *ecalbackend,
<link linkend="gint">gint</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run first
"<link linkend="ECalBackend-removed">removed</link>" <link linkend="void">void</link> user_function (<link linkend="ECalBackend">ECalBackend</link> *ecalbackend,
<link linkend="gint">gint</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run first
</synopsis>
</refsect1>
<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="ECalBackend-struct" role="struct"/>ECalBackend</title>
<indexterm><primary>ECalBackend</primary></indexterm><programlisting>typedef struct _ECalBackend ECalBackend;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="ECalBackendClass" role="struct"/>ECalBackendClass</title>
<indexterm><primary>ECalBackendClass</primary></indexterm><programlisting>typedef struct {
GObjectClass parent_class;
/* Notification signals */
void (* last_client_gone) (ECalBackend *backend);
void (* cal_added) (ECalBackend *backend, EDataCal *cal);
gboolean (* is_loaded) (ECalBackend *backend);
/* FIXME What to pass back here */
void (* opened) (ECalBackend *backend, int status);
void (* removed) (ECalBackend *backend, int status);
void (* obj_updated) (ECalBackend *backend, const char *uid);
/* Virtual methods */
void (* is_read_only) (ECalBackend *backend, EDataCal *cal);
void (* get_cal_address) (ECalBackend *backend, EDataCal *cal);
void (* get_alarm_email_address) (ECalBackend *backend, EDataCal *cal);
void (* get_ldap_attribute) (ECalBackend *backend, EDataCal *cal);
void (* get_static_capabilities) (ECalBackend *backend, EDataCal *cal);
void (* open) (ECalBackend *backend, EDataCal *cal, gboolean only_if_exists, const char *username, const char *password);
void (* remove) (ECalBackend *backend, EDataCal *cal);
/* Object related virtual methods */
void (* create_object) (ECalBackend *backend, EDataCal *cal, const char *calobj);
void (* modify_object) (ECalBackend *backend, EDataCal *cal, const char *calobj, CalObjModType mod);
void (* remove_object) (ECalBackend *backend, EDataCal *cal, const char *uid, const char *rid, CalObjModType mod);
void (* discard_alarm) (ECalBackend *backend, EDataCal *cal, const char *uid, const char *auid);
void (* receive_objects) (ECalBackend *backend, EDataCal *cal, const char *calobj);
void (* send_objects) (ECalBackend *backend, EDataCal *cal, const char *calobj);
void (* get_default_object) (ECalBackend *backend, EDataCal *cal);
void (* get_object) (ECalBackend *backend, EDataCal *cal, const char *uid, const char *rid);
void (* get_object_list) (ECalBackend *backend, EDataCal *cal, const char *sexp);
void (* get_attachment_list) (ECalBackend *backend, EDataCal *cal, const char *uid, const char *rid);
/* Timezone related virtual methods */
void (* get_timezone) (ECalBackend *backend, EDataCal *cal, const char *tzid);
void (* add_timezone) (ECalBackend *backend, EDataCal *cal, const char *object);
void (* set_default_timezone) (ECalBackend *backend, EDataCal *cal, const char *tzid);
void (* start_query) (ECalBackend *backend, EDataCalView *query);
/* Mode relate virtual methods */
CalMode (* get_mode) (ECalBackend *backend);
void (* set_mode) (ECalBackend *backend, CalMode mode);
void (* get_free_busy) (ECalBackend *backend, EDataCal *cal, GList *users, time_t start, time_t end);
void (* get_changes) (ECalBackend *backend, EDataCal *cal, const char *change_id);
/* Internal methods for use only in the pcs */
icaltimezone *(* internal_get_default_timezone) (ECalBackend *backend);
icaltimezone *(* internal_get_timezone) (ECalBackend *backend, const char *tzid);
} ECalBackendClass;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="EDataCal-struct" role="struct"/>EDataCal</title>
<indexterm><primary>EDataCal</primary></indexterm><programlisting>typedef struct _EDataCal EDataCal;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="EDataCalClass" role="struct"/>EDataCalClass</title>
<indexterm><primary>EDataCalClass</primary></indexterm><programlisting>typedef struct {
BonoboObjectClass parent_class;
POA_GNOME_Evolution_Calendar_Cal__epv epv;
} EDataCalClass;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="EDataCalView-struct" role="struct"/>EDataCalView</title>
<indexterm><primary>EDataCalView</primary></indexterm><programlisting>typedef struct _EDataCalView EDataCalView;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="EDataCalViewClass" role="struct"/>EDataCalViewClass</title>
<indexterm><primary>EDataCalViewClass</primary></indexterm><programlisting>typedef struct {
BonoboObjectClass parent_class;
POA_GNOME_Evolution_Calendar_CalView__epv epv;
} EDataCalViewClass;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="ECalBackendSExp-struct" role="struct"/>ECalBackendSExp</title>
<indexterm><primary>ECalBackendSExp</primary></indexterm><programlisting>typedef struct _ECalBackendSExp ECalBackendSExp;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="ECalBackendSExpClass" role="struct"/>ECalBackendSExpClass</title>
<indexterm><primary>ECalBackendSExpClass</primary></indexterm><programlisting>typedef struct {
GObjectClass parent_class;
} ECalBackendSExpClass;
</programlisting>
<para>
</para></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="ECalBackend--kind"/>The "<literal>kind</literal>" property</title>
<indexterm><primary>ECalBackend:kind</primary></indexterm><programlisting> "kind" <link linkend="gulong">gulong</link> : Read / Write / Construct Only</programlisting>
<para></para><para>Allowed values: <= 25</para>
</refsect2>
<refsect2><title><anchor id="ECalBackend--source"/>The "<literal>source</literal>" property</title>
<indexterm><primary>ECalBackend:source</primary></indexterm><programlisting> "source" <link linkend="ESource">ESource</link> : Read / Write / Construct Only</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="ECalBackend--uri"/>The "<literal>uri</literal>" property</title>
<indexterm><primary>ECalBackend:uri</primary></indexterm><programlisting> "uri" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
<para></para><para>Default value: ""</para>
</refsect2>
<refsect2><title><anchor id="EDataCalView--backend"/>The "<literal>backend</literal>" property</title>
<indexterm><primary>EDataCalView:backend</primary></indexterm><programlisting> "backend" <link linkend="ECalBackend">ECalBackend</link> : Read / Write / Construct Only</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="EDataCalView--listener"/>The "<literal>listener</literal>" property</title>
<indexterm><primary>EDataCalView:listener</primary></indexterm><programlisting> "listener" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="EDataCalView--sexp"/>The "<literal>sexp</literal>" property</title>
<indexterm><primary>EDataCalView:sexp</primary></indexterm><programlisting> "sexp" <link linkend="ECalBackendSExp">ECalBackendSExp</link> : Read / Write / Construct Only</programlisting>
<para></para></refsect2>
</refsect1>
<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="ECalBackend-last-client-gone"/>The "last-client-gone" signal</title>
<indexterm><primary>ECalBackend::last-client-gone</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="ECalBackend">ECalBackend</link> *ecalbackend,
<link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ecalbackend</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="ECalBackend-opened"/>The "opened" signal</title>
<indexterm><primary>ECalBackend::opened</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="ECalBackend">ECalBackend</link> *ecalbackend,
<link linkend="gint">gint</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ecalbackend</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="ECalBackend-removed"/>The "removed" signal</title>
<indexterm><primary>ECalBackend::removed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="ECalBackend">ECalBackend</link> *ecalbackend,
<link linkend="gint">gint</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ecalbackend</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
