Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_contacts_model_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: CContactsModelDocument 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>CContactsModelDocument Class Reference</h1><!-- doxytag: class="CContactsModelDocument" -->
<p><a href="class_c_contacts_model_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_contacts_model_document.html#a62cf8fc01cf8078e4c5eb4fb6d86b6a8">~CContactsModelDocument</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">HBufC * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_contacts_model_document.html#a408bc4fcba90731f62d3e4ce0d7da83d">GetItemL</a> (TInt anIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_contacts_model_document.html#a5173bd5e7d4d7a44a0daa07d51e93373">ItemCount</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_contacts_model_document.html#acc165ae349290322113929509bee068a">UpdateContactsL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_contacts_model_document.html#a79036a36e92f4e742866aed8cdfc6bf0">ImportL</a> (RReadStream &aReadStream)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_contacts_model_document.html#ae431484c6c59d5ada5251051ebd75793">ExportL</a> (RWriteStream &aWriteStream, TInt aExportItem)</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_contacts_model_document.html">CContactsModelDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_contacts_model_document.html#a6ece7cee352f17924d51e2e0efe4a0db">NewL</a> (CEikApplication &aApp)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_contacts_model_document.html">CContactsModelDocument</a> application class. </p>
<p>Definition at line <a class="el" href="_contacts_model_document_8h_source.html#l00023">23</a> of file <a class="el" href="_contacts_model_document_8h_source.html">ContactsModelDocument.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a62cf8fc01cf8078e4c5eb4fb6d86b6a8"></a><!-- doxytag: member="CContactsModelDocument::~CContactsModelDocument" ref="a62cf8fc01cf8078e4c5eb4fb6d86b6a8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CContactsModelDocument::~CContactsModelDocument </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="_contacts_model_document_8cpp_source.html#l00023">23</a> of file <a class="el" href="_contacts_model_document_8cpp_source.html">ContactsModelDocument.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6ece7cee352f17924d51e2e0efe4a0db"></a><!-- doxytag: member="CContactsModelDocument::NewL" ref="a6ece7cee352f17924d51e2e0efe4a0db" args="(CEikApplication &aApp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_contacts_model_document.html">CContactsModelDocument</a> * CContactsModelDocument::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>Two-phased constructor. </p>
<p>Definition at line <a class="el" href="_contacts_model_document_8cpp_source.html#l00042">42</a> of file <a class="el" href="_contacts_model_document_8cpp_source.html">ContactsModelDocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a408bc4fcba90731f62d3e4ce0d7da83d"></a><!-- doxytag: member="CContactsModelDocument::GetItemL" ref="a408bc4fcba90731f62d3e4ce0d7da83d" args="(TInt anIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">HBufC * CContactsModelDocument::GetItemL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>anIndex</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>GetItemL</p>
<p>Returns text representation of the specified contact item.</p>
<p>Parameters anIndex - contact item index</p>
<p>Returns String with the text description of the contact item </p>
<p>Definition at line <a class="el" href="_contacts_model_document_8cpp_source.html#l00054">54</a> of file <a class="el" href="_contacts_model_document_8cpp_source.html">ContactsModelDocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5173bd5e7d4d7a44a0daa07d51e93373"></a><!-- doxytag: member="CContactsModelDocument::ItemCount" ref="a5173bd5e7d4d7a44a0daa07d51e93373" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CContactsModelDocument::ItemCount </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ItemCount</p>
<p>Return the number of contact items in the default database</p>
<p>Returns Number of contact items </p>
<p>Definition at line <a class="el" href="_contacts_model_document_8cpp_source.html#l00070">70</a> of file <a class="el" href="_contacts_model_document_8cpp_source.html">ContactsModelDocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acc165ae349290322113929509bee068a"></a><!-- doxytag: member="CContactsModelDocument::UpdateContactsL" ref="acc165ae349290322113929509bee068a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CContactsModelDocument::UpdateContactsL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>UpdateContactsL</p>
<p>Retrives the list of contact item ids from the default database. </p>
<p>Definition at line <a class="el" href="_contacts_model_document_8cpp_source.html#l00075">75</a> of file <a class="el" href="_contacts_model_document_8cpp_source.html">ContactsModelDocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a79036a36e92f4e742866aed8cdfc6bf0"></a><!-- doxytag: member="CContactsModelDocument::ImportL" ref="a79036a36e92f4e742866aed8cdfc6bf0" args="(RReadStream &aReadStream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CContactsModelDocument::ImportL </td>
<td>(</td>
<td class="paramtype">RReadStream & </td>
<td class="paramname"> <em>aReadStream</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ImportL</p>
<p>Reads from the stream vCard and tries to import them in the default database.</p>
<p>Parameters aReadStream - read stream with vCards</p>
<p>Returns KErrNone or KErrGeneral if import failed </p>
<p>Definition at line <a class="el" href="_contacts_model_document_8cpp_source.html#l00100">100</a> of file <a class="el" href="_contacts_model_document_8cpp_source.html">ContactsModelDocument.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae431484c6c59d5ada5251051ebd75793"></a><!-- doxytag: member="CContactsModelDocument::ExportL" ref="ae431484c6c59d5ada5251051ebd75793" args="(RWriteStream &aWriteStream, TInt aExportItem)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CContactsModelDocument::ExportL </td>
<td>(</td>
<td class="paramtype">RWriteStream & </td>
<td class="paramname"> <em>aWriteStream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aExportItem</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ExportL</p>
<p>Exports the selected item from the default contact database to the specified ouput stream as vCard.</p>
<p>Parameters aWriteStream - output stream to write the item as vCard aExportItem - the index of item for export</p>
<p>Returns Nothing </p>
<p>Definition at line <a class="el" href="_contacts_model_document_8cpp_source.html#l00121">121</a> of file <a class="el" href="_contacts_model_document_8cpp_source.html">ContactsModelDocument.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>