Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_c_s_sync_document.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
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: CCSSyncDocument 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>CCSSyncDocument Class Reference</h1><!-- doxytag: class="CCSSyncDocument" -->
<p><a href="class_c_c_s_sync_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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_sync_document.html#ac80ec89ba868be8ebc34d3747f541432">~CCSSyncDocument</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_sync_document.html#a01fb72bd887fb55fccf7394b14f534b9">UpdateTime</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const TTime &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_sync_document.html#adcc74f80be8bb9376ffd87979c4d11db">Time</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CEikAppUi *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_sync_document.html#ab9e5d1259af2b89914126b20e94f5452">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_sync_document.html">CCSSyncDocument</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_sync_document.html#aec1b39314506d58e5104cac0deb1b342">NewL</a> (CEikApplication &amp;aApp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_c_s_sync_document.html">CCSSyncDocument</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_sync_document.html#a00e979c1b19012e9f3f147be87343d0a">NewLC</a> (CEikApplication &amp;aApp)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_c_s_sync_document.html">CCSSyncDocument</a> An instance of class <a class="el" href="class_c_c_s_sync_document.html">CCSSyncDocument</a> is the Document part of the AVKON application framework for the CSSync example application </p>

<p>Definition at line <a class="el" href="cssyncdocument_8h_source.html#l00034">34</a> of file <a class="el" href="cssyncdocument_8h_source.html">cssyncdocument.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac80ec89ba868be8ebc34d3747f541432"></a><!-- doxytag: member="CCSSyncDocument::~CCSSyncDocument" ref="ac80ec89ba868be8ebc34d3747f541432" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CCSSyncDocument::~CCSSyncDocument </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>~CCSSyncDocument. Destructor. Destroys the object and release all memory objects. </p>

<p>Definition at line <a class="el" href="cssyncdocument_8cpp_source.html#l00074">74</a> of file <a class="el" href="cssyncdocument_8cpp_source.html">cssyncdocument.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aec1b39314506d58e5104cac0deb1b342"></a><!-- doxytag: member="CCSSyncDocument::NewL" ref="aec1b39314506d58e5104cac0deb1b342" args="(CEikApplication &amp;aApp)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_c_c_s_sync_document.html">CCSSyncDocument</a> * CCSSyncDocument::NewL </td>
          <td>(</td>
          <td class="paramtype">CEikApplication &amp;&nbsp;</td>
          <td class="paramname"> <em>aApp</em></td>
          <td>&nbsp;)&nbsp;</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_sync_document.html">CCSSyncDocument</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>&nbsp;</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_sync_document.html">CCSSyncDocument</a>. </dd></dl>

<p>Definition at line <a class="el" href="cssyncdocument_8cpp_source.html#l00028">28</a> of file <a class="el" href="cssyncdocument_8cpp_source.html">cssyncdocument.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a00e979c1b19012e9f3f147be87343d0a"></a><!-- doxytag: member="CCSSyncDocument::NewLC" ref="a00e979c1b19012e9f3f147be87343d0a" args="(CEikApplication &amp;aApp)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_c_c_s_sync_document.html">CCSSyncDocument</a> * CCSSyncDocument::NewLC </td>
          <td>(</td>
          <td class="paramtype">CEikApplication &amp;&nbsp;</td>
          <td class="paramname"> <em>aApp</em></td>
          <td>&nbsp;)&nbsp;</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_sync_document.html">CCSSyncDocument</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>&nbsp;</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_sync_document.html">CCSSyncDocument</a>. </dd></dl>

<p>Definition at line <a class="el" href="cssyncdocument_8cpp_source.html#l00040">40</a> of file <a class="el" href="cssyncdocument_8cpp_source.html">cssyncdocument.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a01fb72bd887fb55fccf7394b14f534b9"></a><!-- doxytag: member="CCSSyncDocument::UpdateTime" ref="a01fb72bd887fb55fccf7394b14f534b9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">&lt;/td &gt;&lt; td &gt; The enumerated code <a class="el" href="interfacefor.html">for</a> the option selected&lt;/td &gt;&lt;/tr &gt;&lt;/table &gt;&lt;/dl &gt;&lt; p &gt; Definition at line&lt; a class=&quot;el&quot;href=&quot;cssyncappui_8cpp-source.html#l00084&quot;&gt;&lt;/a &gt; of file&lt; a class=&quot;el&quot;href=&quot;cssyncappui_8cpp-source.html&quot;&gt; cssyncappui cpp&lt;/a &gt;&lt; p &gt; References&lt; a class=&quot;el&quot;href=&quot;cssyncappui_8h-source.html#l00088&quot;&gt;&lt; aclass=&quot;el&quot;href=&quot;cssyncappui_8cpp-source.html#l00074&quot;&gt; and&lt; a class=&quot;el&quot;href=&quot;cssyncdocument_8cpp-source.html#l00095&quot;&gt; CCSSyncDocument::UpdateTime </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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="cssyncdocument_8cpp_source.html#l00095">95</a> of file <a class="el" href="cssyncdocument_8cpp_source.html">cssyncdocument.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="adcc74f80be8bb9376ffd87979c4d11db"></a><!-- doxytag: member="CCSSyncDocument::Time" ref="adcc74f80be8bb9376ffd87979c4d11db" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TTime &amp; CCSSyncDocument::Time </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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="cssyncdocument_8cpp_source.html#l00105">105</a> of file <a class="el" href="cssyncdocument_8cpp_source.html">cssyncdocument.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ab9e5d1259af2b89914126b20e94f5452"></a><!-- doxytag: member="CCSSyncDocument::CreateAppUiL" ref="ab9e5d1259af2b89914126b20e94f5452" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CEikAppUi * CCSSyncDocument::CreateAppUiL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>From CAknDocument, CreateAppUiL. Creates a <a class="el" href="class_c_c_s_sync_app_ui.html">CCSSyncAppUi</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="cssyncdocument_8cpp_source.html#l00084">84</a> of file <a class="el" href="cssyncdocument_8cpp_source.html">cssyncdocument.cpp</a>.</p>

</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>