1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/imageprocessor/imageprocessorobserver.h Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -0,0 +1,108 @@
1.4 +// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +/**
1.20 + @file
1.21 + @publishedAll
1.22 + @released
1.23 +*/
1.24 +
1.25 +#ifndef __IMAGE_PROCESSOR_OBSERVER_H__
1.26 +#define __IMAGE_PROCESSOR_OBSERVER_H__
1.27 +
1.28 +#include <e32base.h>
1.29 +
1.30 +namespace ImageProcessor
1.31 + {
1.32 +
1.33 +class CImgProcessor;
1.34 +
1.35 +/**
1.36 +Plugin API for the observer of CImgProcessor.
1.37 +When the CImgProcessor is set to EOptionNone, which means effects, geometric operations and rendering
1.38 +are applied asynchronously. After certain operations such as initialization or rendering finished, or after each iteration
1.39 +of operation, the certain function will be called, so that user can perform corresponding response.
1.40 +
1.41 +@see TEvent
1.42 +@publishedAll
1.43 +@released
1.44 +*/
1.45 +class MImgProcessorObserver
1.46 + {
1.47 +public:
1.48 + /**
1.49 + The derived class must provide an implementation to perform actions after ImageProcessor complete its initialization
1.50 +
1.51 + @param aImageProcessor
1.52 + The CImgProcessor which has finished the initialization
1.53 + @param aError
1.54 + any error happened in the CImgProcessor initialize process
1.55 + */
1.56 + virtual void ImageProcessorInitializingComplete(CImgProcessor& aImageProcessor, TInt aError) = 0;
1.57 +
1.58 + /**
1.59 + The derived class must provide an implementation to perform actions after the preview of ImageProcessor complete its initialization
1.60 +
1.61 + @param aImageProcessor
1.62 + The CImgProcessor which has finished the initialization of its prview
1.63 + @param aPreviewId
1.64 + the id of the preview which has finished the initialization
1.65 + @param aError
1.66 + any error happened in the CImgProcessor preview initialize process
1.67 + */
1.68 + virtual void ImageProcessorPreviewInitializingComplete(CImgProcessor& aImageProcessor, TInt aPreviewId, TInt aError) = 0;
1.69 +
1.70 + /**
1.71 + The derived class must provide an implementation to perform actions after ImageProcessor complete its action of image processing
1.72 +
1.73 + @param aImageProcessor
1.74 + The CImgProcessor which has finished the rendering
1.75 + @param aError
1.76 + any error happened in the CImgProcessor rendering process
1.77 + */
1.78 + virtual void ImageProcessingComplete(CImgProcessor& aImageProcessor, TInt aError) = 0;
1.79 +
1.80 + /**
1.81 + The derived class must provide an implementation to perform actions after the preview of ImageProcessor complete its rendering process
1.82 +
1.83 + @param aImageProcessor
1.84 + The CImgProcessor which has finished the rendering of its prview
1.85 + @param aPreviewId
1.86 + the id of the preview which has finished the rendering
1.87 + @param aError
1.88 + any error happened in the CImgProcessor preview rendering process
1.89 + */
1.90 + virtual void ImageProcessorPreviewRenderingComplete(CImgProcessor& aImageProcessor, TInt aPreviewId, TInt aError) = 0;
1.91 +
1.92 + /**
1.93 + During image processing, after each iteration, this function will be notified and
1.94 + the derived class must provide an implementation to perform actions (optional) such as showing messages to response.
1.95 +
1.96 + @param aImageProcessor
1.97 + The current CImgProcessor
1.98 + @param aEventId
1.99 + the event id of the current iteration, which is defined in imageprocessor.h as TEvent enumeration,
1.100 + could be EEventInitializing, EEventProcessing, EEventRendering, EEventPreviewInitializing or EEventPreviewRendering,
1.101 + @param aUid
1.102 + The value depends on aEventId, and reserved for future purpose
1.103 + @param aId
1.104 + The value depends on aEventId, for example, if aEventId is EEventPreviewRendering, aId will be the id of the preview.
1.105 + */
1.106 + virtual void ImageProcessorEvent(CImgProcessor& aImageProcessor, TInt aEventId, TUid aUid, TInt aId) = 0;
1.107 + };
1.108 +
1.109 +} //namespace ImageProcessor
1.110 +
1.111 +#endif //__IMAGE_PROCESSOR_OBSERVER_H__