Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_d_b_m_s_listbox_view_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/DBMS/src/DBMSListboxView.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/DBMS/src/DBMSListboxView.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 &lt;eikenv.h&gt;</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include &lt;avkon.hrh&gt;</span>
<a name="l00007"></a>00007 <span class="preprocessor">#include &lt;gdi.h&gt;</span>
<a name="l00008"></a>00008 <span class="preprocessor">#include &lt;eiktxlbx.h&gt;</span>  <span class="comment">// CEikTextListBox</span>
<a name="l00009"></a>00009 <span class="preprocessor">#include &lt;eiklabel.h&gt;</span>  <span class="comment">// CEikLabel</span>
<a name="l00010"></a>00010 <span class="preprocessor">#include &lt;eiktxlbm.h&gt;</span>  <span class="comment">// CTextListBoxModel</span>
<a name="l00011"></a>00011 <span class="preprocessor">#include &lt;aknconsts.h&gt;</span>
<a name="l00012"></a>00012 <span class="preprocessor">#include &lt;AknUtils.h&gt;</span>
<a name="l00013"></a>00013 <span class="preprocessor">#include &quot;DBMSListboxView.h&quot;</span>
<a name="l00014"></a>00014 
<a name="l00015"></a>00015 
<a name="l00016"></a>00016 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00017"></a>00017 <span class="comment">// CDBMSListboxView::NewL()</span>
<a name="l00018"></a>00018 <span class="comment">//</span>
<a name="l00019"></a>00019 <span class="comment">// Create instance of this view.</span>
<a name="l00020"></a>00020 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00021"></a>00021 <span class="comment">//</span>
<a name="l00022"></a><a class="code" href="class_c_d_b_m_s_listbox_view.html#a1187c6bce072aace1351910deb676690">00022</a> <a class="code" href="class_c_d_b_m_s_listbox_view.html">CDBMSListboxView</a>* <a class="code" href="class_c_d_b_m_s_listbox_view.html#a1187c6bce072aace1351910deb676690">CDBMSListboxView::NewL</a>(<span class="keyword">const</span> TRect&amp; aRect)
<a name="l00023"></a>00023     {
<a name="l00024"></a>00024     <a class="code" href="class_c_d_b_m_s_listbox_view.html">CDBMSListboxView</a>* <span class="keyword">self</span> = <span class="keyword">new</span> (ELeave) <a class="code" href="class_c_d_b_m_s_listbox_view.html">CDBMSListboxView</a>;
<a name="l00025"></a>00025     CleanupStack::PushL(<span class="keyword">self</span>);
<a name="l00026"></a>00026     <span class="keyword">self</span>-&gt;ConstructL(aRect);
<a name="l00027"></a>00027     CleanupStack::Pop(<span class="keyword">self</span>);
<a name="l00028"></a>00028     <span class="keywordflow">return</span> <span class="keyword">self</span>;
<a name="l00029"></a>00029     }
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00033"></a>00033 <span class="comment">// CDBMSListboxView::ConstructL()</span>
<a name="l00034"></a>00034 <span class="comment">//</span>
<a name="l00035"></a>00035 <span class="comment">// Perform the second phase construction. Construct the contained controls.</span>
<a name="l00036"></a>00036 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00037"></a>00037 <span class="comment">//</span>
<a name="l00038"></a>00038 <span class="keywordtype">void</span> CDBMSListboxView::ConstructL(<span class="keyword">const</span> TRect&amp; aRect)
<a name="l00039"></a>00039     {
<a name="l00040"></a>00040     <span class="comment">// Create a window for this application view</span>
<a name="l00041"></a>00041     CreateWindowL();
<a name="l00042"></a>00042         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KListboxView, <span class="stringliteral">&quot;Listbox view&quot;</span>);
<a name="l00043"></a>00043 
<a name="l00044"></a>00044     iLabel = <span class="keyword">new</span> (ELeave) CEikLabel();
<a name="l00045"></a>00045     iLabel-&gt;SetTextL(KListboxView);
<a name="l00046"></a>00046     iLabel-&gt;SetContainerWindowL( *<span class="keyword">this</span> );
<a name="l00047"></a>00047 
<a name="l00048"></a>00048     iListBox = <span class="keyword">new</span>(ELeave)CEikTextListBox();
<a name="l00049"></a>00049     iListBox-&gt;ConstructL( <span class="keyword">this</span>);
<a name="l00050"></a>00050     iListBox-&gt;SetContainerWindowL( *<span class="keyword">this</span> );
<a name="l00051"></a>00051 
<a name="l00052"></a>00052     <span class="comment">// Set the windows size</span>
<a name="l00053"></a>00053     SetRect(aRect);
<a name="l00054"></a>00054     ActivateL();
<a name="l00055"></a>00055     }
<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">// CDBMSListboxView::SetCaptionL()</span>
<a name="l00060"></a>00060 <span class="comment">//</span>
<a name="l00061"></a>00061 <span class="comment">// Set caption for this view. Updates the label.</span>
<a name="l00062"></a>00062 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00063"></a>00063 <span class="comment">//</span>
<a name="l00064"></a><a class="code" href="class_c_d_b_m_s_listbox_view.html#a5bf195c1c4b2688016cb7d88d58ea969">00064</a> <span class="keywordtype">void</span> <a class="code" href="class_c_d_b_m_s_listbox_view.html#a5bf195c1c4b2688016cb7d88d58ea969">CDBMSListboxView::SetCaptionL</a>(<span class="keyword">const</span> TDesC&amp; aNewCaption)
<a name="l00065"></a>00065     {
<a name="l00066"></a>00066     iLabel-&gt;SetTextL(aNewCaption);
<a name="l00067"></a>00067     <a class="code" href="class_c_d_b_m_s_listbox_view.html#a88ee1438bf69d34a5e25bf573dd3f036">SizeChanged</a>();
<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">// CDBMSListboxView::SetListItemsL()</span>
<a name="l00073"></a>00073 <span class="comment">//</span>
<a name="l00074"></a>00074 <span class="comment">// Sets the listbox array and updates the view to reflect new array items.</span>
<a name="l00075"></a>00075 <span class="comment">// The listbox takes ownership of the given aNewItems array.</span>
<a name="l00076"></a>00076 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00077"></a>00077 <span class="comment">//</span>
<a name="l00078"></a><a class="code" href="class_c_d_b_m_s_listbox_view.html#a48fe6a8bffab3afc9b09300b0974914a">00078</a> <span class="keywordtype">void</span> <a class="code" href="class_c_d_b_m_s_listbox_view.html#a48fe6a8bffab3afc9b09300b0974914a">CDBMSListboxView::SetListItemsL</a>(CDesCArrayFlat* aNewItems)
<a name="l00079"></a>00079     {
<a name="l00080"></a>00080     CTextListBoxModel* model = iListBox-&gt;Model();
<a name="l00081"></a>00081     model-&gt;SetItemTextArray(aNewItems);
<a name="l00082"></a>00082     <span class="comment">// Set ListBox model responsible for deleting the listItems array</span>
<a name="l00083"></a>00083     model-&gt;SetOwnershipType( ELbmOwnsItemArray );
<a name="l00084"></a>00084     iListBox-&gt;HandleItemAdditionL();
<a name="l00085"></a>00085     <span class="keywordflow">if</span>(aNewItems-&gt;Count()&gt;0)
<a name="l00086"></a>00086         {
<a name="l00087"></a>00087         <span class="comment">// Select the first item, if there is one.</span>
<a name="l00088"></a>00088         iListBox-&gt;SetCurrentItemIndexAndDraw(0);
<a name="l00089"></a>00089         }
<a name="l00090"></a>00090     }
<a name="l00091"></a>00091 
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00094"></a>00094 <span class="comment">// CDBMSListboxView::CDBMSListboxView()</span>
<a name="l00095"></a>00095 <span class="comment">//</span>
<a name="l00096"></a>00096 <span class="comment">// Constructor</span>
<a name="l00097"></a>00097 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00098"></a>00098 <span class="comment">//</span>
<a name="l00099"></a>00099 CDBMSListboxView::CDBMSListboxView()
<a name="l00100"></a>00100     {
<a name="l00101"></a>00101     <span class="comment">// No implementation required</span>
<a name="l00102"></a>00102     }
<a name="l00103"></a>00103 
<a name="l00104"></a>00104 
<a name="l00105"></a>00105 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00106"></a>00106 <span class="comment">// CDBMSListboxView::~CDBMSListboxView()</span>
<a name="l00107"></a>00107 <span class="comment">//</span>
<a name="l00108"></a>00108 <span class="comment">// Desctructor. Delete contained controls</span>
<a name="l00109"></a>00109 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00110"></a>00110 <span class="comment">//</span>
<a name="l00111"></a><a class="code" href="class_c_d_b_m_s_listbox_view.html#ab5c081351e65689c70982104c2a4e903">00111</a> <a class="code" href="class_c_d_b_m_s_listbox_view.html#ab5c081351e65689c70982104c2a4e903">CDBMSListboxView::~CDBMSListboxView</a>()
<a name="l00112"></a>00112     {
<a name="l00113"></a>00113     <span class="keyword">delete</span> iLabel;
<a name="l00114"></a>00114     <span class="keyword">delete</span> iListBox;
<a name="l00115"></a>00115     }
<a name="l00116"></a>00116 
<a name="l00117"></a>00117 
<a name="l00118"></a>00118 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00119"></a>00119 <span class="comment">// CDBMSAppUi::Draw()</span>
<a name="l00120"></a>00120 <span class="comment">//</span>
<a name="l00121"></a>00121 <span class="comment">// Draw the view background. This is called by the framework, when necessary.</span>
<a name="l00122"></a>00122 <span class="comment">//</span>
<a name="l00123"></a>00123 <span class="comment">// Note: The framework will draw the contained controls (label and the listbox)</span>
<a name="l00124"></a>00124 <span class="comment">// by using CountComponentControls() and ComponentControl() methods.</span>
<a name="l00125"></a>00125 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00126"></a>00126 <span class="comment">//</span>
<a name="l00127"></a><a class="code" href="class_c_d_b_m_s_listbox_view.html#ab3a47a0f42d7e6c6bf5e59882b24caa5">00127</a> <span class="keywordtype">void</span> <a class="code" href="class_c_d_b_m_s_listbox_view.html#ab3a47a0f42d7e6c6bf5e59882b24caa5">CDBMSListboxView::Draw</a>(<span class="keyword">const</span> TRect&amp; <span class="comment">/*aRect*/</span>)<span class="keyword"> const</span>
<a name="l00128"></a>00128 <span class="keyword">    </span>{
<a name="l00129"></a>00129     <span class="comment">//Clear the screen</span>
<a name="l00130"></a>00130     CWindowGc&amp; gc = SystemGc();
<a name="l00131"></a>00131     gc.Clear(Rect());
<a name="l00132"></a>00132     }
<a name="l00133"></a>00133 
<a name="l00134"></a>00134 
<a name="l00135"></a>00135 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00136"></a>00136 <span class="comment">// CDBMSListboxView::SizeChanged()</span>
<a name="l00137"></a>00137 <span class="comment">//</span>
<a name="l00138"></a>00138 <span class="comment">// Specify locations and sizes of the label and listbox. Called by</span>
<a name="l00139"></a>00139 <span class="comment">// the framework when the view size is changed</span>
<a name="l00140"></a>00140 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00141"></a>00141 <span class="comment">//</span>
<a name="l00142"></a><a class="code" href="class_c_d_b_m_s_listbox_view.html#a88ee1438bf69d34a5e25bf573dd3f036">00142</a> <span class="keywordtype">void</span> <a class="code" href="class_c_d_b_m_s_listbox_view.html#a88ee1438bf69d34a5e25bf573dd3f036">CDBMSListboxView::SizeChanged</a>()
<a name="l00143"></a>00143     {
<a name="l00144"></a>00144 
<a name="l00145"></a>00145         TRect containerRect = Rect(); <span class="comment">// Rect of the container</span>
<a name="l00146"></a>00146 
<a name="l00147"></a>00147         TSize labelSize = iLabel-&gt;MinimumSize();
<a name="l00148"></a>00148 
<a name="l00149"></a>00149         <span class="comment">// Show the label in the upper part of the screen and in whole</span>
<a name="l00150"></a>00150         <span class="comment">// screen width</span>
<a name="l00151"></a>00151         iLabel-&gt;SetExtent( TPoint(5,2),
<a name="l00152"></a>00152                            TSize(containerRect.Width(), labelSize.iHeight) );
<a name="l00153"></a>00153 
<a name="l00154"></a>00154         <span class="comment">// Fill the rest (bottom) of the screen with listbox</span>
<a name="l00155"></a>00155         iListBox-&gt;SetExtent( TPoint(5,labelSize.iHeight + 5 ),
<a name="l00156"></a>00156             TSize( containerRect.Width(),
<a name="l00157"></a>00157                    containerRect.Height()-labelSize.iHeight ) );
<a name="l00158"></a>00158                    
<a name="l00159"></a>00159     }
<a name="l00160"></a>00160 
<a name="l00161"></a>00161 
<a name="l00162"></a>00162 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00163"></a>00163 <span class="comment">// CDBMSListboxView::CountComponentControls()</span>
<a name="l00164"></a>00164 <span class="comment">//</span>
<a name="l00165"></a>00165 <span class="comment">// Return number of contained controls.</span>
<a name="l00166"></a>00166 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00167"></a>00167 <span class="comment">//</span>
<a name="l00168"></a><a class="code" href="class_c_d_b_m_s_listbox_view.html#a9fa2fb0202add3a56efa3b87dcd047c1">00168</a> TInt <a class="code" href="class_c_d_b_m_s_listbox_view.html#a9fa2fb0202add3a56efa3b87dcd047c1">CDBMSListboxView::CountComponentControls</a>()<span class="keyword"> const</span>
<a name="l00169"></a>00169 <span class="keyword">    </span>{
<a name="l00170"></a>00170         <span class="keywordflow">return</span> 2; <span class="comment">// Label and listbox</span>
<a name="l00171"></a>00171     }
<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">// CDBMSListboxView::ComponentControl()</span>
<a name="l00176"></a>00176 <span class="comment">//</span>
<a name="l00177"></a>00177 <span class="comment">// Return owned controls to framework so it will draw them.</span>
<a name="l00178"></a>00178 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00179"></a>00179 <span class="comment">//</span>
<a name="l00180"></a><a class="code" href="class_c_d_b_m_s_listbox_view.html#afcba97b98e792a7573984944fc84276c">00180</a> CCoeControl* <a class="code" href="class_c_d_b_m_s_listbox_view.html#afcba97b98e792a7573984944fc84276c">CDBMSListboxView::ComponentControl</a>(TInt aIndex)<span class="keyword"> const</span>
<a name="l00181"></a>00181 <span class="keyword">    </span>{
<a name="l00182"></a>00182     <span class="keywordflow">switch</span> ( aIndex )
<a name="l00183"></a>00183         {
<a name="l00184"></a>00184         <span class="keywordflow">case</span> 0:
<a name="l00185"></a>00185             <span class="keywordflow">return</span> iLabel;
<a name="l00186"></a>00186         <span class="keywordflow">case</span> 1:
<a name="l00187"></a>00187             <span class="keywordflow">return</span> iListBox;
<a name="l00188"></a>00188         <span class="keywordflow">default</span>:
<a name="l00189"></a>00189             <span class="keywordflow">return</span> NULL;
<a name="l00190"></a>00190         }
<a name="l00191"></a>00191     }
<a name="l00192"></a>00192 
<a name="l00193"></a>00193 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00194"></a>00194 <span class="comment">// CDBMSListboxView::OfferKeyEventL()</span>
<a name="l00195"></a>00195 <span class="comment">//</span>
<a name="l00196"></a>00196 <span class="comment">// Handle key events. Let the listbox handle the key events.</span>
<a name="l00197"></a>00197 <span class="comment">//</span>
<a name="l00198"></a>00198 <span class="comment">// AppUi must add this control to control stack to ensure key events are</span>
<a name="l00199"></a>00199 <span class="comment">// received and this method is called.</span>
<a name="l00200"></a>00200 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00201"></a>00201 <span class="comment">//</span>
<a name="l00202"></a><a class="code" href="class_c_d_b_m_s_listbox_view.html#a50cb1de235fa9feb7a9f7bd16a96db31">00202</a> TKeyResponse <a class="code" href="class_c_d_b_m_s_listbox_view.html#a50cb1de235fa9feb7a9f7bd16a96db31">CDBMSListboxView::OfferKeyEventL</a>(<span class="keyword">const</span> TKeyEvent&amp; aKeyEvent,
<a name="l00203"></a>00203     TEventCode aType)
<a name="l00204"></a>00204     {
<a name="l00205"></a>00205         <span class="keywordflow">return</span> iListBox-&gt;OfferKeyEventL( aKeyEvent, aType );
<a name="l00206"></a>00206     }
<a name="l00207"></a>00207 
<a name="l00208"></a>00208 
<a name="l00209"></a>00209 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00210"></a>00210 <span class="comment">// CDBMSListboxView::GetSelectedItem()</span>
<a name="l00211"></a>00211 <span class="comment">//</span>
<a name="l00212"></a>00212 <span class="comment">// Get name of the selected item in the listbox.</span>
<a name="l00213"></a>00213 <span class="comment">// ---------------------------------------------------------------------------</span>
<a name="l00214"></a>00214 <span class="comment">//</span>
<a name="l00215"></a><a class="code" href="class_c_d_b_m_s_listbox_view.html#a0df7d5e7a352bacec3bf84e7f487d1ad">00215</a> TInt <a class="code" href="class_c_d_b_m_s_listbox_view.html#a0df7d5e7a352bacec3bf84e7f487d1ad">CDBMSListboxView::GetSelectedItem</a>(TDes&amp; aResult)<span class="keyword"> const</span>
<a name="l00216"></a>00216 <span class="keyword">    </span>{
<a name="l00217"></a>00217     CTextListBoxModel* model = iListBox-&gt;Model();
<a name="l00218"></a>00218     <span class="keywordflow">if</span>(model-&gt;NumberOfItems()==0)
<a name="l00219"></a>00219         {
<a name="l00220"></a>00220         <span class="keywordflow">return</span> KErrNotFound;
<a name="l00221"></a>00221         }
<a name="l00222"></a>00222 
<a name="l00223"></a>00223     aResult.Copy(model-&gt;ItemText(iListBox-&gt;CurrentItemIndex()));
<a name="l00224"></a>00224     <span class="keywordflow">return</span> KErrNone;
<a name="l00225"></a>00225     }
<a name="l00226"></a>00226 
<a name="l00227"></a>00227 <span class="comment">//EOF</span>
</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>