Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_cal_helper_entry.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!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"/>
<title>TB9.2 Example Applications: CCalHelperEntry Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>CCalHelperEntry Class Reference</h1><!-- doxytag: class="CCalHelperEntry" -->
<p><a href="class_c_cal_helper_entry-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cal_helper_entry.html#adf4873c9291d23447a81d80c2e2f0194">~CCalHelperEntry</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CCalEntry * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cal_helper_entry.html#a5df8d96b23f322f04537dcb5173957c8">NewAnnivLC</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cal_helper_entry.html#a30a8d265dcc132557ca843c501318e18">SaveValuesL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cal_helper_entry.html#afe035a415b9519d2f6a300dbff990cc4">SetValues</a> (const TDesC &aName, const TDateTime &aDate, const TBool &aAlarm, const TDateTime &aAlarmTime, const TInt &aSynchronizationMethod)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af326e53faf5836080f3048d7c5849562"></a><!-- doxytag: member="CCalHelperEntry::Name" ref="af326e53faf5836080f3048d7c5849562" args="() const " -->
TBuf< KMaxNameLength > </td><td class="memItemRight" valign="bottom"><b>Name</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80b7dd2b82697d5a6170882dc5ed85f2"></a><!-- doxytag: member="CCalHelperEntry::Date" ref="a80b7dd2b82697d5a6170882dc5ed85f2" args="() const " -->
TDateTime </td><td class="memItemRight" valign="bottom"><b>Date</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d8aeff03d4f9ff517ce682912a34eb5"></a><!-- doxytag: member="CCalHelperEntry::Alarm" ref="a5d8aeff03d4f9ff517ce682912a34eb5" args="() const " -->
TBool </td><td class="memItemRight" valign="bottom"><b>Alarm</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2e0a95469d3640551bb0c702f2511bc"></a><!-- doxytag: member="CCalHelperEntry::AlarmTime" ref="aa2e0a95469d3640551bb0c702f2511bc" args="() const " -->
TDateTime </td><td class="memItemRight" valign="bottom"><b>AlarmTime</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebd65a507172906cdfd7fec6f55468e6"></a><!-- doxytag: member="CCalHelperEntry::SynchronizationMethod" ref="aebd65a507172906cdfd7fec6f55468e6" args="() const " -->
TInt </td><td class="memItemRight" valign="bottom"><b>SynchronizationMethod</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15abb7e5d78f500cfed3f48f79b31ff2"></a><!-- doxytag: member="CCalHelperEntry::Anniv" ref="a15abb7e5d78f500cfed3f48f79b31ff2" args="()" -->
CCalEntry * </td><td class="memItemRight" valign="bottom"><b>Anniv</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2e0f62edc1c777e8bff8ea0050800c1"></a><!-- doxytag: member="CCalHelperEntry::Modified" ref="af2e0f62edc1c777e8bff8ea0050800c1" args="() const " -->
TBool </td><td class="memItemRight" valign="bottom"><b>Modified</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3b17e989b00005cdffba68bc19c76c1"></a><!-- doxytag: member="CCalHelperEntry::DateHasChanged" ref="ad3b17e989b00005cdffba68bc19c76c1" args="() const " -->
TBool </td><td class="memItemRight" valign="bottom"><b>DateHasChanged</b> () const </td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_cal_helper_entry.html">CCalHelperEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_cal_helper_entry.html#a0f9c18726e5e1d41c0de1b7595163d99">NewL</a> (CCalEntry *aAnniv)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5100131026c33fe2cd92110303c50d"></a><!-- doxytag: member="CCalHelperEntry::NewLC" ref="aed5100131026c33fe2cd92110303c50d" args="(CCalEntry *aAnniv)" -->
static <a class="el" href="class_c_cal_helper_entry.html">CCalHelperEntry</a> * </td><td class="memItemRight" valign="bottom"><b>NewLC</b> (CCalEntry *aAnniv)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa66d11cf6f5e303acae0b13c24ef7adf"></a><!-- doxytag: member="CCalHelperEntry::NewL" ref="aa66d11cf6f5e303acae0b13c24ef7adf" args="(CCalInstance *aAnniv)" -->
static <a class="el" href="class_c_cal_helper_entry.html">CCalHelperEntry</a> * </td><td class="memItemRight" valign="bottom"><b>NewL</b> (CCalInstance *aAnniv)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8011b15815c5b1776b5138402031cbc"></a><!-- doxytag: member="CCalHelperEntry::NewLC" ref="ac8011b15815c5b1776b5138402031cbc" args="(CCalInstance *aAnniv)" -->
static <a class="el" href="class_c_cal_helper_entry.html">CCalHelperEntry</a> * </td><td class="memItemRight" valign="bottom"><b>NewLC</b> (CCalInstance *aAnniv)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_cal_helper_entry.html">CCalHelperEntry</a> - wrapper class for handling CCalEntrys and CCalInstances. </p>
<p>Definition at line <a class="el" href="_calendar_helper_entry_8h_source.html#l00022">22</a> of file <a class="el" href="_calendar_helper_entry_8h_source.html">CalendarHelperEntry.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="adf4873c9291d23447a81d80c2e2f0194"></a><!-- doxytag: member="CCalHelperEntry::~CCalHelperEntry" ref="adf4873c9291d23447a81d80c2e2f0194" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCalHelperEntry::~CCalHelperEntry </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="_calendar_helper_entry_8cpp_source.html#l00159">159</a> of file <a class="el" href="_calendar_helper_entry_8cpp_source.html">CalendarHelperEntry.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0f9c18726e5e1d41c0de1b7595163d99"></a><!-- doxytag: member="CCalHelperEntry::NewL" ref="a0f9c18726e5e1d41c0de1b7595163d99" args="(CCalEntry *aAnniv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_cal_helper_entry.html">CCalHelperEntry</a> * CCalHelperEntry::NewL </td>
<td>(</td>
<td class="paramtype">CCalEntry * </td>
<td class="paramname"> <em>aAnniv</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Two-phased constructor. </p>
<p>Definition at line <a class="el" href="_calendar_helper_entry_8cpp_source.html#l00030">30</a> of file <a class="el" href="_calendar_helper_entry_8cpp_source.html">CalendarHelperEntry.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5df8d96b23f322f04537dcb5173957c8"></a><!-- doxytag: member="CCalHelperEntry::NewAnnivLC" ref="a5df8d96b23f322f04537dcb5173957c8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCalEntry * CCalHelperEntry::NewAnnivLC </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_cal_helper_entry.html#a5df8d96b23f322f04537dcb5173957c8">NewAnnivLC()</a></p>
<p>Creates a new CCalEntry object, initializes it with entrys data and returns it. </p>
<p>Definition at line <a class="el" href="_calendar_helper_entry_8cpp_source.html#l00597">597</a> of file <a class="el" href="_calendar_helper_entry_8cpp_source.html">CalendarHelperEntry.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a30a8d265dcc132557ca843c501318e18"></a><!-- doxytag: member="CCalHelperEntry::SaveValuesL" ref="a30a8d265dcc132557ca843c501318e18" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCalHelperEntry::SaveValuesL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_cal_helper_entry.html#a30a8d265dcc132557ca843c501318e18">SaveValuesL()</a></p>
<p>Sets entrys values to entrys member CCalEntry object (iAnniv). Use SaveValuesL first to set values to entry. Call to SaveValuesL is required only just before anniversary is added or updated to the agenda file. </p>
<p>Definition at line <a class="el" href="_calendar_helper_entry_8cpp_source.html#l00514">514</a> of file <a class="el" href="_calendar_helper_entry_8cpp_source.html">CalendarHelperEntry.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afe035a415b9519d2f6a300dbff990cc4"></a><!-- doxytag: member="CCalHelperEntry::SetValues" ref="afe035a415b9519d2f6a300dbff990cc4" args="(const TDesC &aName, const TDateTime &aDate, const TBool &aAlarm, const TDateTime &aAlarmTime, const TInt &aSynchronizationMethod)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CCalHelperEntry::SetValues </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDateTime & </td>
<td class="paramname"> <em>aDate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TBool & </td>
<td class="paramname"> <em>aAlarm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDateTime & </td>
<td class="paramname"> <em>aAlarmTime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TInt & </td>
<td class="paramname"> <em>aSynchronizationMethod</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>SetValuesL()</p>
<p>Sets given values to entry. Returns ETrue if values are valid, EFalse if not. After setting values, use <a class="el" href="class_c_cal_helper_entry.html#a30a8d265dcc132557ca843c501318e18">SaveValuesL()</a> to set entrys values to entrys member CCalEntry object (iAnniv). param aName - name of description of anniversary. param aAge - age of the anniversary param aDate - date when the anniversary occurs. param aAlarm - defines whether the anniversary has an alarm param aAlarmTime - time when the alarm goes off. param aSynchronizationMethod - defines how the anniversary is synchronized with e.g. PC. </p>
<p>Definition at line <a class="el" href="_calendar_helper_entry_8cpp_source.html#l00324">324</a> of file <a class="el" href="_calendar_helper_entry_8cpp_source.html">CalendarHelperEntry.cpp</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>