Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_base_menu_sync.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: CBaseMenuSync 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>CBaseMenuSync Class Reference</h1><!-- doxytag: class="CBaseMenuSync" --><!-- doxytag: inherits="MExecSync" -->
<p>Inherits <a class="el" href="class_m_exec_sync.html">MExecSync</a>.</p>
<p>Inherited by <a class="el" href="class_c_main_menu.html">CMainMenu</a>.</p>
<p><a href="class_c_base_menu_sync-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_sync.html#a99652e2a7de6e4968bea7648dcdd5a31">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_sync.html#aa55e8f30a79c64e6e01282609cd178dd">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_sync.html#abbf13a2a976e8fcd6ddfbcd8dad13808">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_sync.html#a4a298d972f834e087aaaf4d7911eafc7">ExecComplete</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_sync.html#afb83228dd12054790cbf34be3f37a1bb">Terminate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_base_menu_sync.html#abfba0dc4636709f1c4015f577c6b7f7e">~CBaseMenuSync</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_sync.html#a3fb7f70747a648e0a2c8bfbdd55ef300">CBaseMenuSync</a> (CConsoleBase &aConsole)</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_sync.html#aaaa99c2f5c5a3a2a1758f5d0dde3f88c">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_sync.html#a165fab2c7b65d6b1865a77f77a98f201">GConsole</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1774efa5c622a00e0c2edacce8d56154"></a><!-- doxytag: member="CBaseMenuSync::DoCancel" ref="a1774efa5c622a00e0c2edacce8d56154" 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_sync.html#a97dbd941d3863cf33a612293936c5dc1">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_sync.html#a4f9dc7468d0fb82db904c84823d5a9b9">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_sync.html#ae150cff4d3081b2324031392c7bc6f8f">iTelephony</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_sync.html#a1970c379713310ac63c2a04104ca40af">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_sync_8h_source.html#l00029">29</a> of file <a class="el" href="_c_base_menu_sync_8h_source.html">CBaseMenuSync.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="abfba0dc4636709f1c4015f577c6b7f7e"></a><!-- doxytag: member="CBaseMenuSync::~CBaseMenuSync" ref="abfba0dc4636709f1c4015f577c6b7f7e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CBaseMenuSync::~CBaseMenuSync </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="_c_base_menu_sync_8cpp_source.html#l00092">92</a> of file <a class="el" href="_c_base_menu_sync_8cpp_source.html">CBaseMenuSync.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3fb7f70747a648e0a2c8bfbdd55ef300"></a><!-- doxytag: member="CBaseMenuSync::CBaseMenuSync" ref="a3fb7f70747a648e0a2c8bfbdd55ef300" args="(CConsoleBase &aConsole)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CBaseMenuSync::CBaseMenuSync </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_sync_8cpp_source.html#l00064">64</a> of file <a class="el" href="_c_base_menu_sync_8cpp_source.html">CBaseMenuSync.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a99652e2a7de6e4968bea7648dcdd5a31"></a><!-- doxytag: member="CBaseMenuSync::Start" ref="a99652e2a7de6e4968bea7648dcdd5a31" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuSync::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_sync_8cpp_source.html#l00035">35</a> of file <a class="el" href="_c_base_menu_sync_8cpp_source.html">CBaseMenuSync.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa55e8f30a79c64e6e01282609cd178dd"></a><!-- doxytag: member="CBaseMenuSync::CompleteOwnRequest" ref="aa55e8f30a79c64e6e01282609cd178dd" args="(TInt aErr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuSync::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_sync_8cpp_source.html#l00023">23</a> of file <a class="el" href="_c_base_menu_sync_8cpp_source.html">CBaseMenuSync.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abbf13a2a976e8fcd6ddfbcd8dad13808"></a><!-- doxytag: member="CBaseMenuSync::PostOwnRequest" ref="abbf13a2a976e8fcd6ddfbcd8dad13808" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuSync::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_sync_8cpp_source.html#l00045">45</a> of file <a class="el" href="_c_base_menu_sync_8cpp_source.html">CBaseMenuSync.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4a298d972f834e087aaaf4d7911eafc7"></a><!-- doxytag: member="CBaseMenuSync::ExecComplete" ref="a4a298d972f834e087aaaf4d7911eafc7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuSync::ExecComplete </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the active object state to active. </p>
<p>Implements <a class="el" href="class_m_exec_sync.html#a65d7ba87fb8fe5cd2abc7e4b3e998b44">MExecSync</a>.</p>
<p>Definition at line <a class="el" href="_c_base_menu_sync_8cpp_source.html#l00075">75</a> of file <a class="el" href="_c_base_menu_sync_8cpp_source.html">CBaseMenuSync.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afb83228dd12054790cbf34be3f37a1bb"></a><!-- doxytag: member="CBaseMenuSync::Terminate" ref="afb83228dd12054790cbf34be3f37a1bb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuSync::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_sync_8cpp_source.html#l00053">53</a> of file <a class="el" href="_c_base_menu_sync_8cpp_source.html">CBaseMenuSync.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaaa99c2f5c5a3a2a1758f5d0dde3f88c"></a><!-- doxytag: member="CBaseMenuSync::GetTelObj" ref="aaaa99c2f5c5a3a2a1758f5d0dde3f88c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTelephony * CBaseMenuSync::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_sync_8h_source.html#l00072">72</a> of file <a class="el" href="_c_base_menu_sync_8h_source.html">CBaseMenuSync.h</a>.</p>
</div>
</div>
<a class="anchor" id="a165fab2c7b65d6b1865a77f77a98f201"></a><!-- doxytag: member="CBaseMenuSync::GConsole" ref="a165fab2c7b65d6b1865a77f77a98f201" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CConsoleBase * CBaseMenuSync::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_sync_8h_source.html#l00082">82</a> of file <a class="el" href="_c_base_menu_sync_8h_source.html">CBaseMenuSync.h</a>.</p>
</div>
</div>
<a class="anchor" id="a97dbd941d3863cf33a612293936c5dc1"></a><!-- doxytag: member="CBaseMenuSync::ConstructL" ref="a97dbd941d3863cf33a612293936c5dc1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CBaseMenuSync::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_sync_8cpp_source.html#l00084">84</a> of file <a class="el" href="_c_base_menu_sync_8cpp_source.html">CBaseMenuSync.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a4f9dc7468d0fb82db904c84823d5a9b9"></a><!-- doxytag: member="CBaseMenuSync::iState" ref="a4f9dc7468d0fb82db904c84823d5a9b9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TState <a class="el" href="class_c_base_menu_sync.html#a4f9dc7468d0fb82db904c84823d5a9b9">CBaseMenuSync::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_sync_8h_source.html#l00054">54</a> of file <a class="el" href="_c_base_menu_sync_8h_source.html">CBaseMenuSync.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae150cff4d3081b2324031392c7bc6f8f"></a><!-- doxytag: member="CBaseMenuSync::iTelephony" ref="ae150cff4d3081b2324031392c7bc6f8f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTelephony* <a class="el" href="class_c_base_menu_sync.html#ae150cff4d3081b2324031392c7bc6f8f">CBaseMenuSync::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_sync_8h_source.html#l00059">59</a> of file <a class="el" href="_c_base_menu_sync_8h_source.html">CBaseMenuSync.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1970c379713310ac63c2a04104ca40af"></a><!-- doxytag: member="CBaseMenuSync::iConsole" ref="a1970c379713310ac63c2a04104ca40af" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CConsoleBase* <a class="el" href="class_c_base_menu_sync.html#a1970c379713310ac63c2a04104ca40af">CBaseMenuSync::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_sync_8h_source.html#l00063">63</a> of file <a class="el" href="_c_base_menu_sync_8h_source.html">CBaseMenuSync.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>