/*

* Copyright (c) 2002-2010 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:  EIKON Status Pane control.

*

*/

// SYSTEM INCLUDE FILES

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <uikon/eikdefmacros.h>

#endif

#include <barsread.h>

#include <eikspane.h>

#include <coeccntx.h>

#include <aknappui.h>

#include <eikenv.h>

#include <uiklaf/private/lafspane.h>

#include <AknSgcc.h>

#include <AknUtils.h>

#include <AknStatuspaneUtils.h>

#include <AknsCombinedBackgroundControlContext.h>

#include <AknsMaskedLayerBackgroundControlContext.h>

#include <eikapp.h>

#include <coecntrl.h>

#include <aknlayoutscalable_avkon.cdl.h>

#include <layoutmetadata.cdl.h>

#include <AknsDrawUtils.h>

#include "aknstatuspanedatasubscriber.h"

#ifdef RD_SCALABLE_UI_V2

#include <akntouchpane.h>

#endif // RD_SCALABLE_UI_V2

#include <pslninternalcrkeys.h>

#include <centralrepository.h>

#include <akntranseffect.h>

#include <AknTasHook.h>

/** Granularity of the sub-pane control array. */

const TInt KEikStatusPaneControlGranularity = 4;

/** Fading is no longer handled here. */

// const TInt KEikStatusPaneBaseFadedBit    = 1;

/** Flag indicating status pane visibility. */

const TInt KEikStatusPaneBaseVisibleBit     = 2;

/** Flag indicating status pane dimming state. */

const TInt KEikStatusPaneBaseDimmedBit      = 4;

/** Unique UID for status pane TLS singleton. */

const TUid KUidStatusPaneTls = { 0x10005FB5 };

/** Default timeout for status pane blanker. */

const TInt KDefaultUnblankTimeout = 100000; // 0.1 s

/** This flag is used to turn redraw storing on/off in status pane. */

const TInt KEnableRedrawStoring = ETrue;

inline void CEikStatusPaneBase::TPaneCapabilities::SetPresent()

    {

    iFlags |= KStatusPaneCapsPresentBit;

    }

inline void CEikStatusPaneBase::TPaneCapabilities::SetAppOwned()

    {

    iFlags |= KStatusPaneCapsAppOwnedBit;

    }

inline void CEikStatusPaneBase::TPaneCapabilities::SetInCurrentLayout()

    {

    iFlags |= KStatusPaneCapsInCurrentLayoutBit;

    }

#ifdef RD_FULLSCREEN_WALLPAPER

/**

* Skin background context layers used in usual status pane layouts.

*/

enum

    {

    ELayerWallpaper  = 0,

    ELayerBackground = 1,

    ELayerExtension  = 2,

    ELayerStripe     = 3,

    ELayerN          = 4

    };

/**

* Skin background layers for first context used in stacon pane layouts.

*/

enum

    {

    ELayerStaconWallpaper = 0,

    ELayerStaconTop       = 1,

    ELayerStaconBottom    = 2,

    ELayerStaconN         = 3

    };

/**

* Skin background layers for second context used in stacon pane layouts.

*/

enum

    {

    ELayerStaconWp   = 0,

    ELayerStaconSkin = 1

    };

/**

* Skin background layers for second context used in flat status pane layouts.

*/

enum

    {

    ELayerFlatCbaWp   = 0,

    ELaterFlatCbaSkin = 1

    };

/**

* Skin background layers for first context used in flat status pane layouts.

*/

enum

    {

    ELayerFlatWallpaper  = 0,

    ELayerFlatBackground = 1,

    ELayerFlatTl         = 2,

    ELayerFlatTr         = 3,

    ELayerFlatBl         = 4,

    ELayerFlatBr         = 5,

    ELayerFlatT          = 6,

    ELayerFlatB          = 7,

    ELayerFlatR          = 8,

    ELayerFlatL          = 9,

    ELayerFlatCenter     = 10,

    ELayerFlatMain       = 11,

    ELayerFlatCba        = 12,

    ELayerFlatN          = 13

    };

