Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_bluetooth_p_m_p_example_rich_text_editor_r_t_e_8cpp_source.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: examples/ForumNokia/BluetoothPMPExample/src/BluetoothPMPExampleRichTextEditorRTE.cpp 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/BluetoothPMPExample/src/BluetoothPMPExampleRichTextEditorRTE.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright © 2009 Nokia Corporation.</span>
<a name="l00003"></a>00003 <span class="comment"> */</span>
<a name="l00004"></a>00004 
<a name="l00005"></a>00005 <span class="comment">// INCLUDES</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include &quot;BluetoothPMPExamplerichtexteditorrte.h&quot;</span>
<a name="l00007"></a>00007 <span class="preprocessor">#include &lt;barsread.h&gt;</span> <span class="comment">// TResourceReader</span>
<a name="l00008"></a>00008 <span class="preprocessor">#include &lt;BtPmpEx.rsg&gt;</span> <span class="comment">// resources</span>
<a name="l00009"></a>00009 <span class="preprocessor">#include &lt;eikrted.h&gt;</span> <span class="comment">// CEikRichTextEditor</span>
<a name="l00010"></a>00010 <span class="preprocessor">#include &lt;txtrich.h&gt;</span> <span class="comment">// CRichText</span>
<a name="l00011"></a>00011 
<a name="l00012"></a>00012 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTextLines, <span class="stringliteral">&quot;---------------------------&quot;</span>);
<a name="l00013"></a>00013 <span class="preprocessor">#define NEW_TEXT_TO_TOP //If defined the new text will be written to</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span>                        <span class="comment">//the top of the container</span>
<a name="l00015"></a>00015 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00016"></a>00016 <span class="comment">// CRichTextEditorRTE::CRichTextEditorRTE(void)</span>
<a name="l00017"></a>00017 <span class="comment">//</span>
<a name="l00018"></a>00018 <span class="comment">// Standard symbian OS 2nd phase constructor</span>
<a name="l00019"></a>00019 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00020"></a>00020 <span class="keywordtype">void</span> CRichTextEditorRTE::ConstructL()
<a name="l00021"></a>00021     {
<a name="l00022"></a>00022     TResourceReader reader;
<a name="l00023"></a>00023 
<a name="l00024"></a>00024     <span class="comment">// Construct RichTextEditor from resource</span>
<a name="l00025"></a>00025     iCoeEnv-&gt;CreateResourceReaderLC(reader, R_RICHTEXTEDITOR_RICH_TEXT_EDITOR);
<a name="l00026"></a>00026 
<a name="l00027"></a>00027     ConstructFromResourceL(reader);
<a name="l00028"></a>00028 
<a name="l00029"></a>00029     CleanupStack::PopAndDestroy(); <span class="comment">// reader</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031     <span class="comment">// Sets that the control has keyboard focus</span>
<a name="l00032"></a>00032     SetFocus(ETrue);
<a name="l00033"></a>00033     }
<a name="l00034"></a>00034 
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00037"></a>00037 <span class="comment">// CRichTextEditorRTE::CRichTextEditorRTE(void)</span>
<a name="l00038"></a>00038 <span class="comment">//</span>
<a name="l00039"></a>00039 <span class="comment">// Constructor</span>
<a name="l00040"></a>00040 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00041"></a>00041 CRichTextEditorRTE::CRichTextEditorRTE(<span class="keywordtype">void</span>)
<a name="l00042"></a>00042     {
<a name="l00043"></a>00043     }
<a name="l00044"></a>00044 
<a name="l00045"></a>00045 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00046"></a>00046 <span class="comment">// CRichTextEditorRTE::AddCarriageReturnL()</span>
<a name="l00047"></a>00047 <span class="comment">//</span>
<a name="l00048"></a>00048 <span class="comment">// Insert one line break at the end of the text.</span>
<a name="l00049"></a>00049 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00050"></a><a class="code" href="class_c_rich_text_editor_r_t_e.html#a5a57f8dee12cf629be85b72d6c398608">00050</a> <span class="keywordtype">void</span> <a class="code" href="class_c_rich_text_editor_r_t_e.html#a5a57f8dee12cf629be85b72d6c398608">CRichTextEditorRTE::AddCarriageReturnL</a>(TInt pos)
<a name="l00051"></a>00051     {
<a name="l00052"></a>00052     CRichText* richText = RichText();
<a name="l00053"></a>00053     TInt carriagePosition = pos;
<a name="l00054"></a>00054     <span class="keywordflow">if</span>(pos == KCarriageReturnToEnd)
<a name="l00055"></a>00055         {
<a name="l00056"></a>00056         carriagePosition = richText-&gt;DocumentLength();
<a name="l00057"></a>00057         }
<a name="l00058"></a>00058 
<a name="l00059"></a>00059     richText-&gt;InsertL(carriagePosition, CEditableText::ELineBreak);
<a name="l00060"></a>00060     }
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 
<a name="l00063"></a>00063 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00064"></a>00064 <span class="comment">// CRichTextEditorRTE::AddTextL(const TDesC&amp; aText)</span>
<a name="l00065"></a>00065 <span class="comment">//</span>
<a name="l00066"></a>00066 <span class="comment">// Draws text using black color.</span>
<a name="l00067"></a>00067 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00068"></a><a class="code" href="class_c_rich_text_editor_r_t_e.html#a55419e53857c052199a26977966eca71">00068</a> <span class="keywordtype">void</span> <a class="code" href="class_c_rich_text_editor_r_t_e.html#a55419e53857c052199a26977966eca71">CRichTextEditorRTE::AddTextL</a>(<span class="keyword">const</span> TDesC&amp; aText)
<a name="l00069"></a>00069     {
<a name="l00070"></a>00070     CRichText* text = RichText();
<a name="l00071"></a>00071     TInt textSize = text-&gt;DocumentLength();
<a name="l00072"></a>00072     TInt position = textSize;
<a name="l00073"></a>00073 <span class="preprocessor">    #ifdef NEW_TEXT_TO_TOP</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span>        position = 0;
<a name="l00075"></a>00075 <span class="preprocessor">    #endif</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span>
<a name="l00077"></a>00077     <span class="comment">// Interested in color</span>
<a name="l00078"></a>00078     iCharacterFormatMask.SetAttrib(EAttColor);
<a name="l00079"></a>00079     <span class="comment">// Set it to Black</span>
<a name="l00080"></a>00080     iCharacterFormat.iFontPresentation.iTextColor = KRgbBlack;
<a name="l00081"></a>00081     
<a name="l00082"></a>00082     text-&gt;InsertL (position, aText);
<a name="l00083"></a>00083 
<a name="l00084"></a>00084     <span class="comment">// Apply formatting</span>
<a name="l00085"></a>00085     text-&gt;ApplyCharFormatL(iCharacterFormat, iCharacterFormatMask,
<a name="l00086"></a>00086                            position,aText.Length());
<a name="l00087"></a>00087 
<a name="l00088"></a>00088     <a class="code" href="class_c_rich_text_editor_r_t_e.html#a5a57f8dee12cf629be85b72d6c398608">AddCarriageReturnL</a>(position);
<a name="l00089"></a>00089 
<a name="l00090"></a>00090     HandleTextChangedL();
<a name="l00091"></a>00091 
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 <span class="preprocessor">    #ifdef NEW_TEXT_TO_TOP</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span>        <span class="comment">//Keep displaying the top of the screen</span>
<a name="l00095"></a>00095         MoveCursorL (TCursorPosition::EFPageUp, EFalse);
<a name="l00096"></a>00096 <span class="preprocessor">    #else</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span>        <span class="comment">//Keep displaying the bottom of the screen</span>
<a name="l00098"></a>00098         MoveCursorL (TCursorPosition::EFPageDown, EFalse);
<a name="l00099"></a>00099 <span class="preprocessor">    #endif    </span>
<a name="l00100"></a>00100 <span class="preprocessor"></span>    }
<a name="l00101"></a>00101 
<a name="l00102"></a>00102 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00103"></a>00103 <span class="comment">// CRichTextEditorRTE::DrawTextWithoutCarriageL( const TDesC&amp; aText )</span>
<a name="l00104"></a>00104 <span class="comment">//</span>
<a name="l00105"></a>00105 <span class="comment">// Draw text without adding one line break at the end of the text.</span>
<a name="l00106"></a>00106 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00107"></a><a class="code" href="class_c_rich_text_editor_r_t_e.html#a70426200693750d151de3d131da11cdc">00107</a> <span class="keywordtype">void</span> <a class="code" href="class_c_rich_text_editor_r_t_e.html#a70426200693750d151de3d131da11cdc">CRichTextEditorRTE::DrawTextWithoutCarriageL</a>( <span class="keyword">const</span> TDesC&amp; aText )
<a name="l00108"></a>00108     {
<a name="l00109"></a>00109     CRichText* text = RichText();
<a name="l00110"></a>00110     TInt textSize = text-&gt;DocumentLength();
<a name="l00111"></a>00111 
<a name="l00112"></a>00112     <span class="comment">// Interested in color</span>
<a name="l00113"></a>00113     iCharacterFormatMask.SetAttrib(EAttColor);
<a name="l00114"></a>00114     <span class="comment">// Set it to Black</span>
<a name="l00115"></a>00115     iCharacterFormat.iFontPresentation.iTextColor = KRgbBlack;
<a name="l00116"></a>00116     text-&gt;InsertL (textSize, aText);
<a name="l00117"></a>00117     <span class="comment">// Apply formatting</span>
<a name="l00118"></a>00118     text-&gt;ApplyCharFormatL(iCharacterFormat, iCharacterFormatMask,
<a name="l00119"></a>00119                            textSize,aText.Length());
<a name="l00120"></a>00120     HandleTextChangedL();
<a name="l00121"></a>00121     }
<a name="l00122"></a>00122 
<a name="l00123"></a>00123 
<a name="l00124"></a>00124 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00125"></a>00125 <span class="comment">// CRichTextEditorRTE::DrawTextWithoutCarriageL( const TDesC&amp; aText )</span>
<a name="l00126"></a>00126 <span class="comment">//</span>
<a name="l00127"></a>00127 <span class="comment">//  Sets underline on or off.  This will be applied to text added in AddTextL()</span>
<a name="l00128"></a>00128 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00129"></a><a class="code" href="class_c_rich_text_editor_r_t_e.html#af51a90c13c4f3e57a4e18f54029e3410">00129</a> <span class="keywordtype">void</span> <a class="code" href="class_c_rich_text_editor_r_t_e.html#af51a90c13c4f3e57a4e18f54029e3410">CRichTextEditorRTE::SetTextUnderlineOn</a>(TBool aUnderlineOn)
<a name="l00130"></a>00130     {
<a name="l00131"></a>00131     iCharacterFormatMask.SetAttrib(EAttFontUnderline);
<a name="l00132"></a>00132     <span class="keywordflow">if</span> (aUnderlineOn)
<a name="l00133"></a>00133         {
<a name="l00134"></a>00134         iCharacterFormat.iFontPresentation.iUnderline = EUnderlineOn;
<a name="l00135"></a>00135         }
<a name="l00136"></a>00136     <span class="keywordflow">else</span>
<a name="l00137"></a>00137         {
<a name="l00138"></a>00138         iCharacterFormat.iFontPresentation.iUnderline = EUnderlineOff;
<a name="l00139"></a>00139         }
<a name="l00140"></a>00140     }
<a name="l00141"></a>00141 
<a name="l00142"></a>00142 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00143"></a>00143 <span class="comment">// CRichTextEditorRTE::DrawLineL()</span>
<a name="l00144"></a>00144 <span class="comment">//</span>
<a name="l00145"></a>00145 <span class="comment">// Draw one line.</span>
<a name="l00146"></a>00146 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00147"></a><a class="code" href="class_c_rich_text_editor_r_t_e.html#a316eeab83bf529ab9fdeec9afa670952">00147</a> <span class="keywordtype">void</span> <a class="code" href="class_c_rich_text_editor_r_t_e.html#a316eeab83bf529ab9fdeec9afa670952">CRichTextEditorRTE::DrawLineL</a>()
<a name="l00148"></a>00148     {
<a name="l00149"></a>00149     <a class="code" href="class_c_rich_text_editor_r_t_e.html#a55419e53857c052199a26977966eca71">AddTextL</a>( KTextLines );
<a name="l00150"></a>00150     HandleTextChangedL();
<a name="l00151"></a>00151     }
<a name="l00152"></a>00152 
<a name="l00153"></a>00153 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00154"></a>00154 <span class="comment">// CRichTextEditorRTE::NewL()</span>
<a name="l00155"></a>00155 <span class="comment">//</span>
<a name="l00156"></a>00156 <span class="comment">// Symbian OS 2nd phase constructor.</span>
<a name="l00157"></a>00157 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00158"></a><a class="code" href="class_c_rich_text_editor_r_t_e.html#a8485f9c132993b4586536724a8ad1d99">00158</a> <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">CRichTextEditorRTE::NewL</a>()
<a name="l00159"></a>00159     {
<a name="l00160"></a>00160     <a class="code" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a>* <span class="keyword">self</span> = <a class="code" href="class_c_rich_text_editor_r_t_e.html#af6b32a535f84a829fd49160d70e91614">CRichTextEditorRTE::NewLC</a>();
<a name="l00161"></a>00161     CleanupStack::Pop(<span class="keyword">self</span>);
<a name="l00162"></a>00162     <span class="keywordflow">return</span> <span class="keyword">self</span>;
<a name="l00163"></a>00163     }
<a name="l00164"></a>00164 
<a name="l00165"></a>00165 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00166"></a>00166 <span class="comment">// CRichTextEditorRTE::NewLC()</span>
<a name="l00167"></a>00167 <span class="comment">//</span>
<a name="l00168"></a>00168 <span class="comment">// Symbian OS 2nd phase constructor.</span>
<a name="l00169"></a>00169 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00170"></a><a class="code" href="class_c_rich_text_editor_r_t_e.html#af6b32a535f84a829fd49160d70e91614">00170</a> <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">CRichTextEditorRTE::NewLC</a>()
<a name="l00171"></a>00171     {
<a name="l00172"></a>00172     <a class="code" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a>* <span class="keyword">self</span> = <span class="keyword">new</span> (ELeave) <a class="code" href="class_c_rich_text_editor_r_t_e.html">CRichTextEditorRTE</a>;
<a name="l00173"></a>00173     CleanupStack::PushL(<span class="keyword">self</span>);
<a name="l00174"></a>00174     <span class="keyword">self</span>-&gt;ConstructL();
<a name="l00175"></a>00175     <span class="keywordflow">return</span> <span class="keyword">self</span>;
<a name="l00176"></a>00176     }
<a name="l00177"></a>00177 
<a name="l00178"></a>00178 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00179"></a>00179 <span class="comment">// TKeyResponse CRichTextEditorRTE::OfferKeyEventL(const TKeyEvent&amp; aKeyEvent,</span>
<a name="l00180"></a>00180 <span class="comment">//      TEventCode aType)</span>
<a name="l00181"></a>00181 <span class="comment">//</span>
<a name="l00182"></a>00182 <span class="comment">// Called by the framework whenever a key event occurs. Handles scrolling</span>
<a name="l00183"></a>00183 <span class="comment">// events.</span>
<a name="l00184"></a>00184 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00185"></a>00185 TKeyResponse CRichTextEditorRTE::OfferKeyEventL(<span class="keyword">const</span> TKeyEvent&amp; aKeyEvent,
<a name="l00186"></a>00186                                                 TEventCode aType)
<a name="l00187"></a>00187     {
<a name="l00188"></a>00188 
<a name="l00189"></a>00189     <span class="keywordflow">if</span> (aType == EEventKey)
<a name="l00190"></a>00190         {
<a name="l00191"></a>00191         <span class="keywordflow">if</span> (aKeyEvent.iCode == EKeyDownArrow)
<a name="l00192"></a>00192             {
<a name="l00193"></a>00193             MoveCursorL (TCursorPosition::EFPageDown, EFalse);
<a name="l00194"></a>00194 
<a name="l00195"></a>00195             <span class="keywordflow">return</span> EKeyWasConsumed;
<a name="l00196"></a>00196             }
<a name="l00197"></a>00197         <span class="keywordflow">else</span> <span class="keywordflow">if</span> (aKeyEvent.iCode == EKeyUpArrow)
<a name="l00198"></a>00198             {
<a name="l00199"></a>00199             MoveCursorL (TCursorPosition::EFPageUp, EFalse);
<a name="l00200"></a>00200 
<a name="l00201"></a>00201             <span class="keywordflow">return</span> EKeyWasConsumed;
<a name="l00202"></a>00202             }
<a name="l00203"></a>00203         <span class="keywordflow">else</span>
<a name="l00204"></a>00204             {
<a name="l00205"></a>00205             <span class="keywordflow">return</span> CEikRichTextEditor::OfferKeyEventL(aKeyEvent, aType);
<a name="l00206"></a>00206             }
<a name="l00207"></a>00207         }
<a name="l00208"></a>00208 
<a name="l00209"></a>00209     <span class="keywordflow">return</span> EKeyWasNotConsumed;
<a name="l00210"></a>00210     }
<a name="l00211"></a>00211 
<a name="l00212"></a><a class="code" href="class_c_rich_text_editor_r_t_e.html#acff56dfc81d8c60fc20dba36b4b153a5">00212</a> <span class="keywordtype">void</span> <a class="code" href="class_c_rich_text_editor_r_t_e.html#acff56dfc81d8c60fc20dba36b4b153a5">CRichTextEditorRTE::ClearScreenL</a>()
<a name="l00213"></a>00213     {
<a name="l00214"></a>00214     CRichText* text = RichText();
<a name="l00215"></a>00215     text-&gt;DeleteL(0, text-&gt;DocumentLength() );
<a name="l00216"></a>00216     HandleTextChangedL();
<a name="l00217"></a>00217     }
</pre></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>