|
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: CHandlerDocument 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>CHandlerDocument Class Reference</h1><!-- doxytag: class="CHandlerDocument" --> |
|
13 <p><a href="class_c_handler_document-members.html">List of all members.</a></p> |
|
14 <table border="0" cellpadding="0" cellspacing="0"> |
|
15 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> |
|
16 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_handler_document.html#adf0699caf9506bb8a8f5371466e0012b">~CHandlerDocument</a> ()</td></tr> |
|
17 <tr><td class="memItemLeft" align="right" valign="top">CEikAppUi * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_handler_document.html#ab8f0f2c585493c32bf15459cf27fb5d9">CreateAppUiL</a> ()</td></tr> |
|
18 <tr><td class="memItemLeft" align="right" valign="top">CFileStore * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_handler_document.html#ad94b2d5d94375cc63a2cc5654c8374b7">OpenFileL</a> (TBool aDoOpen, const TDesC &aFilename, RFs &aFs)</td></tr> |
|
19 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4cf670adfa6877e757c341b142dc156"></a><!-- doxytag: member="CHandlerDocument::OpenFileL" ref="af4cf670adfa6877e757c341b142dc156" args="(CFileStore *&aFileStore, RFile &aFile)" --> |
|
20 void </td><td class="memItemRight" valign="bottom"><b>OpenFileL</b> (CFileStore *&aFileStore, RFile &aFile)</td></tr> |
|
21 <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> |
|
22 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_handler_document.html">CHandlerDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_handler_document.html#ae7efc152a5fa2151d04036971f7f1135">NewL</a> (CEikApplication &aApp)</td></tr> |
|
23 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_handler_document.html">CHandlerDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_handler_document.html#ac847fa1ca4f5147fc03a1e56efbbbbbf">NewLC</a> (CEikApplication &aApp)</td></tr> |
|
24 </table> |
|
25 <hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
26 <p>An instance of class <a class="el" href="class_c_handler_document.html">CHandlerDocument</a> is the Document part of the AVKON application framework for the handler example application </p> |
|
27 |
|
28 <p>Definition at line <a class="el" href="handler_document_8h_source.html#l00025">25</a> of file <a class="el" href="handler_document_8h_source.html">handlerDocument.h</a>.</p> |
|
29 <hr/><h2>Constructor & Destructor Documentation</h2> |
|
30 <a class="anchor" id="adf0699caf9506bb8a8f5371466e0012b"></a><!-- doxytag: member="CHandlerDocument::~CHandlerDocument" ref="adf0699caf9506bb8a8f5371466e0012b" args="()" --> |
|
31 <div class="memitem"> |
|
32 <div class="memproto"> |
|
33 <table class="memname"> |
|
34 <tr> |
|
35 <td class="memname">CHandlerDocument::~CHandlerDocument </td> |
|
36 <td>(</td> |
|
37 <td class="paramname"></td> |
|
38 <td> ) </td> |
|
39 <td></td> |
|
40 </tr> |
|
41 </table> |
|
42 </div> |
|
43 <div class="memdoc"> |
|
44 <p>~CHandlerDocument</p> |
|
45 <p>Destroy the object and release all memory objects </p> |
|
46 |
|
47 <p>Definition at line <a class="el" href="handler_document_8cpp_source.html#l00047">47</a> of file <a class="el" href="handler_document_8cpp_source.html">handlerDocument.cpp</a>.</p> |
|
48 |
|
49 </div> |
|
50 </div> |
|
51 <hr/><h2>Member Function Documentation</h2> |
|
52 <a class="anchor" id="ae7efc152a5fa2151d04036971f7f1135"></a><!-- doxytag: member="CHandlerDocument::NewL" ref="ae7efc152a5fa2151d04036971f7f1135" args="(CEikApplication &aApp)" --> |
|
53 <div class="memitem"> |
|
54 <div class="memproto"> |
|
55 <table class="memname"> |
|
56 <tr> |
|
57 <td class="memname"><a class="el" href="class_c_handler_document.html">CHandlerDocument</a> * CHandlerDocument::NewL </td> |
|
58 <td>(</td> |
|
59 <td class="paramtype">CEikApplication & </td> |
|
60 <td class="paramname"> <em>aApp</em></td> |
|
61 <td> ) </td> |
|
62 <td><code> [static]</code></td> |
|
63 </tr> |
|
64 </table> |
|
65 </div> |
|
66 <div class="memdoc"> |
|
67 <p>NewL</p> |
|
68 <p>Construct a <a class="el" href="class_c_handler_document.html">CHandlerDocument</a> for the AVKON application aApp using two phase construction, and return a pointer to the created object </p> |
|
69 <dl><dt><b>Parameters:</b></dt><dd> |
|
70 <table border="0" cellspacing="2" cellpadding="0"> |
|
71 <tr><td valign="top"></td><td valign="top"><em>aApp</em> </td><td>application creating this document </td></tr> |
|
72 </table> |
|
73 </dd> |
|
74 </dl> |
|
75 <dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the created instance of <a class="el" href="class_c_handler_document.html">CHandlerDocument</a> </dd></dl> |
|
76 |
|
77 <p>Definition at line <a class="el" href="handler_document_8cpp_source.html#l00022">22</a> of file <a class="el" href="handler_document_8cpp_source.html">handlerDocument.cpp</a>.</p> |
|
78 |
|
79 </div> |
|
80 </div> |
|
81 <a class="anchor" id="ac847fa1ca4f5147fc03a1e56efbbbbbf"></a><!-- doxytag: member="CHandlerDocument::NewLC" ref="ac847fa1ca4f5147fc03a1e56efbbbbbf" args="(CEikApplication &aApp)" --> |
|
82 <div class="memitem"> |
|
83 <div class="memproto"> |
|
84 <table class="memname"> |
|
85 <tr> |
|
86 <td class="memname"><a class="el" href="class_c_handler_document.html">CHandlerDocument</a> * CHandlerDocument::NewLC </td> |
|
87 <td>(</td> |
|
88 <td class="paramtype">CEikApplication & </td> |
|
89 <td class="paramname"> <em>aApp</em></td> |
|
90 <td> ) </td> |
|
91 <td><code> [static]</code></td> |
|
92 </tr> |
|
93 </table> |
|
94 </div> |
|
95 <div class="memdoc"> |
|
96 <p>NewLC</p> |
|
97 <p>Construct a <a class="el" href="class_c_handler_document.html">CHandlerDocument</a> for the AVKON application aApp using two phase construction, and return a pointer to the created object </p> |
|
98 <dl><dt><b>Parameters:</b></dt><dd> |
|
99 <table border="0" cellspacing="2" cellpadding="0"> |
|
100 <tr><td valign="top"></td><td valign="top"><em>aApp</em> </td><td>application creating this document </td></tr> |
|
101 </table> |
|
102 </dd> |
|
103 </dl> |
|
104 <dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the created instance of <a class="el" href="class_c_handler_document.html">CHandlerDocument</a> </dd></dl> |
|
105 |
|
106 <p>Definition at line <a class="el" href="handler_document_8cpp_source.html#l00029">29</a> of file <a class="el" href="handler_document_8cpp_source.html">handlerDocument.cpp</a>.</p> |
|
107 |
|
108 </div> |
|
109 </div> |
|
110 <a class="anchor" id="ab8f0f2c585493c32bf15459cf27fb5d9"></a><!-- doxytag: member="CHandlerDocument::CreateAppUiL" ref="ab8f0f2c585493c32bf15459cf27fb5d9" args="()" --> |
|
111 <div class="memitem"> |
|
112 <div class="memproto"> |
|
113 <table class="memname"> |
|
114 <tr> |
|
115 <td class="memname">CEikAppUi * CHandlerDocument::CreateAppUiL </td> |
|
116 <td>(</td> |
|
117 <td class="paramname"></td> |
|
118 <td> ) </td> |
|
119 <td></td> |
|
120 </tr> |
|
121 </table> |
|
122 </div> |
|
123 <div class="memdoc"> |
|
124 <p>CreateAppUiL</p> |
|
125 <p>Create a <a class="el" href="class_c_handler_app_ui.html">CHandlerAppUi</a> object and return a pointer to it </p> |
|
126 <dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the created instance of the AppUi created </dd></dl> |
|
127 |
|
128 <p>Definition at line <a class="el" href="handler_document_8cpp_source.html#l00052">52</a> of file <a class="el" href="handler_document_8cpp_source.html">handlerDocument.cpp</a>.</p> |
|
129 |
|
130 </div> |
|
131 </div> |
|
132 <a class="anchor" id="ad94b2d5d94375cc63a2cc5654c8374b7"></a><!-- doxytag: member="CHandlerDocument::OpenFileL" ref="ad94b2d5d94375cc63a2cc5654c8374b7" args="(TBool aDoOpen, const TDesC &aFilename, RFs &aFs)" --> |
|
133 <div class="memitem"> |
|
134 <div class="memproto"> |
|
135 <table class="memname"> |
|
136 <tr> |
|
137 <td class="memname">CFileStore * CHandlerDocument::OpenFileL </td> |
|
138 <td>(</td> |
|
139 <td class="paramtype">TBool </td> |
|
140 <td class="paramname"> <em>aDoOpen</em>, </td> |
|
141 </tr> |
|
142 <tr> |
|
143 <td class="paramkey"></td> |
|
144 <td></td> |
|
145 <td class="paramtype">const TDesC & </td> |
|
146 <td class="paramname"> <em>aFilename</em>, </td> |
|
147 </tr> |
|
148 <tr> |
|
149 <td class="paramkey"></td> |
|
150 <td></td> |
|
151 <td class="paramtype">RFs & </td> |
|
152 <td class="paramname"> <em>aFs</em></td><td> </td> |
|
153 </tr> |
|
154 <tr> |
|
155 <td></td> |
|
156 <td>)</td> |
|
157 <td></td><td></td><td></td> |
|
158 </tr> |
|
159 </table> |
|
160 </div> |
|
161 <div class="memdoc"> |
|
162 <p>From <code>CEikDocument</code>. Opens a file. </p> |
|
163 <dl><dt><b>Parameters:</b></dt><dd> |
|
164 <table border="0" cellspacing="2" cellpadding="0"> |
|
165 <tr><td valign="top"></td><td valign="top"><em>aDoOpen</em> </td><td>Open an existing file if <code>ETrue</code>, otherwise create a new file. Not used. </td></tr> |
|
166 <tr><td valign="top"></td><td valign="top"><em>aFilename</em> </td><td>The file to open or create. Not used. </td></tr> |
|
167 <tr><td valign="top"></td><td valign="top"><em>aFs</em> </td><td>File server session to use. Not used. </td></tr> |
|
168 </table> |
|
169 </dd> |
|
170 </dl> |
|
171 <dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to file store object. </dd></dl> |
|
172 |
|
173 <p>Definition at line <a class="el" href="handler_document_8cpp_source.html#l00060">60</a> of file <a class="el" href="handler_document_8cpp_source.html">handlerDocument.cpp</a>.</p> |
|
174 |
|
175 </div> |
|
176 </div> |
|
177 </div> |
|
178 <hr size="1"/><address style="text-align: right;"><small>Generated by |
|
179 <a href="http://www.doxygen.org/index.html"> |
|
180 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> |
|
181 </body> |
|
182 </html> |