Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_install_2src_2txtu_8h_source.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
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/Install/src/txtu.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/Install/src/txtu.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">// © 2004 Nokia Corporation.  All rights reserved.</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 __TXTU_H__</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span><span class="preprocessor">#define __TXTU_H__</span>
<a name="l00008"></a>00008 <span class="preprocessor"></span>
<a name="l00009"></a>00009 <span class="comment">// system include</span>
<a name="l00010"></a>00010 <span class="preprocessor">#include &lt;mtmuibas.h&gt;</span>       <span class="comment">// CBaseMtmUi</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 &quot;txut.h&quot;</span>        <span class="comment">//service settings</span>
<a name="l00014"></a>00014 
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016 <span class="comment">// CTextMtmUi: User Interface MTM</span>
<a name="l00017"></a>00017 <span class="comment">//</span>
<a name="l00018"></a>00018 
<a name="l00019"></a><a class="code" href="class_c_text_mtm_ui.html">00019</a> <span class="keyword">class </span><a class="code" href="class_c_text_mtm_ui.html">CTextMtmUi</a> : <span class="keyword">public</span> CBaseMtmUi
<a name="l00020"></a>00020         {
<a name="l00021"></a>00021 <span class="keyword">public</span>:
<a name="l00022"></a>00022         <span class="comment">// Construction</span>
<a name="l00023"></a>00023         <span class="keyword">static</span> <a class="code" href="class_c_text_mtm_ui.html">CTextMtmUi</a>* NewL(CBaseMtm&amp; aBaseMtm, CRegisteredMtmDll&amp; aRegisteredMtmDll);
<a name="l00024"></a>00024         <span class="comment">// Destruction</span>
<a name="l00025"></a>00025         ~<a class="code" href="class_c_text_mtm_ui.html">CTextMtmUi</a>();
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="keyword">public</span>:
<a name="l00028"></a>00028         <span class="comment">// Context-specific APIs from CBaseMtmUi</span>
<a name="l00029"></a>00029         <span class="keyword">virtual</span> CMsvOperation* CancelL(TRequestStatus&amp; aStatus, <span class="keyword">const</span> CMsvEntrySelection&amp; aSelection);
<a name="l00030"></a>00030 
<a name="l00031"></a>00031         <span class="keyword">virtual</span> CMsvOperation* OpenL(TRequestStatus&amp; aStatus); 
<a name="l00032"></a>00032         <span class="keyword">virtual</span> CMsvOperation* OpenL(TRequestStatus&amp; aStatus, <span class="keyword">const</span> CMsvEntrySelection&amp; aSelection); 
<a name="l00033"></a>00033 
<a name="l00034"></a>00034         <span class="keyword">virtual</span> CMsvOperation* CloseL(TRequestStatus&amp; aStatus); 
<a name="l00035"></a>00035         <span class="keyword">virtual</span> CMsvOperation* CloseL(TRequestStatus&amp; aStatus, <span class="keyword">const</span> CMsvEntrySelection&amp; aSelection);
<a name="l00036"></a>00036 
<a name="l00037"></a>00037         <span class="comment">// Launches editor/settings dialog as appropriate  </span>
<a name="l00038"></a>00038         <span class="keyword">virtual</span> CMsvOperation* EditL(TRequestStatus&amp; aStatus);
<a name="l00039"></a>00039         <span class="keyword">virtual</span> CMsvOperation* EditL(TRequestStatus&amp; aStatus, <span class="keyword">const</span> CMsvEntrySelection&amp; aSelection) ;
<a name="l00040"></a>00040 
<a name="l00041"></a>00041         <span class="comment">// Launches viewer/settings dialog as appropriate  </span>
<a name="l00042"></a>00042         <span class="keyword">virtual</span> CMsvOperation* ViewL(TRequestStatus&amp; aStatus);
<a name="l00043"></a>00043         <span class="keyword">virtual</span> CMsvOperation* ViewL(TRequestStatus&amp; aStatus, <span class="keyword">const</span> CMsvEntrySelection&amp; aSelection);
<a name="l00044"></a>00044 
<a name="l00045"></a>00045         <span class="comment">// Copy and move</span>
<a name="l00046"></a>00046         <span class="keyword">virtual</span> CMsvOperation* CopyToL(<span class="keyword">const</span> CMsvEntrySelection&amp; aSelection, TRequestStatus&amp; aStatus);
<a name="l00047"></a>00047         <span class="keyword">virtual</span> CMsvOperation* MoveToL(<span class="keyword">const</span> CMsvEntrySelection&amp; aSelection, TRequestStatus&amp; aStatus);
<a name="l00048"></a>00048         <span class="keyword">virtual</span> CMsvOperation* CopyFromL(<span class="keyword">const</span> CMsvEntrySelection&amp; aSelection, TMsvId aTargetId, TRequestStatus&amp; aStatus);
<a name="l00049"></a>00049         <span class="keyword">virtual</span> CMsvOperation* MoveFromL(<span class="keyword">const</span> CMsvEntrySelection&amp; aSelection, TMsvId aTargetId, TRequestStatus&amp; aStatus);
<a name="l00050"></a>00050 
<a name="l00051"></a>00051         <span class="comment">// Creat reply/forward message entries</span>
<a name="l00052"></a>00052     <span class="keyword">virtual</span> CMsvOperation* ReplyL(TMsvId aDestination, TMsvPartList aPartList, TRequestStatus&amp; aCompletionStatus);
<a name="l00053"></a>00053         <span class="keyword">virtual</span> CMsvOperation* ForwardL(TMsvId aDestination, TMsvPartList aPartList, TRequestStatus&amp; aCompletionStatus);
<a name="l00054"></a>00054 
<a name="l00055"></a>00055         <span class="comment">// Create/delete/undelete</span>
<a name="l00056"></a>00056         <span class="keyword">virtual</span> CMsvOperation* CreateL(<span class="keyword">const</span> TMsvEntry&amp; aEntry, CMsvEntry&amp; aParent, TRequestStatus&amp; aStatus);
<a name="l00057"></a>00057         <span class="keyword">virtual</span> CMsvOperation* DeleteFromL(<span class="keyword">const</span> CMsvEntrySelection&amp; aSelection,TRequestStatus&amp; aStatus);
<a name="l00058"></a>00058         CMsvOperation* DeleteServiceL(<span class="keyword">const</span> TMsvEntry&amp; aService, TRequestStatus&amp; aStatus);
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 <span class="keyword">public</span>:
<a name="l00061"></a>00061         <span class="comment">// Operation APIs from CBaseMtmUi</span>
<a name="l00062"></a>00062         <span class="keyword">virtual</span> <span class="keywordtype">void</span> InvokeSyncFunctionL(TInt aFunctionId, <span class="keyword">const</span> CMsvEntrySelection&amp; aSelection, TDes8&amp; aParameter);
<a name="l00063"></a>00063         <span class="keyword">virtual</span> CMsvOperation* InvokeAsyncFunctionL(TInt aFunctionId, <span class="keyword">const</span> CMsvEntrySelection&amp; aSelection, TRequestStatus&amp; aCompletionStatus, TDes8&amp; aParameter);
<a name="l00064"></a>00064         <span class="keyword">virtual</span> TInt GetProgress(<span class="keyword">const</span> TDesC8&amp; aProgress, TBuf&lt;EProgressStringMaxLen&gt;&amp; aReturnString, TInt&amp; aTotalEntryCount, TInt&amp; aEntriesDone,
<a name="l00065"></a>00065                 TInt&amp; aCurrentEntrySize, TInt&amp; aCurrentBytesTrans) <span class="keyword">const</span>;
<a name="l00066"></a>00066 
<a name="l00067"></a>00067 
<a name="l00068"></a>00068 <span class="keyword">public</span>:
<a name="l00069"></a>00069         CMsvOperation* LaunchEditorApplicationL(TRequestStatus&amp; aStatus, TMsvId aId, TBool aReadOnly);
<a name="l00070"></a>00070      CMsvOperation* LaunchViewerApplicationL(TRequestStatus&amp; aStatus, TMsvId aId);
<a name="l00071"></a>00071      
<a name="l00072"></a>00072 <span class="keyword">protected</span>: 
<a name="l00073"></a>00073         <span class="comment">// from CBaseMtmUi</span>
<a name="l00074"></a>00074         <span class="keywordtype">void</span> GetResourceFileName(TFileName&amp; aFileName) <span class="keyword">const</span>;
<a name="l00075"></a>00075 
<a name="l00076"></a>00076 <span class="keyword">protected</span>:
<a name="l00077"></a>00077         <a class="code" href="class_c_text_mtm_ui.html">CTextMtmUi</a>(CBaseMtm&amp; aBaseMtm, CRegisteredMtmDll&amp; aRegisteredMtmDll);
<a name="l00078"></a>00078         <span class="keywordtype">void</span> TxtConstructL();
<a name="l00079"></a>00079 
<a name="l00080"></a>00080 <span class="keyword">private</span>:
<a name="l00081"></a>00081     <span class="comment">// private utility methods</span>
<a name="l00082"></a>00082         CMsvOperation* DoCopyMoveToL(<span class="keyword">const</span> CMsvEntrySelection&amp; aSelection, TRequestStatus&amp; aStatus, TBool aCopy);
<a name="l00083"></a>00083         CMsvOperation* DoCopyMoveFromL(<span class="keyword">const</span> CMsvEntrySelection&amp; aSelection, TMsvId aTargetId, TRequestStatus&amp; aStatus, TBool aCopy);
<a name="l00084"></a>00084         <span class="keywordtype">void</span> ValidateSelectionL(<span class="keyword">const</span> CMsvEntry&amp; aParent, <span class="keyword">const</span> CMsvEntrySelection&amp; aSelection);
<a name="l00085"></a>00085         CMsvOperation* MessageEditL(TRequestStatus&amp; aStatus);
<a name="l00086"></a>00086         CMsvOperation* ServiceEditL(TRequestStatus&amp; aStatus);
<a name="l00087"></a>00087         <span class="keywordtype">void</span> SetProgressSuccess(TPckgBuf&lt;TMsvLocalOperationProgress&gt;&amp; aProgress,TMsvId aId);
<a name="l00088"></a>00088 
<a name="l00089"></a>00089 <span class="keyword">private</span>:
<a name="l00090"></a>00090         TMsvId iServiceId;
<a name="l00091"></a>00091     TInt iNewResourceFileOffset;
<a name="l00092"></a>00092     HBufC* iResourceFileName;
<a name="l00093"></a>00093         };
<a name="l00094"></a>00094 
<a name="l00095"></a>00095 
<a name="l00096"></a>00096 <span class="comment">//</span>
<a name="l00097"></a>00097 <span class="comment">//      CEditRemoteOperation: remote edit operation</span>
<a name="l00098"></a>00098 <span class="comment">//</span>
<a name="l00099"></a><a class="code" href="class_c_edit_remote_operation.html">00099</a> <span class="keyword">class </span><a class="code" href="class_c_edit_remote_operation.html">CEditRemoteOperation</a> : <span class="keyword">public</span> CMsvOperation
<a name="l00100"></a>00100         {
<a name="l00101"></a>00101         <span class="keyword">enum</span> TEditRemoteState
<a name="l00102"></a>00102                 {
<a name="l00103"></a>00103                 EStateFinished=0,
<a name="l00104"></a>00104                 EStateEditing,
<a name="l00105"></a>00105                 EStateCopying,
<a name="l00106"></a>00106                 };
<a name="l00107"></a>00107         
<a name="l00108"></a>00108         <span class="keyword">public</span>:
<a name="l00109"></a>00109                 <a class="code" href="class_c_edit_remote_operation.html">CEditRemoteOperation</a>(<a class="code" href="class_c_text_mtm_ui.html">CTextMtmUi</a>&amp; aMtmUi, CMsvSession&amp; aMsvSession, 
<a name="l00110"></a>00110                         TInt aPriority, TRequestStatus&amp; aObserverRequestStatus);
<a name="l00111"></a>00111                 ~<a class="code" href="class_c_edit_remote_operation.html">CEditRemoteOperation</a>();
<a name="l00112"></a>00112 
<a name="l00113"></a>00113     <span class="keyword">public</span>:
<a name="l00114"></a>00114         <span class="keywordtype">void</span> StartL(TMsvEntry&amp; aSourceEntry);
<a name="l00115"></a>00115 
<a name="l00116"></a>00116         <span class="keyword">public</span>: <span class="comment">// from CMsvOperation           </span>
<a name="l00117"></a>00117                 <span class="keyword">virtual</span> <span class="keyword">const</span> TDesC8&amp; ProgressL();
<a name="l00118"></a>00118 
<a name="l00119"></a>00119         <span class="keyword">public</span>: <span class="comment">// from CActive</span>
<a name="l00120"></a>00120                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DoCancel();
<a name="l00121"></a>00121                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> RunL();
<a name="l00122"></a>00122 
<a name="l00123"></a>00123         <span class="keyword">private</span>:
<a name="l00124"></a>00124                 <a class="code" href="class_c_text_mtm_ui.html">CTextMtmUi</a>&amp; iMtmUi;
<a name="l00125"></a>00125                 TBuf8&lt;10&gt; iProgress;
<a name="l00126"></a>00126                 CMsvOperation* iCopyOperation;
<a name="l00127"></a>00127                 CMsvOperation* iEditOperation;
<a name="l00128"></a>00128                 TEditRemoteState iState;
<a name="l00129"></a>00129         };
<a name="l00130"></a>00130 
<a name="l00131"></a>00131 <span class="preprocessor">#endif // __TXTU_H__</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>