#else

/**

* Skin background context layers used in usual status pane layouts.

*/

enum

    {

    ELayerBackground = 0,

    ELayerExtension  = 1,

    ELayerStripe     = 2,

    ELayerWallpaper  = 3,

    ELayerN          = 4

    };

/**

* Skin background context layers used in stacon pane layouts.

*/

enum

    {

    ELayerStaconTop       = 0,

    ELayerStaconBottom    = 1,

    ELayerStaconMain      = 2,

    ELayerStaconWallpaper = 3,

    ELayerStaconN         = 4

    };

/**

* Skin background context layers used in flat status pane layouts.

*/

enum

    {

    ELayerFlatBackground = 0,

    ELayerFlatTl         = 1,

    ELayerFlatTr         = 2,

    ELayerFlatBl         = 3,

    ELayerFlatBr         = 4,

    ELayerFlatT          = 5,

    ELayerFlatB          = 6,

    ELayerFlatR          = 7,

    ELayerFlatL          = 8,

    ELayerFlatCenter     = 9,

    ELayerFlatMain       = 10,

    ELayerFlatWallpaper  = 11,

    ELayerFlatCba        = 12,

    ELayerFlatN          = 13

    };

#endif // RD_FULLSCREEN_WALLPAPER

/**

* Status pane blanker disable levels.

* As of release 3.2 status pane blanker is not used anymore.

*/

enum

    {

    EBlankDisableLevelNone   = 0, ///< Blanker is enabled.

    EBlankDisableLevelNormal = 1, ///< Blanker is disabled, but may be used in some situations.

    EBlankDisableLevelHigh   = 2  ///< Blanker is always disabled.

    };

/** Resource IDs for portrait mode status pane layouts. */

const TInt KStatusPanePortraitResIds[] =

    {

    R_AVKON_STATUS_PANE_LAYOUT_IDLE,

    R_AVKON_STATUS_PANE_LAYOUT_USUAL,

    R_AVKON_STATUS_PANE_LAYOUT_POWER_OFF_RECHARGE,

    R_AVKON_STATUS_PANE_LAYOUT_EMPTY,

    R_AVKON_STATUS_PANE_LAYOUT_SMALL,

    R_AVKON_STATUS_PANE_LAYOUT_SMALL_WITH_SIGNAL_PANE,

    R_AVKON_STATUS_PANE_LAYOUT_VT,

    R_AVKON_STATUS_PANE_LAYOUT_USUAL_MIRRORED,

    R_AVKON_STATUS_PANE_LAYOUT_IDLE_MIRRORED,

    R_AVKON_STATUS_PANE_LAYOUT_POWER_OFF_RECHARGE_MIRRORED,

    R_AVKON_STATUS_PANE_LAYOUT_SMALL_WITH_SIGNAL_PANE_MIRRORED,

    R_AVKON_STATUS_PANE_LAYOUT_VT_MIRRORED,

    R_AVKON_STATUS_PANE_LAYOUT_IDLE_FLAT,

    R_AVKON_STATUS_PANE_LAYOUT_USUAL_FLAT,

    R_AVKON_STATUS_PANE_LAYOUT_USUAL_EXT,

    R_AVKON_STATUS_PANE_LAYOUT_IDLE_EXT,

    R_AVKON_WIDESCREEN_PANE_LAYOUT_IDLE_FLAT_NO_SOFTKEYS

    };

/** Resource IDs for landscape mode status pane layouts. */

