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
|
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: icalperiod.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
 <span id="projectnumber">3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(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_b7a0ea939f6e83384f3c571d31a84be9.html">libical</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">icalperiod.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="icalperiod_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> <span class="comment">/*======================================================================</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> FILE: icalperiod.h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> CREATOR: eric 26 Jan 2001</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> This library is free software; you can redistribute it and/or modify</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> it under the terms of either:</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> The LGPL as published by the Free Software Foundation, version</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> Or:</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> The Mozilla Public License Version 2.0. You may obtain a copy of</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> the License at https://www.mozilla.org/MPL/</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> The Original Code is eric. The Initial Developer of the Original</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> Code is Eric Busboom</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">======================================================================*/</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef ICALPERIOD_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define ICALPERIOD_H</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "libical_ical_export.h"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="icalduration_8h.html">icalduration.h</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="icaltime_8h.html">icaltime.h</a>"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structicalperiodtype.html"> 37</a></span> <span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> start;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> end;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> };</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> LIBICAL_ICAL_EXPORT <span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> <a class="code" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a>(const char *str);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a>(<span class="keyword">struct</span> <a class="code" href="structicalperiodtype.html">icalperiodtype</a> p);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *<a class="code" href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5">icalperiodtype_as_ical_string_r</a>(<span class="keyword">struct</span> <a class="code" href="structicalperiodtype.html">icalperiodtype</a> p);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> LIBICAL_ICAL_EXPORT <span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> <a class="code" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a>(void);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> <a class="code" href="icalperiod_8h.html#ae184bb1351602b7763044c5167a96bdf">icalperiodtype_is_null_period</a>(<span class="keyword">struct</span> <a class="code" href="structicalperiodtype.html">icalperiodtype</a> p);</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> <a class="code" href="icalperiod_8h.html#af7feaf12370cd37d66d160c4d8fbf0c7">icalperiodtype_is_valid_period</a>(<span class="keyword">struct</span> <a class="code" href="structicalperiodtype.html">icalperiodtype</a> p);</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="preprocessor">#endif </span><span class="comment">/* !ICALTIME_H */</span><span class="preprocessor"></span></div><div class="ttc" id="icalduration_8h_html"><div class="ttname"><a href="icalduration_8h.html">icalduration.h</a></div><div class="ttdoc">Methods for working with durations in iCal. </div></div>
<div class="ttc" id="icalperiod_8h_html_ac71be7790d778145a59ad9626458ccd5"><div class="ttname"><a href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5">icalperiodtype_as_ical_string_r</a></div><div class="ttdeci">char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)</div><div class="ttdoc">Converts an icalperiodtype into an iCal-formatted string. </div><div class="ttdef"><b>Definition:</b> icalperiod.c:103</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:37</div></div>
<div class="ttc" id="icaltime_8h_html"><div class="ttname"><a href="icaltime_8h.html">icaltime.h</a></div><div class="ttdoc">struct icaltimetype is a pseudo-object that abstracts time handling. </div></div>
<div class="ttc" id="icalperiod_8h_html_a827e35abf4d6349e15aeaa9a483064fd"><div class="ttname"><a href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a></div><div class="ttdeci">struct icalperiodtype icalperiodtype_from_string(const char *str)</div><div class="ttdoc">Constructs a new icalperiodtype from str. </div><div class="ttdef"><b>Definition:</b> icalperiod.c:30</div></div>
<div class="ttc" id="icalperiod_8h_html_ae184bb1351602b7763044c5167a96bdf"><div class="ttname"><a href="icalperiod_8h.html#ae184bb1351602b7763044c5167a96bdf">icalperiodtype_is_null_period</a></div><div class="ttdeci">int icalperiodtype_is_null_period(struct icalperiodtype p)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:144</div></div>
<div class="ttc" id="structicaldurationtype_html"><div class="ttname"><a href="structicaldurationtype.html">icaldurationtype</a></div><div class="ttdoc">A struct representing a duration. </div><div class="ttdef"><b>Definition:</b> icalduration.h:36</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:104</div></div>
<div class="ttc" id="icalperiod_8h_html_af7feaf12370cd37d66d160c4d8fbf0c7"><div class="ttname"><a href="icalperiod_8h.html#af7feaf12370cd37d66d160c4d8fbf0c7">icalperiodtype_is_valid_period</a></div><div class="ttdeci">int icalperiodtype_is_valid_period(struct icalperiodtype p)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:154</div></div>
<div class="ttc" id="icalperiod_8h_html_a60e59a9f46a1efa9885829a4d23eddfa"><div class="ttname"><a href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a></div><div class="ttdeci">struct icalperiodtype icalperiodtype_null_period(void)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:133</div></div>
<div class="ttc" id="icalperiod_8h_html_ac84e7fc00fa25286c1f109eb35a10883"><div class="ttname"><a href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a></div><div class="ttdeci">const char * icalperiodtype_as_ical_string(struct icalperiodtype p)</div><div class="ttdoc">Converts an icalperiodtype into an iCal-formatted string. </div><div class="ttdef"><b>Definition:</b> icalperiod.c:94</div></div>
</div><!-- fragment --></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.14
</small></address>
</body>
</html>
|
