examples/S60CppExamples/ClientServerAsync/doc/class_c_c_s_async_document.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_document.html">CCSAsyncDocument</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 00026

CCSAsyncDocument Class Reference

#include <class="el" href="csasyncdocument_8h-source.html">csasyncdocument.h> 00027

00028

Inheritance diagram for CCSAsyncDocument: 00029

"class_c_c_s_async_document.png" usemap="#CCSAsyncDocument_map" border="0" alt="">
00030 "CCSAsyncDocument_map"> 00031 00032 "class_c_c_s_async_document-members.html">List of all members.
"_details">

Detailed Description

00033 CCSAsyncDocument An instance of class CCSAsyncDocument is the Document part of the AVKON application framework for the CSAsync example application 00034

00035 00036

00037 Definition at line "el" href="csasyncdocument_8h-source.html#l00034">34 of file class="el" href="csasyncdocument_8h-source.html">csasyncdocument.h.

"0" cellpadding="0" cellspacing="0"> 00038 00039 00040 00041 00042 00043 00044 00045 00046 00047 00048 00049 00050 00051 00052 00053 00054 00055 00056 00057 00058 00059 00060 00061 00062 00063 00064 00065
"2">

Public Member Functions

class="memItemLeft" nowrap align="right" valign="top">virtual class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_document.html#8be2e5c465a282f8419da9246a622582">~CCSAsyncDocument ()
class="memItemLeft" nowrap align="right" valign="top">void class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_document.html#49951129866458617c40b0dc2b4f393f">UpdateTime ()
class="memItemLeft" nowrap align="right" valign="top">void class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_document.html#0dcbea3e9ce301f1d5ac23a7679b8ee0">StopClock ()
class="memItemLeft" nowrap align="right" valign="top">TTime class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_document.html#abd5ca40d94b3e8941d79e5362c038b2">Time () const
class="memItemLeft" nowrap align="right" valign="top">TBool class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_document.html#c66d75d45ff8dc86abcb0b2191aa61a8">ClockActive () const
class="memItemLeft" nowrap align="right" valign="top">CEikAppUi * class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_document.html#0eb34f98d849338274127e28e8c78b4e">CreateAppUiL ()
"2">

Static Public Member Functions

class="memItemLeft" nowrap align="right" valign="top">static CCSAsyncDocumentclass="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_document.html#97d8413d74643854e05e60e11a177553">NewL (CEikApplication &aApp)
class="memItemLeft" nowrap align="right" valign="top">static CCSAsyncDocumentclass="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_document.html#4b4aa55001690769b8aac3d27274aef8">NewLC (CEikApplication &aApp)
"2">

Private Member Functions

class="memItemLeft" nowrap align="right" valign="top"class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_document.html#2b3f9d0286c70047caac1054cee403c1">CCSAsyncDocument (CEikApplication &aApp)
class="memItemLeft" nowrap align="right" valign="top">void class="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_document.html#9ce34ba0b947863222da3c63d0481044">ConstructL ()
"2">

Private Attributes

class="memItemLeft" nowrap align="right" valign="top">class="el" href="class_c_c_s_async_request_handler.html">CCSAsyncRequestHandlerclass="memItemRight" valign="bottom">class="el" href="class_c_c_s_async_document.html#56132cb68e64726ad0658571e44e9644">iHandler
00066

Constructor & Destructor Documentation

00067 class="anchor" name="8be2e5c465a282f8419da9246a622582">

00068

class="mdTable" cellpadding="2" cellspacing="0"> 00069 00070 00081 00082
class="mdRow"> 00071 "0" cellspacing="0" border="0"> 00072 00073 00074 00075 00076 00077 00078 00079
class="md" nowrap valign="top">CCSAsyncDocument::~CCSAsyncDocument class="md" valign="top">(  class="mdname1" valign="top" nowrap> class="md" valign="top"> )  class="md" nowrap> [virtual]
00080
00083 "5" cellpadding="0" border="0"> 00084 00085 00088 00101 00102
00086   00087 00089 00090

00091 ~CCSAsyncDocument. Destructor. Destroys the object and release all memory objects. 00092

00093 Definition at line class="el" href="csasyncdocument_8cpp-source.html#l00073">73 of file class="el" href="csasyncdocument_8cpp-source.html">csasyncdocument.cpp. 00094

00095 References class="el" href="csasyncdocument_8h-source.html#l00127">iHandler.

