epoc32/include/imageprocessor/imageprocessorobserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
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.
williamr@4
     1
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
//
williamr@4
    15
williamr@4
    16
/**
williamr@4
    17
 @file
williamr@4
    18
 @publishedAll 
williamr@4
    19
 @released 
williamr@4
    20
*/
williamr@4
    21
williamr@4
    22
#ifndef __IMAGE_PROCESSOR_OBSERVER_H__
williamr@4
    23
#define __IMAGE_PROCESSOR_OBSERVER_H__
williamr@4
    24
williamr@4
    25
#include <e32base.h>
williamr@4
    26
williamr@4
    27
namespace ImageProcessor
williamr@4
    28
	{
williamr@4
    29
williamr@4
    30
class CImgProcessor;
williamr@4
    31
williamr@4
    32
/**
williamr@4
    33
Plugin API for the observer of CImgProcessor.
williamr@4
    34
When the CImgProcessor is set to EOptionNone, which means effects, geometric operations and rendering 
williamr@4
    35
are applied asynchronously. After certain operations such as initialization or rendering finished, or after each iteration 
williamr@4
    36
of operation, the certain function will be called, so that user can perform corresponding response. 
williamr@4
    37
williamr@4
    38
@see TEvent
williamr@4
    39
@publishedAll
williamr@4
    40
@released
williamr@4
    41
*/	
williamr@4
    42
class MImgProcessorObserver
williamr@4
    43
	{
williamr@4
    44
public: 
williamr@4
    45
	/**
williamr@4
    46
	The derived class must provide an implementation to perform actions after ImageProcessor complete its initialization
williamr@4
    47
	
williamr@4
    48
	@param  aImageProcessor
williamr@4
    49
    		The CImgProcessor which has finished the initialization
williamr@4
    50
    @param  aError
williamr@4
    51
    		any error happened in the CImgProcessor initialize process
williamr@4
    52
    */
williamr@4
    53
	virtual void ImageProcessorInitializingComplete(CImgProcessor& aImageProcessor, TInt aError) = 0;
williamr@4
    54
	
williamr@4
    55
	/**
williamr@4
    56
	The derived class must provide an implementation to perform actions after the preview of ImageProcessor complete its initialization
williamr@4
    57
	
williamr@4
    58
	@param  aImageProcessor
williamr@4
    59
    		The CImgProcessor which has finished the initialization of its prview
williamr@4
    60
    @param  aPreviewId
williamr@4
    61
    		the id of the preview which has finished the initialization
williamr@4
    62
    @param  aError
williamr@4
    63
    		any error happened in the CImgProcessor preview initialize process
williamr@4
    64
    */
williamr@4
    65
	virtual void ImageProcessorPreviewInitializingComplete(CImgProcessor& aImageProcessor, TInt aPreviewId, TInt aError) = 0;
williamr@4
    66
	
williamr@4
    67
	/**
williamr@4
    68
	The derived class must provide an implementation to perform actions after ImageProcessor complete its action of image processing
williamr@4
    69
	
williamr@4
    70
	@param  aImageProcessor
williamr@4
    71
    		The CImgProcessor which has finished the rendering
williamr@4
    72
    @param  aError
williamr@4
    73
    		any error happened in the CImgProcessor rendering process
williamr@4
    74
    */
williamr@4
    75
	virtual void ImageProcessingComplete(CImgProcessor& aImageProcessor, TInt aError) = 0;
williamr@4
    76
	
williamr@4
    77
	/**
williamr@4
    78
	The derived class must provide an implementation to perform actions after the preview of ImageProcessor complete its rendering process
williamr@4
    79
	
williamr@4
    80
	@param  aImageProcessor
williamr@4
    81
    		The CImgProcessor which has finished the rendering of its prview
williamr@4
    82
    @param  aPreviewId
williamr@4
    83
    		the id of the preview which has finished the rendering
williamr@4
    84
    @param  aError
williamr@4
    85
    		any error happened in the CImgProcessor preview rendering process
williamr@4
    86
    */
williamr@4
    87
	virtual void ImageProcessorPreviewRenderingComplete(CImgProcessor& aImageProcessor, TInt aPreviewId, TInt aError) = 0;
williamr@4
    88
	
williamr@4
    89
	/**
williamr@4
    90
	During image processing, after each iteration, this function will be notified and
williamr@4
    91
	the derived class must provide an implementation to perform actions (optional) such as showing messages to response.
williamr@4
    92
	
williamr@4
    93
	@param  aImageProcessor
williamr@4
    94
    		The current CImgProcessor 
williamr@4
    95
    @param  aEventId
williamr@4
    96
    		the event id of the current iteration, which is defined in imageprocessor.h as TEvent enumeration,
williamr@4
    97
    		could be EEventInitializing, EEventProcessing, EEventRendering, EEventPreviewInitializing or EEventPreviewRendering,
williamr@4
    98
    @param  aUid
williamr@4
    99
    		The value depends on aEventId, and reserved for future purpose
williamr@4
   100
    @param  aId
williamr@4
   101
    		The value depends on aEventId, for example, if aEventId is EEventPreviewRendering, aId will be the id of the preview.
williamr@4
   102
    */
williamr@4
   103
	virtual void ImageProcessorEvent(CImgProcessor& aImageProcessor, TInt aEventId, TUid aUid, TInt aId) = 0;
williamr@4
   104
	};
williamr@4
   105
williamr@4
   106
}	//namespace ImageProcessor
williamr@4
   107
williamr@4
   108
#endif //__IMAGE_PROCESSOR_OBSERVER_H__