/*

* 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:  Avkon list layouts

*

*/

/*

 * AKNLISTS.CPP

 * 

 * This file has avkon listboxes

 */

#include <aknenv.h>

#include <aknlists.h>

#include <aknjavalists.h>

#include <eiklbv.h>

#include <eikclbd.h>

#include <AknPanic.h>

#include <barsread.h>

#include <AknAppGrid.h>

#include <aknsfld.h>

#include <aknlayoutscalable_avkon.cdl.h>

#include <aknlayoutscalable_apps.cdl.h>

#include <layoutmetadata.cdl.h>

#include <skinlayout.cdl.h>

#include <AknTasHook.h>

#include "AknDebug.h"

#ifdef RD_UI_TRANSITION_EFFECTS_LIST

#include <aknlistloadertfx.h>

#include <aknlistboxtfxinternal.h>

#endif //RD_UI_TRANSITION_EFFECTS_LIST

#include <akntransitionutils.h>

#include "akntrace.h"

// non colorskinned additional icons

_LIT(KFirstIconReplacement, "0");

// for colorskinning additional icons

_LIT(KFirstCSIconReplacement, "-1");

_LIT(KFirstMovingCSIconReplacement, "-1\t%s");

#ifdef RD_LIST_STRETCH

_LIT(KEmptySpace, " ");

#endif // RD_LIST_STRETCH

//

// Drawing utilities

//

#ifdef AVKON_RDEBUG_ERROR

#define __LAYOUT_DEBUG(var, cmd) \

    if (!(var)) { cmd; }

#else

#define __LAYOUT_DEBUG(var, cmd)

#endif

enum TAknPopupLayoutPanicCodes

    {

    EAknPopupLayoutUnknownResolution

    };

void Panic(TAknPopupLayoutPanicCodes aPanic)

    {

    _LIT(KPanicCat,"AknPopupLayout");

    User::Panic(KPanicCat, aPanic);

    }

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

// If a parent to the supplied control has its Gc set, this function will find 

// it and return it.

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

//

LOCAL_C CWindowGc* ReplaceGcWithCustomGc( const CEikListBox* aListBox )

    {

    _AKNTRACE( "[%s][%d].", __FUNCTION__, __LINE__ );

    const CCoeControl* parent = aListBox;

    CWindowGc* customGc;

    while ( parent )

        {

        customGc = parent->GetGc();

        if ( customGc )

            {

            CListItemDrawer* itemDrawer = aListBox->View()->ItemDrawer();

            CWindowGc* originalGc = itemDrawer->Gc();

            if ( customGc == originalGc )

                {

                return NULL;

                }

            else

                {

                itemDrawer->SetGc( customGc );

                return originalGc;

                }

            }

        parent = parent->Parent();

        }

    return NULL;

    }

// This is used by listboxes to handle item mark correctly. Can be used to other purposes too.

 // AVKON ITEM MARKS

_LIT(KReplacementString, "%S");

EXPORT_C void AknLAFUtils::ReplaceColumn(

    TPtr aTarget, TDesC* aSource, TDesC* aReplacement, TChar aColumnSeparator, TInt aColumn)

    {

    _AKNTRACE( "[%s][%s][%d].", "AknLAFUtils", __FUNCTION__, __LINE__ );

    TBool bufferIsLargeEnough = EFalse;

    // Is the given buffer large enough to hold all column texts without truncation?

    // (+1 is for the last column separator)

    if ( aSource && aReplacement )

        {

        TInt maxSize = aSource->Length() + aReplacement->Length() + 1;

        if ( aColumn >= 0 )

            {

            maxSize += aColumn; // column separators

            }

        bufferIsLargeEnough = ( aTarget.MaxLength() >= maxSize );

        }

    TInt end=0;

    TInt column=0;

    TPtrC text;

    if (aSource)

        {

        text.Set(*aSource);

        }

    while (text.Length() || column<=aColumn) 

        {

        end = text.Locate(aColumnSeparator);

        if (end == KErrNotFound)

            {

            end = text.Length();

            }

        if (column == aColumn) 

            {

            if ( aReplacement ) 

                {

                TInt replace = aReplacement->FindF(KReplacementString);

                if (replace != KErrNotFound)

                    {

                    aTarget.Append(aReplacement->Left(replace));

                    aTarget.Append(text.Left(end));

                    aTarget.Append(aReplacement->Mid(replace+2)); // 2 == length of %s

                    }

                else

                    {

                    aTarget.Append(*aReplacement);

                    }

                if (end!=text.Length()) 

                    {

                    aTarget.Append(aColumnSeparator);

                    }

                }

            } 

        else 

            {

            if (bufferIsLargeEnough || end<KMaxColumnDataLength)

                {

                aTarget.Append(text.Left(end));

                }

            else

                {

                aTarget.Append(text.Left(KMaxColumnDataLength));

                }

            aTarget.Append(aColumnSeparator);

            }

        if (end<text.Length())

            {

            ++end;

            }

        text.Set(text.Mid(end));

        ++column;

        }

    }

 // END OF AVKON LAF