class="fragment">
class="fragment">"l00074">00074     {
00096 "l00075">00075     class="keyword">delete class="code" href="class_c_c_s_async_document.html#56132cb68e64726ad0658571e44e9644">iHandler;
00097 "l00076">00076     }
00098 
00099

00100

00103 class="anchor" name="2b3f9d0286c70047caac1054cee403c1">

00104

class="mdTable" cellpadding="2" cellspacing="0"> 00105 00106 00118 00119
class="mdRow"> 00107 "0" cellspacing="0" border="0"> 00108 00109 00110 00111 00112 00113 00114 00115 00116
class="md" nowrap valign="top">CCSAsyncDocument::CCSAsyncDocument class="md" valign="top">(  class="md" nowrap valign="top">CEikApplication &  class="mdname1" valign="top" nowrap> aApp class="md" valign="top"> )  class="md" nowrap> [private]
00117
00120 "5" cellpadding="0" border="0"> 00121 00122 00125 00144 00145
00123   00124 00126 00127

00128 CCSAsyncDocument. C++ default constructor. Perform the first phase of two phase construction.

Parameters:
00129 "0" cellspacing="2" cellpadding="0"> 00130 00131
"top">"top">aApp Application creating this document.
00132
00133 00134

00135 Definition at line class="el" href="csasyncdocument_8cpp-source.html#l00062">62 of file class="el" href="csasyncdocument_8cpp-source.html">csasyncdocument.cpp. 00136

00137 Referenced by class="el" href="csasyncdocument_8cpp-source.html#l00040">NewLC().

class="fragment">
class="fragment">"l00063">00063 : CAknDocument( aApp )
00138 "l00064">00064     {
00139 "l00065">00065     class="comment">// No implementation required
00140 "l00066">00066     }
00141 
00142

00143

00146

Member Function Documentation

00147 class="anchor" name="97d8413d74643854e05e60e11a177553">

00148

class="mdTable" cellpadding="2" cellspacing="0"> 00149 00150 00162 00163
class="mdRow"> 00151 "0" cellspacing="0" border="0"> 00152 00153 00154 00155 00156 00157 00158 00159 00160
class="md" nowrap valign="top">class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument * CCSAsyncDocument::NewL class="md" valign="top">(  class="md" nowrap valign="top">CEikApplication &  class="mdname1" valign="top" nowrap> aApp class="md" valign="top"> )  class="md" nowrap> [static]
00161
00164 "5" cellpadding="0" border="0"> 00165 00166 00169 00192 00193
00167   00168 00170 00171

00172 NewL. Two-phased constructor. Constructs a CCSAsyncDocument for the AVKON application aApp using two phase construction, and returns a pointer to the created object.

Parameters:
00173 "0" cellspacing="2" cellpadding="0"> 00174 00175
"top">"top">aApp Application creating this document.
00176
00177
Returns:
A pointer to the created instance of CCSAsyncDocument.
00178 00179

00180 Definition at line class="el" href="csasyncdocument_8cpp-source.html#l00028">28 of file class="el" href="csasyncdocument_8cpp-source.html">csasyncdocument.cpp. 00181

00182 References class="el" href="csasyncdocument_8cpp-source.html#l00040">NewLC(). 00183

00184 Referenced by class="el" href="csasyncapplication_8cpp-source.html#l00028">CCSAsyncApplication::CreateDocumentL().

class="fragment">
class="fragment">"l00029">00029     {
00185 "l00030">00030     class="code" href="class_c_c_s_async_document.html">CCSAsyncDocument* class="keyword">self = class="code" href="class_c_c_s_async_document.html#4b4aa55001690769b8aac3d27274aef8">NewLC( aApp );
00186 "l00031">00031     CleanupStack::Pop( class="keyword">self );
00187 "l00032">00032     class="keywordflow">return class="keyword">self;
00188 "l00033">00033     }
00189 
00190

00191

00194 class="anchor" name="4b4aa55001690769b8aac3d27274aef8">

00195

class="mdTable" cellpadding="2" cellspacing="0"> 00196 00197 00209 00210
class="mdRow"> 00198 "0" cellspacing="0" border="0"> 00199 00200 00201 00202 00203 00204 00205 00206 00207
class="md" nowrap valign="top">class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument * CCSAsyncDocument::NewLC class="md" valign="top">(  class="md" nowrap valign="top">CEikApplication &  class="mdname1" valign="top" nowrap> aApp class="md" valign="top"> )  class="md" nowrap> [static]
00208
00211 "5" cellpadding="0" border="0"> 00212 00213 00216 00240 00241
00214   00215 00217 00218

