summaryrefslogtreecommitdiff
path: root/apidocs/icalspanlist_8h_source.html
blob: 5735a0bb93188432bbf55860f494a27b943f1c86 (plain)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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 name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: icalspanlist.h Source File</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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Libical API Documentation<span id="projectnumber">&#160;3.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_e5788c73bf8d77f47d4a3002d26bfd20.html">libicalss</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">icalspanlist.h</div></div>
</div><!--header-->
<div class="contents">
<a href="icalspanlist_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*======================================================================</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> FILE: icalspanlist.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> CREATOR: eric 21 Aug 2000</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"></span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> SPDX-FileCopyrightText: 2000, Eric Busboom &lt;eric@civicknowledge.com&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"></span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"></span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment">=========================================================================*/</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#ifndef ICALSPANLIST_H</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#define ICALSPANLIST_H</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="preprocessor">#include &quot;libical_icalss_export.h&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#include &quot;<a class="code" href="icalset_8h.html">icalset.h</a>&quot;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structicalspanlist__impl.html">icalspanlist_impl</a> <a class="code hl_struct" href="structicalspanlist__impl.html">icalspanlist</a>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalspanlist__impl.html">icalspanlist</a> *<a class="code hl_function" href="icalspanlist_8h.html#acbf0f85b59416bfc8e8a65970e191136">icalspanlist_new</a>(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *set,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>                                                     <span class="keyword">struct</span> <a class="code hl_struct" href="structicaltimetype.html">icaltimetype</a> <a class="code hl_variable" href="structicalspanlist__impl.html#a2876fb86a056d43c55cff46dd340ed1d">start</a>,</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>                                                     <span class="keyword">struct</span> <a class="code hl_struct" href="structicaltimetype.html">icaltimetype</a> <a class="code hl_variable" href="structicalspanlist__impl.html#ad9b5b7be8203c36283e28fad77b97975">end</a>);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>LIBICAL_ICALSS_EXPORT <span class="keywordtype">void</span> <a class="code hl_function" href="icalspanlist_8h.html#acb42d8b7053e8886c8ea895699f6fa9c">icalspanlist_free</a>(<a class="code hl_struct" href="structicalspanlist__impl.html">icalspanlist</a> *sl);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>LIBICAL_ICALSS_EXPORT <span class="keyword">struct </span><a class="code hl_struct" href="structicalperiodtype.html">icalperiodtype</a> <a class="code hl_function" href="icalspanlist_8h.html#af8686abb751773c3358c1a82fb79606c">icalspanlist_next_free_time</a>(<a class="code hl_struct" href="structicalspanlist__impl.html">icalspanlist</a> *sl,</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>                                                                        <span class="keyword">struct </span><a class="code hl_struct" href="structicaltimetype.html">icaltimetype</a> t);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>LIBICAL_ICALSS_EXPORT <span class="keywordtype">void</span> <a class="code hl_function" href="icalspanlist_8h.html#a31a026b29f6b18108e49b15c9593a7fa">icalspanlist_dump</a>(<a class="code hl_struct" href="structicalspanlist__impl.html">icalspanlist</a> *sl);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *<a class="code hl_function" href="icalspanlist_8h.html#aed5ab46eeb595eb24cb99494f6837267">icalspanlist_as_vfreebusy</a>(<a class="code hl_struct" href="structicalspanlist__impl.html">icalspanlist</a> *sl,</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>                                                               <span class="keyword">const</span> <span class="keywordtype">char</span> *organizer,</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>                                                               <span class="keyword">const</span> <span class="keywordtype">char</span> *attendee);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>LIBICAL_ICALSS_EXPORT <span class="keywordtype">int</span> *<a class="code hl_function" href="icalspanlist_8h.html#a7075f544806d8dec4696ccf80067f7d7">icalspanlist_as_freebusy_matrix</a>(<a class="code hl_struct" href="structicalspanlist__impl.html">icalspanlist</a> *span, <span class="keywordtype">int</span> delta_t);</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalspanlist__impl.html">icalspanlist</a> *<a class="code hl_function" href="icalspanlist_8h.html#a980cdf00f77540c74dc44f7037aa82a5">icalspanlist_from_vfreebusy</a>(<a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *comp);</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aicalset_8h_html"><div class="ttname"><a href="icalset_8h.html">icalset.h</a></div></div>
<div class="ttc" id="aicalspanlist_8h_html_a31a026b29f6b18108e49b15c9593a7fa"><div class="ttname"><a href="icalspanlist_8h.html#a31a026b29f6b18108e49b15c9593a7fa">icalspanlist_dump</a></div><div class="ttdeci">void icalspanlist_dump(icalspanlist *sl)</div><div class="ttdoc">(Debug) print out spanlist to STDOUT.</div><div class="ttdef"><b>Definition:</b> icalspanlist.c:202</div></div>
<div class="ttc" id="aicalspanlist_8h_html_a7075f544806d8dec4696ccf80067f7d7"><div class="ttname"><a href="icalspanlist_8h.html#a7075f544806d8dec4696ccf80067f7d7">icalspanlist_as_freebusy_matrix</a></div><div class="ttdeci">int * icalspanlist_as_freebusy_matrix(icalspanlist *span, int delta_t)</div><div class="ttdoc">Returns an hour-by-hour array of free/busy times over a given period.</div><div class="ttdef"><b>Definition:</b> icalspanlist.c:282</div></div>
<div class="ttc" id="aicalspanlist_8h_html_a980cdf00f77540c74dc44f7037aa82a5"><div class="ttname"><a href="icalspanlist_8h.html#a980cdf00f77540c74dc44f7037aa82a5">icalspanlist_from_vfreebusy</a></div><div class="ttdeci">icalspanlist * icalspanlist_from_vfreebusy(icalcomponent *comp)</div><div class="ttdoc">Constructs an icalspanlist from a VFREEBUSY component.</div><div class="ttdef"><b>Definition:</b> icalspanlist.c:394</div></div>
<div class="ttc" id="aicalspanlist_8h_html_acb42d8b7053e8886c8ea895699f6fa9c"><div class="ttname"><a href="icalspanlist_8h.html#acb42d8b7053e8886c8ea895699f6fa9c">icalspanlist_free</a></div><div class="ttdeci">void icalspanlist_free(icalspanlist *sl)</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> icalspanlist.c:184</div></div>
<div class="ttc" id="aicalspanlist_8h_html_acbf0f85b59416bfc8e8a65970e191136"><div class="ttname"><a href="icalspanlist_8h.html#acbf0f85b59416bfc8e8a65970e191136">icalspanlist_new</a></div><div class="ttdeci">icalspanlist * icalspanlist_new(icalset *set, struct icaltimetype start, struct icaltimetype end)</div><div class="ttdoc">Makes a free list from a set of VEVENT components.</div><div class="ttdef"><b>Definition:</b> icalspanlist.c:82</div></div>
<div class="ttc" id="aicalspanlist_8h_html_aed5ab46eeb595eb24cb99494f6837267"><div class="ttname"><a href="icalspanlist_8h.html#aed5ab46eeb595eb24cb99494f6837267">icalspanlist_as_vfreebusy</a></div><div class="ttdeci">icalcomponent * icalspanlist_as_vfreebusy(icalspanlist *sl, const char *organizer, const char *attendee)</div><div class="ttdoc">Returns a VFREEBUSY component for a spanlist.</div><div class="ttdef"><b>Definition:</b> icalspanlist.c:343</div></div>
<div class="ttc" id="aicalspanlist_8h_html_af8686abb751773c3358c1a82fb79606c"><div class="ttname"><a href="icalspanlist_8h.html#af8686abb751773c3358c1a82fb79606c">icalspanlist_next_free_time</a></div><div class="ttdeci">struct icalperiodtype icalspanlist_next_free_time(icalspanlist *sl, struct icaltimetype t)</div><div class="ttdoc">Finds the next free time span in a spanlist.</div><div class="ttdef"><b>Definition:</b> icalspanlist.c:218</div></div>
<div class="ttc" id="astructicalcomponent__impl_html"><div class="ttname"><a href="structicalcomponent__impl.html">icalcomponent_impl</a></div><div class="ttdef"><b>Definition:</b> icalcomponent.c:28</div></div>
<div class="ttc" id="astructicalperiodtype_html"><div class="ttname"><a href="structicalperiodtype.html">icalperiodtype</a></div><div class="ttdoc">Struct to represent a period in time.</div><div class="ttdef"><b>Definition:</b> icalperiod.h:29</div></div>
<div class="ttc" id="astructicalset__impl_html"><div class="ttname"><a href="structicalset__impl.html">icalset_impl</a></div><div class="ttdef"><b>Definition:</b> icalset.h:52</div></div>
<div class="ttc" id="astructicalspanlist__impl_html"><div class="ttname"><a href="structicalspanlist__impl.html">icalspanlist_impl</a></div><div class="ttdef"><b>Definition:</b> icalspanlist.c:21</div></div>
<div class="ttc" id="astructicalspanlist__impl_html_a2876fb86a056d43c55cff46dd340ed1d"><div class="ttname"><a href="structicalspanlist__impl.html#a2876fb86a056d43c55cff46dd340ed1d">icalspanlist_impl::start</a></div><div class="ttdeci">struct icaltimetype start</div><div class="ttdef"><b>Definition:</b> icalspanlist.c:23</div></div>
<div class="ttc" id="astructicalspanlist__impl_html_ad9b5b7be8203c36283e28fad77b97975"><div class="ttname"><a href="structicalspanlist__impl.html#ad9b5b7be8203c36283e28fad77b97975">icalspanlist_impl::end</a></div><div class="ttdeci">struct icaltimetype end</div><div class="ttdef"><b>Definition:</b> icalspanlist.c:24</div></div>
<div class="ttc" id="astructicaltimetype_html"><div class="ttname"><a href="structicaltimetype.html">icaltimetype</a></div><div class="ttdef"><b>Definition:</b> icaltime.h:97</div></div>
</div><!-- fragment --></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&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>