/*

* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  SVG Engine header file

 *

*/

#ifndef SVGENGINEINTERFACEIMPL_H

#define SVGENGINEINTERFACEIMPL_H

#if !defined(__E32BASE_H__)

#include <e32base.h>

#endif

//does this need to be in a #define

#include <e32cons.h>

#include <w32std.h>

#include <badesca.h>

#include "SVGRendererId.h"

#include "SVGListener.h"

const TInt KSvgEngineUidValue=0x040039CE;

const TUid KSvgEngineUid={KSvgEngineUidValue};

typedef TUint           TRenderingQuality;

const TRenderingQuality KLowNoAA                = 0;

const TRenderingQuality KHighNoAA               = 1;

const TRenderingQuality KLowAA                  = 2;

const TRenderingQuality KHighAA                 = 3;

const TInt KInvalidEnumAttribute = -10000;

const TReal32 KInvalidFloatAttribute = -10000;

#define KSVGColorNone  2

#define KSVGCurrentColor 3

#define KSVGColorInherit 4

#define KSVGAttributeInherit    5

#define __TLV_ // Needed by orbit.

enum TSvgErrorCode

{

    ESvgNoError = 0,

    ESvgFileNotFound,

    ESvgDocumentNotValid,

    ESvgDocumentNotAvailable,

    ESvgNoMemory,

    ESvgDiskFull,

    ESvgUnknown,

    ESvgMissingRequiredAttribute,

    ESvgInvalidAttributeValue,

    ESvgbFileNotValid,

    ESvgDRMFailure,

    ESvgThumbNailRestriction

};

enum TSvgPreserveAspectAlignType

    {

    ESvgPreserveAspectRatio_None,

    ESvgPreserveAspectRatio_Unknown,

    ESvgPreserveAspectRatio_XmaxYmax,

    ESvgPreserveAspectRatio_XmaxYmid,

    ESvgPreserveAspectRatio_XmaxYmin,

    ESvgPreserveAspectRatio_XmidYmax,

    ESvgPreserveAspectRatio_XmidYmid,	//default

    ESvgPreserveAspectRatio_XmidYmin,

    ESvgPreserveAspectRatio_XminYmax,

    ESvgPreserveAspectRatio_XminYmid,

    ESvgPreserveAspectRatio_XminYmin

    };

enum TSvgMeetOrSliceType

    {

    ESvgMeetOrSlice_Meet,

    ESvgMeetOrSlice_Slice,

    ESvgMeetOrSlice_Unknown

    };	

class       MSvgHyperlinkListener;

class       MSvgTextAreaListener;

class       MSvgTextListener;

class       MSvgAnimationListener;

class     MSvgListener;

class       CGfxGeneralPath;

class       CFbsBitmap;

class       CSvgEngineImpl;

//class     CSvgGcStack;

class       CSvgElementImpl;

class       MSvgEventReceiver;

class       MSvgRequestObserver;

class       CSvgTimer;

class       MXmlElement;

class       CSvgDocumentImpl;

class       CXmlElementImpl;

class       CSvgErrorImpl;

class       CSvgTextElementImpl;

class 		CSvgBitmapFontProvider;

class MRect

    {

    public:

        /**

         * Get the four points for a rectangle

         *

         * @since 1.0

         * @return : void

         */

        virtual void         GetPoints(TPoint& aPoint1, TPoint& aPoint2, TPoint& aPoint3, TPoint& aPoint4) const = 0;

        virtual TBool        Intersects( const MRect& aRect ) = 0;

        virtual void         Center( TPoint& aCenter ) = 0;

    };

class MSvgError

    {

    public:

        /**

         * Determine wether an error is indicated by this object.

         *

         * @since 1.0

         * @return : ETrue, if ErrorCode() != ESvgNoError

         */

        virtual TBool         HasError() = 0;

        /**

         * Determine wether an error is only a warning.

         * This should be a state when the svg may be display, despite

         * a conflict.

         *

         * @since 1.0

         * @return ETrue if HasError() is only a warning.

         */

        virtual TBool         IsWarning() = 0;

        /**

         * Get the error code contained by this object.

         *

         * @since 1.0

         * @return : the TSvgErrorCode value

         */

        virtual TSvgErrorCode ErrorCode() = 0;

        /**

         * Get the error description string for this object.

         *

         * @since 1.0

         * @return : error description string.

         */

        virtual TDesC&        Description() = 0;

        /**

         * Get the system error code contained by this object.  For example,

         * If ErrorCode() is ESvgDRMFailure, SystemErrorCode() will contain

         * the error-code returned by the system for a drm-failure.

         *

         * @since 1.0

         * @return : the TSvgErrorCode value

         */

        virtual TInt SystemErrorCode() = 0;

    };

