doc/www/doxygen/html/classBarry_1_1Contact.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: Barry::Contact Class Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li class="current"><a href="classes.html"><span>Classes</span></a></li>
  15       <li><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="tabs">
  20     <ul>
  21       <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
  22       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  23       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  24       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  25     </ul>
  26   </div>
  27   <div class="navpath"><a class="el" href="namespaceBarry.html">Barry</a>::<a class="el" href="classBarry_1_1Contact.html">Contact</a>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>Barry::Contact Class Reference<br>
  32 <small>
  33 [<a class="el" href="group__RecordParserClasses.html">RecordParserClasses</a>]</small>
  34 </h1><!-- doxytag: class="Barry::Contact" --><code>#include &lt;<a class="el" href="r__contact_8h-source.html">r_contact.h</a>&gt;</code>
  35 <p>
  36 <div class="dynheader">
  37 Collaboration diagram for Barry::Contact:</div>
  38 <div class="dynsection">
  39 <p><center><img src="classBarry_1_1Contact__coll__graph.png" border="0" usemap="#Barry_1_1Contact__coll__map" alt="Collaboration graph"></center>
  40 <map name="Barry_1_1Contact__coll__map">
  41 <area shape="rect" title="STL class." alt="" coords="67,96,147,123"><area shape="rect" title="STL class." alt="" coords="24,5,189,32"><area shape="rect" title="STL class." alt="" coords="492,189,607,216"><area shape="rect" title="STL class." alt="" coords="592,96,757,123"></map>
  42 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  43
  44 <p>
  45 <a href="classBarry_1_1Contact-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  46 Represents a single record in the Address Book Blackberry database.
  47 <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>
  48 <table border="0" cellpadding="0" cellspacing="0">
  49 <tr><td></td></tr>
  50 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  51 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Contact.html#4d4222eb7832feeb7f42d34a6ed3967d">GetFullName</a> () const </td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper function that returns a formatted full name.  <a href="#4d4222eb7832feeb7f42d34a6ed3967d"></a><br></td></tr>
  54 <tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Contact.html#804531c27dd0dd17d819385b6502738e">GetEmail</a> (unsigned int index=0) const </td></tr>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper function that always returns a valid string.  <a href="#804531c27dd0dd17d819385b6502738e"></a><br></td></tr>
  57 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Contact.html#b42c206f31eef4bcd524632aa70a0c41">BuildFields</a> (Data &amp;data, size_t &amp;offset, const <a class="el" href="classBarry_1_1IConverter.html">IConverter</a> *ic=0) const </td></tr>
  58
  59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Build fields part of record.  <a href="#b42c206f31eef4bcd524632aa70a0c41"></a><br></td></tr>
  60 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
  61 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Contact.html#8dc3a41ab1daa9f744c20c20708e2833">Phone</a></td></tr>
  62
  63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This field, Phone, is deprecated.  <a href="#8dc3a41ab1daa9f744c20c20708e2833"></a><br></td></tr>
  64 </table>
  65 <hr><h2>Member Function Documentation</h2>
  66 <a class="anchor" name="4d4222eb7832feeb7f42d34a6ed3967d"></a><!-- doxytag: member="Barry::Contact::GetFullName" ref="4d4222eb7832feeb7f42d34a6ed3967d" args="() const " -->
  67 <div class="memitem">
  68 <div class="memproto">
  69       <table class="memname">
  70         <tr>
  71           <td class="memname">std::string Barry::Contact::GetFullName           </td>
  72           <td>(</td>
  73           <td class="paramname">          </td>
  74           <td>&nbsp;)&nbsp;</td>
  75           <td> const</td>
  76         </tr>
  77       </table>
  78 </div>
  79 <div class="memdoc">
  80
  81 <p>
  82 Helper function that returns a formatted full name.
  83 <p>
  84
  85 <p>Definition at line <a class="el" href="r__contact_8cc-source.html#l00465">465</a> of file <a class="el" href="r__contact_8cc-source.html">r_contact.cc</a>.</p>
  86
  87 <p>Referenced by <a class="el" href="r__contact_8cc-source.html#l00301">BuildFields()</a>.</p>
  88
  89 <p>
  90 <div class="dynheader">
  91 Here is the caller graph for this function:</div>
  92 <div class="dynsection">
  93 <p><center><img src="classBarry_1_1Contact_4d4222eb7832feeb7f42d34a6ed3967d_icgraph.png" border="0" usemap="#classBarry_1_1Contact_4d4222eb7832feeb7f42d34a6ed3967d_icgraph_map" alt=""></center>
  94 <map name="classBarry_1_1Contact_4d4222eb7832feeb7f42d34a6ed3967d_icgraph_map">
  95 <area shape="rect" href="classBarry_1_1Contact.html#b42c206f31eef4bcd524632aa70a0c41" title="Build fields part of record." alt="" coords="244,5,420,32"></map>
  96 </div>
  97
  98 </div>
  99 </div><p>
 100 <a class="anchor" name="804531c27dd0dd17d819385b6502738e"></a><!-- doxytag: member="Barry::Contact::GetEmail" ref="804531c27dd0dd17d819385b6502738e" args="(unsigned int index=0) const " -->
 101 <div class="memitem">
 102 <div class="memproto">
 103       <table class="memname">
 104         <tr>
 105           <td class="memname">const std::string &amp; Barry::Contact::GetEmail           </td>
 106           <td>(</td>
 107           <td class="paramtype">unsigned int&nbsp;</td>
 108           <td class="paramname"> <em>index</em> = <code>0</code>          </td>
 109           <td>&nbsp;)&nbsp;</td>
 110           <td> const</td>
 111         </tr>
 112       </table>
 113 </div>
 114 <div class="memdoc">
 115
 116 <p>
 117 Helper function that always returns a valid string.
 118 <p>
 119 The string may be empty if there is no address at the specified index.
 120 <p>Definition at line <a class="el" href="r__contact_8cc-source.html#l00480">480</a> of file <a class="el" href="r__contact_8cc-source.html">r_contact.cc</a>.</p>
 121
 122 </div>
 123 </div><p>
 124 <a class="anchor" name="b42c206f31eef4bcd524632aa70a0c41"></a><!-- doxytag: member="Barry::Contact::BuildFields" ref="b42c206f31eef4bcd524632aa70a0c41" args="(Data &amp;data, size_t &amp;offset, const IConverter *ic=0) const " -->
 125 <div class="memitem">
 126 <div class="memproto">
 127       <table class="memname">
 128         <tr>
 129           <td class="memname">void Barry::Contact::BuildFields           </td>
 130           <td>(</td>
 131           <td class="paramtype">Data &amp;&nbsp;</td>
 132           <td class="paramname"> <em>data</em>, </td>
 133         </tr>
 134         <tr>
 135           <td class="paramkey"></td>
 136           <td></td>
 137           <td class="paramtype">size_t &amp;&nbsp;</td>
 138           <td class="paramname"> <em>offset</em>, </td>
 139         </tr>
 140         <tr>
 141           <td class="paramkey"></td>
 142           <td></td>
 143           <td class="paramtype">const <a class="el" href="classBarry_1_1IConverter.html">IConverter</a> *&nbsp;</td>
 144           <td class="paramname"> <em>ic</em> = <code>0</code></td><td>&nbsp;</td>
 145         </tr>
 146         <tr>
 147           <td></td>
 148           <td>)</td>
 149           <td></td><td></td><td> const</td>
 150         </tr>
 151       </table>
 152 </div>
 153 <div class="memdoc">
 154
 155 <p>
 156 Build fields part of record.
 157 <p>
 158
 159 <p>Definition at line <a class="el" href="r__contact_8cc-source.html#l00301">301</a> of file <a class="el" href="r__contact_8cc-source.html">r_contact.cc</a>.</p>
 160
 161 <p>References <a class="el" href="r__contact_8cc-source.html#l00465">GetFullName()</a>, and <a class="el" href="iconv_8cc-source.html#l00129">Barry::IConverter::ToBB()</a>.</p>
 162
 163 <p>
 164 <div class="dynheader">
 165 Here is the call graph for this function:</div>
 166 <div class="dynsection">
 167 <p><center><img src="classBarry_1_1Contact_b42c206f31eef4bcd524632aa70a0c41_cgraph.png" border="0" usemap="#classBarry_1_1Contact_b42c206f31eef4bcd524632aa70a0c41_cgraph_map" alt=""></center>
 168 <map name="classBarry_1_1Contact_b42c206f31eef4bcd524632aa70a0c41_cgraph_map">
 169 <area shape="rect" href="classBarry_1_1Contact.html#4d4222eb7832feeb7f42d34a6ed3967d" title="Helper function that returns a formatted full name." alt="" coords="232,5,421,32"><area shape="rect" href="classBarry_1_1IConverter.html#d67779110abd44d8c6b746822beea20c" title="Barry::IConverter::ToBB" alt="" coords="247,56,407,83"></map>
 170 </div>
 171
 172 </div>
 173 </div><p>
 174 <hr><h2>Member Data Documentation</h2>
 175 <a class="anchor" name="8dc3a41ab1daa9f744c20c20708e2833"></a><!-- doxytag: member="Barry::Contact::Phone" ref="8dc3a41ab1daa9f744c20c20708e2833" args="" -->
 176 <div class="memitem">
 177 <div class="memproto">
 178       <table class="memname">
 179         <tr>
 180           <td class="memname">std::string <a class="el" href="classBarry_1_1Contact.html#8dc3a41ab1daa9f744c20c20708e2833">Barry::Contact::Phone</a>          </td>
 181         </tr>
 182       </table>
 183 </div>
 184 <div class="memdoc">
 185
 186 <p>
 187 This field, Phone, is deprecated.
 188 <p>
 189 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.
 190 <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>
 191
 192 </div>
 193 </div><p>
 194 <hr>The documentation for this class was generated from the following files:<ul>
 195 <li><a class="el" href="r__contact_8h-source.html">r_contact.h</a><li><a class="el" href="r__contact_8cc-source.html">r_contact.cc</a></ul>
 196 </div>
 197 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:14:43 2011 for Barry by&nbsp;
 198 <a href="http://www.doxygen.org/index.html">
 199 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 200 </body>
 201 </html>