Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_c_i_s_v_a_p_i_base_8h_source.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
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: examples/Telephony/ETel3rdPartyExample/Shared/CISVAPIBase.h Source File</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 -->
<h1>examples/Telephony/ETel3rdPartyExample/Shared/CISVAPIBase.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of &quot;Eclipse Public License v1.0&quot;</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL &quot;http://www.eclipse.org/legal/epl-v10.html&quot;.</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">// CCISVAPIBase.h</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016 
<a name="l00017"></a>00017 
<a name="l00018"></a>00018 <span class="preprocessor">#ifndef __CISVAPIBASE_H__</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define __CISVAPIBASE_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;e32base.h&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;etel3rdparty.h&gt;</span>
<a name="l00023"></a>00023 
<a name="l00028"></a>00028 <span class="keyword">enum</span> TTelISVExampleType
<a name="l00029"></a>00029         {
<a name="l00030"></a>00030         KNotType = -1,
<a name="l00031"></a>00031         KPhoneId,
<a name="l00032"></a>00032         KSubscriberId,
<a name="l00033"></a>00033         KBatteryInfo,
<a name="l00034"></a>00034         KSignalInfo,
<a name="l00035"></a>00035         KGetIndicator,
<a name="l00036"></a>00036         KLockInfo,
<a name="l00037"></a>00037         KNetworkInfo,
<a name="l00038"></a>00038         KNetworkName,
<a name="l00039"></a>00039         KOperatorName,
<a name="l00040"></a>00040         KCallInfo,
<a name="l00041"></a>00041         KLineStatus,
<a name="l00042"></a>00042         KCallStatus,
<a name="l00043"></a>00043         KFlightModeInfo,
<a name="l00044"></a>00044         KNetworkRegInfo,
<a name="l00045"></a>00045         KAnswerIncomingCall,
<a name="l00046"></a>00046         KDialCall,
<a name="l00047"></a>00047         KDynamicCaps,
<a name="l00048"></a>00048         KHold,
<a name="l00049"></a>00049         KResume,
<a name="l00050"></a>00050         KSwap,
<a name="l00051"></a>00051         KSendDTMF,
<a name="l00052"></a>00052         KHangup,
<a name="l00053"></a>00053         KCallWaitingStatus,
<a name="l00054"></a>00054         KCallForwardingStatus,
<a name="l00055"></a>00055         KCallBarringStatus,
<a name="l00056"></a>00056         KIdentityServiceStatus
<a name="l00057"></a>00057         };
<a name="l00058"></a>00058 
<a name="l00062"></a>00062 <span class="keyword">enum</span> TState
<a name="l00063"></a>00063         {
<a name="l00064"></a>00064         EStart,
<a name="l00065"></a>00065         EEnd,
<a name="l00066"></a>00066         EDummyAnswer,
<a name="l00067"></a>00067 
<a name="l00068"></a>00068         EGetPhoneId,
<a name="l00069"></a>00069         EGetSubscriberId,
<a name="l00070"></a>00070         EGetCallInfo,
<a name="l00071"></a>00071         EGetBatteryInfo,
<a name="l00072"></a>00072         EGetIndicator,
<a name="l00073"></a>00073         EGetLockInfo,
<a name="l00074"></a>00074         EGetSignalInfo,
<a name="l00075"></a>00075         EGetNetworkInfo,
<a name="l00076"></a>00076         EGetNetworkName,
<a name="l00077"></a>00077         EGetOperatorName,
<a name="l00078"></a>00078 
<a name="l00079"></a>00079         EGetFlightModeInfo,
<a name="l00080"></a>00080         EGetNetworkRegStatus,
<a name="l00081"></a>00081 
<a name="l00082"></a>00082         EGetLineStatus,
<a name="l00083"></a>00083         EGetCallStatus,
<a name="l00084"></a>00084         EAnswerIncomingCall,
<a name="l00085"></a>00085         EDialCall,
<a name="l00086"></a>00086         EGetDynamicCaps,
<a name="l00087"></a>00087         EHold,
<a name="l00088"></a>00088         EResume,
<a name="l00089"></a>00089         ESwap,
<a name="l00090"></a>00090         ESendDTMF,
<a name="l00091"></a>00091         EHangup,
<a name="l00092"></a>00092 
<a name="l00093"></a>00093         ECallForwarding,
<a name="l00094"></a>00094         ECallWaiting,
<a name="l00095"></a>00095         ECallBarring,
<a name="l00096"></a>00096         EIdentityService,
<a name="l00097"></a>00097 
<a name="l00098"></a>00098         EWaitingForKeyPress,
<a name="l00099"></a>00099 
<a name="l00100"></a>00100         ESetNotifier
<a name="l00101"></a>00101         };
<a name="l00102"></a>00102 
<a name="l00107"></a><a class="code" href="class_m_exec_controller.html">00107</a> <span class="keyword">class </span><a class="code" href="class_m_exec_controller.html">MExecController</a>
<a name="l00108"></a>00108         {
<a name="l00109"></a>00109 <span class="keyword">public</span>:
<a name="l00114"></a>00114         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_m_exec_controller.html#a2a5e16cb8fd3d95b81b1a894c6fe48d6">Terminate</a>() = 0;
<a name="l00115"></a>00115 
<a name="l00122"></a>00122         <span class="keyword">virtual</span> CTelephony* <a class="code" href="class_m_exec_controller.html#a679d2e36ae9e07415cbdcfb63b4c6f42">GetTelObj</a>() <span class="keyword">const</span> = 0;
<a name="l00123"></a>00123 
<a name="l00130"></a>00130         <span class="keyword">virtual</span> CConsoleBase* <a class="code" href="class_m_exec_controller.html#ac86eecb3d6f41aa1469a455cd8f4816b">GConsole</a>() <span class="keyword">const</span> = 0;
<a name="l00131"></a>00131 
<a name="l00132"></a>00132         };
<a name="l00133"></a>00133 
<a name="l00138"></a><a class="code" href="class_c_i_s_v_a_p_i_base.html">00138</a> <span class="keyword">class </span><a class="code" href="class_c_i_s_v_a_p_i_base.html">CISVAPIBase</a> : <span class="keyword">public</span> CActive
<a name="l00139"></a>00139         {
<a name="l00140"></a>00140 
<a name="l00141"></a>00141 <span class="keyword">public</span>:
<a name="l00142"></a>00142         <a class="code" href="class_c_i_s_v_a_p_i_base.html#a1c0521545381a967a659fbc12505cf65">CISVAPIBase</a>(<a class="code" href="class_m_exec_controller.html">MExecController</a>* aController,
<a name="l00143"></a>00143                             TTelISVExampleType aExampleType);
<a name="l00144"></a>00144 
<a name="l00145"></a>00145         <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#ae582ca026eb25869ea1e130fe16d2e79">StartRequestL</a>();
<a name="l00146"></a>00146         <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#ae582ca026eb25869ea1e130fe16d2e79">StartRequestL</a>(CTelephony::TCallId aCallId);
<a name="l00147"></a>00147         <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#ae582ca026eb25869ea1e130fe16d2e79">StartRequestL</a>(CTelephony::TCallId aCallId1,
<a name="l00148"></a>00148                            CTelephony::TCallId aCallId2);
<a name="l00149"></a>00149         <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#ae582ca026eb25869ea1e130fe16d2e79">StartRequestL</a>(<span class="keyword">const</span> TDesC&amp; aTones);
<a name="l00150"></a>00150         <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#ab6f0b35112b18c2058f88ab35a9a68c7">RequestNotificationL</a>();
<a name="l00151"></a>00151         <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#ac5030ef71ea228e32977497e8c145073">AppTerminate</a>();
<a name="l00152"></a>00152 
<a name="l00153"></a>00153         <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#abd7ef59baf6d23725e9aed1044ddc9ef">RetrieveTelephonyObject</a>();
<a name="l00154"></a>00154         <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#a4b951da8ea644712b0e26fa662e04799">RetrieveConsole</a>();
<a name="l00155"></a>00155 
<a name="l00156"></a>00156         <span class="keyword">inline</span> TTelISVExampleType <a class="code" href="class_c_i_s_v_a_p_i_base.html#a5f58d0283c6a33fc1c446c5770584700">GetExampleType</a>() <span class="keyword">const</span>;
<a name="l00157"></a>00157 
<a name="l00158"></a>00158 <span class="keyword">protected</span>:
<a name="l00159"></a>00159         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#af5a272546d704790a27788fcd45598b5">DoStartRequestL</a>();
<a name="l00160"></a>00160         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#af5a272546d704790a27788fcd45598b5">DoStartRequestL</a>(CTelephony::TCallId aCallId);
<a name="l00161"></a>00161         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#af5a272546d704790a27788fcd45598b5">DoStartRequestL</a>(CTelephony::TCallId aCallId1,
<a name="l00162"></a>00162                                      CTelephony::TCallId aCallId2);
<a name="l00163"></a>00163         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#af5a272546d704790a27788fcd45598b5">DoStartRequestL</a>(<span class="keyword">const</span> TDesC&amp; aNumber);
<a name="l00164"></a>00164         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#a0c13d9526d07940b6c8f6504e6e2c559">DoRequestNotificationL</a>();
<a name="l00165"></a>00165 
<a name="l00166"></a>00166 <span class="keyword">protected</span>:
<a name="l00172"></a><a class="code" href="class_c_i_s_v_a_p_i_base.html#adf37ee8bacf55ee252621ea199b616ef">00172</a>         <a class="code" href="class_m_exec_controller.html">MExecController</a>* <a class="code" href="class_c_i_s_v_a_p_i_base.html#adf37ee8bacf55ee252621ea199b616ef">iController</a>;
<a name="l00177"></a><a class="code" href="class_c_i_s_v_a_p_i_base.html#a5f92cd8caaa13e65aef6d59ed79edc18">00177</a>         CTelephony* <a class="code" href="class_c_i_s_v_a_p_i_base.html#a5f92cd8caaa13e65aef6d59ed79edc18">iTelephony</a>;
<a name="l00182"></a><a class="code" href="class_c_i_s_v_a_p_i_base.html#ac2937d6d0ac82af3f3d148c0bbca726e">00182</a>         CConsoleBase* <a class="code" href="class_c_i_s_v_a_p_i_base.html#ac2937d6d0ac82af3f3d148c0bbca726e">iConsole</a>;
<a name="l00183"></a>00183 
<a name="l00184"></a>00184 <span class="keyword">private</span>:
<a name="l00189"></a>00189         <span class="keyword">const</span> TTelISVExampleType iExampleType;
<a name="l00190"></a>00190 
<a name="l00191"></a>00191         };
<a name="l00192"></a>00192 
<a name="l00199"></a><a class="code" href="class_c_i_s_v_a_p_i_base.html#a5f58d0283c6a33fc1c446c5770584700">00199</a> <span class="keyword">inline</span> TTelISVExampleType <a class="code" href="class_c_i_s_v_a_p_i_base.html#a5f58d0283c6a33fc1c446c5770584700">CISVAPIBase::GetExampleType</a>()<span class="keyword"> const</span>
<a name="l00200"></a>00200 <span class="keyword">        </span>{
<a name="l00201"></a>00201         <span class="keywordflow">return</span> iExampleType;
<a name="l00202"></a>00202         };
<a name="l00203"></a>00203 
<a name="l00209"></a><a class="code" href="class_c_i_s_v_a_p_i_base.html#abd7ef59baf6d23725e9aed1044ddc9ef">00209</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#abd7ef59baf6d23725e9aed1044ddc9ef">CISVAPIBase::RetrieveTelephonyObject</a>()
<a name="l00210"></a>00210         {
<a name="l00211"></a>00211         <a class="code" href="class_c_i_s_v_a_p_i_base.html#a5f92cd8caaa13e65aef6d59ed79edc18">iTelephony</a> = <a class="code" href="class_c_i_s_v_a_p_i_base.html#adf37ee8bacf55ee252621ea199b616ef">iController</a>-&gt;<a class="code" href="class_m_exec_controller.html#a679d2e36ae9e07415cbdcfb63b4c6f42">GetTelObj</a>();
<a name="l00212"></a>00212         }
<a name="l00213"></a>00213 
<a name="l00219"></a><a class="code" href="class_c_i_s_v_a_p_i_base.html#a4b951da8ea644712b0e26fa662e04799">00219</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_c_i_s_v_a_p_i_base.html#a4b951da8ea644712b0e26fa662e04799">CISVAPIBase::RetrieveConsole</a>()
<a name="l00220"></a>00220         {
<a name="l00221"></a>00221         <a class="code" href="class_c_i_s_v_a_p_i_base.html#ac2937d6d0ac82af3f3d148c0bbca726e">iConsole</a> = <a class="code" href="class_c_i_s_v_a_p_i_base.html#adf37ee8bacf55ee252621ea199b616ef">iController</a>-&gt;<a class="code" href="class_m_exec_controller.html#ac86eecb3d6f41aa1469a455cd8f4816b">GConsole</a>();
<a name="l00222"></a>00222         }
<a name="l00223"></a>00223 
<a name="l00224"></a>00224 
<a name="l00225"></a>00225 <span class="preprocessor">#endif // __CISVAPIBASE_H__</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>