Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_key_reader.html
author Dominic Pinkman <Dominic.Pinkman@Nokia.com>
Fri, 22 Jan 2010 18:26:19 +0000
changeset 1 25a17d01db0c
child 6 43e37759235e
permissions -rw-r--r--
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: CKeyReader Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>CKeyReader Class Reference</h1><!-- doxytag: class="CKeyReader" -->
<p>
<a href="class_c_key_reader-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#efb1aabce1e5c7fbc3639171e8a86f96">CKeyReader</a> (CConsoleBase *aConsole, <a class="el" href="class_c_searchsort_example.html">CSearchsortExample</a> *aExample)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#dce78036855ed407e3d5815dea8a3ff9">~CKeyReader</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#7869521f7564a32ddd19408486e963a8">StartL</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fe39dfc956395ebca0cfb9f1ddcec0c9"></a><!-- doxytag: member="CKeyReader::RunL" ref="fe39dfc956395ebca0cfb9f1ddcec0c9" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#fe39dfc956395ebca0cfb9f1ddcec0c9">RunL</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="01e9e7b7177e4f2825a530a016b58ec6"></a><!-- doxytag: member="CKeyReader::DoCancel" ref="01e9e7b7177e4f2825a530a016b58ec6" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#01e9e7b7177e4f2825a530a016b58ec6">DoCancel</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#db683d57fbfeb45e630dd2e7153dad9a">RunError</a> (TInt aError)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">TBool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#c0bffdacd56e87ec8b385a53fbf90a14">SearchSortSettings</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#87b034aea450dd750e09fa70f69c027f">ResetSettings</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#d2ff85a21a05c51222ce2809721bbb56">CreateMessageEntriesL</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#2ca908955abf805be2cf1e8127e55ad0">DisplayMessageSummary</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TBuf&lt; 32 &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#82769fc3c7df03845b45f99dba7aa4d7">iFrominfo</a> [KMaxEntryCount]</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be9ec8416712a0b9acf6a76afd5f33a4"></a><!-- doxytag: member="CKeyReader::iToinfo" ref="be9ec8416712a0b9acf6a76afd5f33a4" args="[KMaxEntryCount]" -->
TBuf&lt; 32 &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#be9ec8416712a0b9acf6a76afd5f33a4">iToinfo</a> [KMaxEntryCount]</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="206d2160a33c03a1df550d8aa2001801"></a><!-- doxytag: member="CKeyReader::iSubjectinfo" ref="206d2160a33c03a1df550d8aa2001801" args="[KMaxEntryCount]" -->
TBuf&lt; 32 &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#206d2160a33c03a1df550d8aa2001801">iSubjectinfo</a> [KMaxEntryCount]</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">TBuf&lt; 64 &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#6828ce79277f8950ff3a6a24a02b2d17">iSender</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="77766d9d3de32723a7e787a0e3b19507"></a><!-- doxytag: member="CKeyReader::iCaseSensitivityON" ref="77766d9d3de32723a7e787a0e3b19507" args="" -->
TBool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#77766d9d3de32723a7e787a0e3b19507">iCaseSensitivityON</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="099512c3d0af0134637e8e4727da9f7e"></a><!-- doxytag: member="CKeyReader::iWholeWordSearch" ref="099512c3d0af0134637e8e4727da9f7e" args="" -->
TBool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#099512c3d0af0134637e8e4727da9f7e">iWholeWordSearch</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="41937612d58d1ba25f5def27814a67f1"></a><!-- doxytag: member="CKeyReader::iCombinedSearch" ref="41937612d58d1ba25f5def27814a67f1" args="" -->
TBool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#41937612d58d1ba25f5def27814a67f1">iCombinedSearch</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Reads keypresses in asynchronous way and calls example functions. 
<p>Definition at line <a class="el" href="example_8h-source.html#l00027">27</a> of file <a class="el" href="example_8h-source.html">example.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="efb1aabce1e5c7fbc3639171e8a86f96"></a><!-- doxytag: member="CKeyReader::CKeyReader" ref="efb1aabce1e5c7fbc3639171e8a86f96" args="(CConsoleBase *aConsole, CSearchsortExample *aExample)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CKeyReader::CKeyReader           </td>
          <td>(</td>
          <td class="paramtype">CConsoleBase *&nbsp;</td>
          <td class="paramname"> <em>aConsole</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_c_searchsort_example.html">CSearchsortExample</a> *&nbsp;</td>
          <td class="paramname"> <em>aExample</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor. 
<p>Definition at line <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html#l00080">80</a> of file <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html">example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="dce78036855ed407e3d5815dea8a3ff9"></a><!-- doxytag: member="CKeyReader::~CKeyReader" ref="dce78036855ed407e3d5815dea8a3ff9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CKeyReader::~CKeyReader           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Desructor. 
<p>Definition at line <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html#l00094">94</a> of file <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html">example.cpp</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7869521f7564a32ddd19408486e963a8"></a><!-- doxytag: member="CKeyReader::StartL" ref="7869521f7564a32ddd19408486e963a8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CKeyReader::StartL           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Request Function, this takes the key inputs. 
<p>Definition at line <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html#l00100">100</a> of file <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html">example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="db683d57fbfeb45e630dd2e7153dad9a"></a><!-- doxytag: member="CKeyReader::RunError" ref="db683d57fbfeb45e630dd2e7153dad9a" args="(TInt aError)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TInt CKeyReader::RunError           </td>
          <td>(</td>
          <td class="paramtype">TInt&nbsp;</td>
          <td class="paramname"> <em>aError</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Handling leaving of RunL. 
<p>Definition at line <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html#l00272">272</a> of file <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html">example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="c0bffdacd56e87ec8b385a53fbf90a14"></a><!-- doxytag: member="CKeyReader::SearchSortSettings" ref="c0bffdacd56e87ec8b385a53fbf90a14" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TBool CKeyReader::SearchSortSettings           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Function for making search-sort settings. 
<p>Definition at line <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html#l00331">331</a> of file <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html">example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="87b034aea450dd750e09fa70f69c027f"></a><!-- doxytag: member="CKeyReader::ResetSettings" ref="87b034aea450dd750e09fa70f69c027f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CKeyReader::ResetSettings           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Function for resetting search-sort settings. 
<p>Definition at line <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html#l00406">406</a> of file <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html">example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="d2ff85a21a05c51222ce2809721bbb56"></a><!-- doxytag: member="CKeyReader::CreateMessageEntriesL" ref="d2ff85a21a05c51222ce2809721bbb56" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CKeyReader::CreateMessageEntriesL           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Function for creating message entries. 
<p>Definition at line <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html#l00280">280</a> of file <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html">example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="2ca908955abf805be2cf1e8127e55ad0"></a><!-- doxytag: member="CKeyReader::DisplayMessageSummary" ref="2ca908955abf805be2cf1e8127e55ad0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CKeyReader::DisplayMessageSummary           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Function for displaying message summary. 
<p>Definition at line <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html#l00293">293</a> of file <a class="el" href="_messaging_2_search_sort_example_2example_8cpp-source.html">example.cpp</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="82769fc3c7df03845b45f99dba7aa4d7"></a><!-- doxytag: member="CKeyReader::iFrominfo" ref="82769fc3c7df03845b45f99dba7aa4d7" args="[KMaxEntryCount]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TBuf&lt;32&gt; <a class="el" href="class_c_key_reader.html#82769fc3c7df03845b45f99dba7aa4d7">CKeyReader::iFrominfo</a>[KMaxEntryCount]          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Buffer for getting message header info 
<p>Definition at line <a class="el" href="example_8h-source.html#l00080">80</a> of file <a class="el" href="example_8h-source.html">example.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="6828ce79277f8950ff3a6a24a02b2d17"></a><!-- doxytag: member="CKeyReader::iSender" ref="6828ce79277f8950ff3a6a24a02b2d17" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TBuf&lt;64&gt; <a class="el" href="class_c_key_reader.html#6828ce79277f8950ff3a6a24a02b2d17">CKeyReader::iSender</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Variables taking user input and hence used in search-sort settings 
<p>Definition at line <a class="el" href="example_8h-source.html#l00087">87</a> of file <a class="el" href="example_8h-source.html">example.h</a>.</p>

</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:06 2010 for TB10.1 Example Applications by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>