diff options
author | Allen Winter <allen.winter@kdab.com> | 2014-09-26 17:04:59 -0400 |
---|---|---|
committer | Allen Winter <allen.winter@kdab.com> | 2014-09-26 17:04:59 -0400 |
commit | 783c08bf572924af599e0ab1396a310897924c95 (patch) | |
tree | 31117798a5fde034e3783024051b45517160344e /apidocs/icalgauge_8h.html | |
parent | 8364401e95ec796f4c54521969e67a068c85a380 (diff) | |
download | libical-git-783c08bf572924af599e0ab1396a310897924c95.tar.gz |
api documentation, first version
Diffstat (limited to 'apidocs/icalgauge_8h.html')
-rw-r--r-- | apidocs/icalgauge_8h.html | 200 |
1 files changed, 200 insertions, 0 deletions
diff --git a/apidocs/icalgauge_8h.html b/apidocs/icalgauge_8h.html new file mode 100644 index 00000000..002d74d7 --- /dev/null +++ b/apidocs/icalgauge_8h.html @@ -0,0 +1,200 @@ +<!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.3.1"/> +<title>Libical: 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 style="padding-left: 0.5em;"> + <div id="projectname">Libical +  <span id="projectnumber">1.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.3.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></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> | +<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> +<div class="textblock"><code>#include "icalcomponent.h"</code><br/> +</div> +<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 name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:a20ae018b692cbce85360448b5fbfe1f7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20ae018b692cbce85360448b5fbfe1f7"></a> +typedef struct <a class="el" href="structicalgauge__impl.html">icalgauge_impl</a> </td><td class="memItemRight" valign="bottom"><b>icalgauge</b></td></tr> +<tr class="separator:a20ae018b692cbce85360448b5fbfe1f7"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a59c8a1a81f5a81d6624f02a33b110bbc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59c8a1a81f5a81d6624f02a33b110bbc"></a> +char * </td><td class="memItemRight" valign="bottom"><b>icalgauge_as_sql</b> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *gauge)</td></tr> +<tr class="separator:a59c8a1a81f5a81d6624f02a33b110bbc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9047a63c23d86af1b2ad3a2dd4ba63bd"><td class="memItemLeft" align="right" valign="top">int </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"> </td><td class="mdescRight">Return true if comp matches the gauge. <a href="#a9047a63c23d86af1b2ad3a2dd4ba63bd">More...</a><br/></td></tr> +<tr class="separator:a9047a63c23d86af1b2ad3a2dd4ba63bd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3000c05fd412869503e8499c07030f48"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3000c05fd412869503e8499c07030f48"></a> +void </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"> </td><td class="mdescRight">Debug Print gauge information to stdout. <br/></td></tr> +<tr class="separator:a3000c05fd412869503e8499c07030f48"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1f29a1f14146a67013121226c0d77cd1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f29a1f14146a67013121226c0d77cd1"></a> +void </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"> </td></tr> +<tr class="memitem:a0e3a08b481636446b7d1cbefeba82998"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e3a08b481636446b7d1cbefeba82998"></a> +int </td><td class="memItemRight" valign="bottom"><b>icalgauge_get_expand</b> (<a class="el" href="structicalgauge__impl.html">icalgauge</a> *gauge)</td></tr> +<tr class="separator:a0e3a08b481636446b7d1cbefeba82998"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a88671fc0699e1ceda81a92b0109cf349"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalgauge_8h.html#a88671fc0699e1ceda81a92b0109cf349">icalgauge_new_clone</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="separator:a88671fc0699e1ceda81a92b0109cf349"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abbbba1148f033eeb33d715dcb2432295"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abbbba1148f033eeb33d715dcb2432295"></a> +<a class="el" href="structicalgauge__impl.html">icalgauge</a> * </td><td class="memItemRight" valign="bottom"><b>icalgauge_new_from_sql</b> (char *sql, int expand)</td></tr> +<tr class="separator:abbbba1148f033eeb33d715dcb2432295"><td class="memSeparator" colspan="2"> </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 class="anchor" id="a9047a63c23d86af1b2ad3a2dd4ba63bd"></a> +<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> * </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> * </td> + <td class="paramname"><em>comp</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Return true if comp matches the gauge. </p> +<p>The component must be in cannonical form – a VCALENDAR with one VEVENT, VTODO or VJOURNAL sub component </p> +<p>needs to use recurrence-id to do comparison </p> + +</div> +</div> +<a class="anchor" id="a88671fc0699e1ceda81a92b0109cf349"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalgauge_new_clone </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalgauge__impl.html">icalgauge</a> * </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> * </td> + <td class="paramname"><em>comp</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Clone the component, but only return the properties specified in the gauge </p> + +</div> +</div> +</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.3.1 +</small></address> +</body> +</html> |