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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>e-cal-recur</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="Evolution API Reference: libecal, the Calendar Library">
<link rel="up" href="ch01.html" title="Evolution API Reference: libecal, the Calendar Library">
<link rel="prev" href="ECal.html" title="ECal">
<link rel="next" href="libecal-e-cal-time-util.html" title="e-cal-time-util">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Evolution API Reference: libecal, the Calendar Library">
</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="ECal.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 API Reference: libecal, the Calendar Library</th>
<td><a accesskey="n" href="libecal-e-cal-time-util.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2551191" class="shortcut">Top</a>
 | 
<a href="#id2544228" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libecal-e-cal-recur"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2551191"></a><span class="refentrytitle">e-cal-recur</span>
</h2>
<p>e-cal-recur — Functions to expand recurrences for recurrent appointments.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> (<a href="libecal-e-cal-recur.html#ECalRecurInstanceFn">*ECalRecurInstanceFn</a>) (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
time_t instance_start,
time_t instance_end,
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
icaltimezone* (<a href="libecal-e-cal-recur.html#ECalRecurResolveTimezoneFn">*ECalRecurResolveTimezoneFn</a>) (const char *tzid,
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
void <a href="libecal-e-cal-recur.html#e-cal-recur-generate-instances">e_cal_recur_generate_instances</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
time_t start,
time_t end,
<a href="libecal-e-cal-recur.html#ECalRecurInstanceFn">ECalRecurInstanceFn</a> cb,
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> cb_data,
<a href="libecal-e-cal-recur.html#ECalRecurResolveTimezoneFn">ECalRecurResolveTimezoneFn</a> tz_cb,
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> tz_cb_data,
icaltimezone *default_timezone);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2544228"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2544243"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2544254"></a><h3>
<a name="ECalRecurInstanceFn"></a>ECalRecurInstanceFn ()</h3>
<a class="indexterm" name="id2544266"></a><pre class="programlisting"><a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> (*ECalRecurInstanceFn) (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
time_t instance_start,
time_t instance_end,
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>comp</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>instance_start</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>instance_end</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2549166"></a><h3>
<a name="ECalRecurResolveTimezoneFn"></a>ECalRecurResolveTimezoneFn ()</h3>
<a class="indexterm" name="id2549177"></a><pre class="programlisting">icaltimezone* (*ECalRecurResolveTimezoneFn) (const char *tzid,
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>tzid</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2549254"></a><h3>
<a name="e-cal-recur-generate-instances"></a>e_cal_recur_generate_instances ()</h3>
<a class="indexterm" name="id2549265"></a><pre class="programlisting">void e_cal_recur_generate_instances (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
time_t start,
time_t end,
<a href="libecal-e-cal-recur.html#ECalRecurInstanceFn">ECalRecurInstanceFn</a> cb,
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> cb_data,
<a href="libecal-e-cal-recur.html#ECalRecurResolveTimezoneFn">ECalRecurResolveTimezoneFn</a> tz_cb,
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> tz_cb_data,
icaltimezone *default_timezone);</pre>
<p>
Calls the given callback function for each occurrence of the event that
intersects the range between the given <em class="parameter"><code>start</code></em> and <em class="parameter"><code>end</code></em> times (the end time is
not included). Note that the occurrences may start before the given start
time.
</p>
<p>
If the callback routine returns FALSE the occurrence generation stops.
</p>
<p>
Both start and end can be -1, in which case we start at the events first
instance and continue until it ends, or forever if it has no enddate.
</p>
<p>
The tz_cb is used to resolve references to timezones. It is passed a TZID
and should return the icaltimezone* corresponding to that TZID. We need to
do this as we access timezones in different ways on the client & server.
</p>
<p>
The default_timezone argument is used for DTSTART or DTEND properties that
are DATE values or do not have a TZID (i.e. floating times).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>comp</code></em> :</span></td>
<td> A calendar component object.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>start</code></em> :</span></td>
<td> Range start time.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>end</code></em> :</span></td>
<td> Range end time.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>cb</code></em> :</span></td>
<td> Callback function.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>cb_data</code></em> :</span></td>
<td> Closure data for the callback function.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>tz_cb</code></em> :</span></td>
<td> Callback for retrieving timezones.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>tz_cb_data</code></em> :</span></td>
<td> Closure data for the timezone callback.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>default_timezone</code></em> :</span></td>
<td> Default timezone to use when a timezone cannot be
found.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
