Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 2aa62c5bbb658df1fece777472a7bcf2 > files > 321

barry-devel-docs-0.17-0.3.20100730git.fc14.noarch.rpm

<!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>Barry: Barry::Contact 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-20100208 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceBarry.html">Barry</a>::<a class="el" href="classBarry_1_1Contact.html">Contact</a>
  </div>
</div>
<div class="contents">
<h1>Barry::Contact Class Reference<br/>
<small>
[<a class="el" href="group__RecordParserClasses.html">RecordParserClasses</a>]</small>
</h1><!-- doxytag: class="Barry::Contact" -->
<p>Represents a single record in the Address Book Blackberry database.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="r__contact_8h_source.html">r_contact.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for Barry::Contact:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1Contact__coll__graph.png" border="0" usemap="#Barry_1_1Contact_coll__map" alt="Collaboration graph"/></div>
<map name="Barry_1_1Contact_coll__map" id="Barry_1_1Contact_coll__map">
<area shape="rect" id="node4" href="structBarry_1_1ContactGroupLink.html" title="Barry::ContactGroupLink" alt="" coords="784,5,952,35"/><area shape="rect" id="node6" href="structBarry_1_1PostalAddress.html" title="Barry::PostalAddress" alt="" coords="599,398,748,429"/><area shape="rect" id="node8" title="STL class." alt="" coords="227,425,307,455"/><area shape="rect" id="node16" href="structBarry_1_1UnknownData.html" title="Barry::UnknownData" alt="" coords="428,450,572,481"/><area shape="rect" id="node10" title="STL class." alt="" coords="7,425,175,455"/><area shape="rect" id="node14" href="structBarry_1_1UnknownField.html" title="Barry::UnknownField" alt="" coords="795,450,941,481"/><area shape="rect" id="node19" href="structBarry_1_1Date.html" title="Barry::Date" alt="" coords="1236,570,1327,601"/><area shape="rect" id="node25" href="classBarry_1_1CategoryList.html" title="Barry::CategoryList" alt="" coords="1212,623,1351,654"/><area shape="rect" id="node27" title="STL class." alt="" coords="785,623,951,654"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classBarry_1_1Contact-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">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Contact.html#a4d4222eb7832feeb7f42d34a6ed3967d">GetFullName</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper function that returns a formatted full name.  <a href="#a4d4222eb7832feeb7f42d34a6ed3967d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Contact.html#a804531c27dd0dd17d819385b6502738e">GetEmail</a> (unsigned int index=0) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper function that always returns a valid string.  <a href="#a804531c27dd0dd17d819385b6502738e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Contact.html#ab42c206f31eef4bcd524632aa70a0c41">BuildFields</a> (<a class="el" href="classBarry_1_1Data.html">Data</a> &amp;data, size_t &amp;offset, const <a class="el" href="classBarry_1_1IConverter.html">IConverter</a> *ic=0) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Build fields part of record.  <a href="#ab42c206f31eef4bcd524632aa70a0c41"></a><br/></td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Contact.html#a8dc3a41ab1daa9f744c20c20708e2833">Phone</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This field, Phone, is deprecated.  <a href="#a8dc3a41ab1daa9f744c20c20708e2833"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Represents a single record in the Address Book Blackberry database. </p>

<p>Definition at line <a class="el" href="r__contact_8h_source.html#l00062">62</a> of file <a class="el" href="r__contact_8h_source.html">r_contact.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab42c206f31eef4bcd524632aa70a0c41"></a><!-- doxytag: member="Barry::Contact::BuildFields" ref="ab42c206f31eef4bcd524632aa70a0c41" args="(Data &amp;data, size_t &amp;offset, const IConverter *ic=0) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Barry::Contact::BuildFields </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classBarry_1_1Data.html">Data</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t &amp;&nbsp;</td>
          <td class="paramname"> <em>offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classBarry_1_1IConverter.html">IConverter</a> *&nbsp;</td>
          <td class="paramname"> <em>ic</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Build fields part of record. </p>

<p>Definition at line <a class="el" href="r__contact_8cc_source.html#l00288">288</a> of file <a class="el" href="r__contact_8cc_source.html">r_contact.cc</a>.</p>

