/usr/share/gtk-doc/html/libedata-cal/libedata-cal-ECalBackendSExp.html is in libedata-cal1.2-dev 3.2.3-0ubuntu7.1.
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 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ECalBackendSExp</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Calendar Backend (libedata-cal)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Calendar Backend (libedata-cal)">
<link rel="prev" href="libedata-cal-ECalBackendFactory.html" title="ECalBackendFactory">
<link rel="next" href="libedata-cal-ECalBackendStore.html" title="ECalBackendStore">
<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="libedata-cal-ECalBackendFactory.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 Backend (libedata-cal)</th>
<td><a accesskey="n" href="libedata-cal-ECalBackendStore.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libedata-cal-ECalBackendSExp.synopsis" class="shortcut">Top</a>
|
<a href="#libedata-cal-ECalBackendSExp.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libedata-cal-ECalBackendSExp"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libedata-cal-ECalBackendSExp.top_of_page"></a>ECalBackendSExp</span></h2>
<p>ECalBackendSExp</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libedata-cal-ECalBackendSExp.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">ECalBackendSExp</span> * <a class="link" href="libedata-cal-ECalBackendSExp.html#e-cal-backend-sexp-new" title="e_cal_backend_sexp_new ()">e_cal_backend_sexp_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="libedata-cal-ECalBackendSExp.html#e-cal-backend-sexp-text" title="e_cal_backend_sexp_text ()">e_cal_backend_sexp_text</a> (<em class="parameter"><code><span class="type">ECalBackendSExp</span> *sexp</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedata-cal-ECalBackendSExp.html#e-cal-backend-sexp-match-object" title="e_cal_backend_sexp_match_object ()">e_cal_backend_sexp_match_object</a> (<em class="parameter"><code><span class="type">ECalBackendSExp</span> *sexp</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *object</code></em>,
<em class="parameter"><code><a class="link" href="libedata-cal-ECalBackend.html#ECalBackend" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedata-cal-ECalBackendSExp.html#e-cal-backend-sexp-match-comp" title="e_cal_backend_sexp_match_comp ()">e_cal_backend_sexp_match_comp</a> (<em class="parameter"><code><span class="type">ECalBackendSExp</span> *sexp</code></em>,
<em class="parameter"><code><span class="type">ECalComponent</span> *comp</code></em>,
<em class="parameter"><code><a class="link" href="libedata-cal-ECalBackend.html#ECalBackend" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>);
<span class="returnvalue">ESExpResult</span> * <a class="link" href="libedata-cal-ECalBackendSExp.html#e-cal-backend-sexp-func-time-now" title="e_cal_backend_sexp_func_time_now ()">e_cal_backend_sexp_func_time_now</a> (<em class="parameter"><code><span class="type">ESExp</span> *esexp</code></em>,
<em class="parameter"><code><span class="type">gint</span> argc</code></em>,
<em class="parameter"><code><span class="type">ESExpResult</span> **argv</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">ESExpResult</span> * <a class="link" href="libedata-cal-ECalBackendSExp.html#e-cal-backend-sexp-func-make-time" title="e_cal_backend_sexp_func_make_time ()">e_cal_backend_sexp_func_make_time</a> (<em class="parameter"><code><span class="type">ESExp</span> *esexp</code></em>,
<em class="parameter"><code><span class="type">gint</span> argc</code></em>,
<em class="parameter"><code><span class="type">ESExpResult</span> **argv</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">ESExpResult</span> * <a class="link" href="libedata-cal-ECalBackendSExp.html#e-cal-backend-sexp-func-time-add-day" title="e_cal_backend_sexp_func_time_add_day ()">e_cal_backend_sexp_func_time_add_day</a>
(<em class="parameter"><code><span class="type">ESExp</span> *esexp</code></em>,
<em class="parameter"><code><span class="type">gint</span> argc</code></em>,
<em class="parameter"><code><span class="type">ESExpResult</span> **argv</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">ESExpResult</span> * <a class="link" href="libedata-cal-ECalBackendSExp.html#e-cal-backend-sexp-func-time-day-begin" title="e_cal_backend_sexp_func_time_day_begin ()">e_cal_backend_sexp_func_time_day_begin</a>
(<em class="parameter"><code><span class="type">ESExp</span> *esexp</code></em>,
<em class="parameter"><code><span class="type">gint</span> argc</code></em>,
<em class="parameter"><code><span class="type">ESExpResult</span> **argv</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">ESExpResult</span> * <a class="link" href="libedata-cal-ECalBackendSExp.html#e-cal-backend-sexp-func-time-day-end" title="e_cal_backend_sexp_func_time_day_end ()">e_cal_backend_sexp_func_time_day_end</a>
(<em class="parameter"><code><span class="type">ESExp</span> *esexp</code></em>,
<em class="parameter"><code><span class="type">gint</span> argc</code></em>,
<em class="parameter"><code><span class="type">ESExpResult</span> **argv</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedata-cal-ECalBackendSExp.html#e-cal-backend-sexp-evaluate-occur-times" title="e_cal_backend_sexp_evaluate_occur_times ()">e_cal_backend_sexp_evaluate_occur_times</a>
(<em class="parameter"><code><span class="type">ECalBackendSExp</span> *sexp</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>);
</pre>
</div>
<div class="refsect1">
<a name="libedata-cal-ECalBackendSExp.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libedata-cal-ECalBackendSExp.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="e-cal-backend-sexp-new"></a><h3>e_cal_backend_sexp_new ()</h3>
<pre class="programlisting"><span class="returnvalue">ECalBackendSExp</span> * e_cal_backend_sexp_new (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-sexp-text"></a><h3>e_cal_backend_sexp_text ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_cal_backend_sexp_text (<em class="parameter"><code><span class="type">ECalBackendSExp</span> *sexp</code></em>);</pre>
<p>
Retrieve the text expression for the given ECalBackendSExp object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sexp</code></em> :</span></p></td>
<td>An <span class="type">ECalBackendSExp</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The text expression.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-sexp-match-object"></a><h3>e_cal_backend_sexp_match_object ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_cal_backend_sexp_match_object (<em class="parameter"><code><span class="type">ECalBackendSExp</span> *sexp</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *object</code></em>,
<em class="parameter"><code><a class="link" href="libedata-cal-ECalBackend.html#ECalBackend" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>);</pre>
<p>
Match an iCalendar expression against the expression.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sexp</code></em> :</span></p></td>
<td>An <span class="type">ESExp</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>An iCalendar string.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td>A backend.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the object matches the expression, FALSE if not.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-sexp-match-comp"></a><h3>e_cal_backend_sexp_match_comp ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_cal_backend_sexp_match_comp (<em class="parameter"><code><span class="type">ECalBackendSExp</span> *sexp</code></em>,
<em class="parameter"><code><span class="type">ECalComponent</span> *comp</code></em>,
<em class="parameter"><code><a class="link" href="libedata-cal-ECalBackend.html#ECalBackend" title="ECalBackend"><span class="type">ECalBackend</span></a> *backend</code></em>);</pre>
<p>
Matches the given ECalComponent against the expression.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sexp</code></em> :</span></p></td>
<td>An <span class="type">ESExp</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
<td>Component to match against the expression.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td>Backend.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the component matched the expression, FALSE if not.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-sexp-func-time-now"></a><h3>e_cal_backend_sexp_func_time_now ()</h3>
<pre class="programlisting"><span class="returnvalue">ESExpResult</span> * e_cal_backend_sexp_func_time_now (<em class="parameter"><code><span class="type">ESExp</span> *esexp</code></em>,
<em class="parameter"><code><span class="type">gint</span> argc</code></em>,
<em class="parameter"><code><span class="type">ESExpResult</span> **argv</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
Processes the (time-now) sexp expression.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>esexp</code></em> :</span></p></td>
<td>An <span class="type">ESExp</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Number of arguments.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>The arguments.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Closure data.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The result of the function.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-sexp-func-make-time"></a><h3>e_cal_backend_sexp_func_make_time ()</h3>
<pre class="programlisting"><span class="returnvalue">ESExpResult</span> * e_cal_backend_sexp_func_make_time (<em class="parameter"><code><span class="type">ESExp</span> *esexp</code></em>,
<em class="parameter"><code><span class="type">gint</span> argc</code></em>,
<em class="parameter"><code><span class="type">ESExpResult</span> **argv</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
(make-time ISODATE)
ISODATE - string, ISO 8601 date/time representation
</p>
<p>
Constructs a time_t value for the specified date.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>esexp</code></em> :</span></p></td>
<td>An <span class="type">ESExp</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Number of arguments.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>The arguments.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Closure data.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The result of the function.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-sexp-func-time-add-day"></a><h3>e_cal_backend_sexp_func_time_add_day ()</h3>
<pre class="programlisting"><span class="returnvalue">ESExpResult</span> * e_cal_backend_sexp_func_time_add_day
(<em class="parameter"><code><span class="type">ESExp</span> *esexp</code></em>,
<em class="parameter"><code><span class="type">gint</span> argc</code></em>,
<em class="parameter"><code><span class="type">ESExpResult</span> **argv</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
(time-add-day TIME N)
TIME - time_t, base time
N - int, number of days to add
</p>
<p>
Adds the specified number of days to a time value.
</p>
<p>
FIXME: TIMEZONES - need to use a timezone or daylight saving changes will
make the result incorrect.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>esexp</code></em> :</span></p></td>
<td>An <span class="type">ESExp</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Number of arguments.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>The arguments.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Closure data.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The result of the function.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-sexp-func-time-day-begin"></a><h3>e_cal_backend_sexp_func_time_day_begin ()</h3>
<pre class="programlisting"><span class="returnvalue">ESExpResult</span> * e_cal_backend_sexp_func_time_day_begin
(<em class="parameter"><code><span class="type">ESExp</span> *esexp</code></em>,
<em class="parameter"><code><span class="type">gint</span> argc</code></em>,
<em class="parameter"><code><span class="type">ESExpResult</span> **argv</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
(time-day-begin TIME)
TIME - time_t, base time
</p>
<p>
Returns the start of the day, according to the local time.
</p>
<p>
FIXME: TIMEZONES - this uses the current Unix timezone.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>esexp</code></em> :</span></p></td>
<td>An <span class="type">ESExp</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Number of arguments.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>The arguments.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Closure data.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The result of the function.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-sexp-func-time-day-end"></a><h3>e_cal_backend_sexp_func_time_day_end ()</h3>
<pre class="programlisting"><span class="returnvalue">ESExpResult</span> * e_cal_backend_sexp_func_time_day_end
(<em class="parameter"><code><span class="type">ESExp</span> *esexp</code></em>,
<em class="parameter"><code><span class="type">gint</span> argc</code></em>,
<em class="parameter"><code><span class="type">ESExpResult</span> **argv</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
(time-day-end TIME)
TIME - time_t, base time
</p>
<p>
Returns the end of the day, according to the local time.
</p>
<p>
FIXME: TIMEZONES - this uses the current Unix timezone.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>esexp</code></em> :</span></p></td>
<td>An <span class="type">ESExp</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Number of arguments.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>The arguments.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Closure data.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The result of the function.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-backend-sexp-evaluate-occur-times"></a><h3>e_cal_backend_sexp_evaluate_occur_times ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_cal_backend_sexp_evaluate_occur_times
(<em class="parameter"><code><span class="type">ECalBackendSExp</span> *sexp</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>);</pre>
<p>
Determines biggest time window given by expressions "occur-in-range" in sexp.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sexp</code></em> :</span></p></td>
<td>An <span class="type">ESExp</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td>
<td>Start of the time window will be stored here.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
<td>End of the time window will be stored here.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|