/*

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

* Base class for Setting Item Editing

*

*/

#include "aknsettingpage.h"

#include <akninputblock.h>

//For TResourceReader

#include <barsread.h>

//For the CEikLabels

#include <eiklabel.h>

// For the hint text support in the navi pane

#include <aknnavide.h>

#include <aknappui.h>

#include <eikmop.h>

// Skins support

#include <aknconsts.h>

#include <avkon.mbg>

#include <AknsDrawUtils.h>

#include <AknsFrameBackgroundControlContext.h>

#include <AknTasHook.h>

// Skin layout macros

#include <aknlayoutscalable_avkon.cdl.h>

#include <layoutmetadata.cdl.h>

//For MCoeCaptionRetrieverForFep

#include <fepbase.h>

#include <AknPopupFader.h>

#include "aknitemactionmenuregister.h"

#include "aknqueryeditorindicator.h"

// This determines the maximum number of digits in the optional number displayed on the

// top left of the setting page

const TInt KAknSettingPageMaxOrdinalDigits = 3;

// For formatting numbers; maximum is taken care of by an assert in the source

_LIT( KAknSettingPageNumberFormat, "%d" );

/**

 * Local Panic Function and Panic Codes 

 */

enum TAknSettingPagePanicCodes

	{

	EAknPanicSettingPageGeneralPanic,

	EAknPanicSettingPageNoMenuBar,

	EAknPanicSettingPageNoMenuBarResource,

	EAknPanicSettingPageDeprecated,

	EAknPanicSettingPageIllegalSettingNumber, 

	EAknPanicSettingPageIllegalLayout

	};

GLDEF_C void Panic(TAknSettingPagePanicCodes aPanic)

	{

	_LIT(KPanicCat,"AknSettingPage");

	User::Panic(KPanicCat, aPanic);

	}

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

// Calculates and returns control rectangle i.e. whole popup rect common to 

// all setting pages.

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

//

static TRect ControlRect( TBool aEmbeddedSoftkeys )

    {

    TRect container;

    if ( aEmbeddedSoftkeys )

        {

        AknLayoutUtils::LayoutMetricsRect( AknLayoutUtils::EApplicationWindow,

                container );

        TAknLayoutRect layoutRect;

        layoutRect.LayoutRect( container, 

                AknLayoutScalable_Avkon::popup_settings_window( 0 ) );

        TRect finalRect( AknPopupUtils::Position( layoutRect.Rect().Size(), 

                ETrue ), layoutRect.Rect().Size() );

        return finalRect;

        }

    AknLayoutUtils::LayoutMetricsRect(AknLayoutUtils::EMainPane, container);

    return container;

    }

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

// Calculates and returns container rectangle common to all setting pages.

// This container holds all setting view items excluding caption and softkeys.

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

//

static TRect ContainerRect( TBool aEmbeddedSoftkeys )

    {

    TAknLayoutRect layoutRect;

    layoutRect.LayoutRect( TRect( ControlRect( aEmbeddedSoftkeys ) ).Size(), 

            AknLayoutScalable_Avkon::settings_container_pane( 0 ) );

    return layoutRect.Rect();

    }

