Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_base_menu_async.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_base_menu_async.html Fri Jan 22 18:26:19 2010 +0000
@@ -0,0 +1,352 @@
+<!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: CBaseMenuAsync 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>CBaseMenuAsync Class Reference</h1><!-- doxytag: class="CBaseMenuAsync" --><!-- doxytag: inherits="MExecAsync" --><div class="dynheader">
+Inheritance diagram for CBaseMenuAsync:</div>
+<div class="dynsection">
+
+<p><center><img src="class_c_base_menu_async.png" usemap="#CBaseMenuAsync_map" border="0" alt=""></center>
+<map name="CBaseMenuAsync_map">
+<area href="class_m_exec_async.html" alt="MExecAsync" shape="rect" coords="317,56,434,80">
+<area href="class_m_exec_controller.html" alt="MExecController" shape="rect" coords="317,0,434,24">
+<area href="class_c_main_menu.html" alt="CMainMenu" shape="rect" coords="0,168,117,192">
+<area href="class_c_main_menu.html" alt="CMainMenu" shape="rect" coords="127,168,244,192">
+<area href="class_c_main_menu.html" alt="CMainMenu" shape="rect" coords="254,168,371,192">
+<area href="class_c_main_menu.html" alt="CMainMenu" shape="rect" coords="381,168,498,192">
+<area href="class_c_main_menu.html" alt="CMainMenu" shape="rect" coords="508,168,625,192">
+<area href="class_c_main_menu.html" alt="CMainMenu" shape="rect" coords="635,168,752,192">
+</map>
+</div>
+
+<p>
+<a href="class_c_base_menu_async-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_base_menu_async.html#6d8986b4a4afdf12be0f5f3748f1c61e">Start</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_base_menu_async.html#3fac170d8c1ca25c8b7fc38a571518f5">CompleteOwnRequest</a> (TInt aErr)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#61768023f417abf53797f5b9dab7119a">PostOwnRequest</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#2db995cefc1c45f18cb2fa10bf9d1a48">Terminate</a> ()</td></tr>
+
+<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#1dc404b23cd43c158faca4d15c6d653d">CBaseMenuAsync</a> (CConsoleBase &aConsole)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#ada4d420e51e821254a5246ae4012cb8">GetInput</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">CTelephony * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#5791cf54d7993943f2a5b063e5cd2483">GetTelObj</a> () const </td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">CConsoleBase * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#c6eb076d62ec6beaee688a25d7fb4f83">GConsole</a> () const </td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb045609330c866a5204dfd00fa3ad51"></a><!-- doxytag: member="CBaseMenuAsync::DoCancel" ref="eb045609330c866a5204dfd00fa3ad51" args="()=0" -->
+virtual void </td><td class="memItemRight" valign="bottom"><b>DoCancel</b> ()=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#f5592826e38a094a099bc8d8f317a9c7">ConstructL</a> ()</td></tr>
+
+<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">TState </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#22833931dad95ad360390ebd990f9015">iState</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">CTelephony * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#04349c8eb16bed8b19be8ca3c5a829ce">iTelephony</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap 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#6bfb6f0e05a99a7371048f641f90ca88">iLastOperation</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">CConsoleBase * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_async.html#675a3d53fde921b957f88e6c2694b99e">iConsole</a></td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Base Class providing functionality for and control of Etel 3rd Party Instances. Also controls user input and handles displaying information to the user.
+<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" name="1dc404b23cd43c158faca4d15c6d653d"></a><!-- doxytag: member="CBaseMenuAsync::CBaseMenuAsync" ref="1dc404b23cd43c158faca4d15c6d653d" 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 width="100%"><code> [protected]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Constructor.<p>
+<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>Reference to console object to which output will be displayed </td></tr>
+ </table>
+</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><p>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="6d8986b4a4afdf12be0f5f3748f1c61e"></a><!-- doxytag: member="CBaseMenuAsync::Start" ref="6d8986b4a4afdf12be0f5f3748f1c61e" 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 width="100%"></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>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><p>
+<a class="anchor" name="3fac170d8c1ca25c8b7fc38a571518f5"></a><!-- doxytag: member="CBaseMenuAsync::CompleteOwnRequest" ref="3fac170d8c1ca25c8b7fc38a571518f5" 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 width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Completes a request so that the RunL() code of the active object is executed.<p>
+<dl compact><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>
+</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><p>
+<a class="anchor" name="61768023f417abf53797f5b9dab7119a"></a><!-- doxytag: member="CBaseMenuAsync::PostOwnRequest" ref="61768023f417abf53797f5b9dab7119a" 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 width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Sets its own status to KRequestPending.
+<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><p>
+<a class="anchor" name="2db995cefc1c45f18cb2fa10bf9d1a48"></a><!-- doxytag: member="CBaseMenuAsync::Terminate" ref="2db995cefc1c45f18cb2fa10bf9d1a48" 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 width="100%"><code> [virtual]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Ends execution of the active object.
+<p>Implements <a class="el" href="class_m_exec_controller.html#2a5e16cb8fd3d95b81b1a894c6fe48d6">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><p>
+<a class="anchor" name="ada4d420e51e821254a5246ae4012cb8"></a><!-- doxytag: member="CBaseMenuAsync::GetInput" ref="ada4d420e51e821254a5246ae4012cb8" 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 width="100%"><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>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><p>
+<a class="anchor" name="5791cf54d7993943f2a5b063e5cd2483"></a><!-- doxytag: member="CBaseMenuAsync::GetTelObj" ref="5791cf54d7993943f2a5b063e5cd2483" 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 width="100%"> 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" compact><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#679d2e36ae9e07415cbdcfb63b4c6f42">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><p>
+<a class="anchor" name="c6eb076d62ec6beaee688a25d7fb4f83"></a><!-- doxytag: member="CBaseMenuAsync::GConsole" ref="c6eb076d62ec6beaee688a25d7fb4f83" 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 width="100%"> 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" compact><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#c86eecb3d6f41aa1469a455cd8f4816b">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><p>
+<a class="anchor" name="f5592826e38a094a099bc8d8f317a9c7"></a><!-- doxytag: member="CBaseMenuAsync::ConstructL" ref="f5592826e38a094a099bc8d8f317a9c7" 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 width="100%"><code> [protected]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Second phase constructor.
+<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><p>
+<hr><h2>Member Data Documentation</h2>
+<a class="anchor" name="22833931dad95ad360390ebd990f9015"></a><!-- doxytag: member="CBaseMenuAsync::iState" ref="22833931dad95ad360390ebd990f9015" 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#22833931dad95ad360390ebd990f9015">CBaseMenuAsync::iState</a><code> [protected]</code> </td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+The current operating state of the active object.
+<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><p>
+<a class="anchor" name="04349c8eb16bed8b19be8ca3c5a829ce"></a><!-- doxytag: member="CBaseMenuAsync::iTelephony" ref="04349c8eb16bed8b19be8ca3c5a829ce" 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#04349c8eb16bed8b19be8ca3c5a829ce">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>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><p>
+<a class="anchor" name="6bfb6f0e05a99a7371048f641f90ca88"></a><!-- doxytag: member="CBaseMenuAsync::iLastOperation" ref="6bfb6f0e05a99a7371048f641f90ca88" 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#6bfb6f0e05a99a7371048f641f90ca88">CBaseMenuAsync::iLastOperation</a><code> [protected]</code> </td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Active object to perform next operations on.
+<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><p>
+<a class="anchor" name="675a3d53fde921b957f88e6c2694b99e"></a><!-- doxytag: member="CBaseMenuAsync::iConsole" ref="675a3d53fde921b957f88e6c2694b99e" 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#675a3d53fde921b957f88e6c2694b99e">CBaseMenuAsync::iConsole</a><code> [protected]</code> </td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Console instance.
+<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><p>
+<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:03 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>