diff options
Diffstat (limited to 'apidocs/classLibICal_1_1ICalSpanList.html')
| -rw-r--r-- | apidocs/classLibICal_1_1ICalSpanList.html | 343 |
1 files changed, 343 insertions, 0 deletions
diff --git a/apidocs/classLibICal_1_1ICalSpanList.html b/apidocs/classLibICal_1_1ICalSpanList.html new file mode 100644 index 00000000..bf0e34df --- /dev/null +++ b/apidocs/classLibICal_1_1ICalSpanList.html @@ -0,0 +1,343 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Libical API Documentation: LibICal::ICalSpanList Class 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 style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Libical API Documentation +  <span id="projectnumber">2.99</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</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"><b>LibICal</b></li><li class="navelem"><a class="el" href="classLibICal_1_1ICalSpanList.html">ICalSpanList</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> </div> + <div class="headertitle"> +<div class="title">LibICal::ICalSpanList Class Reference</div> </div> +</div><!--header--> +<div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a8c430847dc1c3995c12262d93f9aa974"><td class="memItemLeft" align="right" valign="top"><a id="a8c430847dc1c3995c12262d93f9aa974"></a> + </td><td class="memItemRight" valign="bottom"><b>ICalSpanList</b> (const <a class="el" href="classLibICal_1_1ICalSpanList.html">ICalSpanList</a> &v) throw (icalerrorenum)</td></tr> +<tr class="separator:a8c430847dc1c3995c12262d93f9aa974"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a009d494e48e9bd6401a80315e292e487"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLibICal_1_1ICalSpanList.html#a009d494e48e9bd6401a80315e292e487">ICalSpanList</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set, <a class="el" href="structicaltimetype.html">icaltimetype</a> start, <a class="el" href="structicaltimetype.html">icaltimetype</a> end) throw (icalerrorenum)</td></tr> +<tr class="separator:a009d494e48e9bd6401a80315e292e487"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a553e46923b9b8cdf5f45043eefab3190"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLibICal_1_1ICalSpanList.html#a553e46923b9b8cdf5f45043eefab3190">ICalSpanList</a> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp) throw (icalerrorenum)</td></tr> +<tr class="separator:a553e46923b9b8cdf5f45043eefab3190"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a677ad30a4a2d1753b3357fcdd38cfa85"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLibICal_1_1ICalSpanList.html#a677ad30a4a2d1753b3357fcdd38cfa85">ICalSpanList</a> (<a class="el" href="classLibICal_1_1VComponent.html">VComponent</a> &comp) throw (icalerrorenum)</td></tr> +<tr class="separator:a677ad30a4a2d1753b3357fcdd38cfa85"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa60a6309d691037928c20d06709e47c2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLibICal_1_1ICalSpanList.html#aa60a6309d691037928c20d06709e47c2">~ICalSpanList</a> ()</td></tr> +<tr class="separator:aa60a6309d691037928c20d06709e47c2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a90af8eaf10472184439c880382f137fc"><td class="memItemLeft" align="right" valign="top">std::vector< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classLibICal_1_1ICalSpanList.html#a90af8eaf10472184439c880382f137fc">as_vector</a> (int delta_t) throw (icalerrorenum)</td></tr> +<tr class="separator:a90af8eaf10472184439c880382f137fc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae1c6dbf5f3b15806459f12ec4b89414b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLibICal_1_1ICalSpanList.html#ae1c6dbf5f3b15806459f12ec4b89414b">dump</a> ()</td></tr> +<tr class="separator:ae1c6dbf5f3b15806459f12ec4b89414b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac1cab01d04bb4f2ef0d08ec146b4a6d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classLibICal_1_1VComponent.html">VComponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLibICal_1_1ICalSpanList.html#ac1cab01d04bb4f2ef0d08ec146b4a6d3">get_vfreebusy</a> (const char *organizer, const char *attendee) throw (icalerrorenum)</td></tr> +<tr class="separator:ac1cab01d04bb4f2ef0d08ec146b4a6d3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a56cb25afba3592979d872608d2302243"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLibICal_1_1ICalSpanList.html#a56cb25afba3592979d872608d2302243">operator icalspanlist *</a> ()</td></tr> +<tr class="separator:a56cb25afba3592979d872608d2302243"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa0c55c4133bf5d536474eafbfa92ff3d"><td class="memItemLeft" align="right" valign="top"><a id="aa0c55c4133bf5d536474eafbfa92ff3d"></a> +<a class="el" href="classLibICal_1_1ICalSpanList.html">ICalSpanList</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classLibICal_1_1ICalSpanList.html">ICalSpanList</a> &) throw (icalerrorenum)</td></tr> +<tr class="separator:aa0c55c4133bf5d536474eafbfa92ff3d"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This class wraps the icalspanlist routines in libicalss</p> +<p>Errors within libicalss are propagated via exceptions of type icalerrorenum. See <a class="el" href="icalerror_8h.html" title="Error handling for libical. ">icalerror.h</a> for the complete list of exceptions that might be thrown. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a009d494e48e9bd6401a80315e292e487"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a009d494e48e9bd6401a80315e292e487">◆ </a></span>ICalSpanList() <span class="overload">[1/3]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">LibICal::ICalSpanList::ICalSpanList </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="structicaltimetype.html">icaltimetype</a> </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structicaltimetype.html">icaltimetype</a> </td> + <td class="paramname"><em>end</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + <tr> + <td align="right">throw </td><td>(</td><td colspan="2"><a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a></td> + </tr> + <tr> + <td align="right"></td><td>)</td><td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Construct an <a class="el" href="classLibICal_1_1ICalSpanList.html">ICalSpanList</a> from an icalset </p> + +</div> +</div> +<a id="a553e46923b9b8cdf5f45043eefab3190"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a553e46923b9b8cdf5f45043eefab3190">◆ </a></span>ICalSpanList() <span class="overload">[2/3]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">LibICal::ICalSpanList::ICalSpanList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td> + <td class="paramname"><em>comp</em></td><td>)</td> + <td></td> + </tr> + <tr> + <td align="right">throw </td><td>(</td><td colspan="2"><a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a></td> + </tr> + <tr> + <td align="right"></td><td>)</td><td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Construct an <a class="el" href="classLibICal_1_1ICalSpanList.html">ICalSpanList</a> from the VFREEBUSY chunk of a icalcomponent </p> + +</div> +</div> +<a id="a677ad30a4a2d1753b3357fcdd38cfa85"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a677ad30a4a2d1753b3357fcdd38cfa85">◆ </a></span>ICalSpanList() <span class="overload">[3/3]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">LibICal::ICalSpanList::ICalSpanList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classLibICal_1_1VComponent.html">VComponent</a> & </td> + <td class="paramname"><em>comp</em></td><td>)</td> + <td></td> + </tr> + <tr> + <td align="right">throw </td><td>(</td><td colspan="2"><a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a></td> + </tr> + <tr> + <td align="right"></td><td>)</td><td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Construct an <a class="el" href="classLibICal_1_1ICalSpanList.html">ICalSpanList</a> from the VFREEBUSY chunk of a vcomponent </p> + +</div> +</div> +<a id="aa60a6309d691037928c20d06709e47c2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa60a6309d691037928c20d06709e47c2">◆ </a></span>~ICalSpanList()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">LibICal::ICalSpanList::~ICalSpanList </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Destructor </p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a90af8eaf10472184439c880382f137fc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a90af8eaf10472184439c880382f137fc">◆ </a></span>as_vector()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector< int > LibICal::ICalSpanList::as_vector </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>delta_t</em></td><td>)</td> + <td></td> + </tr> + <tr> + <td align="right">throw </td><td>(</td><td colspan="2"><a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a></td> + </tr> + <tr> + <td align="right"></td><td>)</td><td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return a vector of the number of events over delta t </p> + +</div> +</div> +<a id="ae1c6dbf5f3b15806459f12ec4b89414b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae1c6dbf5f3b15806459f12ec4b89414b">◆ </a></span>dump()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void LibICal::ICalSpanList::dump </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Dump the spanlist to stdout </p> + +</div> +</div> +<a id="ac1cab01d04bb4f2ef0d08ec146b4a6d3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac1cab01d04bb4f2ef0d08ec146b4a6d3">◆ </a></span>get_vfreebusy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classLibICal_1_1VComponent.html">VComponent</a>* LibICal::ICalSpanList::get_vfreebusy </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>organizer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>attendee</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + <tr> + <td align="right">throw </td><td>(</td><td colspan="2"><a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a></td> + </tr> + <tr> + <td align="right"></td><td>)</td><td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return a VFREEBUSY icalcomponent </p> + +</div> +</div> +<a id="a56cb25afba3592979d872608d2302243"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a56cb25afba3592979d872608d2302243">◆ </a></span>operator icalspanlist *()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">LibICal::ICalSpanList::operator <a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Return the base data when casting </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="icalspanlist__cxx_8h_source.html">icalspanlist_cxx.h</a></li> +</ul> +</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.13 +</small></address> +</body> +</html> |