Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/txtfwdop_8cpp_source.html
Week 28 contribution of SDK documentation content. See release notes for details. Fixes bugs Bug 1897 and Bug 1522.
<!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/S60_3rd_Edition_TextMTM_Example/modules/Client/src/txtfwdop.cpp 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/S60_3rd_Edition_TextMTM_Example/modules/Client/src/txtfwdop.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// TXTCPAN.H</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// © 2004 Nokia Corporation. All rights reserved.</span>
<a name="l00004"></a>00004 <span class="comment">//</span>
<a name="l00005"></a>00005
<a name="l00006"></a>00006 <span class="comment">// class include</span>
<a name="l00007"></a>00007 <span class="preprocessor">#include "txtfwdop.h"</span>
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="comment">//system include</span>
<a name="l00010"></a>00010 <span class="preprocessor">#include <txtrich.h></span>
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="comment">// user include</span>
<a name="l00013"></a>00013 <span class="preprocessor">#include "txtcpan.h"</span>
<a name="l00014"></a>00014
<a name="l00015"></a>00015 <a class="code" href="class_c_txt_mtm_forward_operation.html">CTxtMtmForwardOperation</a>* CTxtMtmForwardOperation::NewL(TMsvId aSourceMessage, TMsvId aDestinationFolder, CMsvSession& aMsvSession, TRequestStatus& aObserverRequestStatus)
<a name="l00016"></a>00016 {
<a name="l00017"></a>00017 <a class="code" href="class_c_txt_mtm_forward_operation.html">CTxtMtmForwardOperation</a>* <span class="keyword">self</span> = <span class="keyword">new</span> (ELeave) <a class="code" href="class_c_txt_mtm_forward_operation.html">CTxtMtmForwardOperation</a>(aSourceMessage, aDestinationFolder, aMsvSession, aObserverRequestStatus);
<a name="l00018"></a>00018 CleanupStack::PushL(<span class="keyword">self</span>);
<a name="l00019"></a>00019 <span class="keyword">self</span>->ConstructL();
<a name="l00020"></a>00020 CleanupStack::Pop(<span class="keyword">self</span>);
<a name="l00021"></a>00021 <span class="keywordflow">return</span> <span class="keyword">self</span>;
<a name="l00022"></a>00022 }
<a name="l00023"></a>00023
<a name="l00024"></a>00024 CTxtMtmForwardOperation::~CTxtMtmForwardOperation()
<a name="l00025"></a>00025 {
<a name="l00026"></a>00026 <span class="keyword">delete</span> iMsvEntry;
<a name="l00027"></a>00027 }
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">const</span> TDesC8& CTxtMtmForwardOperation::ProgressL()
<a name="l00030"></a>00030 {
<a name="l00031"></a>00031 <span class="keywordflow">if</span>(!IsActive())
<a name="l00032"></a>00032 User::Leave(KErrNotReady);
<a name="l00033"></a>00033 iProgressBuf() = iProgress;
<a name="l00034"></a>00034 <span class="keywordflow">return</span> iProgressBuf;
<a name="l00035"></a>00035 }
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">const</span> TDesC8& CTxtMtmForwardOperation::FinalProgress()
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 __ASSERT_ALWAYS(!IsActive(), User::Panic(KTxtCPanic, ETxtcOperationIsActive));
<a name="l00040"></a>00040 iProgressBuf() = iProgress;
<a name="l00041"></a>00041 <span class="keywordflow">return</span> iProgressBuf;
<a name="l00042"></a>00042 }
<a name="l00043"></a>00043
<a name="l00044"></a>00044 TInt CTxtMtmForwardOperation::RunError(TInt aError)
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 <span class="comment">// Remove an entry if one's been created by this method</span>
<a name="l00047"></a>00047 <span class="keywordflow">if</span>(iProgress.iState > TTxtMtmForwardOpProgress::ECreateMessage)
<a name="l00048"></a>00048 iMsvSession.RemoveEntry(iProgress.iFinalMsgId);
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="comment">// Populate the progress structure with the error code</span>
<a name="l00051"></a>00051 iProgress.iError = aError;
<a name="l00052"></a>00052 <span class="comment">// Complete the requesting active object with the error code</span>
<a name="l00053"></a>00053 TRequestStatus* stat = &iObserverRequestStatus;
<a name="l00054"></a>00054 User::RequestComplete(stat, aError);
<a name="l00055"></a>00055 <span class="comment">// Returning anything other than KErrNone from this method results in a panic</span>
<a name="l00056"></a>00056 <span class="keywordflow">return</span> KErrNone;
<a name="l00057"></a>00057 }
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keywordtype">void</span> CTxtMtmForwardOperation::DoCancel()
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061 <span class="keywordflow">if</span>(iProgress.iState > TTxtMtmForwardOpProgress::ECreateMessage)
<a name="l00062"></a>00062 iMsvSession.RemoveEntry(iProgress.iFinalMsgId);
<a name="l00063"></a>00063
<a name="l00064"></a>00064 TRequestStatus* stat = &iObserverRequestStatus;
<a name="l00065"></a>00065 User::RequestComplete(stat, KErrCancel);
<a name="l00066"></a>00066 }
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keywordtype">void</span> CTxtMtmForwardOperation::RunL()
<a name="l00069"></a>00069 {
<a name="l00070"></a>00070 User::LeaveIfError(iStatus.Int());
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keywordflow">switch</span>(iProgress.iState)
<a name="l00073"></a>00073 {
<a name="l00074"></a>00074 <span class="keywordflow">case</span> TTxtMtmForwardOpProgress::EInit:
<a name="l00075"></a>00075 iProgress.iState = TTxtMtmForwardOpProgress::ECreateMessage;
<a name="l00076"></a>00076 CreateMessageL(); <span class="comment">// reschedules the active object</span>
<a name="l00077"></a>00077 <span class="keywordflow">break</span>;
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="keywordflow">case</span> TTxtMtmForwardOpProgress::ECreateMessage:
<a name="l00080"></a>00080 iProgress.iState = TTxtMtmForwardOpProgress::EFormatBodyText;
<a name="l00081"></a>00081 FormatBodyTextL(); <span class="comment">// reschedules the active object</span>
<a name="l00082"></a>00082 <span class="keywordflow">break</span>;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keywordflow">case</span> TTxtMtmForwardOpProgress::EFormatBodyText:
<a name="l00085"></a>00085 iProgress.iState = TTxtMtmForwardOpProgress::EFinished;
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="keywordflow">default</span>:
<a name="l00088"></a>00088 <span class="keywordflow">break</span>;
<a name="l00089"></a>00089 }
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="comment">// When the state machine has been completed, this active object won't</span>
<a name="l00092"></a>00092 <span class="comment">// be scheduled to complete a request</span>
<a name="l00093"></a>00093 <span class="keywordflow">if</span>(!IsActive())
<a name="l00094"></a>00094 {
<a name="l00095"></a>00095 TRequestStatus* stat = &iObserverRequestStatus;
<a name="l00096"></a>00096 User::RequestComplete(stat, KErrNone);
<a name="l00097"></a>00097 }
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="keywordtype">void</span> CTxtMtmForwardOperation::CreateMessageL()
<a name="l00101"></a>00101 {
<a name="l00102"></a>00102 <span class="keyword">delete</span> iMsvEntry;
<a name="l00103"></a>00103 iMsvEntry = NULL;
<a name="l00104"></a>00104 iMsvEntry = iMsvSession.GetEntryL(iSourceMessage);
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="comment">// Get the entry to be forwarded </span>
<a name="l00107"></a>00107 TMsvEntry forwardEntry = iMsvEntry->Entry();
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="comment">// Set the context to the destination folder</span>
<a name="l00110"></a>00110 iMsvEntry->SetEntryL(iDestinationFolder);
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">// Create the forwarded index entry</span>
<a name="l00113"></a>00113 forwardEntry.iDate.HomeTime();
<a name="l00114"></a>00114 iMsvEntry->CreateL(forwardEntry);
<a name="l00115"></a>00115 iProgress.iFinalMsgId = forwardEntry.Id();
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="comment">// schedules the active object to complete so that this class's RunL method</span>
<a name="l00118"></a>00118 <span class="comment">// will be called by the active scheduler</span>
<a name="l00119"></a>00119 SetActive();
<a name="l00120"></a>00120 TRequestStatus* stat = &iStatus;
<a name="l00121"></a>00121 User::RequestComplete(stat, KErrNone);
<a name="l00122"></a>00122 }
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="keywordtype">void</span> CTxtMtmForwardOperation::FormatBodyTextL()
<a name="l00125"></a>00125 {
<a name="l00126"></a>00126 CParaFormatLayer* paraLayer = CParaFormatLayer::NewL();
<a name="l00127"></a>00127 CleanupStack::PushL(paraLayer);
<a name="l00128"></a>00128 CCharFormatLayer* charLayer = CCharFormatLayer::NewL();
<a name="l00129"></a>00129 CleanupStack::PushL(charLayer);
<a name="l00130"></a>00130 CRichText* body = CRichText::NewL(paraLayer, charLayer);
<a name="l00131"></a>00131 CleanupStack::PushL(body);
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="comment">// Get the message store from the source entry</span>
<a name="l00134"></a>00134 iMsvEntry->SetEntryL(iSourceMessage);
<a name="l00135"></a>00135 CMsvStore* readStore = iMsvEntry->ReadStoreL();
<a name="l00136"></a>00136 CleanupStack::PushL(readStore);
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="comment">// Get the message store from the newly created destination entry</span>
<a name="l00139"></a>00139 iMsvEntry->SetEntryL(iProgress.iFinalMsgId);
<a name="l00140"></a>00140 CMsvStore* writeStore = iMsvEntry->EditStoreL();
<a name="l00141"></a>00141 CleanupStack::PushL(writeStore);
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="comment">// Get the body text from the source entry and write it</span>
<a name="l00144"></a>00144 <span class="comment">// to the destination entry, prepending the forward </span>
<a name="l00145"></a>00145 <span class="comment">// prefix</span>
<a name="l00146"></a>00146 readStore->RestoreBodyTextL(*body);
<a name="l00147"></a>00147 body->InsertL(0, KTxtMtmFwdPrefix);
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="comment">// this method performs a commit for us</span>
<a name="l00150"></a>00150 writeStore->StoreBodyTextL(*body);
<a name="l00151"></a>00151
<a name="l00152"></a>00152 CleanupStack::PopAndDestroy(5, paraLayer);
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="comment">// schedules the active object to complete so that this class's RunL method</span>
<a name="l00155"></a>00155 <span class="comment">// will be called by the active scheduler</span>
<a name="l00156"></a>00156 SetActive();
<a name="l00157"></a>00157 TRequestStatus* stat = &iStatus;
<a name="l00158"></a>00158 User::RequestComplete(stat, KErrNone);
<a name="l00159"></a>00159
<a name="l00160"></a>00160 }
<a name="l00161"></a>00161
<a name="l00162"></a>00162 CTxtMtmForwardOperation::CTxtMtmForwardOperation(TMsvId aSourceMessage, TMsvId aDestinationFolder, CMsvSession& aMsvSession, TRequestStatus& aObserverRequestStatus)
<a name="l00163"></a>00163 : CMsvOperation(aMsvSession, EPriorityStandard, aObserverRequestStatus),
<a name="l00164"></a>00164 iSourceMessage(aSourceMessage),
<a name="l00165"></a>00165 iDestinationFolder(aDestinationFolder)
<a name="l00166"></a>00166 {
<a name="l00167"></a>00167 CActiveScheduler::Add(<span class="keyword">this</span>);
<a name="l00168"></a>00168 }
<a name="l00169"></a>00169
<a name="l00170"></a>00170 <span class="keywordtype">void</span> CTxtMtmForwardOperation::ConstructL()
<a name="l00171"></a>00171 {
<a name="l00172"></a>00172 <span class="comment">// set the requesting active object's request status to pending so that</span>
<a name="l00173"></a>00173 <span class="comment">// it doesn't complete</span>
<a name="l00174"></a>00174 iObserverRequestStatus = KRequestPending;
<a name="l00175"></a>00175
<a name="l00176"></a>00176 <span class="comment">// schedules the active object to complete so that this class's RunL method</span>
<a name="l00177"></a>00177 <span class="comment">// will be called by the active scheduler</span>
<a name="l00178"></a>00178 SetActive();
<a name="l00179"></a>00179 TRequestStatus* stat = &iStatus;
<a name="l00180"></a>00180 User::RequestComplete(stat, KErrNone);
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="comment">// Note that the active object is scheduled here instead of calling CreateMessageL() so that </span>
<a name="l00183"></a>00183 <span class="comment">// leaves are handled in the RunError method</span>
<a name="l00184"></a>00184 }
</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>