epoc32/include/icl/exifimagedisplayext.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // This is the extension to the plugin API for the Image Display framework
    15 // 
    16 //
    17 
    18 #ifndef EXIFIMAGEDISPLAYEXT_H
    19 #define EXIFIMAGEDISPLAYEXT_H
    20 
    21 #include <e32base.h>
    22 #include <icl/imagedisplaypluginext.h>
    23 #include <icl/exifimagedisplay.hrh>
    24 
    25 const TUid KExifImageDisplayExtensionUid={KUidExifImageDisplayExtension};
    26 
    27 class MExifMetadataReader;
    28 
    29 /**
    30 This class extends the functionality of the Image Display Library client API defined 
    31 in the class CImageDisplay. This extension is supported only by the EXIF-specific framework
    32 plug-ins. In order to invoke the extended functionality, the user needs to call the 
    33 CImageDisplay::ExtensionInterface( ) with the KExifImageDisplayExtensionUid interface UID
    34 and an interface pointer to the object of this class.
    35 
    36 @publishedAll
    37 @released
    38 */
    39 class MExifImageDisplayExtension :public MImageDisplayPluginExtension
    40 	{
    41 public:
    42 	/**
    43 	Obtains an MExifMetadataReader that can be used to access the EXIF metadata of the image.
    44 	@param aPtr A reference to a pointer to the MExifMetadataReader that can be used to access the EXIF
    45 				metadata of the image.
    46 	@return A system-wide error code.
    47 	*/
    48 	virtual TInt GetExifMetadataReader(MExifMetadataReader*& aPtr)=0;
    49 	
    50 	/**
    51 	Sets the level of quality for the scaling algorithm.
    52 	If quality level is not set by calling this function then 
    53 	the fastest/lowest quality algorithm is used.
    54 	Note: This function must be called before calling CImageDisplay::Play()
    55 	
    56 	@param aQualityLevel Quality level value for the scaling algorithm.
    57 				See CBitmapScaler::TQualityAlgorithm for a set of possible values.
    58 	@return A system-wide error code.
    59 	*/	
    60 	virtual TInt SetScaleQuality(TInt aQualityLevel)=0;
    61 	
    62 	/**
    63 	Sets the maximum quality reduction factor for image decoding.
    64 	By default, the plug-in calculates an optimal maximum reduction factor 
    65 	and uses it to produce a series of roughly-decoded images, passing each of 
    66 	them to the observer interface with the CImageDisplayPlugin::EStatusPartialFrame flag set.
    67 	Note: This function must be called before calling CImageDisplay::Play().
    68 	
    69 	@param aMaxReductionFactor
    70 				The maximum quality reduction factor.
    71 				Usually the maximum reduction can be specfied in range of 0-3.
    72 				A value of 0 means no quality reduction is allowed, so a full-quality image will be decoded as the first frame.
    73 				A value of 1 means (1/2)^1=1/2 of the original image quality. 
    74 				A value of 3 means (1/2)^3=1/8 of the original image quality. 
    75 				If the reduction factor is not set by calling this function then
    76 				the reduction factor value of 3 is used for jpeg images.
    77 	@return KErrArgument if the aMaxReductionFactor parameter is not in the supported range, or a system-wide error code.
    78 	*/	
    79 	virtual TInt SetMaximumReductionFactor(TInt aMaxReductionFactor)=0;
    80 	};
    81 
    82 #endif // EXIFIMAGEDISPLAYEXT_H