Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_eikecho_8h-source.html
author Dominic Pinkman <Dominic.Pinkman@Nokia.com>
Tue, 30 Mar 2010 11:42:04 +0100
changeset 4 4816d766a08a
parent 1 25a17d01db0c
permissions -rw-r--r--
Week 12 contribution of SDK documentation_content. See release notes for details. Fixes Bug 1892, Bug 1522, Bug 1520, Bug 394, Bug 1319, Bug 344, Bug 1897

<!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: examples/Networking/TcpIp/EchoClientUI/Eikecho.h Source File</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>examples/Networking/TcpIp/EchoClientUI/Eikecho.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 1997-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 "Eclipse Public License v1.0"</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 "http://www.eclipse.org/legal/epl-v10.html".</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">// Header file for EIKON interface to ECHOENG</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016 
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;basched.h&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;eikenv.h&gt;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;coecntrl.h&gt;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;eikappui.h&gt;</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;e32keys.h&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;eikconso.h&gt;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;eikapp.h&gt;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;eikdoc.h&gt;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;eikon.rsg&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;eikinfo.h&gt;</span>
<a name="l00027"></a>00027 <span class="comment">//#include &lt;eikcmds.hrh&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;eikon.hrh&gt;</span><span class="comment">//newly added</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;eikecho.rsg&gt;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "ECHOENG.H"</span>
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="preprocessor">#ifndef _EIKECHO_H_</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define _EIKECHO_H_</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="keyword">const</span> TUid KUidEikEchoApp = {0xE800006A};
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 <span class="comment">// Connection values: substitute alternative values for KInetAddr</span>
<a name="l00040"></a>00040 <span class="comment">// and KInetHostName if you want to use different servers</span>
<a name="l00041"></a>00041 <span class="keyword">const</span> TUint32 KInetAddr = INET_ADDR(10,159,34,198);<span class="comment">//(193,63,255,1); //</span>
<a name="l00042"></a>00042 _LIT(KInetHostName,<span class="stringliteral">"phoenix.doc.ic.ac.uk"</span>);
<a name="l00043"></a>00043 
<a name="l00044"></a>00044 <span class="comment">// Integer formatting descriptor</span>
<a name="l00045"></a>00045 _LIT(KIntFormat,<span class="stringliteral">"%d"</span>);
<a name="l00046"></a>00046 
<a name="l00047"></a>00047 
<a name="l00048"></a>00048 <span class="comment">//</span>
<a name="l00049"></a>00049 <span class="comment">// CConsoleControl: console-type control</span>
<a name="l00050"></a>00050 <span class="comment">//</span>
<a name="l00051"></a>00051 
<a name="l00052"></a>00052 <span class="keyword">class </span><a class="code" href="class_c_console_control.html">CConsoleControl</a> : <span class="keyword">public</span> CCoeControl, <span class="keyword">public</span> <a class="code" href="class_m_u_i_notify.html">MUINotify</a>
<a name="l00053"></a>00053         {
<a name="l00054"></a>00054 <span class="keyword">public</span>:
<a name="l00055"></a>00055         <span class="keyword">static</span> <a class="code" href="class_c_console_control.html">CConsoleControl</a>* <a class="code" href="class_c_console_control.html#7882b336d8cca24f12beec79e1e3b07b">NewL</a>(<a class="code" href="class_c_echo_engine.html">CEchoEngine</a>* aEchoEngine);
<a name="l00056"></a>00056         <a class="code" href="class_c_console_control.html#fcc2f7d89a4e264eeb7ebbbdd7847b64">~CConsoleControl</a>();
<a name="l00057"></a>00057         <span class="keywordtype">void</span> <a class="code" href="class_c_console_control.html#1d0deb7a7e74ef98b91bd6998109558f">ConstructL</a>(<a class="code" href="class_c_echo_engine.html">CEchoEngine</a>* aEchoEngine);
<a name="l00058"></a>00058 
<a name="l00059"></a>00059         <span class="comment">// Override CCoeControl</span>
<a name="l00060"></a>00060     TKeyResponse <a class="code" href="class_c_console_control.html#1cf39ddc8fb7d49bc16d3334d45ce39c">OfferKeyEventL</a>(<span class="keyword">const</span> TKeyEvent&amp; aKeyEvent,TEventCode aType);
<a name="l00061"></a>00061     <span class="keywordtype">void</span> <a class="code" href="class_c_console_control.html#0a03a5108e06a2a94c37c256f49c71b0">ActivateL</a>();
<a name="l00062"></a>00062 
<a name="l00063"></a>00063         <span class="comment">//Implement MUINotify up calls</span>
<a name="l00064"></a>00064         <span class="keywordtype">void</span> <a class="code" href="class_c_console_control.html#5c8449fbaaf655fb67e5faa6e3498e4a">PrintNotify</a>(<span class="keyword">const</span> TDesC&amp; aDes);
<a name="l00065"></a>00065         <span class="keywordtype">void</span> <a class="code" href="class_c_console_control.html#5c8449fbaaf655fb67e5faa6e3498e4a">PrintNotify</a>(TInt aInt);
<a name="l00066"></a>00066         <span class="keywordtype">void</span> <a class="code" href="class_c_console_control.html#3ac7c903e2f64ad7bcb00bd8af5b8513">ErrorNotifyL</a>(<span class="keyword">const</span> TDesC&amp; aErrMessage, TInt aErrCode);
<a name="l00067"></a>00067 <span class="keyword">protected</span>:
<a name="l00068"></a><a class="code" href="class_c_console_control.html#608da2fc209359390bcfb962cf9b7803">00068</a>         <a class="code" href="class_c_console_control.html#608da2fc209359390bcfb962cf9b7803">CConsoleControl</a>() {}
<a name="l00069"></a>00069 <span class="keyword">private</span>:
<a name="l00070"></a>00070         CEikConsoleScreen* iConsole;    <span class="comment">// Standard EIKON console control</span>
<a name="l00071"></a>00071         <a class="code" href="class_c_echo_engine.html">CEchoEngine</a>* iEchoEngine;               <span class="comment">// The echo engine</span>
<a name="l00072"></a>00072         };
<a name="l00073"></a>00073 
<a name="l00074"></a>00074 <span class="comment">//</span>
<a name="l00075"></a>00075 <span class="comment">// CEchoAppUi: user interface command handling</span>
<a name="l00076"></a>00076 <span class="comment">//</span>
<a name="l00077"></a>00077 
<a name="l00078"></a><a class="code" href="class_c_echo_app_ui.html">00078</a> <span class="keyword">class </span><a class="code" href="class_c_echo_app_ui.html">CEchoAppUi</a> : <span class="keyword">public</span> CEikAppUi
<a name="l00079"></a>00079     {
<a name="l00080"></a>00080 <span class="keyword">public</span>:
<a name="l00081"></a>00081         <a class="code" href="class_c_echo_app_ui.html#5325c8ff27b2391bfa3891caee9de3da">CEchoAppUi</a>(<a class="code" href="class_c_echo_engine.html">CEchoEngine</a>* aEchoEngine);
<a name="l00082"></a>00082     <span class="keywordtype">void</span> <a class="code" href="class_c_echo_app_ui.html#6891cb1ec07c9eb5e0d6cec53a45ecee">ConstructL</a>();
<a name="l00083"></a>00083         <span class="keywordtype">void</span> <a class="code" href="class_c_echo_app_ui.html#875c67a7141f52a8ec35b7f14baff787">CreateConsoleL</a>();
<a name="l00084"></a>00084         <a class="code" href="class_c_echo_app_ui.html#6a1e075962f589f4106dbb532e30b744">~CEchoAppUi</a>();
<a name="l00085"></a>00085 <span class="keyword">private</span>:
<a name="l00086"></a>00086         <span class="comment">// Override CEikAppUi</span>
<a name="l00087"></a>00087     <span class="keywordtype">void</span> HandleCommandL(TInt aCommand);
<a name="l00088"></a>00088 <span class="keyword">private</span>:
<a name="l00089"></a>00089         <a class="code" href="class_c_console_control.html">CConsoleControl</a>* iConsoleControl;
<a name="l00090"></a>00090         <a class="code" href="class_c_echo_engine.html">CEchoEngine</a>* iEchoEngine;
<a name="l00091"></a>00091         };
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 <span class="comment">//</span>
<a name="l00094"></a>00094 <span class="comment">// CEchoDocument: document class, which owns the engine</span>
<a name="l00095"></a>00095 <span class="comment">//</span>
<a name="l00096"></a>00096 
<a name="l00097"></a><a class="code" href="class_c_echo_document.html">00097</a> <span class="keyword">class </span><a class="code" href="class_c_echo_document.html">CEchoDocument</a> : <span class="keyword">public</span> CEikDocument
<a name="l00098"></a>00098         {
<a name="l00099"></a>00099 <span class="keyword">public</span>:
<a name="l00100"></a>00100         <a class="code" href="class_c_echo_document.html#b1551c32f6dc7771e8c1ee97d9cb84e2">CEchoDocument</a>(CEikApplication&amp; aApp);
<a name="l00101"></a>00101         <span class="keyword">static</span> <a class="code" href="class_c_echo_document.html">CEchoDocument</a>* <a class="code" href="class_c_echo_document.html#5f307207d2491752969bc1611521195f">NewL</a>(CEikApplication&amp; aApp);
<a name="l00102"></a>00102         <a class="code" href="class_c_echo_document.html#75c0cad5acd6b414462a05f6f44bef11">~CEchoDocument</a>();
<a name="l00103"></a>00103         <span class="keywordtype">void</span> <a class="code" href="class_c_echo_document.html#e861dbc70fb00f49e1af38b12a9310df">ConstructL</a>();
<a name="l00104"></a>00104 <span class="keyword">private</span>:
<a name="l00105"></a>00105         <span class="comment">// Override CApaDocument</span>
<a name="l00106"></a>00106         CEikAppUi* CreateAppUiL();
<a name="l00107"></a>00107 <span class="keyword">private</span>:
<a name="l00108"></a>00108         <a class="code" href="class_c_echo_engine.html">CEchoEngine</a>* iEchoEngine; <span class="comment">// Document owns the echo engine</span>
<a name="l00109"></a>00109         };
<a name="l00110"></a>00110 
<a name="l00111"></a>00111 <span class="comment">//</span>
<a name="l00112"></a>00112 <span class="comment">// CEchoApplication</span>
<a name="l00113"></a>00113 <span class="comment">//</span>
<a name="l00114"></a>00114 
<a name="l00115"></a><a class="code" href="class_c_echo_application.html">00115</a> <span class="keyword">class </span><a class="code" href="class_c_echo_application.html">CEchoApplication</a> : <span class="keyword">public</span> CEikApplication
<a name="l00116"></a>00116         {
<a name="l00117"></a>00117 <span class="keyword">private</span>: <span class="comment">// from CApaApplication</span>
<a name="l00118"></a>00118         CApaDocument* CreateDocumentL();
<a name="l00119"></a>00119         TUid AppDllUid() <span class="keyword">const</span>;
<a name="l00120"></a>00120         };
<a name="l00121"></a>00121 <span class="preprocessor">#endif</span>
<a name="l00122"></a>00122 <span class="preprocessor"></span>
<a name="l00123"></a>00123 
<a name="l00124"></a>00124 
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:00 2010 for TB10.1 Example Applications by&nbsp;
<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>