Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_handler_document.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: CHandlerDocument 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>CHandlerDocument Class Reference</h1><!-- doxytag: class="CHandlerDocument" -->
<p><a href="class_c_handler_document-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<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>
<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>
<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>
<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)" -->
void </td><td class="memItemRight" valign="bottom"><b>OpenFileL</b> (CFileStore *&aFileStore, RFile &aFile)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<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>
<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>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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>
<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>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="adf0699caf9506bb8a8f5371466e0012b"></a><!-- doxytag: member="CHandlerDocument::~CHandlerDocument" ref="adf0699caf9506bb8a8f5371466e0012b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CHandlerDocument::~CHandlerDocument </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>~CHandlerDocument</p>
<p>Destroy the object and release all memory objects </p>
<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>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae7efc152a5fa2151d04036971f7f1135"></a><!-- doxytag: member="CHandlerDocument::NewL" ref="ae7efc152a5fa2151d04036971f7f1135" args="(CEikApplication &aApp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_handler_document.html">CHandlerDocument</a> * CHandlerDocument::NewL </td>
<td>(</td>
<td class="paramtype">CEikApplication & </td>
<td class="paramname"> <em>aApp</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewL</p>
<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>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aApp</em> </td><td>application creating this document </td></tr>
</table>
</dd>
</dl>
<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>
<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>
</div>
</div>
<a class="anchor" id="ac847fa1ca4f5147fc03a1e56efbbbbbf"></a><!-- doxytag: member="CHandlerDocument::NewLC" ref="ac847fa1ca4f5147fc03a1e56efbbbbbf" args="(CEikApplication &aApp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_handler_document.html">CHandlerDocument</a> * CHandlerDocument::NewLC </td>
<td>(</td>
<td class="paramtype">CEikApplication & </td>
<td class="paramname"> <em>aApp</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewLC</p>
<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>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aApp</em> </td><td>application creating this document </td></tr>
</table>
</dd>
</dl>
<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>
<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>
</div>
</div>
<a class="anchor" id="ab8f0f2c585493c32bf15459cf27fb5d9"></a><!-- doxytag: member="CHandlerDocument::CreateAppUiL" ref="ab8f0f2c585493c32bf15459cf27fb5d9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEikAppUi * CHandlerDocument::CreateAppUiL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>CreateAppUiL</p>
<p>Create a <a class="el" href="class_c_handler_app_ui.html">CHandlerAppUi</a> object and return a pointer to it </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the created instance of the AppUi created </dd></dl>
<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>
</div>
</div>
<a class="anchor" id="ad94b2d5d94375cc63a2cc5654c8374b7"></a><!-- doxytag: member="CHandlerDocument::OpenFileL" ref="ad94b2d5d94375cc63a2cc5654c8374b7" args="(TBool aDoOpen, const TDesC &aFilename, RFs &aFs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CFileStore * CHandlerDocument::OpenFileL </td>
<td>(</td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aDoOpen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aFilename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RFs & </td>
<td class="paramname"> <em>aFs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>From <code>CEikDocument</code>. Opens a file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<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>
<tr><td valign="top"></td><td valign="top"><em>aFilename</em> </td><td>The file to open or create. Not used. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aFs</em> </td><td>File server session to use. Not used. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to file store object. </dd></dl>
<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>
</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>