Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_long_number.html
changeset 1 25a17d01db0c
child 6 43e37759235e
equal deleted inserted replaced
0:89d6a7a84779 1:25a17d01db0c
       
     1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
       
     2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
       
     3 <title>TB10.1 Example Applications: CLongNumber Class Reference</title>
       
     4 <link href="doxygen.css" rel="stylesheet" type="text/css">
       
     5 <link href="tabs.css" rel="stylesheet" type="text/css">
       
     6 </head><body>
       
     7 <!-- Generated by Doxygen 1.5.3 -->
       
     8 <h1>CLongNumber Class Reference</h1><!-- doxytag: class="CLongNumber" -->
       
     9 <p>
       
    10 <a href="class_c_long_number-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
       
    11 <tr><td></td></tr>
       
    12 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
       
    13 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#1b7d3d5b97621f32d776d9b1a0d19d8a">RunL</a> ()</td></tr>
       
    14 
       
    15 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#7039dbe9ebbf42b59f919ba2755dd8a3">DoCancel</a> ()</td></tr>
       
    16 
       
    17 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#1c0ebc1c9dbcc9c34250ffef859b8a2f">AddToScheduler</a> ()</td></tr>
       
    18 
       
    19 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#1b5d110a5df39ccfeda083160370dc5c">ReadNumber</a> ()</td></tr>
       
    20 
       
    21 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#2112ad5c07adc10adf5d63c33ef2d5cd">~CLongNumber</a> ()</td></tr>
       
    22 
       
    23 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#ec695d1da24cd27f36fed7c4f0ffe0a6">PrintNumber</a> ()</td></tr>
       
    24 
       
    25 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#a7b7c59251aa6d2ffc25f0ec9312b59d">InitializeIter</a> ()</td></tr>
       
    26 
       
    27 <tr><td class="memItemLeft" nowrap align="right" valign="top">TBool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#5ef806e05880bcf07c0506bd36beefe0">GetNumber</a> (TInt &amp;aValue)</td></tr>
       
    28 
       
    29 <tr><td class="memItemLeft" nowrap align="right" valign="top">TBool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#e717f76bb1203c1c495b5e37fa4d8ff9">Slide</a> ()</td></tr>
       
    30 
       
    31 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
       
    32 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_long_number.html">CLongNumber</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#a6cb04e2afa3b0948941ab4910739331">NewL</a> (CConsoleBase *aConsole)</td></tr>
       
    33 
       
    34 </table>
       
    35 <hr><a name="_details"></a><h2>Detailed Description</h2>
       
    36 This class has an object of the TSglQue class, which represents the digits of an integer number list. It is derived from the CActive class to handle asynchronous user inputs. It has methods to:<ul>
       
    37 <li>edit the linked list</li><li>traverse the linked list using an iterator </li></ul>
       
    38 
       
    39 <p>Definition at line <a class="el" href="longnumber_8h-source.html#l00034">34</a> of file <a class="el" href="longnumber_8h-source.html">longnumber.h</a>.</p>
       
    40 <hr><h2>Constructor &amp; Destructor Documentation</h2>
       
    41 <a class="anchor" name="2112ad5c07adc10adf5d63c33ef2d5cd"></a><!-- doxytag: member="CLongNumber::~CLongNumber" ref="2112ad5c07adc10adf5d63c33ef2d5cd" args="()" -->
       
    42 <div class="memitem">
       
    43 <div class="memproto">
       
    44       <table class="memname">
       
    45         <tr>
       
    46           <td class="memname">CLongNumber::~CLongNumber           </td>
       
    47           <td>(</td>
       
    48           <td class="paramname">          </td>
       
    49           <td>&nbsp;)&nbsp;</td>
       
    50           <td width="100%"></td>
       
    51         </tr>
       
    52       </table>
       
    53 </div>
       
    54 <div class="memdoc">
       
    55 
       
    56 <p>
       
    57 Destructor. The <a class="el" href="class_t_digit.html">TDigit</a> objects were allocated memory at runtime. Iterate over the list to delete them. 
       
    58 <p>Definition at line <a class="el" href="longnumber_8cpp-source.html#l00277">277</a> of file <a class="el" href="longnumber_8cpp-source.html">longnumber.cpp</a>.</p>
       
    59 
       
    60 </div>
       
    61 </div><p>
       
    62 <hr><h2>Member Function Documentation</h2>
       
    63 <a class="anchor" name="a6cb04e2afa3b0948941ab4910739331"></a><!-- doxytag: member="CLongNumber::NewL" ref="a6cb04e2afa3b0948941ab4910739331" args="(CConsoleBase *aConsole)" -->
       
    64 <div class="memitem">
       
    65 <div class="memproto">
       
    66       <table class="memname">
       
    67         <tr>
       
    68           <td class="memname"><a class="el" href="class_c_long_number.html">CLongNumber</a> * CLongNumber::NewL           </td>
       
    69           <td>(</td>
       
    70           <td class="paramtype">CConsoleBase *&nbsp;</td>
       
    71           <td class="paramname"> <em>aConsole</em>          </td>
       
    72           <td>&nbsp;)&nbsp;</td>
       
    73           <td width="100%"><code> [static]</code></td>
       
    74         </tr>
       
    75       </table>
       
    76 </div>
       
    77 <div class="memdoc">
       
    78 
       
    79 <p>
       
    80 Creates an object of the <a class="el" href="class_c_long_number.html">CLongNumber</a> class. <dl compact><dt><b>Parameters:</b></dt><dd>
       
    81   <table border="0" cellspacing="2" cellpadding="0">
       
    82     <tr><td valign="top"></td><td valign="top"><em>aConsole</em>&nbsp;</td><td>The user console. </td></tr>
       
    83   </table>
       
    84 </dl>
       
    85 <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the object of the <a class="el" href="class_c_long_number.html">CLongNumber</a> class. </dd></dl>
       
    86 
       
    87 <p>Definition at line <a class="el" href="longnumber_8cpp-source.html#l00030">30</a> of file <a class="el" href="longnumber_8cpp-source.html">longnumber.cpp</a>.</p>
       
    88 
       
    89 </div>
       
    90 </div><p>
       
    91 <a class="anchor" name="1b7d3d5b97621f32d776d9b1a0d19d8a"></a><!-- doxytag: member="CLongNumber::RunL" ref="1b7d3d5b97621f32d776d9b1a0d19d8a" args="()" -->
       
    92 <div class="memitem">
       
    93 <div class="memproto">
       
    94       <table class="memname">
       
    95         <tr>
       
    96           <td class="memname">void CLongNumber::RunL           </td>
       
    97           <td>(</td>
       
    98           <td class="paramname">          </td>
       
    99           <td>&nbsp;)&nbsp;</td>
       
   100           <td width="100%"></td>
       
   101         </tr>
       
   102       </table>
       
   103 </div>
       
   104 <div class="memdoc">
       
   105 
       
   106 <p>
       
   107 Handles the key-press events for this active object. 
       
   108 <p>Definition at line <a class="el" href="longnumber_8cpp-source.html#l00064">64</a> of file <a class="el" href="longnumber_8cpp-source.html">longnumber.cpp</a>.</p>
       
   109 
       
   110 </div>
       
   111 </div><p>
       
   112 <a class="anchor" name="7039dbe9ebbf42b59f919ba2755dd8a3"></a><!-- doxytag: member="CLongNumber::DoCancel" ref="7039dbe9ebbf42b59f919ba2755dd8a3" args="()" -->
       
   113 <div class="memitem">
       
   114 <div class="memproto">
       
   115       <table class="memname">
       
   116         <tr>
       
   117           <td class="memname">void CLongNumber::DoCancel           </td>
       
   118           <td>(</td>
       
   119           <td class="paramname">          </td>
       
   120           <td>&nbsp;)&nbsp;</td>
       
   121           <td width="100%"></td>
       
   122         </tr>
       
   123       </table>
       
   124 </div>
       
   125 <div class="memdoc">
       
   126 
       
   127 <p>
       
   128 Cancel any outstanding request. 
       
   129 <p>Definition at line <a class="el" href="longnumber_8cpp-source.html#l00263">263</a> of file <a class="el" href="longnumber_8cpp-source.html">longnumber.cpp</a>.</p>
       
   130 
       
   131 </div>
       
   132 </div><p>
       
   133 <a class="anchor" name="1c0ebc1c9dbcc9c34250ffef859b8a2f"></a><!-- doxytag: member="CLongNumber::AddToScheduler" ref="1c0ebc1c9dbcc9c34250ffef859b8a2f" args="()" -->
       
   134 <div class="memitem">
       
   135 <div class="memproto">
       
   136       <table class="memname">
       
   137         <tr>
       
   138           <td class="memname">void CLongNumber::AddToScheduler           </td>
       
   139           <td>(</td>
       
   140           <td class="paramname">          </td>
       
   141           <td>&nbsp;)&nbsp;</td>
       
   142           <td width="100%"></td>
       
   143         </tr>
       
   144       </table>
       
   145 </div>
       
   146 <div class="memdoc">
       
   147 
       
   148 <p>
       
   149 Adds this active object to the active scheduler 
       
   150 <p>Definition at line <a class="el" href="longnumber_8cpp-source.html#l00056">56</a> of file <a class="el" href="longnumber_8cpp-source.html">longnumber.cpp</a>.</p>
       
   151 
       
   152 </div>
       
   153 </div><p>
       
   154 <a class="anchor" name="1b5d110a5df39ccfeda083160370dc5c"></a><!-- doxytag: member="CLongNumber::ReadNumber" ref="1b5d110a5df39ccfeda083160370dc5c" args="()" -->
       
   155 <div class="memitem">
       
   156 <div class="memproto">
       
   157       <table class="memname">
       
   158         <tr>
       
   159           <td class="memname">void CLongNumber::ReadNumber           </td>
       
   160           <td>(</td>
       
   161           <td class="paramname">          </td>
       
   162           <td>&nbsp;)&nbsp;</td>
       
   163           <td width="100%"></td>
       
   164         </tr>
       
   165       </table>
       
   166 </div>
       
   167 <div class="memdoc">
       
   168 
       
   169 <p>
       
   170 Reads a number from the console. 
       
   171 <p>Definition at line <a class="el" href="longnumber_8cpp-source.html#l00183">183</a> of file <a class="el" href="longnumber_8cpp-source.html">longnumber.cpp</a>.</p>
       
   172 
       
   173 </div>
       
   174 </div><p>
       
   175 <a class="anchor" name="ec695d1da24cd27f36fed7c4f0ffe0a6"></a><!-- doxytag: member="CLongNumber::PrintNumber" ref="ec695d1da24cd27f36fed7c4f0ffe0a6" args="()" -->
       
   176 <div class="memitem">
       
   177 <div class="memproto">
       
   178       <table class="memname">
       
   179         <tr>
       
   180           <td class="memname">void CLongNumber::PrintNumber           </td>
       
   181           <td>(</td>
       
   182           <td class="paramname">          </td>
       
   183           <td>&nbsp;)&nbsp;</td>
       
   184           <td width="100%"></td>
       
   185         </tr>
       
   186       </table>
       
   187 </div>
       
   188 <div class="memdoc">
       
   189 
       
   190 <p>
       
   191 Prints the number. 
       
   192 <p>Definition at line <a class="el" href="longnumber_8cpp-source.html#l00193">193</a> of file <a class="el" href="longnumber_8cpp-source.html">longnumber.cpp</a>.</p>
       
   193 
       
   194 </div>
       
   195 </div><p>
       
   196 <a class="anchor" name="a7b7c59251aa6d2ffc25f0ec9312b59d"></a><!-- doxytag: member="CLongNumber::InitializeIter" ref="a7b7c59251aa6d2ffc25f0ec9312b59d" args="()" -->
       
   197 <div class="memitem">
       
   198 <div class="memproto">
       
   199       <table class="memname">
       
   200         <tr>
       
   201           <td class="memname">void CLongNumber::InitializeIter           </td>
       
   202           <td>(</td>
       
   203           <td class="paramname">          </td>
       
   204           <td>&nbsp;)&nbsp;</td>
       
   205           <td width="100%"></td>
       
   206         </tr>
       
   207       </table>
       
   208 </div>
       
   209 <div class="memdoc">
       
   210 
       
   211 <p>
       
   212 Sets the iterator to the first element of the list. 
       
   213 <p>Definition at line <a class="el" href="longnumber_8cpp-source.html#l00221">221</a> of file <a class="el" href="longnumber_8cpp-source.html">longnumber.cpp</a>.</p>
       
   214 
       
   215 </div>
       
   216 </div><p>
       
   217 <a class="anchor" name="5ef806e05880bcf07c0506bd36beefe0"></a><!-- doxytag: member="CLongNumber::GetNumber" ref="5ef806e05880bcf07c0506bd36beefe0" args="(TInt &amp;aValue)" -->
       
   218 <div class="memitem">
       
   219 <div class="memproto">
       
   220       <table class="memname">
       
   221         <tr>
       
   222           <td class="memname">TBool CLongNumber::GetNumber           </td>
       
   223           <td>(</td>
       
   224           <td class="paramtype">TInt &amp;&nbsp;</td>
       
   225           <td class="paramname"> <em>aValue</em>          </td>
       
   226           <td>&nbsp;)&nbsp;</td>
       
   227           <td width="100%"></td>
       
   228         </tr>
       
   229       </table>
       
   230 </div>
       
   231 <div class="memdoc">
       
   232 
       
   233 <p>
       
   234 Gets the integer number of the <a class="el" href="class_t_digit.html">TDigit</a> node, which is pointed to by the iterator. <dl compact><dt><b>Parameters:</b></dt><dd>
       
   235   <table border="0" cellspacing="2" cellpadding="0">
       
   236     <tr><td valign="top"></td><td valign="top"><em>aValue</em>&nbsp;</td><td>The reference to an integer. On return, this stores the value of the digit. </td></tr>
       
   237   </table>
       
   238 </dl>
       
   239 <dl class="return" compact><dt><b>Returns:</b></dt><dd>EFalse if the iterator has reached the end of the list, else ETrue. </dd></dl>
       
   240 
       
   241 <p>Definition at line <a class="el" href="longnumber_8cpp-source.html#l00232">232</a> of file <a class="el" href="longnumber_8cpp-source.html">longnumber.cpp</a>.</p>
       
   242 
       
   243 </div>
       
   244 </div><p>
       
   245 <a class="anchor" name="e717f76bb1203c1c495b5e37fa4d8ff9"></a><!-- doxytag: member="CLongNumber::Slide" ref="e717f76bb1203c1c495b5e37fa4d8ff9" args="()" -->
       
   246 <div class="memitem">
       
   247 <div class="memproto">
       
   248       <table class="memname">
       
   249         <tr>
       
   250           <td class="memname">TBool CLongNumber::Slide           </td>
       
   251           <td>(</td>
       
   252           <td class="paramname">          </td>
       
   253           <td>&nbsp;)&nbsp;</td>
       
   254           <td width="100%"></td>
       
   255         </tr>
       
   256       </table>
       
   257 </div>
       
   258 <div class="memdoc">
       
   259 
       
   260 <p>
       
   261 Moves the iterator to the next node of the list. <dl class="return" compact><dt><b>Returns:</b></dt><dd>EFalse, if the iterator has reached the end of the list, else ETrue. </dd></dl>
       
   262 
       
   263 <p>Definition at line <a class="el" href="longnumber_8cpp-source.html#l00248">248</a> of file <a class="el" href="longnumber_8cpp-source.html">longnumber.cpp</a>.</p>
       
   264 
       
   265 </div>
       
   266 </div><p>
       
   267 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:06 2010 for TB10.1 Example Applications by&nbsp;
       
   268 <a href="http://www.doxygen.org/index.html">
       
   269 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
       
   270 </body>
       
   271 </html>