const TInt KStatusPaneLandscapeResIds[] =

    {

    R_AVKON_STATUS_PANE_LAYOUT_POWER_OFF_RECHARGE,

    R_AVKON_STATUS_PANE_LAYOUT_EMPTY,

    R_AVKON_STATUS_PANE_LAYOUT_SMALL,

    R_AVKON_STATUS_PANE_LAYOUT_SMALL_WITH_SIGNAL_PANE,

    R_AVKON_STATUS_PANE_LAYOUT_VT,

    R_AVKON_STATUS_PANE_LAYOUT_POWER_OFF_RECHARGE_MIRRORED,

    R_AVKON_STATUS_PANE_LAYOUT_SMALL_WITH_SIGNAL_PANE_MIRRORED,

    R_AVKON_STATUS_PANE_LAYOUT_VT_MIRRORED,

    R_AVKON_STACON_PANE_LAYOUT_USUAL_SOFTKEYS_RIGHT,

    R_AVKON_STACON_PANE_LAYOUT_USUAL_SOFTKEYS_LEFT,

    R_AVKON_STACON_PANE_LAYOUT_IDLE_SOFTKEYS_RIGHT,

    R_AVKON_STACON_PANE_LAYOUT_IDLE_SOFTKEYS_LEFT,

    R_AVKON_STACON_PANE_LAYOUT_EMPTY_SOFTKEYS_RIGHT,

    R_AVKON_STACON_PANE_LAYOUT_EMPTY_SOFTKEYS_LEFT,

    R_AVKON_STATUS_PANE_LAYOUT_IDLE_FLAT,

    R_AVKON_STATUS_PANE_LAYOUT_USUAL_FLAT,

    R_AVKON_WIDESCREEN_PANE_LAYOUT_USUAL,

    R_AVKON_WIDESCREEN_PANE_LAYOUT_IDLE,

    R_AVKON_WIDESCREEN_PANE_LAYOUT_USUAL_FLAT,

    R_AVKON_WIDESCREEN_PANE_LAYOUT_IDLE_FLAT,

    R_AVKON_WIDESCREEN_PANE_LAYOUT_USUAL_FLAT_NO_SOFTKEYS,

    R_AVKON_WIDESCREEN_PANE_LAYOUT_IDLE_FLAT_NO_SOFTKEYS

    };

// ======== LOCAL FUNCTIONS ========

// ---------------------------------------------------------------------------

// Checks if a specified status pane layout is supported in portrait.

// ---------------------------------------------------------------------------

//

static TBool SupportedPortraitResId( TInt aResId )

    {

    for ( TUint ii = 0;

          ii < sizeof( KStatusPanePortraitResIds ) /

               sizeof( *KStatusPanePortraitResIds );

          ii++ )

        {

        if ( KStatusPanePortraitResIds[ii] == aResId )

            {

            return ETrue;

            }

        }

	return EFalse;

	}

// ---------------------------------------------------------------------------

// Checks if a specified status pane layout is supported in landscape.

// ---------------------------------------------------------------------------

//

static TBool SupportedLandscapeResId( TInt aResId )

	{

    for ( TUint ii = 0;

          ii < sizeof( KStatusPaneLandscapeResIds ) /

               sizeof( *KStatusPaneLandscapeResIds );

          ii++ )

        {

        if ( KStatusPaneLandscapeResIds[ii] == aResId )

            {

            return ETrue;

            }

        }

	return EFalse;

	}

// ----------------------------------------------------------------------------

// Sets the container control for the specified control and updates the

// the whole parent hierarchy.

// ----------------------------------------------------------------------------

//

static void SetContainersL( CCoeControl& aControl,

                            const CCoeControl& aContainer )

    {

    aControl.SetContainerWindowL( aContainer );

    TInt count = aControl.CountComponentControls();

    for ( TInt i = 0; i < count; ++i )

        {

        CCoeControl* child = aControl.ComponentControl( i );

        SetContainersL( *child, aControl );

        }

    }

// ---------------------------------------------------------------------------

// Helper method to compose two layout lines together.

// ---------------------------------------------------------------------------

//

inline TAknWindowComponentLayout DoCompose( TAknWindowComponentLayout aLine1,

                                            TAknWindowComponentLayout aLine2 )

    {

    return TAknWindowComponentLayout::Compose( aLine1, aLine2 );

    }

/**

 * Interface for key - value pair getter.

 */

NONSHARABLE_CLASS( MKeyValue )

	{

public:

    /**

    * Return CR key ID.

    */

	virtual TUint32 Key() const = 0;

	/**

    * Return CR key value.

    */

	virtual TInt Value() const = 0;

	};

