/*

* Copyright (c) 2004,2005 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:  SVGT Custom Control Class implements the custom control used

*                to display SVGT content.

*

*/

#ifndef __SVGTCUSTCONTROL_H__

#define __SVGTCUSTCONTROL_H__

// INCLUDES

#include <e32property.h> 

#include <SVGAnimationListener.h>

#include <SVGEngineInterfaceImpl.h>

#include <SVGRequestObserver.h>

#include <AknUtils.h>

#include <SVGListener.h>

#include <SVGHyperlinkListener.h>

#include <SVGTUIControlDbgFlags.hrh>

#include <SVGTProgressBarTimer.h>

#include <SVGTPointerHideTimer.h>

#include <e32std.h>

#ifdef RD_SVGT_AUDIO_SUPPORT

#include<remconcoreapitargetobserver.h>    //for MRemConCoreApiTargetObserver

#endif //RD_SVGT_AUDIO_SUPPORT

// CONSTANTS

const TInt KFindTextQueryMaxLen = 50;

// MACROS

// DATA TYPES

// Enumeration for indicating animation Status of current SVGT Content

enum TSvgtAnimStatus {

        ESvgNoAnimationsPresent,

        ESvgAllAnimationsComplete,

        ESvgAnimationsNotComplete };

// Enumeration for indicating Animation State of the viewer

enum TSvgtViewerAnimStatus

        {

        ESvgAnimPausedState,

        ESvgAnimPlayingState,

        ESvgAnimStoppedState

        };

// Enumeration for indicating pointer types in the viewer

enum TSvgtViewerPointerTypes

            {

            ESvgPointerDefault,

            ESvgPointerHand,

            ESvgPointerText

            };        

enum TSvgCustomControlFlag

        {

        ESvgDisplayWaitNote   = 0x01,    // need to draw initial wait note

        ESvgDisplayErrorNotes = 0x02,    // Display Error Notes

        ESvgDisplayIcons      = 0x04,    // Display Icons

        ESvgWindowOwning      = 0x08,    // Window Owning Control

        ESvgDrawPointer       = 0x10,    // Pointer is drawn

        ESvgDrawPanIndicator  = 0x20,	 // Panning Indicator is drawn

        ESvgDrawPauseIndicator = 0x40,   // Pause Indicator is drawn

        ESvgDrawProgressBar    = 0x80,    // ProgressBar drawn

        ESvgUseBackLight       = 0x100    // Keep Backlight on while animating

        };        

enum TSvgCustomControlSelectCause

    {

    ESvgInvalidSelectCause,

    ESvgHyperLinkSelectCause,

    ESvgTextSelectCause,

    ESvgTextAreaSelectCause    

    };

// FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

class   CSvgEngineInterfaceImpl;

class   CSVGTHyperlinkHandler;

class   CCoeControl;

class   CSVGTProgressBarTimer;

class   MSvgtAppObserver;

class   CAknWaitDialog;

class   CSVGTDrmHelper;

class   CSvgtThreadController;

class   CAknInformationNote;

class   MSvgtApplicationExitObserver;

class   CSvgtEventHandlerAO;

class   CAknNavigationControlContainer;

class   CAknNavigationDecorator;

#ifdef RD_SVGT_AUDIO_SUPPORT

class   CAknVolumePopup;

class CRemConCoreApiTarget;

class CRemConInterfaceSelector;

#endif //RD_SVGT_AUDIO_SUPPORT

// CLASS DECLARATION

/**

*  Interface for the progress timer event listener.

*  @lib SVGTUIControl.lib

*  @since 3.0

*/

class MSVGTProgressBarDrawImpl 

    {

    public:

        /**

        * This function is called in order to render the progress indicator.

        * @since 3.0

        * @param aTimeElapsed - Contains the time elapsed in seconds.

        * @param aTotalTime - Contains the total time in seconds

        */

        virtual void DrawProgressBarL( TUint aTimeElapsed, 

            TUint aTotalTime ) = 0;

    };

/**

*  Interface for MSK labelling   

*  @lib SVGTUIControl.lib

*  @since 3.2

*/

class MSVGTMSKImpl

{

	public:

