evolution-data-server-doc 3.10.4-0ubuntu1.6 / usr / share / gtk-doc / html / libecal / libecal-e-cal-recur.html

This file is indexed.

/usr/share/gtk-doc/html/libecal/libecal-e-cal-recur.html is in evolution-data-server-doc 3.10.4-0ubuntu1.6.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Evolution-Data-Server Manual: Calendar Client (libecal): e-cal-recur</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
<link rel="prev" href="ECalComponent.html" title="ECalComponent">
<link rel="next" href="libecal-e-cal-time-util.html" title="e-cal-time-util">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#libecal-e-cal-recur.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#libecal-e-cal-recur.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ECalComponent.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libecal-e-cal-time-util.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libecal-e-cal-recur"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libecal-e-cal-recur.top_of_page"></a>e-cal-recur</span></h2>
<p>e-cal-recur</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libecal-e-cal-recur.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libecal-e-cal-recur.html#ECalRecurInstanceFn" title="ECalRecurInstanceFn ()">*ECalRecurInstanceFn</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">icaltimezone</span> *
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libecal-e-cal-recur.html#ECalRecurResolveTimezoneFn" title="ECalRecurResolveTimezoneFn ()">*ECalRecurResolveTimezoneFn</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libecal-e-cal-recur.html#e-cal-recur-generate-instances" title="e_cal_recur_generate_instances ()">e_cal_recur_generate_instances</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">time_t</span>
</td>
<td class="function_name">
<a class="link" href="libecal-e-cal-recur.html#e-cal-recur-obtain-enddate" title="e_cal_recur_obtain_enddate ()">e_cal_recur_obtain_enddate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libecal-e-cal-recur.html#e-cal-recur-ensure-end-dates" title="e_cal_recur_ensure_end_dates ()">e_cal_recur_ensure_end_dates</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
</td>
<td class="function_name">
<a class="link" href="libecal-e-cal-recur.html#e-cal-get-recur-nth" title="e_cal_get_recur_nth ()">e_cal_get_recur_nth</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libecal-e-cal-recur.html#e-cal-recur-nth" title="e_cal_recur_nth">e_cal_recur_nth</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libecal-e-cal-recur.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="libecal-e-cal-recur.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libecal-e-cal-recur.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ECalRecurInstanceFn"></a><h3>ECalRecurInstanceFn ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
<span class="c_punctuation">(</span>*ECalRecurInstanceFn<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="ECalComponent.html" title="ECalComponent"><span class="type">ECalComponent</span></a> *comp</code></em>,
                        <em class="parameter"><code><span class="type">time_t</span> instance_start</code></em>,
                        <em class="parameter"><code><span class="type">time_t</span> instance_end</code></em>,
                        <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="ECalRecurResolveTimezoneFn"></a><h3>ECalRecurResolveTimezoneFn ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> *
<span class="c_punctuation">(</span>*ECalRecurResolveTimezoneFn<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tzid</code></em>,
                               <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-recur-generate-instances"></a><h3>e_cal_recur_generate_instances ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_cal_recur_generate_instances (<em class="parameter"><code><a class="link" href="ECalComponent.html" title="ECalComponent"><span class="type">ECalComponent</span></a> *comp</code></em>,
                                <em class="parameter"><code><span class="type">time_t</span> start</code></em>,
                                <em class="parameter"><code><span class="type">time_t</span> end</code></em>,
                                <em class="parameter"><code><a class="link" href="libecal-e-cal-recur.html#ECalRecurInstanceFn" title="ECalRecurInstanceFn ()"><span class="type">ECalRecurInstanceFn</span></a> cb</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> cb_data</code></em>,
                                <em class="parameter"><code><a class="link" href="libecal-e-cal-recur.html#ECalRecurResolveTimezoneFn" title="ECalRecurResolveTimezoneFn ()"><span class="type">ECalRecurResolveTimezoneFn</span></a> tz_cb</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> tz_cb_data</code></em>,
                                <em class="parameter"><code><span class="type">icaltimezone</span> *default_timezone</code></em>);</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 &amp; 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>
<div class="refsect3">
<a name="id-1.2.5.6.4.9"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>comp</p></td>
<td class="parameter_description"><p>A calendar component object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start</p></td>
<td class="parameter_description"><p>Range start time</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end</p></td>
<td class="parameter_description"><p>Range end time</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cb</p></td>
<td class="parameter_description"><p> Callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym> cb_data][<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cb_data</p></td>
<td class="parameter_description"><p> Closure data for the callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>tz_cb</p></td>
<td class="parameter_description"><p> Callback for retrieving timezones. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym> tz_cb_data][<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>tz_cb_data</p></td>
<td class="parameter_description"><p> Closure data for the timezone callback. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>default_timezone</p></td>
<td class="parameter_description"><p>Default timezone to use when a timezone cannot be
found</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-recur-obtain-enddate"></a><h3>e_cal_recur_obtain_enddate ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span>
e_cal_recur_obtain_enddate (<em class="parameter"><code><span class="type">struct icalrecurrencetype</span> *ir</code></em>,
                            <em class="parameter"><code><span class="type">icalproperty</span> *prop</code></em>,
                            <em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>,
                            <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> convert_end_date</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-recur-ensure-end-dates"></a><h3>e_cal_recur_ensure_end_dates ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cal_recur_ensure_end_dates (<em class="parameter"><code><a class="link" href="ECalComponent.html" title="ECalComponent"><span class="type">ECalComponent</span></a> *comp</code></em>,
                              <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> refresh</code></em>,
                              <em class="parameter"><code><a class="link" href="libecal-e-cal-recur.html#ECalRecurResolveTimezoneFn" title="ECalRecurResolveTimezoneFn ()"><span class="type">ECalRecurResolveTimezoneFn</span></a> tz_cb</code></em>,
                              <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> tz_cb_data</code></em>);</pre>
<p>This recalculates the end dates for recurrence &amp; exception rules which use
the COUNT property. If <em class="parameter"><code>refresh</code></em>
 is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> it will recalculate all enddates
for rules which use COUNT. If <em class="parameter"><code>refresh</code></em>
 is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, it will only calculate
the enddate if it hasn't already been set. It returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the component
was changed, i.e. if the component should be saved at some point.
We store the enddate in the "X-EVOLUTION-ENDDATE" parameter of the RRULE
or EXRULE.</p>
<div class="refsect3">
<a name="id-1.2.5.6.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>comp</p></td>
<td class="parameter_description"><p>an <a class="link" href="ECalComponent.html" title="ECalComponent"><span class="type">ECalComponent</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>refresh</p></td>
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to recalculate all end dates</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tz_cb</p></td>
<td class="parameter_description"><p> function to call to resolve
timezones. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym> tz_cb_data][<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>tz_cb_data</p></td>
<td class="parameter_description"><p> data to pass to <em class="parameter"><code>tz_cb</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.6.6.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the component was changed, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
<p></p>
</div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-get-recur-nth"></a><h3>e_cal_get_recur_nth ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
e_cal_get_recur_nth (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns an array of 31 translated strings for each day of the month
(i.e. "1st", "2nd", and so on).</p>
<div class="refsect3">
<a name="id-1.2.5.6.7.5"></a><h4>Returns</h4>
<p> a pointer to an array of strings.  This array is static, do not free it.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-recur-nth"></a><h3>e_cal_recur_nth</h3>
<pre class="programlisting">#define e_cal_recur_nth (e_cal_get_recur_nth ())
</pre>
<p>An array of 31 translated strings for each day of the month (i.e. "1st",
"2nd", and so on).</p>
</div>
</div>
<div class="refsect1">
<a name="libecal-e-cal-recur.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.