/**

 * Interface for a key change listener.

 */

NONSHARABLE_CLASS( MKeyListener )

	{

public:

    /**

    * Called when a value of a key changes.

    */

	virtual void KeyChanged( const MKeyValue& aKeyValue ) = 0;

	};

/**

 * Class for observing changes in Central Repository properties.

 */

NONSHARABLE_CLASS( CCenRepListen ) : public CActive, public MKeyValue

	{

public:

    /**

    * Two-phased constructor.

    *

    * @param  aRep       UID of the repository.

    * @param  aKey       ID  of the key inside the repository.

    * @param  aListener  Listener to be informed of changes.

    */

	static CCenRepListen* NewL( const TUid& aRep,

	                            const TUint32 aKey,

	                            MKeyListener& aListener );

    /**

    * Returns the current value of a CR key.

    *

    * @return Value of the key.

    */

	TInt Value() const;

	/**

    * Returns the ID of a CR key that is being listened to.

    *

    * @return ID of a CR key.

    */

	TUint32 Key() const;

	/**

	* Starts listening to the CR key.

	*/

	void Listen();

	/**

	* Destructor.

	*/

	~CCenRepListen();

private:

    /**

    * C++ constructor.

    *

    * @param  aKey       ID  of the key inside the repository.

    * @param  aListener  Listener to be informed of changes.

    */

	CCenRepListen( const TUint32 aKey, MKeyListener& aListener );

	/**

	* Second-phase constructor.

	*

	* @param  aRep  UID of the repository.

	*/

	void ConstructL( const TUid& aRep );

	/**

	* Cancels listening.

	*/

	void DoCancel();

	/**

	* Called when the key value is changed.

	*/

	void RunL();

private:

    /** ID of the key being listened to. */

	const TUint32   iKey;

	/** Listener to be informed of changes. */

	MKeyListener&   iListener;

	/** Current value of the key. */

	TInt            iValue;

	/** Pointer to a repository. */

	CRepository*    iRepository;

	};

// ---------------------------------------------------------------------------

// CCenRepListen::NewL

// Two-phased constructor.

// ---------------------------------------------------------------------------

//

CCenRepListen* CCenRepListen::NewL( const TUid& aRep,

                                    const TUint32 aKey,

                                    MKeyListener& aListener )

	{

	CCenRepListen* l = new (ELeave) CCenRepListen( aKey, aListener );

	CleanupStack::PushL( l );

	l->ConstructL( aRep );

    CleanupStack::Pop( l );

	return l;

	}

// ---------------------------------------------------------------------------

// CCenRepListen::Value

// Returns the current value of the key.

// ---------------------------------------------------------------------------

//

TInt CCenRepListen::Value() const

	{

	return iValue;

	}

// ---------------------------------------------------------------------------

// CCenRepListen::Value

// Returns the key being listened to.

// ---------------------------------------------------------------------------

//

TUint32 CCenRepListen::Key() const

	{

	return iKey;

	}

// ---------------------------------------------------------------------------

// CCenRepListen::Listen

// Starts listening to a value changes.

// ---------------------------------------------------------------------------

//

void CCenRepListen::Listen()

	{

	Cancel();

	SetActive();

	iRepository->NotifyRequest( iKey, iStatus );

	}

// ---------------------------------------------------------------------------

// CCenRepListen::CCenRepListen

// C++ constructor

// ---------------------------------------------------------------------------

//

CCenRepListen::CCenRepListen( const TUint32 aKey,

                              MKeyListener& aListener )

    : CActive( CActive::EPriorityStandard ),

      iKey( aKey ),

      iListener( aListener )

	{

	CActiveScheduler::Add( this );

	}

// ---------------------------------------------------------------------------

// CCenRepListen::ConstructL

// Second-phase constructor.

// ---------------------------------------------------------------------------

//

void CCenRepListen::ConstructL( const TUid& aRep )

	{

	iRepository = CRepository::NewL( aRep );

	User::LeaveIfError( iRepository->Get( iKey, iValue ) );

	}

// ---------------------------------------------------------------------------