Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_image_converter_engine_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/ImageConverter/inc/ImageConverterEngine.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/ImageConverter/inc/ImageConverterEngine.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 © 2008 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 __IMAGECONVERTER_H__</span>
<a name="l00006"></a>00006 <span class="preprocessor"></span><span class="preprocessor">#define __IMAGECONVERTER_H__</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span>
<a name="l00008"></a>00008 <span class="preprocessor">#include <e32std.h></span>
<a name="l00009"></a>00009 <span class="preprocessor">#include <e32base.h></span>
<a name="l00010"></a>00010 <span class="preprocessor">#include <f32file.h></span>
<a name="l00011"></a>00011 <span class="preprocessor">#include <ImageConversion.h></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include <aknglobalnote.h></span>
<a name="l00013"></a>00013
<a name="l00014"></a>00014 <span class="keyword">class </span>CFbsBitmap;
<a name="l00015"></a>00015 <span class="keyword">class </span>CBitmapRotator;
<a name="l00016"></a>00016 <span class="keyword">class </span>CBitmapScaler;
<a name="l00017"></a>00017
<a name="l00018"></a><a class="code" href="class_m_converter_controller.html">00018</a> <span class="keyword">class </span><a class="code" href="class_m_converter_controller.html">MConverterController</a>
<a name="l00019"></a>00019 {
<a name="l00020"></a>00020 <span class="keyword">public</span>:
<a name="l00021"></a>00021 <span class="keyword">virtual</span> <span class="keywordtype">void</span> NotifyCompletion( TInt aErr, <span class="keyword">const</span> TDesC& aMsg ) = 0;
<a name="l00022"></a>00022 <span class="keyword">virtual</span> TBool IsAnimating() = 0;
<a name="l00023"></a>00023 };
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="comment">// states for this engine</span>
<a name="l00026"></a>00026 <span class="keyword">enum</span> TState
<a name="l00027"></a>00027 {
<a name="l00028"></a>00028 EIdle = 0,
<a name="l00029"></a>00029 EDecoding,
<a name="l00030"></a>00030 EEncoding,
<a name="l00031"></a>00031 ERotating,
<a name="l00032"></a>00032 EScaling
<a name="l00033"></a>00033 };
<a name="l00034"></a>00034
<a name="l00035"></a><a class="code" href="class_c_image_converter_engine.html">00035</a> <span class="keyword">class </span><a class="code" href="class_c_image_converter_engine.html">CImageConverterEngine</a> : <span class="keyword">public</span> CActive
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="keyword">public</span>:
<a name="l00039"></a>00039 <span class="comment">// rotation directions</span>
<a name="l00040"></a>00040 <span class="keyword">enum</span> TDirection
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 EClockwise90 = 0,
<a name="l00043"></a>00043 EAntiClockwise90
<a name="l00044"></a>00044 };
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="keyword">public</span>: <span class="comment">// contructors/destructors</span>
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="comment">/*</span>
<a name="l00049"></a>00049 <span class="comment"> * NewL</span>
<a name="l00050"></a>00050 <span class="comment"> * </span>
<a name="l00051"></a>00051 <span class="comment"> * Create a CImageConverterEngine object and return a pointer to it.</span>
<a name="l00052"></a>00052 <span class="comment"> *</span>
<a name="l00053"></a>00053 <span class="comment"> * Params: </span>
<a name="l00054"></a>00054 <span class="comment"> * aController Pointer to a MConverterController interface.</span>
<a name="l00055"></a>00055 <span class="comment"> * The engine uses NotifyCompletion callback from this interface</span>
<a name="l00056"></a>00056 <span class="comment"> * to notify the controller about completions of coding or </span>
<a name="l00057"></a>00057 <span class="comment"> * encoding requests.</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"> * A pointer to the created engine</span>
<a name="l00061"></a>00061 <span class="comment"> *</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a>00063 <span class="keyword">static</span> <a class="code" href="class_c_image_converter_engine.html">CImageConverterEngine</a>* NewL( <a class="code" href="class_m_converter_controller.html">MConverterController</a>* aController );
<a name="l00064"></a>00064
<a name="l00065"></a>00065 ~<a class="code" href="class_c_image_converter_engine.html">CImageConverterEngine</a>();
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="keyword">public</span>: <span class="comment">// interface methods</span>
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">/*</span>
<a name="l00070"></a>00070 <span class="comment"> * StartToDecodeL</span>
<a name="l00071"></a>00071 <span class="comment"> * </span>
<a name="l00072"></a>00072 <span class="comment"> * Starts to decode an image from a file. When completed calls </span>
<a name="l00073"></a>00073 <span class="comment"> * NotifyCompletion, from iController.</span>
<a name="l00074"></a>00074 <span class="comment"> *</span>
<a name="l00075"></a>00075 <span class="comment"> * Params: </span>
<a name="l00076"></a>00076 <span class="comment"> * aFileName Full path and filename of the image to be decoded.</span>
<a name="l00077"></a>00077 <span class="comment"> * </span>
<a name="l00078"></a>00078 <span class="comment"> * Returns:</span>
<a name="l00079"></a>00079 <span class="comment"> * Nothing</span>
<a name="l00080"></a>00080 <span class="comment"> */</span>
<a name="l00081"></a>00081 <span class="keywordtype">void</span> StartToDecodeL( TFileName& aFileName );
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="comment">/*</span>
<a name="l00084"></a>00084 <span class="comment"> * StartToEncodeL</span>
<a name="l00085"></a>00085 <span class="comment"> * </span>
<a name="l00086"></a>00086 <span class="comment"> * Starts to encode an image to a file. When completed calls </span>
<a name="l00087"></a>00087 <span class="comment"> * NotifyCompletion, from iController.</span>
<a name="l00088"></a>00088 <span class="comment"> *</span>
<a name="l00089"></a>00089 <span class="comment"> * Params: </span>
<a name="l00090"></a>00090 <span class="comment"> * aFileName Full path and filename to the image to be encoded.</span>
<a name="l00091"></a>00091 <span class="comment"> * </span>
<a name="l00092"></a>00092 <span class="comment"> * Returns:</span>
<a name="l00093"></a>00093 <span class="comment"> * Nothing</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <span class="keywordtype">void</span> StartToEncodeL( TFileName& aFileName,
<a name="l00096"></a>00096 TUid aImageType, TUid aImageSubType );
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="comment">/*</span>
<a name="l00099"></a>00099 <span class="comment"> * GetImageInfoL</span>
<a name="l00100"></a>00100 <span class="comment"> * </span>
<a name="l00101"></a>00101 <span class="comment"> * Gets frame 0 info strings. An image has to be decoded before </span>
<a name="l00102"></a>00102 <span class="comment"> * call to this method, otherwise will return NULL.</span>
<a name="l00103"></a>00103 <span class="comment"> * </span>
<a name="l00104"></a>00104 <span class="comment"> * Params: </span>
<a name="l00105"></a>00105 <span class="comment"> * None</span>
<a name="l00106"></a>00106 <span class="comment"> * </span>
<a name="l00107"></a>00107 <span class="comment"> * Returns:</span>
<a name="l00108"></a>00108 <span class="comment"> * CFrameInfoStrings* See Symbian OS documentation for </span>
<a name="l00109"></a>00109 <span class="comment"> * reference.</span>
<a name="l00110"></a>00110 <span class="comment"> */</span>
<a name="l00111"></a>00111 CFrameInfoStrings* GetImageInfoL();
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="comment">/*</span>
<a name="l00114"></a>00114 <span class="comment"> * GetEncoderImageTypesL</span>
<a name="l00115"></a>00115 <span class="comment"> * </span>
<a name="l00116"></a>00116 <span class="comment"> * Gets descriptions of supported (encoding) image types. </span>
<a name="l00117"></a>00117 <span class="comment"> *</span>
<a name="l00118"></a>00118 <span class="comment"> * Params: </span>
<a name="l00119"></a>00119 <span class="comment"> * aImageTypeArray Reference to an array to be filled.</span>
<a name="l00120"></a>00120 <span class="comment"> * See Symbian OS documentation for reference.</span>
<a name="l00121"></a>00121 <span class="comment"> *</span>
<a name="l00122"></a>00122 <span class="comment"> * Returns:</span>
<a name="l00123"></a>00123 <span class="comment"> * Nothing </span>
<a name="l00124"></a>00124 <span class="comment"> */</span>
<a name="l00125"></a>00125 <span class="keyword">static</span> <span class="keywordtype">void</span> GetEncoderImageTypesL(
<a name="l00126"></a>00126 RImageTypeDescriptionArray& aImageTypeArray );
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="comment">/*</span>
<a name="l00129"></a>00129 <span class="comment"> * Rotate</span>
<a name="l00130"></a>00130 <span class="comment"> * </span>
<a name="l00131"></a>00131 <span class="comment"> * Rotates the image to the given direction.</span>
<a name="l00132"></a>00132 <span class="comment"> *</span>
<a name="l00133"></a>00133 <span class="comment"> * Params: </span>
<a name="l00134"></a>00134 <span class="comment"> * aDirection The direction to rotate to.</span>
<a name="l00135"></a>00135 <span class="comment"> *</span>
<a name="l00136"></a>00136 <span class="comment"> * Returns:</span>
<a name="l00137"></a>00137 <span class="comment"> * Nothing </span>
<a name="l00138"></a>00138 <span class="comment"> */</span>
<a name="l00139"></a>00139 <span class="keywordtype">void</span> Rotate( TDirection aDirection );
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="comment">/*</span>
<a name="l00142"></a>00142 <span class="comment"> * Scale</span>
<a name="l00143"></a>00143 <span class="comment"> * </span>
<a name="l00144"></a>00144 <span class="comment"> * Scales the image to the given percentage of the current size.</span>
<a name="l00145"></a>00145 <span class="comment"> *</span>
<a name="l00146"></a>00146 <span class="comment"> * Params: </span>
<a name="l00147"></a>00147 <span class="comment"> * aPercent The new size relative to the current size </span>
<a name="l00148"></a>00148 <span class="comment"> * (e.g. 110 will increase the size by 10 %).</span>
<a name="l00149"></a>00149 <span class="comment"> *</span>
<a name="l00150"></a>00150 <span class="comment"> * Returns:</span>
<a name="l00151"></a>00151 <span class="comment"> * Nothing </span>
<a name="l00152"></a>00152 <span class="comment"> */</span>
<a name="l00153"></a>00153 TInt Scale( TInt aPercent );
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="comment">/*</span>
<a name="l00156"></a>00156 <span class="comment"> * GetBitmap</span>
<a name="l00157"></a>00157 <span class="comment"> * </span>
<a name="l00158"></a>00158 <span class="comment"> * Returns a pointer to the decoded image.</span>
<a name="l00159"></a>00159 <span class="comment"> *</span>
<a name="l00160"></a>00160 <span class="comment"> * Params: </span>
<a name="l00161"></a>00161 <span class="comment"> * None</span>
<a name="l00162"></a>00162 <span class="comment"> *</span>
<a name="l00163"></a>00163 <span class="comment"> * Returns:</span>
<a name="l00164"></a>00164 <span class="comment"> * A pointer to the encoded image </span>
<a name="l00165"></a>00165 <span class="comment"> */</span>
<a name="l00166"></a>00166 CFbsBitmap* GetBitmap();
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="keywordtype">void</span> ShowProgress();
<a name="l00169"></a>00169 <span class="keywordtype">void</span> CancelProgress();
<a name="l00170"></a>00170
<a name="l00171"></a>00171 TBool CanDownScaleMore();
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="keyword">inline</span> TState EngineState(){<span class="keywordflow">return</span> iState;};
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="keyword">protected</span>: <span class="comment">// implementation of CActive</span>
<a name="l00176"></a>00176 <span class="keywordtype">void</span> DoCancel();
<a name="l00177"></a>00177 <span class="keywordtype">void</span> RunL();
<a name="l00178"></a>00178 TInt RunError(TInt aError);
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="keyword">private</span>: <span class="comment">// internal methods</span>
<a name="l00181"></a>00181 <a class="code" href="class_c_image_converter_engine.html">CImageConverterEngine</a>( <a class="code" href="class_m_converter_controller.html">MConverterController</a>* aController );
<a name="l00182"></a>00182 <span class="keywordtype">void</span> ConstructL();
<a name="l00183"></a>00183 TBool FitToScreen();
<a name="l00184"></a>00184 <span class="keywordtype">void</span> DoFitToScreen();
<a name="l00185"></a>00185
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="keyword">private</span>: <span class="comment">// internal data</span>
<a name="l00188"></a>00188 <span class="comment">/*</span>
<a name="l00189"></a>00189 <span class="comment"> * Access to the decoded image,</span>
<a name="l00190"></a>00190 <span class="comment"> * images are also encoded from this bitmap.</span>
<a name="l00191"></a>00191 <span class="comment"> */</span>
<a name="l00192"></a>00192 CFbsBitmap* iBitmap; <span class="comment">// decoded image</span>
<a name="l00193"></a>00193 <a class="code" href="class_m_converter_controller.html">MConverterController</a>* iController; <span class="comment">// ui controller</span>
<a name="l00194"></a>00194 RFs iFs; <span class="comment">// for opening/saving images from/to files</span>
<a name="l00195"></a>00195 CImageDecoder* iImageDecoder; <span class="comment">// decoder from ICL API</span>
<a name="l00196"></a>00196 CImageEncoder* iImageEncoder; <span class="comment">// encoder from ICL API</span>
<a name="l00197"></a>00197 CBitmapRotator* iRotator;
<a name="l00198"></a>00198 CBitmapScaler* iScaler;
<a name="l00199"></a>00199 TState iState;
<a name="l00200"></a>00200 CAknGlobalNote* iGlobalNote;
<a name="l00201"></a>00201 TInt iNoteId;
<a name="l00202"></a>00202 TFileName iFilename;
<a name="l00203"></a>00203 TInt iScaleDownCounter;
<a name="l00204"></a>00204 };
<a name="l00205"></a>00205
<a name="l00206"></a>00206 <span class="preprocessor">#endif // #ifndef __IMAGECONVERTER_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>