	/**

	* This function is called to draw the MSK label by pushing the command to

	* position button's stack

	* @since 3.2

	* @param aResourceID - The MSK label resourceID

	* @param aCommandID	- The command associated with that label

	*/ 							

	virtual void DrawMSKLabelL(TInt aResourceID,TInt aCommandID)=0;

    /**

    * This function is called to remove MSK label from button group's stack

	* @since 3.2

	*/

	virtual void RemoveMSKLabel()=0;

};

class MCustControlPointerEventHandler

    {

public:

    virtual TBool HandleCustControlPointerEventL(const TPointerEvent& aPointerEvent) = 0;    

    };

class MSvgCustControlListener

{

};

enum TCustControlListener

	{

	EAudioListener = 0	

	};

#ifdef RD_SVGT_AUDIO_SUPPORT

class MSvgAudioMuteListener : public MSvgCustControlListener

{

	public:

	virtual void VolumeMuted(TBool aIsVolumeMuted) = 0;

};

#endif

/**

*  CSVGTCustControl is a CCoeControl used to display SVGT content.

*  It can be used independently or through dialog provided by

*  CSVGTUIDialog.

*

*  @lib SVGTUIControl.lib

*  @since 3.0

*/

class CSVGTCustControl : public CCoeControl,

                         public MSvgRequestObserver,

                         public MSvgAnimationListener,

                         public MSVGTProgressBarListener,

                         public MSVGTPointerInactivityListener,

                         public MSvgHyperlinkListener

#ifdef SVGTUICONTROL_DBG_TEXT_EDIT_SELECT_API_ENABLE

                         , public MSvgTextAreaListener,

                         public MSvgTextListener

#endif // SVGTUICONTROL_DBG_TEXT_EDIT_SELECT_API_ENABLE                         

                         , public MSvgLoadingListener

#ifdef RD_SVGT_AUDIO_SUPPORT

                         , public MCoeControlObserver

                         , public MRemConCoreApiTargetObserver