/** DEPRECATED

 *

 * Spec argument expects two things: ItemType typedef and ReadResource(TResourceReader&, ItemType&) method

 */

template<class Spec>

class CArrayReader : public CBase

    {

public:

    ~CArrayReader()

    { delete iArray; }

    void ConstructFromResourceL(TResourceReader &aResource);

    CArrayFix<typename Spec::ItemType> *iArray; // Public

    };

template<class Spec>

void CArrayReader<Spec>::ConstructFromResourceL(TResourceReader &aResource)

    {

#ifdef __WINS__

    iArray = new(ELeave) CArrayFixFlat<Spec::ItemType>(4);

#else

    iArray = new(ELeave) CArrayFixFlat<typename Spec::ItemType>(4);

#endif

    const TInt count = aResource.ReadInt16();

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

        {

        typename Spec::ItemType value;

        Spec::ReadResource(aResource, value);

        iArray->AppendL(value);

        }

    }

// Not for apps

struct SAknLayoutGfx

    {

    TInt id;    

    TInt C;

    TInt l, t, r, b, W, H;

    // the next ones are used by array resource reader template

    typedef SAknLayoutGfx ItemType;

    static void ReadResource(TResourceReader& aReader, ItemType& aTarget);    

    // Accessors for drawing code

    TInt Id() const;

    TInt Color() const;

    TRect Rect(const TRect &aParent) const;

    };

// Not for apps

struct SAknLayoutText 

    {

    TInt id; // must be first

    const CFont* font; 

    TInt C;

    TInt lm, rm, B, W;

    CGraphicsContext::TTextAlign align;

    typedef SAknLayoutText ItemType;

    static void ReadResource(TResourceReader& aReader, ItemType& aTarget);

    };

// Not for apps

struct SAknLayoutCmd

    {

    TInt id; // must be first

    TInt cmd;

    TInt data;

    typedef SAknLayoutCmd ItemType;

    static void ReadResource(TResourceReader& aReader, ItemType& aTarget);

    };

//

// Layout resource readers

//

void SAknLayoutPos::ReadResource(TResourceReader& aReader, ItemType& aTarget)

    {

    aTarget.l = aReader.ReadInt16();

    aTarget.t = aReader.ReadInt16();

    aTarget.r = aReader.ReadInt16();

    aTarget.b = aReader.ReadInt16();

    aTarget.W = aReader.ReadInt16();

    aTarget.H = aReader.ReadInt16();

    }

void SAknLayoutGfx::ReadResource(TResourceReader& aReader, ItemType& aTarget)

    {

    aTarget.id = aReader.ReadInt16();

    aTarget.C = aReader.ReadInt16();

    aTarget.l = aReader.ReadInt16();

    aTarget.t = aReader.ReadInt16();

    aTarget.r = aReader.ReadInt16();

    aTarget.b = aReader.ReadInt16();

    aTarget.W = aReader.ReadInt16();

    aTarget.H = aReader.ReadInt16();

    }

TInt SAknLayoutGfx::Id() const { return id; }

TInt SAknLayoutGfx::Color() const { return C; }

TRect SAknLayoutGfx::Rect(const TRect &aParent) const

    {

    return AknLayoutUtils::RectFromCoords(aParent,l, t, r, b, W, H);

    }

void SAknLayoutText::ReadResource(TResourceReader& aReader, ItemType& aTarget)

    {

    aTarget.id = aReader.ReadInt16();

    TInt fontid = aReader.ReadInt16();

    aTarget.font = AknLayoutUtils::FontFromId(fontid);

    aTarget.C = aReader.ReadInt16();

    aTarget.lm = aReader.ReadInt16();

    aTarget.rm = aReader.ReadInt16();

    aTarget.B = aReader.ReadInt16();

    aTarget.W = aReader.ReadInt16();

    TInt alignid = aReader.ReadInt16();

    aTarget.align = AknLayoutUtils::TextAlignFromId(alignid);

    }

void SAknLayoutCmd::ReadResource(TResourceReader& aReader, ItemType& aTarget)

    {

    aTarget.id = aReader.ReadInt16();

    aTarget.cmd = aReader.ReadInt16();

    aTarget.data = aReader.ReadInt16();

    }

//

