Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_task_manager_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: CTaskManagerAppUi 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>CTaskManagerAppUi Class Reference</h1><!-- doxytag: class="CTaskManagerAppUi" -->
<p><a href="class_c_task_manager_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_task_manager_app_ui.html#a43c2e1e6cfcfa0411d5f2e36acc974aa">ConstructL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_app_ui.html#a3fca7ecf4116dc18d8c3810226a0f63d">~CTaskManagerAppUi</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_c_task_manager_engine.html">CTaskManagerEngine</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_app_ui.html#adcfb1c96ab3e4192a8f74e94db33a5df">Model</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_app_ui.html#abdc7a4c7340d97f4dfaa839ce5fc0b72">ShowConnectingCbaL</a> (const TBool &aShow)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_app_ui.html#aebc6058f351af6c9ffc7ed49ab4ff23e">SetViewBusyL</a> (const TBool &aBusy)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_app_ui.html#a038abf1cade1e3d4986c9751f9dfb663">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_task_manager_app_ui.html#a62ad4ee556c12b81c838fea02a0b5e8b">HandleForegroundEventL</a> (TBool aForeground)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Application UI class. Provides support for the following features:</p>
<ul>
<li>EIKON control architecture </li>
</ul>
<p>Definition at line <a class="el" href="_task_manager_app_ui_8h_source.html#l00033">33</a> of file <a class="el" href="_task_manager_app_ui_8h_source.html">TaskManagerAppUi.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3fca7ecf4116dc18d8c3810226a0f63d"></a><!-- doxytag: member="CTaskManagerAppUi::~CTaskManagerAppUi" ref="a3fca7ecf4116dc18d8c3810226a0f63d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTaskManagerAppUi::~CTaskManagerAppUi </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="_task_manager_app_ui_8cpp_source.html#l00110">110</a> of file <a class="el" href="_task_manager_app_ui_8cpp_source.html">TaskManagerAppUi.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a43c2e1e6cfcfa0411d5f2e36acc974aa"></a><!-- doxytag: member="CTaskManagerAppUi::ConstructL" ref="a43c2e1e6cfcfa0411d5f2e36acc974aa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerAppUi::ConstructL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Symbian OS default constructor. </p>
<p>Definition at line <a class="el" href="_task_manager_app_ui_8cpp_source.html#l00034">34</a> of file <a class="el" href="_task_manager_app_ui_8cpp_source.html">TaskManagerAppUi.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="adcfb1c96ab3e4192a8f74e94db33a5df"></a><!-- doxytag: member="CTaskManagerAppUi::Model" ref="adcfb1c96ab3e4192a8f74e94db33a5df" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_task_manager_engine.html">CTaskManagerEngine</a> & CTaskManagerAppUi::Model </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns reference to engine, which handles transactions. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to engine. </dd></dl>
<p>Definition at line <a class="el" href="_task_manager_app_ui_8cpp_source.html#l00211">211</a> of file <a class="el" href="_task_manager_app_ui_8cpp_source.html">TaskManagerAppUi.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abdc7a4c7340d97f4dfaa839ce5fc0b72"></a><!-- doxytag: member="CTaskManagerAppUi::ShowConnectingCbaL" ref="abdc7a4c7340d97f4dfaa839ce5fc0b72" args="(const TBool &aShow)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerAppUi::ShowConnectingCbaL </td>
<td>(</td>
<td class="paramtype">const TBool & </td>
<td class="paramname"> <em>aShow</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shows proper cba buttons according to the given boolean. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aShow</em> </td><td>defines whether only a cancel button (ETrue) or options and exit buttons are shown. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_task_manager_app_ui_8cpp_source.html#l00222">222</a> of file <a class="el" href="_task_manager_app_ui_8cpp_source.html">TaskManagerAppUi.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aebc6058f351af6c9ffc7ed49ab4ff23e"></a><!-- doxytag: member="CTaskManagerAppUi::SetViewBusyL" ref="aebc6058f351af6c9ffc7ed49ab4ff23e" args="(const TBool &aBusy)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerAppUi::SetViewBusyL </td>
<td>(</td>
<td class="paramtype">const TBool & </td>
<td class="paramname"> <em>aBusy</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>AppView can inform the AppUi that it is busy doing something (like showing a query dialog). While AppView is busy, AppUi makes sure that engine won't update tasks automatically. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aBusy</em> </td><td>defines whether the view is busy or not. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_task_manager_app_ui_8cpp_source.html#l00291">291</a> of file <a class="el" href="_task_manager_app_ui_8cpp_source.html">TaskManagerAppUi.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a038abf1cade1e3d4986c9751f9dfb663"></a><!-- doxytag: member="CTaskManagerAppUi::HandleCommandL" ref="a038abf1cade1e3d4986c9751f9dfb663" args="(TInt aCommand)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerAppUi::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>From CEikAppUi, takes care of command handling. </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="_task_manager_app_ui_8cpp_source.html#l00126">126</a> of file <a class="el" href="_task_manager_app_ui_8cpp_source.html">TaskManagerAppUi.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a62ad4ee556c12b81c838fea02a0b5e8b"></a><!-- doxytag: member="CTaskManagerAppUi::HandleForegroundEventL" ref="a62ad4ee556c12b81c838fea02a0b5e8b" args="(TBool aForeground)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerAppUi::HandleForegroundEventL </td>
<td>(</td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aForeground</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>From CEikAppUi, called when application switches to or from the foreground. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aForeground</em> </td><td>ETrue to switch to the foreground. EFalse to switch from the foreground. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_task_manager_app_ui_8cpp_source.html#l00188">188</a> of file <a class="el" href="_task_manager_app_ui_8cpp_source.html">TaskManagerAppUi.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>