Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_custom_controls_8h_source.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: examples/AppFramework/UIControls/CustomControls/CustomControls.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/AppFramework/UIControls/CustomControls/CustomControls.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">// UI Control Framework example application</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#if !defined(__COSMILEY_H__)</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __COSMILEY_H__</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="comment">//</span>
<a name="l00022"></a>00022 <span class="comment">// Include files containing:</span>
<a name="l00023"></a>00023 <span class="comment">//</span>
<a name="l00024"></a>00024 <span class="comment">// 1. Symbol definitions used by C++ code and resource scripts (the *.hrh)</span>
<a name="l00025"></a>00025 <span class="comment">// 2. Resource ids generated by resource compilation of </span>
<a name="l00026"></a>00026 <span class="comment">// resource scripts (the *.rsg)</span>
<a name="l00027"></a>00027 <span class="comment">// 3. Class definitions required by this app (the *.h)</span>
<a name="l00028"></a>00028 <span class="comment">// </span>
<a name="l00030"></a>00030 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment">// 1.</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <eikon.hrh></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "CustomControls.hrh"</span>
<a name="l00034"></a>00034 <span class="comment">// 2.</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <eikon.rsg></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <customcontrols.rsg></span>
<a name="l00037"></a>00037 <span class="comment">// 3.</span>
<a name="l00038"></a>00038 <span class="preprocessor">#include <eikenv.h></span>
<a name="l00039"></a>00039 <span class="preprocessor">#include <eikappui.h></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <eikproc.h></span>
<a name="l00041"></a>00041 <span class="preprocessor">#include <eikdialg.h></span>
<a name="l00042"></a>00042 <span class="preprocessor">#include <eikmenub.h></span>
<a name="l00043"></a>00043 <span class="preprocessor">#include <eikapp.h></span>
<a name="l00044"></a>00044 <span class="preprocessor">#include <eikdoc.h></span>
<a name="l00045"></a>00045 <span class="preprocessor">#include <coeutils.h></span>
<a name="l00046"></a>00046 <span class="preprocessor">#include <barsread.h></span>
<a name="l00047"></a>00047 <span class="preprocessor">#include <eikfctry.h></span>
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">// The unique identifier for this application.</span>
<a name="l00050"></a>00050 <span class="comment">// NOTE that the number has been arbitrarily chosen for the purpose of</span>
<a name="l00051"></a>00051 <span class="comment">// of the example.</span>
<a name="l00052"></a>00052 <span class="keyword">const</span> TUid KUidExampleApp={0xE8000004};
<a name="l00053"></a>00053
<a name="l00054"></a>00054
<a name="l00056"></a>00056 <span class="comment">//</span>
<a name="l00057"></a>00057 <span class="comment">// -----> CSmileyDialog(definition)</span>
<a name="l00058"></a>00058 <span class="comment">//</span>
<a name="l00060"></a>00060 <span class="comment"></span><span class="keyword">class </span>CSmileyDialog : <span class="keyword">public</span> CEikDialog
<a name="l00061"></a>00061 {
<a name="l00062"></a>00062 <span class="keyword">public</span>:
<a name="l00063"></a>00063 <span class="comment">// Construct and run</span>
<a name="l00064"></a>00064 <span class="keyword">static</span> TBool RunDlgLD();
<a name="l00065"></a>00065 <span class="keyword">private</span>:
<a name="l00066"></a>00066 SEikControlInfo CreateCustomControlL(TInt aControlType);
<a name="l00067"></a>00067 };
<a name="l00068"></a>00068
<a name="l00070"></a>00070 <span class="comment">//</span>
<a name="l00071"></a>00071 <span class="comment">// -----> CSmiley (definition)</span>
<a name="l00072"></a>00072 <span class="comment">//</span>
<a name="l00074"></a>00074 <span class="comment"></span><span class="keyword">class </span>CSmiley : <span class="keyword">public</span> CCoeControl
<a name="l00075"></a>00075 {
<a name="l00076"></a>00076 <span class="keyword">public</span>:
<a name="l00077"></a>00077 CSmiley(TBool aSmiling);
<a name="l00078"></a>00078 ~CSmiley();
<a name="l00079"></a>00079 <span class="keyword">public</span>:
<a name="l00080"></a>00080 TKeyResponse OfferKeyEventL(<span class="keyword">const</span> TKeyEvent& aKeyEvent,TEventCode aType);
<a name="l00081"></a>00081 TBool IsSmiling();
<a name="l00082"></a>00082 <span class="keyword">private</span>:
<a name="l00083"></a>00083 <span class="keywordtype">void</span> Draw(<span class="keyword">const</span> TRect& aRect) <span class="keyword">const</span>;
<a name="l00084"></a>00084 <span class="keywordtype">void</span> SizeChanged();
<a name="l00085"></a>00085 <span class="keyword">protected</span>:
<a name="l00086"></a>00086 <span class="keywordtype">void</span> HandlePointerEventL(<span class="keyword">const</span> TPointerEvent& aPointerEvent);
<a name="l00087"></a>00087 <span class="keywordtype">void</span> FocusChanged(TDrawNow aDrawNow);
<a name="l00088"></a>00088 <span class="keyword">private</span>:
<a name="l00089"></a>00089 TBool iSmiling;
<a name="l00090"></a>00090 TRect iSmileyRect;
<a name="l00091"></a>00091 TInt iSmileyWidth;
<a name="l00092"></a>00092 TInt iSmileyHeight;
<a name="l00093"></a>00093 TRect iSmileRect;
<a name="l00094"></a>00094 TRect iFrownRect;
<a name="l00095"></a>00095 };
<a name="l00096"></a>00096
<a name="l00098"></a>00098 <span class="comment">//</span>
<a name="l00099"></a>00099 <span class="comment">// -----> CSmileyContainer(definition)</span>
<a name="l00100"></a>00100 <span class="comment">//</span>
<a name="l00102"></a>00102 <span class="comment"></span><span class="keyword">class </span>CSmileyContainer : <span class="keyword">public</span> CCoeControl,
<a name="l00103"></a>00103 <span class="keyword">public</span> MCoeControlObserver
<a name="l00104"></a>00104 {
<a name="l00105"></a>00105 <span class="keyword">public</span>:
<a name="l00106"></a>00106 <span class="comment">// Construction</span>
<a name="l00107"></a>00107 CSmileyContainer();
<a name="l00108"></a>00108 <span class="keywordtype">void</span> ConstructL(<span class="keyword">const</span> TRect& aRect);
<a name="l00109"></a>00109 <span class="comment">// Destruction</span>
<a name="l00110"></a>00110 ~CSmileyContainer();
<a name="l00111"></a>00111 <span class="keywordtype">void</span> ConstructFromResourceL(TResourceReader& aReader);
<a name="l00112"></a>00112 <span class="keywordtype">void</span> PrepareForFocusLossL();
<a name="l00113"></a>00113 TKeyResponse OfferKeyEventL(<span class="keyword">const</span> TKeyEvent& aKeyEvent,TEventCode aType);
<a name="l00114"></a>00114 <span class="keyword">protected</span>:
<a name="l00115"></a>00115 <span class="keywordtype">void</span> FocusChanged(TDrawNow aDrawNow);
<a name="l00116"></a>00116 <span class="keyword">private</span>:
<a name="l00117"></a>00117 <span class="comment">// Virtual, defined by CCoeControl; replaces the default implementation</span>
<a name="l00118"></a>00118 <span class="comment">// provided by CCoeControl.</span>
<a name="l00119"></a>00119 <span class="keywordtype">void</span> Draw(<span class="keyword">const</span> TRect& aRect) <span class="keyword">const</span>;
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="comment">// Virtual, defined by CCoeControl; replaces the default implementation</span>
<a name="l00122"></a>00122 <span class="comment">// provided by CCoeControl. </span>
<a name="l00123"></a>00123 TInt CountComponentControls() <span class="keyword">const</span>;
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="comment">// Virtual, defined by CCoeControl; replaces the default implementation</span>
<a name="l00126"></a>00126 <span class="comment">// provided by CCoeControl.</span>
<a name="l00127"></a>00127 CCoeControl* ComponentControl(TInt aIndex) <span class="keyword">const</span>;
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="comment">// Virtual, defined by CCoeControl; empty implementation provided by</span>
<a name="l00130"></a>00130 <span class="comment">// CCoeControl; full implementation provided by this class</span>
<a name="l00131"></a>00131 <span class="keywordtype">void</span> SizeChanged();
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="comment">// Defined as pure virtual by the mixin class MCoeControlObserver </span>
<a name="l00134"></a>00134 <span class="comment">// inherited by CCoeControl. An empty implementation provided by </span>
<a name="l00135"></a>00135 <span class="comment">// this class (its containees do not report events).</span>
<a name="l00136"></a>00136 <span class="keywordtype">void</span> HandleControlEventL(CCoeControl* aControl,
<a name="l00137"></a>00137 TCoeEvent aEventType);
<a name="l00138"></a>00138 <span class="keyword">private</span>:
<a name="l00139"></a>00139 <span class="comment">// Member functions defined and used by this class</span>
<a name="l00140"></a>00140 <span class="keywordtype">void</span> SwapFocus(CCoeControl* aControl);
<a name="l00141"></a>00141 <span class="keyword">private</span>:
<a name="l00142"></a>00142 <span class="comment">// Data members defined and used by this class.</span>
<a name="l00143"></a>00143 CSmiley* iSmiley1;
<a name="l00144"></a>00144 CSmiley* iSmiley2;
<a name="l00145"></a>00145 };
<a name="l00146"></a>00146
<a name="l00147"></a>00147
<a name="l00148"></a>00148
<a name="l00150"></a>00150 <span class="comment">//</span>
<a name="l00151"></a>00151 <span class="comment">// -----> CMainWinControl (definition)</span>
<a name="l00152"></a>00152 <span class="comment">//</span>
<a name="l00154"></a>00154 <span class="comment"></span><span class="keyword">class </span>CMainWinControl : <span class="keyword">public</span> CCoeControl
<a name="l00155"></a>00155 {
<a name="l00156"></a>00156 <span class="keyword">public</span>:
<a name="l00157"></a>00157 CMainWinControl();
<a name="l00158"></a>00158 ~CMainWinControl();
<a name="l00159"></a>00159 <span class="keywordtype">void</span> ConstructL(<span class="keyword">const</span> TRect& rect);
<a name="l00160"></a>00160 TInt CountComponentControls() <span class="keyword">const</span>;
<a name="l00161"></a>00161 CCoeControl* ComponentControl(TInt aIndex) <span class="keyword">const</span>;
<a name="l00162"></a>00162 TKeyResponse OfferKeyEventL(<span class="keyword">const</span> TKeyEvent& aKeyEvent, TEventCode aType);
<a name="l00163"></a>00163 <span class="keyword">private</span>:
<a name="l00164"></a>00164 <span class="keywordtype">void</span> Draw(<span class="keyword">const</span> TRect& aRect) <span class="keyword">const</span>;
<a name="l00165"></a>00165 <span class="keyword">private</span>:
<a name="l00166"></a>00166 CSmileyContainer* iContainer;
<a name="l00167"></a>00167 };
<a name="l00168"></a>00168
<a name="l00170"></a>00170 <span class="comment">//</span>
<a name="l00171"></a>00171 <span class="comment">// -----> CExampleAppUi (definition)</span>
<a name="l00172"></a>00172 <span class="comment">//</span>
<a name="l00174"></a>00174 <span class="comment"></span><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="l00175"></a>00175 {
<a name="l00176"></a>00176 <span class="keyword">public</span>:
<a name="l00177"></a>00177 <span class="comment">// Destruction.</span>
<a name="l00178"></a>00178 ~<a class="code" href="class_c_example_app_ui.html">CExampleAppUi</a>();
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="keyword">public</span>:
<a name="l00181"></a>00181 <span class="comment">// Virtual, defined by CEikAppUi; replaces the implementation </span>
<a name="l00182"></a>00182 <span class="comment">// provided by CEikAppUi.</span>
<a name="l00183"></a>00183 <span class="keywordtype">void</span> ConstructL();
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="keyword">private</span>:
<a name="l00186"></a>00186 <span class="comment">// Virtual, defined by CEikAppUi; empty implementation</span>
<a name="l00187"></a>00187 <span class="comment">// provided by CEikAppUi; full implementation provided</span>
<a name="l00188"></a>00188 <span class="comment">// by this class. </span>
<a name="l00189"></a>00189 <span class="keywordtype">void</span> HandleCommandL(TInt aCommand);
<a name="l00190"></a>00190
<a name="l00191"></a>00191 <span class="comment">// Virtual, defined by CEikAppUi; empty implementation</span>
<a name="l00192"></a>00192 <span class="comment">// provided by CEikAppUi; full implementation provided</span>
<a name="l00193"></a>00193 <span class="comment">// by this class. </span>
<a name="l00194"></a>00194 <span class="keywordtype">void</span> HandleModelChangeL();
<a name="l00195"></a>00195
<a name="l00196"></a>00196 <span class="keyword">private</span>:
<a name="l00197"></a>00197 <span class="keywordtype">void</span> OnCmdExit();
<a name="l00198"></a>00198 <span class="keyword">private</span>:
<a name="l00199"></a>00199 <span class="comment">// Data members defined by this class.</span>
<a name="l00200"></a>00200 CMainWinControl* iMainWinControl;
<a name="l00201"></a>00201 };
<a name="l00202"></a>00202
<a name="l00204"></a>00204 <span class="comment">//</span>
<a name="l00205"></a>00205 <span class="comment">// -----> CExampleDocument (definition)</span>
<a name="l00206"></a>00206 <span class="comment">//</span>
<a name="l00208"></a>00208 <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_c_example_document.html">CExampleDocument</a> : <span class="keyword">public</span> CEikDocument
<a name="l00209"></a>00209 {
<a name="l00210"></a>00210 <span class="keyword">public</span>:
<a name="l00211"></a>00211 <span class="comment">// Construction.</span>
<a name="l00212"></a>00212 <span class="keyword">static</span> <a class="code" href="class_c_example_document.html">CExampleDocument</a>* NewL(CEikApplication& aApp);
<a name="l00213"></a>00213 <a class="code" href="class_c_example_document.html">CExampleDocument</a>(CEikApplication& aApp);
<a name="l00214"></a>00214 <span class="comment">// Destruction.</span>
<a name="l00215"></a>00215 ~<a class="code" href="class_c_example_document.html">CExampleDocument</a>();
<a name="l00216"></a>00216
<a name="l00217"></a>00217 <span class="keyword">private</span>:
<a name="l00218"></a>00218 <span class="comment">// Defined as pure virtual by CEikDocument; full implementation</span>
<a name="l00219"></a>00219 <span class="comment">// provided by this class</span>
<a name="l00220"></a>00220 CEikAppUi* CreateAppUiL(); <span class="comment">// Construct an app.user interface</span>
<a name="l00221"></a>00221
<a name="l00222"></a>00222 <span class="comment">// Defined as pure virtual by CApaDocument; empty implementation </span>
<a name="l00223"></a>00223 <span class="comment">// provided by CEikDocument; full implementation provided</span>
<a name="l00224"></a>00224 <span class="comment">// by this class.</span>
<a name="l00225"></a>00225 <span class="keywordtype">void</span> NewDocumentL(); <span class="comment">// Build a new document</span>
<a name="l00226"></a>00226
<a name="l00227"></a>00227 <span class="comment">// Defined as pure virtual by CApaDocument; empty implementation</span>
<a name="l00228"></a>00228 <span class="comment">// provided by CEikDocument; full implementation provided</span>
<a name="l00229"></a>00229 <span class="comment">// by this class.</span>
<a name="l00230"></a>00230 <span class="keywordtype">void</span> StoreL(CStreamStore& aStore,
<a name="l00231"></a>00231 CStreamDictionary& aStreamDic
<a name="l00232"></a>00232 ) <span class="keyword">const</span>;
<a name="l00233"></a>00233 <span class="keywordtype">void</span> RestoreL(<span class="keyword">const</span> CStreamStore& aStore,
<a name="l00234"></a>00234 <span class="keyword">const</span> CStreamDictionary& aStreamDic
<a name="l00235"></a>00235 );
<a name="l00236"></a>00236
<a name="l00237"></a>00237 <span class="keyword">public</span>:
<a name="l00238"></a>00238 <span class="comment">// Member functions defined by this class</span>
<a name="l00239"></a>00239 <span class="keywordtype">void</span> DoNewFileL(<span class="keyword">const</span> TFileName& aFileName);
<a name="l00240"></a>00240 <span class="keywordtype">void</span> DoOpenFileL(<span class="keyword">const</span> TFileName& aFileName);
<a name="l00241"></a>00241 <span class="keywordtype">void</span> DoSaveToNewFileL(<span class="keyword">const</span> TFileName& aNewFileName);
<a name="l00242"></a>00242 TBool FileNameExists(<span class="keyword">const</span> TFileName& aFileName) <span class="keyword">const</span>;
<a name="l00243"></a>00243
<a name="l00244"></a>00244 <span class="keyword">private</span>:
<a name="l00245"></a>00245 <span class="comment">// Member functions defined by this class</span>
<a name="l00246"></a>00246 <span class="keywordtype">void</span> CreateModelL();
<a name="l00247"></a>00247 <span class="keywordtype">void</span> ResetModelL();
<a name="l00248"></a>00248 };
<a name="l00249"></a>00249
<a name="l00251"></a>00251 <span class="comment">//</span>
<a name="l00252"></a>00252 <span class="comment">// -----> CExampleApplication (definition)</span>
<a name="l00253"></a>00253 <span class="comment">//</span>
<a name="l00255"></a>00255 <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_c_example_application.html">CExampleApplication</a> : <span class="keyword">public</span> CEikApplication
<a name="l00256"></a>00256 {
<a name="l00257"></a>00257 <span class="keyword">private</span>:
<a name="l00258"></a>00258 <span class="comment">// Defined as pure virtual by CApaApplication; implementation</span>
<a name="l00259"></a>00259 <span class="comment">// provided by this class </span>
<a name="l00260"></a>00260 TUid AppDllUid() <span class="keyword">const</span>; <span class="comment">// Returns Uid associated with app</span>
<a name="l00261"></a>00261
<a name="l00262"></a>00262 <span class="comment">// Defined as pure virtual by CEikApplication; implementation</span>
<a name="l00263"></a>00263 <span class="comment">// provided by this class.</span>
<a name="l00264"></a>00264 CApaDocument* CreateDocumentL(); <span class="comment">// Construct new document</span>
<a name="l00265"></a>00265 };
<a name="l00266"></a>00266
<a name="l00267"></a>00267
<a name="l00268"></a>00268
<a name="l00269"></a>00269 <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>