/*

* Copyright (c) 2002-2006 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:  

*     CMmsViewerAppUi class definition.

*

*/

#ifndef MMSVIEWERAPPUI_H

#define MMSVIEWERAPPUI_H

// INCLUDES

#include <finditemengine.h>

#ifdef RD_SCALABLE_UI_V2

#include <akntoolbarobserver.h>

#endif

#include <MuiuMessageIterator.h>

#include <MsgEditorAppUi.h>             // CMsgEditorAppUi

#include <cenrepnotifyhandler.h>

#include <DRMCommon.h>

#include <msgasynccontrolobserver.h>    //MMsgMediaControlObserver

#include <uniobject.h>

#include <unidrminfo.h>                 // CUniDrmInfo

#include <AknNaviDecoratorObserver.h>

#include <aknlongtapdetector.h> // for long tap

#include "MmsViewer.hrh"                // enumerations

#include "MmsViewerOperation.h"

#include "UniMmsSvkEvents.h"               // MMmsSvkEventsObserver

// FUNCTION PROTOTYPES

GLREF_C void Panic( TMmsViewerExceptions aPanic ); 

// FORWARD DECLARATIONS

#ifndef RD_MSG_NAVIPANE_IMPROVEMENT

class CAknNavigationDecorator;

#endif

class CAknNavigationControlContainer;

class CAknTitlePane;

class CAknWaitDialog;

class CMdaAudioPlayerUtility;

class MVideoControlStateObserver;

class CFindItemMenu;

class CFindItemEngine;

class CDocumentHandler;

class CDRMRights;

class CAknLocalScreenClearer;

class CMmsViewerLaunchOperation;

class CMmsViewerChangeSlideOperation;

class CMmsViewerHeader;

class CMmsViewerSendReadReportOperation;

class CMsgMediaInfo;

class CMsgMediaControl;

class CMsgAudioControl;

class CMsgVideoControl;

class CMsgImageControl;

#ifdef RD_SVGT_IN_MESSAGING

class CMsgSvgControl;

#endif

class CMmsConformance;

class CUniSlideLoader;

class CUniSmilModel;

class CUniObjectList;

class CRepository;

class CSendingServiceInfo;

class CMsgVoIPExtension;

class CAknInputBlock;

class CPeriodic;

class CAknVolumeControl;

class CAknInputBlock;

class CAknToolbar;

class CAknStylusPopUpMenu;

// CLASS DECLARATION

/**

*  CMmsViewerAppUi

*  Inherited from CMsgEditorAppUi

*/

class CMmsViewerAppUi :

    public CMsgEditorAppUi,

    public MCenRepNotifyHandlerCallback,

    public MMsgAsyncControlObserver,

    public MMmsViewerOperationObserver,     // ViewerOperationEvent

    public MMmsSvkEventsObserver,           // MmsSvkChangeVolumeL

    public MAknServerAppExitObserver,       // for image viewer

#ifdef RD_SCALABLE_UI_V2

#ifndef RD_MSG_NAVIPANE_IMPROVEMENT

    public MAknNaviDecoratorObserver,       //for navidecorator

#endif

    public MAknToolbarObserver,             //toolbar