NONSHARABLE_CLASS(CAknSettingPageExtension): public CBase, public MCoeCaptionRetrieverForFep

    , public MCoeControlBackground, public MAknFadedComponent

    {

    public:

        static CAknSettingPageExtension* NewL( CAknSettingPage* parent );

	    ~CAknSettingPageExtension();

	    /**

	     * Sets the skin item ID for the frame graphics that is drawn

	     * around the setting item.

	     *

	     * @param  aFrameIID        Skin item ID of the frame graphics.

	     * @param  aFrameCenterIID  Skin item ID of the center piece of the frame

	     *                          graphics.

	     */

	    void SetEditedItemFrameIID( const TAknsItemID& aFrameIID,

	                                const TAknsItemID& aFrameCenterIID );

	    /**

	     * Sets the outer and inner rectangle for the frame graphics that is drawn

	     * around the setting item.

	     *

	     * @param  aOuterRect  Frame outer rectangle.

	     * @param  aInnerRect  Frame inner rectangle.

	     */

	    void SetEditedItemFrameRects( const TRect& aOuterRect,

	                                  const TRect& aInnerRect );

	    /**

	     * Creates if necessary and returns the editor indicator

	     * container control.

	     * 

	     * @return Editor indicator container control.

	     */

	    CAknQueryEditIndicator* EditorIndicatorContainer();

        /**

         * Creates background skin context.

         */

        void CreateBackgroundContextL();

    public: // From base class MCoeControlBackground

	    /**

	     * Draws the background for the setting page and

		 * the editor control (aControl).

	     *

	     * @param  aGc       Graphics context used for drawing.

	     * @param  aControl  The control being drawn.

	     * @param  aRect     The area to be redrawn.

	     */

	    void Draw( CWindowGc& aGc,

	               const CCoeControl& aControl,

	               const TRect& aRect ) const;

    public: // From base class MAknFadedComponent

        /**

         * Returns the number of faded components.

         * 

         * @return Number of faded components.

         */

        TInt CountFadedComponents();

        /**

         * Returns faded component.

         * 

         * @param   aIndex Component index.

         * @return  Faded component.

         */

        CCoeControl* FadedComponent( TInt aIndex );

    private:

        CAknSettingPageExtension();

	    void ConstructL( CAknSettingPage* aParent );

       /**

       * from MCoeCaptionRetrieverForFep

       * fill aCaption with the target control's caption 

       */

  	   IMPORT_C virtual void GetCaptionForFep(TDes& aCaption) const;

    public: // data

        TBool iDrawBackground;   // Determines if background should be drawn (transparency)

        TBool iIsStopActiveSchedulerCalled; // Determins if the CAknSettingPage::StopActiveScheduler function called 

        CEikScrollBarFrame* iSBFrame;

        /**

         * Control context for the setting page background graphics.

         * Not own.

         */

        CAknsBasicBackgroundControlContext* iSettingPageBgContext;

        /**

         * Control context for the setting page bitmap background graphics.

         * Own.

         */

        CAknsBasicBackgroundControlContext* iBasicBgContext;

        /**

         * Control context for the setting page frame background graphics.

         * Own.

         */

        CAknsFrameBackgroundControlContext* iFrameBgContext;

        CEikLabel* iShadowText;

        CFbsBitmap* iLockIcon;

        CFbsBitmap* iLockIconMask;

        TRect iLockIconRect;

        CAknSettingPage* iParent;

        /**

	     * Control context for providing the skinning for the hosted editor

	     * and it's surrounding area.

	     * Own.

	     */

	    CAknsFrameBackgroundControlContext* iEditedItemControlContext;

	    /**

	     * Popup fader.

	     */

        TAknPopupFader iFader;

        /**

         * Editing state indicator container for the editor setting pages.

         * Own.

         */

        CAknQueryEditIndicator* iEditIndicator;

        /**

         * Whether softkeys are embedded or not.

         */

        TBool iEmbeddedSoftkeys;

    };

void CAknSettingPage::GetCaptionForFep(TDes& aCaption) const

    {

    if (iSettingText==NULL)

        {

        aCaption=KNullDesC;

        }

    else

        {

        const TInt maximumLength=aCaption.MaxLength();

        if (iSettingText->Length()>maximumLength)

            {

            aCaption=iSettingText->Left(maximumLength);

            }

        else

            {

            aCaption=*iSettingText;

            }

        }    

    }

CAknSettingPageExtension* CAknSettingPageExtension::NewL(CAknSettingPage* aParent )

    {

    CAknSettingPageExtension* self = new (ELeave) CAknSettingPageExtension;

    CleanupStack::PushL(self);

    self->ConstructL( aParent );

	CleanupStack::Pop(self);

	return self;

    }

CAknSettingPageExtension::~CAknSettingPageExtension()

    {

    delete iSBFrame;

    delete iSettingPageBgContext;

    delete iShadowText;

    delete iLockIcon;

    delete iLockIconMask;

    delete iEditedItemControlContext;

    delete iEditIndicator;

    }

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

// Sets the skin item IDs for the frame graphics drawn around the setting item.

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

//

void CAknSettingPageExtension::SetEditedItemFrameIID(

        const TAknsItemID& aFrameIID,

        const TAknsItemID& aFrameCenterIID )

    {

    iEditedItemControlContext->SetFrame( aFrameIID );

    iEditedItemControlContext->SetCenter( aFrameCenterIID );

    }

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

// Sets the frame rectangles of the setting item frame.

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

//

void CAknSettingPageExtension::SetEditedItemFrameRects(

        const TRect& aOuterRect,

        const TRect& aInnerRect )

    {

    iEditedItemControlContext->SetFrameRects( aOuterRect, aInnerRect );

    }

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

// Creates if necessary and returns the editor indicator container control.

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

//

