/*

* Copyright (c) 2009 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:  Background manager

*

*/

#ifndef CXNBACKGROUNDMANAGER_H

#define CXNBACKGROUNDMANAGER_H

// System includes

#include <coecntrl.h>

#include <AknsSrvClient.h>

#include <coeview.h>

#include <disknotifyhandler.h>

// CLASS DECLARATION

class CXnViewManager;

class CXnViewData;

class CAknsLayeredBackgroundControlContext;

class CXnOomSysHandler;

namespace hspswrapper

    {

    class CHspsWrapper;

    }

using namespace hspswrapper;

/**

*  Background manager.

*

*  @since S60 v5.0

*/

NONSHARABLE_CLASS( CXnBackgroundManager ) : public CCoeControl,

    public MAknsSkinChangeObserver, public MDiskNotifyHandlerCallback

    {

public:

   enum WppType

        {

        ENone,

        ECommon,        

        EPageSpecific 

        };

    /**

     * Two-phased constructor.

     * @param aWrapper HSPS wrapper

     * @return new instance of CXnWallpaperView.

     */

    static CXnBackgroundManager* NewL( CXnViewManager& aViewManager, CHspsWrapper& aWrapper );

    /**

     * Destructor.

     */

    ~CXnBackgroundManager();

    /**

     * Caches wallpaper image.

     * 

     * @since S60 5.0

     * @param aFileName WallpaperImage image path and filename to be cached

     * @param aViewData Page that owns the given wallpaper.

     * @return Error code.

     */            

    TInt CacheWallpaperL( const TDesC& aFileName, CXnViewData& aViewData );

    /**

     * Changes wallpaper image of the current page.

     * 

     * @since S60 5.0

     * @param aFileName WallpaperImage image path and filename

     * @return Error code.

     */

    TInt AddWallpaperL( const TDesC& aFileName );

    /**

     * Deletes wallpaper from the given page as well as from the cache.

     * 

     * @since S60 5.0

     * @param aViewData Page where the wallpaper is to be destroyed.

     */            

    void DeleteWallpaper( CXnViewData& aViewData );

    /**

     * Returns wallpaper type.

     *  

     * @since S60 5.0

     */

    CXnBackgroundManager::WppType WallpaperType();

    /**

     * Shows wallpaper change dialog

     * 

     * @since S60 5.0

     */

    void SetWallpaperL();

    /**

     * Handles wallpaper changing in page change

     * 

     * @since S60 5.0

     * @param aOldView         Old view

     * @param aNewView         New view 

     */

    void WallpaperChanged( const CXnViewData& aOldView, 

        const CXnViewData& aNewView );

    /**

     * Draws wallpaper immediately, or once the window comes visible.

     * 

     * @since S60 5.0

     */

    void UpdateScreen();

public: // Functions from base classes    

    /**

     * @see CCoeControl

     */    

    void MakeVisible( TBool aVisible );

private: // Functions from base classes    

    /**

     * see CCoeControl 

     */

    void Draw(const TRect& aRect) const;  

    /**

     * see CCoeControl 

     */

    void SizeChanged();

    /**

     * see MAknsSkinChangeObserver 

     */

    void SkinContentChanged();

    /**

     * see MAknsSkinChangeObserver 

     */

    void SkinConfigurationChanged(

        const TAknsSkinStatusConfigurationChangeReason aReason );

    /**

     * see MAknsSkinChangeObserver 

     */

    void SkinPackageChanged(

        const TAknsSkinStatusPackageChangeReason aReason );

    /**

    * From MDiskNotifyHandlerCallback.

    */

    void HandleNotifyDisk( TInt aError, const TDiskEvent& aEvent );   

private:

    /**

     * C++ default constructor.

     */

    CXnBackgroundManager( CXnViewManager& aViewManager, CHspsWrapper& aWrapper );

    /**

     * By default Symbian 2nd phase constructor is private.

     */

    void ConstructL();

    void SaveWallpaperL();

    TInt SetSettingPropertyL( const TDesC8& aPluginId, const TDesC8& aItemId,

        const TDesC8& aPropertyName, const TDesC8& aPropertyValue );

    void UpdateWallpapersL();

    void CleanCache();

    void RemoveWallpaperL( CXnViewData& aViewData );

    void RemoveWallpaperFromCache( const TDesC& aFileName, CXnViewData* aViewData = NULL );

    void RemovableDiskInsertedL();

    void CheckFeatureTypeL();

    TInt AddPageSpecificWallpaperL( const TDesC& aFileName );

    TInt AddCommonWallpaperL( const TDesC& aFileName, TBool aSave = ETrue );

    void ReadWallpaperFromCenrepL();    

    void DrawEditModeBackgroundSkin() const;

    CXnOomSysHandler& OomSysHandler() const;

    void DrawStatusPaneMask() const;    

    /**

     * Callback function to be used with CPeriodic.

     */

    static TInt TimerCallback( TAny *aPtr );

private: // data

    /**

     * Provides needed services

     */

    CXnViewManager& iViewManager;

    /** 

     * Hsps wrapper 

     */

    CHspsWrapper& iHspsWrapper;

    /** 

     * skin server to detect when wallpaper has changed 

     * Own.

     */

    RAknsSrvSession iSkinSrv;

    /**

     * File server session.

     * Own.

     */

    RFs iFsSession;

    /**

     * Notifier for disk drive status changes.

     * Own.

     */

    CDiskNotifyHandler* iDiskNotifier;

    /** 

     * Background control context. 

     * Own. 

     */    

    CAknsLayeredBackgroundControlContext* iBgContext;

    /** 

     * Current view rect, which is basically the whole screen.

     */        

    TRect iRect;

    /** 

     * Stores wallpaper type. 

     */

    CXnBackgroundManager::WppType iType;

    /** 

     * Internal wallpaper update in progress

     */

    TInt iIntUpdate;

    /** 

     * True if screen needs to be drawn when view becomes visible.

     */

    TBool iScreenUpdateNeeded;

    /** 

     * Pointer to wallpaper image. This is used only if same wallpaper 

     * is shared among all HS pages.

     * Own. 

     */   

    CFbsBitmap* iBgImage;

    /** 

     * Path of the wallpaper image, including filename. 

     * This is used only if same wallpaper 

     * is shared among all HS pages.

     * Own. 

     */  

    HBufC* iBgImagePath;

    /**

     * Periodic timer.

     * Own.

     */

    CPeriodic* iTimer;

    /**

     * OOM system handler. 

     * Own.

     */

    CXnOomSysHandler* iOomSysHandler;

    };

#endif      // CXNBACKGROUNDMANAGER_H

// End of File