Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_viewer_starter.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: ViewerStarter Class Reference</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 -->
<div class="contents">
<h1>ViewerStarter Class Reference</h1><!-- doxytag: class="ViewerStarter" -->
<p><a href="class_viewer_starter-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static IMPORT_C CMsvOperation * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_viewer_starter.html#a178f324348f5d41092cb2f0b5210b41b">LaunchEditorApplicationL</a> (CMsvSession &aSession, TUid aMtmType, TRequestStatus &aStatus, const <a class="el" href="class_t_editor_parameters.html">TEditorParameters</a> &aParams, const TDesC &aAppName, const TDesC8 *aAddtionalParams=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static IMPORT_C CMsvOperation * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_viewer_starter.html#a589587755211f338b700b2be566c2913">LaunchEditorApplicationL</a> (CMsvSession &aSession, TUid aMtmType, TRequestStatus &aStatus, const <a class="el" href="class_t_editor_parameters.html">TEditorParameters</a> &aParams, const TDesC &aAppName, const TDesC8 &aProgressPack, const TDesC8 *aAddtionalParams=NULL)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_viewer_starter.html">ViewerStarter</a></p>
<p>Static class which launches editor application (provided editor conforms to architecture).</p>
<p>The returned operation completes either when the launched application closes down, or after the launch has been initiated depending on the values in the <a class="el" href="class_t_editor_parameters.html">TEditorParameters</a>. </p>
<p>Definition at line <a class="el" href="_txt_viewer_starter_8h_source.html#l00134">134</a> of file <a class="el" href="_txt_viewer_starter_8h_source.html">TxtViewerStarter.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a178f324348f5d41092cb2f0b5210b41b"></a><!-- doxytag: member="ViewerStarter::LaunchEditorApplicationL" ref="a178f324348f5d41092cb2f0b5210b41b" args="(CMsvSession &aSession, TUid aMtmType, TRequestStatus &aStatus, const TEditorParameters &aParams, const TDesC &aAppName, const TDesC8 *aAddtionalParams=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static IMPORT_C CMsvOperation* ViewerStarter::LaunchEditorApplicationL </td>
<td>(</td>
<td class="paramtype">CMsvSession & </td>
<td class="paramname"> <em>aSession</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TUid </td>
<td class="paramname"> <em>aMtmType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRequestStatus & </td>
<td class="paramname"> <em>aStatus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_t_editor_parameters.html">TEditorParameters</a> & </td>
<td class="paramname"> <em>aParams</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aAppName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC8 * </td>
<td class="paramname"> <em>aAddtionalParams</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Launch message editor </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSession,:</em> </td><td>reference to CMsvSession object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aMtmType,:</em> </td><td>mtm type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aStatus,:</em> </td><td>request status </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aParams,:</em> </td><td>editor launch parameters, should have always embedded flag on: aParams.iFlags&EMsgLaunchEditorEmbedded </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aAppName,:</em> </td><td>editor name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aAddtionamParams,:</em> </td><td>additional parameters </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a589587755211f338b700b2be566c2913"></a><!-- doxytag: member="ViewerStarter::LaunchEditorApplicationL" ref="a589587755211f338b700b2be566c2913" args="(CMsvSession &aSession, TUid aMtmType, TRequestStatus &aStatus, const TEditorParameters &aParams, const TDesC &aAppName, const TDesC8 &aProgressPack, const TDesC8 *aAddtionalParams=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static IMPORT_C CMsvOperation* ViewerStarter::LaunchEditorApplicationL </td>
<td>(</td>
<td class="paramtype">CMsvSession & </td>
<td class="paramname"> <em>aSession</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TUid </td>
<td class="paramname"> <em>aMtmType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRequestStatus & </td>
<td class="paramname"> <em>aStatus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_t_editor_parameters.html">TEditorParameters</a> & </td>
<td class="paramname"> <em>aParams</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aAppName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC8 & </td>
<td class="paramname"> <em>aProgressPack</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC8 * </td>
<td class="paramname"> <em>aAddtionalParams</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Launch message editor </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSession,:</em> </td><td>reference to CMsvSession object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aMtmType,:</em> </td><td>mtm type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aStatus,:</em> </td><td>request status </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aParams,:</em> </td><td>editor launch parameters, should have always embedded flag on: aParams.iFlags&EMsgLaunchEditorEmbedded </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aAppName,:</em> </td><td>editor name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aProgressPack,:</em> </td><td>progress buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aAddtionamParams,:</em> </td><td>additional parameters </td></tr>
</table>
</dd>
</dl>
</div>
</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>