Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_my_string_reverse.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: CMyStringReverse 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>CMyStringReverse Class Reference</h1><!-- doxytag: class="CMyStringReverse" -->
<p>
<a href="class_c_my_string_reverse-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_my_string_reverse.html#2d3f11cae95c95116bcd3ff89962f212">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_my_string_reverse.html#845aed5a330f05b110198d4ee45ab32d">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_my_string_reverse.html#2c4d6ff67407fcd776305acb55820750">AddToScheduler</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_my_string_reverse.html#1b0e1bef7e163fa3fc8f7e06047782ed">~CMyStringReverse</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_my_string_reverse.html#28aa61d2589697113937251c10747826">ReadOption</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_my_string_reverse.html#3df27149dbe0c55a7a6a7afdd0af43d6">ReadChar</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_my_string_reverse.html#c042ac03ee05e8410f080f2ee3b51f39">PrintStrings</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_my_string_reverse.html">CMyStringReverse</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_my_string_reverse.html#2ab3e8b199ce96ba6239d6af086c62a4">NewL</a> (CConsoleBase *aConsole)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class has the doubly linked list, iString. This string represents the user-entered string. The member functions of this class allow users to edit the string and get a reverse string of this string.
<p>Definition at line <a class="el" href="mystringreverse_8h-source.html#l00033">33</a> of file <a class="el" href="mystringreverse_8h-source.html">mystringreverse.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1b0e1bef7e163fa3fc8f7e06047782ed"></a><!-- doxytag: member="CMyStringReverse::~CMyStringReverse" ref="1b0e1bef7e163fa3fc8f7e06047782ed" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CMyStringReverse::~CMyStringReverse </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_letter.html">TLetter</a> objects were allocated memory at runtime. Iterate over the list to delete them.
<p>Definition at line <a class="el" href="mystringreverse_8cpp-source.html#l00236">236</a> of file <a class="el" href="mystringreverse_8cpp-source.html">mystringreverse.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2ab3e8b199ce96ba6239d6af086c62a4"></a><!-- doxytag: member="CMyStringReverse::NewL" ref="2ab3e8b199ce96ba6239d6af086c62a4" args="(CConsoleBase *aConsole)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_my_string_reverse.html">CMyStringReverse</a> * CMyStringReverse::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_my_string_reverse.html">CMyStringReverse</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>
<p>Definition at line <a class="el" href="mystringreverse_8cpp-source.html#l00028">28</a> of file <a class="el" href="mystringreverse_8cpp-source.html">mystringreverse.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="2d3f11cae95c95116bcd3ff89962f212"></a><!-- doxytag: member="CMyStringReverse::RunL" ref="2d3f11cae95c95116bcd3ff89962f212" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMyStringReverse::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. The following actions are defined for a key press event:<ul>
<li>Call the iString.AddFirst() function if '1' is pressed.</li><li>Call the iString.AddLast() function if '2' is pressed.</li><li>Stop the active scheduler if any other number keys are pressed.</li><li>Add the character to iString if any alphabetic keys are pressed depending on the previous numeric key press. </li></ul>
<p>Definition at line <a class="el" href="mystringreverse_8cpp-source.html#l00067">67</a> of file <a class="el" href="mystringreverse_8cpp-source.html">mystringreverse.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="845aed5a330f05b110198d4ee45ab32d"></a><!-- doxytag: member="CMyStringReverse::DoCancel" ref="845aed5a330f05b110198d4ee45ab32d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMyStringReverse::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="mystringreverse_8cpp-source.html#l00222">222</a> of file <a class="el" href="mystringreverse_8cpp-source.html">mystringreverse.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="2c4d6ff67407fcd776305acb55820750"></a><!-- doxytag: member="CMyStringReverse::AddToScheduler" ref="2c4d6ff67407fcd776305acb55820750" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMyStringReverse::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="mystringreverse_8cpp-source.html#l00038">38</a> of file <a class="el" href="mystringreverse_8cpp-source.html">mystringreverse.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="28aa61d2589697113937251c10747826"></a><!-- doxytag: member="CMyStringReverse::ReadOption" ref="28aa61d2589697113937251c10747826" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMyStringReverse::ReadOption </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads the option entered by the user.
<p>Definition at line <a class="el" href="mystringreverse_8cpp-source.html#l00158">158</a> of file <a class="el" href="mystringreverse_8cpp-source.html">mystringreverse.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="3df27149dbe0c55a7a6a7afdd0af43d6"></a><!-- doxytag: member="CMyStringReverse::ReadChar" ref="3df27149dbe0c55a7a6a7afdd0af43d6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMyStringReverse::ReadChar </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads the character entered by the user.
<p>Definition at line <a class="el" href="mystringreverse_8cpp-source.html#l00170">170</a> of file <a class="el" href="mystringreverse_8cpp-source.html">mystringreverse.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="c042ac03ee05e8410f080f2ee3b51f39"></a><!-- doxytag: member="CMyStringReverse::PrintStrings" ref="c042ac03ee05e8410f080f2ee3b51f39" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMyStringReverse::PrintStrings </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Prints the data in iString and iReverseString.
<p>Definition at line <a class="el" href="mystringreverse_8cpp-source.html#l00181">181</a> of file <a class="el" href="mystringreverse_8cpp-source.html">mystringreverse.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:07 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>