/*

* Copyright (c) 2005-2007 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 of title pane's label.

*

*/

// SYSTEM INCLUDES

#include <e32def.h>

#include <AknPictographInterface.h>

#include <AknPictographDrawerInterface.h>

#include <bidivisual.h>

#include <biditext.h>

#include <akniconconfig.h>

#include <layoutmetadata.cdl.h>

#include <AknTasHook.h> // for testability hooks

// USER INCLUDES

#include "AknTitlePaneLabel.h"

#include "AknUtils.h"

#include "AknLayoutFont.h"

#include "aknappui.h"

#include "AknBidiTextUtils.h"

#include "AknStatuspaneUtils.h"

// General effects-related constants

const TInt KScrollTimerInterval                     = 50000; // 20 events/s

const TInt KScrollTimerDelay                        = KScrollTimerInterval;

const TInt KScrollTimerDelayBeforeDirectionReversal = 3000000; // 3s

const TInt KStartValue                              = 0;

const TInt KEndValue                                = 255;

const TInt KMinInterval                             = 50000;

const TInt KScaleMagicNumber                        = 208;

// ============================ MEMBER FUNCTIONS ===============================

CAknTitlePaneLabel::CAknTitlePaneLabel()

    {

    AKNTASHOOK_ADD( this, "CAknTitlePaneLabel" );

    }

CAknTitlePaneLabel::~CAknTitlePaneLabel()

    {

    AKNTASHOOK_REMOVE();

    delete iMask;

    delete iMaskDevice;

    delete iMaskGc;

    delete iBitmap;

    delete iBitmapDevice;

    delete iBitmapGc;

    if ( iEffectTimer )

        {

        iEffectTimer->Cancel();

        delete iEffectTimer;

        ControlEnv()->RemoveForegroundObserver( *this );

        }

    delete iEffectQueue;

    delete iScrollingText;

    }

void CAknTitlePaneLabel::Draw( const TRect& aRect ) const

    {

    if ( iEffect == EEffectNone )

        {

        CEikLabel::Draw( aRect );

        }

    // Text is paused before starting to scroll,

    // drawn without truncation character.

    else if ( iEffect == EEffectPause && iPreviousEffect == EEffectNone )

        {

        // const_cast is required to call the DrawWithoutTruncation() function.

        TRAPD( err,

               const_cast<CAknTitlePaneLabel*>( this )->DrawWithoutTruncationL( aRect ) );

        if ( err != KErrNone )

            {

            CEikLabel::Draw( aRect );

            }

        }

    else

        {

        DrawWithEffect( aRect );

        }

    }

void CAknTitlePaneLabel::DrawWithoutTruncationL( const TRect& aRect )

    {

    // Copy of the truncated text in CEikLabel is made first.

    HBufC* truncatedText = HBufC::NewL( Text()->Length() );

    CleanupStack::PushL( truncatedText );

    TPtr ptr( truncatedText->Des() );

    ptr.Copy( *Text() );

    // CEikLabel's text is set to the full text and is drawn.

    SetTextL( *iScrollingText );

    CEikLabel::Draw( aRect );

    // CEikLabel's text is set back to the truncated form.

    SetTextL( ptr );

    CleanupStack::PopAndDestroy( truncatedText );

    }

void CAknTitlePaneLabel::DrawWithEffect( const TRect& aRect ) const

    {

    if ( iEffect && iBitmap && iMask && iBitmapGc && iMaskGc )

        {

        // Bitblit using mask, this creates the fade effect

        CWindowGc& gc = SystemGc();

        gc.BitBltMasked(

            iTextLayout.TextRect().iTl,

            iBitmap,

            iTextLayout.TextRect(),

            iMask,

            ETrue );

        }

    else

        {

        CEikLabel::Draw( aRect );

        }

    }

void CAknTitlePaneLabel::DrawTextWithEffect() const

    {

    switch ( iEffect )

        {

        case EEffectFadeToLeft:

        case EEffectFadeToRight:

            {

            DrawTextWithFadeEffect();

            break;

            }

        case EEffectDefaultScroll:

            {

            DrawTextWithScrollEffect();

            break;

            }

        case EEffectDefaultScrollWithFade:

        case EEffectLoopScrollWithFade:

        case EEffectScrollOnceWithFade:

        case EEffectFadeOut:

        case EEffectFadeIn:

        case EEffectToggleScrolledTextTruncation:

            {

            DrawTextWithScrollAndFadeEffect();

            break;

            }

        case EEffectPause:

        case EEffectNone:

        default:

            {

            break;

            }

        }

    if ( DrawableWindow() )

        {

        DrawDeferred();

        }

    if ( iObserver && iObserver->DrawableWindow() )

        {

        iObserver->DrawDeferred();

        }

    }