<p>References <a class="el" href="record_8cc_source.html#l00416">Barry::CategoryList::CategoryList2Str()</a>, <a class="el" href="r__contact_8cc_source.html#l00442">GetFullName()</a>, <a class="el" href="record_8cc_source.html#l00321">Barry::Date::ToBBString()</a>, and <a class="el" href="data_8cc_source.html#l00263">Barry::Data::Zap()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1Contact_ab42c206f31eef4bcd524632aa70a0c41_cgraph.png" border="0" usemap="#classBarry_1_1Contact_ab42c206f31eef4bcd524632aa70a0c41_cgraph_map" alt=""></div>
<map name="classBarry_1_1Contact_ab42c206f31eef4bcd524632aa70a0c41_cgraph_map" id="classBarry_1_1Contact_ab42c206f31eef4bcd524632aa70a0c41_cgraph">
<area shape="rect" id="node3" href="classBarry_1_1CategoryList.html#ac0ba2e29841783f5dbdaccf41c549be6" title="Turns the current vectory into a comma delimited category string suitable for use..." alt="" coords="239,5,484,35"/><area shape="rect" id="node5" href="classBarry_1_1Contact.html#a4d4222eb7832feeb7f42d34a6ed3967d" title="Helper function that returns a formatted full name." alt="" coords="264,58,459,89"/><area shape="rect" id="node7" href="structBarry_1_1Date.html#a47439d2bce91bb8949063ad432733c53" title="The Blackberry stores Birthday and Anniversary date fields with the format: DD/MM/YYYY..." alt="" coords="277,111,445,142"/><area shape="rect" id="node9" href="classBarry_1_1Data.html#a034f95733ad4e34a3a3f3be874f3c555" title="set buffer to 0 and remove all data" alt="" coords="300,165,423,195"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a804531c27dd0dd17d819385b6502738e"></a><!-- doxytag: member="Barry::Contact::GetEmail" ref="a804531c27dd0dd17d819385b6502738e" args="(unsigned int index=0) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const std::string &amp; Barry::Contact::GetEmail </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>index</em> = <code>0</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Helper function that always returns a valid string. </p>
<p>The string may be empty if there is no address at the specified index. </p>

<p>Definition at line <a class="el" href="r__contact_8cc_source.html#l00457">457</a> of file <a class="el" href="r__contact_8cc_source.html">r_contact.cc</a>.</p>

</div>
</div>
<a class="anchor" id="a4d4222eb7832feeb7f42d34a6ed3967d"></a><!-- doxytag: member="Barry::Contact::GetFullName" ref="a4d4222eb7832feeb7f42d34a6ed3967d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string Barry::Contact::GetFullName </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Helper function that returns a formatted full name. </p>

<p>Definition at line <a class="el" href="r__contact_8cc_source.html#l00442">442</a> of file <a class="el" href="r__contact_8cc_source.html">r_contact.cc</a>.</p>

<p>Referenced by <a class="el" href="r__contact_8cc_source.html#l00288">BuildFields()</a>.</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1Contact_a4d4222eb7832feeb7f42d34a6ed3967d_icgraph.png" border="0" usemap="#classBarry_1_1Contact_a4d4222eb7832feeb7f42d34a6ed3967d_icgraph_map" alt=""></div>
<map name="classBarry_1_1Contact_a4d4222eb7832feeb7f42d34a6ed3967d_icgraph_map" id="classBarry_1_1Contact_a4d4222eb7832feeb7f42d34a6ed3967d_icgraph">
<area shape="rect" id="node3" href="classBarry_1_1Contact.html#ab42c206f31eef4bcd524632aa70a0c41" title="Build fields part of record." alt="" coords="249,5,431,35"/></map>
</div>
</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a8dc3a41ab1daa9f744c20c20708e2833"></a><!-- doxytag: member="Barry::Contact::Phone" ref="a8dc3a41ab1daa9f744c20c20708e2833" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string <a class="el" href="classBarry_1_1Contact.html#a8dc3a41ab1daa9f744c20c20708e2833">Barry::Contact::Phone</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>This field, Phone, is deprecated. </p>
<p>It is possible to write to this field to the Blackberry, but modern devices won't let you add it through their GUIs. This field only seems to exist on the 7750. While other devices accept the field and display it, it is not accessible by default. </p>

<p>Definition at line <a class="el" href="r__contact_8h_source.html#l00088">88</a> of file <a class="el" href="r__contact_8h_source.html">r_contact.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="r__contact_8h_source.html">r_contact.h</a></li>
<li><a class="el" href="r__contact_8cc_source.html">r_contact.cc</a></li>
</ul>
</div>
<hr class="footer"/><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-20100208 </small></address>
</body>
</html>