/*

* Copyright (c) 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:  Easy dialing list box data.

*

*/

// INCLUDE FILES

#include "easydialinglistboxdata.h"

#include "easydialinglistbox.h"

#include "easydialinglistboxview.h"

#include "easydialinglistboxitemdrawer.h"

#include "easydialingpanics.h"

#include "easydialingcontactdatamanager.h"

#include <easydialing.mbg>

#include <phonebook2.mbg>

#include <phonebook2ece.mbg>

// AvKON and drawing header files

#include <aknlayoutscalable_avkon.cdl.h>

#include <akniconconfig.h>

#include <gulicon.h>

#include <AknBidiTextUtils.h>

#include <bidivisual.h>

#include <aknlistloadertfx.h>

#include <aknlistboxtfxinternal.h>

#include <aknlistboxtfx.h>

#include <akntransitionutils.h>

#include <avkon.rsg>

// EXTERNAL DATA STRUCTURES

// EXTERNAL FUNCTION PROTOTYPES  

// CONSTANTS

// KHighlightSeparatorChar is character used to separate matching and non-matching

// portions of contact names. 

const TInt KHighlightSeparatorChar = 0x1F;

_LIT( KHighlightSeparatorCharAsLit, "\x1F" );

// KContactNameFontHeightPercent is contact name font height relative to list item height.

const TInt KContactNameFontHeightPercent = 35;

// KCompanyNameFontHeightPercent is company name font height relative to list item height.

const TInt KCompanyNameFontHeightPercent = 28;

// KTextBoundingBoxHeightPercent gives the text bounding box height in percents

// relative to font height. This must be over 100, or part of the text cuts off.

const TInt KTextBoundingBoxHeightPercent = 120;

// KTextPlacementPercent controls how text is placed vertically within its bounding box. 

// The value is between 0 and 100. 0 means in top part, 50 means in the middle, 100 means in the

// bottom. 

const TInt KTextPlacementPercent = 70;

// KMarginXPercent defines a width of horizontal margin used in many places. In relation to

// the width of the item rectangle.

const TInt KMarginXPercent = 2;

// KMarginYPercent defines a height of vertical margin. In relation to

// the height of the item rectangle. Currently used only with contact thumbnail.

const TInt KMarginYPercent = 4;

// KContacNameYOffsetPercent defines the vertical placement of contact name in relation to 

// item height.

const TInt KContactNameYOffsetPercent = 10;

// KCompanyNameYOffsetPercent defines the vertical placement of company name in relation to 

// item height.

const TInt KCompanyNameYOffsetPercent = 60;

// KArrowIconSizePercent defines the size of action menu icon relative to item height.

const TInt KArrowIconSizePercent = 20;

// KMatchingTextMarginInPixels the absolute pixel width of highlight margin. Highlight margin

// is an extra space in highlight boundary to make the text look less crowded.

const TInt KMatchingTextMarginInPixels = 3;

// KFavoriteIconSizePercent is size of favorite icon relative to text height.

const TInt KFavoriteIconSizePercent = 65;

// KMatchingTextMarginInPixels is the absolute pixel value for rounding used in highlight 

// rectangle.

const TInt KHighligthRectangleRoundingYInPixels = 4;

// KThumbnailAspectRatio is the aspect ratio of contact thumbnail in percents. 133 for instance

// is 4:3 aspect ration.

const TInt KThumbnailAspectRatio = 133;

const TInt KCent = 100;

const TInt KMaxRunInfoArrayCount = 20;

// IMPLEMENTATION SPECIFIC CONSTANTS

// The mif file from where you would like to show the 

// icon on the screen.

_LIT( KFavouriteIconBitmapFile, "\\resource\\apps\\phonebook2.mif" );

_LIT( KEasyDialingBitmapFile, "\\resource\\apps\\easydialing.mif" );

_LIT( KPhonebook2EceBitmapFile, "\\resource\\apps\\phonebook2ece.mif" );

// MACROS

// LOCAL CONSTANTS AND MACROS

// MODULE DATA STRUCTURES

// GLOBAL FUNCTION PROTOTYPES

TRect ContactImageBoundingBox( const TRect& aItemRect );

TRect ArrowIconBoundingBox(const TRect& aItemRect);

// LOCAL FUNCTION PROTOTYPES