#endif //RD_SVGT_AUDIO_SUPPORT

                         , public MSvgInteractiveElementListener

                         ,public MSvgViewPortListener

    {

    public:

        enum TFileType

            {

            // The uri refers to a local image file

            ELocalImageFile,

            // The uri refers to a remote image file

            ERemoteImageFile,

            // The uri doesnt refer to an image file

            ENotAnImageFile,

            // The uri is not well formed(parsing error)

            EInvalidFilePath

            };

    public: // Constructors and destructor

    MCustControlPointerEventHandler* iPntrObserver;

    void SetPointerObserver(MCustControlPointerEventHandler* aPntrObserver)

        {

        iPntrObserver = aPntrObserver;

        }

//TOUCH SUPPORT START    

#ifdef RD_SCALABLE_UI_V2

        //From CCoeControl

		void HandlePointerEventL(const TPointerEvent& aPointerEvent);

        void SetContainerWindowL(const CCoeControl &aContainer);

		enum TIndicatorType

		    {

		    ELeftIndicator,

		    ERightIndicator,

		    EUpIndicator,

		    EDownIndicator,

		    EPauseIndicator, //for future use

		    ENoIndicator

		    };

		TIndicatorType ActiveIndicator(const TPoint aPosition ) const;

		TRect ActiveIndicatorRect( TIndicatorType aIndicator) const;

		void PanPresentation(const CSVGTCustControl::TIndicatorType aIndicatorType );

#endif  //RD_SCALABLE_UI_V2

#ifdef RD_SVGT_AUDIO_SUPPORT

        //From MCoeControlObserver

        virtual void HandleControlEventL(CCoeControl* aControl,TCoeEvent aEventType);

		void SetPresentationVolume( TInt aVolumeLevel );

		TInt PresentationVolume() const;

		TInt GetPrevVolume() const;

        void MrccatoCommand(TRemConCoreApiOperationId aOperationId, 

                             TRemConCoreApiButtonAction aButtonAct );

        void FilterAndSendCommand(TInt aCommandId);

#endif	//RD_SVGT_AUDIO_SUPPORT

//TOUCH SUPPORT END

        /**

        * Two-phased constructor.

        * @since 3.0

        * @param aFileHandle RFile that indicates the SVGT content filehandle

        * @param aAppObs Implementation Class provided by application that

        *   uses this control

        * @param aPBDrawImpl Implementation for rendering progress Indicator

        * @param aMSKImpl Implementation for drawing MSK label 

        * Note: The ownership of the file handle is not transferred. 

        *       It is the responsibility of the caller to close this file 

        *       after deleting this control.

        * @return CSVGTCustControl*

        */

        IMPORT_C static CSVGTCustControl* NewL( RFile& aFileHandle,

                                       MSvgtAppObserver* aAppObs, 

                                       MSVGTProgressBarDrawImpl* aPBDrawImpl,

                                       MSVGTMSKImpl* aMSKImpl,

                                       MSvgtApplicationExitObserver* 

                                            aExitObserver = NULL,

                                       TBool aProgressiveRendering = EFalse,

                                       const CCoeControl* aParent = NULL,

                                       TInt aDisplayFlag = 

                                       ESvgDisplayWaitNote|

                                       ESvgDisplayErrorNotes|

                                       ESvgDisplayIcons|

                                       ESvgDrawPanIndicator|

                                       ESvgDrawPointer|

                                       ESvgDrawPauseIndicator|

                                       ESvgDrawProgressBar|

                                       ESvgUseBackLight

                                        );

        /**

        * Two-phased constructor which pushes created object onto

        * Cleanup Stack.

        * @since 3.0

        * @param aFileHandle RFile that indicates the SVGT content filehandle

        * @param aAppObs Implementation Class provided by application that

        *   uses this control

        * @param aPBDrawImpl Implementation for rendering progress Indicator

        * @param aMSKImpl Implementation for drawing MSK label 

        * Note: The ownership of the file handle is not transferred. 

        *       It is the responsibility of the caller to close this file 

        *       after deleting this control.

        * @return CSVGTCustControl*

        */

        static CSVGTCustControl* NewLC( RFile& aFileHandle,

                                        MSvgtAppObserver* aAppObs,

                                        MSVGTProgressBarDrawImpl* aPBDrawImpl,

                                        MSVGTMSKImpl* aMSKImpl,

                                        MSvgtApplicationExitObserver* 

                                            aExitObserver = NULL,

                                        TBool aProgressiveRendering = EFalse,

                                        const CCoeControl* aParent = NULL,

                                        TInt aDisplayFlag = 

                                        ESvgDisplayWaitNote|

                                        ESvgDisplayErrorNotes|

                                        ESvgDisplayIcons|

                                        ESvgDrawPanIndicator|

                                        ESvgDrawPointer|

                                        ESvgDrawPauseIndicator|

                                        ESvgDrawProgressBar|

                                        ESvgUseBackLight );

        /**

        * Destructor.

        */

        virtual ~CSVGTCustControl();

    public: // New functions

      	/**

      	* Sets the MSK Labels under various circumstances. 

      	* @since 3.2

      	*/

       	void SetMSKLabelL();

      	/**

      	* Indicates whether the context menu is opened or not

      	* @since 3.2

      	* @param aButtonID -EAknSoftkeyContextOptions indicates context menu icon is pressed

      	*				   -EAknSoftkeySelect animation on mousedown/mouseup event.

      	* @return TBool-ETrue Indicates context menu icon is pressed

      	*				EFalse otherwise.

      	*/

      	TBool GetMSKLabelFlag(TInt aButtonId) const;

      	/**

      	* Sets either the iPlayMSKLabel and iContextMenuActivated flag.

      	* @since 3.2

      	* @param aButtonID -EAknSoftkeyContextOptions indicates context menu icon is pressed

      	*				   -EAknSoftkeySelect animation on mousedown/mouseup event.

      	*/

      	void ChangeMSKLabelFlag(TInt aButtonId);

        /**

        * Process commands for handling SVGT content.

        * @since 3.0

        * @param aCommandId Integer indicating command that was activated.

        */

        virtual void ProcessViewerCommandL( TInt aCommandId );

        /**

        * Get function for current zoom level.

        * @since 3.0

        * @param aZoomLevel Integer indicating the number of times the

        *  user has zoomed in(Zero indicates original view or no Zoom)

        */

        void GetCurrentZoomLevel( TInt& aZoomLevel ) const;

        /**

        * Get function for current play status.

        * @since 3.0

        * @param aIsPlaying Boolean indicating whether Content is

        *  Playing/Paused.

        */

        void GetCurrentAnimState( TSvgtViewerAnimStatus& aAnimState ) const;

        /**

        * Indicates whether the Control in Full Screen Mode.

        * @since 3.0

        * @param aIsFullScreenOn Boolean indicating whether Content is

        *  in Full Screen Mode.

        */

        void GetCurrentFullScreenStatus( TBool& aIsFullScreenOn ) const;

        /**

        * Indicates whether the Loop feature is enabled for the Control

        * @since 3.0

        * @param aIsLoopOn Boolean indicating whether Content is

        *  in Loop Mode.

        */

        void GetCurrentLoopStatus( TBool& aIsLoopOn ) const;

        /**

        * Gets the normal screen layout rectangle for control from LAF

        * @since 3.0

        * @param aRect TRect indicating the rectangle extent of the control

        */

        void GetNormalScreenLayoutRect( TRect& aRect ) const;

        /**

        * Indicates whether the Loop feature is allowed for the Control

        * Note: Loop Feature is allowed only for Non-Interactive content

        * which has finite duration animations.

        * @since 3.0

        * @return TBool - ETrue Indicates Loop is allowed

        *                 EFalse Otherwise.

        */

        TBool IsLoopAllowed() const;

        /**

        * Finds whether the content contains animations

        * @return TBool -  ETrue indicates content contains animations,

        *                  EFalse otherwise

        * @since 3.0

        */

        TBool  IsAnimationPresent() const;

        /**

        * Finds whether the content contains any infinite duration animation

        * @return TBool -  ETrue indicates Finite duration,

        *                  EFalse otherwise

        * @since 3.0

        */

        TBool  IsContentFinite() const;

        /**

        * Indicates whether the SVG content is loaded 

        * @return TBool -  ETrue indicates content loading complete,

        *                  EFalse otherwise

        * @since 3.0

        */        

        TBool  IsProcessDone() const;

        /**

        * Sets the screen mode of the Control State Variable.

        * Note: This does not change the size of the framebuffer - 

        * This is done in the SizeChanged().

        * @since 3.0

        * @param aIsFullScreenOn Boolean indicating whether Content is

        *  in Full Screen Mode.

        */

        virtual void SetCurrentFullScreenStatus( TBool aIsFullScreenOn );

        /**

        * Function used by the application to handle background/foreground

        * events. When the application goes to background the presentation

        * needs to be paused. When application comes back to foreground,

        * the user would need to start the paused presentation. 

        * @param aForeground: ETrue: Foreground event, 

        *                     EFalse: Background event.

        * @since 3.0

        */

        void HandleApplicationForegroundEvent( TBool aForeground );

        /**

        * Indicates whether the "Select Text" menu item be displayed

        * @since 3.1

        * @return TBool - ETrue Indicates menu item is displayed

        *                 EFalse Otherwise.

        */

        TBool IsTextSelectOn() const;

        /**

        * Indicates whether the "Edit Text" menu item be displayed

        * @since 3.1

        * @return TBool - ETrue Indicates menu item is displayed

        *                 EFalse Otherwise.

        */

        TBool IsTextEditOn() const;

        /**

        * Indicates whether the text content has changed since

        * last Save.

        * @since 3.1

        * @return TBool - ETrue Indicates text has changed

        *                 EFalse Otherwise.

        */

        TBool IsTextContentChanged() const;

        /**

        * Used to notify custom control that save is complete and

        * any cleanup operation can be performed.

        * @since 3.1

        */

        void SaveComplete( const TInt aError );

        TInt DoHandleLoadingThreadError();

        void DoExitFromDialogL();

        void AssignImageData( const TDesC& aUri, HBufC8* aData );

        TFileType ImageFileType( const TDesC& aUri ) const;

        void SetThreadRunning(TBool aState);

        TBool IsThreadRunning() const;

        void PerformEngineRedraw();

        /**

        * Used to reset the backlight time for finite content

        * any cleanup operation can be performed.

        * @since 3.1

        */

        void ResetBacklightTime();

        void StopEventHandler();

        /**

        * This is a utility function is used for performing functionality 

        * once the engine load is complete

        * @since 3.1