examples/S60CppExamples/ClientServerAsync/doc/class_c_c_s_async_app_ui.html

00001 "-//W3C//DTD HTML 4.0 Transitional//EN">
00002 
00003 
00004 
00005 "Content-Type" content="text/html;charset=iso-8859-1">
00006 <a class="code" href="class_c_c_s_async_app_ui.html">CCSAsyncAppUi</a> Class Reference
00007 "style.css" rel="stylesheet" type="text/css">
00008 
00009 
00010 "0" width="100%" height="8" bgcolor="#eeeeee">
00011 
 "100%" height="1">"2" color="#000000" face="Arial, Helvetica, sans-serif">
00012 S60 5th Edition SDK 
Example Applications Guide
 

00013 
00014 
class="tabs">
00015   

00020 
class="tabs">
00021   

00026 
CCSAsyncAppUi Class Reference
#include <class="el" href="csasyncappui_8h-source.html">csasyncappui.h>
00027 

00028 
Inheritance diagram for CCSAsyncAppUi:
00029 
"class_c_c_s_async_app_ui.png" usemap="#CCSAsyncAppUi_map" border="0" alt="">

00030 "CCSAsyncAppUi_map">
00031 "class_m_async_time_observer.html" alt="MAsyncTimeObserver" shape="rect" coords="149,0,288,24">
00032 
00033 "class_c_c_s_async_app_ui-members.html">List of all members.
"_details">
Detailed Description

00034 CCSAsyncAppUi An instance of class CCSAsyncAppUi is the UserInterface part of the AVKON application framework for the CSAsync example application 
00035 

00036 
00037 

00038 Definition at line "el" href="csasyncappui_8h-source.html#l00034">34 of file class="el" href="csasyncappui_8h-source.html">csasyncappui.h.
"0" cellpadding="0" cellspacing="0">
00039 00040 00041 00042 
00043 00044 
00045 00046 
00047 00048 
00049 00050 
00051 00052 
00053 00054 00055 
00056 00057 
00058 00059 00060 
00061 


"2">
Public Member Functions


class="memItemLeft" nowrap align="right" valign="top"> class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_app_ui.html#1145745dbcfc53f07104bf3b2041317c">CCSAsyncAppUi ()


class="memItemLeft" nowrap align="right" valign="top">virtual class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_app_ui.html#06a6b26206d4efb097029fdd4f06b116">~CCSAsyncAppUi ()


class="memItemLeft" nowrap align="right" valign="top">void class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_app_ui.html#a682d228622cea7790645ce10f591242">HandleCommandL (TInt aCommand)


class="memItemLeft" nowrap align="right" valign="top">void class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_app_ui.html#3ae77c2aed5e1270a13c14bd5aa415fe">DynInitMenuPaneL (TInt aResourceId, CEikMenuPane *aMenuPane)


class="memItemLeft" nowrap align="right" valign="top">void class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_app_ui.html#081e2db0d35721e6ad6d5d1d99fbbd83">HandleTimeUpdate ()


class="memItemLeft" nowrap align="right" valign="top">virtual void class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_app_ui.html#6acdbe8a9b57446075bf46d035e751eb">HandleResourceChangeL (TInt aType)


"2">
Private Member Functions


class="memItemLeft" nowrap align="right" valign="top">void class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_app_ui.html#9ce34ba0b947863222da3c63d0481044">ConstructL ()


class="memItemLeft" nowrap align="right" valign="top">class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument * class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_app_ui.html#1e0f1d7283b2cd8210c9d7ab96e93267">AsyncDocument () const 


"2">
Private Attributes


class="memItemLeft" nowrap align="right" valign="top">class="el" href="class_c_c_s_async_app_view.html">CCSAsyncAppView * class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_app_ui.html#45dd0a3e0e75e56b4727a01a8ef2c6b1">iAppView



00062 
Constructor & Destructor Documentation

