Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_t_x_t_s_e_r_v_8_h_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/S60_3rd_Edition_TextMTM_Example/modules/Server/inc/TXTSERV.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/S60_3rd_Edition_TextMTM_Example/modules/Server/inc/TXTSERV.H</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// TXTSERV.H</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// Copyright (c) 1999 Symbian Ltd. 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="preprocessor">#ifndef __TXTSERV_H__</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span><span class="preprocessor">#define __TXTSERV_H__</span>
<a name="l00008"></a>00008 <span class="preprocessor"></span>
<a name="l00009"></a>00009 <span class="preprocessor">#include <mtsr.h></span>
<a name="l00010"></a>00010 <span class="preprocessor">#include <MSVSTORE.H></span>
<a name="l00011"></a>00011 <span class="preprocessor">#include <MSVUIDS.H></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include <MSVIDS.H></span>
<a name="l00013"></a>00013
<a name="l00014"></a>00014 <span class="preprocessor">#include "TXTSPAN.H"</span>
<a name="l00015"></a>00015 <span class="preprocessor">#include "txut.h"</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="comment">//</span>
<a name="l00019"></a>00019 <span class="comment">// ETxtOperations: The operations the mtm can be in (iCurrentOperation)</span>
<a name="l00020"></a>00020 <span class="comment">//</span>
<a name="l00021"></a>00021 <span class="keyword">enum</span> ETxtOperations
<a name="l00022"></a>00022 {
<a name="l00023"></a>00023 ETxtOpIdle,
<a name="l00024"></a>00024 ETxtOpCopyMoveDel
<a name="l00025"></a>00025 };
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="keyword">class </span><a class="code" href="class_c_txt_copy_move_base.html">CTxtCopyMoveBase</a>;
<a name="l00028"></a>00028 <span class="keyword">class </span><a class="code" href="class_c_txt_active_oper.html">CTxtActiveOper</a>;
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="comment">//</span>
<a name="l00031"></a>00031 <span class="comment">// CTextServerMtm: The Server-side MTM implementation</span>
<a name="l00032"></a>00032 <span class="comment">//</span>
<a name="l00033"></a><a class="code" href="class_c_text_server_mtm.html">00033</a> <span class="keyword">class </span><a class="code" href="class_c_text_server_mtm.html">CTextServerMtm</a> : <span class="keyword">public</span> CBaseServerMtm
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 <span class="keyword">public</span>:
<a name="l00036"></a>00036 <span class="comment">// Constructor, initialisation, and destructor </span>
<a name="l00037"></a>00037 IMPORT_C <span class="keyword">static</span> <a class="code" href="class_c_text_server_mtm.html">CTextServerMtm</a>* NewL(CRegisteredMtmDll& aRegisteredMtmDll, CMsvServerEntry* aInitialEntry);
<a name="l00038"></a>00038 ~<a class="code" href="class_c_text_server_mtm.html">CTextServerMtm</a>();
<a name="l00039"></a>00039 <span class="keywordtype">void</span> SetInitialEntry(CMsvServerEntry* aEntry);
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">// Copy and move </span>
<a name="l00042"></a>00042 <span class="keywordtype">void</span> CopyToLocalL(<span class="keyword">const</span> CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
<a name="l00043"></a>00043 <span class="keywordtype">void</span> CopyFromLocalL(<span class="keyword">const</span> CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
<a name="l00044"></a>00044 <span class="keywordtype">void</span> CopyWithinServiceL(<span class="keyword">const</span> CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
<a name="l00045"></a>00045 <span class="keywordtype">void</span> MoveToLocalL(<span class="keyword">const</span> CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
<a name="l00046"></a>00046 <span class="keywordtype">void</span> MoveFromLocalL(<span class="keyword">const</span> CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
<a name="l00047"></a>00047 <span class="keywordtype">void</span> MoveWithinServiceL(<span class="keyword">const</span> CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">// Create, change, delete </span>
<a name="l00050"></a>00050 <span class="keywordtype">void</span> DeleteAllL(<span class="keyword">const</span> CMsvEntrySelection& aSelection, TRequestStatus& aStatus);
<a name="l00051"></a>00051 <span class="keywordtype">void</span> CreateL(TMsvEntry aNewEntry, TRequestStatus& aStatus);
<a name="l00052"></a>00052 <span class="keywordtype">void</span> ChangeL(TMsvEntry aNewEntry, TRequestStatus& aStatus);
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="comment">// Command and progress</span>
<a name="l00055"></a>00055 <span class="keywordtype">void</span> StartCommandL(CMsvEntrySelection& aSelection, TInt aCommand,
<a name="l00056"></a>00056 <span class="keyword">const</span> TDesC8& aParameter, TRequestStatus& aStatus);
<a name="l00057"></a>00057 TBool CommandExpected();
<a name="l00058"></a>00058 <span class="keyword">const</span> TDesC8& Progress();
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keyword">protected</span>:
<a name="l00061"></a>00061 <span class="comment">// Active object completion </span>
<a name="l00062"></a>00062 <span class="keywordtype">void</span> DoCancel();
<a name="l00063"></a>00063 <span class="keywordtype">void</span> DoRunL();
<a name="l00064"></a>00064 <span class="keywordtype">void</span> DoComplete(TInt aError);
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">private</span>:
<a name="l00067"></a>00067 <a class="code" href="class_c_text_server_mtm.html">CTextServerMtm</a>(CRegisteredMtmDll& aRegisteredMtmDll, CMsvServerEntry* aInitialEntry);
<a name="l00068"></a>00068 <span class="keywordtype">void</span> ConstructL();
<a name="l00069"></a>00069 <span class="keywordtype">void</span> DoOperationL(<a class="code" href="class_c_txt_active_oper.html">CTxtActiveOper</a>* aActiveOperation, <span class="keyword">const</span> CMsvEntrySelection& aSelection,
<a name="l00070"></a>00070 TMsvId aDestination, TRequestStatus& aStatus);
<a name="l00071"></a>00071 <span class="keywordtype">void</span> ConnectToServiceL();
<a name="l00072"></a>00072 <span class="keywordtype">void</span> DoRefreshL();
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="comment">// General asserts</span>
<a name="l00075"></a>00075 <span class="keywordtype">void</span> AssertConnected();
<a name="l00076"></a>00076 <span class="keywordtype">void</span> AssertHasServerEntry();
<a name="l00077"></a>00077 <span class="keywordtype">void</span> AssertIdle();
<a name="l00078"></a>00078
<a name="l00079"></a>00079
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keyword">private</span>:
<a name="l00082"></a>00082 TTxtProgressBuf iProgressBuf;
<a name="l00083"></a>00083 TInt iCurrentOperation;
<a name="l00084"></a>00084 CMsvServerEntry* iEntry;
<a name="l00085"></a>00085 TRequestStatus* iReportStatus;
<a name="l00086"></a>00086 RFs iFs;
<a name="l00087"></a>00087 TMsvId iServiceEntryId;
<a name="l00088"></a>00088 <a class="code" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a>* iTxtSettings;
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <a class="code" href="class_c_txt_copy_move_base.html">CTxtCopyMoveBase</a>* iTxtCopyMove; <span class="comment">// Needed for copy, move, delete ops</span>
<a name="l00091"></a>00091 TParse iParse; <span class="comment">// Needed for the move to remote operations, to keep track of the current folder.</span>
<a name="l00092"></a>00092 };
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="comment">// Assert functions</span>
<a name="l00095"></a>00095 <span class="keyword">inline</span> <span class="keywordtype">void</span> CTextServerMtm::AssertConnected()
<a name="l00096"></a>00096 {
<a name="l00097"></a>00097 __ASSERT_DEBUG(iServiceEntryId != KMsvNullIndexEntryId, gPanic(ETxtsInvalidService));
<a name="l00098"></a>00098 __ASSERT_DEBUG(iTxtSettings != NULL, gPanic(ETxtsInvalidService));
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="keyword">inline</span> <span class="keywordtype">void</span> CTextServerMtm::AssertHasServerEntry()
<a name="l00102"></a>00102 {
<a name="l00103"></a>00103 __ASSERT_DEBUG(iEntry != NULL, gPanic(ETxtsInvalidService));
<a name="l00104"></a>00104 }
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="keyword">inline</span> <span class="keywordtype">void</span> CTextServerMtm::AssertIdle()
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108 __ASSERT_DEBUG(iCurrentOperation==ETxtOpIdle,gPanic(ETxtsAlreadyBusy));
<a name="l00109"></a>00109 }
<a name="l00110"></a>00110
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <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>