00219 NewLC. Two-phased constructor. Constructs a CCSAsyncDocument for the AVKON application aApp using two phase construction, and returns a pointer to the created object.

Parameters:
00220 "0" cellspacing="2" cellpadding="0"> 00221 00222
"top">"top">aApp Application creating this document.
00223
00224
Returns:
A pointer to the created instance of CCSAsyncDocument.
00225 00226

00227 Definition at line class="el" href="csasyncdocument_8cpp-source.html#l00040">40 of file class="el" href="csasyncdocument_8cpp-source.html">csasyncdocument.cpp. 00228

00229 References class="el" href="csasyncdocument_8cpp-source.html#l00062">CCSAsyncDocument(). 00230

00231 Referenced by class="el" href="csasyncdocument_8cpp-source.html#l00028">NewL().

class="fragment">
class="fragment">"l00041">00041     {
00232 "l00042">00042     class="code" href="class_c_c_s_async_document.html">CCSAsyncDocument* class="keyword">self = class="keyword">new ( ELeave ) class="code" href="class_c_c_s_async_document.html#2b3f9d0286c70047caac1054cee403c1">CCSAsyncDocument( aApp );
00233 "l00043">00043     CleanupStack::PushL( class="keyword">self );
00234 "l00044">00044     class="keyword">self->ConstructL();
00235 "l00045">00045     class="keywordflow">return class="keyword">self;
00236 "l00046">00046     }
00237 
00238

00239

00242 class="anchor" name="49951129866458617c40b0dc2b4f393f">

00243

class="mdTable" cellpadding="2" cellspacing="0"> 00244 00245 00256 00257
class="mdRow"> 00246 "0" cellspacing="0" border="0"> 00247 00248 00249 00250 00251 00252 00253 00254
class="md" nowrap valign="top">void CCSAsyncDocument::UpdateTime class="md" valign="top">(  class="mdname1" valign="top" nowrap> class="md" valign="top"> )  class="md" nowrap>
00255
00258 "5" cellpadding="0" border="0"> 00259 00260 00263 00278 00279
00261   00262 00264 00265

00266 UpdateTime. Asks the time server to update this documents locally stored time. 00267

00268 Definition at line class="el" href="csasyncdocument_8cpp-source.html#l00098">98 of file class="el" href="csasyncdocument_8cpp-source.html">csasyncdocument.cpp. 00269

00270 References class="el" href="csasyncdocument_8h-source.html#l00127">iHandler, and class="el" href="csasyncrequesthandler_8cpp-source.html#l00088">CCSAsyncRequestHandler::RequestTime(). 00271

00272 Referenced by class="el" href="csasyncappui_8cpp-source.html#l00084">CCSAsyncAppUi::HandleCommandL().

00276

00277

00280 class="anchor" name="0dcbea3e9ce301f1d5ac23a7679b8ee0">

00281

class="mdTable" cellpadding="2" cellspacing="0"> 00282 00283 00294 00295
class="mdRow"> 00284 "0" cellspacing="0" border="0"> 00285 00286 00287 00288 00289 00290 00291 00292
class="md" nowrap valign="top">void CCSAsyncDocument::StopClock class="md" valign="top">(  class="mdname1" valign="top" nowrap> class="md" valign="top"> )  class="md" nowrap>
00293
00296 "5" cellpadding="0" border="0"> 00297 00298 00301 00319 00320
00299   00300 00302 00303

00304 StopClock. Stops the clock. 00305

00306 Definition at line class="el" href="csasyncdocument_8cpp-source.html#l00108">108 of file class="el" href="csasyncdocument_8cpp-source.html">csasyncdocument.cpp. 00307

00308 References class="el" href="csasyncrequesthandler_8cpp-source.html#l00102">CCSAsyncRequestHandler::CancelRequest(), class="el" href="csasyncdocument_8cpp-source.html#l00131">ClockActive(), and class="el" href="csasyncdocument_8h-source.html#l00127">iHandler. 00309

00310 Referenced by class="el" href="csasyncappui_8cpp-source.html#l00084">CCSAsyncAppUi::HandleCommandL().

00317

00318

00321 class="anchor" name="abd5ca40d94b3e8941d79e5362c038b2">

