Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_base_menu_async.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: CBaseMenuAsync Class Reference</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 -->
<div class="contents">
<h1>CBaseMenuAsync Class Reference</h1><!-- doxytag: class="CBaseMenuAsync" --><!-- doxytag: inherits="MExecAsync" -->
<p>Inherits <a class="el" href="class_m_exec_async.html">MExecAsync</a>.</p>
<p>Inherited by <a class="el" href="class_c_main_menu.html">CMainMenu</a>, <a class="el" href="class_c_main_menu.html">CMainMenu</a>, <a class="el" href="class_c_main_menu.html">CMainMenu</a>, <a class="el" href="class_c_main_menu.html">CMainMenu</a>, <a class="el" href="class_c_main_menu.html">CMainMenu</a>, and <a class="el" href="class_c_main_menu.html">CMainMenu</a>.</p>
<p><a href="class_c_base_menu_async-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#a6d8986b4a4afdf12be0f5f3748f1c61e">Start</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#a3fac170d8c1ca25c8b7fc38a571518f5">CompleteOwnRequest</a> (TInt aErr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#a61768023f417abf53797f5b9dab7119a">PostOwnRequest</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#a2db995cefc1c45f18cb2fa10bf9d1a48">Terminate</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#a1dc404b23cd43c158faca4d15c6d653d">CBaseMenuAsync</a> (CConsoleBase &aConsole)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#aada4d420e51e821254a5246ae4012cb8">GetInput</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CTelephony * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#a5791cf54d7993943f2a5b063e5cd2483">GetTelObj</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CConsoleBase * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#ac6eb076d62ec6beaee688a25d7fb4f83">GConsole</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb045609330c866a5204dfd00fa3ad51"></a><!-- doxytag: member="CBaseMenuAsync::DoCancel" ref="aeb045609330c866a5204dfd00fa3ad51" args="()=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>DoCancel</b> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#af5592826e38a094a099bc8d8f317a9c7">ConstructL</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TState </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#a22833931dad95ad360390ebd990f9015">iState</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CTelephony * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#a04349c8eb16bed8b19be8ca3c5a829ce">iTelephony</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_c_i_s_v_a_p_i_base.html">CISVAPIBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#a6bfb6f0e05a99a7371048f641f90ca88">iLastOperation</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CConsoleBase * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#a675a3d53fde921b957f88e6c2694b99e">iConsole</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Base Class providing functionality for and control of Etel 3rd Party Instances. Also controls user input and handles displaying information to the user. </p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8h_source.html#l00032">32</a> of file <a class="el" href="_c_base_menu_async_8h_source.html">CBaseMenuAsync.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1dc404b23cd43c158faca4d15c6d653d"></a><!-- doxytag: member="CBaseMenuAsync::CBaseMenuAsync" ref="a1dc404b23cd43c158faca4d15c6d653d" args="(CConsoleBase &aConsole)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CBaseMenuAsync::CBaseMenuAsync </td>
<td>(</td>
<td class="paramtype">CConsoleBase & </td>
<td class="paramname"> <em>aConsole</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor.</p>
<dl><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>Reference to console object to which output will be displayed </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_c_base_menu_async_8cpp_source.html#l00066">66</a> of file <a class="el" href="_c_base_menu_async_8cpp_source.html">CBaseMenuAsync.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6d8986b4a4afdf12be0f5f3748f1c61e"></a><!-- doxytag: member="CBaseMenuAsync::Start" ref="a6d8986b4a4afdf12be0f5f3748f1c61e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuAsync::Start </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts (this) active object making it active so it can take input and perform required functionality. </p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8cpp_source.html#l00036">36</a> of file <a class="el" href="_c_base_menu_async_8cpp_source.html">CBaseMenuAsync.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3fac170d8c1ca25c8b7fc38a571518f5"></a><!-- doxytag: member="CBaseMenuAsync::CompleteOwnRequest" ref="a3fac170d8c1ca25c8b7fc38a571518f5" args="(TInt aErr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuAsync::CompleteOwnRequest </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aErr</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Completes a request so that the RunL() code of the active object is executed.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aErr</em> </td><td>The error code to pass to User::RequestComplete(). </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_c_base_menu_async_8cpp_source.html#l00024">24</a> of file <a class="el" href="_c_base_menu_async_8cpp_source.html">CBaseMenuAsync.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a61768023f417abf53797f5b9dab7119a"></a><!-- doxytag: member="CBaseMenuAsync::PostOwnRequest" ref="a61768023f417abf53797f5b9dab7119a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuAsync::PostOwnRequest </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets its own status to KRequestPending. </p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8cpp_source.html#l00046">46</a> of file <a class="el" href="_c_base_menu_async_8cpp_source.html">CBaseMenuAsync.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2db995cefc1c45f18cb2fa10bf9d1a48"></a><!-- doxytag: member="CBaseMenuAsync::Terminate" ref="a2db995cefc1c45f18cb2fa10bf9d1a48" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuAsync::Terminate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Ends execution of the active object. </p>
<p>Implements <a class="el" href="class_m_exec_controller.html#a2a5e16cb8fd3d95b81b1a894c6fe48d6">MExecController</a>.</p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8cpp_source.html#l00054">54</a> of file <a class="el" href="_c_base_menu_async_8cpp_source.html">CBaseMenuAsync.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aada4d420e51e821254a5246ae4012cb8"></a><!-- doxytag: member="CBaseMenuAsync::GetInput" ref="aada4d420e51e821254a5246ae4012cb8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuAsync::GetInput </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Places a request for input to the console, reads the input character from the keypad (keyboard etc.) </p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8cpp_source.html#l00078">78</a> of file <a class="el" href="_c_base_menu_async_8cpp_source.html">CBaseMenuAsync.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5791cf54d7993943f2a5b063e5cd2483"></a><!-- doxytag: member="CBaseMenuAsync::GetTelObj" ref="a5791cf54d7993943f2a5b063e5cd2483" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTelephony * CBaseMenuAsync::GetTelObj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a pointer to object pointed to by iTelephony.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to CTelephony object used to make ETel ISV calls </dd></dl>
<p>Implements <a class="el" href="class_m_exec_controller.html#a679d2e36ae9e07415cbdcfb63b4c6f42">MExecController</a>.</p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8h_source.html#l00076">76</a> of file <a class="el" href="_c_base_menu_async_8h_source.html">CBaseMenuAsync.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac6eb076d62ec6beaee688a25d7fb4f83"></a><!-- doxytag: member="CBaseMenuAsync::GConsole" ref="ac6eb076d62ec6beaee688a25d7fb4f83" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CConsoleBase * CBaseMenuAsync::GConsole </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a pointer to object pointed to by iConsole.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to CConsoleBase object used to display output </dd></dl>
<p>Implements <a class="el" href="class_m_exec_controller.html#ac86eecb3d6f41aa1469a455cd8f4816b">MExecController</a>.</p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8h_source.html#l00086">86</a> of file <a class="el" href="_c_base_menu_async_8h_source.html">CBaseMenuAsync.h</a>.</p>
</div>
</div>
<a class="anchor" id="af5592826e38a094a099bc8d8f317a9c7"></a><!-- doxytag: member="CBaseMenuAsync::ConstructL" ref="af5592826e38a094a099bc8d8f317a9c7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuAsync::ConstructL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Second phase constructor. </p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8cpp_source.html#l00089">89</a> of file <a class="el" href="_c_base_menu_async_8cpp_source.html">CBaseMenuAsync.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a22833931dad95ad360390ebd990f9015"></a><!-- doxytag: member="CBaseMenuAsync::iState" ref="a22833931dad95ad360390ebd990f9015" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TState <a class="el" href="class_c_base_menu_async.html#a22833931dad95ad360390ebd990f9015">CBaseMenuAsync::iState</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The current operating state of the active object. </p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8h_source.html#l00055">55</a> of file <a class="el" href="_c_base_menu_async_8h_source.html">CBaseMenuAsync.h</a>.</p>
</div>
</div>
<a class="anchor" id="a04349c8eb16bed8b19be8ca3c5a829ce"></a><!-- doxytag: member="CBaseMenuAsync::iTelephony" ref="a04349c8eb16bed8b19be8ca3c5a829ce" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTelephony* <a class="el" href="class_c_base_menu_async.html#a04349c8eb16bed8b19be8ca3c5a829ce">CBaseMenuAsync::iTelephony</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>CTelephony Instance used by all member active objects to make calls to ETel ISV. </p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8h_source.html#l00060">60</a> of file <a class="el" href="_c_base_menu_async_8h_source.html">CBaseMenuAsync.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6bfb6f0e05a99a7371048f641f90ca88"></a><!-- doxytag: member="CBaseMenuAsync::iLastOperation" ref="a6bfb6f0e05a99a7371048f641f90ca88" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_i_s_v_a_p_i_base.html">CISVAPIBase</a>* <a class="el" href="class_c_base_menu_async.html#a6bfb6f0e05a99a7371048f641f90ca88">CBaseMenuAsync::iLastOperation</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Active object to perform next operations on. </p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8h_source.html#l00064">64</a> of file <a class="el" href="_c_base_menu_async_8h_source.html">CBaseMenuAsync.h</a>.</p>
</div>
</div>
<a class="anchor" id="a675a3d53fde921b957f88e6c2694b99e"></a><!-- doxytag: member="CBaseMenuAsync::iConsole" ref="a675a3d53fde921b957f88e6c2694b99e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CConsoleBase* <a class="el" href="class_c_base_menu_async.html#a675a3d53fde921b957f88e6c2694b99e">CBaseMenuAsync::iConsole</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Console instance. </p>
<p>Definition at line <a class="el" href="_c_base_menu_async_8h_source.html#l00068">68</a> of file <a class="el" href="_c_base_menu_async_8h_source.html">CBaseMenuAsync.h</a>.</p>
</div>
</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>