CAknQueryEditIndicator* CAknSettingPageExtension::EditorIndicatorContainer()

    {

    if ( !iEditIndicator )

        {

        TRAPD( err, iEditIndicator = CAknQueryEditIndicator::NewL( iParent ) );

        if ( !err )

            {

            iEditIndicator->SetBackground( this );

            }

        }

    return iEditIndicator;

    }

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

// Creates background skin context.

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

//

void CAknSettingPageExtension::CreateBackgroundContextL()

    {

    TRect nullRect( 0, 0, 0, 0 );

    if ( iEmbeddedSoftkeys )

        {

        iFrameBgContext =

        CAknsFrameBackgroundControlContext::NewL( KAknsIIDQsnFrPopup,

                                                  nullRect,

                                                  nullRect,

                                                  EFalse );

        iSettingPageBgContext = iFrameBgContext;

        }

    else

        {

        iBasicBgContext = 

        CAknsBasicBackgroundControlContext::NewL( 

                KAknsIIDQsnBgAreaMainListSet, 

                nullRect,

                EFalse );

        iSettingPageBgContext = iBasicBgContext;

        }

    }

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

// Draws the background for the setting page and the setting page item.

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

//

void CAknSettingPageExtension::Draw( CWindowGc& aGc,

                                     const CCoeControl& aControl,

                                     const TRect& aRect ) const

    {

    MAknsSkinInstance* skin = AknsUtils::SkinInstance();

    if ( !iParent->IsBackgroundDrawingEnabled() )

        {

        return;

        }

    if ( &aControl == iParent )

        {

        AknsDrawUtils::Background( skin,

                                   iSettingPageBgContext,

                                   aGc,

                                   aRect );

        AknsDrawUtils::Background( skin,

                                   iEditedItemControlContext,

                                   aGc,

                                   aRect );

        }

    else if ( &aControl == iSBFrame->VerticalScrollBar() )

        {

        AknsDrawUtils::Background( skin,

                                   iSettingPageBgContext,

                                   aGc,

                                   aRect );

        }

    else if ( &aControl == iParent->EditorControl() )

        {

        aGc.SetBrushColor( TRgb( ~0 ) );

        AknsDrawUtils::Background( skin,

                                   iSettingPageBgContext,

                                   aGc,

                                   aRect );

        AknsDrawUtils::Background( skin,

                                   iEditedItemControlContext,

                                   aGc,

                                   aRect );

        }

    else if ( &aControl == iEditIndicator )

        {

        AknsDrawUtils::Background( skin,

                                   iSettingPageBgContext,

                                   aGc,

                                   aRect );

        }

    }

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

// Counts faded components.

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

//

TInt CAknSettingPageExtension::CountFadedComponents()

    {

    TInt count = 1; // this

    CCoeControl* buttonGroupControl = NULL;

    if ( iParent->Cba() )

        {

        MEikButtonGroup* buttonGroup = iParent->Cba()->ButtonGroup();

        if ( buttonGroup )

            {

            buttonGroupControl = buttonGroup->AsControl();

            if ( buttonGroupControl )

                {

                ++count;

                }

            }

        }

    return count;

    }

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

// Returns faded components.

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

//

CCoeControl* CAknSettingPageExtension::FadedComponent( TInt aIndex )

    {

    switch ( aIndex )

        {

        case 0:

            return iParent;

        case 1:

            {

            CCoeControl* cba = NULL;

            if ( iParent->Cba() )

                {

                MEikButtonGroup* buttonGroup = iParent->Cba()->ButtonGroup();

                if ( buttonGroup )

                    {

                    cba = buttonGroup->AsControl();

                    }

                }

            return cba;

            }

        default:

            return NULL;

        }

    }

CAknSettingPageExtension::CAknSettingPageExtension()

    {

    iEmbeddedSoftkeys = ETrue;

    }

void CAknSettingPageExtension::ConstructL( CAknSettingPage* aParent )

    {

    iParent = aParent;

    iDrawBackground = ETrue;

    iIsStopActiveSchedulerCalled = EFalse;

    TRect nullRect( 0, 0, 0, 0 );

    iEditedItemControlContext =

        CAknsFrameBackgroundControlContext::NewL( KAknsIIDDefault,

                                                  nullRect,

                                                  nullRect,

                                                  EFalse );

    }

/**

* GetCaptionForFep.  Overrides MCoeCaptionRetrieverForFep::GetCaptionForFep

*

*/

EXPORT_C void CAknSettingPageExtension::GetCaptionForFep(TDes& aCaption) const

    {

    iParent->GetCaptionForFep(aCaption);

    }

//////////////////////////////////////////////////////////////////////

// Construction/Destruction

//////////////////////////////////////////////////////////////////////

/**

 * Constructor