Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_calendar_a_p_iexample_engine_8h_source.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: examples/ForumNokia/CalendarExample/inc/CalendarAPIexampleEngine.h Source File</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 -->
<h1>examples/ForumNokia/CalendarExample/inc/CalendarAPIexampleEngine.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright © 2008 Nokia Corporation.</span>
<a name="l00003"></a>00003 <span class="comment"> */</span>
<a name="l00004"></a>00004
<a name="l00005"></a>00005
<a name="l00006"></a>00006 <span class="preprocessor">#ifndef __CALENDAR_API_EXAMPLE_ENGINE_H</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span><span class="preprocessor">#define __CALENDAR_API_EXAMPLE_ENGINE_H</span>
<a name="l00008"></a>00008 <span class="preprocessor"></span>
<a name="l00009"></a>00009 <span class="comment">// INCLUDES</span>
<a name="l00010"></a>00010 <span class="preprocessor">#include <e32base.h></span> <span class="comment">//CBase</span>
<a name="l00011"></a>00011 <span class="preprocessor">#include <calsession.h></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include <calentry.h></span>
<a name="l00013"></a>00013 <span class="preprocessor">#include <calinstanceview.h></span>
<a name="l00014"></a>00014 <span class="preprocessor">#include <calentryview.h></span>
<a name="l00015"></a>00015 <span class="preprocessor">#include <CalProgressCallBack.h></span>
<a name="l00016"></a>00016 <span class="preprocessor">#include <AknProgressDialog.h></span>
<a name="l00017"></a>00017 <span class="preprocessor">#include <eikprogi.h></span> <span class="comment">//CEikProgressInfo</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include "CalendarHelperEntry.h"</span> <span class="comment">//CCalHelperEntry</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="comment">// CONSTANTS</span>
<a name="l00021"></a>00021 <span class="keyword">const</span> TInt KMaxSync = 2;
<a name="l00022"></a>00022 <span class="keyword">const</span> TInt KDefaultAlarmHour = 8;
<a name="l00023"></a>00023 <span class="keyword">const</span> TInt KUndefinedModifyIndex = -1;
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="keyword">enum</span> TSearchType
<a name="l00026"></a>00026 {
<a name="l00027"></a>00027 EWeek,
<a name="l00028"></a>00028 EMonth,
<a name="l00029"></a>00029 ESixMonths,
<a name="l00030"></a>00030 EYear
<a name="l00031"></a>00031 };
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="comment">//commands to observer</span>
<a name="l00034"></a><a class="code" href="class_m_calender_engine_observer_u_i.html">00034</a> <span class="keyword">class </span><a class="code" href="class_m_calender_engine_observer_u_i.html">MCalenderEngineObserverUI</a>
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 <span class="keyword">public</span>:
<a name="l00037"></a>00037 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ActivateView(TUid aViewId) = 0;
<a name="l00038"></a>00038 };
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">//Commands called from views:</span>
<a name="l00041"></a><a class="code" href="class_m_calendar_engine_commands_interface.html">00041</a> <span class="keyword">class </span><a class="code" href="class_m_calendar_engine_commands_interface.html">MCalendarEngineCommandsInterface</a>
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <span class="keyword">public</span>:
<a name="l00044"></a>00044 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DoSearchL( <span class="keyword">const</span> TSearchType& aType) = 0;
<a name="l00045"></a>00045 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DoAddL() = 0;
<a name="l00046"></a>00046 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DoSaveL() = 0;
<a name="l00047"></a>00047 <span class="keyword">virtual</span> <span class="keywordtype">void</span> CreateEntryForModificationL(TBool& aModify)=0;
<a name="l00048"></a>00048 <span class="keyword">virtual</span> TInt EntryCount() <span class="keyword">const</span> = 0;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DeleteEntryL(<span class="keyword">const</span> TInt& aIndex) = 0;
<a name="l00051"></a>00051 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ExecuteDeletionL() = 0;
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="keyword">virtual</span> <a class="code" href="class_c_cal_helper_entry.html">CCalHelperEntry</a>& Entry(<span class="keyword">const</span> TInt& aIndex) = 0;
<a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetModifyIndex(<span class="keyword">const</span> TInt& aIndex) = 0;
<a name="l00055"></a>00055 <span class="keyword">virtual</span> TInt ModifyIndex() <span class="keyword">const</span> = 0;
<a name="l00056"></a>00056 <span class="keyword">virtual</span> TBool SetValuesToNewEntry( <span class="keyword">const</span> TDesC& aName,
<a name="l00057"></a>00057 <span class="keyword">const</span> TDateTime& aDate,
<a name="l00058"></a>00058 <span class="keyword">const</span> TBool& aAlarm,
<a name="l00059"></a>00059 <span class="keyword">const</span> TDateTime& aAlarmTime,
<a name="l00060"></a>00060 <span class="keyword">const</span> TInt& aSynchronizationMethod) = 0;
<a name="l00061"></a>00061 <span class="keyword">virtual</span> <span class="keywordtype">void</span> GetValuesToSet(TDes& aName, TTime& aDate,
<a name="l00062"></a>00062 TBool& aAlarm, TTime& aAlarmTime,
<a name="l00063"></a>00063 TInt& aSync) = 0 ;
<a name="l00064"></a>00064
<a name="l00065"></a>00065 };
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">// CLASS DECLARATION</span>
<a name="l00068"></a>00068
<a name="l00078"></a><a class="code" href="class_c_calendar_a_p_iexample_engine.html">00078</a> <span class="keyword">class </span><a class="code" href="class_c_calendar_a_p_iexample_engine.html">CCalendarAPIexampleEngine</a> : <span class="keyword">public</span> CBase,
<a name="l00079"></a>00079 <span class="keyword">public</span> MCalProgressCallBack,
<a name="l00080"></a>00080 <span class="keyword">public</span> <a class="code" href="class_m_calendar_engine_commands_interface.html">MCalendarEngineCommandsInterface</a>
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082 <span class="keyword">public</span>: <span class="comment">// Constructors and destructor</span>
<a name="l00083"></a>00083
<a name="l00087"></a>00087 <span class="keyword">static</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html">CCalendarAPIexampleEngine</a>* <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a828ecb12001e4b37e25bd6cc797ec0e1">NewL</a>(<a class="code" href="class_m_calender_engine_observer_u_i.html">MCalenderEngineObserverUI</a>& aAppUi);
<a name="l00088"></a>00088
<a name="l00092"></a>00092 <span class="keyword">virtual</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a23ebb701be19fa40918d52c27a92c3d5">~CCalendarAPIexampleEngine</a>();
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keyword">public</span>: <span class="comment">// Other functions</span>
<a name="l00095"></a>00095
<a name="l00102"></a>00102 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a49bd7e0013f25b4f7a646d326c23cd02">AddAnniversaryL</a>( CCalEntry* aAnniv) ;
<a name="l00103"></a>00103
<a name="l00110"></a>00110 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#ae0e66fc7880379936e7b972dd5802432">UpdateAnniversaryL</a>(CCalEntry* aAnniv) ;
<a name="l00111"></a>00111
<a name="l00118"></a>00118 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a5ceaf50f3280a0ff856d8a5587360237">DeleteAnniversaryL</a>(CCalEntry* aAnniv) ;
<a name="l00119"></a>00119
<a name="l00128"></a>00128 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#ac3b7e15f745f89b94a308ae8367efb70">GetAnniversariesL</a>( <span class="keyword">const</span> TDateTime& aFrom,
<a name="l00129"></a>00129 <span class="keyword">const</span> TDateTime& aTo,
<a name="l00130"></a>00130 RPointerArray<CCalInstance>& aAnniversaries);
<a name="l00131"></a>00131
<a name="l00137"></a>00137 TInt <a class="code" href="class_c_calendar_a_p_iexample_engine.html#ace056abb20efb7e0fefe252ccf568dd1">EntryCount</a>() <span class="keyword">const</span>;
<a name="l00138"></a>00138
<a name="l00145"></a>00145 <a class="code" href="class_c_cal_helper_entry.html">CCalHelperEntry</a>& <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a23d83b637beef3cf132e12889db837cc">Entry</a>(<span class="keyword">const</span> TInt& aIndex);
<a name="l00146"></a>00146
<a name="l00153"></a>00153 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a40c4ecbe11fb1efc7e4599e383154424">DoSearchL</a>( <span class="keyword">const</span> TSearchType& aType);
<a name="l00154"></a>00154
<a name="l00160"></a>00160 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#ae156e27902003b8e052b374fe7d06736">DoAddL</a>();
<a name="l00161"></a>00161
<a name="l00167"></a>00167 TInt <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a850f1b1b40e497937af6f9b8d29295b0">ModifyIndex</a>() <span class="keyword">const</span>;
<a name="l00168"></a>00168
<a name="l00176"></a>00176 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#af6537fbb3939229bc63ba8becd9999ec">SetModifyIndex</a>(<span class="keyword">const</span> TInt& aIndex);
<a name="l00177"></a>00177
<a name="l00186"></a>00186 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a85a35524d5df8f1d17a1c514802d6b26">CreateEntryForModificationL</a>(TBool& aModify);
<a name="l00187"></a>00187
<a name="l00194"></a>00194 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a7fd4e824c27d0b3fae4ef8e3557124d6">SaveL</a>();
<a name="l00195"></a>00195
<a name="l00200"></a>00200 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a1c52493e38c301b3a0d8557ed550368d">DoSaveL</a>();
<a name="l00201"></a>00201
<a name="l00208"></a>00208 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a025565532c28804df338f0a7df75a696">DeleteEntryL</a>(<span class="keyword">const</span> TInt& aIndex);
<a name="l00209"></a>00209
<a name="l00217"></a>00217 TBool <a class="code" href="class_c_calendar_a_p_iexample_engine.html#a5b889d02c363bd157c12ed85efd426a5">SetValuesToNewEntry</a>( <span class="keyword">const</span> TDesC& aName,
<a name="l00218"></a>00218 <span class="keyword">const</span> TDateTime& aDate,
<a name="l00219"></a>00219 <span class="keyword">const</span> TBool& aAlarm,
<a name="l00220"></a>00220 <span class="keyword">const</span> TDateTime& aAlarmTime,
<a name="l00221"></a>00221 <span class="keyword">const</span> TInt& aSynchronizationMethod);
<a name="l00222"></a>00222
<a name="l00229"></a>00229 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#abd740ea4b118933e914bd6e75f233b99">GetValuesToSet</a>(TDes& aName, TTime& aDate,
<a name="l00230"></a>00230 TBool& aAlarm, TTime& aAlarmTime,
<a name="l00231"></a>00231 TInt& aSync);
<a name="l00232"></a>00232
<a name="l00238"></a>00238 <span class="keywordtype">void</span> <a class="code" href="class_c_calendar_a_p_iexample_engine.html#ab9c813758126185e6ba0f20dea338aee">ExecuteDeletionL</a>();
<a name="l00239"></a>00239
<a name="l00240"></a>00240 <span class="keyword">private</span>:
<a name="l00244"></a>00244 <a class="code" href="class_c_calendar_a_p_iexample_engine.html">CCalendarAPIexampleEngine</a>(<a class="code" href="class_m_calender_engine_observer_u_i.html">MCalenderEngineObserverUI</a>& aAppUi);
<a name="l00245"></a>00245 <span class="keywordtype">void</span> ConstructL();
<a name="l00246"></a>00246
<a name="l00253"></a>00253 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Progress(TInt aPercentageCompleted);
<a name="l00254"></a>00254
<a name="l00261"></a>00261 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Completed(TInt aError);
<a name="l00262"></a>00262
<a name="l00267"></a>00267 <span class="keyword">virtual</span> TBool NotifyProgress();
<a name="l00268"></a>00268
<a name="l00269"></a>00269 <span class="keyword">private</span>: <span class="comment">// Data members</span>
<a name="l00270"></a>00270
<a name="l00271"></a>00271 CActiveSchedulerWait* iWait;
<a name="l00272"></a>00272 CCalSession* iCalSession;
<a name="l00273"></a>00273 CCalEntryView* iEntryView;
<a name="l00274"></a>00274 CCalInstanceView* iInstanceView;
<a name="l00275"></a>00275 TBool iCreatingEntryView;
<a name="l00276"></a>00276 CAknProgressDialog* iProgressDialog;
<a name="l00277"></a>00277 CEikProgressInfo* iProgressInfo;
<a name="l00278"></a>00278
<a name="l00279"></a>00279 <span class="comment">// Here are all CCalEntrys hold inside CCalHelperEntry</span>
<a name="l00280"></a>00280 <span class="comment">// the results are put here in DoSearchL</span>
<a name="l00281"></a>00281 RPointerArray<CCalHelperEntry> iEntries;
<a name="l00282"></a>00282
<a name="l00283"></a>00283 TSearchType iCurrentSearchType;
<a name="l00284"></a>00284
<a name="l00285"></a>00285 <span class="comment">//Used in creating new entries. Created in CreateEntryForModificationL</span>
<a name="l00286"></a>00286 <a class="code" href="class_c_cal_helper_entry.html">CCalHelperEntry</a>* iEntry;
<a name="l00287"></a>00287
<a name="l00288"></a>00288 <span class="comment">//Used in knowing which CCalEntry we're modifying</span>
<a name="l00289"></a>00289 TInt iModifyIndex;
<a name="l00290"></a>00290
<a name="l00291"></a>00291 <span class="comment">//A reference to appui, used in updating views.</span>
<a name="l00292"></a>00292 <a class="code" href="class_m_calender_engine_observer_u_i.html">MCalenderEngineObserverUI</a>& iAppUi;
<a name="l00293"></a>00293
<a name="l00294"></a>00294 };
<a name="l00295"></a>00295
<a name="l00296"></a>00296 <span class="preprocessor">#endif</span>
</pre></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>