<?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>KCalUtils::IncidenceFormatter Namespace 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>KCalUtils 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="namespaceKCalUtils.html">KCalUtils</a></li><li class="navelem"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html">IncidenceFormatter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">KCalUtils::IncidenceFormatter Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6e09262c9c2a8b81d056ea447d6cb5be"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a6e09262c9c2a8b81d056ea447d6cb5be">dateTimeToString</a> (const KDateTime &date, bool dateOnly=false, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec())</td></tr>
<tr class="separator:a6e09262c9c2a8b81d056ea447d6cb5be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81ba251ae4a73aadd2835dc2d8e5eb6f"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a81ba251ae4a73aadd2835dc2d8e5eb6f">dateToString</a> (const KDateTime &date, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec())</td></tr>
<tr class="separator:a81ba251ae4a73aadd2835dc2d8e5eb6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b74292836beaff28a7ed5eb97141640"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a7b74292836beaff28a7ed5eb97141640">durationString</a> (const KCalCore::Incidence::Ptr &incidence)</td></tr>
<tr class="separator:a7b74292836beaff28a7ed5eb97141640"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80724f3793f28f9dbfd22bc9c3bafd21"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a80724f3793f28f9dbfd22bc9c3bafd21">extensiveDisplayStr</a> (const <a class="elRef" doxygen="kcalcore.tag:../../kcalcore/html/" href="../../kcalcore/html/classKCalCore_1_1Calendar.html#a347780ed011ca3e30f816a34f75d72bf">KCalCore::Calendar::Ptr</a> &calendar, const KCalCore::IncidenceBase::Ptr &incidence, const QDate &date=QDate(), KDateTime::Spec spec=KDateTime::Spec())</td></tr>
<tr class="separator:a80724f3793f28f9dbfd22bc9c3bafd21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a098641cc4adb2bbba19859d205c2ca71"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a098641cc4adb2bbba19859d205c2ca71">extensiveDisplayStr</a> (const QString &sourceName, const KCalCore::IncidenceBase::Ptr &incidence, const QDate &date=QDate(), KDateTime::Spec spec=KDateTime::Spec())</td></tr>
<tr class="separator:a098641cc4adb2bbba19859d205c2ca71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9461f1577a38774325acd2b3ffbc26b"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#ac9461f1577a38774325acd2b3ffbc26b">formatICalInvitation</a> (QString invitation, const <a class="elRef" doxygen="kcalcore.tag:../../kcalcore/html/" href="../../kcalcore/html/classKCalCore_1_1MemoryCalendar.html#a10c8cba5642979bb6adbe8958b63a8fb">KCalCore::MemoryCalendar::Ptr</a> &calendar, InvitationFormatterHelper *helper, bool outlookCompareStyle)</td></tr>
<tr class="separator:ac9461f1577a38774325acd2b3ffbc26b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6bbb1033c27adeb5463ef4c877d7648"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#af6bbb1033c27adeb5463ef4c877d7648">formatICalInvitationNoHtml</a> (const QString &invitation, const <a class="elRef" doxygen="kcalcore.tag:../../kcalcore/html/" href="../../kcalcore/html/classKCalCore_1_1MemoryCalendar.html#a10c8cba5642979bb6adbe8958b63a8fb">KCalCore::MemoryCalendar::Ptr</a> &calendar, InvitationFormatterHelper *helper, const QString &sender, bool outlookCompareStyle)</td></tr>
<tr class="separator:af6bbb1033c27adeb5463ef4c877d7648"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f360c4d2f15239a05e7fd73bfee95e8"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a3f360c4d2f15239a05e7fd73bfee95e8">incidenceStatusName</a> (KCalCore::Incidence::Status status)</td></tr>
<tr class="separator:a3f360c4d2f15239a05e7fd73bfee95e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdf2b48ef5c9d1a9fc261b19db4796c9"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#abdf2b48ef5c9d1a9fc261b19db4796c9">incidenceStatusStr</a> (const KCalCore::Incidence::Ptr &incidence)</td></tr>
<tr class="separator:abdf2b48ef5c9d1a9fc261b19db4796c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af37c8c33f4833c34367b94488e6287f1"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#af37c8c33f4833c34367b94488e6287f1">mailBodyStr</a> (const KCalCore::IncidenceBase::Ptr &incidence, KDateTime::Spec spec=KDateTime::Spec())</td></tr>
<tr class="separator:af37c8c33f4833c34367b94488e6287f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3ab574aa8028995cfcf0033eb2805ff"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#ab3ab574aa8028995cfcf0033eb2805ff">recurrenceString</a> (const KCalCore::Incidence::Ptr &incidence)</td></tr>
<tr class="separator:ab3ab574aa8028995cfcf0033eb2805ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10ee8a48646ecf98f678eb1a88dd0fb5"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a10ee8a48646ecf98f678eb1a88dd0fb5">reminderStringList</a> (const KCalCore::Incidence::Ptr &incidence, bool shortfmt=true)</td></tr>
<tr class="separator:a10ee8a48646ecf98f678eb1a88dd0fb5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c65f8fcc8c618616b585985c4e017eb"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a5c65f8fcc8c618616b585985c4e017eb">resourceString</a> (const <a class="elRef" doxygen="kcalcore.tag:../../kcalcore/html/" href="../../kcalcore/html/classKCalCore_1_1Calendar.html#a347780ed011ca3e30f816a34f75d72bf">KCalCore::Calendar::Ptr</a> &calendar, const KCalCore::Incidence::Ptr &incidence)</td></tr>
<tr class="separator:a5c65f8fcc8c618616b585985c4e017eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78ea97b840fc276f661043a9dde85368"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a78ea97b840fc276f661043a9dde85368">timeToString</a> (const KDateTime &date, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec())</td></tr>
<tr class="separator:a78ea97b840fc276f661043a9dde85368"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb31e79f8db1cd9c713e0e2b22a526ba"><td class="memItemLeft" align="right" valign="top">KCALUTILS_EXPORT QString </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#acb31e79f8db1cd9c713e0e2b22a526ba">toolTipStr</a> (const QString &sourceName, const KCalCore::IncidenceBase::Ptr &incidence, const QDate &date=QDate(), bool richText=true, KDateTime::Spec spec=KDateTime::Spec())</td></tr>
<tr class="separator:acb31e79f8db1cd9c713e0e2b22a526ba"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides methods to format Incidences in various ways for display purposes. </p>
<p>Helpers that provides several static methods to format an Incidence in different ways: like an HTML representation for KMail, a representation for tool tips, or a representation for a viewer widget. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a6e09262c9c2a8b81d056ea447d6cb5be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KCalUtils::IncidenceFormatter::dateTimeToString </td>
<td>(</td>
<td class="paramtype">const KDateTime & </td>
<td class="paramname"><em>date</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>dateOnly</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shortfmt</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const KDateTime::Spec & </td>
<td class="paramname"><em>spec</em> = <code>KDateTime::Spec()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a QString date/time representation of a KDateTime object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">date</td><td>The date to be formatted. </td></tr>
<tr><td class="paramname">dateOnly</td><td>If true, don't print the time fields; print the date fields only. </td></tr>
<tr><td class="paramname">shortfmt</td><td>If true, display info in short format. </td></tr>
<tr><td class="paramname">spec</td><td>Time spec to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a81ba251ae4a73aadd2835dc2d8e5eb6f" title="Build a QString date representation of a KDateTime object.">dateToString()</a>, <a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a78ea97b840fc276f661043a9dde85368" title="Build a QString time representation of a KDateTime object.">timeToString()</a>. </dd></dl>
<p>Definition at line <a class="el" href="incidenceformatter_8cpp_source.html#l04348">4348</a> of file <a class="el" href="incidenceformatter_8cpp_source.html">incidenceformatter.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a81ba251ae4a73aadd2835dc2d8e5eb6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KCalUtils::IncidenceFormatter::dateToString </td>
<td>(</td>
<td class="paramtype">const KDateTime & </td>
<td class="paramname"><em>date</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shortfmt</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const KDateTime::Spec & </td>
<td class="paramname"><em>spec</em> = <code>KDateTime::Spec()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a QString date representation of a KDateTime object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">date</td><td>The date to be formatted. </td></tr>
<tr><td class="paramname">shortfmt</td><td>If true, display info in short format. </td></tr>
<tr><td class="paramname">spec</td><td>Time spec to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a81ba251ae4a73aadd2835dc2d8e5eb6f" title="Build a QString date representation of a KDateTime object.">dateToString()</a>, <a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a6e09262c9c2a8b81d056ea447d6cb5be" title="Build a QString date/time representation of a KDateTime object.">dateTimeToString()</a>. </dd></dl>
<p>Definition at line <a class="el" href="incidenceformatter_8cpp_source.html#l04326">4326</a> of file <a class="el" href="incidenceformatter_8cpp_source.html">incidenceformatter.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7b74292836beaff28a7ed5eb97141640"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCALUTILS_EXPORT QString KCalUtils::IncidenceFormatter::durationString </td>
<td>(</td>
<td class="paramtype">const KCalCore::Incidence::Ptr & </td>
<td class="paramname"><em>incidence</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a duration string computed for the specified Incidence. </p>
<p>Only makes sense for Events and Todos. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">incidence</td><td>is a pointer to the Incidence. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a80724f3793f28f9dbfd22bc9c3bafd21"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCALUTILS_EXPORT QString KCalUtils::IncidenceFormatter::extensiveDisplayStr </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="kcalcore.tag:../../kcalcore/html/" href="../../kcalcore/html/classKCalCore_1_1Calendar.html#a347780ed011ca3e30f816a34f75d72bf">KCalCore::Calendar::Ptr</a> & </td>
<td class="paramname"><em>calendar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const KCalCore::IncidenceBase::Ptr & </td>
<td class="paramname"><em>incidence</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QDate & </td>
<td class="paramname"><em>date</em> = <code>QDate()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">KDateTime::Spec </td>
<td class="paramname"><em>spec</em> = <code>KDateTime::Spec()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a RichText QString representation of an Incidence in a nice format suitable for using in a viewer widget. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">calendar</td><td>is a pointer to the Calendar that owns the specified Incidence. </td></tr>
<tr><td class="paramname">incidence</td><td>is a pointer to the Incidence to be formatted. </td></tr>
<tr><td class="paramname">date</td><td>is the QDate for which the string representation should be computed; used mainly for recurring incidences. </td></tr>
<tr><td class="paramname">spec</td><td>is an optional time specification which, when specified, will shift the Incidence times to different timezones. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a098641cc4adb2bbba19859d205c2ca71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCALUTILS_EXPORT QString KCalUtils::IncidenceFormatter::extensiveDisplayStr </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>sourceName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const KCalCore::IncidenceBase::Ptr & </td>
<td class="paramname"><em>incidence</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QDate & </td>
<td class="paramname"><em>date</em> = <code>QDate()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">KDateTime::Spec </td>
<td class="paramname"><em>spec</em> = <code>KDateTime::Spec()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a RichText QString representation of an Incidence in a nice format suitable for using in a viewer widget. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sourceName</td><td>where the incidence is from (e.g. resource name) </td></tr>
<tr><td class="paramname">incidence</td><td>is a pointer to the Incidence to be formatted. </td></tr>
<tr><td class="paramname">date</td><td>is the QDate for which the string representation should be computed; used mainly for recurring incidences. </td></tr>
<tr><td class="paramname">spec</td><td>is an optional time specification which, when specified, will shift the Incidence times to different timezones. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac9461f1577a38774325acd2b3ffbc26b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KCalUtils::IncidenceFormatter::formatICalInvitation </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>invitation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" doxygen="kcalcore.tag:../../kcalcore/html/" href="../../kcalcore/html/classKCalCore_1_1MemoryCalendar.html#a10c8cba5642979bb6adbe8958b63a8fb">KCalCore::MemoryCalendar::Ptr</a> & </td>
<td class="paramname"><em>calendar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">InvitationFormatterHelper * </td>
<td class="paramname"><em>helper</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>outlookCompareStyle</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deliver an HTML formatted string displaying an invitation. </p>
<p>Use the time zone from mCalendar.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">invitation</td><td>a QString containing a string representation of a calendar Incidence which will be intrepreted as an invitation. </td></tr>
<tr><td class="paramname">calendar</td><td>is a pointer to the Calendar that owns the invitation. </td></tr>
<tr><td class="paramname">helper</td><td>is a pointer to an InvitationFormatterHelper. </td></tr>
<tr><td class="paramname">outlookCompareStyle</td><td>if true, display updated invitation comparisons in the style of Microsoft Outlook (tm); else use our own "classic" style. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="incidenceformatter_8cpp_source.html#l03258">3258</a> of file <a class="el" href="incidenceformatter_8cpp_source.html">incidenceformatter.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af6bbb1033c27adeb5463ef4c877d7648"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KCalUtils::IncidenceFormatter::formatICalInvitationNoHtml </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>invitation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" doxygen="kcalcore.tag:../../kcalcore/html/" href="../../kcalcore/html/classKCalCore_1_1MemoryCalendar.html#a10c8cba5642979bb6adbe8958b63a8fb">KCalCore::MemoryCalendar::Ptr</a> & </td>
<td class="paramname"><em>calendar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">InvitationFormatterHelper * </td>
<td class="paramname"><em>helper</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>sender</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>outlookCompareStyle</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deliver an HTML formatted string displaying an invitation. </p>
<p>Differs from <a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#ac9461f1577a38774325acd2b3ffbc26b" title="Deliver an HTML formatted string displaying an invitation.">formatICalInvitation()</a> in that invitation details (summary, location, etc) have HTML formatting cleaned. Use the time zone from calendar.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">invitation</td><td>a QString containing a string representation of a calendar Incidence which will be intrepreted as an invitation. </td></tr>
<tr><td class="paramname">calendar</td><td>is a pointer to the Calendar that owns the invitation. </td></tr>
<tr><td class="paramname">helper</td><td>is a pointer to an InvitationFormatterHelper. </td></tr>
<tr><td class="paramname">sender</td><td>is a QString containing the email address of the person sending the invitation. </td></tr>
<tr><td class="paramname">outlookCompareStyle</td><td>if true, display updated invitation comparisons in the style of Microsoft Outlook (tm); else use our own "classic" style. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="incidenceformatter_8cpp_source.html#l03268">3268</a> of file <a class="el" href="incidenceformatter_8cpp_source.html">incidenceformatter.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3f360c4d2f15239a05e7fd73bfee95e8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCALUTILS_EXPORT QString KCalUtils::IncidenceFormatter::incidenceStatusName </td>
<td>(</td>
<td class="paramtype">KCalCore::Incidence::Status </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the translated string form of a specified #Status. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>is a #Status type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abdf2b48ef5c9d1a9fc261b19db4796c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCALUTILS_EXPORT QString KCalUtils::IncidenceFormatter::incidenceStatusStr </td>
<td>(</td>
<td class="paramtype">const KCalCore::Incidence::Ptr & </td>
<td class="paramname"><em>incidence</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a translatedstatus string for this incidence. </p>
</div>
</div>
<a class="anchor" id="af37c8c33f4833c34367b94488e6287f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCALUTILS_EXPORT QString KCalUtils::IncidenceFormatter::mailBodyStr </td>
<td>(</td>
<td class="paramtype">const KCalCore::IncidenceBase::Ptr & </td>
<td class="paramname"><em>incidence</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">KDateTime::Spec </td>
<td class="paramname"><em>spec</em> = <code>KDateTime::Spec()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a QString representation of an Incidence in format suitable for including inside a mail message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">incidence</td><td>is a pointer to the Incidence to be formatted. </td></tr>
<tr><td class="paramname">spec</td><td>is an optional time specification which, when specified, will shift the Incidence times to different timezones. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab3ab574aa8028995cfcf0033eb2805ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCALUTILS_EXPORT QString KCalUtils::IncidenceFormatter::recurrenceString </td>
<td>(</td>
<td class="paramtype">const KCalCore::Incidence::Ptr & </td>
<td class="paramname"><em>incidence</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a pretty QString representation of an Incidence's recurrence info. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">incidence</td><td>is a pointer to the Incidence whose recurrence info is to be formatted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a10ee8a48646ecf98f678eb1a88dd0fb5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCALUTILS_EXPORT QStringList KCalUtils::IncidenceFormatter::reminderStringList </td>
<td>(</td>
<td class="paramtype">const KCalCore::Incidence::Ptr & </td>
<td class="paramname"><em>incidence</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shortfmt</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reminder string computed for the specified Incidence. </p>
<p>Each item of the returning QStringList corresponds to a string representation of an reminder belonging to this incidence. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">incidence</td><td>is a pointer to the Incidence. </td></tr>
<tr><td class="paramname">shortfmt</td><td>if false, a short version of each reminder is printed; else a longer version of each reminder is printed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5c65f8fcc8c618616b585985c4e017eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCALUTILS_EXPORT QString KCalUtils::IncidenceFormatter::resourceString </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="kcalcore.tag:../../kcalcore/html/" href="../../kcalcore/html/classKCalCore_1_1Calendar.html#a347780ed011ca3e30f816a34f75d72bf">KCalCore::Calendar::Ptr</a> & </td>
<td class="paramname"><em>calendar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const KCalCore::Incidence::Ptr & </td>
<td class="paramname"><em>incidence</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a Calendar Resource label name for the specified Incidence. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">calendar</td><td>is a pointer to the Calendar. </td></tr>
<tr><td class="paramname">incidence</td><td>is a pointer to the Incidence. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a78ea97b840fc276f661043a9dde85368"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KCalUtils::IncidenceFormatter::timeToString </td>
<td>(</td>
<td class="paramtype">const KDateTime & </td>
<td class="paramname"><em>date</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shortfmt</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const KDateTime::Spec & </td>
<td class="paramname"><em>spec</em> = <code>KDateTime::Spec()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a QString time representation of a KDateTime object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">date</td><td>The date to be formatted. </td></tr>
<tr><td class="paramname">shortfmt</td><td>If true, display info in short format. </td></tr>
<tr><td class="paramname">spec</td><td>Time spec to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a81ba251ae4a73aadd2835dc2d8e5eb6f" title="Build a QString date representation of a KDateTime object.">dateToString()</a>, <a class="el" href="namespaceKCalUtils_1_1IncidenceFormatter.html#a6e09262c9c2a8b81d056ea447d6cb5be" title="Build a QString date/time representation of a KDateTime object.">dateTimeToString()</a>. </dd></dl>
<p>Definition at line <a class="el" href="incidenceformatter_8cpp_source.html#l04309">4309</a> of file <a class="el" href="incidenceformatter_8cpp_source.html">incidenceformatter.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acb31e79f8db1cd9c713e0e2b22a526ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCALUTILS_EXPORT QString KCalUtils::IncidenceFormatter::toolTipStr </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>sourceName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const KCalCore::IncidenceBase::Ptr & </td>
<td class="paramname"><em>incidence</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QDate & </td>
<td class="paramname"><em>date</em> = <code>QDate()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>richText</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">KDateTime::Spec </td>
<td class="paramname"><em>spec</em> = <code>KDateTime::Spec()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a QString representation of an Incidence in a nice format suitable for using in a tooltip. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sourceName</td><td>where the incidence is from (e.g. resource name) </td></tr>
<tr><td class="paramname">incidence</td><td>is a pointer to the Incidence to be formatted. </td></tr>
<tr><td class="paramname">date</td><td>is the QDate for which the toolTip should be computed; used mainly for recurring incidences. Note: For to-dos, this is the due date of the occurrence, not the start date. </td></tr>
<tr><td class="paramname">richText</td><td>if yes, the QString will be created as RichText. </td></tr>
<tr><td class="paramname">spec</td><td>is an optional time specification which, when specified, will shift the Incidence times to different timezones. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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:48:41 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">KCalUtils Library</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "KCalUtils 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="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="classKCalUtils_1_1DndFactory.html">kcalutils::dndfactory</option>, <option value="classKCalUtils_1_1HtmlExport.html">kcalutils::htmlexport</option>, <option value="classKCalUtils_1_1Scheduler.html">kcalutils::scheduler</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>
