Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_s_m_s_example_app_ui.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: CSMSExampleAppUi 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>CSMSExampleAppUi Class Reference</h1><!-- doxytag: class="CSMSExampleAppUi" --><!-- doxytag: inherits="MSmsEngineObserver" -->
<p>Inherits <a class="el" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a>.</p>
<p><a href="class_c_s_m_s_example_app_ui-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_s_m_s_example_app_ui.html#a44611e774c5a5d618d9cd083579bc6d4">ConstructL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_app_ui.html#a81b73f109e4d4525d253aa21953b253e">~CSMSExampleAppUi</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_app_ui.html#ae292f7b9c356d224aafa380693bbe24e">GetAddressL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_app_ui.html#a1e5b5c3b25caf18588ae09fc0344bf80">QueryMessageL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_app_ui.html#ab5cf37b6cf7fa57be20850a15856538f">QueryMessagesAndExecuteL</a> (TInt aMode, TMsvId aOriginFolderID, TMsvId aDestinationFolderID)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_app_ui.html#a179ce0f6af46df630d7c5f7378d93b65">ShowMessageL</a> (const TDesC &aMsg) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_app_ui.html#a390de7b831218e12fa3a0188c7ebbd39">ShowErrorL</a> (TInt aErrorCode) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_app_ui.html#ac7782a59a80cea988f2267a8f4c7ccc7">SendingMessage</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a945e7c9a8769b31ba7c440992bb5e8d0"></a><!-- doxytag: member="CSMSExampleAppUi::MessageSent" ref="a945e7c9a8769b31ba7c440992bb5e8d0" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>MessageSent</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1e8b4bbf6bfeb6ba50fba525f0a822e"></a><!-- doxytag: member="CSMSExampleAppUi::MessageReceived" ref="ae1e8b4bbf6bfeb6ba50fba525f0a822e" args="(const TDesC &addr, const TDesC &msg)" -->
void </td><td class="memItemRight" valign="bottom"><b>MessageReceived</b> (const TDesC &addr, const TDesC &msg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab59b1dd9594ad7ce64db590f90883fec"></a><!-- doxytag: member="CSMSExampleAppUi::SmsEngineInitialized" ref="ab59b1dd9594ad7ce64db590f90883fec" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>SmsEngineInitialized</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68602dbcf5703c0d1e64c2b87a7be2d3"></a><!-- doxytag: member="CSMSExampleAppUi::SmsEngineError" ref="a68602dbcf5703c0d1e64c2b87a7be2d3" args="(TInt aErrorCode)" -->
void </td><td class="memItemRight" valign="bottom"><b>SmsEngineError</b> (TInt aErrorCode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a251eea802b49887fee22b4ad4337f382"></a><!-- doxytag: member="CSMSExampleAppUi::MessageDeleted" ref="a251eea802b49887fee22b4ad4337f382" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>MessageDeleted</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_app_ui.html#ab59304b4adee09c3c8cf56ee1332dc11">HandleResourceChangeL</a> (TInt aType)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Application UI class. </p>
<p>Definition at line <a class="el" href="_s_m_s_example_appui_8h_source.html#l00031">31</a> of file <a class="el" href="_s_m_s_example_appui_8h_source.html">SMSExampleAppui.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a81b73f109e4d4525d253aa21953b253e"></a><!-- doxytag: member="CSMSExampleAppUi::~CSMSExampleAppUi" ref="a81b73f109e4d4525d253aa21953b253e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSMSExampleAppUi::~CSMSExampleAppUi </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="_s_m_s_example_appui_8cpp_source.html#l00068">68</a> of file <a class="el" href="_s_m_s_example_appui_8cpp_source.html">SMSExampleAppui.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a44611e774c5a5d618d9cd083579bc6d4"></a><!-- doxytag: member="CSMSExampleAppUi::ConstructL" ref="a44611e774c5a5d618d9cd083579bc6d4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSMSExampleAppUi::ConstructL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>default constructor. </p>
<p>Definition at line <a class="el" href="_s_m_s_example_appui_8cpp_source.html#l00047">47</a> of file <a class="el" href="_s_m_s_example_appui_8cpp_source.html">SMSExampleAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae292f7b9c356d224aafa380693bbe24e"></a><!-- doxytag: member="CSMSExampleAppUi::GetAddressL" ref="ae292f7b9c356d224aafa380693bbe24e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CSMSExampleAppUi::GetAddressL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Query message address (recipient). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>dialog return value </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_appui_8cpp_source.html#l00094">94</a> of file <a class="el" href="_s_m_s_example_appui_8cpp_source.html">SMSExampleAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1e5b5c3b25caf18588ae09fc0344bf80"></a><!-- doxytag: member="CSMSExampleAppUi::QueryMessageL" ref="a1e5b5c3b25caf18588ae09fc0344bf80" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CSMSExampleAppUi::QueryMessageL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Query message body. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>dialog return value </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_appui_8cpp_source.html#l00103">103</a> of file <a class="el" href="_s_m_s_example_appui_8cpp_source.html">SMSExampleAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab5cf37b6cf7fa57be20850a15856538f"></a><!-- doxytag: member="CSMSExampleAppUi::QueryMessagesAndExecuteL" ref="ab5cf37b6cf7fa57be20850a15856538f" args="(TInt aMode, TMsvId aOriginFolderID, TMsvId aDestinationFolderID)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSMSExampleAppUi::QueryMessagesAndExecuteL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aMode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aOriginFolderID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aDestinationFolderID</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute one operation according to ListBox mode. </p>
<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>Mode of the ListBox. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aOriginFolderID</em> </td><td>Source folder of the operation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDestinationFolderID</em> </td><td>Target folder of the operation. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_appui_8cpp_source.html#l00257">257</a> of file <a class="el" href="_s_m_s_example_appui_8cpp_source.html">SMSExampleAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a179ce0f6af46df630d7c5f7378d93b65"></a><!-- doxytag: member="CSMSExampleAppUi::ShowMessageL" ref="a179ce0f6af46df630d7c5f7378d93b65" args="(const TDesC &aMsg) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSMSExampleAppUi::ShowMessageL </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aMsg</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Show a dialog containing the message </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aMsg</em> </td><td>the message </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_appui_8cpp_source.html#l00281">281</a> of file <a class="el" href="_s_m_s_example_appui_8cpp_source.html">SMSExampleAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a390de7b831218e12fa3a0188c7ebbd39"></a><!-- doxytag: member="CSMSExampleAppUi::ShowErrorL" ref="a390de7b831218e12fa3a0188c7ebbd39" args="(TInt aErrorCode) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSMSExampleAppUi::ShowErrorL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aErrorCode</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Show a dialog containing the error code </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aErrorCode</em> </td><td>the error code </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_appui_8cpp_source.html#l00273">273</a> of file <a class="el" href="_s_m_s_example_appui_8cpp_source.html">SMSExampleAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac7782a59a80cea988f2267a8f4c7ccc7"></a><!-- doxytag: member="CSMSExampleAppUi::SendingMessage" ref="ac7782a59a80cea988f2267a8f4c7ccc7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSMSExampleAppUi::SendingMessage </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>From <a class="el" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a> </p>
<p>Implements <a class="el" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a>.</p>
<p>Definition at line <a class="el" href="_s_m_s_example_appui_8cpp_source.html#l00307">307</a> of file <a class="el" href="_s_m_s_example_appui_8cpp_source.html">SMSExampleAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab59304b4adee09c3c8cf56ee1332dc11"></a><!-- doxytag: member="CSMSExampleAppUi::HandleResourceChangeL" ref="ab59304b4adee09c3c8cf56ee1332dc11" args="(TInt aType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSMSExampleAppUi::HandleResourceChangeL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aType</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>from CAknAppUiBase </p>
<p>Definition at line <a class="el" href="_s_m_s_example_appui_8cpp_source.html#l00288">288</a> of file <a class="el" href="_s_m_s_example_appui_8cpp_source.html">SMSExampleAppui.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>