Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_c_s_async_document.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: CCSAsyncDocument 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>CCSAsyncDocument Class Reference</h1><!-- doxytag: class="CCSAsyncDocument" -->
<p><a href="class_c_c_s_async_document-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_document.html#a23cbeeb1f559354c0b4d0182adddfde4">~CCSAsyncDocument</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_document.html#afe99840e05fffe337b28b2a8c7e96cdc">UpdateTime</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_document.html#add1f562e2b18c7318d3cf4c6c0abf8db">StopClock</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TTime </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_document.html#a6b5c1a65ea758d5ca98c95955ee4de6f">Time</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_document.html#a98ef800a723c4f16e991a6dbc0d529f2">ClockActive</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CEikAppUi * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_document.html#aa97ccf1fda44ab910f7b6e2ea91da0c6">CreateAppUiL</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_document.html#a50acf074a5dd1aa399cfb0982c176f01">NewL</a> (CEikApplication &aApp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_document.html#abe6a44e36ede9c8c326e84ca6c7fb318">NewLC</a> (CEikApplication &aApp)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument</a> An instance of class <a class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument</a> is the Document part of the AVKON application framework for the CSAsync example application </p>
<p>Definition at line <a class="el" href="csasyncdocument_8h_source.html#l00034">34</a> of file <a class="el" href="csasyncdocument_8h_source.html">csasyncdocument.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a23cbeeb1f559354c0b4d0182adddfde4"></a><!-- doxytag: member="CCSAsyncDocument::~CCSAsyncDocument" ref="a23cbeeb1f559354c0b4d0182adddfde4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCSAsyncDocument::~CCSAsyncDocument </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>~CCSAsyncDocument. Destructor. Destroys the object and release all memory objects. </p>
<p>Definition at line <a class="el" href="csasyncdocument_8cpp_source.html#l00073">73</a> of file <a class="el" href="csasyncdocument_8cpp_source.html">csasyncdocument.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a50acf074a5dd1aa399cfb0982c176f01"></a><!-- doxytag: member="CCSAsyncDocument::NewL" ref="a50acf074a5dd1aa399cfb0982c176f01" args="(CEikApplication &aApp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument</a> * CCSAsyncDocument::NewL </td>
<td>(</td>
<td class="paramtype">CEikApplication & </td>
<td class="paramname"> <em>aApp</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewL. Two-phased constructor. Constructs a <a class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument</a> for the AVKON application aApp using two phase construction, and returns a pointer to the created object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aApp</em> </td><td>Application creating this document. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the created instance of <a class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument</a>. </dd></dl>
<p>Definition at line <a class="el" href="csasyncdocument_8cpp_source.html#l00028">28</a> of file <a class="el" href="csasyncdocument_8cpp_source.html">csasyncdocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abe6a44e36ede9c8c326e84ca6c7fb318"></a><!-- doxytag: member="CCSAsyncDocument::NewLC" ref="abe6a44e36ede9c8c326e84ca6c7fb318" args="(CEikApplication &aApp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument</a> * CCSAsyncDocument::NewLC </td>
<td>(</td>
<td class="paramtype">CEikApplication & </td>
<td class="paramname"> <em>aApp</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewLC. Two-phased constructor. Constructs a <a class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument</a> for the AVKON application aApp using two phase construction, and returns a pointer to the created object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aApp</em> </td><td>Application creating this document. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the created instance of <a class="el" href="class_c_c_s_async_document.html">CCSAsyncDocument</a>. </dd></dl>
<p>Definition at line <a class="el" href="csasyncdocument_8cpp_source.html#l00040">40</a> of file <a class="el" href="csasyncdocument_8cpp_source.html">csasyncdocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afe99840e05fffe337b28b2a8c7e96cdc"></a><!-- doxytag: member="CCSAsyncDocument::UpdateTime" ref="afe99840e05fffe337b28b2a8c7e96cdc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"></td >< td > The enumerated code <a class="el" href="interfacefor.html">for</a> the option selected</td ></tr ></table ></dl >< p > Definition at line< a class="el"href="csasyncappui_8cpp-source.html#l00084"></a > of file< a class="el"href="csasyncappui_8cpp-source.html"> csasyncappui cpp</a >< p > References< a class="el"href="csasyncappui_8cpp-source.html#l00074">< aclass="el"href="csasyncdocument_8cpp-source.html#l00108"> and< a class="el"href="csasyncdocument_8cpp-source.html#l00098"> CCSAsyncDocument::UpdateTime </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>UpdateTime. Asks the time server to update this documents locally stored time. </p>
<p>Definition at line <a class="el" href="csasyncdocument_8cpp_source.html#l00098">98</a> of file <a class="el" href="csasyncdocument_8cpp_source.html">csasyncdocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="add1f562e2b18c7318d3cf4c6c0abf8db"></a><!-- doxytag: member="CCSAsyncDocument::StopClock" ref="add1f562e2b18c7318d3cf4c6c0abf8db" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"></td >< td >< p > CancelRequest Cancels an outstanding request< p > Definition at line< a class="el"href="csasyncrequesthandler_8cpp-source.html#l00102"></a > of file< a class="el"href="csasyncrequesthandler_8cpp-source.html"> csasyncrequesthandler cpp</a >< p > Referenced by< a class="el"href="csasyncdocument_8cpp-source.html#l00108"> CCSAsyncDocument::StopClock </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Initial value:</b><div class="fragment"><pre class="fragment"><span class="stringliteral">"fragment"</span>><pre <span class="keyword">class</span>=<span class="stringliteral">"fragment"</span>><a name=<span class="stringliteral">"l00103"</span>></a>00103 {
<a name=<span class="stringliteral">"l00104"</span>></a>00104 Cancel() ; <span <span class="keyword">class</span>=<span class="stringliteral">"comment"</span>>
<a name=<span class="stringliteral">"l00105"</span>></a>00105 }
</pre></div>
<p>
</td>
</tr>
</table>
<a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"abd5ca40d94b3e8941d79e5362c038b2"</span>></a><!-- doxytag: member=<span class="stringliteral">"CCSAsyncRequestHandler::Time"</span> ref=<span class="stringliteral">"abd5ca40d94b3e8941d79e5362c038b2"</span> args=<span class="stringliteral">"() const "</span> --><p>
<table <span class="keyword">class</span>=<span class="stringliteral">"mdTable"</span> cellpadding=<span class="stringliteral">"2"</span> cellspacing=<span class="stringliteral">"0"</span>>
<tr>
<td <span class="keyword">class</span>=<span class="stringliteral">"mdRow"</span>>
<table cellpadding=<span class="stringliteral">"0"</span> cellspacing=<span class="stringliteral">"0"</span> border=<span class="stringliteral">"0"</span>>
<tr>
<td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> nowrap valign=<span class="stringliteral">"top"</span>>TTime <a class="code" href="class_c_c_s_async_request_handler.html#aabca1fcdd326961717cd467071b93432">CCSAsyncRequestHandler::Time</a> </td>
<td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> valign=<span class="stringliteral">"top"</span>>(&nbsp;</td>
<td <span class="keyword">class</span>=<span class="stringliteral">"mdname1"</span> valign=<span class="stringliteral">"top"</span> nowrap> </td>
<td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> valign=<span class="stringliteral">"top"</span>>&nbsp;)&nbsp
</pre></div><p>StopClock. Stops the clock. </p>
<p>Definition at line <a class="el" href="csasyncdocument_8cpp_source.html#l00108">108</a> of file <a class="el" href="csasyncdocument_8cpp_source.html">csasyncdocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6b5c1a65ea758d5ca98c95955ee4de6f"></a><!-- doxytag: member="CCSAsyncDocument::Time" ref="a6b5c1a65ea758d5ca98c95955ee4de6f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TTime CCSAsyncDocument::Time </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Time. Returns the currently stored time. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The time. </dd></dl>
<p>Definition at line <a class="el" href="csasyncdocument_8cpp_source.html#l00121">121</a> of file <a class="el" href="csasyncdocument_8cpp_source.html">csasyncdocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a98ef800a723c4f16e991a6dbc0d529f2"></a><!-- doxytag: member="CCSAsyncDocument::ClockActive" ref="a98ef800a723c4f16e991a6dbc0d529f2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CCSAsyncDocument::ClockActive </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ClockActive. Checks whether the clock has been started. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>ETrue if the clock has been started, EFalse if the clock is stopped </dd></dl>
<p>Definition at line <a class="el" href="csasyncdocument_8cpp_source.html#l00131">131</a> of file <a class="el" href="csasyncdocument_8cpp_source.html">csasyncdocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa97ccf1fda44ab910f7b6e2ea91da0c6"></a><!-- doxytag: member="CCSAsyncDocument::CreateAppUiL" ref="aa97ccf1fda44ab910f7b6e2ea91da0c6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEikAppUi * CCSAsyncDocument::CreateAppUiL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>From CAknDocument, CreateAppUiL. Creates a <a class="el" href="class_c_c_s_async_app_ui.html">CCSAsyncAppUi</a> object and returns a pointer to it. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the created instance of the AppUi created. </dd></dl>
<p>Definition at line <a class="el" href="csasyncdocument_8cpp_source.html#l00083">83</a> of file <a class="el" href="csasyncdocument_8cpp_source.html">csasyncdocument.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>