Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_handler_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: CHandlerAppUi 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>CHandlerAppUi Class Reference</h1><!-- doxytag: class="CHandlerAppUi" -->
<p><a href="class_c_handler_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_handler_app_ui.html#aa548d313175dd5b99fdb60d155bbfef3">ConstructL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_handler_app_ui.html#a99438591ec85afac47356e75e5196960">CHandlerAppUi</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_handler_app_ui.html#a7f08e522fc283c4797f43a36e6e44cff">~CHandlerAppUi</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac85bae6076d39f2a2843d1774f81f10"></a><!-- doxytag: member="CHandlerAppUi::SetFileData" ref="aac85bae6076d39f2a2843d1774f81f10" args="(TFileName &aFileName, TDes8 &aData)" -->
void </td><td class="memItemRight" valign="bottom"><b>SetFileData</b> (TFileName &aFileName, TDes8 &aData)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_handler_app_ui.html#ae18d4c05000f0ad0f6b901de5f9c5e09">OpenFileL</a> (const TDesC &aFileName)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_handler_app_ui.html#a5a8e266ddd6a70da8bc709f89369d85e">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_handler_app_ui.html#a6482d65b27f5685965922b80a996b18a">HandleResourceChangeL</a> (TInt aType)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_handler_app_ui.html#a5420d5da910b47d409106e0c8bc2f0ff">ProcessCommandParametersL</a> (TApaCommand aCommand, TFileName &aDocumentName)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_handler_app_ui.html#a716e15fd3d4286dcff0fb652c042db23">ProcessCommandParametersL</a> (TApaCommand aCommand, TFileName &aDocumentName, const TDesC8 &aTail)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An instance of class <a class="el" href="class_c_handler_app_ui.html">CHandlerAppUi</a> is the UserInterface part of the AVKON application framework for the handler example application </p>
<p>Definition at line <a class="el" href="handler_appui_8h_source.html#l00023">23</a> of file <a class="el" href="handler_appui_8h_source.html">handlerAppui.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a99438591ec85afac47356e75e5196960"></a><!-- doxytag: member="CHandlerAppUi::CHandlerAppUi" ref="a99438591ec85afac47356e75e5196960" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CHandlerAppUi::CHandlerAppUi </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_handler_app_ui.html">CHandlerAppUi</a></p>
<p>Perform the first phase of two phase construction. This needs to be public due to the way the framework constructs the AppUi </p>
<p>Definition at line <a class="el" href="handler_appui_8cpp_source.html#l00058">58</a> of file <a class="el" href="handler_appui_8cpp_source.html">handlerAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7f08e522fc283c4797f43a36e6e44cff"></a><!-- doxytag: member="CHandlerAppUi::~CHandlerAppUi" ref="a7f08e522fc283c4797f43a36e6e44cff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CHandlerAppUi::~CHandlerAppUi </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>~CHandlerAppUi</p>
<p>Destroy the object and release all memory objects </p>
<p>Definition at line <a class="el" href="handler_appui_8cpp_source.html#l00063">63</a> of file <a class="el" href="handler_appui_8cpp_source.html">handlerAppui.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa548d313175dd5b99fdb60d155bbfef3"></a><!-- doxytag: member="CHandlerAppUi::ConstructL" ref="aa548d313175dd5b99fdb60d155bbfef3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CHandlerAppUi::ConstructL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ConstructL</p>
<p>Perform the second phase construction of a <a class="el" href="class_c_handler_app_ui.html">CHandlerAppUi</a> object this needs to be public due to the way the framework constructs the AppUi </p>
<p>Definition at line <a class="el" href="handler_appui_8cpp_source.html#l00033">33</a> of file <a class="el" href="handler_appui_8cpp_source.html">handlerAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae18d4c05000f0ad0f6b901de5f9c5e09"></a><!-- doxytag: member="CHandlerAppUi::OpenFileL" ref="ae18d4c05000f0ad0f6b901de5f9c5e09" args="(const TDesC &aFileName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CHandlerAppUi::OpenFileL </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aFileName</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>From CAknAppUi, handles file change. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aFileName</em> </td><td>New file to be opened. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="handler_appui_8cpp_source.html#l00143">143</a> of file <a class="el" href="handler_appui_8cpp_source.html">handlerAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5a8e266ddd6a70da8bc709f89369d85e"></a><!-- doxytag: member="CHandlerAppUi::HandleCommandL" ref="a5a8e266ddd6a70da8bc709f89369d85e" args="(TInt aCommand)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CHandlerAppUi::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>See CAknAppUi </p>
<p>Definition at line <a class="el" href="handler_appui_8cpp_source.html#l00081">81</a> of file <a class="el" href="handler_appui_8cpp_source.html">handlerAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6482d65b27f5685965922b80a996b18a"></a><!-- doxytag: member="CHandlerAppUi::HandleResourceChangeL" ref="a6482d65b27f5685965922b80a996b18a" args="(TInt aType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CHandlerAppUi::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>See CAknAppUi </p>
<p>Definition at line <a class="el" href="handler_appui_8cpp_source.html#l00115">115</a> of file <a class="el" href="handler_appui_8cpp_source.html">handlerAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5420d5da910b47d409106e0c8bc2f0ff"></a><!-- doxytag: member="CHandlerAppUi::ProcessCommandParametersL" ref="a5420d5da910b47d409106e0c8bc2f0ff" args="(TApaCommand aCommand, TFileName &aDocumentName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CHandlerAppUi::ProcessCommandParametersL </td>
<td>(</td>
<td class="paramtype">TApaCommand </td>
<td class="paramname"> <em>aCommand</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TFileName & </td>
<td class="paramname"> <em>aDocumentName</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See CAknAppUi </p>
<p>Definition at line <a class="el" href="handler_appui_8cpp_source.html#l00130">130</a> of file <a class="el" href="handler_appui_8cpp_source.html">handlerAppui.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a716e15fd3d4286dcff0fb652c042db23"></a><!-- doxytag: member="CHandlerAppUi::ProcessCommandParametersL" ref="a716e15fd3d4286dcff0fb652c042db23" args="(TApaCommand aCommand, TFileName &aDocumentName, const TDesC8 &aTail)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CHandlerAppUi::ProcessCommandParametersL </td>
<td>(</td>
<td class="paramtype">TApaCommand </td>
<td class="paramname"> <em>aCommand</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TFileName & </td>
<td class="paramname"> <em>aDocumentName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC8 & </td>
<td class="paramname"> <em>aTail</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See CAknAppUi </p>
<p>Definition at line <a class="el" href="handler_appui_8cpp_source.html#l00135">135</a> of file <a class="el" href="handler_appui_8cpp_source.html">handlerAppui.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>