/*

* 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:  Implementation for the default control in the

*                status pane's title pane.

*

*/

// SYSTEM INCLUDE FILES

#include <eikclbd.h>

#include <eikfutil.h>

#include <eikappui.h>

#include <eikapp.h>

#include <eikspane.h>

#include <apgcli.h>

#include <eiklabel.h>

#include <eikimage.h>

#include <gulalign.h>

#include <avkon.rsg>

#include <AknLayout.lag>

#include <AknsDrawUtils.h>

#include <AknBidiTextUtils.h>

#include <PUAcodes.hrh>

#include <AknPictographInterface.h>

#include <AknPictographDrawerInterface.h>

#include <aknlayoutscalable_avkon.cdl.h>

#include <eikenv.h>

#include <layoutmetadata.cdl.h>

#include <AknTasHook.h>

// USER INCLUDE FILES

#include "aknappui.h"

#include "AknUtils.h"

#include "avkon.hrh"

#include "AknPanic.h"

#include "akntitle.h"

#include "aknconsts.h"

#include "AknStatuspaneUtils.h"

#include "AknTitlePaneLabel.h"

#include "AknTitlePaneObserver.h"

#include "aknnavi.h"

#include "aknnavide.h"

// Titlepane flags

enum TTitlePaneControlFlags

    {

    EAknTitlePaneButton1DownInTitleRect = 0x00000001

    };

// Scrolling related constants

const TInt KScrollPauseBeforeScroll     = 1000000; // 1.0s

const TInt KScrollPauseBeforeFadeOut    = 2000000; // 2s

const TInt KScrollPauseBeforeFadeIn     = 500000;  // 0.5s

const TInt KScrollFadeInFadeOutDuration = 1000000; // 1s

const TInt KTitleMaxLines = 2;

NONSHARABLE_CLASS( CAknTitlePaneExtension )

    : public CBase,

      public MAknPictographAnimatorCallBack

    {

public:

    static CAknTitlePaneExtension* NewL( CAknTitlePane& aOwner );

    ~CAknTitlePaneExtension();

private: // From MAknPictographAnimatorCallBack

    void DrawPictographArea();

private:

    CAknTitlePaneExtension( CAknTitlePane& aOwner );

    void ConstructL();

public:

    CAknTitlePane&           iOwner;

    CEikImage*               iTitleImage;

    CAknPictographInterface* iPictoInterface;

    TInt                     iFlags;

    TBool                    iSmallImageShown;

    TBool                    iScrollEffectEnabled;

    TBool                    iScrollEffectNeeded;

    TInt                     iCurrentNumberOfTextLines;

    TInt                     iLimitedNumberOfTextLines;

    TBool                    iImageAutoscaling;

    TBool                    iSmallImageAutoscaling;

    CEikStatusPaneBase*      iStatusPane;

    };

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

// CAknTitlePaneExtension::NewL

// Two-phased constructor.

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

//

