Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_hello_world_basic_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: CHelloWorldBasicDocument 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>CHelloWorldBasicDocument Class Reference</h1><!-- doxytag: class="CHelloWorldBasicDocument" -->
<p><a href="class_c_hello_world_basic_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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#a1f8542d9d52e018d71177ba045be17c9">~CHelloWorldBasicDocument</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CEikAppUi * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#ac2579614da65e8b1ba74cc5cb525f19d">CreateAppUiL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#a7f814225fc04da0467bd6d381ee9dc35">~CHelloWorldBasicDocument</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CEikAppUi * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#aaa74eaf80847d984cf124c47bda1071d">CreateAppUiL</a> ()</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_hello_world_basic_document.html">CHelloWorldBasicDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#aae5def314d0c4d0c4c4ede7d7f62c7b9">NewL</a> (CEikApplication &aApp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#a97a7e8e9ca276dde864269fe892c265b">NewLC</a> (CEikApplication &aApp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#a3f2969b88dc1f698f56be62e6f691866">NewL</a> (CEikApplication &aApp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#aeca9ceef60a26d2674282c521c943b6a">NewLC</a> (CEikApplication &aApp)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> application class. An instance of class <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> is the Document part of the AVKON application framework for the HelloWorldBasic example application. </p>
<p>Definition at line <a class="el" href="_forum_nokia_2_s60__3rd___edition___text_m_t_m___example_2modules_2_install_2src_2helloworldbasicdocument_8h_source.html#l00034">34</a> of file <a class="el" href="_forum_nokia_2_s60__3rd___edition___text_m_t_m___example_2modules_2_install_2src_2helloworldbasicdocument_8h_source.html">helloworldbasicdocument.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1f8542d9d52e018d71177ba045be17c9"></a><!-- doxytag: member="CHelloWorldBasicDocument::~CHelloWorldBasicDocument" ref="a1f8542d9d52e018d71177ba045be17c9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CHelloWorldBasicDocument::~CHelloWorldBasicDocument </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>~CHelloWorldBasicDocument Virtual Destructor. </p>
<p>Definition at line <a class="el" href="helloworldbasicdocument_8cpp_source.html#l00077">77</a> of file <a class="el" href="helloworldbasicdocument_8cpp_source.html">helloworldbasicdocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7f814225fc04da0467bd6d381ee9dc35"></a><!-- doxytag: member="CHelloWorldBasicDocument::~CHelloWorldBasicDocument" ref="a7f814225fc04da0467bd6d381ee9dc35" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual CHelloWorldBasicDocument::~CHelloWorldBasicDocument </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>~CHelloWorldBasicDocument Virtual Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aae5def314d0c4d0c4c4ede7d7f62c7b9"></a><!-- doxytag: member="CHelloWorldBasicDocument::NewL" ref="aae5def314d0c4d0c4c4ede7d7f62c7b9" args="(CEikApplication &aApp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> * CHelloWorldBasicDocument::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. Two-phased constructor. Construct a <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</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_hello_world_basic_document.html">CHelloWorldBasicDocument</a>. </dd></dl>
<p>Definition at line <a class="el" href="helloworldbasicdocument_8cpp_source.html#l00027">27</a> of file <a class="el" href="helloworldbasicdocument_8cpp_source.html">helloworldbasicdocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a97a7e8e9ca276dde864269fe892c265b"></a><!-- doxytag: member="CHelloWorldBasicDocument::NewLC" ref="a97a7e8e9ca276dde864269fe892c265b" args="(CEikApplication &aApp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> * CHelloWorldBasicDocument::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. Two-phased constructor. Construct a <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</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_hello_world_basic_document.html">CHelloWorldBasicDocument</a>. </dd></dl>
<p>Definition at line <a class="el" href="helloworldbasicdocument_8cpp_source.html#l00040">40</a> of file <a class="el" href="helloworldbasicdocument_8cpp_source.html">helloworldbasicdocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac2579614da65e8b1ba74cc5cb525f19d"></a><!-- doxytag: member="CHelloWorldBasicDocument::CreateAppUiL" ref="ac2579614da65e8b1ba74cc5cb525f19d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEikAppUi * CHelloWorldBasicDocument::CreateAppUiL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>CreateAppUiL From CEikDocument, CreateAppUiL. Create a <a class="el" href="class_c_hello_world_basic_app_ui.html">CHelloWorldBasicAppUi</a> object and return a pointer to it. The object returned is owned by the Uikon framework. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to created instance of AppUi. </dd></dl>
<p>Definition at line <a class="el" href="helloworldbasicdocument_8cpp_source.html#l00087">87</a> of file <a class="el" href="helloworldbasicdocument_8cpp_source.html">helloworldbasicdocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3f2969b88dc1f698f56be62e6f691866"></a><!-- doxytag: member="CHelloWorldBasicDocument::NewL" ref="a3f2969b88dc1f698f56be62e6f691866" args="(CEikApplication &aApp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a>* CHelloWorldBasicDocument::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. Two-phased constructor. Construct a <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</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_hello_world_basic_document.html">CHelloWorldBasicDocument</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="aeca9ceef60a26d2674282c521c943b6a"></a><!-- doxytag: member="CHelloWorldBasicDocument::NewLC" ref="aeca9ceef60a26d2674282c521c943b6a" args="(CEikApplication &aApp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a>* CHelloWorldBasicDocument::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. Two-phased constructor. Construct a <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</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_hello_world_basic_document.html">CHelloWorldBasicDocument</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="aaa74eaf80847d984cf124c47bda1071d"></a><!-- doxytag: member="CHelloWorldBasicDocument::CreateAppUiL" ref="aaa74eaf80847d984cf124c47bda1071d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEikAppUi* CHelloWorldBasicDocument::CreateAppUiL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>CreateAppUiL From CEikDocument, CreateAppUiL. Create a <a class="el" href="class_c_hello_world_basic_app_ui.html">CHelloWorldBasicAppUi</a> object and return a pointer to it. The object returned is owned by the Uikon framework. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to created instance of AppUi. </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>