examples/S60CppExamples/helloworldbasic/doc/class_c_hello_world_basic_document.html

00001 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
00002 <html>
00003 
00004 <head>
00005 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
00006 <title>CHelloWorldBasicDocument Class Reference</title>
00007 <link href="style.css" rel="stylesheet" type="text/css">
00008 </head>
00009 
00010 <table border="0" width="100%" height="8" bgcolor="#eeeeee">
00011 <tr> <td width="100%" height="1"><b><font size="2" color="#000000" face="Arial, Helvetica, sans-serif"><strong><a name=Top></a>
00012 S60 5th Edition SDK </strong></font></b><br><i>Example Applications Guide</i></td></tr> </table>
00013 <!-- Generated by Doxygen 1.4.5 -->
00014 <div class="tabs">
00015   <ul>
00016     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
00017     <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
00018     <li><a href="files.html"><span>Files</span></a></li>
00019   </ul></div>
00020 <div class="tabs">
00021   <ul>
00022     <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
00023     <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
00024     <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
00025   </ul></div>
00026 <h1>CHelloWorldBasicDocument Class Reference</h1><!-- doxytag: class="CHelloWorldBasicDocument" --><!-- doxytag: inherits="CAknDocument" --><code>#include &lt;<a class="el" href="helloworldbasicdocument_8h-source.html">helloworldbasicdocument.h</a>&gt;</code>
00027 <p>
00028 <p>Inheritance diagram for CHelloWorldBasicDocument:
00029 <p><center><img src="class_c_hello_world_basic_document.png" usemap="#CHelloWorldBasicDocument_map" border="0" alt=""></center>
00030 <map name="CHelloWorldBasicDocument_map">
00031 </map>
00032 <a href="class_c_hello_world_basic_document-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
00033 CHelloWorldBasicDocument application class. An instance of class CHelloWorldBasicDocument is the Document part of the AVKON application framework for the HelloWorldBasic example application. 
00034 <p>
00035 
00036 <p>
00037 Definition at line <a class="el" href="helloworldbasicdocument_8h-source.html#l00034">34</a> of file <a class="el" href="helloworldbasicdocument_8h-source.html">helloworldbasicdocument.h</a>.<table border="0" cellpadding="0" cellspacing="0">
00038 <tr><td></td></tr>
00039 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
00040 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#38db548c717a9a7df64d3c2aaa254612">~CHelloWorldBasicDocument</a> ()</td></tr>
00041 
00042 <tr><td class="memItemLeft" nowrap align="right" valign="top">CEikAppUi *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#0eb34f98d849338274127e28e8c78b4e">CreateAppUiL</a> ()</td></tr>
00043 
00044 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
00045 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#97d8413d74643854e05e60e11a177553">NewL</a> (CEikApplication &amp;aApp)</td></tr>
00046 
00047 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#4b4aa55001690769b8aac3d27274aef8">NewLC</a> (CEikApplication &amp;aApp)</td></tr>
00048 
00049 <tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr>
00050 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#9ce34ba0b947863222da3c63d0481044">ConstructL</a> ()</td></tr>
00051 
00052 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hello_world_basic_document.html#bb6b5232044d786261a557dfa7947419">CHelloWorldBasicDocument</a> (CEikApplication &amp;aApp)</td></tr>
00053 
00054 </table>
00055 <hr><h2>Constructor &amp; Destructor Documentation</h2>
00056 <a class="anchor" name="38db548c717a9a7df64d3c2aaa254612"></a><!-- doxytag: member="CHelloWorldBasicDocument::~CHelloWorldBasicDocument" ref="38db548c717a9a7df64d3c2aaa254612" args="()" --><p>
00057 <table class="mdTable" cellpadding="2" cellspacing="0">
00058   <tr>
00059     <td class="mdRow">
00060       <table cellpadding="0" cellspacing="0" border="0">
00061         <tr>
00062           <td class="md" nowrap valign="top">CHelloWorldBasicDocument::~CHelloWorldBasicDocument           </td>
00063           <td class="md" valign="top">(&nbsp;</td>
00064           <td class="mdname1" valign="top" nowrap>          </td>
00065           <td class="md" valign="top">&nbsp;)&nbsp;</td>
00066           <td class="md" nowrap><code> [virtual]</code></td>
00067         </tr>
00068       </table>
00069     </td>
00070   </tr>
00071 </table>
00072 <table cellspacing="5" cellpadding="0" border="0">
00073   <tr>
00074     <td>
00075       &nbsp;
00076     </td>
00077     <td>
00078 
00079 <p>
00080 ~CHelloWorldBasicDocument Virtual Destructor. 
00081 <p>
00082 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>.<div class="fragment"><pre class="fragment"><a name="l00078"></a>00078     {
00083 <a name="l00079"></a>00079     <span class="comment">// No implementation required</span>
00084 <a name="l00080"></a>00080     }
00085 </pre></div>
00086 <p>
00087     </td>
00088   </tr>
00089 </table>
00090 <a class="anchor" name="bb6b5232044d786261a557dfa7947419"></a><!-- doxytag: member="CHelloWorldBasicDocument::CHelloWorldBasicDocument" ref="bb6b5232044d786261a557dfa7947419" args="(CEikApplication &amp;aApp)" --><p>
00091 <table class="mdTable" cellpadding="2" cellspacing="0">
00092   <tr>
00093     <td class="mdRow">
00094       <table cellpadding="0" cellspacing="0" border="0">
00095         <tr>
00096           <td class="md" nowrap valign="top">CHelloWorldBasicDocument::CHelloWorldBasicDocument           </td>
00097           <td class="md" valign="top">(&nbsp;</td>
00098           <td class="md" nowrap valign="top">CEikApplication &amp;&nbsp;</td>
00099           <td class="mdname1" valign="top" nowrap> <em>aApp</em>          </td>
00100           <td class="md" valign="top">&nbsp;)&nbsp;</td>
00101           <td class="md" nowrap><code> [private]</code></td>
00102         </tr>
00103       </table>
00104     </td>
00105   </tr>
00106 </table>
00107 <table cellspacing="5" cellpadding="0" border="0">
00108   <tr>
00109     <td>
00110       &nbsp;
00111     </td>
00112     <td>
00113 
00114 <p>
00115 CHelloWorldBasicDocument. C++ default constructor. <dl compact><dt><b>Parameters:</b></dt><dd>
00116   <table border="0" cellspacing="2" cellpadding="0">
00117     <tr><td valign="top"></td><td valign="top"><em>aApp</em>&nbsp;</td><td>Application creating this document. </td></tr>
00118   </table>
00119 </dl>
00120 
00121 <p>
00122 Definition at line <a class="el" href="helloworldbasicdocument_8cpp-source.html#l00066">66</a> of file <a class="el" href="helloworldbasicdocument_8cpp-source.html">helloworldbasicdocument.cpp</a>.
00123 <p>
00124 Referenced by <a class="el" href="helloworldbasicdocument_8cpp-source.html#l00040">NewLC()</a>.<div class="fragment"><pre class="fragment"><a name="l00067"></a>00067     : CAknDocument( aApp )
00125 <a name="l00068"></a>00068     {
00126 <a name="l00069"></a>00069     <span class="comment">// No implementation required</span>
00127 <a name="l00070"></a>00070     }
00128 </pre></div>
00129 <p>
00130     </td>
00131   </tr>
00132 </table>
00133 <hr><h2>Member Function Documentation</h2>
00134 <a class="anchor" name="97d8413d74643854e05e60e11a177553"></a><!-- doxytag: member="CHelloWorldBasicDocument::NewL" ref="97d8413d74643854e05e60e11a177553" args="(CEikApplication &amp;aApp)" --><p>
00135 <table class="mdTable" cellpadding="2" cellspacing="0">
00136   <tr>
00137     <td class="mdRow">
00138       <table cellpadding="0" cellspacing="0" border="0">
00139         <tr>
00140           <td class="md" nowrap valign="top"><a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> * CHelloWorldBasicDocument::NewL           </td>
00141           <td class="md" valign="top">(&nbsp;</td>
00142           <td class="md" nowrap valign="top">CEikApplication &amp;&nbsp;</td>
00143           <td class="mdname1" valign="top" nowrap> <em>aApp</em>          </td>
00144           <td class="md" valign="top">&nbsp;)&nbsp;</td>
00145           <td class="md" nowrap><code> [static]</code></td>
00146         </tr>
00147       </table>
00148     </td>
00149   </tr>
00150 </table>
00151 <table cellspacing="5" cellpadding="0" border="0">
00152   <tr>
00153     <td>
00154       &nbsp;
00155     </td>
00156     <td>
00157 
00158 <p>
00159 NewL. Two-phased constructor. Construct a CHelloWorldBasicDocument for the AVKON application aApp using two phase construction, and return a pointer to the created object. <dl compact><dt><b>Parameters:</b></dt><dd>
00160   <table border="0" cellspacing="2" cellpadding="0">
00161     <tr><td valign="top"></td><td valign="top"><em>aApp</em>&nbsp;</td><td>Application creating this document. </td></tr>
00162   </table>
00163 </dl>
00164 <dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created instance of CHelloWorldBasicDocument. </dd></dl>
00165 
00166 <p>
00167 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>.
00168 <p>
00169 References <a class="el" href="helloworldbasicdocument_8cpp-source.html#l00040">NewLC()</a>.
00170 <p>
00171 Referenced by <a class="el" href="helloworldbasicapplication_8cpp-source.html#l00031">CHelloWorldBasicApplication::CreateDocumentL()</a>.<div class="fragment"><pre class="fragment"><a name="l00029"></a>00029     {
00172 <a name="l00030"></a>00030     <a class="code" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a>* <span class="keyword">self</span> = <a class="code" href="class_c_hello_world_basic_document.html#4b4aa55001690769b8aac3d27274aef8">NewLC</a>( aApp );
00173 <a name="l00031"></a>00031     CleanupStack::Pop( <span class="keyword">self</span> );
00174 <a name="l00032"></a>00032     <span class="keywordflow">return</span> <span class="keyword">self</span>;
00175 <a name="l00033"></a>00033     }
00176 </pre></div>
00177 <p>
00178     </td>
00179   </tr>
00180 </table>
00181 <a class="anchor" name="4b4aa55001690769b8aac3d27274aef8"></a><!-- doxytag: member="CHelloWorldBasicDocument::NewLC" ref="4b4aa55001690769b8aac3d27274aef8" args="(CEikApplication &amp;aApp)" --><p>
00182 <table class="mdTable" cellpadding="2" cellspacing="0">
00183   <tr>
00184     <td class="mdRow">
00185       <table cellpadding="0" cellspacing="0" border="0">
00186         <tr>
00187           <td class="md" nowrap valign="top"><a class="el" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a> * CHelloWorldBasicDocument::NewLC           </td>
00188           <td class="md" valign="top">(&nbsp;</td>
00189           <td class="md" nowrap valign="top">CEikApplication &amp;&nbsp;</td>
00190           <td class="mdname1" valign="top" nowrap> <em>aApp</em>          </td>
00191           <td class="md" valign="top">&nbsp;)&nbsp;</td>
00192           <td class="md" nowrap><code> [static]</code></td>
00193         </tr>
00194       </table>
00195     </td>
00196   </tr>
00197 </table>
00198 <table cellspacing="5" cellpadding="0" border="0">
00199   <tr>
00200     <td>
00201       &nbsp;
00202     </td>
00203     <td>
00204 
00205 <p>
00206 NewLC. Two-phased constructor. Construct a CHelloWorldBasicDocument for the AVKON application aApp using two phase construction, and return a pointer to the created object. <dl compact><dt><b>Parameters:</b></dt><dd>
00207   <table border="0" cellspacing="2" cellpadding="0">
00208     <tr><td valign="top"></td><td valign="top"><em>aApp</em>&nbsp;</td><td>Application creating this document. </td></tr>
00209   </table>
00210 </dl>
00211 <dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created instance of CHelloWorldBasicDocument. </dd></dl>
00212 
00213 <p>
00214 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>.
00215 <p>
00216 References <a class="el" href="helloworldbasicdocument_8cpp-source.html#l00066">CHelloWorldBasicDocument()</a>.
00217 <p>
00218 Referenced by <a class="el" href="helloworldbasicdocument_8cpp-source.html#l00027">NewL()</a>.<div class="fragment"><pre class="fragment"><a name="l00042"></a>00042     {
00219 <a name="l00043"></a>00043     <a class="code" href="class_c_hello_world_basic_document.html">CHelloWorldBasicDocument</a>* <span class="keyword">self</span> =
00220 <a name="l00044"></a>00044         <span class="keyword">new</span> ( ELeave ) <a class="code" href="class_c_hello_world_basic_document.html#bb6b5232044d786261a557dfa7947419">CHelloWorldBasicDocument</a>( aApp );
00221 <a name="l00045"></a>00045 
00222 <a name="l00046"></a>00046     CleanupStack::PushL( <span class="keyword">self</span> );
00223 <a name="l00047"></a>00047     <span class="keyword">self</span>-&gt;ConstructL();
00224 <a name="l00048"></a>00048     <span class="keywordflow">return</span> <span class="keyword">self</span>;
00225 <a name="l00049"></a>00049     }
00226 </pre></div>
00227 <p>
00228     </td>
00229   </tr>
00230 </table>
00231 <a class="anchor" name="0eb34f98d849338274127e28e8c78b4e"></a><!-- doxytag: member="CHelloWorldBasicDocument::CreateAppUiL" ref="0eb34f98d849338274127e28e8c78b4e" args="()" --><p>
00232 <table class="mdTable" cellpadding="2" cellspacing="0">
00233   <tr>
00234     <td class="mdRow">
00235       <table cellpadding="0" cellspacing="0" border="0">
00236         <tr>
00237           <td class="md" nowrap valign="top">CEikAppUi * CHelloWorldBasicDocument::CreateAppUiL           </td>
00238           <td class="md" valign="top">(&nbsp;</td>
00239           <td class="mdname1" valign="top" nowrap>          </td>
00240           <td class="md" valign="top">&nbsp;)&nbsp;</td>
00241           <td class="md" nowrap></td>
00242         </tr>
00243       </table>
00244     </td>
00245   </tr>
00246 </table>
00247 <table cellspacing="5" cellpadding="0" border="0">
00248   <tr>
00249     <td>
00250       &nbsp;
00251     </td>
00252     <td>
00253 
00254 <p>
00255 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. <dl compact><dt><b>Returns:</b></dt><dd>Pointer to created instance of AppUi. </dd></dl>
00256 
00257 <p>
00258 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>.<div class="fragment"><pre class="fragment"><a name="l00088"></a>00088     {
00259 <a name="l00089"></a>00089     <span class="comment">// Create the application user interface, and return a pointer to it;</span>
00260 <a name="l00090"></a>00090     <span class="comment">// the framework takes ownership of this object</span>
00261 <a name="l00091"></a>00091     <span class="keywordflow">return</span> ( static_cast &lt;CEikAppUi*&gt; ( <span class="keyword">new</span> ( ELeave )
00262 <a name="l00092"></a>00092                                         <a class="code" href="class_c_hello_world_basic_app_ui.html">CHelloWorldBasicAppUi</a> ) );
00263 <a name="l00093"></a>00093     }
00264 </pre></div>
00265 <p>
00266     </td>
00267   </tr>
00268 </table>
00269 <a class="anchor" name="9ce34ba0b947863222da3c63d0481044"></a><!-- doxytag: member="CHelloWorldBasicDocument::ConstructL" ref="9ce34ba0b947863222da3c63d0481044" args="()" --><p>
00270 <table class="mdTable" cellpadding="2" cellspacing="0">
00271   <tr>
00272     <td class="mdRow">
00273       <table cellpadding="0" cellspacing="0" border="0">
00274         <tr>
00275           <td class="md" nowrap valign="top">void CHelloWorldBasicDocument::ConstructL           </td>
00276           <td class="md" valign="top">(&nbsp;</td>
00277           <td class="mdname1" valign="top" nowrap>          </td>
00278           <td class="md" valign="top">&nbsp;)&nbsp;</td>
00279           <td class="md" nowrap><code> [private]</code></td>
00280         </tr>
00281       </table>
00282     </td>
00283   </tr>
00284 </table>
00285 <table cellspacing="5" cellpadding="0" border="0">
00286   <tr>
00287     <td>
00288       &nbsp;
00289     </td>
00290     <td>
00291 
00292 <p>
00293 ConstructL 2nd phase constructor. 
00294 <p>
00295 Definition at line <a class="el" href="helloworldbasicdocument_8cpp-source.html#l00056">56</a> of file <a class="el" href="helloworldbasicdocument_8cpp-source.html">helloworldbasicdocument.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00057"></a>00057     {
00296 <a name="l00058"></a>00058     <span class="comment">// No implementation required</span>
00297 <a name="l00059"></a>00059     }
00298 </pre></div>
00299 <p>
00300     </td>
00301   </tr>
00302 </table>
00303 <hr>The documentation for this class was generated from the following files:<ul>
00304 <li><a class="el" href="helloworldbasicdocument_8h-source.html">helloworldbasicdocument.h</a><li><a class="el" href="helloworldbasicdocument_8cpp-source.html">helloworldbasicdocument.cpp</a></ul>
00305 <hr>
00306 
00307 <table x-use-null-cells
00308                 style="x-cell-content-align: top;
00309                                 width: 100%;
00310                                 border-spacing: 0px;
00311                                 border-spacing: 0px;"
00312                 cellspacing=0
00313                 width=100%>
00314   <col style="width: 50%;">
00315   <col style="width: 50%;">
00316 
00317   <tr style="x-cell-content-align: top;"
00318         valign=top>
00319   <td style="width: 50%;
00320                         padding-right: 10px;
00321                         padding-left: 10px;
00322                         border-right-style: None;
00323                         border-left-style: None;
00324                         border-top-style: None;
00325                         border-bottom-style: None;"
00326         width=50%>
00327   <p style="font-family: Arial;"><small style="font-size: smaller;">© Nokia 2009</small></td>
00328   <td style="width: 50%;
00329                         padding-right: 10px;
00330                         padding-left: 10px;
00331                         border-top-style: None;
00332                         border-bottom-style: None;
00333                         border-right-style: None;"
00334         width=50%>
00335   <p style="text-align: right; margin-right: -4px;"
00336         align=right><span style="font-weight: bold;"><a href="#Top"
00337                                                                                                         title="Back to top"><img
00338  src="top.gif"
00339         x-maintain-ratio=TRUE
00340         alt="Back to top"
00341         style="border: none;
00342                         width: 18px;
00343                         height: 15px;
00344                         float: none;
00345                         border-style: none;
00346                         border-style: none;"
00347         width=18
00348         height=15
00349         border=0></a></span></td></tr>
00350  </table>
00351 </body>
00352 </html>
00353 

Generated by  doxygen 1.6.2