00322

class="mdTable" cellpadding="2" cellspacing="0"> 00323 00324 00335 00336
class="mdRow"> 00325 "0" cellspacing="0" border="0"> 00326 00327 00328 00329 00330 00331 00332 00333
class="md" nowrap valign="top">TTime CCSAsyncDocument::Time class="md" valign="top">(  class="mdname1" valign="top" nowrap> class="md" valign="top"> )  class="md" nowrap> const
00334
00337 "5" cellpadding="0" border="0"> 00338 00339 00342 00358 00359
00340   00341 00343 00344

00345 Time. Returns the currently stored time.

Returns:
The time.
00346 00347

00348 Definition at line class="el" href="csasyncdocument_8cpp-source.html#l00121">121 of file class="el" href="csasyncdocument_8cpp-source.html">csasyncdocument.cpp. 00349

00350 References class="el" href="csasyncdocument_8h-source.html#l00127">iHandler, and class="el" href="csasyncrequesthandler_8cpp-source.html#l00151">CCSAsyncRequestHandler::Time(). 00351

00352 Referenced by class="el" href="csasyncappview_8cpp-source.html#l00097">CCSAsyncAppView::Draw().

00356

00357

00360 class="anchor" name="c66d75d45ff8dc86abcb0b2191aa61a8">

00361

class="mdTable" cellpadding="2" cellspacing="0"> 00362 00363 00374 00375
class="mdRow"> 00364 "0" cellspacing="0" border="0"> 00365 00366 00367 00368 00369 00370 00371 00372
class="md" nowrap valign="top">TBool CCSAsyncDocument::ClockActive class="md" valign="top">(  class="mdname1" valign="top" nowrap> class="md" valign="top"> )  class="md" nowrap> const
00373
00376 "5" cellpadding="0" border="0"> 00377 00378 00381 00397 00398
00379   00380 00382 00383

00384 ClockActive. Checks whether the clock has been started.

Returns:
ETrue if the clock has been started, EFalse if the clock is stopped
00385 00386

00387 Definition at line class="el" href="csasyncdocument_8cpp-source.html#l00131">131 of file class="el" href="csasyncdocument_8cpp-source.html">csasyncdocument.cpp. 00388

00389 References class="el" href="csasyncdocument_8h-source.html#l00127">iHandler. 00390

00391 Referenced by class="el" href="csasyncdocument_8cpp-source.html#l00108">StopClock().

class="fragment">
class="fragment">"l00132">00132     {
00392 "l00133">00133     class="keywordflow">return class="code" href="class_c_c_s_async_document.html#56132cb68e64726ad0658571e44e9644">iHandler->IsActive();
00393 "l00134">00134     }
00394 
00395

00396

00399 class="anchor" name="0eb34f98d849338274127e28e8c78b4e">

00400

class="mdTable" cellpadding="2" cellspacing="0"> 00401 00402 00413 00414
class="mdRow"> 00403 "0" cellspacing="0" border="0"> 00404 00405 00406 00407 00408 00409 00410 00411
class="md" nowrap valign="top">CEikAppUi * CCSAsyncDocument::CreateAppUiL class="md" valign="top">(  class="mdname1" valign="top" nowrap> class="md" valign="top"> )  class="md" nowrap>
00412
00415 "5" cellpadding="0" border="0"> 00416 00417 00420 00439 00440
00418   00419 00421 00422

00423 From CAknDocument, CreateAppUiL. Creates a class="el" href="class_c_c_s_async_app_ui.html">CCSAsyncAppUi object and returns a pointer to it.

Returns:
A pointer to the created instance of the AppUi created.
00424 00425

00426 Definition at line class="el" href="csasyncdocument_8cpp-source.html#l00083">83 of file class="el" href="csasyncdocument_8cpp-source.html">csasyncdocument.cpp. 00427

00428 References class="el" href="csasyncdocument_8h-source.html#l00127">iHandler, and class="el" href="csasyncrequesthandler_8cpp-source.html#l00030">CCSAsyncRequestHandler::NewL().

