/usr/share/gtk-doc/html/libecal/libecal-e-cal-recur.html is in libecal1.2-dev 3.2.3-0ubuntu6.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-cal-recur</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.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="libecal-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.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libecal-ECalComponent.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-Data-Server Manual: Calendar Client (libecal)</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">
<a href="#libecal-e-cal-recur.synopsis" class="shortcut">Top</a>
|
<a href="#libecal-e-cal-recur.description" class="shortcut">Description</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libecal-e-cal-recur.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">gboolean</span> (<a class="link" href="libecal-e-cal-recur.html#ECalRecurInstanceFn" title="ECalRecurInstanceFn ()">*ECalRecurInstanceFn</a>) (<em class="parameter"><code><a class="link" href="libecal-ECalComponent.html#ECalComponent" title="struct 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><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">icaltimezone</span> * (<a class="link" href="libecal-e-cal-recur.html#ECalRecurResolveTimezoneFn" title="ECalRecurResolveTimezoneFn ()">*ECalRecurResolveTimezoneFn</a>) (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">void</span> <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> (<em class="parameter"><code><a class="link" href="libecal-ECalComponent.html#ECalComponent" title="struct 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><span class="type">gpointer</span> 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><span class="type">gpointer</span> tz_cb_data</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *default_timezone</code></em>);
<span class="returnvalue">time_t</span> <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> (<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><span class="type">gboolean</span> convert_end_date</code></em>);
<span class="returnvalue">gboolean</span> <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> (<em class="parameter"><code><a class="link" href="libecal-ECalComponent.html#ECalComponent" title="struct ECalComponent"><span class="type">ECalComponent</span></a> *comp</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> 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><span class="type">gpointer</span> tz_cb_data</code></em>);
const <span class="returnvalue">gchar</span> ** <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> (<em class="parameter"><code><span class="type">void</span></code></em>);
#define <a class="link" href="libecal-e-cal-recur.html#e-cal-recur-nth" title="e_cal_recur_nth">e_cal_recur_nth</a>
</pre>
</div>
<div class="refsect1">
<a name="libecal-e-cal-recur.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libecal-e-cal-recur.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ECalRecurInstanceFn"></a><h3>ECalRecurInstanceFn ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> (*ECalRecurInstanceFn) (<em class="parameter"><code><a class="link" href="libecal-ECalComponent.html#ECalComponent" title="struct 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><span class="type">gpointer</span> data</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ECalRecurResolveTimezoneFn"></a><h3>ECalRecurResolveTimezoneFn ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> * (*ECalRecurResolveTimezoneFn) (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
</p>
</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="libecal-ECalComponent.html#ECalComponent" title="struct 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><span class="type">gpointer</span> 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><span class="type">gpointer</span> 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 & 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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
<td>A calendar component object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td>
<td>Range start time.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
<td>Range end time.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cb</code></em> :</span></p></td>
<td>Callback function.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cb_data</code></em> :</span></p></td>
<td>Closure data for the callback function.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tz_cb</code></em> :</span></p></td>
<td>Callback for retrieving timezones.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tz_cb_data</code></em> :</span></p></td>
<td>Closure data for the timezone callback.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>default_timezone</code></em> :</span></p></td>
<td>Default timezone to use when a timezone cannot be
found.</td>
</tr>
</tbody>
</table></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><span class="type">gboolean</span> convert_end_date</code></em>);</pre>
<p>
</p>
</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"><span class="returnvalue">gboolean</span> e_cal_recur_ensure_end_dates (<em class="parameter"><code><a class="link" href="libecal-ECalComponent.html#ECalComponent" title="struct ECalComponent"><span class="type">ECalComponent</span></a> *comp</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> 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><span class="type">gpointer</span> tz_cb_data</code></em>);</pre>
<p>
This recalculates the end dates for recurrence & exception rules which use
the COUNT property. If <em class="parameter"><code>refresh</code></em> is <code class="literal">TRUE</code> it will recalculate all enddates
for rules which use COUNT. If <em class="parameter"><code>refresh</code></em> is <code class="literal">FALSE</code>, it will only calculate
the enddate if it hasn't already been set. It returns <code class="literal">TRUE</code> 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>
<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 <span class="returnvalue">gchar</span> ** 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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to an array of strings. This array is static, do not free it.</td>
</tr></tbody>
</table></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>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|