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
|
<!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=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: icalproperty.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.15 -->
<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">icalproperty.h</div> </div>
</div><!--header-->
<div class="contents">
<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: icalproperty.h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> CREATOR: eric 20 March 1999</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> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef ICALPROPERTY_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define ICALPROPERTY_H</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">#include "libical_ical_export.h"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "icalderivedproperty.h"</span> <span class="comment">/* To get icalproperty_kind enumerations */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <stdarg.h></span> <span class="comment">/* for va_... */</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new(icalproperty_kind kind);</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new_impl(icalproperty_kind kind);</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new_clone(icalproperty *prop);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new_from_string(<span class="keyword">const</span> <span class="keywordtype">char</span> *str);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icalproperty_as_ical_string(icalproperty *prop);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *icalproperty_as_ical_string_r(icalproperty *prop);</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> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_free(icalproperty *prop);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_isa(icalproperty *property);</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> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> icalproperty_isa_property(<span class="keywordtype">void</span> *property);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_add_parameters(<span class="keyword">struct</span> <a class="code" href="structicalproperty__impl.html">icalproperty_impl</a> *prop, va_list args);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_add_parameter(icalproperty *prop, icalparameter *parameter);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_set_parameter(icalproperty *prop, icalparameter *parameter);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_set_parameter_from_string(icalproperty *prop,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *name,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *value);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icalproperty_get_parameter_as_string(icalproperty *prop,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *icalproperty_get_parameter_as_string_r(icalproperty *prop,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_remove_parameter_by_kind(icalproperty *prop,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  icalparameter_kind kind);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_remove_parameter_by_name(icalproperty *prop,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_remove_parameter_by_ref(icalproperty *prop,</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  icalparameter *param);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> icalproperty_count_parameters(<span class="keyword">const</span> icalproperty *prop);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">/* Iterate through the parameters */</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> LIBICAL_ICAL_EXPORT icalparameter *icalproperty_get_first_parameter(icalproperty *prop,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  icalparameter_kind kind);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> LIBICAL_ICAL_EXPORT icalparameter *icalproperty_get_next_parameter(icalproperty *prop,</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  icalparameter_kind kind);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/* Access the value of the property */</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_set_value(icalproperty *prop, icalvalue *value);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_set_value_from_string(icalproperty *prop, <span class="keyword">const</span> <span class="keywordtype">char</span> *value,</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *kind);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> LIBICAL_ICAL_EXPORT icalvalue *icalproperty_get_value(<span class="keyword">const</span> icalproperty *prop);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icalproperty_get_value_as_string(<span class="keyword">const</span> icalproperty *prop);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *icalproperty_get_value_as_string_r(<span class="keyword">const</span> icalproperty *prop);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalvalue_set_parent(icalvalue *value, icalproperty *property);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> LIBICAL_ICAL_EXPORT icalproperty *icalvalue_get_parent(icalvalue *value);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/* Deal with X properties */</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_set_x_name(icalproperty *prop, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icalproperty_get_x_name(icalproperty *prop);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icalproperty_get_property_name(<span class="keyword">const</span> icalproperty *prop);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *icalproperty_get_property_name_r(<span class="keyword">const</span> icalproperty *prop);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> LIBICAL_ICAL_EXPORT icalvalue_kind icalparameter_value_to_value_kind(icalparameter_value value);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalparameter_set_parent(icalparameter *param, icalproperty *property);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> LIBICAL_ICAL_EXPORT icalproperty *icalparameter_get_parent(icalparameter *param);</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">/* Convert kinds to string and get default value type */</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> LIBICAL_ICAL_EXPORT icalvalue_kind icalproperty_kind_to_value_kind(icalproperty_kind kind);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_value_kind_to_kind(icalvalue_kind kind);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icalproperty_kind_to_string(icalproperty_kind kind);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_string_to_kind(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">string</span>);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> icalproperty_kind_is_valid(<span class="keyword">const</span> icalproperty_kind kind);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> LIBICAL_ICAL_EXPORT icalproperty_method icalproperty_string_to_method(<span class="keyword">const</span> <span class="keywordtype">char</span> *str);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icalproperty_method_to_string(icalproperty_method method);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icalproperty_enum_to_string(<span class="keywordtype">int</span> e);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *icalproperty_enum_to_string_r(<span class="keywordtype">int</span> e);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> icalproperty_kind_and_string_to_enum(<span class="keyword">const</span> <span class="keywordtype">int</span> kind, <span class="keyword">const</span> <span class="keywordtype">char</span> *str);</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icalproperty_status_to_string(icalproperty_status);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> LIBICAL_ICAL_EXPORT icalproperty_status icalproperty_string_to_status(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">string</span>);</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> icalproperty_enum_belongs_to_property(icalproperty_kind kind, <span class="keywordtype">int</span> e);</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalproperty_normalize(icalproperty *prop);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="preprocessor">#endif </span><span class="comment">/*ICALPROPERTY_H */</span><span class="preprocessor"></span></div><div class="ttc" id="structicalproperty__impl_html"><div class="ttname"><a href="structicalproperty__impl.html">icalproperty_impl</a></div><div class="ttdef"><b>Definition:</b> icalproperty.c:36</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.15
</small></address>
</body>
</html>
|
