Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class__c__hello__world__basic__application_8html_source.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: examples/S60CppExamples/helloworldbasic/doc/class_c_hello_world_basic_application.html Source File</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 -->
<h1>examples/S60CppExamples/helloworldbasic/doc/class_c_hello_world_basic_application.html</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <!DOCTYPE HTML PUBLIC <span class="stringliteral">"-//W3C//DTD HTML 4.0 Transitional//EN"</span>>
<a name="l00002"></a>00002 <html>
<a name="l00003"></a>00003
<a name="l00004"></a>00004 <head>
<a name="l00005"></a>00005 <meta http-equiv=<span class="stringliteral">"Content-Type"</span> content=<span class="stringliteral">"text/html;charset=iso-8859-1"</span>>
<a name="l00006"></a>00006 <title><a class="code" href="class_c_hello_world_basic_application.html">CHelloWorldBasicApplication</a> Class Reference</title>
<a name="l00007"></a>00007 <link href=<span class="stringliteral">"style.css"</span> rel=<span class="stringliteral">"stylesheet"</span> type=<span class="stringliteral">"text/css"</span>>
<a name="l00008"></a>00008 </head>
<a name="l00009"></a>00009
<a name="l00010"></a>00010 <table border=<span class="stringliteral">"0"</span> width=<span class="stringliteral">"100%"</span> height=<span class="stringliteral">"8"</span> bgcolor=<span class="stringliteral">"#eeeeee"</span>>
<a name="l00011"></a>00011 <tr> <td width=<span class="stringliteral">"100%"</span> height=<span class="stringliteral">"1"</span>><b><font size=<span class="stringliteral">"2"</span> color=<span class="stringliteral">"#000000"</span> face=<span class="stringliteral">"Arial, Helvetica, sans-serif"</span>><strong><a name=Top></a>
<a name="l00012"></a>00012 S60 5th Edition SDK </strong></font></b><br><i>Example Applications Guide</i></td></tr> </table>
<a name="l00013"></a>00013 <!-- Generated by Doxygen 1.4.5 -->
<a name="l00014"></a>00014 <div <span class="keyword">class</span>=<span class="stringliteral">"tabs"</span>>
<a name="l00015"></a>00015 <ul>
<a name="l00016"></a>00016 <li><a href=<span class="stringliteral">"index.html"</span>><span>Main&nbsp;Page</span></a></li>
<a name="l00017"></a>00017 <li <span class="keywordtype">id</span>=<span class="stringliteral">"current"</span>><a href=<span class="stringliteral">"annotated.html"</span>><span>Classes</span></a></li>
<a name="l00018"></a>00018 <li><a href=<span class="stringliteral">"files.html"</span>><span>Files</span></a></li>
<a name="l00019"></a>00019 </ul></div>
<a name="l00020"></a>00020 <div <span class="keyword">class</span>=<span class="stringliteral">"tabs"</span>>
<a name="l00021"></a>00021 <ul>
<a name="l00022"></a>00022 <li><a href=<span class="stringliteral">"annotated.html"</span>><span>Class&nbsp;List</span></a></li>
<a name="l00023"></a>00023 <li><a href=<span class="stringliteral">"hierarchy.html"</span>><span>Class&nbsp;Hierarchy</span></a></li>
<a name="l00024"></a>00024 <li><a href=<span class="stringliteral">"functions.html"</span>><span>Class&nbsp;Members</span></a></li>
<a name="l00025"></a>00025 </ul></div>
<a name="l00026"></a>00026 <h1><a class="code" href="class_c_hello_world_basic_application.html">CHelloWorldBasicApplication</a> Class Reference</h1><!-- doxytag: <span class="keyword">class</span>=<span class="stringliteral">"CHelloWorldBasicApplication"</span> --><!-- doxytag: inherits=<span class="stringliteral">"CAknApplication"</span> --><code>#include &lt;<a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"helloworldbasicapplication_8h-source.html"</span>>helloworldbasicapplication.h</a>&gt;</code>
<a name="l00027"></a>00027 <p>
<a name="l00028"></a>00028 <p>Inheritance diagram <span class="keywordflow">for</span> <a class="code" href="class_c_hello_world_basic_application.html">CHelloWorldBasicApplication</a>:
<a name="l00029"></a>00029 <p><center><img src=<span class="stringliteral">"class_c_hello_world_basic_application.png"</span> usemap=<span class="stringliteral">"#CHelloWorldBasicApplication_map"</span> border=<span class="stringliteral">"0"</span> alt=<span class="stringliteral">""</span>></center>
<a name="l00030"></a>00030 <map name=<span class="stringliteral">"CHelloWorldBasicApplication_map"</span>>
<a name="l00031"></a>00031 </map>
<a name="l00032"></a>00032 <a href=<span class="stringliteral">"class_c_hello_world_basic_application-members.html"</span>>List of all members.</a><hr><a name=<span class="stringliteral">"_details"</span>></a><h2>Detailed Description</h2>
<a name="l00033"></a>00033 <a class="code" href="class_c_hello_world_basic_application.html">CHelloWorldBasicApplication</a> application <span class="keyword">class</span>. Provides factory to create concrete document <span class="keywordtype">object</span>. An instance of <a class="code" href="class_c_hello_world_basic_application.html">CHelloWorldBasicApplication</a> is the application part of the AVKON application framework <span class="keywordflow">for</span> the HelloWorldBasic example application.
<a name="l00034"></a>00034 <p>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <p>
<a name="l00037"></a>00037 Definition at line <a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"helloworldbasicapplication_8h-source.html#l00030"</span>>30</a> of file <a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"helloworldbasicapplication_8h-source.html"</span>>helloworldbasicapplication.h</a>.<table border=<span class="stringliteral">"0"</span> cellpadding=<span class="stringliteral">"0"</span> cellspacing=<span class="stringliteral">"0"</span>>
<a name="l00038"></a>00038 <tr><td></td></tr>
<a name="l00039"></a>00039 <tr><td colspan=<span class="stringliteral">"2"</span>><br><h2>Public Member Functions</h2></td></tr>
<a name="l00040"></a>00040 <tr><td <span class="keyword">class</span>=<span class="stringliteral">"memItemLeft"</span> nowrap align=<span class="stringliteral">"right"</span> valign=<span class="stringliteral">"top"</span>>TUid&nbsp;</td><td <span class="keyword">class</span>=<span class="stringliteral">"memItemRight"</span> valign=<span class="stringliteral">"bottom"</span>><a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"class_c_hello_world_basic_application.html#266a6db7f5728454ee8b7a9c5f517dca"</span>>AppDllUid</a> () const </td></tr>
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <tr><td colspan=<span class="stringliteral">"2"</span>><br><h2>Protected Member Functions</h2></td></tr>
<a name="l00043"></a>00043 <tr><td <span class="keyword">class</span>=<span class="stringliteral">"memItemLeft"</span> nowrap align=<span class="stringliteral">"right"</span> valign=<span class="stringliteral">"top"</span>>CApaDocument *&nbsp;</td><td <span class="keyword">class</span>=<span class="stringliteral">"memItemRight"</span> valign=<span class="stringliteral">"bottom"</span>><a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"class_c_hello_world_basic_application.html#0a048c97a8c1868d0e1e5daf2838bcab"</span>>CreateDocumentL</a> ()</td></tr>
<a name="l00044"></a>00044
<a name="l00045"></a>00045 </table>
<a name="l00046"></a>00046 <hr><h2>Member Function Documentation</h2>
<a name="l00047"></a>00047 <a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"266a6db7f5728454ee8b7a9c5f517dca"</span>></a><!-- doxytag: member=<span class="stringliteral">"CHelloWorldBasicApplication::AppDllUid"</span> ref=<span class="stringliteral">"266a6db7f5728454ee8b7a9c5f517dca"</span> args=<span class="stringliteral">"() const "</span> --><p>
<a name="l00048"></a>00048 <table <span class="keyword">class</span>=<span class="stringliteral">"mdTable"</span> cellpadding=<span class="stringliteral">"2"</span> cellspacing=<span class="stringliteral">"0"</span>>
<a name="l00049"></a>00049 <tr>
<a name="l00050"></a>00050 <td <span class="keyword">class</span>=<span class="stringliteral">"mdRow"</span>>
<a name="l00051"></a>00051 <table cellpadding=<span class="stringliteral">"0"</span> cellspacing=<span class="stringliteral">"0"</span> border=<span class="stringliteral">"0"</span>>
<a name="l00052"></a>00052 <tr>
<a name="l00053"></a>00053 <td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> nowrap valign=<span class="stringliteral">"top"</span>>TUid CHelloWorldBasicApplication::AppDllUid </td>
<a name="l00054"></a>00054 <td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> valign=<span class="stringliteral">"top"</span>>(&nbsp;</td>
<a name="l00055"></a>00055 <td <span class="keyword">class</span>=<span class="stringliteral">"mdname1"</span> valign=<span class="stringliteral">"top"</span> nowrap> </td>
<a name="l00056"></a>00056 <td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> valign=<span class="stringliteral">"top"</span>>&nbsp;)&nbsp;</td>
<a name="l00057"></a>00057 <td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> nowrap> <span class="keyword">const</span></td>
<a name="l00058"></a>00058 </tr>
<a name="l00059"></a>00059 </table>
<a name="l00060"></a>00060 </td>
<a name="l00061"></a>00061 </tr>
<a name="l00062"></a>00062 </table>
<a name="l00063"></a>00063 <table cellspacing=<span class="stringliteral">"5"</span> cellpadding=<span class="stringliteral">"0"</span> border=<span class="stringliteral">"0"</span>>
<a name="l00064"></a>00064 <tr>
<a name="l00065"></a>00065 <td>
<a name="l00066"></a>00066 &nbsp;
<a name="l00067"></a>00067 </td>
<a name="l00068"></a>00068 <td>
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <p>
<a name="l00071"></a>00071 From CApaApplication, AppDllUid. <dl compact><dt><b>Returns:</b></dt><dd>Application<span class="stringliteral">'s UID (KUidHelloWorldBasicApp). </dd></dl></span>
<a name="l00072"></a>00072 <span class="stringliteral"></span>
<a name="l00073"></a>00073 <span class="stringliteral"><p></span>
<a name="l00074"></a>00074 <span class="stringliteral">Definition at line <a class="el" href="helloworldbasicapplication_8cpp-source.html#l00043">43</a> of file <a class="el" href="helloworldbasicapplication_8cpp-source.html">helloworldbasicapplication.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00044"></a>00044 {</span>
<a name="l00075"></a>00075 <span class="stringliteral"><a name="l00045"></a>00045 <span class="comment">// Return the UID for the HelloWorldBasic application</span></span>
<a name="l00076"></a>00076 <span class="stringliteral"><a name="l00046"></a>00046 <span class="keywordflow">return</span> KUidHelloWorldBasicApp;</span>
<a name="l00077"></a>00077 <span class="stringliteral"><a name="l00047"></a>00047 }</span>
<a name="l00078"></a>00078 <span class="stringliteral"></pre></div></span>
<a name="l00079"></a>00079 <span class="stringliteral"><p></span>
<a name="l00080"></a>00080 <span class="stringliteral"> </td></span>
<a name="l00081"></a>00081 <span class="stringliteral"> </tr></span>
<a name="l00082"></a>00082 <span class="stringliteral"></table></span>
<a name="l00083"></a>00083 <span class="stringliteral"><a class="anchor" name="0a048c97a8c1868d0e1e5daf2838bcab"></a><!-- doxytag: member="CHelloWorldBasicApplication::CreateDocumentL" ref="0a048c97a8c1868d0e1e5daf2838bcab" args="()" --><p></span>
<a name="l00084"></a>00084 <span class="stringliteral"><table class="mdTable" cellpadding="2" cellspacing="0"></span>
<a name="l00085"></a>00085 <span class="stringliteral"> <tr></span>
<a name="l00086"></a>00086 <span class="stringliteral"> <td class="mdRow"></span>
<a name="l00087"></a>00087 <span class="stringliteral"> <table cellpadding="0" cellspacing="0" border="0"></span>
<a name="l00088"></a>00088 <span class="stringliteral"> <tr></span>
<a name="l00089"></a>00089 <span class="stringliteral"> <td class="md" nowrap valign="top">CApaDocument * CHelloWorldBasicApplication::CreateDocumentL </td></span>
<a name="l00090"></a>00090 <span class="stringliteral"> <td class="md" valign="top">(&nbsp;</td></span>
<a name="l00091"></a>00091 <span class="stringliteral"> <td class="mdname1" valign="top" nowrap> </td></span>
<a name="l00092"></a>00092 <span class="stringliteral"> <td class="md" valign="top">&nbsp;)&nbsp;</td></span>
<a name="l00093"></a>00093 <span class="stringliteral"> <td class="md" nowrap><code> [protected]</code></td></span>
<a name="l00094"></a>00094 <span class="stringliteral"> </tr></span>
<a name="l00095"></a>00095 <span class="stringliteral"> </table></span>
<a name="l00096"></a>00096 <span class="stringliteral"> </td></span>
<a name="l00097"></a>00097 <span class="stringliteral"> </tr></span>
<a name="l00098"></a>00098 <span class="stringliteral"></table></span>
<a name="l00099"></a>00099 <span class="stringliteral"><table cellspacing="5" cellpadding="0" border="0"></span>
<a name="l00100"></a>00100 <span class="stringliteral"> <tr></span>
<a name="l00101"></a>00101 <span class="stringliteral"> <td></span>
<a name="l00102"></a>00102 <span class="stringliteral"> &nbsp;</span>
<a name="l00103"></a>00103 <span class="stringliteral"> </td></span>
<a name="l00104"></a>00104 <span class="stringliteral"> <td></span>
<a name="l00105"></a>00105 <span class="stringliteral"></span>
<a name="l00106"></a>00106 <span class="stringliteral"><p></span>
<a name="l00107"></a>00107 <span class="stringliteral">From CApaApplication, CreateDocumentL. Creates <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> document object. The returned pointer in not owned by the CHelloWorldBasicApplication object. <dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created document object. </dd></dl></span>
<a name="l00108"></a>00108 <span class="stringliteral"></span>
<a name="l00109"></a>00109 <span class="stringliteral"><p></span>
<a name="l00110"></a>00110 <span class="stringliteral">Definition at line <a class="el" href="helloworldbasicapplication_8cpp-source.html#l00031">31</a> of file <a class="el" href="helloworldbasicapplication_8cpp-source.html">helloworldbasicapplication.cpp</a>.</span>
<a name="l00111"></a>00111 <span class="stringliteral"><p></span>
<a name="l00112"></a>00112 <span class="stringliteral">References <a class="el" href="helloworldbasicdocument_8cpp-source.html#l00027">CHelloWorldBasicDocument::NewL()</a>.<div class="fragment"><pre class="fragment"><a name="l00032"></a>00032 {</span>
<a name="l00113"></a>00113 <span class="stringliteral"><a name="l00033"></a>00033 <span class="comment">// Create an HelloWorldBasic document, and return a pointer to it</span></span>
<a name="l00114"></a>00114 <span class="stringliteral"><a name="l00034"></a>00034 <span class="keywordflow">return</span> (static_cast&lt;CApaDocument*&gt;</span>
<a name="l00115"></a>00115 <span class="stringliteral"><a name="l00035"></a>00035 ( <a class="code" href="class_c_hello_world_basic_document.html#97d8413d74643854e05e60e11a177553">CHelloWorldBasicDocument::NewL</a>( *<span class="keyword">this</span> ) ) );</span>
<a name="l00116"></a>00116 <span class="stringliteral"><a name="l00036"></a>00036 }</span>
<a name="l00117"></a>00117 <span class="stringliteral"></pre></div></span>
<a name="l00118"></a>00118 <span class="stringliteral"><p></span>
<a name="l00119"></a>00119 <span class="stringliteral"> </td></span>
<a name="l00120"></a>00120 <span class="stringliteral"> </tr></span>
<a name="l00121"></a>00121 <span class="stringliteral"></table></span>
<a name="l00122"></a>00122 <span class="stringliteral"><hr>The documentation for this class was generated from the following files:<ul></span>
<a name="l00123"></a>00123 <span class="stringliteral"><li><a class="el" href="helloworldbasicapplication_8h-source.html">helloworldbasicapplication.h</a><li><a class="el" href="helloworldbasicapplication_8cpp-source.html">helloworldbasicapplication.cpp</a></ul></span>
<a name="l00124"></a>00124 <span class="stringliteral"><hr></span>
<a name="l00125"></a>00125 <span class="stringliteral"></span>
<a name="l00126"></a>00126 <span class="stringliteral"><table x-use-null-cells</span>
<a name="l00127"></a>00127 <span class="stringliteral"> style="x-cell-content-align: top;</span>
<a name="l00128"></a>00128 <span class="stringliteral"> width: 100%;</span>
<a name="l00129"></a>00129 <span class="stringliteral"> border-spacing: 0px;</span>
<a name="l00130"></a>00130 <span class="stringliteral"> border-spacing: 0px;"</span>
<a name="l00131"></a>00131 <span class="stringliteral"> cellspacing=0</span>
<a name="l00132"></a>00132 <span class="stringliteral"> width=100%></span>
<a name="l00133"></a>00133 <span class="stringliteral"> <col style="width: 50%;"></span>
<a name="l00134"></a>00134 <span class="stringliteral"> <col style="width: 50%;"></span>
<a name="l00135"></a>00135 <span class="stringliteral"></span>
<a name="l00136"></a>00136 <span class="stringliteral"> <tr style="x-cell-content-align: top;"</span>
<a name="l00137"></a>00137 <span class="stringliteral"> valign=top></span>
<a name="l00138"></a>00138 <span class="stringliteral"> <td style="width: 50%;</span>
<a name="l00139"></a>00139 <span class="stringliteral"> padding-right: 10px;</span>
<a name="l00140"></a>00140 <span class="stringliteral"> padding-left: 10px;</span>
<a name="l00141"></a>00141 <span class="stringliteral"> border-right-style: None;</span>
<a name="l00142"></a>00142 <span class="stringliteral"> border-left-style: None;</span>
<a name="l00143"></a>00143 <span class="stringliteral"> border-top-style: None;</span>
<a name="l00144"></a>00144 <span class="stringliteral"> border-bottom-style: None;"</span>
<a name="l00145"></a>00145 <span class="stringliteral"> width=50%></span>
<a name="l00146"></a>00146 <span class="stringliteral"> <p style="font-family: Arial;"><small style="font-size: smaller;">© Nokia 2009</small></td></span>
<a name="l00147"></a>00147 <span class="stringliteral"> <td style="width: 50%;</span>
<a name="l00148"></a>00148 <span class="stringliteral"> padding-right: 10px;</span>
<a name="l00149"></a>00149 <span class="stringliteral"> padding-left: 10px;</span>
<a name="l00150"></a>00150 <span class="stringliteral"> border-top-style: None;</span>
<a name="l00151"></a>00151 <span class="stringliteral"> border-bottom-style: None;</span>
<a name="l00152"></a>00152 <span class="stringliteral"> border-right-style: None;"</span>
<a name="l00153"></a>00153 <span class="stringliteral"> width=50%></span>
<a name="l00154"></a>00154 <span class="stringliteral"> <p style="text-align: right; margin-right: -4px;"</span>
<a name="l00155"></a>00155 <span class="stringliteral"> align=right><span style="font-weight: bold;"><a href="#Top"</span>
<a name="l00156"></a>00156 <span class="stringliteral"> title="Back to top"><img</span>
<a name="l00157"></a>00157 <span class="stringliteral"> src="top.gif"</span>
<a name="l00158"></a>00158 <span class="stringliteral"> x-maintain-ratio=TRUE</span>
<a name="l00159"></a>00159 <span class="stringliteral"> alt="Back to top"</span>
<a name="l00160"></a>00160 <span class="stringliteral"> style="border: none;</span>
<a name="l00161"></a>00161 <span class="stringliteral"> width: 18px;</span>
<a name="l00162"></a>00162 <span class="stringliteral"> height: 15px;</span>
<a name="l00163"></a>00163 <span class="stringliteral"> float: none;</span>
<a name="l00164"></a>00164 <span class="stringliteral"> border-style: none;</span>
<a name="l00165"></a>00165 <span class="stringliteral"> border-style: none;"</span>
<a name="l00166"></a>00166 <span class="stringliteral"> width=18</span>
<a name="l00167"></a>00167 <span class="stringliteral"> height=15</span>
<a name="l00168"></a>00168 <span class="stringliteral"> border=0></a></span></td></tr></span>
<a name="l00169"></a>00169 <span class="stringliteral"> </table></span>
<a name="l00170"></a>00170 <span class="stringliteral"></body></span>
<a name="l00171"></a>00171 <span class="stringliteral"></html></span>
<a name="l00172"></a>00172 <span class="stringliteral"></span>
</pre></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>