Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_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: CListboxView 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>CListboxView Class Reference</h1><!-- doxytag: class="CListboxView" -->
<p><a href="class_c_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_listbox_view.html#a29c27380408a2a5cc71f2e899976104a">~CListboxView</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listbox_view.html#aae097e538eab238bc0347b0b4dc894a1">SetListBoxMode</a> (TInt aMode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listbox_view.html#a7d758680b3ed57ad7356027e3accdf83">InitializeListBoxL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listbox_view.html#af703b20a0981a743387c2dde4d38bd45">SetFolderID</a> (TMsvId aFolderID)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listbox_view.html#af86e13e5917bcaade6d7c3e1f64bd20b">SetTargetFolderID</a> (TMsvId aTargetFolderID)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TUid </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listbox_view.html#a05e5e49fe239bb0b08306129737c140c">Id</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listbox_view.html#a3e906bd96106e3d79554c5ea707862fe">HandleCommandL</a> (TInt aCommand)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listbox_view.html#a117a2ea97fe26ced10cbb93f79094c5f">DoActivateL</a> (const TVwsViewId &aPrevViewId, TUid aCustomMessageId, const TDesC8 &aCustomMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listbox_view.html#a549d6b5ded76da7f5ff08496b216b294">DoDeactivate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listbox_view.html#a0bcf37a713ad5861f58bba1c4e194145">HandleClientRectChange</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd04b634529e2d32d9112e8585c9762b"></a><!-- doxytag: member="CListboxView::HandleResourceChangeL" ref="afd04b634529e2d32d9112e8585c9762b" args="(TInt aType)" -->
void </td><td class="memItemRight" valign="bottom"><b>HandleResourceChangeL</b> (TInt aType)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03de54d4364512570b06bec9aa855c13"></a><!-- doxytag: member="CListboxView::SizeChanged" ref="a03de54d4364512570b06bec9aa855c13" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>SizeChanged</b> ()</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_listbox_view.html">CListboxView</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listbox_view.html#a78493d402358793b862569a8d9a7ed0d">NewL</a> (<a class="el" href="class_c_sms_engine.html">CSmsEngine</a> *aEngine, <a class="el" href="class_c_log_view.html">CLogView</a> *aView1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_listbox_view.html">CListboxView</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listbox_view.html#a35c786db041d911f8e5bd044e387f669">NewLC</a> (<a class="el" href="class_c_sms_engine.html">CSmsEngine</a> *aEngine, <a class="el" href="class_c_log_view.html">CLogView</a> *aView1)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>ListBox view.</p>
<p>Improvement would be to get a rid of reference to engine and implement MVC. </p>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8h_source.html#l00024">24</a> of file <a class="el" href="_s_m_s_example_list_box_view_8h_source.html">SMSExampleListBoxView.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a29c27380408a2a5cc71f2e899976104a"></a><!-- doxytag: member="CListboxView::~CListboxView" ref="a29c27380408a2a5cc71f2e899976104a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CListboxView::~CListboxView </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy the object </p>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00068">68</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a78493d402358793b862569a8d9a7ed0d"></a><!-- doxytag: member="CListboxView::NewL" ref="a78493d402358793b862569a8d9a7ed0d" args="(CSmsEngine *aEngine, CLogView *aView1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_listbox_view.html">CListboxView</a> * CListboxView::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_sms_engine.html">CSmsEngine</a> * </td>
<td class="paramname"> <em>aEngine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_c_log_view.html">CLogView</a> * </td>
<td class="paramname"> <em>aView1</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="class_c_listbox_view.html">CListboxView</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aEngine</em> </td><td>Pointer to <a class="el" href="class_c_sms_engine.html">CSmsEngine</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aView1</em> </td><td>Pointer to <a class="el" href="class_c_log_view.html">CLogView</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the created instance of <a class="el" href="class_c_listbox_view.html">CListboxView</a>. </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00030">30</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a35c786db041d911f8e5bd044e387f669"></a><!-- doxytag: member="CListboxView::NewLC" ref="a35c786db041d911f8e5bd044e387f669" args="(CSmsEngine *aEngine, CLogView *aView1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_listbox_view.html">CListboxView</a> * CListboxView::NewLC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_sms_engine.html">CSmsEngine</a> * </td>
<td class="paramname"> <em>aEngine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_c_log_view.html">CLogView</a> * </td>
<td class="paramname"> <em>aView1</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="class_c_listbox_view.html">CListboxView</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aEngine</em> </td><td>Pointer to <a class="el" href="class_c_sms_engine.html">CSmsEngine</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aView1</em> </td><td>Pointer to <a class="el" href="class_c_log_view.html">CLogView</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the created instance of <a class="el" href="class_c_listbox_view.html">CListboxView</a>. </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00043">43</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aae097e538eab238bc0347b0b4dc894a1"></a><!-- doxytag: member="CListboxView::SetListBoxMode" ref="aae097e538eab238bc0347b0b4dc894a1" args="(TInt aMode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListboxView::SetListBoxMode </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aMode</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set ListBoxMode (delete, copy, move). </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="_s_m_s_example_8hrh_source.html">SMSExample.hrh</a>. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aMode</em> </td><td>ListBox mode. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00192">192</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7d758680b3ed57ad7356027e3accdf83"></a><!-- doxytag: member="CListboxView::InitializeListBoxL" ref="a7d758680b3ed57ad7356027e3accdf83" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListboxView::InitializeListBoxL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load source folder messages into ListBox. </p>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00136">136</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af703b20a0981a743387c2dde4d38bd45"></a><!-- doxytag: member="CListboxView::SetFolderID" ref="af703b20a0981a743387c2dde4d38bd45" args="(TMsvId aFolderID)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListboxView::SetFolderID </td>
<td>(</td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aFolderID</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set source folder (from which copy or move is performed). </p>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00125">125</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af86e13e5917bcaade6d7c3e1f64bd20b"></a><!-- doxytag: member="CListboxView::SetTargetFolderID" ref="af86e13e5917bcaade6d7c3e1f64bd20b" args="(TMsvId aTargetFolderID)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListboxView::SetTargetFolderID </td>
<td>(</td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aTargetFolderID</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set target folder (to which folder copy or move is targeted). </p>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00202">202</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a05e5e49fe239bb0b08306129737c140c"></a><!-- doxytag: member="CListboxView::Id" ref="a05e5e49fe239bb0b08306129737c140c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TUid CListboxView::Id </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Identity of this view to the system. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the ID of view. </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00092">92</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3e906bd96106e3d79554c5ea707862fe"></a><!-- doxytag: member="CListboxView::HandleCommandL" ref="a3e906bd96106e3d79554c5ea707862fe" args="(TInt aCommand)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListboxView::HandleCommandL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aCommand</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handle a user command. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aCommand</em> </td><td>Command to be handled. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00301">301</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a117a2ea97fe26ced10cbb93f79094c5f"></a><!-- doxytag: member="CListboxView::DoActivateL" ref="a117a2ea97fe26ced10cbb93f79094c5f" args="(const TVwsViewId &aPrevViewId, TUid aCustomMessageId, const TDesC8 &aCustomMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListboxView::DoActivateL </td>
<td>(</td>
<td class="paramtype">const TVwsViewId & </td>
<td class="paramname"> <em>aPrevViewId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TUid </td>
<td class="paramname"> <em>aCustomMessageId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC8 & </td>
<td class="paramname"> <em>aCustomMessage</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create the Container class object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aPrevViewId</em> </td><td>The id of the previous view. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aCustomMessageId</em> </td><td>message identifier. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aCustomMessage</em> </td><td>custom message provided when the view is changed. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00106">106</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a549d6b5ded76da7f5ff08496b216b294"></a><!-- doxytag: member="CListboxView::DoDeactivate" ref="a549d6b5ded76da7f5ff08496b216b294" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListboxView::DoDeactivate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the container class instance from the App UI's stack and deletes the instance. </p>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00177">177</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0bcf37a713ad5861f58bba1c4e194145"></a><!-- doxytag: member="CListboxView::HandleClientRectChange" ref="a0bcf37a713ad5861f58bba1c4e194145" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListboxView::HandleClientRectChange </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>From CAknView reaction if size change. </p>
<p>Definition at line <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html#l00212">212</a> of file <a class="el" href="_s_m_s_example_list_box_view_8cpp_source.html">SMSExampleListBoxView.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>