static TRect ContactNameBoundingBox(

        const TRect& aItemRect, 

        const CFont* aContactNameFont, 

        TBool aArrowIconShown,

        TBool aThumbnailsShown );

static TRect CompanyNameBoundingBox(

        const TRect& aItemRect, 

        const CFont* aCompanyNameFont, 

        TBool aIsCurrentItem,

        TBool aThumbnailsShown );

static TRect FavouriteIconBoundingBox( const TRect& aContactNameBoundingBox );

static TRect MirrorLayoutBoundingBox(const TRect& aSourceRect, TRect& aBoundingBoxRect);

static TInt BaseLineOffset( const TRect& aTextBoundingBox, const CFont* aFont );

static TBool ContainsRightToLeftText( const TDesC& aDesc );

static TInt HighlightSeparatorCount( const TDesC& aText );

static HBufC* ConvertToVisualAndClipLC( const TDesC& aText, const CFont& aFont, const TRect& aBoundingBox ); 

static void ClipTextToWidth(

        TDes& aText,

        const CFont& aFont,

        TInt aMaxWidthInPixels,

        TBool& aMatch );

static TBool DrawPieceOfText(

        const TRect& aBoundingBox,

        TInt& aXOffset,

        CWindowGc &aGc, 

        const TDesC& aText,

        TBool aMatch,

        const CFont* aFont,

        const CEasyDialingListBoxData::TExtendedColors& aColors,

        TBool aHighLight);

static TInt DrawTextWithMatchHighlightL(

        const TRect& aBoundingBox,

        CWindowGc &aGc, 

        const TDesC& aText,

        const CFont* aFont,

        const CEasyDialingListBoxData::TExtendedColors& aColors,

        TBool aHighLight );

static TInt CalculateTextWidth(

        const TRect& aBoundingBox,

        const TDesC& aText,

        const CFont* aFont );

static TBool CalculateTextPieceWidth(

        const TRect& aBoundingBox,

        TInt& aXOffset,

        const TDesC& aText,

        TBool aMatch,

        const CFont* aFont );

static CGulIcon* CreateIconL(

        const TDesC& aFileName,

        TInt aBitmapId,

        TInt aMaskId );

// FORWARD DECLARATIONS

/*

 * ==============================================================================

 * 

 * 

 * class EasyDialingListBoxData::TExtendedColors

 * 

 * 

 * ==============================================================================

 */

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

// TExtendedColors

// 

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

//       

CEasyDialingListBoxData::TExtendedColors::TExtendedColors() :

CFormattedCellListBoxData::TColors(),

iMatchingText(KRgbBlack),

iMatchingBack(KRgbDarkYellow)

    {

    }

/*

 * ==============================================================================

 * 

 * 

 * class CEasyDialingListBoxData

 * 

 * 

 * ==============================================================================

 */

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

// CEasyDialingListBoxData

// 

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

//

CEasyDialingListBoxData::CEasyDialingListBoxData( CCoeEnv& aCoeEnv ) :

CFormattedCellListBoxData(), iCoeEnv( aCoeEnv )

    {

    }

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

// Destructor

// 

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

//

CEasyDialingListBoxData::~CEasyDialingListBoxData()

    {

    // Release fonts. ReleaseFont function can cope with null pointer

    // so we don't need to null check them.

    CWsScreenDevice& screenDev = *( iCoeEnv.ScreenDevice() );

    screenDev.ReleaseFont( iContactNameFont );

    screenDev.ReleaseFont( iCompanyNameFont );

    delete iArrowPointingRight;

    delete iArrowPointingLeft;

    delete iColorBitmap;

    delete iDummyThumbnail;

    delete iFavouriteIcon;

    iContactDataManager = NULL;

    }

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

// NewL

// 

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

//

CEasyDialingListBoxData* CEasyDialingListBoxData::NewL( CCoeEnv& aCoeEnv )

    {

    CEasyDialingListBoxData* self = new (ELeave) CEasyDialingListBoxData( aCoeEnv );

    CleanupStack::PushL( self );

    self->ConstructLD();

    CleanupStack::Pop( self );

    return self;

    }

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

// DrawData

// 

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

//