00063 class="anchor" name="1145745dbcfc53f07104bf3b2041317c">

00064 
class="mdTable" cellpadding="2" cellspacing="0">
00065   00066     00077   00078 

class="mdRow">
00067       "0" cellspacing="0" border="0">
00068         00069           00070           00071           00072           00073           00074         00075       

class="md" nowrap valign="top">CCSAsyncAppUi::CCSAsyncAppUi           
class="md" valign="top">( 
class="mdname1" valign="top" nowrap>          
class="md" valign="top"> ) 
class="md" nowrap>




00076     		




00079 "5" cellpadding="0" border="0">
00080   00081     00084     00095   00096 


00082        
00083     

00085 
00086 

00087 CCSAsyncAppUi. C++ default constructor. This needs to be public due to the way the framework constructs the AppUi. 
00088 

00089 Definition at line class="el" href="csasyncappui_8cpp-source.html#l00035">35 of file class="el" href="csasyncappui_8cpp-source.html">csasyncappui.cpp.
class="fragment">
class="fragment">"l00036">00036     {
00090 "l00037">00037     class="comment">// No implementation required
00091 "l00038">00038     }
00092 

00093 

00094     





00097 class="anchor" name="06a6b26206d4efb097029fdd4f06b116">

00098 
class="mdTable" cellpadding="2" cellspacing="0">
00099   00100     00111   00112 

class="mdRow">
00101       "0" cellspacing="0" border="0">
00102         00103           00104           00105           00106           00107           00108         00109       

class="md" nowrap valign="top">CCSAsyncAppUi::~CCSAsyncAppUi           
class="md" valign="top">( 
class="mdname1" valign="top" nowrap>          
class="md" valign="top"> ) 
class="md" nowrap> [virtual]




00110     		




00113 "5" cellpadding="0" border="0">
00114   00115     00118     00136   00137 


00116        
00117     

00119 
00120 

00121 ~CCSAsyncAppUi. Destructor. Destroys the object and release all memory objects. 
00122 

00123 Definition at line class="el" href="csasyncappui_8cpp-source.html#l00059">59 of file class="el" href="csasyncappui_8cpp-source.html">csasyncappui.cpp.
00124 

00125 References class="el" href="csasyncappui_8h-source.html#l00103">iAppView.
class="fragment">
class="fragment">"l00060">00060     {
00126 "l00061">00061     class="keywordflow">if ( class="code" href="class_c_c_s_async_app_ui.html#45dd0a3e0e75e56b4727a01a8ef2c6b1">iAppView )
00127 "l00062">00062         {
00128 "l00063">00063         iEikonEnv->RemoveFromStack( class="code" href="class_c_c_s_async_app_ui.html#45dd0a3e0e75e56b4727a01a8ef2c6b1">iAppView );
00129 "l00064">00064         class="keyword">delete iAppView;
00130 "l00065">00065         iAppView = NULL;
00131 "l00066">00066         }
00132 "l00067">00067     }
00133 

00134 

00135     





00138 
Member Function Documentation

00139 class="anchor" name="a682d228622cea7790645ce10f591242">

00140 
class="mdTable" cellpadding="2" cellspacing="0">
00141   00142     00154   00155 

class="mdRow">
00143       "0" cellspacing="0" border="0">
00144         00145           00146           00147           00148           00149           00150           00151         00152       

class="md" nowrap valign="top">void CCSAsyncAppUi::HandleCommandL           
class="md" valign="top">( 
class="md" nowrap valign="top">TInt 
class="mdname1" valign="top" nowrap> aCommand          
class="md" valign="top"> ) 
class="md" nowrap>




00153     		




00156 "5" cellpadding="0" border="0">
00157   00158     00161     00196   00197 


00159        
00160     

00162 
00163 

00164 From CAknAppUi, HandleCommandL. Handles user menu selections. 
Parameters:

00165   "0" cellspacing="2" cellpadding="0">
00166     00167   
"top">"top">aCommand The enumerated code for the option selected. 



00168 

00169 
00170 

00171 Definition at line class="el" href="csasyncappui_8cpp-source.html#l00084">84 of file class="el" href="csasyncappui_8cpp-source.html">csasyncappui.cpp.
00172 

00173 References class="el" href="csasyncappui_8cpp-source.html#l00074">AsyncDocument(), class="el" href="csasyncdocument_8cpp-source.html#l00108">CCSAsyncDocument::StopClock(), and class="el" href="csasyncdocument_8cpp-source.html#l00098">CCSAsyncDocument::UpdateTime().
class="fragment">
class="fragment">"l00085">00085     {
00174 "l00086">00086     class="keywordflow">switch( aCommand )
00175 "l00087">00087         {
00176 "l00088">00088         class="keywordflow">case EEikCmdExit:
00177 "l00089">00089         class="keywordflow">case EAknSoftkeyExit:
00178 "l00090">00090             Exit();
00179 "l00091">00091             class="keywordflow">break;
00180 "l00092">00092 
00181 "l00093">00093         class="keywordflow">case EStartClock:
00182 "l00094">00094             class="code" href="class_c_c_s_async_app_ui.html#1e0f1d7283b2cd8210c9d7ab96e93267">AsyncDocument()->class="code" href="class_c_c_s_async_document.html#49951129866458617c40b0dc2b4f393f">UpdateTime();
00183 "l00095">00095             class="keywordflow">break;
00184 "l00096">00096 
00185 "l00097">00097         class="keywordflow">case EStopClock:
00186 "l00098">00098             class="code" href="class_c_c_s_async_app_ui.html#1e0f1d7283b2cd8210c9d7ab96e93267">AsyncDocument()->class="code" href="class_c_c_s_async_document.html#0dcbea3e9ce301f1d5ac23a7679b8ee0">StopClock();
00187 "l00099">00099             class="keywordflow">break;
00188 "l00100">00100 
00189 "l00101">00101         class="keywordflow">default:
00190 "l00102">00102             class="keywordflow">break;
00191 "l00103">00103         }
00192 "l00104">00104     }
00193 

00194 

00195     





00198 class="anchor" name="3ae77c2aed5e1270a13c14bd5aa415fe">

00199 
class="mdTable" cellpadding="2" cellspacing="0">
00200   00201     00222   00223 

class="mdRow">
00202       "0" cellspacing="0" border="0">
00203         00204           00205           00206           00207           00208         00209         00210           00211           00212           00213           00214         00215         00216           00217           00218           00219         00220       

class="md" nowrap valign="top">void CCSAsyncAppUi::DynInitMenuPaneL           
class="md" valign="top">( 
class="md" nowrap valign="top">TInt 
class="mdname" nowrap> aResourceId, 




class="md" nowrap align="right">
class="md">
class="md" nowrap>CEikMenuPane * 
class="mdname" nowrap> aMenuPane




class="md">
class="md">) 
class="md" colspan="2">




00221     		




00224 "5" cellpadding="0" border="0">
00225   00226     00229     00260   00261 


00227        
00228     

00230 
00231 

00232 From CAknAppUi, DynInitMenuPaneL. Prepares the menu prior to display. 
Parameters:

00233   "0" cellspacing="2" cellpadding="0">
00234     00235     00236   
"top">"top">aResourceId The resource for the menu to be displayed. 


"top">"top">aMenuPane The handle to the menu. 



00237 

00238 
00239 

00240 Definition at line class="el" href="csasyncappui_8cpp-source.html#l00123">123 of file class="el" href="csasyncappui_8cpp-source.html">csasyncappui.cpp.
00241 

