epoc32/include/icl/imageplugin.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
   167 
   167 
   168 public:
   168 public:
   169 	/**
   169 	/**
   170 	@publishedAll
   170 	@publishedAll
   171 	@released
   171 	@released
   172 
   172 	
   173 	Called by the framework to obtain a pointer to a codec implemented extension.
   173 	Called by the framework to obtain a pointer to a codec implemented extension.
   174 
   174 
   175 	@param aExtUid Extension UID normally prefixed KUidImageConv. @see icl_uids.hrh .
   175 	@param aExtUid Extension UID normally prefixed KUidImageConv. @see icl_uids.hrh .
   176 	@param aExtPtr Returns a ptr to the extension implemented by the codec plugin.
   176 	@param aExtPtr Returns a ptr to the extension implemented by the codec plugin.
   177 	*/
   177 	*/
   178 	IMPORT_C virtual void GetExtensionL(TUid aExtUid, MImageConvExtension*& aExtPtr);
   178 	IMPORT_C virtual void GetExtensionL(TUid aExtUid, MImageConvExtension*& aExtPtr);
   179 	/**
   179 	/**
   180 	@publishedAll
   180 	@publishedAll
   181 	@released
   181 	@released
   182 
   182 	
   183 	Called by the framework on the plugin to apply a clipping rectangle to the image.
   183 	Called by the framework on the plugin to apply a clipping rectangle to the image.
   184 
   184 
   185 	Sets the area of interest of the image to be decoded.
   185 	Sets the area of interest of the image to be decoded.
   186 
   186 
   187 	@param aClipRect	A pointer to a TRect that specifies the
   187 	@param aClipRect	A pointer to a TRect that specifies the
   196 	*/
   196 	*/
   197 	IMPORT_C virtual void SetClippingRectL(const TRect* aClipRect);
   197 	IMPORT_C virtual void SetClippingRectL(const TRect* aClipRect);
   198 	/**
   198 	/**
   199 	@publishedAll
   199 	@publishedAll
   200 	@released
   200 	@released
   201 
   201 	
   202 	Called by framework on plugin to get the size of decoded image.
   202 	Called by framework on plugin to get the size of decoded image.
   203 
   203 
   204 	Get the size of the decoded image for the given frame. The calculation will account for any clipping rectangle set,
   204 	Get the size of the decoded image for the given frame. The calculation will account for any clipping rectangle set,
   205 	scaling applied through the TImageConvScaler extension and any operation applied through TImageConvOperation.
   205 	scaling applied through the TImageConvScaler extension and any operation applied through TImageConvOperation.
   206 	If TImageConvScaler::SetScalingL(.. has been called then the size of the bitmap passed to CImageDecoder::Convert must match the size returned from
   206 	If TImageConvScaler::SetScalingL(.. has been called then the size of the bitmap passed to CImageDecoder::Convert must match the size returned from
   311 	
   311 	
   312 public:
   312 public:
   313 	/**
   313 	/**
   314 	@publishedAll
   314 	@publishedAll
   315 	@released
   315 	@released
   316 
   316 	
   317 	Called by the framework to obtain a pointer to a codec implemented extension.
   317 	Called by the framework to obtain a pointer to a codec implemented extension.
   318 
   318 
   319 	@param aExtUid Extension UID normally prefixed KUidImageConv. @see icl_uids.hrh .
   319 	@param aExtUid Extension UID normally prefixed KUidImageConv. @see icl_uids.hrh .
   320 	@param aExtPtr. Returns a ptr to the extension implemented by the codec plugin.
   320 	@param aExtPtr. Returns a ptr to the extension implemented by the codec plugin.
   321 	*/
   321 	*/
   325 	CImageEncoderPriv* iProperties; // not owned
   325 	CImageEncoderPriv* iProperties; // not owned
   326 	};
   326 	};
   327 
   327 
   328 
   328 
   329 #endif //ImageConversionPlugin_h
   329 #endif //ImageConversionPlugin_h
       
   330