// Resource reader for columnlistbox layouts

//

EXPORT_C void CAknGenericReader::ConstructL(TInt aResourceId)

    {

    TResourceReader reader;

    CEikonEnv::Static()->CreateResourceReaderLC(reader, aResourceId);

    ConstructFromResourceL(reader);

    CleanupStack::PopAndDestroy(); // reader

    }

EXPORT_C void CAknGenericReader::ConstructFromResourceL(TResourceReader &reader)

    {

    iGfx = new(ELeave) CArrayReader<SAknLayoutGfx>;

    iGfx->ConstructFromResourceL(reader);

    iText = new(ELeave) CArrayReader<SAknLayoutText>;

    iText->ConstructFromResourceL(reader);

    iCmd = new(ELeave) CArrayReader<SAknLayoutCmd>;

    iCmd->ConstructFromResourceL(reader);

    iArea = new(ELeave) CArrayReader<SAknLayoutGfx>;

    iArea->ConstructFromResourceL(reader);

    }

EXPORT_C CAknGenericReader::~CAknGenericReader()

    {

    delete iGfx;

    delete iText;

    delete iCmd;

    delete iArea;

    }

EXPORT_C const SAknLayoutGfx* CAknGenericReader::GfxItem(TInt aIndex) const

    {

    TInt index=KErrNotFound;

    TKeyArrayFix key(0,ECmpTInt);

    SAknLayoutGfx gfx;

    gfx.id = aIndex;

    TInt zeroiffound = iGfx->iArray->Find(gfx, key, index);

    if (zeroiffound!=0) return 0;

    return &iGfx->iArray->At(index);

    }

EXPORT_C const SAknLayoutText* CAknGenericReader::TextItem(TInt aIndex) const

    {

    TInt index=KErrNotFound;

    TKeyArrayFix key(0,ECmpTInt);

    SAknLayoutText text;

    text.id = aIndex;

    TInt zeroiffound = iText->iArray->Find(text, key, index);

    if (zeroiffound!=0) return 0;

    return &iText->iArray->At(index);

    }

EXPORT_C const SAknLayoutCmd* CAknGenericReader::CmdItem(TInt aIndex) const

    {       

    TInt index=KErrNotFound;

    TKeyArrayFix key(0,ECmpTInt);

    SAknLayoutCmd cmd;

    cmd.id = aIndex;

    TBool zeroiffound = iCmd->iArray->Find(cmd, key, index);

    if (zeroiffound!=0) return 0;

    return &iCmd->iArray->At(index);

    }

EXPORT_C const SAknLayoutGfx* CAknGenericReader::AreaItem(TInt aIndex) const

    {

    TInt index=KErrNotFound;

    TKeyArrayFix key(0,ECmpTInt);

    SAknLayoutGfx area;

    area.id = aIndex;

    TBool zeroiffound = iArea->iArray->Find(area, key, index);

    if (zeroiffound!=0) return 0;

    return &iArea->iArray->At(index);

    }

//

// Implementation of this module is completely Avkon LAF Code!

//

TBool IsEmptyVal(TInt aValue)

    {

    return aValue == ELayoutEmpty || aValue == -1;

    }

#define ITEM_EXISTS(x) (((x) > -1) && ((x) < aListBox->Model()->NumberOfItems()))

static void HandleItemRemovalBodyL(CEikListBox *aListBox, TInt currentitem, TInt topitem)

    {

    TInt lastitem = aListBox->Model()->NumberOfItems()-1;

    if (lastitem < topitem) topitem = lastitem;

    TInt numItems = aListBox->View()->NumberOfItemsThatFitInRect(aListBox->View()->ViewRect());

    if (!ITEM_EXISTS(topitem + numItems -1)) topitem = lastitem - numItems +1;

    if (topitem < 0) topitem = 0;

    if (topitem!=-1) aListBox->SetTopItemIndex(topitem);

    if (currentitem != -1 && lastitem != -1) aListBox->SetCurrentItemIndexAndDraw(currentitem > lastitem ? lastitem : currentitem);

    if (topitem==-1 || lastitem == -1) aListBox->DrawDeferred();

    }

EXPORT_C void AknListBoxUtils::HandleItemRemovalAndPositionHighlightL(CEikListBox *aListBox, TInt aCurrentItemIndex , TBool /* aCurrentRemoved */)

    {

    _AKNTRACE( "[%s][%s][%d].", "AknListBoxUtils", __FUNCTION__, __LINE__ );

    // Handle the actual positioning of the list and highlight

    TInt currentitem = aCurrentItemIndex;

    TInt topitem = aListBox->TopItemIndex();

    aListBox->HandleItemRemovalL();

    HandleItemRemovalBodyL(aListBox, currentitem, topitem);

    }

