Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_client_app_view_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/HTTPClientExample/inc/ClientAppView.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/HTTPClientExample/inc/ClientAppView.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"> * Copyright (c) 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="preprocessor">#ifndef __CLIENT_APPVIEW_H__</span>
<a name="l00006"></a>00006 <span class="preprocessor"></span><span class="preprocessor">#define __CLIENT_APPVIEW_H__</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span>
<a name="l00008"></a>00008 <span class="preprocessor">#include <coecntrl.h></span>
<a name="l00009"></a>00009 <span class="preprocessor">#include <eikrted.h></span>
<a name="l00010"></a>00010 <span class="preprocessor">#include "ClientEngine.h"</span>
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="comment">/*</span>
<a name="l00013"></a>00013 <span class="comment">*</span>
<a name="l00014"></a>00014 <span class="comment">* Applications' view. Contains two CEikRichTextEditors for displaying received</span>
<a name="l00015"></a>00015 <span class="comment">* data and status events.</span>
<a name="l00016"></a>00016 <span class="comment">*</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a><a class="code" href="class_c_client_app_view.html">00018</a> <span class="keyword">class </span><a class="code" href="class_c_client_app_view.html">CClientAppView</a> : <span class="keyword">public</span> CCoeControl,
<a name="l00019"></a>00019 <span class="keyword">public</span> MCoeControlObserver,
<a name="l00020"></a>00020 <span class="keyword">public</span> <a class="code" href="class_m_client_observer.html">MClientObserver</a>
<a name="l00021"></a>00021 {
<a name="l00022"></a>00022 <span class="keyword">public</span>:
<a name="l00023"></a>00023 <span class="comment">/*</span>
<a name="l00024"></a>00024 <span class="comment"> * NewL()</span>
<a name="l00025"></a>00025 <span class="comment"> *</span>
<a name="l00026"></a>00026 <span class="comment"> * Create a CClientEngine object.</span>
<a name="l00027"></a>00027 <span class="comment"> *</span>
<a name="l00028"></a>00028 <span class="comment"> * Params:</span>
<a name="l00029"></a>00029 <span class="comment"> * aRect: Extents of the view.</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * Returns:</span>
<a name="l00032"></a>00032 <span class="comment"> * A pointer to the created instance of CClientAppView</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a>00035 <span class="keyword">static</span> <a class="code" href="class_c_client_app_view.html">CClientAppView</a>* NewL(<span class="keyword">const</span> TRect& aRect);
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment">/*</span>
<a name="l00038"></a>00038 <span class="comment"> * NewLC()</span>
<a name="l00039"></a>00039 <span class="comment"> *</span>
<a name="l00040"></a>00040 <span class="comment"> * Create a CClientEngine object.</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> * Params:</span>
<a name="l00043"></a>00043 <span class="comment"> * aRect: Extents of the view.</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> * Returns:</span>
<a name="l00046"></a>00046 <span class="comment"> * A pointer to the created instance of CClientAppView</span>
<a name="l00047"></a>00047 <span class="comment"> *</span>
<a name="l00048"></a>00048 <span class="comment"> */</span>
<a name="l00049"></a>00049 <span class="keyword">static</span> <a class="code" href="class_c_client_app_view.html">CClientAppView</a>* NewLC(<span class="keyword">const</span> TRect& aRect);
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">/*</span>
<a name="l00052"></a>00052 <span class="comment"> * ~CClientAppView()</span>
<a name="l00053"></a>00053 <span class="comment"> *</span>
<a name="l00054"></a>00054 <span class="comment"> * Destructor of CClientAppView.</span>
<a name="l00055"></a>00055 <span class="comment"> *</span>
<a name="l00056"></a>00056 <span class="comment"> * Params:</span>
<a name="l00057"></a>00057 <span class="comment"> * -</span>
<a name="l00058"></a>00058 <span class="comment"> *</span>
<a name="l00059"></a>00059 <span class="comment"> * Returns:</span>
<a name="l00060"></a>00060 <span class="comment"> * -</span>
<a name="l00061"></a>00061 <span class="comment"> *</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a>00063 ~<a class="code" href="class_c_client_app_view.html">CClientAppView</a>();
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="comment">/*</span>
<a name="l00066"></a>00066 <span class="comment"> * ResetL()</span>
<a name="l00067"></a>00067 <span class="comment"> *</span>
<a name="l00068"></a>00068 <span class="comment"> * Resets contents of the view; clears CEikRichTextEditors.</span>
<a name="l00069"></a>00069 <span class="comment"> *</span>
<a name="l00070"></a>00070 <span class="comment"> * Params:</span>
<a name="l00071"></a>00071 <span class="comment"> * -</span>
<a name="l00072"></a>00072 <span class="comment"> *</span>
<a name="l00073"></a>00073 <span class="comment"> * Returns:</span>
<a name="l00074"></a>00074 <span class="comment"> * -</span>
<a name="l00075"></a>00075 <span class="comment"> *</span>
<a name="l00076"></a>00076 <span class="comment"> */</span>
<a name="l00077"></a>00077 <span class="keywordtype">void</span> ResetL();
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">// Switches focus between the two rich text editors.</span>
<a name="l00080"></a>00080 <span class="keywordtype">void</span> SwitchFocus();
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="comment">// Returns the width (breadth) of the scrollbar for a particular editor</span>
<a name="l00083"></a>00083 TInt GetScrollbarWidth(CEikRichTextEditor* aEditor) <span class="keyword">const</span>;
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="comment">/*</span>
<a name="l00086"></a>00086 <span class="comment">* From CCoeControl</span>
<a name="l00087"></a>00087 <span class="comment">*/</span>
<a name="l00088"></a>00088 <span class="keyword">public</span>:
<a name="l00089"></a>00089 <span class="comment">/*</span>
<a name="l00090"></a>00090 <span class="comment"> * Draw()</span>
<a name="l00091"></a>00091 <span class="comment"> *</span>
<a name="l00092"></a>00092 <span class="comment"> * Draws the view.</span>
<a name="l00093"></a>00093 <span class="comment"> *</span>
<a name="l00094"></a>00094 <span class="comment"> * Params:</span>
<a name="l00095"></a>00095 <span class="comment"> * aRect:</span>
<a name="l00096"></a>00096 <span class="comment"> *</span>
<a name="l00097"></a>00097 <span class="comment"> * Returns:</span>
<a name="l00098"></a>00098 <span class="comment"> * -</span>
<a name="l00099"></a>00099 <span class="comment"> *</span>
<a name="l00100"></a>00100 <span class="comment"> */</span>
<a name="l00101"></a>00101 <span class="keywordtype">void</span> Draw(<span class="keyword">const</span> TRect& aRect) <span class="keyword">const</span>;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="comment">/*</span>
<a name="l00104"></a>00104 <span class="comment"> * GetHelpContext()</span>
<a name="l00105"></a>00105 <span class="comment"> * Identify the help context so that the framework can look up</span>
<a name="l00106"></a>00106 <span class="comment"> * the corresponding help topic</span>
<a name="l00107"></a>00107 <span class="comment"> * @param aContext Returns the help context</span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 <span class="keywordtype">void</span> GetHelpContext(TCoeHelpContext& aContext) <span class="keyword">const</span>;
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="keyword">private</span>:
<a name="l00112"></a>00112 <span class="keywordtype">void</span> HandleResourceChange(TInt aType);
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="comment">/*</span>
<a name="l00115"></a>00115 <span class="comment">* From MCoeControlObserver</span>
<a name="l00116"></a>00116 <span class="comment">*/</span>
<a name="l00117"></a>00117 <span class="keyword">private</span>:
<a name="l00118"></a>00118 <span class="comment">/*</span>
<a name="l00119"></a>00119 <span class="comment"> * CountComponentControls()</span>
<a name="l00120"></a>00120 <span class="comment"> *</span>
<a name="l00121"></a>00121 <span class="comment"> * Gets the number of controls contained in this compound control.</span>
<a name="l00122"></a>00122 <span class="comment"> *</span>
<a name="l00123"></a>00123 <span class="comment"> * Params:</span>
<a name="l00124"></a>00124 <span class="comment"> * -</span>
<a name="l00125"></a>00125 <span class="comment"> *</span>
<a name="l00126"></a>00126 <span class="comment"> * Returns:</span>
<a name="l00127"></a>00127 <span class="comment"> * Number of controls.</span>
<a name="l00128"></a>00128 <span class="comment"> *</span>
<a name="l00129"></a>00129 <span class="comment"> */</span>
<a name="l00130"></a>00130 TInt CountComponentControls() <span class="keyword">const</span>;
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="comment">/*</span>
<a name="l00133"></a>00133 <span class="comment"> * ComponentControl()</span>
<a name="l00134"></a>00134 <span class="comment"> *</span>
<a name="l00135"></a>00135 <span class="comment"> * Gets the specified component of a compound control.</span>
<a name="l00136"></a>00136 <span class="comment"> *</span>
<a name="l00137"></a>00137 <span class="comment"> * Params:</span>
<a name="l00138"></a>00138 <span class="comment"> * aIndex:</span>
<a name="l00139"></a>00139 <span class="comment"> *</span>
<a name="l00140"></a>00140 <span class="comment"> * Returns:</span>
<a name="l00141"></a>00141 <span class="comment"> * Pointer to control with index aIndex.</span>
<a name="l00142"></a>00142 <span class="comment"> *</span>
<a name="l00143"></a>00143 <span class="comment"> */</span>
<a name="l00144"></a>00144 CCoeControl* ComponentControl(TInt aIndex) <span class="keyword">const</span>;
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="comment">/*</span>
<a name="l00147"></a>00147 <span class="comment"> * OfferKeyEventL()</span>
<a name="l00148"></a>00148 <span class="comment"> *</span>
<a name="l00149"></a>00149 <span class="comment"> * Handles key events passed to this control (view).</span>
<a name="l00150"></a>00150 <span class="comment"> *</span>
<a name="l00151"></a>00151 <span class="comment"> * Params:</span>
<a name="l00152"></a>00152 <span class="comment"> * aKeyEvent: The key event.</span>
<a name="l00153"></a>00153 <span class="comment"> * aType: The type of key event: EEventKey, EEventKeyUp or</span>
<a name="l00154"></a>00154 <span class="comment"> * EEventKeyDown.</span>
<a name="l00155"></a>00155 <span class="comment"> *</span>
<a name="l00156"></a>00156 <span class="comment"> * Returns:</span>
<a name="l00157"></a>00157 <span class="comment"> * -</span>
<a name="l00158"></a>00158 <span class="comment"> *</span>
<a name="l00159"></a>00159 <span class="comment"> */</span>
<a name="l00160"></a>00160 TKeyResponse OfferKeyEventL(<span class="keyword">const</span> TKeyEvent& aKeyEvent, TEventCode aType);
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="comment">/*</span>
<a name="l00163"></a>00163 <span class="comment"> * HandleControlEventL()</span>
<a name="l00164"></a>00164 <span class="comment"> *</span>
<a name="l00165"></a>00165 <span class="comment"> * Handles control events.</span>
<a name="l00166"></a>00166 <span class="comment"> *</span>
<a name="l00167"></a>00167 <span class="comment"> * Params:</span>
<a name="l00168"></a>00168 <span class="comment"> * aControl: Control</span>
<a name="l00169"></a>00169 <span class="comment"> * aEventType: Event type</span>
<a name="l00170"></a>00170 <span class="comment"> *</span>
<a name="l00171"></a>00171 <span class="comment"> * Returns:</span>
<a name="l00172"></a>00172 <span class="comment"> * -</span>
<a name="l00173"></a>00173 <span class="comment"> *</span>
<a name="l00174"></a>00174 <span class="comment"> */</span>
<a name="l00175"></a>00175 <span class="keywordtype">void</span> HandleControlEventL( CCoeControl* <span class="comment">/* aControl */</span>,
<a name="l00176"></a>00176 TCoeEvent <span class="comment">/* aEventType */</span> );
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="keywordtype">void</span> SizeChanged();
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="comment">/*</span>
<a name="l00181"></a>00181 <span class="comment">* From MClientObserver (see ClientEngine.h)</span>
<a name="l00182"></a>00182 <span class="comment">*/</span>
<a name="l00183"></a>00183 <span class="keyword">public</span>:
<a name="l00184"></a>00184 <span class="keywordtype">void</span> ClientEvent(<span class="keyword">const</span> TDesC& aEventDescription);
<a name="l00185"></a>00185 <span class="keywordtype">void</span> ClientBodyReceived(<span class="keyword">const</span> TDesC8& aBodyData);
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="keyword">private</span>:
<a name="l00188"></a>00188 <span class="comment">/*</span>
<a name="l00189"></a>00189 <span class="comment"> * ConstructL()</span>
<a name="l00190"></a>00190 <span class="comment"> *</span>
<a name="l00191"></a>00191 <span class="comment"> * Perform the second phase construction of a CClientAppView object.</span>
<a name="l00192"></a>00192 <span class="comment"> *</span>
<a name="l00193"></a>00193 <span class="comment"> * Params:</span>
<a name="l00194"></a>00194 <span class="comment"> * aRect: Extents of the view.</span>
<a name="l00195"></a>00195 <span class="comment"> *</span>
<a name="l00196"></a>00196 <span class="comment"> * Returns:</span>
<a name="l00197"></a>00197 <span class="comment"> * -</span>
<a name="l00198"></a>00198 <span class="comment"> *</span>
<a name="l00199"></a>00199 <span class="comment"> */</span>
<a name="l00200"></a>00200 <span class="keywordtype">void</span> ConstructL(<span class="keyword">const</span> TRect& aRect);
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="comment">/*</span>
<a name="l00203"></a>00203 <span class="comment"> * CClientAppView()</span>
<a name="l00204"></a>00204 <span class="comment"> *</span>
<a name="l00205"></a>00205 <span class="comment"> * Perform the first phase of two phase construction.</span>
<a name="l00206"></a>00206 <span class="comment"> *</span>
<a name="l00207"></a>00207 <span class="comment"> * Params:</span>
<a name="l00208"></a>00208 <span class="comment"> * -</span>
<a name="l00209"></a>00209 <span class="comment"> *</span>
<a name="l00210"></a>00210 <span class="comment"> * Returns:</span>
<a name="l00211"></a>00211 <span class="comment"> * -</span>
<a name="l00212"></a>00212 <span class="comment"> *</span>
<a name="l00213"></a>00213 <span class="comment"> */</span>
<a name="l00214"></a>00214 <a class="code" href="class_c_client_app_view.html">CClientAppView</a>();
<a name="l00215"></a>00215
<a name="l00216"></a>00216 <span class="comment">/*</span>
<a name="l00217"></a>00217 <span class="comment"> * AddToOutputWindowL()</span>
<a name="l00218"></a>00218 <span class="comment"> *</span>
<a name="l00219"></a>00219 <span class="comment"> * Adds given text to output window (CEikRichTextEditor, iOutputWindow)</span>
<a name="l00220"></a>00220 <span class="comment"> * Does not format the added text.</span>
<a name="l00221"></a>00221 <span class="comment"> *</span>
<a name="l00222"></a>00222 <span class="comment"> * Params:</span>
<a name="l00223"></a>00223 <span class="comment"> * aText: Text to be added.</span>
<a name="l00224"></a>00224 <span class="comment"> *</span>
<a name="l00225"></a>00225 <span class="comment"> * Returns:</span>
<a name="l00226"></a>00226 <span class="comment"> * -</span>
<a name="l00227"></a>00227 <span class="comment"> *</span>
<a name="l00228"></a>00228 <span class="comment"> */</span>
<a name="l00229"></a>00229 <span class="keywordtype">void</span> AddToOutputWindowL(<span class="keyword">const</span> TDesC8& aText);
<a name="l00230"></a>00230
<a name="l00231"></a>00231 <span class="comment">/*</span>
<a name="l00232"></a>00232 <span class="comment"> * AddToStatusWindowL()</span>
<a name="l00233"></a>00233 <span class="comment"> *</span>
<a name="l00234"></a>00234 <span class="comment"> * Adds given text to status window (CEikRichTextEditor, iStatusWindow)</span>
<a name="l00235"></a>00235 <span class="comment"> *</span>
<a name="l00236"></a>00236 <span class="comment"> * Params:</span>
<a name="l00237"></a>00237 <span class="comment"> * aText: A single line of text to be added.</span>
<a name="l00238"></a>00238 <span class="comment"> *</span>
<a name="l00239"></a>00239 <span class="comment"> * Returns:</span>
<a name="l00240"></a>00240 <span class="comment"> * -</span>
<a name="l00241"></a>00241 <span class="comment"> *</span>
<a name="l00242"></a>00242 <span class="comment"> */</span>
<a name="l00243"></a>00243 <span class="keywordtype">void</span> AddToStatusWindowL(<span class="keyword">const</span> TDesC& aText);
<a name="l00244"></a>00244
<a name="l00245"></a>00245 <span class="keyword">private</span>:
<a name="l00246"></a>00246 CEikRichTextEditor* iOutputWindow;
<a name="l00247"></a>00247 CEikRichTextEditor* iStatusWindow;
<a name="l00248"></a>00248 };
<a name="l00249"></a>00249
<a name="l00250"></a>00250
<a name="l00251"></a>00251 <span class="preprocessor">#endif // __CLIENT_APPVIEW_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>