void CEasyDialingListBoxData::DrawData(

    const TListItemProperties& aProperties, 

    CWindowGc& aGc,

    const TDesC* aText,

    const TRect& aRect,

    TBool aHighlight,

    const TExtendedColors& aColors ) const

    {

    const TRect &aItemRect = aRect;

    if ( aHighlight )

        {

        DrawHighlight( aGc, aItemRect );

        }

    // Draw the actual items.

    DrawDataFormatted( aProperties, aGc, aText, aItemRect, 

            aHighlight, aColors );

    }

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

// ConstructLD

// 

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

//

void CEasyDialingListBoxData::ConstructLD()

    {

    CFormattedCellListBoxData::ConstructLD();

    // EasyDialing bitmap file is attempted to be read from the same directory where the

    // executed binary is located

    TFileName dllFileName;

    Dll::FileName( dllFileName );

    TParse parse;

    User::LeaveIfError(parse.Set(KEasyDialingBitmapFile, &dllFileName, NULL));

    TFileName bitmapFileName(parse.FullName());

    // Icon displayed for the selected item in normal layout

    iArrowPointingRight = CreateIconL( bitmapFileName, EMbmEasydialingQgn_indi_org_arrow_right, 

            EMbmEasydialingQgn_indi_org_arrow_right_mask );

    // Icon displayed for the selected item in mirrored layout

    iArrowPointingLeft = CreateIconL( bitmapFileName, EMbmEasydialingQgn_indi_org_arrow_left, 

            EMbmEasydialingQgn_indi_org_arrow_left_mask );

    // Only mask for the arrow icons are used. iColorBitmap is used for making the icon 

    // to follow text color changes according to skin.

    iColorBitmap = new (ELeave) CFbsBitmap;

    // Contact default thumbnail is not available in themes. It is read from phonebook resource.

    iDummyThumbnail = CreateIconL( KPhonebook2EceBitmapFile,

            EMbmPhonebook2eceQgn_prop_pb_thumb_unknown, EMbmPhonebook2eceQgn_prop_pb_thumb_unknown_mask );

    // Create the favourite icon bitmap and mask

    iFavouriteIcon = CreateIconL( KFavouriteIconBitmapFile, 

            EMbmPhonebook2Qgn_prop_pb_topc, EMbmPhonebook2Qgn_prop_pb_topc_mask );

    }

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

// DrawHighlight

// 

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

//

void CEasyDialingListBoxData::DrawHighlight( CWindowGc &aGc, const TRect &aItemRect ) const

    {

    MAknListBoxTfxInternal* transApi = CAknListLoader::TfxApiInternal( &aGc );

    if ( transApi )

        {

        transApi->Invalidate(MAknListBoxTfxInternal::EListHighlight );

        transApi->BeginRedraw( MAknListBoxTfxInternal::EListHighlight, aItemRect );

        transApi->StartDrawing( MAknListBoxTfxInternal::EListHighlight );

        aGc.SetClippingRect( iControl->Rect() );

        }

    TAknLayoutRect outerRect;

    TAknLayoutRect innerRect;

    outerRect.LayoutRect( aItemRect, TAknWindowComponentLayout::Compose(

            AknLayoutScalable_Avkon::list_highlight_pane_cp1(),

            AknLayoutScalable_Avkon::list_highlight_pane_g10_cp1() ).LayoutLine() );

    innerRect.LayoutRect( aItemRect, TAknWindowComponentLayout::Compose(

            AknLayoutScalable_Avkon::list_highlight_pane_cp1(),

            AknLayoutScalable_Avkon::list_highlight_pane_g1_cp1() ).LayoutLine() );

    MAknsControlContext *cc = AknsDrawUtils::ControlContext( Control() );

    if ( !cc ) 

        {

        cc = SkinBackgroundContext();

        }

    if ( cc )

        {

        aGc.SetPenStyle( CGraphicsContext::ENullPen );

        AknsDrawUtils::DrawFrame(

                AknsUtils::SkinInstance(), 

                aGc,

                outerRect.Rect(),

                innerRect.Rect(),

                KAknsIIDQsnFrList,

                KAknsIIDQsnFrListCenter );

        }

    if ( transApi )

        {

        aGc.CancelClippingRect();

        transApi->StopDrawing();

        transApi->EndRedraw( MAknListBoxTfxInternal::EListHighlight );

        }

    }

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

// DrawDataFormatted

// 

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

// 

// ToDo: SetSize function could be called once for all static data in SizeChanged.

// Applies at least to icons.

