Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_long_number.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: CLongNumber Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>CLongNumber Class Reference</h1><!-- doxytag: class="CLongNumber" -->
<p>
<a href="class_c_long_number-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#1b7d3d5b97621f32d776d9b1a0d19d8a">RunL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#7039dbe9ebbf42b59f919ba2755dd8a3">DoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#1c0ebc1c9dbcc9c34250ffef859b8a2f">AddToScheduler</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#1b5d110a5df39ccfeda083160370dc5c">ReadNumber</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#2112ad5c07adc10adf5d63c33ef2d5cd">~CLongNumber</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#ec695d1da24cd27f36fed7c4f0ffe0a6">PrintNumber</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#a7b7c59251aa6d2ffc25f0ec9312b59d">InitializeIter</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#5ef806e05880bcf07c0506bd36beefe0">GetNumber</a> (TInt &aValue)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#e717f76bb1203c1c495b5e37fa4d8ff9">Slide</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_long_number.html">CLongNumber</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_long_number.html#a6cb04e2afa3b0948941ab4910739331">NewL</a> (CConsoleBase *aConsole)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
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>
<li>edit the linked list</li><li>traverse the linked list using an iterator </li></ul>
<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>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="2112ad5c07adc10adf5d63c33ef2d5cd"></a><!-- doxytag: member="CLongNumber::~CLongNumber" ref="2112ad5c07adc10adf5d63c33ef2d5cd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CLongNumber::~CLongNumber </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
<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>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a6cb04e2afa3b0948941ab4910739331"></a><!-- doxytag: member="CLongNumber::NewL" ref="a6cb04e2afa3b0948941ab4910739331" args="(CConsoleBase *aConsole)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_long_number.html">CLongNumber</a> * CLongNumber::NewL </td>
<td>(</td>
<td class="paramtype">CConsoleBase * </td>
<td class="paramname"> <em>aConsole</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aConsole</em> </td><td>The user console. </td></tr>
</table>
</dl>
<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>
<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>
</div>
</div><p>
<a class="anchor" name="1b7d3d5b97621f32d776d9b1a0d19d8a"></a><!-- doxytag: member="CLongNumber::RunL" ref="1b7d3d5b97621f32d776d9b1a0d19d8a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLongNumber::RunL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Handles the key-press events for this active object.
<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>
</div>
</div><p>
<a class="anchor" name="7039dbe9ebbf42b59f919ba2755dd8a3"></a><!-- doxytag: member="CLongNumber::DoCancel" ref="7039dbe9ebbf42b59f919ba2755dd8a3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLongNumber::DoCancel </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cancel any outstanding request.
<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>
</div>
</div><p>
<a class="anchor" name="1c0ebc1c9dbcc9c34250ffef859b8a2f"></a><!-- doxytag: member="CLongNumber::AddToScheduler" ref="1c0ebc1c9dbcc9c34250ffef859b8a2f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLongNumber::AddToScheduler </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds this active object to the active scheduler
<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>
</div>
</div><p>
<a class="anchor" name="1b5d110a5df39ccfeda083160370dc5c"></a><!-- doxytag: member="CLongNumber::ReadNumber" ref="1b5d110a5df39ccfeda083160370dc5c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLongNumber::ReadNumber </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads a number from the console.
<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>
</div>
</div><p>
<a class="anchor" name="ec695d1da24cd27f36fed7c4f0ffe0a6"></a><!-- doxytag: member="CLongNumber::PrintNumber" ref="ec695d1da24cd27f36fed7c4f0ffe0a6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLongNumber::PrintNumber </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Prints the number.
<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>
</div>
</div><p>
<a class="anchor" name="a7b7c59251aa6d2ffc25f0ec9312b59d"></a><!-- doxytag: member="CLongNumber::InitializeIter" ref="a7b7c59251aa6d2ffc25f0ec9312b59d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLongNumber::InitializeIter </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the iterator to the first element of the list.
<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>
</div>
</div><p>
<a class="anchor" name="5ef806e05880bcf07c0506bd36beefe0"></a><!-- doxytag: member="CLongNumber::GetNumber" ref="5ef806e05880bcf07c0506bd36beefe0" args="(TInt &aValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CLongNumber::GetNumber </td>
<td>(</td>
<td class="paramtype">TInt & </td>
<td class="paramname"> <em>aValue</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aValue</em> </td><td>The reference to an integer. On return, this stores the value of the digit. </td></tr>
</table>
</dl>
<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>
<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>
</div>
</div><p>
<a class="anchor" name="e717f76bb1203c1c495b5e37fa4d8ff9"></a><!-- doxytag: member="CLongNumber::Slide" ref="e717f76bb1203c1c495b5e37fa4d8ff9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CLongNumber::Slide </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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>
<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>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:06 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>