#endif

    public MCoeControlObserver,              // of CAknVolumeControl

    public MUniObjectObserver,

    public MAknLongTapDetectorCallBack

    {

    public:  // Constructors and destructor

        /**

        * C++ default constructor.

        */

        CMmsViewerAppUi();

        /**

        * Destructor.

        */

        virtual ~CMmsViewerAppUi();

    protected: 

        /**

         * Prepare to exit.

         * from CEikAppUi

         */

        void PrepareToExit();

    private: // New functions        

        /**

        * Calls InitNavipaneL, PrepareHeaderL and PrepareBodyL

        * and does some validity checks.

        */

        void DrawSlideL();

        /**

        * Set waiting note.

        */

        void SetPendingNote(    TInt                aResourceId, 

                                CUniObject*         aObject = NULL,

                                TInt                aError = KErrNone );

        /**

        * Shows notes related to message opening, 

        * which could not shown until loading was complete

        */

        void ShowPendingNoteL();

        /**

        * Changes slide. Calls ResetViewL and DrawSlideL. Creates

        * a screen blanker to hide the view operations from the user.

        * @param aSlideNumber The number of the slide to be shown next.

        * @param aScreenClearer Screen clearer is run

        */

        void ChangeSlideL( TInt aSlideNumber, TBool aScreenClearer );

        /**

        * Initializes navipane according to message content

        */

        void InitNavipaneL();

        /**

        * Sub function for InitNavipaneL();

        * @param aText string in the right hand side of navipane

        */

#ifndef RD_MSG_NAVIPANE_IMPROVEMENT

        void CreateTabGroupL( const TDesC& aText );

#endif 

        /**

        * Resets the message view. This function is called

        * when moving from slide to slide.

        * @param TBool ETrue -> only body reseted

        *              EFalse -> body and header reseted

        */

        void ResetViewL();

        // Command functions

        /**

        * Implements reply commands.

        * Launches MMS Editor for replying/forwarding.

        * @param aCase either EReplyToSender or EReplyToAll

        */

        void DoReplyL( TInt aCase );

        /**

        * Implements forward command.

        * Launches MMS Editor for replying/forwarding.

        */

        void DoForwardL();

        TBool CanForwardL( TInt& aResourceId );

        TBool CanForwardObjectsL( TInt& aResourceId );

        void CanForwardObjectsInListL( 

                                        CUniObjectList* aObjectList, 

                                        TInt& aSdCount, 

                                        TInt& aFlCount, 

                                        TInt& aNonConfCount, 

                                        TInt& aNormalCount,

                                        TInt& aResourceId ) const;

        /**

        * Implements reply via SMS/Audio message command.

        * Launches SMS/Audio message/Email Editor by utilising SendUI.

        * @param aCase EMmsViewerReplyViaAudio or EMmsViewerReplyViaMail

        */

        void DoReplyViaL( TInt aCase);

        /**

        * Implements the view image command.

        * Launches PhotoAlbum's ImageViewer.

        */

        void DoViewImageL();

        /**

        * Implements the objects command.

        * Opens the Objects view where the user can access

        * individual media elements in a list format.

        */

        void DoObjectsL();

        /**

        * Implements the move command.

        * Shows a folder selection dialog

        * (CMsgFolderSelectionDialog), moves the message

        * entry into selected folder and exits the viewer.

        */

        void DoMoveMessageL();

        /**

        * Implements the "Send" key functionality.

        * Uses MsvUiServiceUtilities::CallServiceL to create a call.

        */

        void DoHandleSendKeyL();

        /**

        * Implements the message info command.

        * Opens message info dialog provided by MMS ui mtm.

        */

        void DoMessageInfoL();

        /**

        * Start SMIL presentation

        */

        void DoShowPresentationL();

        /**

        * Implements the delete command.

        * Shows a confirmation query, deletes the message

        * entry and exits the viewer.

        */

        void DoDeleteAndExitL();

        /**

        * Sets qtn_drm_preview_msg into waiting queue ( SetPendingNote() ),

        * if needed.

        */ 

        void ResolveDrmWaitingNotes();

        //Audio related functions:

        //

        /**

        * Cancels the automatic play of an audio (or a video)

        * file.

        */

        void CancelAutoplay();

        /**

        * State of an control on the UI has changed

        * @param aControl control

        * @param aState new state

        * @param aState previous state

        */

        void MsgAsyncControlStateChanged(   

                                    CMsgBaseControl& aControl,

                                    TMsgAsyncControlState aNewState,

                                    TMsgAsyncControlState aOldState );

        void DoMsgMediaControlStateChangedL(   

                                    CMsgMediaControl& aControl,

                                    TMsgAsyncControlState aNewState,

                                    TMsgAsyncControlState aOldState );

        /**

        * Asynchronous control on the UI has received resource change event.

        *

        * @param aControl control

        * @param aType event type

        */

        void MsgAsyncControlResourceChanged( CMsgBaseControl& aControl, TInt aType );

        void DoVideoStateChangeL( TInt aState );

        void DoAudioStateChangeL( TInt aState );

        /**

        * Handles the actual navipane and softkey updating according

        * to the state of audio playback. This function does not set 

        * volume control visible, it is done using ShowVolumeL( ).

        * When playing starts empties the navi pane.

        * Hides the volume control when playing stops.

        */

        void UpdatePanesL( TBool aAudioPlaying, TBool aVideoPlaying );

        /**

        * From MCenRepNotifyHandlerCallback

        */

        void HandleNotifyInt(TUint32 aId, TInt aNewValue);

        void HandleNotifyError(TUint32 aId, TInt error, CCenRepNotifyHandler* aHandler);

        void HandleNotifyGeneric(TUint32 aId);

        /**

        * From MMessageIteratorObserver. 

        * @param See documentation of MMessateIteratorObserver

        */

#ifndef RD_MSG_NAVIPANE_IMPROVEMENT

        void HandleIteratorEventL(TMessageIteratorEvent aEvent);

#endif        

        /**

        * Returns ETrue if the message is self composed and

        * EFalse otherwise (a received message).

        * @return ETrue if message is self composed,

        *         EFalse otherwise (received)

        */

        TBool IsOwnMessage() const;

        /**

        * Returns ETrue if the message has a sender, EFalse

        * otherwise (either self composed message or received

        * from a secret number).

        * @return ETrue if message has sender

        *         EFalse otherwise

        */

        TBool HasSender() const;

        /**

        * Checks whether Reply->To all should be shown.

        * For received messages checks that there is more

        * than one recipient. For sent messages checks that

        * there is at least one recipient.

        * @return ETrue if Reply->To all should be shown

        *         EFalse otherwise

        */

        TBool ShowReplyToAll() const;

        /**

        * Checks whether Reply menu should be shown at all.

        * @return ETrue if Reply menu should be shown

        *         EFalse otherwise

        */

        TBool ShowReplyMenu() const;

        // Notes:

        /**

        * Show an information note

        * @param aResourceId The resource if of the note to be shown

        */

        void ShowInformationNoteL( TInt aResourceId );

        /**

        * Show an information note

        * @param aResourceId The resource if of the note to be shown

        */

        void ShowErrorNoteL( TInt aResourceId );

        /**

        * Show a confirmation query

        * @param aResourceId The resource if of the query to be shown

        */

        TInt ShowConfirmationQueryL( TInt aResourceId ) const;

        TInt ShowConfirmationQueryL(   TInt            aResourceId,

                                        const TDesC&    aString) const;

        /**

        * Auxiliary function. Shows a confirmation query if it is not shown before. 

        *

        * @param aResourceID

        * @return the return value returned by CAknQueryDialog::ExecuteLD

        */  

        TInt ShowGuidedModeConfirmationQueryL( TInt aResourceID );

        /**

        * Shows "Out of disk" error note if disk space would

        * go below critical level when allocating aSize

        * @param aSize Bytes wanted to allocate

        * @return ETrue if below critical after allocation

        *         EFalse if allocation OK

        */

        TBool ShowOutOfDiskNoteIfBelowCriticalLevelL( TInt aSize );

        /**

        * Return a pointer to document-object

        * @return CMmsViewerDocument*

        */        

        CMmsViewerDocument* Document() const;

        /**

        * Shows any DRM related notes that are related to

        * message opening:

        * - "No rights" query

        * - "Expired rights" query

        * - "Preview rights" note

        */

        void ResolveDRMNotesL();

        /**

        * Returns the control id of the currently focused control.

        * @return Control id of the focused control or

        *         EMsgComponentIdNull if no control focused

        */

        TInt FocusedControlId();

        /**

        * Sets automatic highlighting on/off.

        * @param aEnable if ETrue sets automatic highlighting on,

        *                if EFalse sets automatic highlighting off

        */

        void SetFindModeL( TBool aEnable );

        /**

        * Starts to play/display media including image.

        * @param aControl control to be played

        */         

        void MediaPlayL(CMsgMediaControl* aControl);

        /**

        * Handle selection key for media object ( excluding 3gpp presentation )

        * This function is entered when Options menu->Play is selected.

        * Resulting action is one of the following: play, embedded play, activate or get rights.

        * @param aMedia control to be be handled

        */         

        void MediaOpenL( CMsgMediaControl* aMedia );

        /**

        * Stops playing media. Does not stop animations. 

        */         

        void MediaStop();

        /**

        * Stops playing single media.

        * @param aControl control to be played

        */         

        void MediaStop(CMsgMediaControl* aControl);

        /**

        * Closes every media control. Closing means freeing file

        * specific resources that other application can use the file.

        */         

        void MediaClose();

        /**

        * Closes single media.

        * @param aControl control to be played

        */         

        void MediaClose(CMsgMediaControl* aControl);

        /**

        * Reloads slide

        */

        void ReloadSlideL();

        /**

        * Resets every control. Frees all resources

        */         

        void MediaReset();

        /**

        * Resets single control. Frees all resources

        */         

        void MediaReset(CMsgMediaControl* aControl);

        /**

        * Checks whether media is initialised and media control can be

        * selected. 

        * This function returns ETrue, if media is DRM protected and

        * no rights exist.

        */         

        TBool MediaInitializedL( CMsgMediaControl*   aMedia );

        /**

        * Checks whether media can be played or tried to be played.

        * This function returns EFalse, if media is DRM protected and

        * no rights exist.

        */         

        TBool CMmsViewerAppUi::MediaCanPlay(const CMsgMediaControl* aMedia,

                                            const CUniObject* aMmsObject ) const;

        /**

        * Checks whether media can be stopped or tried to be played

        */         

        TBool MediaCanStop(CMsgMediaControl* aMedia);

        /**

        * Checks whether media can be paused.

        * This means also that media is really playing.

        */         

        TBool MediaIsRunning(CMsgMediaControl* aMedia);

        /**

        * Returns UI control id

        * @param aControl TMmsContolIds only

        */         

        CMsgMediaControl* MediaControlById(TInt aControl);

        /**

        * Starts animation

        */

        void StartAnimationL();

        /**

         * Stops animation

         */

        void StopAnimation();

        /**

        * Implements saving text or media object into file system from