Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_descriptor_ex_app_ui_8cpp_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/ForumNokia/DescriptorExample/src/DescriptorExAppUi.cpp 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/ForumNokia/DescriptorExample/src/DescriptorExAppUi.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright © 2008 Nokia Corporation.</span>
<a name="l00003"></a>00003 <span class="comment"> */</span>
<a name="l00004"></a>00004 
<a name="l00005"></a>00005 <span class="preprocessor">#include &quot;DescriptorExAppUi.h&quot;</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include &quot;DescriptorExContainer.h&quot;</span>
<a name="l00007"></a>00007 <span class="preprocessor">#include &lt;DescriptorEx.rsg&gt;</span>
<a name="l00008"></a>00008 <span class="preprocessor">#include &quot;descriptorex.hrh&quot;</span>
<a name="l00009"></a>00009 <span class="preprocessor">#include &lt;aknutils.h&gt;</span>
<a name="l00010"></a>00010 
<a name="l00011"></a>00011 <span class="preprocessor">#include &lt;avkon.hrh&gt;</span>
<a name="l00012"></a>00012 <span class="preprocessor">#include &quot;DescriptorExamples.h&quot;</span>
<a name="l00013"></a>00013 
<a name="l00014"></a>00014 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00015"></a>00015 <span class="comment">// defines a type that is pointer to a example method in CDescriptorExamples</span>
<a name="l00016"></a>00016 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00017"></a>00017 <span class="keyword">typedef</span> void (<a class="code" href="class_c_descriptor_examples.html">CDescriptorExamples</a>::*TExampleMethodPtr)();
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00020"></a>00020 <span class="comment">// defines an array of pointers pointing to example methods</span>
<a name="l00021"></a>00021 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00022"></a>00022 <span class="keyword">static</span> <span class="keyword">const</span> TExampleMethodPtr ExampleMethods[] =
<a name="l00023"></a>00023     {
<a name="l00024"></a>00024     &amp;<a class="code" href="class_c_descriptor_examples.html#a7f529caf8413e46dbb90c73f9b8839da">CDescriptorExamples::ToStack</a>,
<a name="l00025"></a>00025     &amp;<a class="code" href="class_c_descriptor_examples.html#abfb8e980e2e7e89daa2b46de2cb98d4a">CDescriptorExamples::ToHeapL</a>,
<a name="l00026"></a>00026     &amp;<a class="code" href="class_c_descriptor_examples.html#ac09dcbba3fcb7b55391e50c3692052d5">CDescriptorExamples::Literals</a>,
<a name="l00027"></a>00027 
<a name="l00028"></a>00028     &amp;<a class="code" href="class_c_descriptor_examples.html#ac45c0edc4bd868c8c21d25ec676f121b">CDescriptorExamples::NonModifyingMethods</a>,
<a name="l00029"></a>00029     &amp;<a class="code" href="class_c_descriptor_examples.html#a5c4e6afcc42704c6d55ff898f7d5f749">CDescriptorExamples::ModifyingMethodsL</a>,
<a name="l00030"></a>00030     &amp;<a class="code" href="class_c_descriptor_examples.html#ae51548be0afb3319e849f7ff8ccf440f">CDescriptorExamples::CharacterConversionsL</a>,
<a name="l00031"></a>00031     &amp;<a class="code" href="class_c_descriptor_examples.html#ace06425c580f03f1bdd084f079de168f">CDescriptorExamples::LexicalAnalysis</a>,
<a name="l00032"></a>00032 
<a name="l00033"></a>00033     &amp;<a class="code" href="class_c_descriptor_examples.html#a16794acec84adb6c9f9bd53493bfda8f">CDescriptorExamples::CircularBuffersL</a>,
<a name="l00034"></a>00034     &amp;<a class="code" href="class_c_descriptor_examples.html#a7b302d526ed71c8039a1be75d9ceb21a">CDescriptorExamples::FlatDynamicBuffersL</a>,
<a name="l00035"></a>00035     &amp;<a class="code" href="class_c_descriptor_examples.html#a4fbafdaa5db8471d65748de40a0fac1b">CDescriptorExamples::SegmentedDynamicBuffersL</a>,
<a name="l00036"></a>00036     &amp;<a class="code" href="class_c_descriptor_examples.html#aa3004492a8d6c9ba4aebeb1b81b1f6a3">CDescriptorExamples::PackageBuffers</a>,
<a name="l00037"></a>00037     &amp;<a class="code" href="class_c_descriptor_examples.html#a0c138dfa0a2aa25627963b9fee1b63d5">CDescriptorExamples::RBufDemonstrations</a>
<a name="l00038"></a>00038     };
<a name="l00039"></a>00039 <span class="keyword">static</span> <span class="keyword">const</span> TInt KNumberOfExampleMethods = <span class="keyword">sizeof</span>(ExampleMethods) / 
<a name="l00040"></a>00040                                             <span class="keyword">sizeof</span>(TExampleMethodPtr);
<a name="l00041"></a>00041 
<a name="l00042"></a>00042 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00043"></a>00043 <span class="comment">// Executes requested method. If aNumber indexes out of bounds of method pointer</span>
<a name="l00044"></a>00044 <span class="comment">// array, nothing is done.</span>
<a name="l00045"></a>00045 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00046"></a>00046 LOCAL_C <span class="keywordtype">void</span> ExecuteExampleMethodL(TInt aNumber, <a class="code" href="class_c_descriptor_examples.html">CDescriptorExamples</a> &amp;aExample)
<a name="l00047"></a>00047     {
<a name="l00048"></a>00048     <span class="keywordflow">if</span>( aNumber &gt;= 0 &amp;&amp; aNumber &lt; KNumberOfExampleMethods )
<a name="l00049"></a>00049         {
<a name="l00050"></a>00050         TExampleMethodPtr mPtr = ExampleMethods[aNumber];
<a name="l00051"></a>00051         (aExample.*mPtr)(); <span class="comment">// call example method through method pointer</span>
<a name="l00052"></a>00052         }
<a name="l00053"></a>00053     }
<a name="l00054"></a>00054 
<a name="l00055"></a>00055 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00056"></a>00056 <span class="comment">// Second phase constructor of class CDescriptorExAppUi.</span>
<a name="l00057"></a>00057 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00058"></a>00058 <span class="keywordtype">void</span> CDescriptorExAppUi::ConstructL()
<a name="l00059"></a>00059     {
<a name="l00060"></a>00060     BaseConstructL(EAknEnableSkin);
<a name="l00061"></a>00061 
<a name="l00062"></a>00062     iAppContainer = <span class="keyword">new</span> (ELeave) <a class="code" href="class_c_descriptor_ex_container.html">CDescriptorExContainer</a>;
<a name="l00063"></a>00063     iAppContainer-&gt;SetMopParent(<span class="keyword">this</span>);
<a name="l00064"></a>00064     iAppContainer-&gt;<a class="code" href="class_c_descriptor_ex_container.html#acee626ffc604002e389a14eed03108db">ConstructL</a>( ClientRect() );
<a name="l00065"></a>00065     AddToStackL( iAppContainer );
<a name="l00066"></a>00066     iBuffer = HBufC::NewL(4096);
<a name="l00067"></a>00067     iExamples = <span class="keyword">new</span> (ELeave) <a class="code" href="class_c_descriptor_examples.html">CDescriptorExamples</a>( <span class="keyword">this</span> );
<a name="l00068"></a>00068     }
<a name="l00069"></a>00069 
<a name="l00070"></a>00070 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00071"></a>00071 <span class="comment">// This destructor frees reserved resources</span>
<a name="l00072"></a>00072 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00073"></a>00073 CDescriptorExAppUi::~CDescriptorExAppUi()
<a name="l00074"></a>00074     {
<a name="l00075"></a>00075     <span class="keyword">delete</span> iExamples;
<a name="l00076"></a>00076     iExamples = NULL;
<a name="l00077"></a>00077     <span class="keyword">delete</span> iBuffer;
<a name="l00078"></a>00078     iBuffer = NULL;
<a name="l00079"></a>00079     <span class="keywordflow">if</span> (iAppContainer)
<a name="l00080"></a>00080         {
<a name="l00081"></a>00081         RemoveFromStack( iAppContainer );
<a name="l00082"></a>00082         <span class="keyword">delete</span> iAppContainer;
<a name="l00083"></a>00083         iAppContainer = NULL;
<a name="l00084"></a>00084         }
<a name="l00085"></a>00085    }
<a name="l00086"></a>00086 
<a name="l00087"></a>00087 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00088"></a>00088 <span class="comment">// Run all example methods and write results to the file.</span>
<a name="l00089"></a>00089 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00090"></a>00090 <span class="keywordtype">void</span> CDescriptorExAppUi::RunAllL()
<a name="l00091"></a>00091     {
<a name="l00092"></a>00092     <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>( KFileName, <span class="stringliteral">&quot;c:\\Data\\DescriptorEx.log.txt&quot;</span> );
<a name="l00093"></a>00093 
<a name="l00094"></a>00094     <a class="code" href="class_c_file_forwarder.html">CFileForwarder</a> *fileWriter = <span class="keyword">new</span> (ELeave) <a class="code" href="class_c_file_forwarder.html">CFileForwarder</a>();
<a name="l00095"></a>00095     CleanupStack::PushL( fileWriter );
<a name="l00096"></a>00096     fileWriter-&gt;<a class="code" href="class_c_file_forwarder.html#a8ba86f9e2f054d9c44114276428cfe98">ConstructL</a>(KFileName);
<a name="l00097"></a>00097 
<a name="l00098"></a>00098     <a class="code" href="class_c_descriptor_examples.html">CDescriptorExamples</a> *example = <span class="keyword">new</span> (ELeave) <a class="code" href="class_c_descriptor_examples.html">CDescriptorExamples</a>(fileWriter);
<a name="l00099"></a>00099     CleanupStack::PushL( example );
<a name="l00100"></a>00100 
<a name="l00101"></a>00101     <span class="keywordflow">for</span>( TInt i=0; i &lt; KNumberOfExampleMethods; i++ )
<a name="l00102"></a>00102         {
<a name="l00103"></a>00103         ExecuteExampleMethodL(i, *example);
<a name="l00104"></a>00104         }
<a name="l00105"></a>00105     GetViewBuffer().AppendFormat( _L(
<a name="l00106"></a>00106         <span class="stringliteral">&quot;Results of example methods written to file\n\&quot;%S\&quot;\n&quot;</span>), &amp;KFileName );
<a name="l00107"></a>00107     UpdateView();
<a name="l00108"></a>00108 
<a name="l00109"></a>00109     CleanupStack::PopAndDestroy(2); <span class="comment">// examples, fileWriter</span>
<a name="l00110"></a>00110     }
<a name="l00111"></a>00111 
<a name="l00112"></a>00112 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00113"></a>00113 <span class="comment">// Handles commands from framework. Expecting to receive only menu commands and</span>
<a name="l00114"></a>00114 <span class="comment">// selecting back from right menu (EAknSoftkeyBack).</span>
<a name="l00115"></a>00115 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00116"></a>00116 <span class="keywordtype">void</span> CDescriptorExAppUi::HandleCommandL(TInt aCommand)
<a name="l00117"></a>00117     {
<a name="l00118"></a>00118     <span class="keywordflow">if</span>( aCommand - TDescriptorExCommandFirstID &lt; KNumberOfExampleMethods )
<a name="l00119"></a>00119         {
<a name="l00120"></a>00120         <span class="comment">// reset internal buffer before example</span>
<a name="l00121"></a>00121         iBuffer-&gt;Des().SetLength(0);
<a name="l00122"></a>00122 
<a name="l00123"></a>00123         <span class="comment">// call one of the example methods. Since commands start from</span>
<a name="l00124"></a>00124         <span class="comment">// TDescriptorExCommandFirstID, it has to be decreased from aCommand</span>
<a name="l00125"></a>00125         <span class="comment">// to get correct example method number (since indexing to array</span>
<a name="l00126"></a>00126         <span class="comment">// starts from zero).</span>
<a name="l00127"></a>00127         ExecuteExampleMethodL( aCommand - TDescriptorExCommandFirstID,
<a name="l00128"></a>00128                               *iExamples );
<a name="l00129"></a>00129         }
<a name="l00130"></a>00130 
<a name="l00131"></a>00131     <span class="keywordflow">switch</span> ( aCommand )
<a name="l00132"></a>00132         {
<a name="l00133"></a>00133         <span class="keywordflow">case</span> EAknSoftkeyExit:
<a name="l00134"></a>00134         <span class="keywordflow">case</span> EEikCmdExit:
<a name="l00135"></a>00135             {
<a name="l00136"></a>00136             Exit();
<a name="l00137"></a>00137             <span class="keywordflow">break</span>;
<a name="l00138"></a>00138             }
<a name="l00139"></a>00139         <span class="keywordflow">case</span> ECmd_RunAll:
<a name="l00140"></a>00140             {
<a name="l00141"></a>00141             <span class="comment">//The RBuf demonstration (RBufDemonstrations) consists of code </span>
<a name="l00142"></a>00142             <span class="comment">//examples in manipulating RBuf objects and doesn&#39;t write any </span>
<a name="l00143"></a>00143             <span class="comment">//results to the file so it isn&#39;t executed here.</span>
<a name="l00144"></a>00144             <span class="comment">//iExamples-&gt;RBufDemonstrations();</span>
<a name="l00145"></a>00145             RunAllL();
<a name="l00146"></a>00146             <span class="keywordflow">break</span>;
<a name="l00147"></a>00147             }
<a name="l00148"></a>00148         <span class="keywordflow">default</span>:
<a name="l00149"></a>00149             {
<a name="l00150"></a>00150             <span class="keywordflow">break</span>;      
<a name="l00151"></a>00151             }
<a name="l00152"></a>00152         };
<a name="l00153"></a>00153     }
<a name="l00154"></a>00154 
<a name="l00155"></a>00155 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00156"></a>00156 <span class="comment">// Handle key events</span>
<a name="l00157"></a>00157 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00158"></a>00158 TKeyResponse CDescriptorExAppUi::HandleKeyEventL(<span class="keyword">const</span> TKeyEvent&amp; aKeyEvent,
<a name="l00159"></a>00159                                                  TEventCode aType)
<a name="l00160"></a>00160 {
<a name="l00161"></a>00161     <span class="comment">// forward key event to container</span>
<a name="l00162"></a>00162     <span class="keywordflow">return</span> iAppContainer-&gt;<a class="code" href="class_c_descriptor_ex_container.html#ab635bde519254d61e4dfda6d51c9f021">OfferKeyEventL</a>( aKeyEvent, aType );
<a name="l00163"></a>00163 }
<a name="l00164"></a>00164 
<a name="l00165"></a>00165 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00166"></a>00166 <span class="comment">// Return modifiable descriptor pointer to our internal buffer so that examples</span>
<a name="l00167"></a>00167 <span class="comment">// can write their results to it.</span>
<a name="l00168"></a>00168 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00169"></a>00169 TPtr CDescriptorExAppUi::GetViewBuffer()
<a name="l00170"></a>00170 {
<a name="l00171"></a>00171     <span class="keywordflow">return</span> iBuffer-&gt;Des();
<a name="l00172"></a>00172 }
<a name="l00173"></a>00173 
<a name="l00174"></a>00174 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00175"></a>00175 <span class="comment">// Update our edvin control with data in our internal buffer. If unicode</span>
<a name="l00176"></a>00176 <span class="comment">// build, replace any ascii &#39;\n&#39; character with unicode variant since edwin</span>
<a name="l00177"></a>00177 <span class="comment">// understands only unicode paragraphs when unicode build.</span>
<a name="l00178"></a>00178 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00179"></a>00179 <span class="keywordtype">void</span> CDescriptorExAppUi::UpdateView()
<a name="l00180"></a>00180     {
<a name="l00181"></a>00181     <span class="comment">// replace any &#39;\n&#39; characters from buffer with UCS paragraph separator if</span>
<a name="l00182"></a>00182     <span class="comment">// unicode build.</span>
<a name="l00183"></a>00183 <span class="preprocessor">#ifdef _UNICODE</span>
<a name="l00184"></a>00184 <span class="preprocessor"></span>    TText16* ptr=(TText16*)iBuffer-&gt;Ptr();
<a name="l00185"></a>00185     TText16* endPtr=ptr + iBuffer-&gt;Length();
<a name="l00186"></a>00186     <span class="keywordflow">for</span>(;ptr &lt; endPtr; ptr++ )
<a name="l00187"></a>00187     {
<a name="l00188"></a>00188         <span class="keywordflow">if</span>( *ptr == <span class="charliteral">&#39;\n&#39;</span> )
<a name="l00189"></a>00189         {
<a name="l00190"></a>00190             *ptr = 0x2029; <span class="comment">// UCS_PARASEP = 0x2029</span>
<a name="l00191"></a>00191         }
<a name="l00192"></a>00192     }
<a name="l00193"></a>00193 <span class="preprocessor">#endif</span>
<a name="l00194"></a>00194 <span class="preprocessor"></span>    <span class="comment">// MResultViewer declares this method as non leaving (no suffix L). If</span>
<a name="l00195"></a>00195     <span class="comment">// text editor can&#39;t set the text, we ignore the error.</span>
<a name="l00196"></a>00196     TRAPD(ignored, iAppContainer-&gt;<a class="code" href="class_c_descriptor_ex_container.html#ab7b00bc5265b7e7b02498d490b537341">SetTextL</a>(*iBuffer));
<a name="l00197"></a>00197     }
<a name="l00198"></a>00198 
<a name="l00199"></a>00199 <span class="keywordtype">void</span> CDescriptorExAppUi::HandleResourceChangeL(TInt aType)
<a name="l00200"></a>00200     {
<a name="l00201"></a>00201     CAknAppUi::HandleResourceChangeL(aType);
<a name="l00202"></a>00202 
<a name="l00203"></a>00203     <span class="keywordflow">if</span> ( aType == KEikDynamicLayoutVariantSwitch )
<a name="l00204"></a>00204         {
<a name="l00205"></a>00205         TRect rect;
<a name="l00206"></a>00206         AknLayoutUtils::LayoutMetricsRect(AknLayoutUtils::EMainPane, rect);
<a name="l00207"></a>00207         iAppContainer-&gt;SetRect(rect);
<a name="l00208"></a>00208         }
<a name="l00209"></a>00209     }
</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>