00242 References class="el" href="csasyncappui_8cpp-source.html#l00074">AsyncDocument().
class="fragment">
class="fragment">"l00125">00125     {
00243 "l00126">00126     class="keywordflow">if ( aResourceId == R_CSASYNC_MENU )
00244 "l00127">00127         {
00245 "l00128">00128         class="keywordflow">if ( class="code" href="class_c_c_s_async_app_ui.html#1e0f1d7283b2cd8210c9d7ab96e93267">AsyncDocument()->ClockActive() )
00246 "l00129">00129             {
00247 "l00130">00130             aMenuPane->SetItemDimmed( EStartClock, ETrue );
00248 "l00131">00131             aMenuPane->SetItemDimmed( EStopClock, EFalse );
00249 "l00132">00132             }
00250 "l00133">00133         class="keywordflow">else
00251 "l00134">00134             {
00252 "l00135">00135             aMenuPane->SetItemDimmed( EStartClock, EFalse );
00253 "l00136">00136             aMenuPane->SetItemDimmed( EStopClock, ETrue );
00254 "l00137">00137             }
00255 "l00138">00138         }
00256 "l00139">00139     }
00257 

00258 

00259     





00262 class="anchor" name="081e2db0d35721e6ad6d5d1d99fbbd83">

00263 
class="mdTable" cellpadding="2" cellspacing="0">
00264   00265     00276   00277 

class="mdRow">
00266       "0" cellspacing="0" border="0">
00267         00268           00269           00270           00271           00272           00273         00274       

class="md" nowrap valign="top">void CCSAsyncAppUi::HandleTimeUpdate           
class="md" valign="top">( 
class="mdname1" valign="top" nowrap>          
class="md" valign="top"> ) 
class="md" nowrap> [virtual]




00275     		




00278 "5" cellpadding="0" border="0">
00279   00280     00283     00300   00301 


00281        
00282     

00284 
00285 

00286 From class="el" href="class_m_async_time_observer.html">MAsyncTimeObserver, HandleTimeUpdate. Handles updates to the time. 
00287 

00288 Implements class="el" href="class_m_async_time_observer.html#0f7e397559bb14d521856cfb636830df">MAsyncTimeObserver.
00289 

00290 Definition at line class="el" href="csasyncappui_8cpp-source.html#l00111">111 of file class="el" href="csasyncappui_8cpp-source.html">csasyncappui.cpp.
00291 

00292 References class="el" href="csasyncappui_8h-source.html#l00103">iAppView.
class="fragment">
class="fragment">"l00112">00112     {
00293 "l00113">00113     __ASSERT_ALWAYS( class="code" href="class_c_c_s_async_app_ui.html#45dd0a3e0e75e56b4727a01a8ef2c6b1">iAppView, User::Panic ( KCSAsyncClient, 
00294 "l00114">00114                                              ECSAsyncProgram ) );
00295 "l00115">00115     class="code" href="class_c_c_s_async_app_ui.html#45dd0a3e0e75e56b4727a01a8ef2c6b1">iAppView->DrawNow();
00296 "l00116">00116     }
00297 

00298 

00299     





00302 class="anchor" name="6acdbe8a9b57446075bf46d035e751eb">

00303 
class="mdTable" cellpadding="2" cellspacing="0">
00304   00305     00317   00318 

class="mdRow">
00306       "0" cellspacing="0" border="0">
00307         00308           00309           00310           00311           00312           00313           00314         00315       

class="md" nowrap valign="top">void CCSAsyncAppUi::HandleResourceChangeL           
class="md" valign="top">( 
class="md" nowrap valign="top">TInt 
class="mdname1" valign="top" nowrap> aType          
class="md" valign="top"> ) 
class="md" nowrap> [virtual]




00316     		




00319 "5" cellpadding="0" border="0">
00320   00321     00324     00349   00350 


00322        
00323     

00325 
00326 

00327 class="el" href="class_c_c_s_async_app_ui.html#6acdbe8a9b57446075bf46d035e751eb">HandleResourceChangeL() Called by framework when layout is changed. 
Parameters:

