summaryrefslogtreecommitdiff
path: root/apidocs/icalspanlist_8h_source.html
blob: a484bec50c0bc27dcfc8dc427bb7311f65443b66 (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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<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 style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Libical API Documentation
   &#160;<span id="projectnumber">2.99</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</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 name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*======================================================================</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> FILE: icalspanlist.h</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> CREATOR: eric 21 Aug 2000</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> (C) COPYRIGHT 2000, Eric Busboom &lt;eric@softwarestudio.org&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">     http://www.softwarestudio.org</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> This library is free software; you can redistribute it and/or modify</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> it under the terms of either:</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">    The LGPL as published by the Free Software Foundation, version</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">    2.1, available at: http://www.gnu.org/licenses/lgpl-2.1.html</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> Or:</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">    The Mozilla Public License Version 2.0. You may obtain a copy of</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">    the License at http://www.mozilla.org/MPL/</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">=========================================================================*/</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#ifndef ICALSPANLIST_H</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#define ICALSPANLIST_H</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &quot;libical_icalss_export.h&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="icalset_8h.html">icalset.h</a>&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structicalspanlist__impl.html">icalspanlist_impl</a> <a class="code" href="structicalspanlist__impl.html">icalspanlist</a>;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;LIBICAL_ICALSS_EXPORT <a class="code" href="structicalspanlist__impl.html">icalspanlist</a> *<a class="code" href="icalspanlist_8h.html#ae7f6d3e48e73cf9cd2712abd101400eb">icalspanlist_new</a>(<a class="code" href="structicalset__impl.html">icalset</a> *<span class="keyword">set</span>,</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;                                                     <span class="keyword">struct</span> <a class="code" href="structicaltimetype.html">icaltimetype</a> <a class="code" href="structicalspanlist__impl.html#a2876fb86a056d43c55cff46dd340ed1d">start</a>,</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;                                                     <span class="keyword">struct</span> <a class="code" href="structicaltimetype.html">icaltimetype</a> <a class="code" href="structicalspanlist__impl.html#ad9b5b7be8203c36283e28fad77b97975">end</a>);</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;LIBICAL_ICALSS_EXPORT <span class="keywordtype">void</span> <a class="code" href="icalspanlist_8h.html#aacc49ed6cd735f495292f0cf3c464a4d">icalspanlist_free</a>(<a class="code" href="structicalspanlist__impl.html">icalspanlist</a> *spl);</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;LIBICAL_ICALSS_EXPORT <span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> <a class="code" href="icalspanlist_8h.html#af8686abb751773c3358c1a82fb79606c">icalspanlist_next_free_time</a>(<a class="code" href="structicalspanlist__impl.html">icalspanlist</a> *sl,</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;                                                                        <span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> t);</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;LIBICAL_ICALSS_EXPORT <span class="keywordtype">void</span> <a class="code" href="icalspanlist_8h.html#a5ad885ca2cbf81bfea72d04cf17b5010">icalspanlist_dump</a>(<a class="code" href="structicalspanlist__impl.html">icalspanlist</a> *s);</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;LIBICAL_ICALSS_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *<a class="code" href="icalspanlist_8h.html#a2c5f900137f272a1897d8856fbd1b961">icalspanlist_as_vfreebusy</a>(<a class="code" href="structicalspanlist__impl.html">icalspanlist</a> *sl,</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;                                                               <span class="keyword">const</span> <span class="keywordtype">char</span> *organizer,</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;                                                               <span class="keyword">const</span> <span class="keywordtype">char</span> *attendee);</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;LIBICAL_ICALSS_EXPORT <span class="keywordtype">int</span> *<a class="code" href="icalspanlist_8h.html#aca42fe723854f27dee1dbd89ac8eea43">icalspanlist_as_freebusy_matrix</a>(<a class="code" href="structicalspanlist__impl.html">icalspanlist</a> *span, <span class="keywordtype">int</span> delta_t);</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;LIBICAL_ICALSS_EXPORT <a class="code" href="structicalspanlist__impl.html">icalspanlist</a> *<a class="code" href="icalspanlist_8h.html#a7178dfde5839654471d57611794eda96">icalspanlist_from_vfreebusy</a>(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *comp);</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="icalset_8h_html"><div class="ttname"><a href="icalset_8h.html">icalset.h</a></div></div>
<div class="ttc" id="structicalspanlist__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:33</div></div>
<div class="ttc" id="structicalperiodtype_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:38</div></div>
<div class="ttc" id="structicalspanlist__impl_html"><div class="ttname"><a href="structicalspanlist__impl.html">icalspanlist_impl</a></div><div class="ttdef"><b>Definition:</b> icalspanlist.c:29</div></div>
<div class="ttc" id="icalspanlist_8h_html_a5ad885ca2cbf81bfea72d04cf17b5010"><div class="ttname"><a href="icalspanlist_8h.html#a5ad885ca2cbf81bfea72d04cf17b5010">icalspanlist_dump</a></div><div class="ttdeci">void icalspanlist_dump(icalspanlist *s)</div><div class="ttdoc">(Debug) print out spanlist to stdout. </div><div class="ttdef"><b>Definition:</b> icalspanlist.c:233</div></div>
<div class="ttc" id="icalspanlist_8h_html_a7178dfde5839654471d57611794eda96"><div class="ttname"><a href="icalspanlist_8h.html#a7178dfde5839654471d57611794eda96">icalspanlist_from_vfreebusy</a></div><div class="ttdeci">icalspanlist * icalspanlist_from_vfreebusy(icalcomponent *comp)</div><div class="ttdoc">Construct an icalspanlist from a VFREEBUSY component. </div><div class="ttdef"><b>Definition:</b> icalspanlist.c:477</div></div>
<div class="ttc" id="structicalspanlist__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:32</div></div>
<div class="ttc" id="icalspanlist_8h_html_aca42fe723854f27dee1dbd89ac8eea43"><div class="ttname"><a href="icalspanlist_8h.html#aca42fe723854f27dee1dbd89ac8eea43">icalspanlist_as_freebusy_matrix</a></div><div class="ttdeci">int * icalspanlist_as_freebusy_matrix(icalspanlist *span, int delta_t)</div><div class="ttdoc">Return an integer matrix of total events per delta_t timespan. </div><div class="ttdef"><b>Definition:</b> icalspanlist.c:341</div></div>
<div class="ttc" id="icalspanlist_8h_html_ae7f6d3e48e73cf9cd2712abd101400eb"><div class="ttname"><a href="icalspanlist_8h.html#ae7f6d3e48e73cf9cd2712abd101400eb">icalspanlist_new</a></div><div class="ttdeci">icalspanlist * icalspanlist_new(icalset *set, struct icaltimetype start, struct icaltimetype end)</div><div class="ttdoc">Constructor Make a free list from a set of component. Start and end should be in UTC. </div><div class="ttdef"><b>Definition:</b> icalspanlist.c:103</div></div>
<div class="ttc" id="structicalcomponent__impl_html"><div class="ttname"><a href="structicalcomponent__impl.html">icalcomponent_impl</a></div><div class="ttdef"><b>Definition:</b> icalcomponent.c:33</div></div>
<div class="ttc" id="structicaltimetype_html"><div class="ttname"><a href="structicaltimetype.html">icaltimetype</a></div><div class="ttdef"><b>Definition:</b> icaltime.h:105</div></div>
<div class="ttc" id="structicalset__impl_html"><div class="ttname"><a href="structicalset__impl.html">icalset_impl</a></div><div class="ttdef"><b>Definition:</b> icalset.h:60</div></div>
<div class="ttc" id="icalspanlist_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">Find next free time span in a spanlist. </div><div class="ttdef"><b>Definition:</b> icalspanlist.c:258</div></div>
<div class="ttc" id="icalspanlist_8h_html_a2c5f900137f272a1897d8856fbd1b961"><div class="ttname"><a href="icalspanlist_8h.html#a2c5f900137f272a1897d8856fbd1b961">icalspanlist_as_vfreebusy</a></div><div class="ttdeci">icalcomponent * icalspanlist_as_vfreebusy(icalspanlist *sl, const char *organizer, const char *attendee)</div><div class="ttdoc">Return a valid VFREEBUSY component for this span. </div><div class="ttdef"><b>Definition:</b> icalspanlist.c:417</div></div>
<div class="ttc" id="icalspanlist_8h_html_aacc49ed6cd735f495292f0cf3c464a4d"><div class="ttname"><a href="icalspanlist_8h.html#aacc49ed6cd735f495292f0cf3c464a4d">icalspanlist_free</a></div><div class="ttdeci">void icalspanlist_free(icalspanlist *spl)</div><div class="ttdoc">Destructor. </div><div class="ttdef"><b>Definition:</b> icalspanlist.c:211</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>