Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_direct_8h-source.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!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/Graphics/WS/Direct/Direct.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/Graphics/WS/Direct/Direct.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 "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">// Application framework classes for Direct Screen Area (DSA) API example</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef __DIRECT_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __DIRECT_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <coecntrl.h></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <coeccntx.h></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <coemain.h></span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="preprocessor">#include <eikappui.h></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <eikapp.h></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <eikdoc.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <uikon.hrh></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#include <direct.rsg></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "Direct.hrh"</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">const</span> TUid KUidExample = { 0xE8000054 };
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="class_c_direct_display_life.html">CDirectDisplayLife</a>;
<a name="l00035"></a>00035 <span class="keyword">class </span><a class="code" href="class_c_life_engine.html">CLifeEngine</a>;
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment">// View, a window containing a DSA</span>
<a name="l00038"></a>00038 <span class="keyword">class </span><a class="code" href="class_c_example_app_view.html">CExampleAppView</a> : <span class="keyword">public</span> CCoeControl
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a>00041 <span class="comment">// View state</span>
<a name="l00042"></a>00042 <span class="keyword">enum</span> {
<a name="l00043"></a><a class="code" href="class_c_example_app_view.html#00040a12eb52a7ba2cc5ea80e676170b65eaa5efccb864bc600943bb682c3f7a">00043</a> <a class="code" href="class_c_example_app_view.html#00040a12eb52a7ba2cc5ea80e676170b65eaa5efccb864bc600943bb682c3f7a">EDirectNotStarted</a>=0, <span class="comment">// DSA not used</span>
<a name="l00044"></a><a class="code" href="class_c_example_app_view.html#00040a12eb52a7ba2cc5ea80e676170b8b2eeda5e14c91dacbfa6a70eb0a91a3">00044</a> <a class="code" href="class_c_example_app_view.html#00040a12eb52a7ba2cc5ea80e676170b8b2eeda5e14c91dacbfa6a70eb0a91a3">EDirectStarted</a>, <span class="comment">// DSA in use</span>
<a name="l00045"></a><a class="code" href="class_c_example_app_view.html#00040a12eb52a7ba2cc5ea80e676170b633266899f12dcdaaf992fc6cfd43216">00045</a> <a class="code" href="class_c_example_app_view.html#00040a12eb52a7ba2cc5ea80e676170b633266899f12dcdaaf992fc6cfd43216">EDirectPaused</a> <span class="comment">// Use of DSA temporarily halted</span>
<a name="l00046"></a>00046 };
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keyword">public</span>:
<a name="l00049"></a>00049 <span class="comment">// Construction & destruction</span>
<a name="l00050"></a>00050 <a class="code" href="class_c_example_app_view.html#187bc221ae94a9461bb00530660a7feb">CExampleAppView</a>(<a class="code" href="class_c_life_engine.html">CLifeEngine</a>& aLifeEngine);
<a name="l00051"></a>00051 <a class="code" href="class_c_example_app_view.html#c78c771feb302e8d161572f7ec1a7bcd">~CExampleAppView</a>();
<a name="l00052"></a>00052 <span class="keywordtype">void</span> <a class="code" href="class_c_example_app_view.html#35add6fa9ced3ba37334889336e294ee">ConstructL</a>(<span class="keyword">const</span> TRect& aRect);
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="comment">// Start using the DSA</span>
<a name="l00055"></a>00055 <span class="keywordtype">void</span> <a class="code" href="class_c_example_app_view.html#479b5ab58c4bacde42cbeff660c929dc">StartDirectL</a>();
<a name="l00056"></a>00056 <span class="comment">// Pause use of the DSA</span>
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="class_c_example_app_view.html#b62c7800ab5e6f9bc34ae7d05d761a6e">PauseDirect</a>();
<a name="l00058"></a>00058 <span class="comment">// Restart use of the DSA after pausing</span>
<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="class_c_example_app_view.html#e59b69c1349cb34a77ddc8e20e81e17f">RestartDirect</a>();
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="comment">// Gets the view state</span>
<a name="l00062"></a>00062 TInt <a class="code" href="class_c_example_app_view.html#11519abd2e90045d161a6961f80f72a1">State</a>() <span class="keyword">const</span>;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="keyword">private</span>:
<a name="l00065"></a>00065 <span class="comment">// from CCoeControl</span>
<a name="l00066"></a>00066 <span class="keywordtype">void</span> Draw(<span class="keyword">const</span> TRect&) <span class="keyword">const</span>;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keyword">private</span>:
<a name="l00069"></a>00069 <span class="comment">// The object that handles the DSA</span>
<a name="l00070"></a>00070 <a class="code" href="class_c_direct_display_life.html">CDirectDisplayLife</a>* iDirectDisplayLife;
<a name="l00071"></a>00071 <span class="comment">// The data the view displays</span>
<a name="l00072"></a>00072 <a class="code" href="class_c_life_engine.html">CLifeEngine</a>& iLifeEngine;
<a name="l00073"></a>00073 <span class="comment">// View state</span>
<a name="l00074"></a>00074 TInt iState;
<a name="l00075"></a>00075 };
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">// App UI, handles user commands</span>
<a name="l00078"></a>00078 <span class="keyword">class </span><a class="code" href="class_c_example_app_ui.html">CExampleAppUi</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 <span class="comment">// Construction & destruction</span>
<a name="l00082"></a>00082 <span class="keywordtype">void</span> <a class="code" href="class_c_example_app_ui.html#c7d473f79f7509e283327e17c1078042">ConstructL</a>();
<a name="l00083"></a>00083 <a class="code" href="class_c_example_app_ui.html#8aaaf511fa76f36e9fed17b25bcc287f">~CExampleAppUi</a>();
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">private</span>:
<a name="l00086"></a>00086 <span class="comment">// from CEikAppUi</span>
<a name="l00087"></a>00087 <span class="keywordtype">void</span> HandleCommandL(TInt aCommand);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">private</span>:
<a name="l00090"></a>00090 <span class="keyword">class </span>COverlayDialog: <span class="keyword">public</span> CActive
<a name="l00091"></a>00091 {
<a name="l00092"></a>00092 <span class="keyword">public</span>:
<a name="l00093"></a>00093 COverlayDialog();
<a name="l00094"></a>00094 ~COverlayDialog();
<a name="l00095"></a>00095 <span class="keywordtype">void</span> ShowDialog();
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keyword">private</span>:
<a name="l00098"></a>00098 <span class="keywordtype">void</span> RunL();
<a name="l00099"></a>00099 <span class="keywordtype">void</span> DoCancel();
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="keyword">private</span>:
<a name="l00102"></a>00102 RNotifier iNotifier;
<a name="l00103"></a>00103 TInt iR;
<a name="l00104"></a>00104 };
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="keyword">private</span>:
<a name="l00107"></a>00107 <span class="comment">// The app view</span>
<a name="l00108"></a>00108 <a class="code" href="class_c_example_app_view.html">CExampleAppView</a>* iAppView;
<a name="l00109"></a>00109 COverlayDialog* iOverlayDialog;
<a name="l00110"></a>00110 };
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">// App document. Owns the engine.</span>
<a name="l00113"></a>00113 <span class="keyword">class </span><a class="code" href="class_c_example_document.html">CExampleDocument</a> : <span class="keyword">public</span> CEikDocument
<a name="l00114"></a>00114 {
<a name="l00115"></a>00115 <span class="keyword">public</span>:
<a name="l00116"></a>00116 <span class="comment">// Construction & destruction</span>
<a name="l00117"></a>00117 <a class="code" href="class_c_example_document.html#57c35ffe8a97fa1e9301c33b8f3735bc">CExampleDocument</a>(CEikApplication& aApp);
<a name="l00118"></a>00118 <a class="code" href="class_c_example_document.html#7aec1681b280f187290484d06b149e16">~CExampleDocument</a>();
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="comment">// Gets the engine</span>
<a name="l00121"></a>00121 <a class="code" href="class_c_life_engine.html">CLifeEngine</a>& <a class="code" href="class_c_example_document.html#59cddfe0a19f2915ecbc7d07c26cb6f6">LifeEngine</a>() <span class="keyword">const</span>;
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="keyword">private</span>:
<a name="l00124"></a>00124 <span class="comment">// from CEikDocument</span>
<a name="l00125"></a>00125 CEikAppUi* CreateAppUiL();
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keyword">private</span>:
<a name="l00128"></a>00128 <span class="comment">// The engine</span>
<a name="l00129"></a>00129 <a class="code" href="class_c_life_engine.html">CLifeEngine</a>* iLifeEngine;
<a name="l00130"></a>00130 };
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="comment">// Application class</span>
<a name="l00133"></a>00133 <span class="keyword">class </span><a class="code" href="class_c_example_application.html">CExampleApplication</a> : <span class="keyword">public</span> CEikApplication
<a name="l00134"></a>00134 {
<a name="l00135"></a>00135 <span class="keyword">private</span>: <span class="comment">// from CApaApplication</span>
<a name="l00136"></a>00136 CApaDocument* CreateDocumentL();
<a name="l00137"></a>00137 TUid AppDllUid() <span class="keyword">const</span>;
<a name="l00138"></a>00138 };
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:32:58 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>