00328   "0" cellspacing="2" cellpadding="0">
00329     00330   
"top">"top">aType The type of resources that have changed. 



00331 

00332 
00333 

00334 Definition at line class="el" href="csasyncappui_8cpp-source.html#l00146">146 of file class="el" href="csasyncappui_8cpp-source.html">csasyncappui.cpp.
00335 

00336 References class="el" href="csasyncappui_8h-source.html#l00103">iAppView.
class="fragment">
class="fragment">"l00147">00147     {
00337 "l00148">00148     CAknAppUi::HandleResourceChangeL( aType );
00338 "l00149">00149 
00339 "l00150">00150     class="keywordflow">if ( aType==KEikDynamicLayoutVariantSwitch )
00340 "l00151">00151         {
00341 "l00152">00152         class="code" href="class_c_c_s_async_app_ui.html#45dd0a3e0e75e56b4727a01a8ef2c6b1">iAppView->SetRect( ClientRect() );
00342 "l00153">00153         }
00343 "l00154">00154     class="comment">//Controls derived from CCoeControl, handled in container class
00344 "l00155">00155     class="code" href="class_c_c_s_async_app_ui.html#45dd0a3e0e75e56b4727a01a8ef2c6b1">iAppView->HandleResourceChange( aType );
00345 "l00156">00156     }
00346 

00347 

00348     





00351 class="anchor" name="9ce34ba0b947863222da3c63d0481044">

00352 
class="mdTable" cellpadding="2" cellspacing="0">
00353   00354     00365   00366 

class="mdRow">
00355       "0" cellspacing="0" border="0">
00356         00357           00358           00359           00360           00361           00362         00363       

class="md" nowrap valign="top">void CCSAsyncAppUi::ConstructL           
class="md" valign="top">( 
class="mdname1" valign="top" nowrap>          
class="md" valign="top"> ) 
class="md" nowrap> [private]




00364     		




00367 "5" cellpadding="0" border="0">
00368   00369     00372     00389   00390 


00370        
00371     

00373 
00374 

00375 ConstructL. 2nd phase constructor. 
00376 

00377 Definition at line class="el" href="csasyncappui_8cpp-source.html#l00045">45 of file class="el" href="csasyncappui_8cpp-source.html">csasyncappui.cpp.
00378 

00379 References class="el" href="csasyncappui_8cpp-source.html#l00074">AsyncDocument(), class="el" href="csasyncappui_8h-source.html#l00103">iAppView, and class="el" href="csasyncappview_8cpp-source.html#l00032">CCSAsyncAppView::NewL().
class="fragment">
class="fragment">"l00046">00046     {
00380 "l00047">00047     BaseConstructL();
00381 "l00048">00048 
00382 "l00049">00049     class="code" href="class_c_c_s_async_app_ui.html#45dd0a3e0e75e56b4727a01a8ef2c6b1">iAppView = class="code" href="class_c_c_s_async_app_view.html#113d3c41dfbbbaf3bd2d6d1213cc9f32">CCSAsyncAppView::NewL( ClientRect(), *class="code" href="class_c_c_s_async_app_ui.html#1e0f1d7283b2cd8210c9d7ab96e93267">AsyncDocument() );
00383 "l00050">00050 
00384 "l00051">00051     AddToStackL( class="code" href="class_c_c_s_async_app_ui.html#45dd0a3e0e75e56b4727a01a8ef2c6b1">iAppView );
00385 "l00052">00052     }
00386 

00387 

00388     





00391 class="anchor" name="1e0f1d7283b2cd8210c9d7ab96e93267">

00392 
class="mdTable" cellpadding="2" cellspacing="0">
00393   00394     00405   00406 

class="mdRow">
00395       "0" cellspacing="0" border="0">
00396         00397           00398           00399           00400           00401           00402         00403       

