Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_t_my_class.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: TMyClass 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>TMyClass Class Reference</h1><!-- doxytag: class="TMyClass" -->
<p><a href="class_t_my_class-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_my_class.html#a0cd85e121a9381570a6e661822e7f328">TMyClass</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_my_class.html#a3e3f5a602a8be6eca1be2e6bc9287145">TMyClass</a> (const TDesC &amp;aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_my_class.html#aca6375111d2a8a4f8ee068e2d882ff40">SetBuf</a> (const TDesC &amp;aDes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const TDesC &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_my_class.html#a748ac22426e7695ccfb1af1dd88c96a9">GetBuf</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Demonstrates a simple class containing a simple buffer and methods</p>
<ul>
<li>create a text buffer using new value</li>
<li>to set value to buffer</li>
<li>retrieve buffer's value </li>
</ul>

<p>Definition at line <a class="el" href="circularbuffer_8h_source.html#l00058">58</a> of file <a class="el" href="circularbuffer_8h_source.html">circularbuffer.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a0cd85e121a9381570a6e661822e7f328"></a><!-- doxytag: member="TMyClass::TMyClass" ref="a0cd85e121a9381570a6e661822e7f328" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TMyClass::TMyClass </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor. </p>

<p>Definition at line <a class="el" href="circularbuffer_8cpp_source.html#l00036">36</a> of file <a class="el" href="circularbuffer_8cpp_source.html">circularbuffer.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a3e3f5a602a8be6eca1be2e6bc9287145"></a><!-- doxytag: member="TMyClass::TMyClass" ref="a3e3f5a602a8be6eca1be2e6bc9287145" args="(const TDesC &amp;aDes)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TMyClass::TMyClass </td>
          <td>(</td>
          <td class="paramtype">const TDesC &amp;&nbsp;</td>
          <td class="paramname"> <em>aDes</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor. This overload <a class="el" href="class_t_my_class.html">TMyClass</a> constructor using a descriptor </p>

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

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aca6375111d2a8a4f8ee068e2d882ff40"></a><!-- doxytag: member="TMyClass::SetBuf" ref="aca6375111d2a8a4f8ee068e2d882ff40" args="(const TDesC &amp;aDes)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void TMyClass::SetBuf </td>
          <td>(</td>
          <td class="paramtype">const TDesC &amp;&nbsp;</td>
          <td class="paramname"> <em>aDes</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set <a class="el" href="class_t_my_class.html">TMyClass</a> buffer using a descriptor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aDes</em>&nbsp;</td><td>contains the new value for buffer. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="circularbuffer_8cpp_source.html#l00056">56</a> of file <a class="el" href="circularbuffer_8cpp_source.html">circularbuffer.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a748ac22426e7695ccfb1af1dd88c96a9"></a><!-- doxytag: member="TMyClass::GetBuf" ref="a748ac22426e7695ccfb1af1dd88c96a9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TDesC &amp; TMyClass::GetBuf </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Get <a class="el" href="class_t_my_class.html">TMyClass</a> buffers. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A buffer contains the objects. </dd></dl>

<p>Definition at line <a class="el" href="circularbuffer_8cpp_source.html#l00048">48</a> of file <a class="el" href="circularbuffer_8cpp_source.html">circularbuffer.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>