Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_rich_text_editor_r_t_e.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: CRichTextEditorRTE 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>CRichTextEditorRTE Class Reference</h1><!-- doxytag: class="CRichTextEditorRTE" -->
<p><a href="class_c_rich_text_editor_r_t_e-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"><a class="anchor" id="abb4d9474022c8185a47d4b48eeafa36d"></a><!-- doxytag: member="CRichTextEditorRTE::OfferKeyEventL" ref="abb4d9474022c8185a47d4b48eeafa36d" args="(const TKeyEvent &aKeyEvent, TEventCode aType)" -->
TKeyResponse </td><td class="memItemRight" valign="bottom"><b>OfferKeyEventL</b> (const TKeyEvent &aKeyEvent, TEventCode aType)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rich_text_editor_r_t_e.html#a5a57f8dee12cf629be85b72d6c398608">AddCarriageReturnL</a> (TInt pos)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rich_text_editor_r_t_e.html#a55419e53857c052199a26977966eca71">AddTextL</a> (const TDesC &aText)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rich_text_editor_r_t_e.html#af51a90c13c4f3e57a4e18f54029e3410">SetTextUnderlineOn</a> (TBool aUnderlineOn)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rich_text_editor_r_t_e.html#a70426200693750d151de3d131da11cdc">DrawTextWithoutCarriageL</a> (const TDesC &aText)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rich_text_editor_r_t_e.html#a316eeab83bf529ab9fdeec9afa670952">DrawLineL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rich_text_editor_r_t_e.html#acff56dfc81d8c60fc20dba36b4b153a5">ClearScreenL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb4d9474022c8185a47d4b48eeafa36d"></a><!-- doxytag: member="CRichTextEditorRTE::OfferKeyEventL" ref="abb4d9474022c8185a47d4b48eeafa36d" args="(const TKeyEvent &aKeyEvent, TEventCode aType)" -->
TKeyResponse </td><td class="memItemRight" valign="bottom"><b>OfferKeyEventL</b> (const TKeyEvent &aKeyEvent, TEventCode aType)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71a851743a10d738d25082895ae0458e"></a><!-- doxytag: member="CRichTextEditorRTE::AddCarriageReturnL" ref="a71a851743a10d738d25082895ae0458e" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>AddCarriageReturnL</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55419e53857c052199a26977966eca71"></a><!-- doxytag: member="CRichTextEditorRTE::AddTextL" ref="a55419e53857c052199a26977966eca71" args="(const TDesC &aText)" -->
void </td><td class="memItemRight" valign="bottom"><b>AddTextL</b> (const TDesC &aText)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rich_text_editor_r_t_e.html#a8485f9c132993b4586536724a8ad1d99">NewL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rich_text_editor_r_t_e.html#af6b32a535f84a829fd49160d70e91614">NewLC</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rich_text_editor_r_t_e.html#aba44d99d192b4fdd2e9540bebee50b9e">NewL</a> (const CCoeControl &aView)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rich_text_editor_r_t_e.html#ae6ee8012092e261bcf4c88e3d1b9c735">NewLC</a> (const CCoeControl &aView)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> Editor that prints text. </p>
<p>Definition at line <a class="el" href="_bluetooth_p_m_p_example_richtexteditorrte_8h_source.html#l00022">22</a> of file <a class="el" href="_bluetooth_p_m_p_example_richtexteditorrte_8h_source.html">BluetoothPMPExampleRichtexteditorrte.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8485f9c132993b4586536724a8ad1d99"></a><!-- doxytag: member="CRichTextEditorRTE::NewL" ref="a8485f9c132993b4586536724a8ad1d99" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> * CRichTextEditorRTE::NewL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Instance of <a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a>. </dd></dl>
<p>Definition at line <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html#l00158">158</a> of file <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html">BluetoothPMPExampleRichTextEditorRTE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af6b32a535f84a829fd49160d70e91614"></a><!-- doxytag: member="CRichTextEditorRTE::NewLC" ref="af6b32a535f84a829fd49160d70e91614" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> * CRichTextEditorRTE::NewLC </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Instance of <a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a>. </dd></dl>
<p>Definition at line <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html#l00170">170</a> of file <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html">BluetoothPMPExampleRichTextEditorRTE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5a57f8dee12cf629be85b72d6c398608"></a><!-- doxytag: member="CRichTextEditorRTE::AddCarriageReturnL" ref="a5a57f8dee12cf629be85b72d6c398608" args="(TInt pos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRichTextEditorRTE::AddCarriageReturnL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>pos</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add one carriage return to the spesified position. </p>
<p>Definition at line <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html#l00050">50</a> of file <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html">BluetoothPMPExampleRichTextEditorRTE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a55419e53857c052199a26977966eca71"></a><!-- doxytag: member="CRichTextEditorRTE::AddTextL" ref="a55419e53857c052199a26977966eca71" args="(const TDesC &aText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRichTextEditorRTE::AddTextL </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aText</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print text on the screen. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aText</em> </td><td>text to be displayed </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html#l00068">68</a> of file <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html">BluetoothPMPExampleRichTextEditorRTE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af51a90c13c4f3e57a4e18f54029e3410"></a><!-- doxytag: member="CRichTextEditorRTE::SetTextUnderlineOn" ref="af51a90c13c4f3e57a4e18f54029e3410" args="(TBool aUnderlineOn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRichTextEditorRTE::SetTextUnderlineOn </td>
<td>(</td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aUnderlineOn</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set text undeline on. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aUnderlineOn</em> </td><td>ETrue if underline is used, EFalse otherwise. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html#l00129">129</a> of file <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html">BluetoothPMPExampleRichTextEditorRTE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a70426200693750d151de3d131da11cdc"></a><!-- doxytag: member="CRichTextEditorRTE::DrawTextWithoutCarriageL" ref="a70426200693750d151de3d131da11cdc" args="(const TDesC &aText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRichTextEditorRTE::DrawTextWithoutCarriageL </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aText</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print text on the screen. No Carriage return at the end. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aText</em> </td><td>text to be displayed </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html#l00107">107</a> of file <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html">BluetoothPMPExampleRichTextEditorRTE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a316eeab83bf529ab9fdeec9afa670952"></a><!-- doxytag: member="CRichTextEditorRTE::DrawLineL" ref="a316eeab83bf529ab9fdeec9afa670952" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRichTextEditorRTE::DrawLineL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draw a line that separates log events </p>
<p>Definition at line <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html#l00147">147</a> of file <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html">BluetoothPMPExampleRichTextEditorRTE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acff56dfc81d8c60fc20dba36b4b153a5"></a><!-- doxytag: member="CRichTextEditorRTE::ClearScreenL" ref="acff56dfc81d8c60fc20dba36b4b153a5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRichTextEditorRTE::ClearScreenL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears the screen from log text </p>
<p>Definition at line <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html#l00212">212</a> of file <a class="el" href="_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.html">BluetoothPMPExampleRichTextEditorRTE.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aba44d99d192b4fdd2e9540bebee50b9e"></a><!-- doxytag: member="CRichTextEditorRTE::NewL" ref="aba44d99d192b4fdd2e9540bebee50b9e" args="(const CCoeControl &aView)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> * CRichTextEditorRTE::NewL </td>
<td>(</td>
<td class="paramtype">const CCoeControl & </td>
<td class="paramname"> <em>aView</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_rich_text_editor_r_t_e.html#a8485f9c132993b4586536724a8ad1d99">NewL()</a></p>
<p>discussion Create a <a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> object, which will draw itself to aRect </p>
<p>Definition at line <a class="el" href="richtexteditorrte_8cpp_source.html#l00075">75</a> of file <a class="el" href="richtexteditorrte_8cpp_source.html">richtexteditorrte.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae6ee8012092e261bcf4c88e3d1b9c735"></a><!-- doxytag: member="CRichTextEditorRTE::NewLC" ref="ae6ee8012092e261bcf4c88e3d1b9c735" args="(const CCoeControl &aView)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> * CRichTextEditorRTE::NewLC </td>
<td>(</td>
<td class="paramtype">const CCoeControl & </td>
<td class="paramname"> <em>aView</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_rich_text_editor_r_t_e.html#af6b32a535f84a829fd49160d70e91614">NewLC()</a> </p>
<p>Definition at line <a class="el" href="richtexteditorrte_8cpp_source.html#l00082">82</a> of file <a class="el" href="richtexteditorrte_8cpp_source.html">richtexteditorrte.cpp</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>