<?xml version="1.0" encoding="UTF-8"?> <!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" lang="en" xml:lang="en"> <head> <title>KCal::CalFormat Class Reference</title> <style type="text/css"> .cp-doNotDisplay { display: none; } @media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }} .cp-edit { text-align: right; } @media print, embossed { .cp-edit { display: none; }} </style> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" /> <meta name="trademark" content="KDE e.V." /> <meta name="description" content="K Desktop Environment Homepage, KDE.org" /> <meta name="MSSmartTagsPreventParsing" content="true" /> <meta name="robots" content="all" /> <meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" /> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link rel="shortcut icon" href="../../favicon.ico" /><link rel="icon" href="../../favicon.ico" /> <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../kde.css" /> <link rel="stylesheet" media="print, embossed" type="text/css" href="../../print.css" /> <link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../flat.css" /> <link rel="stylesheet" type="text/css" href="../../doxygen.css" /> <link rel="stylesheet" type="text/css" href="../../tabs.css" /> </head> <body> <ul class="cp-doNotDisplay"> <li><a href="#cp-content" accesskey="2">Skip to content</a></li> <li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li> </ul> <div id="container"> <div id="header"> <div id="header_top"><div><div> <img alt ="" src="../../top-kde.jpg"/> </div></div></div> <div id="header_bottom"> <div id="location"> <ul> <li><a href="http://api.kde.org">KDE API Reference</a></li> <li><a href="../../index.html">kdepimlibs-4.10.5 API Reference</a></li> </ul> </div> <div id="menu"> <ul> <li><a href="http://www.kde.org/">KDE Home</a></li> <li><a href="http://kde.org/contact/">Contact Us</a></li> </ul> </div> </div> </div> <!-- End page header --> <div id="body_wrapper"> <div id="body"> <!-- begin main content --> <div id="right"> <div class="content"> <div id="main"> <div class="clearer"> </div> <h2><a name="content"></a>KCal Library</h2> <!-- BC --> <div id="top"> <!-- Generated by Doxygen 1.8.3.1 --> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceKCal.html">KCal</a></li><li class="navelem"><a class="el" href="classKCal_1_1CalFormat.html">CalFormat</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="classKCal_1_1CalFormat-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">KCal::CalFormat Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="calformat_8h_source.html">calformat.h</a>></code></p> <div class="dynheader"> Inheritance diagram for KCal::CalFormat:</div> <div class="dyncontent"> <div class="center"> <img src="classKCal_1_1CalFormat.png" usemap="#KCal::CalFormat_map" alt=""/> <map id="KCal::CalFormat_map" name="KCal::CalFormat_map"> <area href="classKCal_1_1ICalFormat.html" title="iCalendar format implementation." alt="KCal::ICalFormat" shape="rect" coords="0,56,121,80"/> <area href="classKCal_1_1QtopiaFormat.html" title="This class implements the calendar format used by Qtopia." alt="KCal::QtopiaFormat" shape="rect" coords="131,56,252,80"/> </map> </div></div> <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:a79521c5597be2ba29e292e54ff729317"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a79521c5597be2ba29e292e54ff729317">CalFormat</a> ()</td></tr> <tr class="separator:a79521c5597be2ba29e292e54ff729317"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3f81d89cd92e072c3f8194eb4b2e2876"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a3f81d89cd92e072c3f8194eb4b2e2876">~CalFormat</a> ()</td></tr> <tr class="separator:a3f81d89cd92e072c3f8194eb4b2e2876"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2996f3b49cbd7595312ffe80e6c7685e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a2996f3b49cbd7595312ffe80e6c7685e">clearException</a> ()</td></tr> <tr class="separator:a2996f3b49cbd7595312ffe80e6c7685e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abbc98894ae8c89b897f5c1e0adbb28e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKCal_1_1ErrorFormat.html">ErrorFormat</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#abbc98894ae8c89b897f5c1e0adbb28e2">exception</a> ()</td></tr> <tr class="separator:abbc98894ae8c89b897f5c1e0adbb28e2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad1db3b3b032b9f19a6aac69b6f11e5e2"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#ad1db3b3b032b9f19a6aac69b6f11e5e2">fromRawString</a> (<a class="el" href="classKCal_1_1Calendar.html">Calendar</a> *calendar, const QByteArray &string)=0</td></tr> <tr class="separator:ad1db3b3b032b9f19a6aac69b6f11e5e2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8475dc1c8c6c2a84be5826b2c01edee5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a8475dc1c8c6c2a84be5826b2c01edee5">fromString</a> (<a class="el" href="classKCal_1_1Calendar.html">Calendar</a> *calendar, const QString &string)=0</td></tr> <tr class="separator:a8475dc1c8c6c2a84be5826b2c01edee5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab0f56e1df2ea6f2a0ff657ca5dbfa9be"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#ab0f56e1df2ea6f2a0ff657ca5dbfa9be">load</a> (<a class="el" href="classKCal_1_1Calendar.html">Calendar</a> *calendar, const QString &fileName)=0</td></tr> <tr class="separator:ab0f56e1df2ea6f2a0ff657ca5dbfa9be"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9fb6c73494e6515064c0d783237378d2"><td class="memItemLeft" align="right" valign="top">const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a9fb6c73494e6515064c0d783237378d2">loadedProductId</a> ()</td></tr> <tr class="separator:a9fb6c73494e6515064c0d783237378d2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3ffd5bd1e96be91f28e077ba769849d0"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a3ffd5bd1e96be91f28e077ba769849d0">save</a> (<a class="el" href="classKCal_1_1Calendar.html">Calendar</a> *calendar, const QString &fileName)=0</td></tr> <tr class="separator:a3ffd5bd1e96be91f28e077ba769849d0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1a076363ad2cdc50c972dbf42ab589b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a1a076363ad2cdc50c972dbf42ab589b2">setException</a> (<a class="el" href="classKCal_1_1ErrorFormat.html">ErrorFormat</a> *error)</td></tr> <tr class="separator:a1a076363ad2cdc50c972dbf42ab589b2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a06a06f66edfb9fb6142fc0e506ea5350"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a06a06f66edfb9fb6142fc0e506ea5350">toString</a> (<a class="el" href="classKCal_1_1Calendar.html">Calendar</a> *calendar)=0</td></tr> <tr class="separator:a06a06f66edfb9fb6142fc0e506ea5350"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a94637dc2964f1ea8eeb2b1103997f665"><td class="memItemLeft" align="right" valign="top">static const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a94637dc2964f1ea8eeb2b1103997f665">application</a> ()</td></tr> <tr class="separator:a94637dc2964f1ea8eeb2b1103997f665"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0cf1b3de8c9fd981c7d616c2cef48595"><td class="memItemLeft" align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a0cf1b3de8c9fd981c7d616c2cef48595">createUniqueId</a> ()</td></tr> <tr class="separator:a0cf1b3de8c9fd981c7d616c2cef48595"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab4a0a7e561b630af42f1315495e7f006"><td class="memItemLeft" align="right" valign="top">static const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#ab4a0a7e561b630af42f1315495e7f006">productId</a> ()</td></tr> <tr class="separator:ab4a0a7e561b630af42f1315495e7f006"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7ea8ed2974cc331baaa1e0f793e96fe8"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a7ea8ed2974cc331baaa1e0f793e96fe8">setApplication</a> (const QString &<a class="el" href="classKCal_1_1CalFormat.html#a94637dc2964f1ea8eeb2b1103997f665">application</a>, const QString &productID)</td></tr> <tr class="separator:a7ea8ed2974cc331baaa1e0f793e96fe8"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:a24076798e9034b6f69ebabf85672aa74"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCal_1_1CalFormat.html#a24076798e9034b6f69ebabf85672aa74">setLoadedProductId</a> (const QString &id)</td></tr> <tr class="separator:a24076798e9034b6f69ebabf85672aa74"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>An abstract base class that provides an interface to various calendar formats. </p> <p>This is the base class for calendar formats. It provides an interface for the generation/interpretation of a textual representation of a calendar. </p> <p>Definition at line <a class="el" href="calformat_8h_source.html#l00051">51</a> of file <a class="el" href="calformat_8h_source.html">calformat.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a79521c5597be2ba29e292e54ff729317"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">CalFormat::CalFormat </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructs a new <a class="el" href="classKCal_1_1Calendar.html" title="Represents the main calendar class.">Calendar</a> Format object. </p> <p>Private class that helps to provide binary compatibility between releases.</p> <p>Definition at line <a class="el" href="calformat_8cpp_source.html#l00061">61</a> of file <a class="el" href="calformat_8cpp_source.html">calformat.cpp</a>.</p> </div> </div> <a class="anchor" id="a3f81d89cd92e072c3f8194eb4b2e2876"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">CalFormat::~CalFormat </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Destructor. </p> <p>Definition at line <a class="el" href="calformat_8cpp_source.html#l00066">66</a> of file <a class="el" href="calformat_8cpp_source.html">calformat.cpp</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a94637dc2964f1ea8eeb2b1103997f665"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const QString & CalFormat::application </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the application name used in unique IDs and error messages. </p> <p>Definition at line <a class="el" href="calformat_8cpp_source.html#l00095">95</a> of file <a class="el" href="calformat_8cpp_source.html">calformat.cpp</a>.</p> </div> </div> <a class="anchor" id="a2996f3b49cbd7595312ffe80e6c7685e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void CalFormat::clearException </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Clears the exception status. </p> <p>Definition at line <a class="el" href="calformat_8cpp_source.html#l00071">71</a> of file <a class="el" href="calformat_8cpp_source.html">calformat.cpp</a>.</p> </div> </div> <a class="anchor" id="a0cf1b3de8c9fd981c7d616c2cef48595"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">QString CalFormat::createUniqueId </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Creates a unique id string. </p> <p>Definition at line <a class="el" href="calformat_8cpp_source.html#l00115">115</a> of file <a class="el" href="calformat_8cpp_source.html">calformat.cpp</a>.</p> </div> </div> <a class="anchor" id="abbc98894ae8c89b897f5c1e0adbb28e2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classKCal_1_1ErrorFormat.html">ErrorFormat</a> * CalFormat::exception </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Returns an exception, if there is any, containing information about the last error that occurred. </p> <p>Definition at line <a class="el" href="calformat_8cpp_source.html#l00083">83</a> of file <a class="el" href="calformat_8cpp_source.html">calformat.cpp</a>.</p> </div> </div> <a class="anchor" id="ad1db3b3b032b9f19a6aac69b6f11e5e2"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool KCal::CalFormat::fromRawString </td> <td>(</td> <td class="paramtype"><a class="el" href="classKCal_1_1Calendar.html">Calendar</a> * </td> <td class="paramname"><em>calendar</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QByteArray & </td> <td class="paramname"><em>string</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Parses a utf8 encoded string, returning the first iCal component encountered in that string. </p> <p>This is an overload used for efficient reading to avoid utf8 conversions, which are expensive when reading from disk.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">calendar</td><td>is the <a class="el" href="classKCal_1_1Calendar.html" title="Represents the main calendar class.">Calendar</a> to be loaded. </td></tr> <tr><td class="paramname">string</td><td>is the QByteArray containing the <a class="el" href="classKCal_1_1Calendar.html" title="Represents the main calendar class.">Calendar</a> data.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if successful; false otherwise. </dd></dl> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKCal_1_1CalFormat.html#a8475dc1c8c6c2a84be5826b2c01edee5" title="Loads a calendar from a string.">fromString()</a>, <a class="el" href="classKCal_1_1CalFormat.html#a06a06f66edfb9fb6142fc0e506ea5350" title="Returns the calendar as a string.">toString()</a>. </dd></dl> <p>Implemented in <a class="el" href="classKCal_1_1ICalFormat.html#ae65a72f015161293b505e53f87d177d8">KCal::ICalFormat</a>, and <a class="el" href="classKCal_1_1QtopiaFormat.html#acdb5b9c548b09d80406323e98dd9b852">KCal::QtopiaFormat</a>.</p> </div> </div> <a class="anchor" id="a8475dc1c8c6c2a84be5826b2c01edee5"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool KCal::CalFormat::fromString </td> <td>(</td> <td class="paramtype"><a class="el" href="classKCal_1_1Calendar.html">Calendar</a> * </td> <td class="paramname"><em>calendar</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"><em>string</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Loads a calendar from a string. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">calendar</td><td>is the <a class="el" href="classKCal_1_1Calendar.html" title="Represents the main calendar class.">Calendar</a> to be loaded. </td></tr> <tr><td class="paramname">string</td><td>is the QString containing the <a class="el" href="classKCal_1_1Calendar.html" title="Represents the main calendar class.">Calendar</a> data.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if successful; false otherwise. </dd></dl> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKCal_1_1CalFormat.html#ad1db3b3b032b9f19a6aac69b6f11e5e2" title="Parses a utf8 encoded string, returning the first iCal component encountered in that string...">fromRawString()</a>, <a class="el" href="classKCal_1_1CalFormat.html#a06a06f66edfb9fb6142fc0e506ea5350" title="Returns the calendar as a string.">toString()</a>. </dd></dl> <p>Implemented in <a class="el" href="classKCal_1_1ICalFormat.html#af83caf7a4b2190ef364d587f84c65e2f">KCal::ICalFormat</a>, and <a class="el" href="classKCal_1_1QtopiaFormat.html#a6804f7f3cb03b138775a5a8248ac741c">KCal::QtopiaFormat</a>.</p> </div> </div> <a class="anchor" id="ab0f56e1df2ea6f2a0ff657ca5dbfa9be"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool KCal::CalFormat::load </td> <td>(</td> <td class="paramtype"><a class="el" href="classKCal_1_1Calendar.html">Calendar</a> * </td> <td class="paramname"><em>calendar</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"><em>fileName</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Loads a calendar on disk into the calendar associated with this format. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">calendar</td><td>is the <a class="el" href="classKCal_1_1Calendar.html" title="Represents the main calendar class.">Calendar</a> to be loaded. </td></tr> <tr><td class="paramname">fileName</td><td>is the name of the disk file containing the <a class="el" href="classKCal_1_1Calendar.html" title="Represents the main calendar class.">Calendar</a> data.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if successful; false otherwise. </dd></dl> <p>Implemented in <a class="el" href="classKCal_1_1ICalFormat.html#abf3a248a20236375bc71617864366732">KCal::ICalFormat</a>, and <a class="el" href="classKCal_1_1QtopiaFormat.html#aa79965ebd8c68738051efa1e3bdfc6cc">KCal::QtopiaFormat</a>.</p> </div> </div> <a class="anchor" id="a9fb6c73494e6515064c0d783237378d2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const QString & CalFormat::loadedProductId </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Returns the PRODID string loaded from calendar file. </p> <p>Definition at line <a class="el" href="calformat_8cpp_source.html#l00105">105</a> of file <a class="el" href="calformat_8cpp_source.html">calformat.cpp</a>.</p> </div> </div> <a class="anchor" id="ab4a0a7e561b630af42f1315495e7f006"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const QString & CalFormat::productId </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the PRODID string to write into calendar files. </p> <p>Definition at line <a class="el" href="calformat_8cpp_source.html#l00100">100</a> of file <a class="el" href="calformat_8cpp_source.html">calformat.cpp</a>.</p> </div> </div> <a class="anchor" id="a3ffd5bd1e96be91f28e077ba769849d0"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool KCal::CalFormat::save </td> <td>(</td> <td class="paramtype"><a class="el" href="classKCal_1_1Calendar.html">Calendar</a> * </td> <td class="paramname"><em>calendar</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"><em>fileName</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Writes the calendar to disk. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">calendar</td><td>is the <a class="el" href="classKCal_1_1Calendar.html" title="Represents the main calendar class.">Calendar</a> containing the data to be saved. </td></tr> <tr><td class="paramname">fileName</td><td>is the name of the file to write the calendar data.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if successful; false otherwise. </dd></dl> <p>Implemented in <a class="el" href="classKCal_1_1ICalFormat.html#aa21c0da1d38e6aaa4435258f8642c014">KCal::ICalFormat</a>, and <a class="el" href="classKCal_1_1QtopiaFormat.html#a74e27fb1ec4b39bba802b90e45ced710">KCal::QtopiaFormat</a>.</p> </div> </div> <a class="anchor" id="a7ea8ed2974cc331baaa1e0f793e96fe8"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void CalFormat::setApplication </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>application</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"><em>productID</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Sets the application name for use in unique IDs and error messages, and product ID for incidence PRODID property. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">application</td><td>is a string containing the application name. </td></tr> <tr><td class="paramname">productID</td><td>is a string containing the product identifier. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="calformat_8cpp_source.html#l00088">88</a> of file <a class="el" href="calformat_8cpp_source.html">calformat.cpp</a>.</p> </div> </div> <a class="anchor" id="a1a076363ad2cdc50c972dbf42ab589b2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void CalFormat::setException </td> <td>(</td> <td class="paramtype"><a class="el" href="classKCal_1_1ErrorFormat.html">ErrorFormat</a> * </td> <td class="paramname"><em>error</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Sets an exception that is to be used by the functions of this class to report errors. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>is a pointer to an <a class="el" href="classKCal_1_1ErrorFormat.html" title="Calendar format related error class.">ErrorFormat</a> which contains the exception. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="calformat_8cpp_source.html#l00077">77</a> of file <a class="el" href="calformat_8cpp_source.html">calformat.cpp</a>.</p> </div> </div> <a class="anchor" id="a24076798e9034b6f69ebabf85672aa74"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void CalFormat::setLoadedProductId </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>id</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>PRODID string loaded from calendar file. </p> <p>Definition at line <a class="el" href="calformat_8cpp_source.html#l00110">110</a> of file <a class="el" href="calformat_8cpp_source.html">calformat.cpp</a>.</p> </div> </div> <a class="anchor" id="a06a06f66edfb9fb6142fc0e506ea5350"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual QString KCal::CalFormat::toString </td> <td>(</td> <td class="paramtype"><a class="el" href="classKCal_1_1Calendar.html">Calendar</a> * </td> <td class="paramname"><em>calendar</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the calendar as a string. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">calendar</td><td>is the <a class="el" href="classKCal_1_1Calendar.html" title="Represents the main calendar class.">Calendar</a> containing the data to be saved.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>a QString containing the <a class="el" href="classKCal_1_1Calendar.html" title="Represents the main calendar class.">Calendar</a> data if successful; an empty string otherwise. </dd></dl> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKCal_1_1CalFormat.html#a8475dc1c8c6c2a84be5826b2c01edee5" title="Loads a calendar from a string.">fromString()</a>, <a class="el" href="classKCal_1_1CalFormat.html#ad1db3b3b032b9f19a6aac69b6f11e5e2" title="Parses a utf8 encoded string, returning the first iCal component encountered in that string...">fromRawString()</a>. </dd></dl> <p>Implemented in <a class="el" href="classKCal_1_1ICalFormat.html#a21a3b8d26e16ea6cb36cd5b44754257f">KCal::ICalFormat</a>, and <a class="el" href="classKCal_1_1QtopiaFormat.html#a1a5e6dbbf71fdb063ab1597e75cdfdba">KCal::QtopiaFormat</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="calformat_8h_source.html">calformat.h</a></li> <li><a class="el" href="calformat_8cpp_source.html">calformat.cpp</a></li> </ul> </div><!-- contents --> <div class="copyrights"> This file is part of the KDE documentation.<br/> Documentation copyright © 1996-2013 The KDE developers.<br/> Generated on Fri Jul 12 2013 16:49:32 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006 <p> KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online. </p> </div> </div> </div> </div> <div id="left"> <div class="menu_box"> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">KCal Library</h2> <a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "KCal Library"</a> </div></div> <ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</a></li><li><a href="pages.html">Related Pages</a></li></ul> <!-- <h2>Class Picker</h2> <div style="text-align: center;"> <form name="guideform"> <select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value"> <option value="annotated.html">-- Choose --</option> <option value="classKCal_1_1Alarm.html">kcal::alarm</option>, <option value="classKCal_1_1AssignmentVisitor.html">kcal::assignmentvisitor</option>, <option value="classKCal_1_1Attachment.html">kcal::attachment</option>, <option value="classKCal_1_1Attendee.html">kcal::attendee</option>, <option value="classKCal_1_1Calendar.html">kcal::calendar</option>, <option value="classKCal_1_1Calendar_1_1CalendarObserver.html">kcal::calendar::calendarobserver</option>, <option value="classKCal_1_1CalendarLocal.html">kcal::calendarlocal</option>, <option value="classKCal_1_1CalendarNull.html">kcal::calendarnull</option>, <option value="classKCal_1_1CalendarResources.html">kcal::calendarresources</option>, <option value="classKCal_1_1CalFilter.html">kcal::calfilter</option>, <option value="classKCal_1_1CalFormat.html">kcal::calformat</option>, <option value="classKCal_1_1CalStorage.html">kcal::calstorage</option>, <option value="classKCal_1_1ComparisonVisitor.html">kcal::comparisonvisitor</option>, <option value="classKCal_1_1Compat.html">kcal::compat</option>, <option value="classKCal_1_1CompatFactory.html">kcal::compatfactory</option>, <option value="classKCal_1_1CompatOutlook9.html">kcal::compatoutlook9</option>, <option value="classKCal_1_1CompatPre31.html">kcal::compatpre31</option>, <option value="classKCal_1_1CompatPre32.html">kcal::compatpre32</option>, <option value="classKCal_1_1CompatPre35.html">kcal::compatpre35</option>, <option value="classKCal_1_1CustomProperties.html">kcal::customproperties</option>, <option value="classKCal_1_1DndFactory.html">kcal::dndfactory</option>, <option value="classKCal_1_1DummyScheduler.html">kcal::dummyscheduler</option>, <option value="classKCal_1_1Duration.html">kcal::duration</option>, <option value="classKCal_1_1ErrorFormat.html">kcal::errorformat</option>, <option value="classKCal_1_1Event.html">kcal::event</option>, <option value="classKCal_1_1Exception.html">kcal::exception</option>, <option value="classKCal_1_1FileStorage.html">kcal::filestorage</option>, <option value="classKCal_1_1FreeBusy.html">kcal::freebusy</option>, <option value="classKCal_1_1FreeBusyCache.html">kcal::freebusycache</option>, <option value="classKCal_1_1FreeBusyPeriod.html">kcal::freebusyperiod</option>, <option value="classKCal_1_1HtmlExport.html">kcal::htmlexport</option>, <option value="classKCal_1_1ICalFormat.html">kcal::icalformat</option>, <option value="classKCal_1_1ICalFormatImpl.html">kcal::icalformatimpl</option>, <option value="classKCal_1_1ICalTimeZone.html">kcal::icaltimezone</option>, <option value="classKCal_1_1ICalTimeZoneBackend.html">kcal::icaltimezonebackend</option>, <option value="classKCal_1_1ICalTimeZoneData.html">kcal::icaltimezonedata</option>, <option value="classKCal_1_1ICalTimeZones.html">kcal::icaltimezones</option>, <option value="classKCal_1_1ICalTimeZoneSource.html">kcal::icaltimezonesource</option>, <option value="classKCal_1_1Incidence.html">kcal::incidence</option>, <option value="classKCal_1_1IncidenceBase.html">kcal::incidencebase</option>, <option value="classKCal_1_1IncidenceBase_1_1IncidenceObserver.html">kcal::incidencebase::incidenceobserver</option>, <option value="classKCal_1_1IncidenceBase_1_1Visitor.html">kcal::incidencebase::visitor</option>, <option value="classKCal_1_1Journal.html">kcal::journal</option>, <option value="classKCal_1_1KResult.html">kcal::kresult</option>, <option value="classKCal_1_1KResultError.html">kcal::kresulterror</option>, <option value="classKCal_1_1KResultInProgress.html">kcal::kresultinprogress</option>, <option value="classKCal_1_1KResultOk.html">kcal::kresultok</option>, <option value="classKCal_1_1ListBase.html">kcal::listbase</option>, <option value="classKCal_1_1Period.html">kcal::period</option>, <option value="classKCal_1_1Person.html">kcal::person</option>, <option value="classKCal_1_1QtopiaFormat.html">kcal::qtopiaformat</option>, <option value="classKCal_1_1Recurrence.html">kcal::recurrence</option>, <option value="classKCal_1_1RecurrenceRule.html">kcal::recurrencerule</option>, <option value="classKCal_1_1RecurrenceRule_1_1WDayPos.html">kcal::recurrencerule::wdaypos</option>, <option value="classKCal_1_1ResourceCached.html">kcal::resourcecached</option>, <option value="classKCal_1_1ResourceCachedReloadConfig.html">kcal::resourcecachedreloadconfig</option>, <option value="classKCal_1_1ResourceCachedSaveConfig.html">kcal::resourcecachedsaveconfig</option>, <option value="classKCal_1_1ResourceCalendar.html">kcal::resourcecalendar</option>, <option value="classKCal_1_1ResourceLocal.html">kcal::resourcelocal</option>, <option value="classKCal_1_1ResourceLocalConfig.html">kcal::resourcelocalconfig</option>, <option value="classKCal_1_1ResourceLocalDir.html">kcal::resourcelocaldir</option>, <option value="classKCal_1_1ResourceLocalDirConfig.html">kcal::resourcelocaldirconfig</option>, <option value="classKCal_1_1ScheduleMessage.html">kcal::schedulemessage</option>, <option value="classKCal_1_1Scheduler.html">kcal::scheduler</option>, <option value="classKCal_1_1SortableList.html">kcal::sortablelist</option>, <option value="classKCal_1_1Todo.html">kcal::todo</option>, </select> </form> </div> --> <div class="menu_box"> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2> <a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a> </div></div> <div class="nav_list"> <ul> <li><a href="../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../kblog/html/index.html">kblog</a></li><li><a href="../../kcal/html/index.html">kcal</a></li><li><a href="../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../kholidays/html/index.html">kholidays</a></li><li><a href="../../kimap/html/index.html">kimap</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../kldap/html/index.html">kldap</a></li><li><a href="../../kmbox/html/index.html">kmbox</a></li><li><a href="../../kmime/html/index.html">kmime</a></li><li><a href="../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../ktnef/html/index.html">ktnef</a></li><li><a href="../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../microblog/html/index.html">microblog</a></li><li><a href="../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../syndication/html/index.html">syndication</a></li><li> <a href="../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../syndication/rss2/html/index.html">rss2</a></li> </ul></div></div> <!-- api_searchbox --> </div> </div> <div class="clearer"></div> </div> <div class="clearer"></div> </div> <div id="end_body"></div> <div id="footer"><div id="footer_text"> Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br> Contact the specific authors with questions and comments about the page contents.<p> KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a></p> </div></div> </div> <!-- WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL BE BLOCKED INSTANTLY AND PERMANENTLY! <a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a> WARNING END --> </body> </html>