class="md" nowrap valign="top">class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument * CCSAsyncAppUi::AsyncDocument           
class="md" valign="top">( 
class="mdname1" valign="top" nowrap>          
class="md" valign="top"> ) 
class="md" nowrap> const [private]




00404     		




00407 "5" cellpadding="0" border="0">
00408   00409     00412     00425   00426 


00410        
00411     

00413 
00414 

00415 AsyncDocument. Casts iDocument member from CAknAppUi to class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument. 
00416 

00417 Definition at line class="el" href="csasyncappui_8cpp-source.html#l00074">74 of file class="el" href="csasyncappui_8cpp-source.html">csasyncappui.cpp.
00418 

00419 Referenced by class="el" href="csasyncappui_8cpp-source.html#l00045">ConstructL(), class="el" href="csasyncappui_8cpp-source.html#l00123">DynInitMenuPaneL(), and class="el" href="csasyncappui_8cpp-source.html#l00084">HandleCommandL().
class="fragment">
class="fragment">"l00075">00075     {
00420 "l00076">00076     class="keywordflow">return ( static_cast<CCSAsyncDocument*>( iDocument ) );
00421 "l00077">00077     }
00422 

00423 

00424     





00427 
Member Data Documentation

00428 class="anchor" name="45dd0a3e0e75e56b4727a01a8ef2c6b1">

00429 
class="mdTable" cellpadding="2" cellspacing="0">
00430   00431     00438   00439 

class="mdRow">
00432       "0" cellspacing="0" border="0">
00433         00434           00435         00436       

class="md" nowrap valign="top">class="el" href="class_c_c_s_async_app_view.html">CCSAsyncAppView* class="el" href="class_c_c_s_async_app_ui.html#45dd0a3e0e75e56b4727a01a8ef2c6b1">CCSAsyncAppUi::iAppView [private]          




00437     		




00440 "5" cellpadding="0" border="0">
00441   00442     00445     00453   00454 


00443        
00444     

00446 
00447 

00448 iAppView, the application view. Owned by CCSAsyncAppUi object. 
00449 

00450 Definition at line class="el" href="csasyncappui_8h-source.html#l00103">103 of file class="el" href="csasyncappui_8h-source.html">csasyncappui.h.
00451 

00452 Referenced by class="el" href="csasyncappui_8cpp-source.html#l00045">ConstructL(), class="el" href="csasyncappui_8cpp-source.html#l00146">HandleResourceChangeL(), class="el" href="csasyncappui_8cpp-source.html#l00111">HandleTimeUpdate(), and class="el" href="csasyncappui_8cpp-source.html#l00059">~CCSAsyncAppUi().    





00455 
The documentation for this class was generated from the following files:
00457 

00458 
00459 00460                 style="x-cell-content-align: top;
00461                                 width: 100%;
00462                                 border-spacing: 0px;
00463                                 border-spacing: 0px;"
00464                 cellspacing=0
00465                 width=100%>
00466   00467   00468 
00469   00470         valign=top>
00471   00480   00502  



00472                         padding-right: 10px;
00473                         padding-left: 10px;
00474                         border-right-style: None;
00475                         border-left-style: None;
00476                         border-top-style: None;
00477                         border-bottom-style: None;"
00478         width=50%>
00479   
 Nokia 2009

00481                         padding-right: 10px;
00482                         padding-left: 10px;
00483                         border-top-style: None;
00484                         border-bottom-style: None;
00485                         border-right-style: None;"
00486         width=50%>
00487   
00488         align=right>00489                                                                                                         title="Back to top">00490  src="top.gif"
00491         x-maintain-ratio=TRUE
00492         alt="Back to top"
00493         style="border: none;
00494                         width: 18px;
00495                         height: 15px;
00496                         float: none;
00497                         border-style: none;
00498                         border-style: none;"
00499         width=18
00500         height=15
00501         border=0>



00503 
00504 
00505
Generated by  doxygen 1.6.2

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).

All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.