class="fragment">
class="fragment">"l00084">00084     {
00429 "l00085">00085     class="comment">// Create the application user interface, and return a pointer to it
00430 "l00086">00086     class="code" href="class_c_c_s_async_app_ui.html">CCSAsyncAppUi* appUi = class="keyword">new ( ELeave ) class="code" href="class_c_c_s_async_app_ui.html">CCSAsyncAppUi;
00431 "l00087">00087     CleanupStack::PushL( appUi );
00432 "l00088">00088     class="code" href="class_c_c_s_async_document.html#56132cb68e64726ad0658571e44e9644">iHandler = class="code" href="class_c_c_s_async_request_handler.html#e27bf7140859a754f6f06c51dbbd1b12">CCSAsyncRequestHandler::NewL( *appUi );
00433 "l00089">00089     CleanupStack::Pop( appUi ) ;
00434 "l00090">00090     class="keywordflow">return appUi;
00435 "l00091">00091     }
00436 
00437

00438

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

00442

class="mdTable" cellpadding="2" cellspacing="0"> 00443 00444 00455 00456
class="mdRow"> 00445 "0" cellspacing="0" border="0"> 00446 00447 00448 00449 00450 00451 00452 00453
class="md" nowrap valign="top">void CCSAsyncDocument::ConstructL class="md" valign="top">(  class="mdname1" valign="top" nowrap> class="md" valign="top"> )  class="md" nowrap> [private]
00454
00457 "5" cellpadding="0" border="0"> 00458 00459 00462 00473 00474
00460   00461 00463 00464

00465 ConstructL. Performs the second phase construction of a CCSAsyncDocument object. 00466

00467 Definition at line class="el" href="csasyncdocument_8cpp-source.html#l00053">53 of file class="el" href="csasyncdocument_8cpp-source.html">csasyncdocument.cpp.

class="fragment">
class="fragment">"l00054">00054     {
00468 "l00055">00055     class="comment">// No implementation required
00469 "l00056">00056     }
00470 
00471

00472

00475

Member Data Documentation

00476 class="anchor" name="56132cb68e64726ad0658571e44e9644">

00477

class="mdTable" cellpadding="2" cellspacing="0"> 00478 00479 00486 00487
class="mdRow"> 00480 "0" cellspacing="0" border="0"> 00481 00482 00483 00484
class="md" nowrap valign="top">class="el" href="class_c_c_s_async_request_handler.html">CCSAsyncRequestHandler* class="el" href="class_c_c_s_async_document.html#56132cb68e64726ad0658571e44e9644">CCSAsyncDocument::iHandler [private]
00485
00488 "5" cellpadding="0" border="0"> 00489 00490 00493 00501 00502
00491   00492 00494 00495

00496 iHandler, Active object for handling asynchronous requests. Owned by CCSAsyncDocument object. 00497

00498 Definition at line class="el" href="csasyncdocument_8h-source.html#l00127">127 of file class="el" href="csasyncdocument_8h-source.html">csasyncdocument.h. 00499

00500 Referenced by class="el" href="csasyncdocument_8cpp-source.html#l00131">ClockActive(), class="el" href="csasyncdocument_8cpp-source.html#l00083">CreateAppUiL(), class="el" href="csasyncdocument_8cpp-source.html#l00108">StopClock(), class="el" href="csasyncdocument_8cpp-source.html#l00121">Time(), class="el" href="csasyncdocument_8cpp-source.html#l00098">UpdateTime(), and class="el" href="csasyncdocument_8cpp-source.html#l00073">~CCSAsyncDocument().

00503
The documentation for this class was generated from the following files: 00505
00506 00507 00508 style="x-cell-content-align: top; 00509 width: 100%; 00510 border-spacing: 0px; 00511 border-spacing: 0px;" 00512 cellspacing=0 00513 width=100%> 00514 00515 00516 00517 00518 valign=top> 00519 00528 00550
00520 padding-right: 10px; 00521 padding-left: 10px; 00522 border-right-style: None; 00523 border-left-style: None; 00524 border-top-style: None; 00525 border-bottom-style: None;" 00526 width=50%> 00527

Nokia 2009

00529 padding-right: 10px; 00530 padding-left: 10px; 00531 border-top-style: None; 00532 border-bottom-style: None; 00533 border-right-style: None;" 00534 width=50%> 00535

00536 align=right>00537 title="Back to top">00538 src="top.gif" 00539 x-maintain-ratio=TRUE 00540 alt="Back to top" 00541 style="border: none; 00542 width: 18px; 00543 height: 15px; 00544 float: none; 00545 border-style: none; 00546 border-style: none;" 00547 width=18 00548 height=15 00549 border=0>

00551 00552 00553

Generated by  doxygen 1.6.2