Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_common_graphics_control_framework_8h_source.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_common_graphics_control_framework_8h_source.html Tue Mar 30 16:16:55 2010 +0100
@@ -0,0 +1,117 @@
+<!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/Graphics/CommonGraphicsExampleFiles/CommonGraphicsControlFramework.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/Graphics/CommonGraphicsExampleFiles/CommonGraphicsControlFramework.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2000-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">//</span>
+<a name="l00015"></a>00015
+<a name="l00016"></a>00016
+<a name="l00017"></a>00017 <span class="preprocessor">#ifndef __CommonGraphicsControlFramework_H</span>
+<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __CommonGraphicsControlFramework_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 <s32file.h></span>
+<a name="l00022"></a>00022
+<a name="l00023"></a>00023 <span class="comment">//</span>
+<a name="l00024"></a>00024 <span class="comment">// class MGraphicsExampleObserver</span>
+<a name="l00025"></a>00025 <span class="comment">//</span>
+<a name="l00026"></a>00026
+<a name="l00027"></a>00027 <span class="keyword">class </span><a class="code" href="class_m_graphics_example_observer.html">MGraphicsExampleObserver</a>
+<a name="l00028"></a>00028 {
+<a name="l00029"></a>00029 <span class="keyword">public</span>:
+<a name="l00030"></a>00030 <span class="keyword">virtual</span> <span class="keywordtype">void</span> NotifyGraphicExampleFinished()=0;
+<a name="l00031"></a>00031 <span class="keyword">virtual</span> <span class="keywordtype">void</span> NotifyStatus(<span class="keyword">const</span> TDesC& aMessage)=0;
+<a name="l00032"></a>00032 };
+<a name="l00033"></a>00033
+<a name="l00034"></a>00034 <span class="comment">//</span>
+<a name="l00035"></a>00035 <span class="comment">// class CGraphicExampleControl</span>
+<a name="l00036"></a>00036 <span class="comment">//</span>
+<a name="l00037"></a>00037
+<a name="l00038"></a>00038 <span class="comment">/*</span>
+<a name="l00039"></a>00039 <span class="comment"> Usage</span>
+<a name="l00040"></a>00040 <span class="comment"></span>
+<a name="l00041"></a>00041 <span class="comment"> Use this class as a base class for examples for the</span>
+<a name="l00042"></a>00042 <span class="comment"> graphics layer. It uses CONE's facilities to provide</span>
+<a name="l00043"></a>00043 <span class="comment"> an initailized graphics environment.</span>
+<a name="l00044"></a>00044 <span class="comment"></span>
+<a name="l00045"></a>00045 <span class="comment"> It creates a 600x200 window in which you can do your</span>
+<a name="l00046"></a>00046 <span class="comment"> drawing.</span>
+<a name="l00047"></a>00047 <span class="comment"></span>
+<a name="l00048"></a>00048 <span class="comment"> it supports multiple phases, so you can do different drawings</span>
+<a name="l00049"></a>00049 <span class="comment"> from one phase to another. Tap the spacebar or click the</span>
+<a name="l00050"></a>00050 <span class="comment"> mouse (anywhere) to advance a phase.</span>
+<a name="l00051"></a>00051 <span class="comment"></span>
+<a name="l00052"></a>00052 <span class="comment"> Quit the program with CTRL-Q, or by advancing beyond the last</span>
+<a name="l00053"></a>00053 <span class="comment"> phase.</span>
+<a name="l00054"></a>00054 <span class="comment"></span>
+<a name="l00055"></a>00055 <span class="comment"> Writing derived classes</span>
+<a name="l00056"></a>00056 <span class="comment"></span>
+<a name="l00057"></a>00057 <span class="comment"> A minimal derived class should have a Draw() function</span>
+<a name="l00058"></a>00058 <span class="comment"> which puts a drawing onto the screen.</span>
+<a name="l00059"></a>00059 <span class="comment"></span>
+<a name="l00060"></a>00060 <span class="comment"> If you are using multiplephases, code a constructor which</span>
+<a name="l00061"></a>00061 <span class="comment"> calls SetMaxPhases() specifying the number of phases. Have</span>
+<a name="l00062"></a>00062 <span class="comment"> Draw() honour the phase number, available using Phase().</span>
+<a name="l00063"></a>00063 <span class="comment">*/</span>
+<a name="l00064"></a>00064
+<a name="l00065"></a>00065 <span class="preprocessor">#pragma warning(disable : 4100)</span>
+<a name="l00066"></a>00066 <span class="preprocessor"></span> <span class="comment">// disable "parameter not used" warning on HandleKey()</span>
+<a name="l00067"></a>00067
+<a name="l00068"></a>00068 <span class="keyword">class </span><a class="code" href="class_c_graphic_example_control.html">CGraphicExampleControl</a> : <span class="keyword">public</span> CCoeControl
+<a name="l00069"></a>00069 {
+<a name="l00070"></a>00070 <span class="keyword">public</span>:
+<a name="l00071"></a>00071 <span class="comment">// construct/destruct</span>
+<a name="l00072"></a>00072 <span class="keywordtype">void</span> ConstructL(<span class="keyword">const</span> TRect& aRect, <a class="code" href="class_m_graphics_example_observer.html">MGraphicsExampleObserver</a>* aGraphObserver, <span class="keyword">const</span> CCoeControl& aParent);
+<a name="l00073"></a>00073 <span class="comment">// second-phase construction</span>
+<a name="l00074"></a>00074 <span class="comment">// when all initialized, calls GraphicTestEnvironmentComplete()</span>
+<a name="l00075"></a>00075 ~<a class="code" href="class_c_graphic_example_control.html">CGraphicExampleControl</a>();
+<a name="l00076"></a>00076 <span class="comment">// allow access by container</span>
+<a name="l00077"></a>00077 TKeyResponse OfferKeyEventL(<span class="keyword">const</span> TKeyEvent& aKeyEvent,TEventCode aType);
+<a name="l00078"></a>00078 <span class="comment">// intercepts ctrl-Q and space; offers other keys to derived classes</span>
+<a name="l00079"></a>00079 <span class="keyword">protected</span>:
+<a name="l00080"></a>00080 <span class="comment">// derived classes must provide these</span>
+<a name="l00081"></a>00081 <span class="keyword">virtual</span> <span class="keywordtype">void</span> UpdateModelL() =0; <span class="comment">// empty update model function</span>
+<a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Draw(<span class="keyword">const</span> TRect& <span class="comment">/* aRect */</span>)<span class="keyword"> const </span>{}; <span class="comment">// empty draw function</span>
+<a name="l00083"></a>00083 <span class="comment">// use Phase() in Draw() to tell what phase we're in</span>
+<a name="l00084"></a>00084 TInt Phase()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> iPhase; }; <span class="comment">// get phase number</span>
+<a name="l00085"></a>00085 <span class="keywordtype">void</span> SetMaxPhases(TInt aMaxPhases) { iMaxPhases=aMaxPhases; };
+<a name="l00086"></a>00086 <span class="comment">// use this from derived-class constructor to set number of phases</span>
+<a name="l00087"></a>00087 CFont* iMessageFont; <span class="comment">// font for messages</span>
+<a name="l00088"></a>00088 <span class="keyword">private</span>:
+<a name="l00089"></a>00089 <span class="comment">// functions provided for CCoeControl protocol</span>
+<a name="l00090"></a>00090 <span class="keywordtype">void</span> HandlePointerEventL(<span class="keyword">const</span> TPointerEvent& aPointerEvent);
+<a name="l00091"></a>00091 <span class="comment">// advances phase on pointer-down</span>
+<a name="l00092"></a>00092 <span class="keywordtype">void</span> Quit(); <span class="comment">// does termination</span>
+<a name="l00093"></a>00093 <span class="keywordtype">void</span> NextPhaseL(); <span class="comment">// advances phase: quits if all phases done</span>
+<a name="l00094"></a>00094 <span class="comment">// phase control for graphics examples</span>
+<a name="l00095"></a>00095 TInt iPhase; <span class="comment">// phase number</span>
+<a name="l00096"></a>00096 TInt iMaxPhases; <span class="comment">// maximum phases</span>
+<a name="l00097"></a>00097 <span class="keyword">protected</span>:
+<a name="l00098"></a>00098 <a class="code" href="class_m_graphics_example_observer.html">MGraphicsExampleObserver</a>* iGraphObserver;
+<a name="l00099"></a>00099 };
+<a name="l00100"></a>00100
+<a name="l00101"></a>00101 <span class="preprocessor">#endif</span>
+</pre></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>