CAknTitlePaneExtension* CAknTitlePaneExtension::NewL( CAknTitlePane& aOwner )

    {

    CAknTitlePaneExtension* self =

        new( ELeave ) CAknTitlePaneExtension( aOwner );

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

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

// CAknTitlePaneExtension::~CAknTitlePaneExtension

// Destructor.

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

//

CAknTitlePaneExtension::~CAknTitlePaneExtension()

    {

    delete iTitleImage;

    delete iPictoInterface;

    }

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

// CAknTitlePaneExtension::CAknTitlePaneExtension

// C++ constructor.

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

//

CAknTitlePaneExtension::CAknTitlePaneExtension( CAknTitlePane& aOwner )

    : iOwner( aOwner )

    {

    }

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

// CAknTitlePaneExtension::ConstructL

// Second-phase constructor.

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

//

void CAknTitlePaneExtension::ConstructL()

    {

    iTitleImage = new( ELeave ) CEikImage;

    iTitleImage->SetContainerWindowL( iOwner );

    iTitleImage->SetNonFocusing();

    iTitleImage->ActivateL();

    // Returns NULL if not supported.

    iPictoInterface = CAknPictographInterface::NewL( iOwner, *this );

    iScrollEffectEnabled = EFalse;

    }

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

// CAknTitlePaneExtension::DrawPictographArea

// Draws the pictographs.

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

//

void CAknTitlePaneExtension::DrawPictographArea()

    {

    iOwner.DrawDeferred();

    }

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

// CAknTitlePane::CAknTitlePane

// Default constructor.

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

//

EXPORT_C CAknTitlePane::CAknTitlePane()

    {

    AKNTASHOOK_ADD( this, "CAknTitlePane" );

    }

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

// CAknTitlePane::~CAknTitlePane

// Destructor.

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

//

EXPORT_C CAknTitlePane::~CAknTitlePane()

    {

    AKNTASHOOK_REMOVE();

    AknsUtils::DeregisterControlPosition( this );

    delete iTitleText;

    delete iDefaultTitleText;

    delete iTitleLabel;

    delete iExtension;

    }

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

// CAknTitlePane::ConstructL

// Second-phase constructor.

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

//

EXPORT_C void CAknTitlePane::ConstructL()

    {

    CommonConstructL();

    SetTextToDefaultL();

    if ( AknLayoutUtils::PenEnabled() )

        {

        // set flags to default values

        iExtension->iFlags = 0;

        }

    }

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

// CAknTitlePane::ConstructFromResourceL

// Resource constructor.

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

//

EXPORT_C void CAknTitlePane::ConstructFromResourceL( TResourceReader& aReader )

    {

    CommonConstructL();

    ReadFromResourceFileL( aReader );

    }

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

// CAknTitlePane::SetTextL

// Sets the title pane text.

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

//

EXPORT_C void CAknTitlePane::SetTextL( const TDesC& aText )

    {

    SetText( aText.AllocL(), EFalse );

    }

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

// CAknTitlePane::SetText

// Sets the title pane text.

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

//

EXPORT_C void CAknTitlePane::SetText( HBufC* aText )

    {

    SetText( aText, EFalse );

    }

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

// CAknTitlePane::SetSmallPicture

// Sets the small title pane picture.

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

//

EXPORT_C void CAknTitlePane::SetSmallPicture( const CFbsBitmap* aBitmap,

                                              const CFbsBitmap* aMaskBitmap,

                                              TBool aVisible )

    {

    if ( iExtension->iTitleImage )

        {

        // If NULL image is given, previous (existing) image is shown.

        if ( aBitmap )

            {

            iExtension->iTitleImage->SetPictureOwnedExternally( EFalse );

            iExtension->iTitleImage->SetPicture( aBitmap, aMaskBitmap );

            if ( iExtension->iTitleImage->Bitmap() &&

                 iExtension->iTitleImage->Bitmap()->SizeInPixels() == TSize( 0, 0 ) )

                {

                // Picture is scaled by title pane if the bitmap's

                // size is not set.

                iExtension->iSmallImageAutoscaling = ETrue;

                }

            else

                {

                iExtension->iSmallImageAutoscaling = EFalse;

                }

            }

        if ( aVisible )

            {

            iExtension->iSmallImageShown = ETrue;

            iImageShown = EFalse;

            }

        else

            {

            iExtension->iSmallImageShown = EFalse;

            iImageShown = EFalse;

            }

        SizeChanged();

        DrawDeferred();

        }

    }

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

// CAknTitlePane::SetPicture

// Sets the large title pane picture (operator logo).

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

//

EXPORT_C void CAknTitlePane::SetPicture( const CFbsBitmap* aBitmap,

                                         const CFbsBitmap* aMaskBitmap )

    {

    if ( iExtension && iExtension->iTitleImage )

        {

        // If NULL image is given, previous (existing) image is shown.

        if ( aBitmap )

            {

            iExtension->iTitleImage->SetPictureOwnedExternally( EFalse );

            iExtension->iTitleImage->SetPicture( aBitmap, aMaskBitmap );

            if ( iExtension->iTitleImage->Bitmap() &&

                 iExtension->iTitleImage->Bitmap()->SizeInPixels() == TSize( 0, 0 ) )

                {

                // Picture is scaled by title pane if the bitmap's

                // size is not set.

                iExtension->iImageAutoscaling = ETrue;

                }

            else

                {

                iExtension->iImageAutoscaling = EFalse;

                }

            }

        iImageShown = ETrue;

        iExtension->iSmallImageShown = EFalse;

        SizeChanged();

        DrawDeferred();

        }

    }

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

// CAknTitlePane::SetSmallPictureFromFileL

// Sets the small title pane picture from a file.

// Used by the resource constructor.

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

//

void CAknTitlePane::SetSmallPictureFromFileL( const TDesC& aFileName,

                                              TInt aMainId,

                                              TInt aMaskId )

    {

    if ( iExtension && iExtension->iTitleImage )

        {

        CEikImage*& img = iExtension->iTitleImage;

        delete img;

        img = NULL;

        img = new (ELeave) CEikImage;

        img->CreatePictureFromFileL( aFileName, aMainId, aMaskId );

        iImageShown = EFalse;

        iExtension->iSmallImageShown = ETrue;

        iExtension->iTitleImage->SetPictureOwnedExternally( EFalse );

        if ( iExtension->iTitleImage->Bitmap() &&

             iExtension->iTitleImage->Bitmap()->SizeInPixels() == TSize( 0, 0 ) )

                {

                // Picture is scaled by title pane if the bitmap's

                // size is not set.

                iExtension->iSmallImageAutoscaling = ETrue;

                }

            else

                {

                iExtension->iSmallImageAutoscaling = EFalse;

                }

        SizeChanged();

        DrawDeferred();

        }

    }

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

// CAknTitlePane::SetPictureFromFileL

// Sets the large title pane picture (operator logo) from a file.

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

//

EXPORT_C void CAknTitlePane::SetPictureFromFileL( const TDesC& aFileName,

                                                  TInt aMainId,

                                                  TInt aMaskId )

    {

    CEikImage*& img = iExtension->iTitleImage;

    delete img;

    img = NULL;

    img = new (ELeave) CEikImage;

    img->SetContainerWindowL( *this );

    img->SetNonFocusing();

    img->ActivateL();

    img->CreatePictureFromFileL( aFileName, aMainId, aMaskId );

    iImageShown = ETrue;

    iExtension->iSmallImageShown = EFalse;

    if ( iExtension->iTitleImage &&

         iExtension->iTitleImage->Bitmap() &&

         iExtension->iTitleImage->Bitmap()->SizeInPixels() == TSize( 0, 0 ) )

        {

        iExtension->iImageAutoscaling = ETrue;

        }

    else

        {

        iExtension->iImageAutoscaling = EFalse;

        }

    SizeChanged();

    DrawDeferred();

    }

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

// CAknTitlePane::SetFromResourceL

// Sets the title pane content from a resource.

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

//

EXPORT_C void CAknTitlePane::SetFromResourceL( TResourceReader& aReader )

    {

    if ( !iTitleLabel && !iExtension ) // not constructed yet

        {

        ConstructFromResourceL( aReader );

        }

    else // update from resource

        {

        ReadFromResourceFileL(aReader);

        }

    }

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

// CAknTitlePane::SetTextToDefaultL

// Sets the title pane text to default (application name).

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

//

EXPORT_C void CAknTitlePane::SetTextToDefaultL()

    {

    iExtension->iScrollEffectEnabled = EFalse;

    if ( iDefaultTitleText )

        {

        SetTextL( *iDefaultTitleText );

        return;

        }

    TBool textSet = EFalse;

    RApaLsSession lsSession;

    TInt ret = lsSession.Connect();

    if ( ret == KErrNone )

        {

        CleanupClosePushL( lsSession );

        TApaAppInfo appInfo;

        ret = lsSession.GetAppInfo( appInfo, AppUid() );

        if ( ret == KErrNone )

            {

            iDefaultTitleText = appInfo.iCaption.AllocL();

            SetTextL( *iDefaultTitleText );

            textSet = ETrue;

            }

        CleanupStack::PopAndDestroy( &lsSession);

        }

    if ( !textSet )

        {

        SetTextL( KTitlePaneDefaultText );

        }

    }

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

// CAknTitlePane::PrepareContext

// Updates the text color for the window context from skin.

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

//

EXPORT_C void CAknTitlePane::PrepareContext( CWindowGc& aGc ) const

    {

    if ( !iImageShown )

        {

        TRgb color;

        MAknsSkinInstance* skin = AknsUtils::SkinInstance();

        TInt error = AknsUtils::GetCachedColor( skin,

                                                color,

                                                KAknsIIDQsnTextColors,

                                                EAknsCIQsnTextColorsCG1 );

        if ( !error )

            {

            aGc.SetPenColor( color );

            }

        }

    }

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

// CAknTitlePane::SizeChanged

// Handles size change events.

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

//

EXPORT_C void CAknTitlePane::SizeChanged()

    {

    // No fading if staconpane is active, because status pane

    // and control pane are combined.

    SetContainerWindowNonFading( AknStatuspaneUtils::StaconPaneActive() );

    // If fonts are destroyed with ENV destruction sequence, then abort.

    // TBD is a way to detect it right, we use this hack instead for now.

    if ( !( iEikonEnv->Alert() ) )

        {

        return;

        }

    TInt spLayout( AknStatuspaneUtils::CurrentStatusPaneLayoutResId() );

    if ( AknStatuspaneUtils::StaconPaneActive() )

        {

        SizeChangedInStaconPane();

        }

    else if ( AknStatuspaneUtils::FlatLayoutActive() )

        {