/**

 * This class implements the interface for a SVGT Engine, providing methods

 * to load svg contents and manipulate the output, such as zooming, panning

 * and rotating the display.

 */

class CSvgEngineInterfaceImpl : public CBase

    {

    public:

        IMPORT_C MSvgError* CSvgEngineInterfaceImpl::SaveSvgDom(TInt aHandle, const TDesC& aFileName, TInt aEngine = NULL);

        /**

         * Two phase construction

         */

        // April 27th : Add thrid new parameter for specifying the Text height

        IMPORT_C static CSvgEngineInterfaceImpl* NewL( CFbsBitmap* aFrameBuffer,

                                                  MSvgRequestObserver* aReqObserver,  TFontSpec& aFontSpec  );

        IMPORT_C static CSvgEngineInterfaceImpl* NewL( CFbsBitmap* aFrameBuffer,

                                                  MSvgRequestObserver* aReqObserver,  TFontSpec& aFontSpec ,SVGRendererId aRendererType );

        /**

         * Create a new Svg Engine interface.

         *

         * @since 1.0

         * @param : aFrameBuffer -- bitmap to draw resulting svg image.

         * @param : aReqObserver -- interface for callbacks to retrieve info

         *                          only client can provide, such as opening files.

         * @param : aFontSpec -- Font spec to use for text drawing.

         * @return : none

         */

        IMPORT_C static CSvgEngineInterfaceImpl* NewLC( CFbsBitmap* aFrameBuffer,

                                                   MSvgRequestObserver* aReqObserver,  TFontSpec& aFontSpec  );

        // NGA:: overloading NewLC to include a renderer selector parameter

        IMPORT_C static CSvgEngineInterfaceImpl* NewLC( CFbsBitmap* aFrameBuffer,

                                                   MSvgRequestObserver* aReqObserver,  TFontSpec& aFontSpec ,SVGRendererId aRendererType );

       /**

         * Added for getting the NVG-TLV from S60SVGTEngine in QT S60 baseport.

         * @since 1.0

         * @return : Pointer to the tlv data

         */

        IMPORT_C const TPtrC8 TLVEncodedData() const;

        /**

         * Svg Engine interface Destructor.

         *

         * @since 1.0

         * @param : None

         * @return : none

         */

        IMPORT_C                            ~CSvgEngineInterfaceImpl();

        /**

         * Load a svg document from a file.  An error is return if one is encountered.

         * Some errors may be more like warnings, which may allow the svg content

         * to display nevertheless.

         *

         * @since 1.0

         * @param aFileName -- Name of svg file

         * @return : Error code if any

         */

        IMPORT_C MSvgError*                  Load( const TDesC& aFileName );

        /**

         * Load a svg document from a byte array.  An error is return if one is encountered.

         * Some errors may be more like warnings, which may allow the svg content

         * to display nevertheless.

         *

         * @since 1.0

         * @param  aByteData -- Byte array of svg document.

         * @return : Error code if any

         */

        IMPORT_C MSvgError*                  Load( const TDesC8& aByteData );

        /**

         * Load a svg document from from the RFile Handle passed.  An error is return if one is encountered.

         * Some errors may be more like warnings, which may allow the svg content

         * to display nevertheless.

         *

         * @since 1.0

         * @param  aFileHandle -- RFile handle of svg document.

         * @return : Error code if any

        **/

        IMPORT_C MSvgError*                  Load( RFile& aFileHandle );

        /**

         * Destroy the currently "loaded" svg document.  Prepared documents,

         * must be destroy through DeleteDom, or the engine will destroy them

         * in its destructor function.

         *

         * @since 1.0

         * @param : none

         * @return : none

         */

        IMPORT_C void                       Destroy();

        /**

         * Request the SVG Engine to begin an animation.

         *

         * @since 1.0

         * @param : aEngine -- NULL to start internal svg-engine

         * @param : aIsMainThread -- EFalse to start engine asynchronously,

         * defaulted to EFalse.

         * @return : none

         */

        IMPORT_C void                       Start( CSvgEngineImpl* aEngine = NULL,

                                                   TBool aIsMainThread = ETrue );

        /**

         * Request the SVG Engine to begin an animation. 

         * This method returns an error code.

         * @since 1.0

         * @param : MSvgError*& -- Pointer to Error object ,

         * @param : aEngine -- NULL to start internal svg-engine,

         * @return : none

         */

         IMPORT_C void                        Start( MSvgError*& aError,

                                                    CSvgEngineImpl* aEngine = NULL

                                                   );

        /**

         * Request the SVG Engine to stop an animation.

         *

         * @since 1.0

         * @param : none

         * @return : none

         */

        IMPORT_C void                       Stop( CSvgEngineImpl* aEngine = NULL );

        /**

         * Request the SVG Engine to pause an animation.

         *

         * @since Series 60 3.0

         * @param : none

         * @return : none

         */

        IMPORT_C void                       Pause( CSvgEngineImpl* aEngine = NULL );

        /**

         * Request the SVG Engine to resume an animation.

         *

         * @since 1.0

         * @param : none

         * @return : none

         */

        IMPORT_C void                       Resume( CSvgEngineImpl* aEngine = NULL );

        /**

         * Get the animation duration of a svg content, in milliseconds,

         * for non-indefinite animations.

         *

         * @since 1.0

         * @param

         * @return the animation duration.

         */

        IMPORT_C TUint32                    Duration( TInt aEngine = NULL );

        /**

         * Reset the view to the default values.  Redraw() must be called to

         * update the output image.

         *

         * @since 1.0

         * @param

         * @return the animation duration.

         */

        IMPORT_C void                       OriginalView( TInt aEngine = NULL );

        /**

         * Request the SVG Engine to zoom-in on the content given the zoom factor.

         * The value range is greater than zero.  The current zoom factor is

         * multiplied with the given value to yield the final result.  Redraw()

         * must be called to update the output image.

         *

         * @since 1.0

         * @param : aScaleFactor -- A value greater than zero.

         * @return

         */

        IMPORT_C void                       Zoom( TReal32 aScaleFactor, TInt aEngine = NULL ) __SOFTFP;

        /**

         * Shift the center of the content in both x and y coordinates.  The

         * values are in user-coordinate values and may be negative.  Redraw()

         * must be called to update the output image.

         *

         * @since 1.0

         * @param : aX -- Number of pixels to pan left (negative) or right.

         * @param : aY -- Number of pixels to pan up (negative) or down.

         * @return

         */

        IMPORT_C void                       Pan( TInt aX, TInt aY, TInt aEngine = NULL );

       /**

         * Shift the center of the content in both x and y coordinates.  The

         * values are in user-coordinate values and may be negative.

         *

         * @since 1.0

         * @param : aX -- Number of pixels to pan left (negative) or right.

         * @param : aY -- Number of pixels to pan up (negative) or down.

         * @return TBool

         */

        IMPORT_C TBool                      IsPanPossible( TInt aX, TInt aY, TInt aEngine = NULL );

       /**

         *  Checks the panning possibility in four directions. A efficient

	 *  API for clients which want to show 4 way panning indicators.

	 *  It is efficient for these clients to get the all four direction

	 *  information at one go. Saves rendering time significantly per

	 *  frame.

	 *

         * @since 1.0

         * @param : left: would contain result of whether panning of one pixel

	 * 	possible to left.

         * @param : right: would contain result of whether panning of one pixel

	 * 	possible to right.

         * @param : up: would contain result of whether panning of one pixel

	 * 	possible to up.

         * @param : down: would contain result of whether panning of one pixel

	 * 	possible to down.

         * @param : 

         * @return 

         */

        IMPORT_C void                      IsPanPossibleFourWay

    ( TBool& left, TBool& right, TBool& up, TBool& down, TInt aEngine = NULL);

        /**

         * Rotate the content about the given point by the given angle.

         * The point is in user-coordinates.  Redraw() must be called to

         * update the output image.

         *

         * @since 1.0

         * @param : aAngle -- Number of gradients to rotate.

         * @param : aX -- X center of rotation

         * @param : aY -- Y center of rotation.

         * @return

         */

        IMPORT_C void                       Rotate( TReal32 aAngle,

                                                    TInt aX,

                                                    TInt aY,

                                                    TInt aEngine = NULL ) __SOFTFP;

        /**

         * Notify the SVG Engine that a "mouse down" event.  The engine will

         * initiate mouse-related events, such as links, if appropriate.

         *

         * @since 1.0

         * @param : aX -- x coordinate of mouse event.

         * @param : aY -- y coordinate of mouse event.

         * @return

         */

        IMPORT_C TInt                       MouseDown( TInt aX, TInt aY, TInt aEngine = NULL );

        /**

         * Notify the SVG Engine that a "mouse up" event.  The engine will

         * initiate mouse-related events, such as links, if appropriate.

         *

         * @since 1.0

         * @param : aX -- x coordinate of mouse event.

         * @param : aY -- y coordinate of mouse event.

         * @return

         */

        IMPORT_C void                       MouseUp( TInt aX, TInt aY, TInt aEngine = NULL );

        /**

         * Notify the SVG Engine that a "mouse move" event.  The engine will

         * initiate mouse-related events, such as links, if appropriate.

         *

         * @since 1.0

         * @param : aX -- x coordinate of mouse event.

         * @param : aY -- y coordinate of mouse event.

         * @return

         */

        IMPORT_C void                       MouseMove( TInt aX, TInt aY, TInt aEngine = NULL );

        /**

         * Notify the SVG Engine that a "key press" event.  The engine will

         * initiate key-related events if appropriate.

         * @since 1.0

         * @param : aKeyCode -- key code of key event.

         * @return

         */

        IMPORT_C void                       KeyPress( const TKeyEvent& aKeyEvent, TInt aEngine = NULL );

        /**

         * Retrieve the rendering quality setting.  See TRenderingQuality

         * for possible values.

         *

         * @since 1.0

         * @param

         * @return

         */

        IMPORT_C TRenderingQuality          GetRenderQuality( );

        /**

         * Set the rendering quality.  Low-level graphics is always set

         * to high -- no effect from this call.  Redraw() must be called to

         * update the output image.

         *

         * @since 1.0

         * @param : aQualityLevel -- rendering quality

         * @return

         */

        IMPORT_C void                       SetRenderQuality( TRenderingQuality aQualityLevel, TInt aEngine = NULL );

        /**

         * Retrieve the reference to the svg document object.

         *

         * @since 1.0

         * @param none

         * @return current document that was Loaded or Prepare/UseDom.

         */

         //DEPRECATED API...

        IMPORT_C CSvgDocumentImpl*          SvgDocument();

        /**

         * Set the minimum delay between each frame, in milliseconds.

         * Frames per Second = 1000 / aFrameDelay

         *

         * The default/minimum value is 67 milliseconds (15 fps).

         *

         * @since 1.0

         * @param : aFrameDelay -- animation frame duration.

         * @return none

         */

        IMPORT_C void                       SetAnimFrameDuration( TUint aAFDur, TInt aEngine = NULL );

        /**

         * Request for updating the off-screen image buffer with the

         * svg content.

         *

         * @since 1.0

         * @param aIsMainThread -- indicate whether this redraw request

         * is called in the main thread (executed immediately).

         * Otherwise, this request is to be executed asynchronously.

         * 'Main thread' used here means the thread which instantiated

         * this CSvgEngineInterfaceImpl object.

         * @return none

         */

        IMPORT_C void                       Redraw( TBool aIsMainThread = ETrue, TInt aEngine = NULL );

        /**

         * Switch the debugging mode on/off.

         *

         * @since 1.0

         * @param none

         * @return none

         */

        IMPORT_C void                       SwitchDebugInfo( TInt aEngine = NULL );