void CEasyDialingListBoxData::DrawDataFormatted( 

        TListItemProperties /* aProperties */,

        CWindowGc& aGc,

        const TDesC* aText,

        const TRect& aItemRect,

        TBool aHighlight,

        const TExtendedColors& aColors ) const

    {

    TPtrC cellText;

    __ASSERT_DEBUG( error == KErrNone, EasyDialingPanic( EEasyDialingPanicInvalidListBoxModelString ) );

    __ASSERT_DEBUG( iContactNameFont, EasyDialingPanic( EEasyDialingNoFontFound ) );

    __ASSERT_DEBUG( iCompanyNameFont, EasyDialingPanic( EEasyDialingNoFontFound ) );

    MAknListBoxTfxInternal* transApi = CAknListLoader::TfxApiInternal( &aGc );

    if ( transApi )

        {

        transApi->StartDrawing( MAknListBoxTfxInternal::EListItem );

        if ( transApi->EffectsDisabled() )

            {

            aGc.SetClippingRect( iControl->Rect() );

            }

        }

    TRect boundingBox = ContactImageBoundingBox( aItemRect );

    if ( AknLayoutUtils::LayoutMirrored() )

        {

        boundingBox = MirrorLayoutBoundingBox( aItemRect, boundingBox );

        }

    // Arrow icon is drawn if the item is in focus and listbox has focus

    // (and not only the temporary visual focus caused by touching a list item).

    TBool showArrowIcon = aHighlight && iControl->IsFocused();

    if ( showArrowIcon )

        {

        TRect arrowRect = ArrowIconBoundingBox( aItemRect );

        if ( AknLayoutUtils::LayoutMirrored() )

            {

            arrowRect = MirrorLayoutBoundingBox( aItemRect, arrowRect );

            }

        DrawArrowIcon( aGc, arrowRect );

        }

    boundingBox = ContactNameBoundingBox( aItemRect,

                                          iContactNameFont,

                                          showArrowIcon,

                                          iContactDataManager->GetContactThumbnailSetting() );

    if ( AknLayoutUtils::LayoutMirrored() )

        {

        boundingBox = MirrorLayoutBoundingBox( aItemRect, boundingBox );

        }

    TInt err( KErrNone );

    TRAP( err, DrawTextWithMatchHighlightL(

            boundingBox, aGc, cellText, iContactNameFont, aColors, aHighlight ) );

    if ( !err && TextUtils::ColumnText( cellText , 2, aText ) == KErrNone ) 

        {

        TRect companyNameBoundingBox = CompanyNameBoundingBox( 

                aItemRect, iCompanyNameFont, aHighlight, iContactDataManager->GetContactThumbnailSetting() );

        if ( AknLayoutUtils::LayoutMirrored() )

            {

            companyNameBoundingBox = MirrorLayoutBoundingBox( aItemRect, companyNameBoundingBox );

            }

        TRAP( err, DrawTextWithMatchHighlightL(

                companyNameBoundingBox, aGc, cellText, iCompanyNameFont, aColors, aHighlight ) );

        }

    if ( transApi )

        {

        aGc.CancelClippingRect();

        transApi->StopDrawing();

        }

    }

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

// DrawContactThumbnail

// 

// Draws the Contact Thumbnail Icon if any, else draws the dummy contact thumbnail

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

//

    {

    CFbsBitmap* thumbnail(NULL);

    if ( isLoaded && thumbnail )

        {

        // center the thumbnail in its rect

        TSize size(thumbnail->SizeInPixels());

        TInt xOffset = (aBoundingBox.Width() - size.iWidth) / 2;

        TInt yOffset = (aBoundingBox.Height() - size.iHeight) / 2;

        TPoint tl(aBoundingBox.iTl.iX + xOffset, aBoundingBox.iTl.iY + yOffset);

        TRect sourceRect( TPoint(0,0),size);

        aGc.BitBlt(tl, thumbnail, sourceRect);

        }

    else if ( isLoaded && iContactDataManager->GetContactThumbnailSetting() )

        {

        // draw dummy thumnbnail, but only if we know that the contact doesn't

        // have a thumbnail, and thumbnail drawing is enabled.

        aGc.BitBltMasked( aBoundingBox.iTl, iDummyThumbnail->Bitmap(),

                TRect( TPoint(0,0), aBoundingBox.Size() ), 

                iDummyThumbnail->Mask(), ETrue );

        }