summaryrefslogtreecommitdiff
path: root/apidocs/icalgauge_8h.html
blob: 3161da20920fff9798b724ee78c98f4743dc123c (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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<!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: icalgauge.h File Reference</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="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">icalgauge.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Routines implementing a filter for ical components.  
<a href="#details">More...</a></p>

<p><a href="icalgauge_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>
Typedefs</h2></td></tr>
<tr class="memitem:a20ae018b692cbce85360448b5fbfe1f7"><td class="memItemLeft" align="right" valign="top"><a id="a20ae018b692cbce85360448b5fbfe1f7" name="a20ae018b692cbce85360448b5fbfe1f7"></a>
typedef struct <a class="el" href="structicalgauge__impl.html">icalgauge_impl</a>&#160;</td><td class="memItemRight" valign="bottom"><b>icalgauge</b></td></tr>
<tr class="separator:a20ae018b692cbce85360448b5fbfe1f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9047a63c23d86af1b2ad3a2dd4ba63bd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="icalgauge_8h.html#a9047a63c23d86af1b2ad3a2dd4ba63bd">icalgauge_compare</a> (<a class="el" href="structicalgauge__impl.html">icalgauge</a> *g, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr>
<tr class="memdesc:a9047a63c23d86af1b2ad3a2dd4ba63bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if comp matches the gauge.  <a href="icalgauge_8h.html#a9047a63c23d86af1b2ad3a2dd4ba63bd">More...</a><br /></td></tr>
<tr class="separator:a9047a63c23d86af1b2ad3a2dd4ba63bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3000c05fd412869503e8499c07030f48"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="icalgauge_8h.html#a3000c05fd412869503e8499c07030f48">icalgauge_dump</a> (<a class="el" href="structicalgauge__impl.html">icalgauge</a> *gauge)</td></tr>
<tr class="memdesc:a3000c05fd412869503e8499c07030f48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug.  <a href="icalgauge_8h.html#a3000c05fd412869503e8499c07030f48">More...</a><br /></td></tr>
<tr class="separator:a3000c05fd412869503e8499c07030f48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f29a1f14146a67013121226c0d77cd1"><td class="memItemLeft" align="right" valign="top"><a id="a1f29a1f14146a67013121226c0d77cd1" name="a1f29a1f14146a67013121226c0d77cd1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>icalgauge_free</b> (<a class="el" href="structicalgauge__impl.html">icalgauge</a> *gauge)</td></tr>
<tr class="separator:a1f29a1f14146a67013121226c0d77cd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e3a08b481636446b7d1cbefeba82998"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="icalgauge_8h.html#a0e3a08b481636446b7d1cbefeba82998">icalgauge_get_expand</a> (<a class="el" href="structicalgauge__impl.html">icalgauge</a> *gauge)</td></tr>
<tr class="separator:a0e3a08b481636446b7d1cbefeba82998"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fb0409762bf525c18c0266e7ff0a39f"><td class="memItemLeft" align="right" valign="top"><a id="a8fb0409762bf525c18c0266e7ff0a39f" name="a8fb0409762bf525c18c0266e7ff0a39f"></a>
<a class="el" href="structicalgauge__impl.html">icalgauge</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>icalgauge_new_from_sql</b> (const char *sql, int expand)</td></tr>
<tr class="separator:a8fb0409762bf525c18c0266e7ff0a39f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Routines implementing a filter for ical components. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a9047a63c23d86af1b2ad3a2dd4ba63bd" name="a9047a63c23d86af1b2ad3a2dd4ba63bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9047a63c23d86af1b2ad3a2dd4ba63bd">&#9670;&nbsp;</a></span>icalgauge_compare()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int icalgauge_compare </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structicalgauge__impl.html">icalgauge</a> *&#160;</td>
          <td class="paramname"><em>g</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *&#160;</td>
          <td class="paramname"><em>comp</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns true if comp matches the gauge. </p>
<p >The component must be in canonical form &ndash; a VCALENDAR with one VEVENT, VTODO or VJOURNAL sub component </p>
<p >needs to use recurrence-id to do comparison</p>

</div>
</div>
<a id="a3000c05fd412869503e8499c07030f48" name="a3000c05fd412869503e8499c07030f48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3000c05fd412869503e8499c07030f48">&#9670;&nbsp;</a></span>icalgauge_dump()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void icalgauge_dump </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structicalgauge__impl.html">icalgauge</a> *&#160;</td>
          <td class="paramname"><em>gauge</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Debug. </p>
<p >Prints gauge information to STDOUT. </p>

</div>
</div>
<a id="a0e3a08b481636446b7d1cbefeba82998" name="a0e3a08b481636446b7d1cbefeba82998"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e3a08b481636446b7d1cbefeba82998">&#9670;&nbsp;</a></span>icalgauge_get_expand()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int icalgauge_get_expand </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structicalgauge__impl.html">icalgauge</a> *&#160;</td>
          <td class="paramname"><em>gauge</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Returns the expand value for the specified icalgauge. If <code>gauge</code> is NULL a value of -1 is returned. </p>

</div>
</div>
</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>