diff options
Diffstat (limited to 'apidocs/icalspanlist_8h.html')
| -rw-r--r-- | apidocs/icalspanlist_8h.html | 95 |
1 files changed, 48 insertions, 47 deletions
diff --git a/apidocs/icalspanlist_8h.html b/apidocs/icalspanlist_8h.html index 6aebc897..8a208652 100644 --- a/apidocs/icalspanlist_8h.html +++ b/apidocs/icalspanlist_8h.html @@ -2,8 +2,8 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=11"/> -<meta name="generator" content="Doxygen 1.9.3"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.9.1"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Libical API Documentation: icalspanlist.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -19,9 +19,10 @@ <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> - <tr id="projectrow"> - <td id="projectalign"> - <div id="projectname">Libical API Documentation<span id="projectnumber"> 3.1</span> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Libical API Documentation +  <span id="projectnumber">3.0</span> </div> </td> </tr> @@ -29,22 +30,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.9.3 --> +<!-- Generated by Doxygen 1.9.1 --> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ -var searchBox = new SearchBox("searchBox", "search",'Search','.html'); +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -/* @license-end */ -</script> +/* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" @@ -69,7 +69,8 @@ $(function() { <div class="summary"> <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> - <div class="headertitle"><div class="title">icalspanlist.h File Reference</div></div> + <div class="headertitle"> +<div class="title">icalspanlist.h File Reference</div> </div> </div><!--header--> <div class="contents"> @@ -78,47 +79,47 @@ $(function() { <p><a href="icalspanlist_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> -<tr class="memitem:ab56eb13ccdb70ef4a7d6aede068d6fd4"><td class="memItemLeft" align="right" valign="top"><a id="ab56eb13ccdb70ef4a7d6aede068d6fd4" name="ab56eb13ccdb70ef4a7d6aede068d6fd4"></a> +<tr class="memitem:ab56eb13ccdb70ef4a7d6aede068d6fd4"><td class="memItemLeft" align="right" valign="top"><a id="ab56eb13ccdb70ef4a7d6aede068d6fd4"></a> typedef struct <a class="el" href="structicalspanlist__impl.html">icalspanlist_impl</a> </td><td class="memItemRight" valign="bottom"><b>icalspanlist</b></td></tr> <tr class="separator:ab56eb13ccdb70ef4a7d6aede068d6fd4"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:a7075f544806d8dec4696ccf80067f7d7"><td class="memItemLeft" align="right" valign="top">int * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a7075f544806d8dec4696ccf80067f7d7">icalspanlist_as_freebusy_matrix</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *span, int delta_t)</td></tr> -<tr class="memdesc:a7075f544806d8dec4696ccf80067f7d7"><td class="mdescLeft"> </td><td class="mdescRight">Returns an hour-by-hour array of free/busy times over a given period. <a href="icalspanlist_8h.html#a7075f544806d8dec4696ccf80067f7d7">More...</a><br /></td></tr> -<tr class="separator:a7075f544806d8dec4696ccf80067f7d7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aed5ab46eeb595eb24cb99494f6837267"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#aed5ab46eeb595eb24cb99494f6837267">icalspanlist_as_vfreebusy</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *sl, const char *organizer, const char *attendee)</td></tr> -<tr class="memdesc:aed5ab46eeb595eb24cb99494f6837267"><td class="mdescLeft"> </td><td class="mdescRight">Returns a VFREEBUSY component for a spanlist. <a href="icalspanlist_8h.html#aed5ab46eeb595eb24cb99494f6837267">More...</a><br /></td></tr> -<tr class="separator:aed5ab46eeb595eb24cb99494f6837267"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aca42fe723854f27dee1dbd89ac8eea43"><td class="memItemLeft" align="right" valign="top">int * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#aca42fe723854f27dee1dbd89ac8eea43">icalspanlist_as_freebusy_matrix</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *span, int delta_t)</td></tr> +<tr class="memdesc:aca42fe723854f27dee1dbd89ac8eea43"><td class="mdescLeft"> </td><td class="mdescRight">Returns an hour-by-hour array of free/busy times over a given period. <a href="icalspanlist_8h.html#aca42fe723854f27dee1dbd89ac8eea43">More...</a><br /></td></tr> +<tr class="separator:aca42fe723854f27dee1dbd89ac8eea43"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2c5f900137f272a1897d8856fbd1b961"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a2c5f900137f272a1897d8856fbd1b961">icalspanlist_as_vfreebusy</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *sl, const char *organizer, const char *attendee)</td></tr> +<tr class="memdesc:a2c5f900137f272a1897d8856fbd1b961"><td class="mdescLeft"> </td><td class="mdescRight">Returns a VFREEBUSY component for a spanlist. <a href="icalspanlist_8h.html#a2c5f900137f272a1897d8856fbd1b961">More...</a><br /></td></tr> +<tr class="separator:a2c5f900137f272a1897d8856fbd1b961"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a31a026b29f6b18108e49b15c9593a7fa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a31a026b29f6b18108e49b15c9593a7fa">icalspanlist_dump</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *sl)</td></tr> <tr class="memdesc:a31a026b29f6b18108e49b15c9593a7fa"><td class="mdescLeft"> </td><td class="mdescRight">(Debug) print out spanlist to STDOUT. <a href="icalspanlist_8h.html#a31a026b29f6b18108e49b15c9593a7fa">More...</a><br /></td></tr> <tr class="separator:a31a026b29f6b18108e49b15c9593a7fa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acb42d8b7053e8886c8ea895699f6fa9c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#acb42d8b7053e8886c8ea895699f6fa9c">icalspanlist_free</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *sl)</td></tr> <tr class="memdesc:acb42d8b7053e8886c8ea895699f6fa9c"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="icalspanlist_8h.html#acb42d8b7053e8886c8ea895699f6fa9c">More...</a><br /></td></tr> <tr class="separator:acb42d8b7053e8886c8ea895699f6fa9c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a980cdf00f77540c74dc44f7037aa82a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a980cdf00f77540c74dc44f7037aa82a5">icalspanlist_from_vfreebusy</a> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr> -<tr class="memdesc:a980cdf00f77540c74dc44f7037aa82a5"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an icalspanlist from a VFREEBUSY component. <a href="icalspanlist_8h.html#a980cdf00f77540c74dc44f7037aa82a5">More...</a><br /></td></tr> -<tr class="separator:a980cdf00f77540c74dc44f7037aa82a5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:acbf0f85b59416bfc8e8a65970e191136"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#acbf0f85b59416bfc8e8a65970e191136">icalspanlist_new</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> start, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> end)</td></tr> -<tr class="memdesc:acbf0f85b59416bfc8e8a65970e191136"><td class="mdescLeft"> </td><td class="mdescRight">Makes a free list from a set of VEVENT components. <a href="icalspanlist_8h.html#acbf0f85b59416bfc8e8a65970e191136">More...</a><br /></td></tr> -<tr class="separator:acbf0f85b59416bfc8e8a65970e191136"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7178dfde5839654471d57611794eda96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a7178dfde5839654471d57611794eda96">icalspanlist_from_vfreebusy</a> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr> +<tr class="memdesc:a7178dfde5839654471d57611794eda96"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an icalspanlist from a VFREEBUSY component. <a href="icalspanlist_8h.html#a7178dfde5839654471d57611794eda96">More...</a><br /></td></tr> +<tr class="separator:a7178dfde5839654471d57611794eda96"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae7f6d3e48e73cf9cd2712abd101400eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#ae7f6d3e48e73cf9cd2712abd101400eb">icalspanlist_new</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> start, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> end)</td></tr> +<tr class="memdesc:ae7f6d3e48e73cf9cd2712abd101400eb"><td class="mdescLeft"> </td><td class="mdescRight">Makes a free list from a set of VEVENT components. <a href="icalspanlist_8h.html#ae7f6d3e48e73cf9cd2712abd101400eb">More...</a><br /></td></tr> +<tr class="separator:ae7f6d3e48e73cf9cd2712abd101400eb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af8686abb751773c3358c1a82fb79606c"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#af8686abb751773c3358c1a82fb79606c">icalspanlist_next_free_time</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *sl, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> t)</td></tr> <tr class="memdesc:af8686abb751773c3358c1a82fb79606c"><td class="mdescLeft"> </td><td class="mdescRight">Finds the next free time span in a spanlist. <a href="icalspanlist_8h.html#af8686abb751773c3358c1a82fb79606c">More...</a><br /></td></tr> <tr class="separator:af8686abb751773c3358c1a82fb79606c"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p >Code that supports collections of free/busy spans of time. </p> +<div class="textblock"><p>Code that supports collections of free/busy spans of time. </p> </div><h2 class="groupheader">Function Documentation</h2> -<a id="a7075f544806d8dec4696ccf80067f7d7" name="a7075f544806d8dec4696ccf80067f7d7"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a7075f544806d8dec4696ccf80067f7d7">◆ </a></span>icalspanlist_as_freebusy_matrix()</h2> +<a id="aca42fe723854f27dee1dbd89ac8eea43"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aca42fe723854f27dee1dbd89ac8eea43">◆ </a></span>icalspanlist_as_freebusy_matrix()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">int * icalspanlist_as_freebusy_matrix </td> + <td class="memname">int* icalspanlist_as_freebusy_matrix </td> <td>(</td> <td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td> <td class="paramname"><em>span</em>, </td> @@ -147,18 +148,18 @@ Functions</h2></td></tr> </dl> <dl class="section return"><dt>Returns</dt><dd>A pointer to an array of integers containing the number of busy events in each delta_t time period. The final entry contains the value -1.</dd></dl> <p>This calculation is somewhat tricky. This is due to the fact that the time range contains the start time, but does not contain the end time. To perform a proper calculation we subtract one second off the end times to get a true containing time.</p> -<p >Also note that if you supplying a spanlist that does not start or end on a time boundary divisible by delta_t you may get results that are not quite what you expect. </p> +<p>Also note that if you supplying a spanlist that does not start or end on a time boundary divisible by delta_t you may get results that are not quite what you expect. </p> </div> </div> -<a id="aed5ab46eeb595eb24cb99494f6837267" name="aed5ab46eeb595eb24cb99494f6837267"></a> -<h2 class="memtitle"><span class="permalink"><a href="#aed5ab46eeb595eb24cb99494f6837267">◆ </a></span>icalspanlist_as_vfreebusy()</h2> +<a id="a2c5f900137f272a1897d8856fbd1b961"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2c5f900137f272a1897d8856fbd1b961">◆ </a></span>icalspanlist_as_vfreebusy()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * icalspanlist_as_vfreebusy </td> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalspanlist_as_vfreebusy </td> <td>(</td> <td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td> <td class="paramname"><em>sl</em>, </td> @@ -186,7 +187,7 @@ Functions</h2></td></tr> <p>Returns a VFREEBUSY component for a spanlist. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">sl</td><td>A valid icalspanlist, from <a class="el" href="icalspanlist_8h.html#acbf0f85b59416bfc8e8a65970e191136" title="Makes a free list from a set of VEVENT components.">icalspanlist_new()</a> </td></tr> + <tr><td class="paramname">sl</td><td>A valid icalspanlist, from <a class="el" href="icalspanlist_8h.html#ae7f6d3e48e73cf9cd2712abd101400eb" title="Makes a free list from a set of VEVENT components.">icalspanlist_new()</a> </td></tr> <tr><td class="paramname">organizer</td><td>The organizer specified as "MAILTO:user@domain" </td></tr> <tr><td class="paramname">attendee</td><td>The attendee specified as "MAILTO:user@domain"</td></tr> </table> @@ -197,7 +198,7 @@ Functions</h2></td></tr> </div> </div> -<a id="a31a026b29f6b18108e49b15c9593a7fa" name="a31a026b29f6b18108e49b15c9593a7fa"></a> +<a id="a31a026b29f6b18108e49b15c9593a7fa"></a> <h2 class="memtitle"><span class="permalink"><a href="#a31a026b29f6b18108e49b15c9593a7fa">◆ </a></span>icalspanlist_dump()</h2> <div class="memitem"> @@ -223,7 +224,7 @@ Functions</h2></td></tr> </div> </div> -<a id="acb42d8b7053e8886c8ea895699f6fa9c" name="acb42d8b7053e8886c8ea895699f6fa9c"></a> +<a id="acb42d8b7053e8886c8ea895699f6fa9c"></a> <h2 class="memtitle"><span class="permalink"><a href="#acb42d8b7053e8886c8ea895699f6fa9c">◆ </a></span>icalspanlist_free()</h2> <div class="memitem"> @@ -250,14 +251,14 @@ Functions</h2></td></tr> </div> </div> -<a id="a980cdf00f77540c74dc44f7037aa82a5" name="a980cdf00f77540c74dc44f7037aa82a5"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a980cdf00f77540c74dc44f7037aa82a5">◆ </a></span>icalspanlist_from_vfreebusy()</h2> +<a id="a7178dfde5839654471d57611794eda96"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7178dfde5839654471d57611794eda96">◆ </a></span>icalspanlist_from_vfreebusy()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * icalspanlist_from_vfreebusy </td> + <td class="memname"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a>* icalspanlist_from_vfreebusy </td> <td>(</td> <td class="paramtype"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td> <td class="paramname"><em>comp</em></td><td>)</td> @@ -267,7 +268,7 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Constructs an icalspanlist from a VFREEBUSY component. </p> -<p >Constructs an icalspanlist from the VFREEBUSY component of an icalcomponent.</p> +<p>Constructs an icalspanlist from the VFREEBUSY component of an icalcomponent.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">comp</td><td>A valid icalcomponent.</td></tr> @@ -278,14 +279,14 @@ Functions</h2></td></tr> </div> </div> -<a id="acbf0f85b59416bfc8e8a65970e191136" name="acbf0f85b59416bfc8e8a65970e191136"></a> -<h2 class="memtitle"><span class="permalink"><a href="#acbf0f85b59416bfc8e8a65970e191136">◆ </a></span>icalspanlist_new()</h2> +<a id="ae7f6d3e48e73cf9cd2712abd101400eb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae7f6d3e48e73cf9cd2712abd101400eb">◆ </a></span>icalspanlist_new()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * icalspanlist_new </td> + <td class="memname"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a>* icalspanlist_new </td> <td>(</td> <td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td> <td class="paramname"><em>set</em>, </td> @@ -324,7 +325,7 @@ Functions</h2></td></tr> </div> </div> -<a id="af8686abb751773c3358c1a82fb79606c" name="af8686abb751773c3358c1a82fb79606c"></a> +<a id="af8686abb751773c3358c1a82fb79606c"></a> <h2 class="memtitle"><span class="permalink"><a href="#af8686abb751773c3358c1a82fb79606c">◆ </a></span>icalspanlist_next_free_time()</h2> <div class="memitem"> @@ -365,7 +366,7 @@ Functions</h2></td></tr> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </small></address> </body> </html> |