Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_key_reader.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: CKeyReader 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>CKeyReader Class Reference</h1><!-- doxytag: class="CKeyReader" -->
<p><a href="class_c_key_reader-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#aefb1aabce1e5c7fbc3639171e8a86f96">CKeyReader</a> (CConsoleBase *aConsole, <a class="el" href="class_c_searchsort_example.html">CSearchsortExample</a> *aExample)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#adce78036855ed407e3d5815dea8a3ff9">~CKeyReader</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#a7869521f7564a32ddd19408486e963a8">StartL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe39dfc956395ebca0cfb9f1ddcec0c9"></a><!-- doxytag: member="CKeyReader::RunL" ref="afe39dfc956395ebca0cfb9f1ddcec0c9" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>RunL</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01e9e7b7177e4f2825a530a016b58ec6"></a><!-- doxytag: member="CKeyReader::DoCancel" ref="a01e9e7b7177e4f2825a530a016b58ec6" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>DoCancel</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#adb683d57fbfeb45e630dd2e7153dad9a">RunError</a> (TInt aError)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#ac0bffdacd56e87ec8b385a53fbf90a14">SearchSortSettings</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#a87b034aea450dd750e09fa70f69c027f">ResetSettings</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#ad2ff85a21a05c51222ce2809721bbb56">CreateMessageEntriesL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#a2ca908955abf805be2cf1e8127e55ad0">DisplayMessageSummary</a> ()</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBuf< 32 > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#a82769fc3c7df03845b45f99dba7aa4d7">iFrominfo</a> [KMaxEntryCount]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe9ec8416712a0b9acf6a76afd5f33a4"></a><!-- doxytag: member="CKeyReader::iToinfo" ref="abe9ec8416712a0b9acf6a76afd5f33a4" args="[KMaxEntryCount]" -->
TBuf< 32 > </td><td class="memItemRight" valign="bottom"><b>iToinfo</b> [KMaxEntryCount]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a206d2160a33c03a1df550d8aa2001801"></a><!-- doxytag: member="CKeyReader::iSubjectinfo" ref="a206d2160a33c03a1df550d8aa2001801" args="[KMaxEntryCount]" -->
TBuf< 32 > </td><td class="memItemRight" valign="bottom"><b>iSubjectinfo</b> [KMaxEntryCount]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBuf< 64 > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_key_reader.html#a6828ce79277f8950ff3a6a24a02b2d17">iSender</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77766d9d3de32723a7e787a0e3b19507"></a><!-- doxytag: member="CKeyReader::iCaseSensitivityON" ref="a77766d9d3de32723a7e787a0e3b19507" args="" -->
TBool </td><td class="memItemRight" valign="bottom"><b>iCaseSensitivityON</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a099512c3d0af0134637e8e4727da9f7e"></a><!-- doxytag: member="CKeyReader::iWholeWordSearch" ref="a099512c3d0af0134637e8e4727da9f7e" args="" -->
TBool </td><td class="memItemRight" valign="bottom"><b>iWholeWordSearch</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41937612d58d1ba25f5def27814a67f1"></a><!-- doxytag: member="CKeyReader::iCombinedSearch" ref="a41937612d58d1ba25f5def27814a67f1" args="" -->
TBool </td><td class="memItemRight" valign="bottom"><b>iCombinedSearch</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Reads keypresses in asynchronous way and calls example functions. </p>
<p>Definition at line <a class="el" href="_messaging_2_search_sort_example_2example_8h_source.html#l00027">27</a> of file <a class="el" href="_messaging_2_search_sort_example_2example_8h_source.html">example.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aefb1aabce1e5c7fbc3639171e8a86f96"></a><!-- doxytag: member="CKeyReader::CKeyReader" ref="aefb1aabce1e5c7fbc3639171e8a86f96" 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 * </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> * </td>
<td class="paramname"> <em>aExample</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<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>
<a class="anchor" id="adce78036855ed407e3d5815dea8a3ff9"></a><!-- doxytag: member="CKeyReader::~CKeyReader" ref="adce78036855ed407e3d5815dea8a3ff9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CKeyReader::~CKeyReader </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Desructor. </p>
<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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7869521f7564a32ddd19408486e963a8"></a><!-- doxytag: member="CKeyReader::StartL" ref="a7869521f7564a32ddd19408486e963a8" 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> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request Function, this takes the key inputs. </p>
<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>
<a class="anchor" id="adb683d57fbfeb45e630dd2e7153dad9a"></a><!-- doxytag: member="CKeyReader::RunError" ref="adb683d57fbfeb45e630dd2e7153dad9a" 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 </td>
<td class="paramname"> <em>aError</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handling leaving of RunL. </p>
<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>
<a class="anchor" id="ac0bffdacd56e87ec8b385a53fbf90a14"></a><!-- doxytag: member="CKeyReader::SearchSortSettings" ref="ac0bffdacd56e87ec8b385a53fbf90a14" 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> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function for making search-sort settings. </p>
<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>
<a class="anchor" id="a87b034aea450dd750e09fa70f69c027f"></a><!-- doxytag: member="CKeyReader::ResetSettings" ref="a87b034aea450dd750e09fa70f69c027f" 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> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function for resetting search-sort settings. </p>
<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>
<a class="anchor" id="ad2ff85a21a05c51222ce2809721bbb56"></a><!-- doxytag: member="CKeyReader::CreateMessageEntriesL" ref="ad2ff85a21a05c51222ce2809721bbb56" 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> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function for creating message entries. </p>
<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>
<a class="anchor" id="a2ca908955abf805be2cf1e8127e55ad0"></a><!-- doxytag: member="CKeyReader::DisplayMessageSummary" ref="a2ca908955abf805be2cf1e8127e55ad0" 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> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function for displaying message summary. </p>
<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>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a82769fc3c7df03845b45f99dba7aa4d7"></a><!-- doxytag: member="CKeyReader::iFrominfo" ref="a82769fc3c7df03845b45f99dba7aa4d7" args="[KMaxEntryCount]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBuf<32> <a class="el" href="class_c_key_reader.html#a82769fc3c7df03845b45f99dba7aa4d7">CKeyReader::iFrominfo</a>[KMaxEntryCount]</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Buffer for getting message header info </p>
<p>Definition at line <a class="el" href="_messaging_2_search_sort_example_2example_8h_source.html#l00080">80</a> of file <a class="el" href="_messaging_2_search_sort_example_2example_8h_source.html">example.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6828ce79277f8950ff3a6a24a02b2d17"></a><!-- doxytag: member="CKeyReader::iSender" ref="a6828ce79277f8950ff3a6a24a02b2d17" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBuf<64> <a class="el" href="class_c_key_reader.html#a6828ce79277f8950ff3a6a24a02b2d17">CKeyReader::iSender</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Variables taking user input and hence used in search-sort settings </p>
<p>Definition at line <a class="el" href="_messaging_2_search_sort_example_2example_8h_source.html#l00087">87</a> of file <a class="el" href="_messaging_2_search_sort_example_2example_8h_source.html">example.h</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>