Mercurial Mercurial > oss > MCL > sftools > depl > docscontent / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_client_2inc_2txclient_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/Client/inc/txclient.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/Client/inc/txclient.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// TXCLIENT.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 
<a name="l00007"></a>00007 <span class="preprocessor">#if !defined (__TXCLIENT_H__)</span>
<a name="l00008"></a>00008 <span class="preprocessor"></span><span class="preprocessor">#define __TXCLIENT_H__</span>
<a name="l00009"></a>00009 <span class="preprocessor"></span>
<a name="l00010"></a>00010 <span class="comment">// system includes</span>
<a name="l00011"></a>00011 <span class="preprocessor">#include &lt;e32base.h&gt;</span>
<a name="l00012"></a>00012 <span class="preprocessor">#include &lt;badesca.h&gt;</span>
<a name="l00013"></a>00013 <span class="preprocessor">#include &lt;msvapi.h&gt;</span>
<a name="l00014"></a>00014 <span class="preprocessor">#include &lt;mtclbase.h&gt;</span>
<a name="l00015"></a>00015 <span class="preprocessor">#include &quot;../../Util/inc/txut.h&quot;</span>       <span class="comment">// TMTMTxtSettings</span>
<a name="l00016"></a>00016 
<a name="l00017"></a>00017 <span class="keyword">const</span> TUint KAddresseeListResizeGranularity = 5;
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="comment">// </span>
<a name="l00020"></a>00020 <span class="comment">// CTextMtmClient</span>
<a name="l00021"></a>00021 <span class="comment">//              Implements CBaseMtm to provide Client-side Text MTM             </span>
<a name="l00022"></a>00022 <span class="comment">//</span>
<a name="l00023"></a>00023 
<a name="l00024"></a><a class="code" href="class_c_text_mtm_client.html">00024</a> <span class="keyword">class </span><a class="code" href="class_c_text_mtm_client.html">CTextMtmClient</a> : <span class="keyword">public</span> CBaseMtm
<a name="l00025"></a>00025         {
<a name="l00026"></a>00026 <span class="keyword">public</span>:
<a name="l00027"></a>00027         <span class="comment">//Construction and destruction </span>
<a name="l00028"></a>00028         IMPORT_C <span class="keyword">static</span> <a class="code" href="class_c_text_mtm_client.html">CTextMtmClient</a>* NewL(CRegisteredMtmDll&amp; aRegisteredMtmDll,CMsvSession&amp; aMsvSession);
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 
<a name="l00031"></a>00031         ~<a class="code" href="class_c_text_mtm_client.html">CTextMtmClient</a>();
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="keyword">public</span>:
<a name="l00034"></a>00034     <span class="comment">// from CBaseMtm</span>
<a name="l00035"></a>00035         <span class="comment">// Store and restore entry data </span>
<a name="l00036"></a>00036         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SaveMessageL(); 
<a name="l00037"></a>00037         <span class="keyword">virtual</span> <span class="keywordtype">void</span> LoadMessageL();
<a name="l00038"></a>00038 
<a name="l00039"></a>00039         <span class="comment">// Response message creation </span>
<a name="l00040"></a>00040         <span class="keyword">virtual</span> CMsvOperation* ReplyL(TMsvId aDestination, TMsvPartList aPartlist, TRequestStatus&amp; aCompletionStatus);
<a name="l00041"></a>00041         <span class="keyword">virtual</span> CMsvOperation* ForwardL(TMsvId aDestination, TMsvPartList aPartList, TRequestStatus&amp; aCompletionStatus);
<a name="l00042"></a>00042 
<a name="l00043"></a>00043         <span class="comment">// Validation and search </span>
<a name="l00044"></a>00044         <span class="keyword">virtual</span> TMsvPartList ValidateMessage(TUint aPartList);
<a name="l00045"></a>00045         <span class="keyword">virtual</span> TMsvPartList Find(<span class="keyword">const</span> TDesC&amp; aTextToFind, TMsvPartList aPartList);
<a name="l00046"></a>00046 
<a name="l00047"></a>00047         <span class="comment">// Addressees have no meaning in the text mtm.</span>
<a name="l00048"></a>00048         <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddAddresseeL(<span class="keyword">const</span> TDesC&amp; aRealAddress);
<a name="l00049"></a>00049         <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddAddresseeL(<span class="keyword">const</span> TDesC&amp; aRealAddress, <span class="keyword">const</span> TDesC&amp; aAlias);
<a name="l00050"></a>00050         <span class="keyword">virtual</span> <span class="keywordtype">void</span> RemoveAddressee(TInt aIndex);
<a name="l00051"></a>00051 
<a name="l00052"></a>00052         <span class="comment">// MTM-specific functionality</span>
<a name="l00053"></a>00053         <span class="keyword">virtual</span> TInt QueryCapability(TUid aCapability, TInt&amp; aResponse);
<a name="l00054"></a>00054         <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="l00055"></a>00055         <span class="keyword">virtual</span> CMsvOperation* InvokeAsyncFunctionL(TInt aFunctionId,<span class="keyword">const</span> CMsvEntrySelection&amp; aSelection, TDes8&amp; aParameter, TRequestStatus&amp; aCompletionStatus);
<a name="l00056"></a>00056 
<a name="l00057"></a>00057         <span class="keywordtype">void</span> CreateAttachmentL(<span class="keyword">const</span> TDesC&amp; aFilePath, <span class="keyword">const</span> TDesC8&amp; aMimeType, TRequestStatus&amp; aStatus);
<a name="l00058"></a>00058         <span class="keywordtype">void</span> CreateAttachmentL(RFile&amp; aFile, <span class="keyword">const</span> TDesC8&amp; aMimeType, TRequestStatus&amp; aStatus);
<a name="l00059"></a>00059         <span class="keywordtype">void</span> CreateLinkedAttachmentL(<span class="keyword">const</span> TDesC&amp; aFilePath, <span class="keyword">const</span> TDesC8&amp; aMimeType, TRequestStatus&amp; aStatus);
<a name="l00060"></a>00060         <span class="keywordtype">void</span> CreateMessageAttachmentL(TMsvId aAttachmentId, TRequestStatus&amp; aStatus);
<a name="l00061"></a>00061         
<a name="l00062"></a>00062         TMsvId DefaultServiceL() <span class="keyword">const</span>;
<a name="l00063"></a>00063         <span class="keywordtype">void</span> RemoveDefaultServiceL();
<a name="l00064"></a>00064         <span class="keywordtype">void</span> ChangeDefaultServiceL(<span class="keyword">const</span> TMsvId&amp; aService);
<a name="l00065"></a>00065 
<a name="l00066"></a>00066     <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetSubjectL(<span class="keyword">const</span> TDesC &amp;aSubject);
<a name="l00067"></a>00067     <span class="keyword">virtual</span> <span class="keyword">const</span> TPtrC SubjectL() <span class="keyword">const</span>;
<a name="l00068"></a>00068 <span class="keyword">public</span>:
<a name="l00069"></a>00069         <span class="comment">// Text-specific</span>
<a name="l00070"></a>00070         <a class="code" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a>&amp; TxtSettings();
<a name="l00071"></a>00071         <a class="code" href="class_c_m_t_m_txt_settings.html">CMTMTxtSettings</a>&amp; Settings();
<a name="l00072"></a>00072 <span class="keyword">protected</span>:
<a name="l00073"></a>00073     <span class="comment">// from CBaseMtm</span>
<a name="l00074"></a>00074         <span class="keyword">virtual</span> <span class="keywordtype">void</span> ContextEntrySwitched(); 
<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_client.html">CTextMtmClient</a>(CRegisteredMtmDll&amp; aRegisteredMtmDll,CMsvSession&amp; aMsvSession);
<a name="l00078"></a>00078         <span class="keywordtype">void</span> ConstructL();
<a name="l00079"></a>00079 
<a name="l00080"></a>00080 <span class="keyword">private</span>: <span class="comment">// Properties</span>
<a name="l00081"></a>00081         <a class="code" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a> iTxtSettings;
<a name="l00082"></a>00082         <a class="code" href="class_c_m_t_m_txt_settings.html">CMTMTxtSettings</a>* iSettings;
<a name="l00083"></a>00083         };
<a name="l00084"></a>00084 
<a name="l00085"></a>00085 
<a name="l00086"></a>00086 <span class="comment">//</span>
<a name="l00087"></a>00087 <span class="comment">// inline implementations</span>
<a name="l00088"></a>00088 <span class="comment">//</span>
<a name="l00089"></a>00089 
<a name="l00090"></a>00090 <span class="comment">// Addresses are not used in this MTM</span>
<a name="l00091"></a>00091  <span class="keywordtype">void</span> CTextMtmClient::AddAddresseeL(<span class="keyword">const</span> TDesC&amp; <span class="comment">/*aRealAddress*/</span>) {};
<a name="l00092"></a>00092  <span class="keywordtype">void</span> CTextMtmClient::AddAddresseeL(<span class="keyword">const</span> TDesC&amp; <span class="comment">/*aRealAddress*/</span>, <span class="keyword">const</span> TDesC&amp; <span class="comment">/*aAlias*/</span>) {};
<a name="l00093"></a>00093  <span class="keywordtype">void</span> CTextMtmClient::RemoveAddressee(TInt <span class="comment">/*aIndex*/</span>) {};
<a name="l00094"></a>00094  <a class="code" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a>&amp; CTextMtmClient::TxtSettings()
<a name="l00095"></a>00095         {
<a name="l00096"></a>00096         <span class="keywordflow">return</span> iTxtSettings;
<a name="l00097"></a>00097         }
<a name="l00098"></a>00098 
<a name="l00099"></a>00099  <a class="code" href="class_c_m_t_m_txt_settings.html">CMTMTxtSettings</a>&amp; CTextMtmClient::Settings()
<a name="l00100"></a>00100         {
<a name="l00101"></a>00101         <span class="keywordflow">return</span> *iSettings;
<a name="l00102"></a>00102         }
<a name="l00103"></a>00103 <span class="preprocessor">#endif // __TXCLIENT_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>
MCL/sftools/depl/docscontent