diff options
Diffstat (limited to 'apidocs/icalrecur_8h.html')
| -rw-r--r-- | apidocs/icalrecur_8h.html | 246 |
1 files changed, 140 insertions, 106 deletions
diff --git a/apidocs/icalrecur_8h.html b/apidocs/icalrecur_8h.html index 2fa7fa9e..656d4285 100644 --- a/apidocs/icalrecur_8h.html +++ b/apidocs/icalrecur_8h.html @@ -3,15 +3,16 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.3.1"/> +<meta name="generator" content="Doxygen 1.8.9.1"/> <title>Libical: icalrecur.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); + $(document).ready(function() { init_search(); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> @@ -23,7 +24,7 @@ <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Libical -  <span id="projectnumber">1.0</span> +  <span id="projectnumber">2.0</span> </div> </td> </tr> @@ -31,7 +32,7 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.3.1 --> +<!-- Generated by Doxygen 1.8.9.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> @@ -70,7 +71,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></div> +</div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> @@ -98,8 +99,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); <p>Routines for dealing with recurring time. <a href="#details">More...</a></p> -<div class="textblock"><code>#include <time.h></code><br/> -<code>#include "<a class="el" href="icaltime_8h_source.html">icaltime.h</a>"</code><br/> +<div class="textblock"><code>#include "libical_ical_export.h"</code><br /> +<code>#include "<a class="el" href="icalarray_8h_source.html">icalarray.h</a>"</code><br /> +<code>#include "<a class="el" href="icaltime_8h_source.html">icaltime.h</a>"</code><br /> </div> <p><a href="icalrecur_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> @@ -111,110 +113,139 @@ Data Structures</h2></td></tr> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:a88c777bba1c5287ec7a262a8cf140209"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88c777bba1c5287ec7a262a8cf140209"></a> -#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_DAY_SIZE</b>   364 /* 7 days * 52 weeks */</td></tr> +#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_DAY_SIZE</b>   7*(ICAL_BY_WEEKNO_SIZE-1)+1 /* 1 to N */</td></tr> <tr class="separator:a88c777bba1c5287ec7a262a8cf140209"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af7660eef516049982e6ea1aa56d7a14f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7660eef516049982e6ea1aa56d7a14f"></a> -#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_HOUR_SIZE</b>   25</td></tr> +#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_HOUR_SIZE</b>   25 /* 0 to 23 */</td></tr> <tr class="separator:af7660eef516049982e6ea1aa56d7a14f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1328acf3383993b85d9819702a94dd8a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1328acf3383993b85d9819702a94dd8a"></a> -#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_MINUTE_SIZE</b>   61</td></tr> +#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_MINUTE_SIZE</b>   61 /* 0 to 59 */</td></tr> <tr class="separator:a1328acf3383993b85d9819702a94dd8a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3ba206a293eca6a045c9e24b75516528"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ba206a293eca6a045c9e24b75516528"></a> -#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_MONTH_SIZE</b>   13</td></tr> +#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_MONTH_SIZE</b>   14 /* 1 to 13 */</td></tr> <tr class="separator:a3ba206a293eca6a045c9e24b75516528"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7d6e5cf6656a21e1fede23a4af633f31"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d6e5cf6656a21e1fede23a4af633f31"></a> -#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_MONTHDAY_SIZE</b>   32</td></tr> +#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_MONTHDAY_SIZE</b>   32 /* 1 to 31 */</td></tr> <tr class="separator:a7d6e5cf6656a21e1fede23a4af633f31"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:acec51b2d651f24e31b00627b60b12728"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#acec51b2d651f24e31b00627b60b12728">ICAL_BY_SECOND_SIZE</a>   61</td></tr> +<tr class="memitem:acec51b2d651f24e31b00627b60b12728"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#acec51b2d651f24e31b00627b60b12728">ICAL_BY_SECOND_SIZE</a>   62 /* 0 to 60 */</td></tr> <tr class="separator:acec51b2d651f24e31b00627b60b12728"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8a02214312ee862af943de714ad30c1f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a02214312ee862af943de714ad30c1f"></a> -#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_SETPOS_SIZE</b>   367</td></tr> +#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_SETPOS_SIZE</b>   ICAL_BY_YEARDAY_SIZE /* 1 to N */</td></tr> <tr class="separator:a8a02214312ee862af943de714ad30c1f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a213222b2455537fceb2814e9e084e95a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a213222b2455537fceb2814e9e084e95a"></a> -#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_WEEKNO_SIZE</b>   54</td></tr> +#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_WEEKNO_SIZE</b>   56 /* 1 to 55 */</td></tr> <tr class="separator:a213222b2455537fceb2814e9e084e95a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aad632e88ecae484b09c8ca4be1bfd58b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad632e88ecae484b09c8ca4be1bfd58b"></a> -#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_YEARDAY_SIZE</b>   367</td></tr> +#define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_YEARDAY_SIZE</b>   386 /* 1 to 385 */</td></tr> <tr class="separator:aad632e88ecae484b09c8ca4be1bfd58b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> -<tr class="memitem:a15b0ec0400bb64fcfd625d5a5511db7f"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> -<a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator_impl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a></td></tr> +<tr class="memitem:a15b0ec0400bb64fcfd625d5a5511db7f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator_impl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a></td></tr> <tr class="separator:a15b0ec0400bb64fcfd625d5a5511db7f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa6ee5f3c0bc53d00b6fa3f4c1c062ae0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6ee5f3c0bc53d00b6fa3f4c1c062ae0"></a> -typedef enum <br class="typebreak"/> -icalrecurrencetype_frequency </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_frequency</b></td></tr> +typedef enum icalrecurrencetype_frequency </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_frequency</b></td></tr> <tr class="separator:aa6ee5f3c0bc53d00b6fa3f4c1c062ae0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a13b283c5f2402e6c22f26a7b10737898"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a13b283c5f2402e6c22f26a7b10737898"></a> +typedef enum icalrecurrencetype_skip </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_skip</b></td></tr> +<tr class="separator:a13b283c5f2402e6c22f26a7b10737898"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa2321c0974a3fbeeb9b5d635e697b7b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2321c0974a3fbeeb9b5d635e697b7b7"></a> -typedef enum <br class="typebreak"/> -icalrecurrencetype_weekday </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_weekday</b></td></tr> +typedef enum icalrecurrencetype_weekday </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_weekday</b></td></tr> <tr class="separator:aa2321c0974a3fbeeb9b5d635e697b7b7"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> -<tr class="memitem:abc6126af1d45847bc59afa0aa3216b04"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <b>ICAL_RECURRENCE_ARRAY_MAX</b> = 0x7f7f, +<tr class="memitem:a593dc289d9bb0313584701e0675cf303"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a593dc289d9bb0313584701e0675cf303"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrence_array_max_values</b> { <b>ICAL_RECURRENCE_ARRAY_MAX</b> = 0x7f7f, <b>ICAL_RECURRENCE_ARRAY_MAX_BYTE</b> = 0x7f }</td></tr> -<tr class="separator:abc6126af1d45847bc59afa0aa3216b04"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a203e6ca308804a67ff343837e7c11a61"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_frequency</b> { <br/> -  <b>ICAL_SECONDLY_RECURRENCE</b> =0, -<b>ICAL_MINUTELY_RECURRENCE</b> =1, -<b>ICAL_HOURLY_RECURRENCE</b> =2, -<b>ICAL_DAILY_RECURRENCE</b> =3, -<br/> -  <b>ICAL_WEEKLY_RECURRENCE</b> =4, -<b>ICAL_MONTHLY_RECURRENCE</b> =5, -<b>ICAL_YEARLY_RECURRENCE</b> =6, -<b>ICAL_NO_RECURRENCE</b> =7 -<br/> +<tr class="separator:a593dc289d9bb0313584701e0675cf303"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a203e6ca308804a67ff343837e7c11a61"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a203e6ca308804a67ff343837e7c11a61"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_frequency</b> { <br /> +  <b>ICAL_SECONDLY_RECURRENCE</b> = 0, +<b>ICAL_MINUTELY_RECURRENCE</b> = 1, +<b>ICAL_HOURLY_RECURRENCE</b> = 2, +<b>ICAL_DAILY_RECURRENCE</b> = 3, +<br /> +  <b>ICAL_WEEKLY_RECURRENCE</b> = 4, +<b>ICAL_MONTHLY_RECURRENCE</b> = 5, +<b>ICAL_YEARLY_RECURRENCE</b> = 6, +<b>ICAL_NO_RECURRENCE</b> = 7 +<br /> }</td></tr> <tr class="separator:a203e6ca308804a67ff343837e7c11a61"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a0d3df238238f2689b2cc48b162a9507b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_weekday</b> { <br/> +<tr class="memitem:a46e0128948e7c4c5c1e120061211ddea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46e0128948e7c4c5c1e120061211ddea"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_skip</b> { <b>ICAL_SKIP_BACKWARD</b> = 0, +<b>ICAL_SKIP_FORWARD</b>, +<b>ICAL_SKIP_OMIT</b>, +<b>ICAL_SKIP_UNDEFINED</b> + }</td></tr> +<tr class="separator:a46e0128948e7c4c5c1e120061211ddea"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0d3df238238f2689b2cc48b162a9507b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d3df238238f2689b2cc48b162a9507b"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_weekday</b> { <br />   <b>ICAL_NO_WEEKDAY</b>, <b>ICAL_SUNDAY_WEEKDAY</b>, <b>ICAL_MONDAY_WEEKDAY</b>, <b>ICAL_TUESDAY_WEEKDAY</b>, -<br/> +<br />   <b>ICAL_WEDNESDAY_WEEKDAY</b>, <b>ICAL_THURSDAY_WEEKDAY</b>, <b>ICAL_FRIDAY_WEEKDAY</b>, <b>ICAL_SATURDAY_WEEKDAY</b> -<br/> +<br /> }</td></tr> <tr class="separator:a0d3df238238f2689b2cc48b162a9507b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:a488780da8434731021af8d791b087b77"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a488780da8434731021af8d791b087b77">icalrecur_expand_recurrence</a> (char *rule, time_t start, int count, time_t *array)</td></tr> -<tr class="separator:a488780da8434731021af8d791b087b77"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a8a758c7b3a75d67c28faa7485c45c48f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a758c7b3a75d67c28faa7485c45c48f"></a> -void </td><td class="memItemRight" valign="bottom"><b>icalrecur_iterator_decrement_count</b> (<a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a> *)</td></tr> -<tr class="separator:a8a758c7b3a75d67c28faa7485c45c48f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a14daf9df313fdad9f536a7d9242b4cdc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a14daf9df313fdad9f536a7d9242b4cdc">icalrecur_iterator_free</a> (<a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a> *)</td></tr> -<tr class="separator:a14daf9df313fdad9f536a7d9242b4cdc"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a3259c2b9b03763d8ee02868816d6261a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a3259c2b9b03763d8ee02868816d6261a">icalrecur_iterator_new</a> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> rule, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> dtstart)</td></tr> -<tr class="separator:a3259c2b9b03763d8ee02868816d6261a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2e10af320612cd7ab8c6fb6177ade3e3"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a2e10af320612cd7ab8c6fb6177ade3e3">icalrecur_iterator_next</a> (<a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a> *)</td></tr> -<tr class="separator:a2e10af320612cd7ab8c6fb6177ade3e3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ad60e4e0c33acf7f90dbbf891e2326a8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad60e4e0c33acf7f90dbbf891e2326a8e"></a> -icalrecurrencetype_weekday </td><td class="memItemRight" valign="bottom"><b>icalrecur_string_to_weekday</b> (const char *str)</td></tr> -<tr class="separator:ad60e4e0c33acf7f90dbbf891e2326a8e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a45f67a448ee73729ad1203276434ee52"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45f67a448ee73729ad1203276434ee52"></a> -char * </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_as_string</b> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> *recur)</td></tr> -<tr class="separator:a45f67a448ee73729ad1203276434ee52"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a27204e0666e4e4e3b7d2ef0f159ac5a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27204e0666e4e4e3b7d2ef0f159ac5a3"></a> -char * </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_as_string_r</b> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> *recur)</td></tr> -<tr class="separator:a27204e0666e4e4e3b7d2ef0f159ac5a3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ad1bf76a6221d8aa78387b20a537491ce"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1bf76a6221d8aa78387b20a537491ce"></a> -void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_clear</b> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> *r)</td></tr> -<tr class="separator:ad1bf76a6221d8aa78387b20a537491ce"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a96c160e7e6b16e0e369c540f2ee164c7"><td class="memItemLeft" align="right" valign="top">enum icalrecurrencetype_weekday </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a96c160e7e6b16e0e369c540f2ee164c7">icalrecurrencetype_day_day_of_week</a> (short day)</td></tr> -<tr class="separator:a96c160e7e6b16e0e369c540f2ee164c7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa730e9ac327064456902076b718400f4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#aa730e9ac327064456902076b718400f4">icalrecurrencetype_day_position</a> (short day)</td></tr> -<tr class="separator:aa730e9ac327064456902076b718400f4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a0e8ebcf355ba22299f553f8f5e657926"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a0e8ebcf355ba22299f553f8f5e657926">icalrecurrencetype_from_string</a> (const char *str)</td></tr> -<tr class="separator:a0e8ebcf355ba22299f553f8f5e657926"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1ff36713dbb1bddf333f2c7203886c41"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a1ff36713dbb1bddf333f2c7203886c41">icalrecur_expand_recurrence</a> (char *rule, time_t start, int count, time_t *array)</td></tr> +<tr class="separator:a1ff36713dbb1bddf333f2c7203886c41"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0f5953b3031359bd352c3e2fe769a6de"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f5953b3031359bd352c3e2fe769a6de"></a> +LIBICAL_ICAL_EXPORT const char * </td><td class="memItemRight" valign="bottom"><b>icalrecur_freq_to_string</b> (icalrecurrencetype_frequency kind)</td></tr> +<tr class="separator:a0f5953b3031359bd352c3e2fe769a6de"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaf23abc0ada8b9373ae575ee0ed2964f"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#aaf23abc0ada8b9373ae575ee0ed2964f">icalrecur_iterator_free</a> (<a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a> *)</td></tr> +<tr class="separator:aaf23abc0ada8b9373ae575ee0ed2964f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af93474703998baec72fa81ab76e46673"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT <a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#af93474703998baec72fa81ab76e46673">icalrecur_iterator_new</a> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> rule, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> dtstart)</td></tr> +<tr class="separator:af93474703998baec72fa81ab76e46673"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8b58e5d1eec717d763bbf8843ac5c3d8"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a8b58e5d1eec717d763bbf8843ac5c3d8">icalrecur_iterator_next</a> (<a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a> *)</td></tr> +<tr class="separator:a8b58e5d1eec717d763bbf8843ac5c3d8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a381f703404d81ce2af411ad36ed4348f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a381f703404d81ce2af411ad36ed4348f"></a> +LIBICAL_ICAL_EXPORT const char * </td><td class="memItemRight" valign="bottom"><b>icalrecur_skip_to_string</b> (icalrecurrencetype_skip kind)</td></tr> +<tr class="separator:a381f703404d81ce2af411ad36ed4348f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0e2777324370f88861282321d2728567"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e2777324370f88861282321d2728567"></a> +LIBICAL_ICAL_EXPORT icalrecurrencetype_frequency </td><td class="memItemRight" valign="bottom"><b>icalrecur_string_to_freq</b> (const char *str)</td></tr> +<tr class="separator:a0e2777324370f88861282321d2728567"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a266cf88df4cb05f84421dedddc4ea691"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a266cf88df4cb05f84421dedddc4ea691"></a> +LIBICAL_ICAL_EXPORT icalrecurrencetype_skip </td><td class="memItemRight" valign="bottom"><b>icalrecur_string_to_skip</b> (const char *str)</td></tr> +<tr class="separator:a266cf88df4cb05f84421dedddc4ea691"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7b8c86fb0d1ae8e514f2a613ee568af5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b8c86fb0d1ae8e514f2a613ee568af5"></a> +LIBICAL_ICAL_EXPORT icalrecurrencetype_weekday </td><td class="memItemRight" valign="bottom"><b>icalrecur_string_to_weekday</b> (const char *str)</td></tr> +<tr class="separator:a7b8c86fb0d1ae8e514f2a613ee568af5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac0ab89c3a493e04cc505294a0d7aeaec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0ab89c3a493e04cc505294a0d7aeaec"></a> +LIBICAL_ICAL_EXPORT const char * </td><td class="memItemRight" valign="bottom"><b>icalrecur_weekday_to_string</b> (icalrecurrencetype_weekday kind)</td></tr> +<tr class="separator:ac0ab89c3a493e04cc505294a0d7aeaec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adc7fd2faa22ab242b9c20a5d762864e4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc7fd2faa22ab242b9c20a5d762864e4"></a> +LIBICAL_ICAL_EXPORT char * </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_as_string</b> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> *recur)</td></tr> +<tr class="separator:adc7fd2faa22ab242b9c20a5d762864e4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9551c1360180a3976186dbf81bf15c19"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9551c1360180a3976186dbf81bf15c19"></a> +LIBICAL_ICAL_EXPORT char * </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_as_string_r</b> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> *recur)</td></tr> +<tr class="separator:a9551c1360180a3976186dbf81bf15c19"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7a511d562614cbd58f042d2e38950ff9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a511d562614cbd58f042d2e38950ff9"></a> +LIBICAL_ICAL_EXPORT void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_clear</b> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> *r)</td></tr> +<tr class="separator:a7a511d562614cbd58f042d2e38950ff9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a49948e4a58c1c402b3cc807f5f836f74"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT enum icalrecurrencetype_weekday </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a49948e4a58c1c402b3cc807f5f836f74">icalrecurrencetype_day_day_of_week</a> (short day)</td></tr> +<tr class="separator:a49948e4a58c1c402b3cc807f5f836f74"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad5da4569ae67adc2c341c03d23e166fd"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#ad5da4569ae67adc2c341c03d23e166fd">icalrecurrencetype_day_position</a> (short day)</td></tr> +<tr class="separator:ad5da4569ae67adc2c341c03d23e166fd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af01cc853523e9d6910de3ab9b902b4ba"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#af01cc853523e9d6910de3ab9b902b4ba">icalrecurrencetype_from_string</a> (const char *str)</td></tr> +<tr class="separator:af01cc853523e9d6910de3ab9b902b4ba"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acbfde65897df7e26a0ae3758b17205a7"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#acbfde65897df7e26a0ae3758b17205a7">icalrecurrencetype_month_is_leap</a> (short month)</td></tr> +<tr class="separator:acbfde65897df7e26a0ae3758b17205a7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae259d5fd53932c73d88cff57ce1edd0b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae259d5fd53932c73d88cff57ce1edd0b"></a> +LIBICAL_ICAL_EXPORT int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_month_month</b> (short month)</td></tr> +<tr class="separator:ae259d5fd53932c73d88cff57ce1edd0b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6947e672169d9a31896fb8541b3e2e9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6947e672169d9a31896fb8541b3e2e9c"></a> +LIBICAL_ICAL_EXPORT int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rscale_is_supported</b> (void)</td></tr> +<tr class="separator:a6947e672169d9a31896fb8541b3e2e9c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa6ae9b5851e38180e9692f2a57e45e89"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6ae9b5851e38180e9692f2a57e45e89"></a> +LIBICAL_ICAL_EXPORT <a class="el" href="struct__icalarray.html">icalarray</a> * </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rscale_supported_calendars</b> (void)</td></tr> +<tr class="separator:aa6ae9b5851e38180e9692f2a57e45e89"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Routines for dealing with recurring time. </p> @@ -228,15 +259,15 @@ void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_cl <div class="line">recur = icalproperty_get_rrule(rrule);</div> <div class="line">start = icalproperty_get_dtstart(dtstart);</div> </div><!-- fragment --><p>Or, just make them up:</p> -<div class="fragment"><div class="line">recur = <a class="code" href="icalrecur_8h.html#a0e8ebcf355ba22299f553f8f5e657926">icalrecurrencetype_from_string</a>(<span class="stringliteral">"FREQ=YEARLY;BYDAY=SU,WE"</span>);</div> -<div class="line">dtstart = <a class="code" href="icaltime_8h.html#a1b66b9f52a9823b95e4cd33f9dd9b8e5" title="Contructor.">icaltime_from_string</a>(<span class="stringliteral">"19970101T123000"</span>)</div> +<div class="fragment"><div class="line">recur = <a class="code" href="icalrecur_8h.html#af01cc853523e9d6910de3ab9b902b4ba">icalrecurrencetype_from_string</a>(<span class="stringliteral">"FREQ=YEARLY;BYDAY=SU,WE"</span>);</div> +<div class="line">dtstart = <a class="code" href="icaltime_8h.html#ad03ef81281c570ee8b3d6ab22926d3d6">icaltime_from_string</a>(<span class="stringliteral">"19970101T123000"</span>)</div> </div><!-- fragment --><p>2) Create an iterator</p> <div class="fragment"><div class="line"><a class="code" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a>* ritr;</div> -<div class="line">ritr = <a class="code" href="icalrecur_8h.html#a3259c2b9b03763d8ee02868816d6261a">icalrecur_iterator_new</a>(recur,start);</div> +<div class="line">ritr = <a class="code" href="icalrecur_8h.html#af93474703998baec72fa81ab76e46673">icalrecur_iterator_new</a>(recur,start);</div> </div><!-- fragment --><p>3) Iterator over the occurrences</p> <div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> next;</div> -<div class="line"><span class="keywordflow">while</span> (next = <a class="code" href="icalrecur_8h.html#a2e10af320612cd7ab8c6fb6177ade3e3">icalrecur_iterator_next</a>(ritr) </div> -<div class="line"> && !<a class="code" href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a>(next){</div> +<div class="line"><span class="keywordflow">while</span> (next = <a class="code" href="icalrecur_8h.html#a8b58e5d1eec717d763bbf8843ac5c3d8">icalrecur_iterator_next</a>(ritr)</div> +<div class="line"> && !<a class="code" href="icaltime_8h.html#a889775a03ccb7b41920baa7e3dc0e93e">icaltime_is_null_time</a>(next){</div> <div class="line"> Do something with next</div> <div class="line">}</div> </div><!-- fragment --><p>Note that that the time returned by icalrecur_iterator_next is in whatever timezone that dtstart is in. </p> @@ -246,7 +277,7 @@ void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_cl <div class="memproto"> <table class="memname"> <tr> - <td class="memname">#define ICAL_BY_SECOND_SIZE   61</td> + <td class="memname">#define ICAL_BY_SECOND_SIZE   62 /* 0 to 60 */</td> </tr> </table> </div><div class="memdoc"> @@ -269,12 +300,12 @@ void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_cl </div> </div> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="a488780da8434731021af8d791b087b77"></a> +<a class="anchor" id="a1ff36713dbb1bddf333f2c7203886c41"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">int icalrecur_expand_recurrence </td> + <td class="memname">LIBICAL_ICAL_EXPORT int icalrecur_expand_recurrence </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>rule</em>, </td> @@ -309,12 +340,12 @@ void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_cl </div> </div> -<a class="anchor" id="a14daf9df313fdad9f536a7d9242b4cdc"></a> +<a class="anchor" id="aaf23abc0ada8b9373ae575ee0ed2964f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">void icalrecur_iterator_free </td> + <td class="memname">LIBICAL_ICAL_EXPORT void icalrecur_iterator_free </td> <td>(</td> <td class="paramtype"><a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a> * </td> <td class="paramname"></td><td>)</td> @@ -326,12 +357,12 @@ void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_cl </div> </div> -<a class="anchor" id="a3259c2b9b03763d8ee02868816d6261a"></a> +<a class="anchor" id="af93474703998baec72fa81ab76e46673"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a>* icalrecur_iterator_new </td> + <td class="memname">LIBICAL_ICAL_EXPORT <a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a>* icalrecur_iterator_new </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> </td> <td class="paramname"><em>rule</em>, </td> @@ -353,37 +384,29 @@ void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_cl </div> </div> -<a class="anchor" id="a2e10af320612cd7ab8c6fb6177ade3e3"></a> +<a class="anchor" id="a8b58e5d1eec717d763bbf8843ac5c3d8"></a> <div class="memitem"> <div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> icalrecur_iterator_next </td> + <td class="memname">LIBICAL_ICAL_EXPORT struct <a class="el" href="structicaltimetype.html">icaltimetype</a> icalrecur_iterator_next </td> <td>(</td> <td class="paramtype"><a class="el" href="icalrecur_8h.html#a15b0ec0400bb64fcfd625d5a5511db7f">icalrecur_iterator</a> * </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">read</span></span> </td> - </tr> -</table> </div><div class="memdoc"> <p>Get the next occurrence from an iterator </p> </div> </div> -<a class="anchor" id="a96c160e7e6b16e0e369c540f2ee164c7"></a> +<a class="anchor" id="a49948e4a58c1c402b3cc807f5f836f74"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">enum icalrecurrencetype_weekday icalrecurrencetype_day_day_of_week </td> + <td class="memname">LIBICAL_ICAL_EXPORT enum icalrecurrencetype_weekday icalrecurrencetype_day_day_of_week </td> <td>(</td> <td class="paramtype">short </td> <td class="paramname"><em>day</em></td><td>)</td> @@ -392,19 +415,19 @@ void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_cl </table> </div><div class="memdoc"> <p>Array Encoding</p> -<p>The 'day' element of the by_day array is encoded to allow representation of both the day of the week ( Monday, Tueday), but also the Nth day of the week ( First tuesday of the month, last thursday of the year) These routines decode the day values 1 == Monday, etc.</p> -<p>The 'day' element of icalrecurrencetype_weekday is encoded to allow representation of both the day of the week ( Monday, Tueday), but also the Nth day of the week ( First tuesday of the month, last thursday of the year) These routines decode the day values.</p> +<p>The 'day' element of the by_day array is encoded to allow representation of both the day of the week ( Monday, Tueday), but also the Nth day of the week ( First tuesday of the month, last thursday of the year) These routines decode the day values1 == Monday, etc.</p> +<p>The 'day' element of icalrecurrencetype_weekday is encoded to allow representation of both the day of the week ( Monday, Tuesday), but also the Nth day of the week ( First tuesday of the month, last thursday of the year) These routines decode the day values.</p> <p>The day's position in the period ( Nth-ness) and the numerical value of the day are encoded together as: pos*7 + dow</p> <p>A position of 0 means 'any' or 'every' </p> </div> </div> -<a class="anchor" id="aa730e9ac327064456902076b718400f4"></a> +<a class="anchor" id="ad5da4569ae67adc2c341c03d23e166fd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">int icalrecurrencetype_day_position </td> + <td class="memname">LIBICAL_ICAL_EXPORT int icalrecurrencetype_day_position </td> <td>(</td> <td class="paramtype">short </td> <td class="paramname"><em>day</em></td><td>)</td> @@ -416,37 +439,48 @@ void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_cl </div> </div> -<a class="anchor" id="a0e8ebcf355ba22299f553f8f5e657926"></a> +<a class="anchor" id="af01cc853523e9d6910de3ab9b902b4ba"></a> <div class="memitem"> <div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> icalrecurrencetype_from_string </td> + <td class="memname">LIBICAL_ICAL_EXPORT struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> icalrecurrencetype_from_string </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em></td><td>)</td> <td></td> </tr> </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">read</span></span> </td> - </tr> -</table> </div><div class="memdoc"> <p>Recurrance rule parser Convert between strings and recurrencetype structures. </p> </div> </div> +<a class="anchor" id="acbfde65897df7e26a0ae3758b17205a7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">LIBICAL_ICAL_EXPORT int icalrecurrencetype_month_is_leap </td> + <td>(</td> + <td class="paramtype">short </td> + <td class="paramname"><em>month</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>The 'month' element of the by_month array is encoded to allow representation of the "L" leap suffix (RFC 7529). These routines decode the month values.</p> +<p>The 'month' element of the by_month array is encoded to allow representation of the "L" leap suffix (RFC 7529). These routines decode the month values.</p> +<p>The "L" suffix is encoded by setting a high-order bit </p> + +</div> +</div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.3.1 +</a> 1.8.9.1 </small></address> </body> </html> |