Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_txt_viewer_starter_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/TxtViewerStarter.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/TxtViewerStarter.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">* ============================================================================</span>
<a name="l00003"></a>00003 <span class="comment">*  Name     : ViewerStarter from MuiuMsgEditorLauncher.h</span>
<a name="l00004"></a>00004 <span class="comment">*  Part of  : msgavkon\muiu</span>
<a name="l00005"></a>00005 <span class="comment">*</span>
<a name="l00006"></a>00006 <span class="comment">*  Description:</span>
<a name="l00007"></a>00007 <span class="comment">*  Static class which launches editor application (provided editor</span>
<a name="l00008"></a>00008 <span class="comment">*  conforms to \msgeditor architecture.</span>
<a name="l00009"></a>00009 <span class="comment">*</span>
<a name="l00010"></a>00010 <span class="comment">*</span>
<a name="l00011"></a>00011 <span class="comment">*  Version:</span>
<a name="l00012"></a>00012 <span class="comment">*</span>
<a name="l00013"></a>00013 <span class="comment">*  Copyright (C) 2002 Nokia Corporation.</span>
<a name="l00014"></a>00014 <span class="comment">*  This material, including documentation and any related </span>
<a name="l00015"></a>00015 <span class="comment">*  computer programs, is protected by copyright controlled by </span>
<a name="l00016"></a>00016 <span class="comment">*  Nokia Corporation. All rights are reserved. Copying, </span>
<a name="l00017"></a>00017 <span class="comment">*  including reproducing, storing,  adapting or translating, any </span>
<a name="l00018"></a>00018 <span class="comment">*  or all of this material requires the prior written consent of </span>
<a name="l00019"></a>00019 <span class="comment">*  Nokia Corporation. This material also contains confidential </span>
<a name="l00020"></a>00020 <span class="comment">*  information which may not be disclosed to others without the </span>
<a name="l00021"></a>00021 <span class="comment">*  prior written consent of Nokia Corporation.</span>
<a name="l00022"></a>00022 <span class="comment">*</span>
<a name="l00023"></a>00023 <span class="comment">* ============================================================================</span>
<a name="l00024"></a>00024 <span class="comment">*/</span>
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="preprocessor">#ifndef __MUIUMSGEDITORLAUNCHER_H__</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define __MUIUMSGEDITORLAUNCHER_H__</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="comment">//  INCLUDES</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;apparc.h&gt;</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;msvapi.h&gt;</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;msvids.h&gt;</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;MTCLBASE.H&gt;</span>   <span class="comment">// TMsvPartList</span>
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="comment">// CONSTANTS</span>
<a name="l00038"></a>00038 <span class="keyword">const</span> TUid KUidMsvEditorParameterValue = {0x100014AA};
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 
<a name="l00041"></a>00041 <span class="comment">// FORWARD DECLARATIONS (These declarations are for class ViewerStarter)</span>
<a name="l00042"></a>00042 <span class="keyword">class </span>CEikDocument;
<a name="l00043"></a>00043 <span class="keyword">class </span>CCommandAbsorbingControl;
<a name="l00044"></a>00044 <span class="keyword">class </span><a class="code" href="class_t_editor_parameters.html">TEditorParameters</a>;
<a name="l00045"></a>00045 
<a name="l00046"></a>00046 
<a name="l00047"></a>00047 <span class="comment">// CLASS DECLARATION</span>
<a name="l00048"></a>00048 
<a name="l00052"></a><a class="code" href="class_t_editor_parameters.html">00052</a> <span class="keyword">class </span><a class="code" href="class_t_editor_parameters.html">TEditorParameters</a>
<a name="l00053"></a>00053     {
<a name="l00054"></a>00054     <span class="keyword">public</span>:
<a name="l00055"></a>00055         <span class="keyword">inline</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a>();
<a name="l00056"></a>00056         <span class="keyword">inline</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a>( <span class="keyword">const</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a>&amp; aParams );
<a name="l00057"></a>00057         <span class="keyword">inline</span> <span class="keywordtype">void</span> ExternalizeL( RWriteStream&amp; aStream ) <span class="keyword">const</span>;
<a name="l00058"></a>00058         <span class="keyword">inline</span> <span class="keywordtype">void</span> InternalizeL( RReadStream&amp; aStream );
<a name="l00059"></a>00059     <span class="keyword">public</span>:
<a name="l00060"></a>00060         TMsvId  iId;
<a name="l00061"></a>00061         TInt    iFlags;
<a name="l00062"></a>00062         TMsvPartList iPartList;
<a name="l00063"></a>00063         TMsvId iDestinationFolderId;
<a name="l00064"></a>00064         TUid    iSpecialAppId;
<a name="l00065"></a>00065     };
<a name="l00066"></a>00066 
<a name="l00070"></a>00070 <span class="keyword">enum</span> TEditorFlags
<a name="l00071"></a>00071     {
<a name="l00072"></a>00072     EMsgReadOnly = 0x00010,
<a name="l00073"></a>00073     EMsgSwitch = 0x00020,          <span class="comment">// Internal</span>
<a name="l00074"></a>00074     EMsgEditorChanged = 0x00040,       <span class="comment">// Internal</span>
<a name="l00075"></a>00075     EMsgCreateNewMessage = 0x00080,
<a name="l00076"></a>00076     EMsgLaunchEditorThenWait = 0x00100,
<a name="l00077"></a>00077     EMsgLaunchEditorEmbedded = 0x00200,
<a name="l00078"></a>00078     EMsgForwardMessage = 0x01000,
<a name="l00079"></a>00079     EMsgReplyToMessageSender = 0x02000,
<a name="l00080"></a>00080     EMsgReplyToMessageAll = 0x04000,
<a name="l00081"></a>00081     EMsgCreateMessageToService = 0x08000,
<a name="l00082"></a>00082     EMsgEditNewMessage = 0x10000,
<a name="l00083"></a>00083     EMsgPreviewMessage = 0x20000,
<a name="l00084"></a>00084     EMsgCreateDuplicate = 0x40000,
<a name="l00085"></a>00085     EMsgUnreadMessage = 0x80000,
<a name="l00086"></a>00086     EMsgFirstFreeEditorSpecificFlag = 0x100000
<a name="l00087"></a>00087     };
<a name="l00088"></a>00088 
<a name="l00089"></a>00089 <span class="keyword">inline</span> TEditorParameters::TEditorParameters()
<a name="l00090"></a>00090 :   iId( KMsvNullIndexEntryId ),
<a name="l00091"></a>00091     iFlags( 0 ),
<a name="l00092"></a>00092     iPartList( 0 ),
<a name="l00093"></a>00093     iDestinationFolderId( KMsvNullIndexEntryId ),
<a name="l00094"></a>00094     iSpecialAppId( TUid::Uid(0) )
<a name="l00095"></a>00095     {}
<a name="l00096"></a>00096 
<a name="l00097"></a>00097 <span class="keyword">inline</span> TEditorParameters::TEditorParameters( <span class="keyword">const</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a>&amp; aParams )
<a name="l00098"></a>00098 :   iId( aParams.iId ),
<a name="l00099"></a>00099     iFlags( aParams.iFlags ),
<a name="l00100"></a>00100     iPartList( aParams.iPartList ),
<a name="l00101"></a>00101     iDestinationFolderId( aParams.iDestinationFolderId ),
<a name="l00102"></a>00102     iSpecialAppId( aParams.iSpecialAppId )
<a name="l00103"></a>00103     {}
<a name="l00104"></a>00104 
<a name="l00105"></a>00105 <span class="keyword">inline</span> <span class="keywordtype">void</span> TEditorParameters::ExternalizeL( RWriteStream&amp; aStream )<span class="keyword"> const</span>
<a name="l00106"></a>00106 <span class="keyword">    </span>{
<a name="l00107"></a>00107     aStream.WriteInt32L( iId );
<a name="l00108"></a>00108     aStream.WriteInt32L( iFlags );
<a name="l00109"></a>00109     aStream.WriteInt32L( iPartList );
<a name="l00110"></a>00110     aStream.WriteInt32L( iDestinationFolderId );
<a name="l00111"></a>00111     }
<a name="l00112"></a>00112 <span class="keyword">inline</span> <span class="keywordtype">void</span> TEditorParameters::InternalizeL( RReadStream&amp; aStream )
<a name="l00113"></a>00113     {
<a name="l00114"></a>00114     iId = aStream.ReadInt32L();
<a name="l00115"></a>00115     iFlags = aStream.ReadInt32L();
<a name="l00116"></a>00116     iPartList = aStream.ReadInt32L();
<a name="l00117"></a>00117     iDestinationFolderId = aStream.ReadInt32L();
<a name="l00118"></a>00118     }
<a name="l00119"></a>00119 
<a name="l00120"></a>00120 
<a name="l00121"></a>00121 <span class="comment">// CLASS DECLARATION</span>
<a name="l00122"></a>00122 
<a name="l00134"></a><a class="code" href="class_viewer_starter.html">00134</a> <span class="keyword">class </span><a class="code" href="class_viewer_starter.html">ViewerStarter</a>
<a name="l00135"></a>00135     {
<a name="l00136"></a>00136     <span class="keyword">public</span>:
<a name="l00137"></a>00137 
<a name="l00147"></a>00147         IMPORT_C <span class="keyword">static</span> CMsvOperation* <a class="code" href="class_viewer_starter.html#a178f324348f5d41092cb2f0b5210b41b">LaunchEditorApplicationL</a>(
<a name="l00148"></a>00148             CMsvSession&amp; aSession,
<a name="l00149"></a>00149             TUid aMtmType,
<a name="l00150"></a>00150             TRequestStatus&amp; aStatus,
<a name="l00151"></a>00151             <span class="keyword">const</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a>&amp; aParams,
<a name="l00152"></a>00152             <span class="keyword">const</span> TDesC&amp; aAppName,
<a name="l00153"></a>00153             <span class="keyword">const</span> TDesC8* aAddtionalParams = NULL );
<a name="l00154"></a>00154 
<a name="l00165"></a>00165         IMPORT_C <span class="keyword">static</span> CMsvOperation* <a class="code" href="class_viewer_starter.html#a178f324348f5d41092cb2f0b5210b41b">LaunchEditorApplicationL</a>(
<a name="l00166"></a>00166             CMsvSession&amp; aSession,
<a name="l00167"></a>00167             TUid aMtmType,
<a name="l00168"></a>00168             TRequestStatus&amp; aStatus,
<a name="l00169"></a>00169             <span class="keyword">const</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a>&amp; aParams,
<a name="l00170"></a>00170             <span class="keyword">const</span> TDesC&amp; aAppName,
<a name="l00171"></a>00171             <span class="keyword">const</span> TDesC8&amp; aProgressPack,
<a name="l00172"></a>00172             <span class="keyword">const</span> TDesC8* aAddtionalParams = NULL );
<a name="l00173"></a>00173 
<a name="l00174"></a>00174     <span class="keyword">private</span>:
<a name="l00178"></a>00178         <span class="keyword">static</span> CMsvOperation* LaunchEditorApplicationEmbeddedL(
<a name="l00179"></a>00179             CMsvSession&amp; aSession,
<a name="l00180"></a>00180             TUid aMtmType,
<a name="l00181"></a>00181             TRequestStatus&amp; aStatus,
<a name="l00182"></a>00182             <span class="keyword">const</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a>&amp; aParams,
<a name="l00183"></a>00183             <span class="keyword">const</span> TDesC&amp; aAppName,
<a name="l00184"></a>00184             <span class="keyword">const</span> TDesC8&amp; aProgressPack );
<a name="l00185"></a>00185 
<a name="l00189"></a>00189         <span class="keyword">static</span> CMsvOperation* LaunchEditorApplicationStandAloneL(
<a name="l00190"></a>00190             CMsvSession&amp; aSession,
<a name="l00191"></a>00191             TUid aMtmType,
<a name="l00192"></a>00192             TRequestStatus&amp; aStatus,
<a name="l00193"></a>00193             <span class="keyword">const</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a>&amp; aParams,
<a name="l00194"></a>00194             <span class="keyword">const</span> TDesC&amp; aAppName,
<a name="l00195"></a>00195             <span class="keyword">const</span> TDesC8&amp; aProgressPack,
<a name="l00196"></a>00196             <span class="keyword">const</span> TDesC8* aAddtionalParams,
<a name="l00197"></a>00197             TBool aLaunchThenWait );
<a name="l00198"></a>00198 
<a name="l00209"></a>00209         <span class="keyword">static</span> TUid DiscoverL( <span class="keyword">const</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a> aParams );
<a name="l00210"></a>00210 
<a name="l00221"></a>00221         <span class="keyword">static</span> TBool TryMatchL(  <span class="keyword">const</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a> aParams, <span class="keyword">const</span> TApaAppServiceInfo aInfo, TUid&amp; aAppUid  );
<a name="l00222"></a>00222 
<a name="l00223"></a>00223     };
<a name="l00224"></a>00224 
<a name="l00225"></a>00225 
<a name="l00231"></a><a class="code" href="class_msv_ui_editor_utilities.html">00231</a> <span class="keyword">class </span><a class="code" href="class_msv_ui_editor_utilities.html">MsvUiEditorUtilities</a>
<a name="l00232"></a>00232     {
<a name="l00233"></a>00233     <span class="keyword">public</span>:
<a name="l00234"></a>00234         IMPORT_C <span class="keyword">static</span> HBufC* ResolveAppFileNameL( TUid aAppUid );
<a name="l00235"></a>00235     };
<a name="l00236"></a>00236 
<a name="l00237"></a>00237 
<a name="l00245"></a><a class="code" href="class_msg_editor_service_resolver.html">00245</a> <span class="keyword">class </span><a class="code" href="class_msg_editor_service_resolver.html">MsgEditorServiceResolver</a>
<a name="l00246"></a>00246         {
<a name="l00247"></a>00247         <span class="keyword">public</span>:
<a name="l00258"></a>00258         <span class="keyword">static</span> TUid <a class="code" href="class_msg_editor_service_resolver.html#a16b552abe0c8d4cc1a50519ca10af04e">DiscoverL</a>( <span class="keyword">const</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a> aParams, TUid aMtmType );
<a name="l00259"></a>00259 
<a name="l00270"></a>00270         <span class="keyword">static</span> TBool <a class="code" href="class_msg_editor_service_resolver.html#a61f943efa43f4e0bc57f5bdb8a69d2bf">TryMatchL</a>(  <span class="keyword">const</span> <a class="code" href="class_t_editor_parameters.html">TEditorParameters</a> aParams, TUid aMtmType, <span class="keyword">const</span> TApaAppServiceInfo aInfo, TUid&amp; aAppUid  );
<a name="l00271"></a>00271         };
<a name="l00272"></a>00272 
<a name="l00273"></a>00273 
<a name="l00274"></a>00274 
<a name="l00275"></a>00275 <span class="preprocessor">#endif // __MSGEDITORLAUNCHER_H__</span>
<a name="l00276"></a>00276 <span class="preprocessor"></span>
<a name="l00277"></a>00277 <span class="comment">// End of file</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>