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/icalset_8h.html | |
parent | 8364401e95ec796f4c54521969e67a068c85a380 (diff) | |
download | libical-git-783c08bf572924af599e0ab1396a310897924c95.tar.gz |
api documentation, first version
Diffstat (limited to 'apidocs/icalset_8h.html')
-rw-r--r-- | apidocs/icalset_8h.html | 510 |
1 files changed, 510 insertions, 0 deletions
diff --git a/apidocs/icalset_8h.html b/apidocs/icalset_8h.html new file mode 100644 index 00000000..12199cd4 --- /dev/null +++ b/apidocs/icalset_8h.html @@ -0,0 +1,510 @@ +<!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: icalset.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="#nested-classes">Data Structures</a> | +<a href="#define-members">Macros</a> | +<a href="#typedef-members">Typedefs</a> | +<a href="#enum-members">Enumerations</a> | +<a href="#func-members">Functions</a> | +<a href="#var-members">Variables</a> </div> + <div class="headertitle"> +<div class="title">icalset.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <limits.h></code><br/> +<code>#include <libical/ical.h></code><br/> +<code>#include "<a class="el" href="icalgauge_8h_source.html">icalgauge.h</a>"</code><br/> +</div> +<p><a href="icalset_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="nested-classes"></a> +Data Structures</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structicalset__impl.html">icalset_impl</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structicalsetiter.html">icalsetiter</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:aa88723bb5a6bc3290b400af971c21bf5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa88723bb5a6bc3290b400af971c21bf5"></a> +#define </td><td class="memItemRight" valign="bottom"><b>ICAL_PATH_MAX</b>   1024</td></tr> +<tr class="separator:aa88723bb5a6bc3290b400af971c21bf5"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:afd61fe1666039b2ddaca8e6f7403fd7d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd61fe1666039b2ddaca8e6f7403fd7d"></a> +typedef struct <a class="el" href="structicalset__impl.html">icalset_impl</a> </td><td class="memItemRight" valign="bottom"><b>icalset</b></td></tr> +<tr class="separator:afd61fe1666039b2ddaca8e6f7403fd7d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a66924788348bffed0ff8e258e428d622"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66924788348bffed0ff8e258e428d622"></a> +typedef enum icalset_kind </td><td class="memItemRight" valign="bottom"><b>icalset_kind</b></td></tr> +<tr class="separator:a66924788348bffed0ff8e258e428d622"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7804d7b8c9e916feccea66dd372d00f4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7804d7b8c9e916feccea66dd372d00f4"></a> +typedef struct <a class="el" href="structicalsetiter.html">icalsetiter</a> </td><td class="memItemRight" valign="bottom"><b>icalsetiter</b></td></tr> +<tr class="separator:a7804d7b8c9e916feccea66dd372d00f4"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +Enumerations</h2></td></tr> +<tr class="memitem:a39089640736d0c8dcaf5a1cb3bb9a40b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>icalset_kind</b> { <b>ICAL_FILE_SET</b>, +<b>ICAL_DIR_SET</b>, +<b>ICAL_BDB_SET</b> + }</td></tr> +<tr class="separator:a39089640736d0c8dcaf5a1cb3bb9a40b"><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:add0cc2ad5e7d5cd11aba745c5ec58078"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add0cc2ad5e7d5cd11aba745c5ec58078"></a> +icalerrorenum </td><td class="memItemRight" valign="bottom"><b>icalset_add_component</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr> +<tr class="separator:add0cc2ad5e7d5cd11aba745c5ec58078"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aadee54652cebe71ec9b4a8cfd4b769db"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadee54652cebe71ec9b4a8cfd4b769db"></a> +<a class="el" href="structicalsetiter.html">icalsetiter</a> </td><td class="memItemRight" valign="bottom"><b>icalset_begin_component</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, icalcomponent_kind kind, <a class="el" href="structicalgauge__impl.html">icalgauge</a> *gauge)</td></tr> +<tr class="separator:aadee54652cebe71ec9b4a8cfd4b769db"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abcd096d98f98b701322eaa69a339938b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalset_8h.html#abcd096d98f98b701322eaa69a339938b">icalset_clear_select</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr> +<tr class="separator:abcd096d98f98b701322eaa69a339938b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2c852ee9d1ddd570809482ba56fee0e6"><td class="memItemLeft" align="right" valign="top">icalerrorenum </td><td class="memItemRight" valign="bottom"><a class="el" href="icalset_8h.html#a2c852ee9d1ddd570809482ba56fee0e6">icalset_commit</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr> +<tr class="separator:a2c852ee9d1ddd570809482ba56fee0e6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a390d0352fbbab0e3e79ee0ee5c88c1df"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a390d0352fbbab0e3e79ee0ee5c88c1df"></a> +int </td><td class="memItemRight" valign="bottom"><b>icalset_count_components</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, icalcomponent_kind kind)</td></tr> +<tr class="separator:a390d0352fbbab0e3e79ee0ee5c88c1df"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5a9f949dad6062549a59c4d3ea47ba4a"><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="icalset_8h.html#a5a9f949dad6062549a59c4d3ea47ba4a">icalset_fetch</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set, const char *uid)</td></tr> +<tr class="separator:a5a9f949dad6062549a59c4d3ea47ba4a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae088baa2bc4df4e56f14cb895caf80e2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae088baa2bc4df4e56f14cb895caf80e2"></a> +<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icalset_fetch_match</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *c)</td></tr> +<tr class="separator:ae088baa2bc4df4e56f14cb895caf80e2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2a602a0901474216b3dddbd21f5ff8f5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalset_8h.html#a2a602a0901474216b3dddbd21f5ff8f5">icalset_free</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr> +<tr class="separator:a2a602a0901474216b3dddbd21f5ff8f5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a70f4a1f9227386ffee719e7f6d3a02c4"><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="icalset_8h.html#a70f4a1f9227386ffee719e7f6d3a02c4">icalset_get_current_component</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr> +<tr class="separator:a70f4a1f9227386ffee719e7f6d3a02c4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac80f79ccb4fb9fba9811cf9b852c075d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac80f79ccb4fb9fba9811cf9b852c075d"></a> +<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icalset_get_first_component</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr> +<tr class="separator:ac80f79ccb4fb9fba9811cf9b852c075d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a99f9cd8ebd8ac6ee1e0c9cff9034e6eb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99f9cd8ebd8ac6ee1e0c9cff9034e6eb"></a> +<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icalset_get_next_component</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr> +<tr class="separator:a99f9cd8ebd8ac6ee1e0c9cff9034e6eb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a741f744dc23853a6629ebd4935618da0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a741f744dc23853a6629ebd4935618da0"></a> +int </td><td class="memItemRight" valign="bottom"><b>icalset_has_uid</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, const char *uid)</td></tr> +<tr class="separator:a741f744dc23853a6629ebd4935618da0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2caa3e1d3c665fe107dde1e4be8c49c1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalset_8h.html#a2caa3e1d3c665fe107dde1e4be8c49c1">icalset_mark</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr> +<tr class="separator:a2caa3e1d3c665fe107dde1e4be8c49c1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afb2fbb4b1dae61bd4e2ad78c70daa1df"><td class="memItemLeft" align="right" valign="top">icalerrorenum </td><td class="memItemRight" valign="bottom"><a class="el" href="icalset_8h.html#afb2fbb4b1dae61bd4e2ad78c70daa1df">icalset_modify</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *oldc, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *newc)</td></tr> +<tr class="separator:afb2fbb4b1dae61bd4e2ad78c70daa1df"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0d3558a1f82345c09f96769f6be736be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalset__impl.html">icalset</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalset_8h.html#a0d3558a1f82345c09f96769f6be736be">icalset_new</a> (icalset_kind kind, const char *dsn, void *options)</td></tr> +<tr class="memdesc:a0d3558a1f82345c09f96769f6be736be"><td class="mdescLeft"> </td><td class="mdescRight">Generic icalset constructor. <a href="#a0d3558a1f82345c09f96769f6be736be">More...</a><br/></td></tr> +<tr class="separator:a0d3558a1f82345c09f96769f6be736be"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9ca5cae787bab5df5ac37561721c5c2f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ca5cae787bab5df5ac37561721c5c2f"></a> +<a class="el" href="structicalset__impl.html">icalset</a> * </td><td class="memItemRight" valign="bottom"><b>icalset_new_dir</b> (const char *path)</td></tr> +<tr class="separator:a9ca5cae787bab5df5ac37561721c5c2f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0e7d1881941d2b32e9830b98d502c594"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e7d1881941d2b32e9830b98d502c594"></a> +<a class="el" href="structicalset__impl.html">icalset</a> * </td><td class="memItemRight" valign="bottom"><b>icalset_new_file</b> (const char *path)</td></tr> +<tr class="separator:a0e7d1881941d2b32e9830b98d502c594"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae8a1b23f38d528e68ea671e5e195c2d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8a1b23f38d528e68ea671e5e195c2d4"></a> +<a class="el" href="structicalset__impl.html">icalset</a> * </td><td class="memItemRight" valign="bottom"><b>icalset_new_file_reader</b> (const char *path)</td></tr> +<tr class="separator:ae8a1b23f38d528e68ea671e5e195c2d4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a92a1865bf5c2dd424d8593a9a58933a9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92a1865bf5c2dd424d8593a9a58933a9"></a> +<a class="el" href="structicalset__impl.html">icalset</a> * </td><td class="memItemRight" valign="bottom"><b>icalset_new_file_writer</b> (const char *path)</td></tr> +<tr class="separator:a92a1865bf5c2dd424d8593a9a58933a9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae681fcb1547b57ebdeb5bb4e045e3ec0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae681fcb1547b57ebdeb5bb4e045e3ec0"></a> +const char * </td><td class="memItemRight" valign="bottom"><b>icalset_path</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr> +<tr class="separator:ae681fcb1547b57ebdeb5bb4e045e3ec0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a40ba946500e79218ae39f89db5397121"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40ba946500e79218ae39f89db5397121"></a> +int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalset_8h.html#a40ba946500e79218ae39f89db5397121">icalset_register_class</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr> +<tr class="memdesc:a40ba946500e79218ae39f89db5397121"><td class="mdescLeft"> </td><td class="mdescRight">Register a new derived class. <br/></td></tr> +<tr class="separator:a40ba946500e79218ae39f89db5397121"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2e8b8d6392761d9b41848c64784e3ac3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e8b8d6392761d9b41848c64784e3ac3"></a> +icalerrorenum </td><td class="memItemRight" valign="bottom"><b>icalset_remove_component</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr> +<tr class="separator:a2e8b8d6392761d9b41848c64784e3ac3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0d4a88d44364f1da9e107f99926a7217"><td class="memItemLeft" align="right" valign="top">icalerrorenum </td><td class="memItemRight" valign="bottom"><a class="el" href="icalset_8h.html#a0d4a88d44364f1da9e107f99926a7217">icalset_select</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set, <a class="el" href="structicalgauge__impl.html">icalgauge</a> *gauge)</td></tr> +<tr class="separator:a0d4a88d44364f1da9e107f99926a7217"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a08ce74b26a9e7ca6beee38bf4777e249"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08ce74b26a9e7ca6beee38bf4777e249"></a> +<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icalsetiter_deref</b> (<a class="el" href="structicalsetiter.html">icalsetiter</a> *i)</td></tr> +<tr class="separator:a08ce74b26a9e7ca6beee38bf4777e249"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adafa15e2aaa912a5249bd4b0c5a0f90a"><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="icalset_8h.html#adafa15e2aaa912a5249bd4b0c5a0f90a">icalsetiter_next</a> (<a class="el" href="structicalsetiter.html">icalsetiter</a> *i)</td></tr> +<tr class="separator:adafa15e2aaa912a5249bd4b0c5a0f90a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a89abcf2a8ca067be41370edd58117913"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89abcf2a8ca067be41370edd58117913"></a> +<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icalsetiter_prior</b> (<a class="el" href="structicalsetiter.html">icalsetiter</a> *i)</td></tr> +<tr class="separator:a89abcf2a8ca067be41370edd58117913"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5f6fa6d4ff922d7de93a53fc210f74c7"><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="icalset_8h.html#a5f6fa6d4ff922d7de93a53fc210f74c7">icalsetiter_to_next</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set, <a class="el" href="structicalsetiter.html">icalsetiter</a> *i)</td></tr> +<tr class="separator:a5f6fa6d4ff922d7de93a53fc210f74c7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a56a39d015d5560137307aa65e7ed78ae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56a39d015d5560137307aa65e7ed78ae"></a> +<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icalsetiter_to_prior</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, <a class="el" href="structicalsetiter.html">icalsetiter</a> *i)</td></tr> +<tr class="separator:a56a39d015d5560137307aa65e7ed78ae"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> +Variables</h2></td></tr> +<tr class="memitem:a66eebdc183a6a66a99d91a5275ccd6ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalsetiter.html">icalsetiter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalset_8h.html#a66eebdc183a6a66a99d91a5275ccd6ec">icalsetiter_null</a></td></tr> +<tr class="separator:a66eebdc183a6a66a99d91a5275ccd6ec"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><dl class="section author"><dt>Author</dt><dd>eric 28 November 1999</dd></dl> +<p>Icalset is the "base class" for representations of a collection of iCal components. Derived classes (actually delegatees) include:</p> +<p>icalfileset Store components in a single file icaldirset Store components in multiple files in a directory icalbdbset Store components in a Berkeley DB File icalheapset Store components on the heap icalmysqlset Store components in a mysql database. </p> +</div><h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="abcd096d98f98b701322eaa69a339938b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalset_clear_select </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td> + <td class="paramname"><em>set</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Clears the gauge defined by <a class="el" href="icalset_8h.html#a0d4a88d44364f1da9e107f99926a7217">icalset_select()</a> </p> + +</div> +</div> +<a class="anchor" id="a2c852ee9d1ddd570809482ba56fee0e6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">icalerrorenum icalset_commit </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td> + <td class="paramname"><em>set</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Write changes to disk immediately </p> + +</div> +</div> +<a class="anchor" id="a5a9f949dad6062549a59c4d3ea47ba4a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalset_fetch </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td> + <td class="paramname"><em>set</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>uid</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get a component by uid </p> + +</div> +</div> +<a class="anchor" id="a2a602a0901474216b3dddbd21f5ff8f5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalset_free </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td> + <td class="paramname"><em>set</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>free memory associated with this icalset automatically calls the implementation specific free routine </p> + +</div> +</div> +<a class="anchor" id="a70f4a1f9227386ffee719e7f6d3a02c4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalset_get_current_component </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td> + <td class="paramname"><em>set</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Iterate through the components. If a guage has been defined, these will skip over components that do not pass the gauge </p> + +</div> +</div> +<a class="anchor" id="a2caa3e1d3c665fe107dde1e4be8c49c1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalset_mark </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td> + <td class="paramname"><em>set</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Mark the cluster as changed, so it will be written to disk when it is freed. </p> + +</div> +</div> +<a class="anchor" id="afb2fbb4b1dae61bd4e2ad78c70daa1df"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">icalerrorenum icalset_modify </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td> + <td class="paramname"><em>set</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>oldc</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>newc</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Modify components according to the MODIFY method of CAP. Works on the currently selected components. </p> + +</div> +</div> +<a class="anchor" id="a0d3558a1f82345c09f96769f6be736be"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structicalset__impl.html">icalset</a>* icalset_new </td> + <td>(</td> + <td class="paramtype">icalset_kind </td> + <td class="paramname"><em>kind</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>dsn</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>options</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Generic icalset constructor. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">kind</td><td>The type of icalset to create </td></tr> + <tr><td class="paramname">dsn</td><td>Data Source Name - usually a pathname or DB handle </td></tr> + <tr><td class="paramname">options</td><td>Any implementation specific options</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A valid icalset reference or NULL if error.</dd></dl> +<p>This creates any of the icalset types available. </p> +<p>unimplemented</p> +<p>call the implementation specific initializer </p> + +</div> +</div> +<a class="anchor" id="a0d4a88d44364f1da9e107f99926a7217"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">icalerrorenum icalset_select </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td> + <td class="paramname"><em>set</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structicalgauge__impl.html">icalgauge</a> * </td> + <td class="paramname"><em>gauge</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Restrict the component returned by icalset_first, _next to those that pass the gauge. </p> + +</div> +</div> +<a class="anchor" id="adafa15e2aaa912a5249bd4b0c5a0f90a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalsetiter_next </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalsetiter.html">icalsetiter</a> * </td> + <td class="paramname"><em>i</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Default _next, _prior, _deref for subclasses that use single cluster </p> + +</div> +</div> +<a class="anchor" id="a5f6fa6d4ff922d7de93a53fc210f74c7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalsetiter_to_next </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td> + <td class="paramname"><em>set</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structicalsetiter.html">icalsetiter</a> * </td> + <td class="paramname"><em>i</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>for subclasses that use multiple clusters that require specialized cluster traversal </p> + +</div> +</div> +<h2 class="groupheader">Variable Documentation</h2> +<a class="anchor" id="a66eebdc183a6a66a99d91a5275ccd6ec"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structicalsetiter.html">icalsetiter</a> icalsetiter_null</td> + </tr> + </table> +</div><div class="memdoc"> +<p>External Iterator with gauge - for thread safety </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> |