EXPORT_C void AknListBoxUtils::HandleItemRemovalAndPositionHighlightL(CEikListBox *aListBox, TInt aCurrentItemIndex, CArrayFix<TInt> &aIndexes)

    {

    _AKNTRACE( "[%s][%s][%d].", "AknListBoxUtils", __FUNCTION__, __LINE__ );

    TInt currentitem = aCurrentItemIndex;

    TInt topitem = aListBox->TopItemIndex();

    aListBox->HandleItemRemovalL(aIndexes);

    HandleItemRemovalBodyL(aListBox, currentitem, topitem);

    }

EXPORT_C void AknListBoxLayouts::SetupStandardListBox(CEikListBox& aListBox)

    {

    aListBox.SetBorder(TGulBorder::ENone);

    }

// Added for Selection Grid

EXPORT_C void AknListBoxLayouts::SetupStandardGrid(CAknGrid& aGrid)

    {

    _AKNTRACE( "[%s][%s][%d].", "AknListBoxLayouts", __FUNCTION__, __LINE__ );

    aGrid.SetBorder(TGulBorder::ENone);

    // This method is used by e.g. GMS grid and color selection grid. Text color

    // taken from color selection grid.

    TInt textColor = AKN_LAYOUT_TEXT_Cell_pane_texts__pop_up_large_graphic_colour_none__Line_1.iC;

    aGrid.ItemDrawer()->SetTextColor(AKN_LAF_COLOR_STATIC(textColor));

    aGrid.ItemDrawer()->SetBackColor(AKN_LAF_COLOR_STATIC(0));

    MAknsSkinInstance* skin = AknsUtils::SkinInstance();

    TRgb color;

    /*

    * do not set highlight color here, since grid type is

    * unknown here and every grid which wants to set

    * it's highlightcolor  will do that in it's

    * SizeChanged() method

    *

    * so try to get an extended skin color and if that fails

    * use old code

    */

    TInt error = AknsUtils::GetCachedColor( skin,

                                            color,

                                            KAknsIIDQsnTextColors,

                                            EAknsCIQsnTextColorsCG10 );

    if (error)

        {

        color = AKN_LAF_COLOR( textColor );

        aGrid.ItemDrawer()->SetHighlightedTextColor(color);

        }

    aGrid.ItemDrawer()->SetHighlightedBackColor(AKN_LAF_COLOR_STATIC(0));

    aGrid.ItemDrawer()->FormattedCellData()->SetSkinParentPos(aGrid.ItemDrawer()->FormattedCellData()->Control()->PositionRelativeToScreen());

    AknsUtils::RegisterControlPosition(aGrid.ItemDrawer()->FormattedCellData()->Control());

    }

void AknListBoxLayouts::SetupGridPos(CAknGrid& aGrid,

                                     const TAknWindowLineLayout &aLayout)

    {

    SetupGridPos(aGrid,aLayout.il, aLayout.it, aLayout.ir, aLayout.ib, aLayout.iW, aLayout.iH);

    }

EXPORT_C void AknListBoxLayouts::SetupGridPos(CAknGrid& aGrid,

                TInt l, TInt t, TInt r, TInt b, TInt W, TInt H) 

    {

    _AKNTRACE( "[%s][%s][%d].", "AknListBoxLayouts", __FUNCTION__, __LINE__ );

    TSize sz( aGrid.Rect().Size() );

    TInt gridHeight = aGrid.Rect().Height();

    if (IsParentRelative(W)) { W = sz.iWidth - ELayoutP + W; }

    if (IsParentRelative(H)) { H = sz.iHeight - ELayoutP + H; }

    if (IsParentRelative(l)) { l = sz.iWidth - ELayoutP + l; }

    if (IsParentRelative(t)) { t = sz.iHeight - ELayoutP + t; }

    if (IsParentRelative(r)) { r = sz.iWidth - ELayoutP + r; }

    if (IsParentRelative(b)) { b = sz.iHeight - ELayoutP + b; }

    if (IsEmptyVal(W)) W = sz.iWidth - r - l;

    if (IsEmptyVal(H)) H = gridHeight - t - b;

    if (IsEmptyVal(l)) l = sz.iWidth - W - r;

    if (IsEmptyVal(t)) t = gridHeight - H - b;

    if (IsEmptyVal(r)) r = sz.iWidth - l - W;

    if (IsEmptyVal(b)) b = gridHeight - t - H;

    aGrid.SetColumnWidth(W);

    TRAP_IGNORE(aGrid.SetItemHeightL(H));

    aGrid.SetHorizontalMargin(l);