Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/richtexteditorrte_8h_source.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: examples/ForumNokia/ThreadExample/inc/richtexteditorrte.h Source File</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 -->
<h1>examples/ForumNokia/ThreadExample/inc/richtexteditorrte.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">* ============================================================================</span>
<a name="l00003"></a>00003 <span class="comment">* Name : CRichTextEditorRTE from CRichTextEditorRTE.h</span>
<a name="l00004"></a>00004 <span class="comment">* Part of : Thread</span>
<a name="l00005"></a>00005 <span class="comment">* Created : 04.02.2005 by Forum Nokia</span>
<a name="l00006"></a>00006 <span class="comment">* Description:</span>
<a name="l00007"></a>00007 <span class="comment">* RichtTextEditor that prints text on the screen and handles scrolling.</span>
<a name="l00008"></a>00008 <span class="comment">* Version : 1.0</span>
<a name="l00009"></a>00009 <span class="comment">* Copyright: Nokia Corporation</span>
<a name="l00010"></a>00010 <span class="comment">* ============================================================================</span>
<a name="l00011"></a>00011 <span class="comment">*/</span>
<a name="l00012"></a>00012
<a name="l00013"></a>00013 <span class="preprocessor">#ifndef CRICHTEXTEDITOR_H</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor">#define CRICHTEXTEDITOR_H</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span>
<a name="l00016"></a>00016 <span class="comment">// INCLUDES</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include <eikrted.h></span> <span class="comment">// CCEikRichTextEditor</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include <txtfrmat.h></span> <span class="comment">// TCharFormatMask</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include <gdi.h></span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="comment">// CLASS DECLARATION</span>
<a name="l00022"></a>00022
<a name="l00026"></a>00026 <span class="keyword">class </span><a class="code" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a> : <span class="keyword">public</span> CEikRichTextEditor
<a name="l00027"></a>00027 {
<a name="l00028"></a>00028 <span class="keyword">public</span>:
<a name="l00029"></a>00029
<a name="l00036"></a>00036 <span class="keyword">static</span> <a class="code" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a>* <a class="code" href="class_c_rich_text_editor_r_t_e.html#a8485f9c132993b4586536724a8ad1d99">NewL</a>(<span class="keyword">const</span> CCoeControl& aView);
<a name="l00037"></a>00037
<a name="l00042"></a>00042 <span class="keyword">static</span> <a class="code" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a>* <a class="code" href="class_c_rich_text_editor_r_t_e.html#af6b32a535f84a829fd49160d70e91614">NewLC</a>(<span class="keyword">const</span> CCoeControl& aView);
<a name="l00043"></a>00043
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="keyword">public</span>: <span class="comment">// from CoeControl</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 TKeyResponse OfferKeyEventL(<span class="keyword">const</span> TKeyEvent& aKeyEvent, TEventCode aType);
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">public</span>: <span class="comment">// members</span>
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">/* </span>
<a name="l00052"></a>00052 <span class="comment">* AddCarriageReturnL ()</span>
<a name="l00053"></a>00053 <span class="comment">* </span>
<a name="l00054"></a>00054 <span class="comment">* discussion Add one carriage return</span>
<a name="l00055"></a>00055 <span class="comment">*</span>
<a name="l00056"></a>00056 <span class="comment">*/</span>
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="class_c_rich_text_editor_r_t_e.html#a5a57f8dee12cf629be85b72d6c398608">AddCarriageReturnL</a> ();
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">/* </span>
<a name="l00060"></a>00060 <span class="comment">* AddTextL (const TDesC& aText)</span>
<a name="l00061"></a>00061 <span class="comment">* </span>
<a name="l00062"></a>00062 <span class="comment">* discussion Print text on the screen.</span>
<a name="l00063"></a>00063 <span class="comment">* param aText text to be displayed</span>
<a name="l00064"></a>00064 <span class="comment">*</span>
<a name="l00065"></a>00065 <span class="comment">*/</span>
<a name="l00066"></a>00066 <span class="keywordtype">void</span> <a class="code" href="class_c_rich_text_editor_r_t_e.html#a55419e53857c052199a26977966eca71">AddTextL</a> (<span class="keyword">const</span> TDesC& aText);
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keyword">private</span>: <span class="comment">// Basic two-phase EPOC constructors</span>
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keywordtype">void</span> ConstructL(<span class="keyword">const</span> CCoeControl& aView);
<a name="l00071"></a>00071
<a name="l00078"></a>00078 <a class="code" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a>();
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="keyword">private</span>: <span class="comment">//data</span>
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="comment">// formatting options for the RichText that will be displayed</span>
<a name="l00083"></a>00083 TCharFormatMask iCharacterFormatMask;
<a name="l00084"></a>00084 TCharFormat iCharacterFormat;
<a name="l00085"></a>00085 };
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="preprocessor">#endif // #ifndef CRICHTEXTEDITOR_H</span>
</pre></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>