imagingandcamerafws/imagingfws/ImageProcessor/inc/imageprocessorpreviewintf.h
changeset 0 40261b775718
equal deleted inserted replaced
-1:000000000000 0:40261b775718
       
     1 // Copyright (c) 2008-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 //
       
    15 
       
    16 /**
       
    17  @file
       
    18  @publishedPartner 
       
    19  @released 
       
    20 */
       
    21 
       
    22 #ifndef __IMAGE_PROCESSOR_PREVIEW_INTF__
       
    23 #define __IMAGE_PROCESSOR_PREVIEW_INTF__
       
    24 
       
    25 #include <e32base.h>
       
    26 #include <imageprocessor/imageprocessorpreview.h> 
       
    27 
       
    28 class CFbsBitmap;
       
    29 class CImageFrame;
       
    30 
       
    31 namespace ImageProcessor
       
    32 	{
       
    33 namespace Plugin
       
    34 	{
       
    35 	
       
    36 /**
       
    37 Plugin API for the preview.
       
    38 
       
    39 @see TPreview
       
    40 @publishedPartner
       
    41 @released
       
    42 */	
       
    43 class MPreview
       
    44 	{
       
    45 public:
       
    46 	/**
       
    47 	This must provide an implementation as defined by TPreview::SetOutputL(CFbsBitmap& aBitmap)
       
    48 	
       
    49 	@see TPreview::SetOutputL(CFbsBitmap& aBitmap)
       
    50 	*/	
       
    51 	virtual void SetOutputL(CFbsBitmap& aBitmap) = 0;
       
    52 	
       
    53 	/**
       
    54 	This must provide an implementation as defined by TPreview::SetOutputL(CImageFrame& aPixelBuffer)
       
    55 	
       
    56 	@see TPreview::SetOutputL(CImageFrame& aPixelBuffer)
       
    57 	*/
       
    58 	virtual void SetOutputL(CImageFrame& aPixelBuffer) = 0;
       
    59 	
       
    60 	/**
       
    61 	This must provide an implementation as defined by TPreview::CreateOutputL(const TSize &aFrameSize, const TFrameFormatBase &aFrameFormat, const TFrameLayoutBase &aFrameLayout)
       
    62 	
       
    63 	@see TPreview::CreateOutputL(const TSize &aFrameSize, const TFrameFormatBase &aFrameFormat, const TFrameLayoutBase &aFrameLayout)
       
    64 	*/
       
    65 	virtual CImageFrame* CreateOutputL(const TSize &aFrameSize, const TFrameFormatBase &aFrameFormat, const TFrameLayoutBase &aFrameLayout) = 0;
       
    66 	
       
    67 	/**
       
    68 	This must provide an implementation as defined by TPreview::InitializeL()
       
    69 	
       
    70 	@see TPreview::InitializeL()
       
    71 	*/
       
    72 	virtual void InitializeL() = 0; // async
       
    73 	
       
    74 	/**
       
    75 	This must provide an implementation as defined by TPreview::UninitializeL()
       
    76 	
       
    77 	@see TPreview::UninitializeL()
       
    78 	*/
       
    79 	virtual void UninitializeL() = 0; // sync
       
    80 
       
    81 	/**
       
    82 	This must provide an implementation as defined by TPreview::RenderL()
       
    83 	
       
    84 	@see TPreview::RenderL()
       
    85 	*/
       
    86 	virtual void RenderL() = 0;
       
    87 
       
    88 	/**
       
    89 	This must provide an implementation as defined by TPreview::ResetL()
       
    90 	
       
    91 	@see TPreview::ResetL()
       
    92 	*/
       
    93 	virtual void ResetL() = 0;
       
    94 	
       
    95 	/**
       
    96 	This must provide an implementation as defined by TPreview::Cancel()
       
    97 	
       
    98 	@see TPreview::Cancel()
       
    99 	*/
       
   100 	virtual void Cancel() = 0;
       
   101 
       
   102 	/**
       
   103 	This must provide an implementation as defined by TPreview::SetZoomL(TReal32 aZoom)
       
   104 	
       
   105 	@see TPreview::SetZoomL(TReal32 aZoom)
       
   106 	*/
       
   107 	virtual void SetZoomL(TReal32 aZoom) = 0;
       
   108 	
       
   109 	/**
       
   110 	This must provide an implementation as defined by TPreview::SetPanL(TReal32 aPanX, TReal32 aPanY)
       
   111 	
       
   112 	@see TPreview::SetPanL(TReal32 aPanX, TReal32 aPanY)
       
   113 	*/
       
   114 	virtual void SetPanL(TReal32 aPanX, TReal32 aPanY) = 0;
       
   115 	
       
   116 	/**
       
   117 	This must provide an implementation as defined by TPreview::SetPreviewId(TInt aPreviewId)
       
   118 	
       
   119 	@see TPreview::SetPreviewId(TInt aPreviewId)
       
   120 	*/
       
   121 	virtual void SetPreviewId(TInt aPreviewId) = 0;
       
   122 
       
   123 	/**
       
   124 	This must provide an implementation as defined by TPreview::GetZoomLevelSettings(TReal32& aMinimumLevel, TReal32& aMaximumLevel)
       
   125 	
       
   126 	@see TPreview::GetZoomLevelSettings(TReal32& aMinimumLevel, TReal32& aMaximumLevel)
       
   127 	*/
       
   128 	virtual void GetZoomLevelSettings(TReal32& aMinimumLevel, TReal32& aMaximumLevel) = 0;
       
   129 	
       
   130 	/**
       
   131 	This must provide an implementation as defined by TPreview::GetPanLevelSettings(TReal32& aMinimumLevel, TReal32& aMaximumLevel)
       
   132 	
       
   133 	@see TPreview::GetPanLevelSettings(TReal32& aMinimumLevel, TReal32& aMaximumLevel)
       
   134 	*/
       
   135 	virtual void GetPanLevelSettings(TReal32& aMinimumLevel, TReal32& aMaximumLevel) = 0;
       
   136 	
       
   137 	/**
       
   138 	This must provide an implementation as defined by TPreview::ZoomL()
       
   139 	
       
   140 	@see TPreview::ZoomL()
       
   141 	*/
       
   142 	virtual TReal32 ZoomL() const = 0;
       
   143 	
       
   144 	/**
       
   145 	This must provide an implementation as defined by TPreview::PanL(TReal32& aPanX, TReal32& aPanY)
       
   146 	
       
   147 	@see TPreview::PanL(TReal32& aPanX, TReal32& aPanY)
       
   148 	*/
       
   149 	virtual void PanL(TReal32& aPanX, TReal32& aPanY) const = 0;
       
   150 	
       
   151 	/**
       
   152 	This must provide an implementation as defined by TPreview::SizeL()
       
   153 	
       
   154 	@see TPreview::SizeL()
       
   155 	*/
       
   156 	virtual TSize SizeL() const = 0;
       
   157 	
       
   158 	/**
       
   159 	This must provide an implementation as defined by TPreview::CanvasAreaL()
       
   160 	
       
   161 	@see TPreview::CanvasAreaL()
       
   162 	*/
       
   163 	virtual TRect CanvasAreaL() const = 0;
       
   164 	
       
   165 	/**
       
   166 	This must provide an implementation as defined by TPreview::PreviewId()
       
   167 	
       
   168 	@see TPreview::PreviewId()
       
   169 	*/
       
   170 	virtual TInt PreviewId() const = 0;
       
   171 	
       
   172 	/**
       
   173 	This must provide an implementation as defined by TPreview::PreviewToCurrentCoordL(const TPoint& aPreviewPoint, TPoint& aCurrentPoint)
       
   174 	
       
   175 	@see TPreview::PreviewToCurrentCoordL(const TPoint& aPreviewPoint, TPoint& aCurrentPoint)
       
   176 	*/
       
   177 	virtual void PreviewToCurrentCoordL(const TPoint& aPreviewPoint, TPoint& aCurrentPoint) const = 0;
       
   178 	
       
   179 	/**
       
   180 	This must provide an implementation as defined by TPreview::CanvasToCurrentCoordL(const TPoint& aCanvasPoint, TPoint& aCurrentPoint)
       
   181 	
       
   182 	@see TPreview::CanvasToCurrentCoordL(const TPoint& aCanvasPoint, TPoint& aCurrentPoint)
       
   183 	*/
       
   184 	virtual void CanvasToCurrentCoordL(const TPoint& aCanvasPoint, TPoint& aCurrentPoint) const = 0;
       
   185 
       
   186 	/**
       
   187 	This must provide an implementation as defined by TPreview::Extension(TUid aExtension)
       
   188 	
       
   189 	@see TPreview::Extension(TUid aExtension)
       
   190 	*/
       
   191 	virtual TAny* Extension(TUid aExtension) const = 0;
       
   192 
       
   193 private:
       
   194 	TInt iReserved; // future proof
       
   195 	};
       
   196 
       
   197 	}
       
   198 	}
       
   199 
       
   200 #endif //__IMAGE_PROCESSOR_PREVIEW_INTF__