void CAknTitlePaneLabel::DrawTextWithFadeEffect() const

    {

    if ( iEffect &&

         iBitmap &&

         iMask &&

         iBitmapGc &&

         iMaskGc &&

         iTitleText &&

         iScrollingText )

        {

        InitBitmaps();

        iMaskGc->SetPenStyle( CGraphicsContext::ESolidPen );

        iMaskGc->SetBrushStyle( CGraphicsContext::ENullBrush );

        iBitmapGc->SetPenStyle( CGraphicsContext::ESolidPen );

        iBitmapGc->SetBrushStyle( CGraphicsContext::ENullBrush );

        if ( IsStrikethrough() )

            {

            iMaskGc->SetStrikethroughStyle( EStrikethroughOn );

            iBitmapGc->SetStrikethroughStyle( EStrikethroughOn );

            }

        else

            {

            iMaskGc->SetStrikethroughStyle( EStrikethroughOff );

            iBitmapGc->SetStrikethroughStyle( EStrikethroughOff );

            }

        if ( IsUnderlined() )

            {

            iMaskGc->SetUnderlineStyle( EUnderlineOn );

            iBitmapGc->SetUnderlineStyle( EUnderlineOn );

            }

        else

            {

            iMaskGc->SetUnderlineStyle( EUnderlineOff );

            iBitmapGc->SetUnderlineStyle( EUnderlineOff );

            }

        const CFont* fontUsed =

            AknLayoutUtils::FontFromId( iTextLayoutLine.FontId() );

        iBitmapGc->UseFont( fontUsed );

        // First draw with white color for masking purpose

        const CAknLayoutFont* layoutFont =

            CAknLayoutFont::AsCAknLayoutFontOrNull( fontUsed );

        TInt textPaneAscent( 0 );

        if ( layoutFont )

            {

            textPaneAscent = layoutFont->TextPaneTopToBaseline();

            }

        else

            {

            textPaneAscent = fontUsed->AscentInPixels();

            }

        CGraphicsContext::TTextAlign textAlign( CGraphicsContext::ELeft );

        if( AknLayoutUtils::LayoutMirrored() )

            {

            textAlign = CGraphicsContext::ERight;

            }

        iBitmapGc->SetPenColor( KRgbWhite );

        iBitmapGc->DrawText( *iScrollingText,

                             iTextLayout.TextRect(),

                             textPaneAscent,

                             textAlign,

                             0 );

        // Draw pictographs

        if ( iPictographInterface )

            {

            iPictographInterface->Interface()->DrawPictographsInText(

                *iBitmapGc,

                *fontUsed,

                *iScrollingText,

                iTextLayout.TextRect(),

                textPaneAscent,

                textAlign,

                0 );

            }

        // Draw text to mask

        iMaskGc->BitBltMasked(

            Rect().iTl,

            iBitmap,

            TRect( iBitmap->SizeInPixels() ),

            iBitmap,

            ETrue );

        TRgb color( KRgbBlack );

        if ( IsDimmed() )

            {

            color = iEikonEnv->ControlColor( EColorLabelDimmedText, *this );

            }

        else

            {

            color = iEikonEnv->ControlColor( EColorLabelText, *this );

            }

        iBitmapGc->SetPenColor( color );

        iBitmapGc->DrawText( *iScrollingText,

                             iTextLayout.TextRect(),

                             textPaneAscent,

                             textAlign,

                             0 );

        // Draw pictographs

        if ( iPictographInterface )

            {

            iPictographInterface->Interface()->DrawPictographsInText(

                *iBitmapGc,

                *fontUsed,

                *iScrollingText,

                iTextLayout.TextRect(),

                textPaneAscent,

                textAlign,

                0 );

            }

        iBitmapGc->DiscardFont(); // Release the font cache

        }

    }

