Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_d_b_m_s_listbox_view.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: CDBMSListboxView Class Reference</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 -->
<div class="contents">
<h1>CDBMSListboxView Class Reference</h1><!-- doxytag: class="CDBMSListboxView" -->
<p><a href="class_c_d_b_m_s_listbox_view-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_m_s_listbox_view.html#ab5c081351e65689c70982104c2a4e903">~CDBMSListboxView</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_m_s_listbox_view.html#a5bf195c1c4b2688016cb7d88d58ea969">SetCaptionL</a> (const TDesC &aNewCaption)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_m_s_listbox_view.html#a48fe6a8bffab3afc9b09300b0974914a">SetListItemsL</a> (CDesCArrayFlat *aNewItems)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_m_s_listbox_view.html#a0df7d5e7a352bacec3bf84e7f487d1ad">GetSelectedItem</a> (TDes &aResult) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_m_s_listbox_view.html#ab3a47a0f42d7e6c6bf5e59882b24caa5">Draw</a> (const TRect &aRect) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_m_s_listbox_view.html#a88ee1438bf69d34a5e25bf573dd3f036">SizeChanged</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_m_s_listbox_view.html#a9fa2fb0202add3a56efa3b87dcd047c1">CountComponentControls</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CCoeControl * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_m_s_listbox_view.html#afcba97b98e792a7573984944fc84276c">ComponentControl</a> (TInt aIndex) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TKeyResponse </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_m_s_listbox_view.html#a50cb1de235fa9feb7a9f7bd16a96db31">OfferKeyEventL</a> (const TKeyEvent &aKeyEvent, TEventCode aType)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_d_b_m_s_listbox_view.html">CDBMSListboxView</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_m_s_listbox_view.html#a1187c6bce072aace1351910deb676690">NewL</a> (const TRect &aRect)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class: <a class="el" href="class_c_d_b_m_s_listbox_view.html">CDBMSListboxView</a></p>
<p>Description: An instance of this class is an Application View object for the DBMS example application.</p>
<p>This is window owning container control.It shows label and a single listbox. The listbox is used to</p>
<ul>
<li>show the columns of the Books table</li>
<li>show book names (titles) in the database </li>
</ul>
<p>Definition at line <a class="el" href="_d_b_m_s_listbox_view_8h_source.html#l00026">26</a> of file <a class="el" href="_d_b_m_s_listbox_view_8h_source.html">DBMSListboxView.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab5c081351e65689c70982104c2a4e903"></a><!-- doxytag: member="CDBMSListboxView::~CDBMSListboxView" ref="ab5c081351e65689c70982104c2a4e903" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CDBMSListboxView::~CDBMSListboxView </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function: ~CDBMSAppView</p>
<p>Description: Destroy the view object </p>
<p>Definition at line <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html#l00111">111</a> of file <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html">DBMSListboxView.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1187c6bce072aace1351910deb676690"></a><!-- doxytag: member="CDBMSListboxView::NewL" ref="a1187c6bce072aace1351910deb676690" args="(const TRect &aRect)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_d_b_m_s_listbox_view.html">CDBMSListboxView</a> * CDBMSListboxView::NewL </td>
<td>(</td>
<td class="paramtype">const TRect & </td>
<td class="paramname"> <em>aRect</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function: NewL</p>
<p>Description: Create a <a class="el" href="class_c_d_b_m_s_listbox_view.html">CDBMSListboxView</a> object, which will draw itself to aRect.</p>
<p>Param: aRect the rectangle this view will be drawn to</p>
<p>Returns: A pointer to the created instance of <a class="el" href="class_c_d_b_m_s_listbox_view.html">CDBMSListboxView</a> </p>
<p>Definition at line <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html#l00022">22</a> of file <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html">DBMSListboxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5bf195c1c4b2688016cb7d88d58ea969"></a><!-- doxytag: member="CDBMSListboxView::SetCaptionL" ref="a5bf195c1c4b2688016cb7d88d58ea969" args="(const TDesC &aNewCaption)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CDBMSListboxView::SetCaptionL </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aNewCaption</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function: SetCaptionL</p>
<p>Description: Sets new caption for the view.</p>
<p>Param: aNewCaption new value for the caption. </p>
<p>Definition at line <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html#l00064">64</a> of file <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html">DBMSListboxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a48fe6a8bffab3afc9b09300b0974914a"></a><!-- doxytag: member="CDBMSListboxView::SetListItemsL" ref="a48fe6a8bffab3afc9b09300b0974914a" args="(CDesCArrayFlat *aNewItems)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CDBMSListboxView::SetListItemsL </td>
<td>(</td>
<td class="paramtype">CDesCArrayFlat * </td>
<td class="paramname"> <em>aNewItems</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function: SetListItemsL</p>
<p>Description: Sets the list box items. The listbox takes ownership of the aNewItems array.</p>
<p>Param: aNewItems Array of descriptors to be shown in the listbox. </p>
<p>Definition at line <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html#l00078">78</a> of file <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html">DBMSListboxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0df7d5e7a352bacec3bf84e7f487d1ad"></a><!-- doxytag: member="CDBMSListboxView::GetSelectedItem" ref="a0df7d5e7a352bacec3bf84e7f487d1ad" args="(TDes &aResult) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CDBMSListboxView::GetSelectedItem </td>
<td>(</td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aResult</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function: GetSelectedItem</p>
<p>Description: Get name of the selected item in the listbox.</p>
<p>Param: aResult The result is placed here. Provide descriptor long enough.</p>
<p>Returns: KErrNone, if item was selected. KErrNotFound otherwise. </p>
<p>Definition at line <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html#l00215">215</a> of file <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html">DBMSListboxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab3a47a0f42d7e6c6bf5e59882b24caa5"></a><!-- doxytag: member="CDBMSListboxView::Draw" ref="ab3a47a0f42d7e6c6bf5e59882b24caa5" args="(const TRect &aRect) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CDBMSListboxView::Draw </td>
<td>(</td>
<td class="paramtype">const TRect & </td>
<td class="paramname"> <em>aRect</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function: Draw</p>
<p>Description: Paints this view (an empty rect). This is called by the framework, when view needs to redraw itself.</p>
<p>Param: aRect Frame rectangle for container. </p>
<p>Definition at line <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html#l00127">127</a> of file <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html">DBMSListboxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a88ee1438bf69d34a5e25bf573dd3f036"></a><!-- doxytag: member="CDBMSListboxView::SizeChanged" ref="a88ee1438bf69d34a5e25bf573dd3f036" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CDBMSListboxView::SizeChanged </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function: SizeChanged</p>
<p>Description: Determines controls' sizes according to current state. </p>
<p>Definition at line <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html#l00142">142</a> of file <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html">DBMSListboxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9fa2fb0202add3a56efa3b87dcd047c1"></a><!-- doxytag: member="CDBMSListboxView::CountComponentControls" ref="a9fa2fb0202add3a56efa3b87dcd047c1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CDBMSListboxView::CountComponentControls </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function: CountComponentControls</p>
<p>Returns: Number of controls within this container. </p>
<p>Definition at line <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html#l00168">168</a> of file <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html">DBMSListboxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afcba97b98e792a7573984944fc84276c"></a><!-- doxytag: member="CDBMSListboxView::ComponentControl" ref="afcba97b98e792a7573984944fc84276c" args="(TInt aIndex) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCoeControl * CDBMSListboxView::ComponentControl </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aIndex</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function: ComponentControl</p>
<p>Param: aIndex of control</p>
<p>Returns: One of the controls this class owns. </p>
<p>Definition at line <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html#l00180">180</a> of file <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html">DBMSListboxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a50cb1de235fa9feb7a9f7bd16a96db31"></a><!-- doxytag: member="CDBMSListboxView::OfferKeyEventL" ref="a50cb1de235fa9feb7a9f7bd16a96db31" args="(const TKeyEvent &aKeyEvent, TEventCode aType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TKeyResponse CDBMSListboxView::OfferKeyEventL </td>
<td>(</td>
<td class="paramtype">const TKeyEvent & </td>
<td class="paramname"> <em>aKeyEvent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TEventCode </td>
<td class="paramname"> <em>aType</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function: OfferKeyEventL</p>
<p>Description: Handles key events for this control. Forwards them to listbox</p>
<p>Param: aKeyEvent The key event.</p>
<p>Param: aType The type of the event.</p>
<p>Returns: Indicates whether or not the key event was used (consumed) by this control. </p>
<p>Definition at line <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html#l00202">202</a> of file <a class="el" href="_d_b_m_s_listbox_view_8cpp_source.html">DBMSListboxView.cpp</a>.</p>
</div>
</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>