Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_markable_list_container.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: CMarkableListContainer 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>CMarkableListContainer Class Reference</h1><!-- doxytag: class="CMarkableListContainer" -->
<p><a href="class_c_markable_list_container-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_markable_list_container.html#a5747f1d73ae260eb58296703caa65f67">SetArraysL</a> (CDesCArrayFlat *aAddress, CDesCArrayFlat *aMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_markable_list_container.html#a098478c485704cf8f9d3dea5947c90a7">SetIdArray</a> (RArray< TMsvId > *aArray)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_markable_list_container.html#a8b913c8e2219239a985c62406258ae95">MarkAllL</a> (TBool aSelectionMode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">RArray< TMsvId > * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_markable_list_container.html#a33290384da240b832c560970c8659fa8">GetSelectedItems</a> ()</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_markable_list_container.html">CMarkableListContainer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_markable_list_container.html#aef5ba6740ea596ddafdca687f1e13a54">NewL</a> (const TRect &aRect)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_markable_list_container.html">CMarkableListContainer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_markable_list_container.html#ada4e354b6d42db530a6852f0f4f2c455">NewLC</a> (const TRect &aRect)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Message ListBox. </p>
<p>Definition at line <a class="el" href="_s_m_s_example_markable_list_container_8h_source.html#l00021">21</a> of file <a class="el" href="_s_m_s_example_markable_list_container_8h_source.html">SMSExampleMarkableListContainer.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aef5ba6740ea596ddafdca687f1e13a54"></a><!-- doxytag: member="CMarkableListContainer::NewL" ref="aef5ba6740ea596ddafdca687f1e13a54" args="(const TRect &aRect)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_markable_list_container.html">CMarkableListContainer</a> * CMarkableListContainer::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>Create new <a class="el" href="class_c_markable_list_container.html">CMarkableListContainer</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>aRect</em> </td><td>Frame rectangle for container. </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_markable_list_container.html">CMarkableListContainer</a> </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html#l00342">342</a> of file <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html">SMSExampleMarkableListContainer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ada4e354b6d42db530a6852f0f4f2c455"></a><!-- doxytag: member="CMarkableListContainer::NewLC" ref="ada4e354b6d42db530a6852f0f4f2c455" args="(const TRect &aRect)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_markable_list_container.html">CMarkableListContainer</a> * CMarkableListContainer::NewLC </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>NewLC </p>
<p>Definition at line <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html#l00354">354</a> of file <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html">SMSExampleMarkableListContainer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5747f1d73ae260eb58296703caa65f67"></a><!-- doxytag: member="CMarkableListContainer::SetArraysL" ref="a5747f1d73ae260eb58296703caa65f67" args="(CDesCArrayFlat *aAddress, CDesCArrayFlat *aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMarkableListContainer::SetArraysL </td>
<td>(</td>
<td class="paramtype">CDesCArrayFlat * </td>
<td class="paramname"> <em>aAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CDesCArrayFlat * </td>
<td class="paramname"> <em>aMessage</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set SMS recipient and body arrays. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aAddress</em> </td><td>Array of SMS addressess </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aMessage</em> </td><td>Array of SMS bodys. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html#l00100">100</a> of file <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html">SMSExampleMarkableListContainer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a098478c485704cf8f9d3dea5947c90a7"></a><!-- doxytag: member="CMarkableListContainer::SetIdArray" ref="a098478c485704cf8f9d3dea5947c90a7" args="(RArray< TMsvId > *aArray)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMarkableListContainer::SetIdArray </td>
<td>(</td>
<td class="paramtype">RArray< TMsvId > * </td>
<td class="paramname"> <em>aArray</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set array of message Ids. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aArray</em> </td><td>Array of Ids. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html#l00454">454</a> of file <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html">SMSExampleMarkableListContainer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8b913c8e2219239a985c62406258ae95"></a><!-- doxytag: member="CMarkableListContainer::MarkAllL" ref="a8b913c8e2219239a985c62406258ae95" args="(TBool aSelectionMode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMarkableListContainer::MarkAllL </td>
<td>(</td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aSelectionMode</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Mark or unmark all ListBox items. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSelectionMode</em> </td><td>ETrue if all items should be marked, EFalse if unmarked. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html#l00117">117</a> of file <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html">SMSExampleMarkableListContainer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a33290384da240b832c560970c8659fa8"></a><!-- doxytag: member="CMarkableListContainer::GetSelectedItems" ref="a33290384da240b832c560970c8659fa8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RArray< TMsvId > * CMarkableListContainer::GetSelectedItems </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns all message ids which have been marked. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array of ids. </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html#l00464">464</a> of file <a class="el" href="_s_m_s_example_markable_list_container_8cpp_source.html">SMSExampleMarkableListContainer.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>