|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
2 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
3 <head> |
|
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
5 <title>TB9.2 Example Applications: ViewerStarter Class Reference</title> |
|
6 <link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
7 <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
8 </head> |
|
9 <body> |
|
10 <!-- Generated by Doxygen 1.6.2 --> |
|
11 <div class="contents"> |
|
12 <h1>ViewerStarter Class Reference</h1><!-- doxytag: class="ViewerStarter" --> |
|
13 <p><a href="class_viewer_starter-members.html">List of all members.</a></p> |
|
14 <table border="0" cellpadding="0" cellspacing="0"> |
|
15 <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> |
|
16 <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> |
|
17 <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> |
|
18 </table> |
|
19 <hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
20 <p><a class="el" href="class_viewer_starter.html">ViewerStarter</a></p> |
|
21 <p>Static class which launches editor application (provided editor conforms to architecture).</p> |
|
22 <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> |
|
23 |
|
24 <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> |
|
25 <hr/><h2>Member Function Documentation</h2> |
|
26 <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)" --> |
|
27 <div class="memitem"> |
|
28 <div class="memproto"> |
|
29 <table class="memname"> |
|
30 <tr> |
|
31 <td class="memname">static IMPORT_C CMsvOperation* ViewerStarter::LaunchEditorApplicationL </td> |
|
32 <td>(</td> |
|
33 <td class="paramtype">CMsvSession & </td> |
|
34 <td class="paramname"> <em>aSession</em>, </td> |
|
35 </tr> |
|
36 <tr> |
|
37 <td class="paramkey"></td> |
|
38 <td></td> |
|
39 <td class="paramtype">TUid </td> |
|
40 <td class="paramname"> <em>aMtmType</em>, </td> |
|
41 </tr> |
|
42 <tr> |
|
43 <td class="paramkey"></td> |
|
44 <td></td> |
|
45 <td class="paramtype">TRequestStatus & </td> |
|
46 <td class="paramname"> <em>aStatus</em>, </td> |
|
47 </tr> |
|
48 <tr> |
|
49 <td class="paramkey"></td> |
|
50 <td></td> |
|
51 <td class="paramtype">const <a class="el" href="class_t_editor_parameters.html">TEditorParameters</a> & </td> |
|
52 <td class="paramname"> <em>aParams</em>, </td> |
|
53 </tr> |
|
54 <tr> |
|
55 <td class="paramkey"></td> |
|
56 <td></td> |
|
57 <td class="paramtype">const TDesC & </td> |
|
58 <td class="paramname"> <em>aAppName</em>, </td> |
|
59 </tr> |
|
60 <tr> |
|
61 <td class="paramkey"></td> |
|
62 <td></td> |
|
63 <td class="paramtype">const TDesC8 * </td> |
|
64 <td class="paramname"> <em>aAddtionalParams</em> = <code>NULL</code></td><td> </td> |
|
65 </tr> |
|
66 <tr> |
|
67 <td></td> |
|
68 <td>)</td> |
|
69 <td></td><td></td><td><code> [static]</code></td> |
|
70 </tr> |
|
71 </table> |
|
72 </div> |
|
73 <div class="memdoc"> |
|
74 <p>Launch message editor </p> |
|
75 <dl><dt><b>Parameters:</b></dt><dd> |
|
76 <table border="0" cellspacing="2" cellpadding="0"> |
|
77 <tr><td valign="top"></td><td valign="top"><em>aSession,:</em> </td><td>reference to CMsvSession object </td></tr> |
|
78 <tr><td valign="top"></td><td valign="top"><em>aMtmType,:</em> </td><td>mtm type </td></tr> |
|
79 <tr><td valign="top"></td><td valign="top"><em>aStatus,:</em> </td><td>request status </td></tr> |
|
80 <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> |
|
81 <tr><td valign="top"></td><td valign="top"><em>aAppName,:</em> </td><td>editor name </td></tr> |
|
82 <tr><td valign="top"></td><td valign="top"><em>aAddtionamParams,:</em> </td><td>additional parameters </td></tr> |
|
83 </table> |
|
84 </dd> |
|
85 </dl> |
|
86 |
|
87 </div> |
|
88 </div> |
|
89 <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)" --> |
|
90 <div class="memitem"> |
|
91 <div class="memproto"> |
|
92 <table class="memname"> |
|
93 <tr> |
|
94 <td class="memname">static IMPORT_C CMsvOperation* ViewerStarter::LaunchEditorApplicationL </td> |
|
95 <td>(</td> |
|
96 <td class="paramtype">CMsvSession & </td> |
|
97 <td class="paramname"> <em>aSession</em>, </td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td class="paramkey"></td> |
|
101 <td></td> |
|
102 <td class="paramtype">TUid </td> |
|
103 <td class="paramname"> <em>aMtmType</em>, </td> |
|
104 </tr> |
|
105 <tr> |
|
106 <td class="paramkey"></td> |
|
107 <td></td> |
|
108 <td class="paramtype">TRequestStatus & </td> |
|
109 <td class="paramname"> <em>aStatus</em>, </td> |
|
110 </tr> |
|
111 <tr> |
|
112 <td class="paramkey"></td> |
|
113 <td></td> |
|
114 <td class="paramtype">const <a class="el" href="class_t_editor_parameters.html">TEditorParameters</a> & </td> |
|
115 <td class="paramname"> <em>aParams</em>, </td> |
|
116 </tr> |
|
117 <tr> |
|
118 <td class="paramkey"></td> |
|
119 <td></td> |
|
120 <td class="paramtype">const TDesC & </td> |
|
121 <td class="paramname"> <em>aAppName</em>, </td> |
|
122 </tr> |
|
123 <tr> |
|
124 <td class="paramkey"></td> |
|
125 <td></td> |
|
126 <td class="paramtype">const TDesC8 & </td> |
|
127 <td class="paramname"> <em>aProgressPack</em>, </td> |
|
128 </tr> |
|
129 <tr> |
|
130 <td class="paramkey"></td> |
|
131 <td></td> |
|
132 <td class="paramtype">const TDesC8 * </td> |
|
133 <td class="paramname"> <em>aAddtionalParams</em> = <code>NULL</code></td><td> </td> |
|
134 </tr> |
|
135 <tr> |
|
136 <td></td> |
|
137 <td>)</td> |
|
138 <td></td><td></td><td><code> [static]</code></td> |
|
139 </tr> |
|
140 </table> |
|
141 </div> |
|
142 <div class="memdoc"> |
|
143 <p>Launch message editor </p> |
|
144 <dl><dt><b>Parameters:</b></dt><dd> |
|
145 <table border="0" cellspacing="2" cellpadding="0"> |
|
146 <tr><td valign="top"></td><td valign="top"><em>aSession,:</em> </td><td>reference to CMsvSession object </td></tr> |
|
147 <tr><td valign="top"></td><td valign="top"><em>aMtmType,:</em> </td><td>mtm type </td></tr> |
|
148 <tr><td valign="top"></td><td valign="top"><em>aStatus,:</em> </td><td>request status </td></tr> |
|
149 <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> |
|
150 <tr><td valign="top"></td><td valign="top"><em>aAppName,:</em> </td><td>editor name </td></tr> |
|
151 <tr><td valign="top"></td><td valign="top"><em>aProgressPack,:</em> </td><td>progress buffer </td></tr> |
|
152 <tr><td valign="top"></td><td valign="top"><em>aAddtionamParams,:</em> </td><td>additional parameters </td></tr> |
|
153 </table> |
|
154 </dd> |
|
155 </dl> |
|
156 |
|
157 </div> |
|
158 </div> |
|
159 </div> |
|
160 <hr size="1"/><address style="text-align: right;"><small>Generated by |
|
161 <a href="http://www.doxygen.org/index.html"> |
|
162 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> |
|
163 </body> |
|
164 </html> |