Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_descriptor_ex_container_8cpp_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/ForumNokia/DescriptorExample/src/DescriptorExContainer.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/DescriptorExContainer.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="comment">// INCLUDE FILES</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include <coemain.h></span>
<a name="l00007"></a>00007 <span class="preprocessor">#include <eikenv.h></span>
<a name="l00008"></a>00008 <span class="preprocessor">#include <gdi.h></span>
<a name="l00009"></a>00009 <span class="preprocessor">#include <txtrich.h></span>
<a name="l00010"></a>00010 <span class="preprocessor">#include <aknsbasicbackgroundcontrolcontext.h></span>
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="preprocessor">#include "DescriptorExContainer.h"</span>
<a name="l00013"></a>00013
<a name="l00014"></a>00014
<a name="l00015"></a>00015 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00016"></a>00016 <span class="comment">// Two phase constructor. Constructs container containing one non editable</span>
<a name="l00017"></a>00017 <span class="comment">// editor component.</span>
<a name="l00018"></a>00018 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00019"></a><a class="code" href="class_c_descriptor_ex_container.html#acee626ffc604002e389a14eed03108db">00019</a> <span class="keywordtype">void</span> <a class="code" href="class_c_descriptor_ex_container.html#acee626ffc604002e389a14eed03108db">CDescriptorExContainer::ConstructL</a>(<span class="keyword">const</span> TRect& aRect)
<a name="l00020"></a>00020 {
<a name="l00021"></a>00021 CreateWindowL();
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="comment">// Create editable editor control</span>
<a name="l00024"></a>00024 iTextBox = <span class="keyword">new</span> (ELeave) CEikEdwin();
<a name="l00025"></a>00025 iTextBox->SetContainerWindowL( *<span class="keyword">this</span> );
<a name="l00026"></a>00026 iTextBox->ConstructL( CEikEdwin::ENoAutoSelection |
<a name="l00027"></a>00027 CEikEdwin::EDisplayOnly |
<a name="l00028"></a>00028 CEikEdwin::EReadOnly |
<a name="l00029"></a>00029 CEikEdwin::EAvkonEditor |
<a name="l00030"></a>00030 CEikEdwin::EInclusiveSizeFixed);
<a name="l00031"></a>00031 iTextBox->CreateScrollBarFrameL()->SetScrollBarVisibilityL(
<a name="l00032"></a>00032 CEikScrollBarFrame::EOff, CEikScrollBarFrame::EOn);
<a name="l00033"></a>00033
<a name="l00034"></a>00034 iTextBox->UpdateScrollBarsL();
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="comment">// http://wiki.forum.nokia.com/index.php/TSS000578_-_How_to_ensure_that_the_scroll_bar_background_is_drawn_properly%3F</span>
<a name="l00037"></a>00037 <span class="comment">// Skin support</span>
<a name="l00038"></a>00038 iSkinContext = CAknsBasicBackgroundControlContext::NewL(KAknsIIDQsnBgAreaMainAppsGrid,aRect,EFalse);
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">// Activate the window, which makes it ready to be drawn</span>
<a name="l00041"></a>00041 ActivateL();
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="comment">// Set the windows size</span>
<a name="l00044"></a>00044 <span class="comment">// NOTE: To call this after ActivateL() is solution to get</span>
<a name="l00045"></a>00045 <span class="comment">// scrollbarframe width in SizeChanged() method.</span>
<a name="l00046"></a>00046 SetRect(aRect);
<a name="l00047"></a>00047 }
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00050"></a>00050 <span class="comment">// Destroys all resources owned by this object.</span>
<a name="l00051"></a>00051 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00052"></a><a class="code" href="class_c_descriptor_ex_container.html#a3ed61f26ea8dc81ec7780c174fcc21f2">00052</a> <a class="code" href="class_c_descriptor_ex_container.html#a3ed61f26ea8dc81ec7780c174fcc21f2">CDescriptorExContainer::~CDescriptorExContainer</a>()
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054 <span class="keyword">delete</span> iTextBox;
<a name="l00055"></a>00055 <span class="keyword">delete</span> iSkinContext;
<a name="l00056"></a>00056 }
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00059"></a>00059 <span class="comment">// Sets the data shown in editor and sets the focus on editor.</span>
<a name="l00060"></a>00060 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00061"></a><a class="code" href="class_c_descriptor_ex_container.html#ab7b00bc5265b7e7b02498d490b537341">00061</a> <span class="keywordtype">void</span> <a class="code" href="class_c_descriptor_ex_container.html#ab7b00bc5265b7e7b02498d490b537341">CDescriptorExContainer::SetTextL</a>(<span class="keyword">const</span> TDesC& aText)
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063 iTextBox->SetTextL( &aText );
<a name="l00064"></a>00064 iTextBox->SetFocus( ETrue );
<a name="l00065"></a>00065
<a name="l00066"></a>00066 iTextBox->HandleTextChangedL();
<a name="l00067"></a>00067 iTextBox->UpdateScrollBarsL();
<a name="l00068"></a>00068
<a name="l00069"></a>00069 }
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00072"></a>00072 <span class="comment">// Return number of objects in this container</span>
<a name="l00073"></a>00073 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00074"></a>00074 TInt CDescriptorExContainer::CountComponentControls()<span class="keyword"> const</span>
<a name="l00075"></a>00075 <span class="keyword"> </span>{
<a name="l00076"></a>00076 <span class="keywordflow">return</span> 1; <span class="comment">// return nbr of controls inside this container</span>
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00080"></a>00080 <span class="comment">// Handle up and down keys to scroll the edwin control.</span>
<a name="l00081"></a>00081 <span class="comment">// </span>
<a name="l00082"></a>00082 <span class="comment">// For some odd reason the edwin control doesn't process keyevent expect in</span>
<a name="l00083"></a>00083 <span class="comment">// case that cursor is in the beginning or end of the document.</span>
<a name="l00084"></a>00084 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00085"></a><a class="code" href="class_c_descriptor_ex_container.html#ab635bde519254d61e4dfda6d51c9f021">00085</a> TKeyResponse <a class="code" href="class_c_descriptor_ex_container.html#ab635bde519254d61e4dfda6d51c9f021">CDescriptorExContainer::OfferKeyEventL</a>(<span class="keyword">const</span> TKeyEvent& aKeyEvent,
<a name="l00086"></a>00086 TEventCode aType)
<a name="l00087"></a>00087 {
<a name="l00088"></a>00088 TKeyResponse result = EKeyWasNotConsumed;
<a name="l00089"></a>00089 <span class="keywordflow">switch</span>(aKeyEvent.iScanCode)
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 <span class="keywordflow">case</span> EStdKeyRightArrow:
<a name="l00092"></a>00092 <span class="keywordflow">case</span> EStdKeyDownArrow:
<a name="l00093"></a>00093 {
<a name="l00094"></a>00094 result = EKeyWasConsumed;
<a name="l00095"></a>00095 <span class="keywordflow">if</span>( aType == EEventKeyDown )
<a name="l00096"></a>00096 {
<a name="l00097"></a>00097 iTextBox->MoveCursorL( TCursorPosition::EFLineDown, EFalse );
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099 <span class="keywordflow">break</span>;
<a name="l00100"></a>00100 }
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keywordflow">case</span> EStdKeyLeftArrow:
<a name="l00103"></a>00103 <span class="keywordflow">case</span> EStdKeyUpArrow:
<a name="l00104"></a>00104 {
<a name="l00105"></a>00105 result = EKeyWasConsumed;
<a name="l00106"></a>00106 <span class="keywordflow">if</span>( aType == EEventKeyDown )
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108 iTextBox->MoveCursorL( TCursorPosition::EFLineUp, EFalse );
<a name="l00109"></a>00109 }
<a name="l00110"></a>00110 <span class="keywordflow">break</span>;
<a name="l00111"></a>00111 }
<a name="l00112"></a>00112 }
<a name="l00113"></a>00113 <span class="keywordflow">return</span> result;
<a name="l00114"></a>00114 }
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00117"></a>00117 <span class="comment">// Return component at requested index.</span>
<a name="l00118"></a>00118 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00119"></a>00119 CCoeControl* CDescriptorExContainer::ComponentControl(TInt aIndex)<span class="keyword"> const</span>
<a name="l00120"></a>00120 <span class="keyword"> </span>{
<a name="l00121"></a>00121 <span class="keywordflow">switch</span> ( aIndex )
<a name="l00122"></a>00122 {
<a name="l00123"></a>00123 <span class="keywordflow">case</span> 0:
<a name="l00124"></a>00124 <span class="keywordflow">return</span> iTextBox;
<a name="l00125"></a>00125 <span class="keywordflow">default</span>:
<a name="l00126"></a>00126 <span class="keywordflow">return</span> NULL;
<a name="l00127"></a>00127 }
<a name="l00128"></a>00128 }
<a name="l00129"></a>00129
<a name="l00130"></a>00130 TInt CDescriptorExContainer::GetScrollbarWidth()<span class="keyword"> const</span>
<a name="l00131"></a>00131 <span class="keyword"> </span>{
<a name="l00132"></a>00132 TInt scrollbarWidth = iTextBox->ScrollBarFrame()->
<a name="l00133"></a>00133 ScrollBarBreadth(CEikScrollBar::EVertical);
<a name="l00134"></a>00134 <span class="comment">// If scrollbars are not drawn yet, the width remains zero. In this</span>
<a name="l00135"></a>00135 <span class="comment">// case, an intentionally magical number is returned.</span>
<a name="l00136"></a>00136 <span class="keywordflow">if</span> (scrollbarWidth == 0)
<a name="l00137"></a>00137 {
<a name="l00138"></a>00138 scrollbarWidth = 8;
<a name="l00139"></a>00139 }
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="keywordflow">return</span> scrollbarWidth;
<a name="l00142"></a>00142 }
<a name="l00143"></a>00143
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="keywordtype">void</span> CDescriptorExContainer::SizeChanged()
<a name="l00146"></a>00146 {
<a name="l00147"></a>00147 TRect rect = Rect();
<a name="l00148"></a>00148 TInt scrollbarWidth = GetScrollbarWidth();
<a name="l00149"></a>00149 iTextBox->SetExtent(TPoint(0, 0),
<a name="l00150"></a>00150 TSize(rect.Width() - scrollbarWidth, rect.Height()));
<a name="l00151"></a>00151
<a name="l00152"></a>00152 iTextBox->UpdateScrollBarsL();
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="comment">// Update new size for the skin</span>
<a name="l00155"></a>00155 iSkinContext->SetRect(rect);
<a name="l00156"></a>00156 }
<a name="l00157"></a>00157
<a name="l00158"></a>00158
<a name="l00159"></a>00159 TTypeUid::Ptr CDescriptorExContainer::MopSupplyObject(TTypeUid aId)
<a name="l00160"></a>00160 {
<a name="l00161"></a>00161 <span class="comment">// That is for the skin support</span>
<a name="l00162"></a>00162 <span class="keywordflow">if</span>( aId.iUid == MAknsControlContext::ETypeId && iSkinContext != NULL )
<a name="l00163"></a>00163 {
<a name="l00164"></a>00164 <span class="keywordflow">return</span> MAknsControlContext::SupplyMopObject( aId, iSkinContext );
<a name="l00165"></a>00165 }
<a name="l00166"></a>00166 <span class="keywordflow">return</span> CCoeControl::MopSupplyObject( aId );
<a name="l00167"></a>00167 }
<a name="l00168"></a>00168
</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>