void CAknTitlePaneLabel::DrawTextWithScrollEffect() const

    {

    if ( iEffect &&

         iBitmap &&

         iMask &&

         iBitmapGc &&

         iMaskGc &&

         iTitleText &&

         iScrollingText )

        {

        InitBitmaps();

        iMaskGc->SetPenStyle( CGraphicsContext::ESolidPen );

        iMaskGc->SetBrushStyle( CGraphicsContext::ENullBrush );

        iBitmapGc->SetPenStyle( CGraphicsContext::ESolidPen );

        iBitmapGc->SetBrushStyle( CGraphicsContext::ENullBrush );

        TRect rect( iScrollRect );

        TRgb color( KRgbBlack );

        if ( IsDimmed() )

            {

            color = iEikonEnv->ControlColor( EColorLabelDimmedText, *this );

            }

        else

            {

            color = iEikonEnv->ControlColor( EColorLabelText, *this );

            }

        const CFont* fontUsed =

            AknLayoutUtils::FontFromId( iTextLayoutLine.FontId() );

        const CAknLayoutFont* layoutFont =

            CAknLayoutFont::AsCAknLayoutFontOrNull( fontUsed );

        TInt textPaneAscent( 0 );

        if ( layoutFont )

            {

            textPaneAscent = layoutFont->TextPaneTopToBaseline();

            }

        else

            {

            textPaneAscent = fontUsed->AscentInPixels();

            }

        CGraphicsContext::TTextAlign textAlign( CGraphicsContext::ELeft );

        if ( iWesternText )

            {

            rect.iTl.iX -= iScrollPosition;

            }

        else

            {

            rect.iBr.iX += iScrollPosition;

            textAlign = CGraphicsContext::ERight;

            }

        iBitmapGc->SetPenColor( KRgbWhite );

        iBitmapGc->UseFont( fontUsed );

        TBool truncated = Text()->Locate( KEllipsis ) != KErrNotFound;

        if ( !iScrollPosition && truncated )

            {

            // Draw truncated text

            iBitmapGc->DrawText( *Text(), rect, textPaneAscent, textAlign, 0 );

            // Draw pictographs

            if ( iPictographInterface )

                {

                iPictographInterface->Interface()->DrawPictographsInText(

                    *iBitmapGc,

                    *fontUsed,

                    *Text(),

                    rect,

                    textPaneAscent,

                    textAlign,

                    0 );

                }

            }

        else if ( iScrollingText )

            {

            // Draw non-truncated text

            iBitmapGc->DrawText( *iScrollingText,

                                 rect,

                                 textPaneAscent,

                                 textAlign,

                                 0 );

            // Draw pictographs

            if ( iPictographInterface )

                {

                iPictographInterface->Interface()->DrawPictographsInText(

                    *iBitmapGc,

                    *fontUsed,

                    *iScrollingText,

                    rect,

                    textPaneAscent,

                    textAlign,

                    0 );

                }

            }

        // Draw text to mask

        iMaskGc->BitBltMasked(

            Rect().iTl,

            iBitmap,

            TRect( iBitmap->SizeInPixels() ),

            iBitmap,

            ETrue );

        iBitmapGc->SetPenColor( color );

        if ( !iScrollPosition && truncated )

            {

            // Draw truncated text

            iBitmapGc->DrawText( *Text(), rect, textPaneAscent, textAlign, 0 );

            // Draw pictographs

            if ( iPictographInterface )

                {

                iPictographInterface->Interface()->DrawPictographsInText(

                    *iBitmapGc,

                    *fontUsed,

                    *Text(),

                    rect,

                    textPaneAscent,

                    textAlign,

                    0 );

                }

            }

        else if ( iScrollingText )

            {

            // Draw non-truncated text

            iBitmapGc->DrawText( *iScrollingText,

                                 rect,

                                 textPaneAscent,

                                 textAlign,

                                 0 );

            // Draw pictographs

            if ( iPictographInterface )

                {

                iPictographInterface->Interface()->DrawPictographsInText(

                    *iBitmapGc,

                    *fontUsed,

                    *iScrollingText,

                    rect,

                    textPaneAscent,

                    textAlign,

                    0 );

                }

            }

        iBitmapGc->DiscardFont(); // Release the font cache

        }

    }

void CAknTitlePaneLabel::DrawTextWithScrollAndFadeEffect() const

    {

    DrawTextWithScrollEffect();

    }

void CAknTitlePaneLabel::SetTextEffect( TInt aEffect,

                                        TRect aEffectRect,

                                        TInt aEffectDuration,

                                        TRect aLabelRect,

                                        TAknLayoutText aTextLayout,

                                        TAknTextLineLayout aTextLayoutLine,

                                        HBufC* aTitleText,

                                        CCoeControl* aObserver)

    {

    iPreviousEffect = iEffect;

    iObserver = aObserver;

    iTextLayout = aTextLayout;

    iTextLayoutLine = aTextLayoutLine;

    if ( ( iTitleText != aTitleText && iScrollingText ) ||

         ( !iScrollingText && aEffect ) )

        {

        TRAP_IGNORE( CreateScrollingTextL( aTitleText ) );

        }

    iTitleText = aTitleText;

    iEffectDuration = aEffectDuration;

    iWesternText =

        TBidiText::TextDirectionality( *Text() ) == TBidiText::ELeftToRight;

    if ( aEffect == EEffectScrollOnceWithFade ||

         aEffect == EEffectLoopScrollWithFade ||

         aEffect == EEffectLoopScroll ||

         aEffect == EEffectDefaultScrollWithFade ||

         aEffect == EEffectDefaultScroll )

        {

        iScrollPosition = 0;

        }

    iScrollRect = iTextLayout.TextRect();

    if ( iScrollRect.iTl.iX < aEffectRect.iTl.iX )

        {

        iScrollRect.iTl.iX = aEffectRect.iTl.iX;

        }

    if ( iScrollRect.iBr.iX > aEffectRect.iBr.iX )

        {

        iScrollRect.iBr.iX = aEffectRect.iBr.iX;

        }

    const CFont* fontUsed =

        AknLayoutUtils::FontFromId( aTextLayoutLine.FontId() );

    CFont::TMeasureTextInput input;

    input.iFlags = CFont::TMeasureTextInput::EFVisualOrder;

    iTextLength = fontUsed->MeasureText( *aTitleText, &input );

    iOperatorNamePhase = 0;

    if ( !aEffect ||

         iEffect != aEffect ||

         iEffectRect != aEffectRect ||

         Rect() != aLabelRect )

        {

        iEffect = aEffect;