/*

* 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:  This is a concrete class for the handling of a grid.

*                The class handles a rectangular grid arrangement of items

*                held in any linear ordering i.e. cells ordered top to

*                bottom and left, left to right and down etc.

*

*/

#include <AknGrid.h>

#include <avkon.hrh>

#include <avkon.rsg>

#include <barsread.h>

#include <AknGridView.h>

#include <AknGridM.h>

#include <eiklbm.h>

#include <eiklbi.h>

#include <eiklbx.h>

#include <eikenv.h>

#include <eiklbx.pan>

#include <eikkeys.h>

#include <AknsUtils.h>

//formatted listbox

#include <eikfrlbd.h>

#include <eikfrlb.h>

#include <AknDef.h>

#include <aknlayoutscalable_avkon.cdl.h>

#include <AknsControlContext.h>

#include "layoutmetadata.cdl.h"

#include <aknphysics.h>

#ifdef RD_UI_TRANSITION_EFFECTS_LIST

    #include <aknlistloadertfx.h>

    #include <aknlistboxtfxinternal.h>

#endif //RD_UI_TRANSITION_EFFECTS_LIST

#include <touchfeedback.h>

#include "akntrace.h"

const TInt KDefaultLineHeightForHorizontalGrid = 10;

const TInt KEikListBoxPointerRepeatInterval = 100000;  // 0.1 seconds in micro seconds

const TInt KEikListBoxInvalidIndex = -1;

enum TGridOrientation

    {

    EGridOrientationHorizontal,

    EGridOrientationVertical

    };

enum TGridHorizontal

    {

    EGridHorizontalRightToLeft,

    EGridHorizontalLeftToRight,

    EGridHorizontalWritingDirection,

    EGridHorizontalAntiWritingDirection

    };

enum TGridVertical

    {

    EGridVerticalBottomToTop,

    EGridVerticalTopToBottom

    };

/**

* Local Panic Function and Panic Codes 

*/

enum TAknGridPanicCodes

    {

    EAknPanicGridGeneralPanic,

    EAknPanicGridModelAlreadyExists,

    EAknPanicGridInvalidNumberOfPrimaryItems,

    EAknPanicGridNoView

    };

enum TAknGridStateFlags

    {

    EAknGridStateButton1DownInGrid = 0x01

    };

// ================= Extension class ========================

NONSHARABLE_CLASS(CAknGridExtension) : public CBase

    {

    public:

        CAknGridExtension();

        ~CAknGridExtension();

    TInt GetScrollingSpeed( TBool aIsOverItem, TInt aItemIndex, CAknGridView& aView, 

                            const TPoint& aPoint ) const;

    public: // data 

        TInt iFlags;

        // EMMA-7A8B9F.Ugly hack. Prevent MopSupplyObject being invoked 

        // from CEikListBox::MopGetObject()

        TBool iIsFromBaseClass;

        TPoint iLastPoint;

        TBool iKineticScrolling;

        TBool iSingleClickEnabled;

    };

CAknGridExtension::CAknGridExtension() 

    : 

    iFlags(0), 

    iIsFromBaseClass( EFalse ),

    iLastPoint( 0, 0 ), 

    iKineticScrolling( CAknPhysics::FeatureEnabled() ),

    iSingleClickEnabled( iAvkonAppUi->IsSingleClickCompatible() )

    {

    }

CAknGridExtension::~CAknGridExtension()

    {

    }

TInt CAknGridExtension::GetScrollingSpeed( TBool aIsOverItem, TInt aItemIndex, 

                                           CAknGridView& aView, const TPoint& aPoint ) const

    {

    TInt itemCountInRow = aView.NumberOfColsInView();

    TInt speed = 0;

    TInt y = aPoint.iY - iLastPoint.iY;

    if ( aIsOverItem )

        {

        if ( aView.BottomItemIndex() - aItemIndex < itemCountInRow 

            &&  y> 0 )

            {

            speed = 1;

            }

        else if ( aItemIndex - aView.TopItemIndex() < itemCountInRow 

            && y < 0 )

            {

            speed = -1;

            }

        }

    else

        {

        speed = 0;

        }

    return speed;

    }

// ================= CAknGrid class ========================

GLDEF_C void Panic(TAknGridPanicCodes aPanic)

    {

    _LIT(KPanicCat,"AknGrid");

    User::Panic(KPanicCat, aPanic);

    }

EXPORT_C CAknGrid::CAknGrid()

    {

    }

EXPORT_C CAknGrid::~CAknGrid()

    {

    delete iExtension;

    }

/**

* This function must only be called before ConstructL()

*/

EXPORT_C void CAknGrid::SetModel(CAknGridM* aModel)

    {

    __ASSERT_ALWAYS(!iModel, Panic(EAknPanicGridModelAlreadyExists));

    iModel = aModel;

    }

EXPORT_C void CAknGrid::ConstructL(const CCoeControl* aParent, TInt aFlags)

    {

    _AKNTRACE_FUNC_ENTER;

    if (!iModel)

        {

        iModel = new(ELeave) CAknGridM;

        }

    GridModel()->ConstructL();

    CreateItemDrawerL();

    ItemDrawer()->FormattedCellData()->SetControl(this);

    CEikListBox::ConstructL(aParent, aFlags);

    if ( !iExtension )

        {

        iExtension = new (ELeave) CAknGridExtension;    

        }

    // the default scrolling method is follows items

    SetPrimaryScrollingType( CAknGridView::EScrollFollowsItemsAndLoops );

    SetSecondaryScrollingType( CAknGridView::EScrollFollowsItemsAndLoops );

    _AKNTRACE_FUNC_EXIT;

    }

EXPORT_C void CAknGrid::ConstructFromResourceL(TResourceReader& aReader)

    {

    _AKNTRACE_FUNC_ENTER;

    RestoreCommonListBoxPropertiesL(aReader);        

    TInt requiredCellCharWidth=aReader.ReadInt16();

    if (!iModel)

        iModel = new(ELeave) CAknGridM;

    TInt items=aReader.ReadInt32();

    if (!items)

        {

        STATIC_CAST(CAknGridM*,iModel)->ConstructL();

        }

    else

        {

        CDesCArray* desArray=iCoeEnv->ReadDesCArrayResourceL(items);

        CleanupStack::PushL(desArray);

        STATIC_CAST(CAknGridM*,iModel)->ConstructL(desArray);

        CleanupStack::Pop( desArray );

        }

    CreateItemDrawerL();

    iItemDrawer->SetDrawMark(EFalse);

    ItemDrawer()->FormattedCellData()->SetControl(this);

    STATIC_CAST(CFormattedCellListBoxItemDrawer*,iItemDrawer)->SetCellWidthInChars(requiredCellCharWidth);

    CreateViewL();

    // empty text

    HBufC* emptyGridText = aReader.ReadHBufCL();

    if (emptyGridText)

        {

        CleanupStack::PushL(emptyGridText);

        SetEmptyGridTextL(*emptyGridText);

        CleanupStack::PopAndDestroy( emptyGridText );

        }

    TInt gridStyle=aReader.ReadInt32();

    TResourceReader reader;

    if (!gridStyle)

        {

        iEikonEnv->CreateResourceReaderLC(reader,R_AVKON_GRID_STYLE_DEFAULT);

        }

    else

        {

        iEikonEnv->CreateResourceReaderLC(reader,gridStyle);

        }

    SetLayoutFromResourceL(reader);

    CleanupStack::PopAndDestroy(); // reader

    if ( !iExtension )

        {        

        iExtension = new (ELeave) CAknGridExtension;  

        }

    _AKNTRACE_FUNC_EXIT;

    }

/**

* This routine assumes that SetLayoutL has been called to set

* up the grid.

*/

EXPORT_C void CAknGrid::SizeChanged()

    {

    _AKNTRACE_FUNC_ENTER;

    TRect clientRect = iBorder.InnerRect(Rect());

    TInt currentDataIndex = 0;

    CAknGridView* gridView = GridView();

    // reset item offset

    gridView->SetItemOffsetInPixels( 0 );

    if (iCurrentIsValid) // appshell does not call HandleItemAddition!

        {                // so this is never called. See CAknAppStyleGrid::SizeChanged()

        // remember current position

        currentDataIndex = gridView->CurrentDataIndex();

        }

    TRect rect(clientRect);

    rect.SetRect(rect.iTl.iX + ListBoxMargins().iLeft, rect.iTl.iY + ListBoxMargins().iTop,

                 rect.iBr.iX - ListBoxMargins().iRight, rect.iBr.iY - ListBoxMargins().iBottom);

    iView->SetViewRect(rect);

    _AKNTRACE( "The rect of grid are ( %d, %d ) ( %d, %d )", 

    		   rect.iTl.iX, rect.iTl.iY, 

    		   rect.iBr.iX, rect.iBr.iY );

    TRAPD(err1, HandleViewRectSizeChangeL());

    if (err1)

        {

        if (iSBFrameOwned == ENotOwnedExternally)

            {

            delete iSBFrame;

            iSBFrame = 0;

            }

        }

    // check grid orientated to show current focus (item height

    // change may have moved the focus to a new page)

    if (iCurrentIsValid)

        {

        gridView->SetCurrentDataIndex(currentDataIndex);

        }

    MAknsSkinInstance* skin = AknsUtils::SkinInstance();

    TRgb color;

    TInt error = AknsUtils::GetCachedColor( skin,

                                            color,

                                            KAknsIIDQsnTextColors,

                                            EAknsCIQsnTextColorsCG11 );

    if (!error)

        {

        ItemDrawer()->SetHighlightedTextColor( color );

        }

    _AKNTRACE_FUNC_EXIT;

    }

/**

* Protected routine used by functions to check/alter the dimensions

* of the grid as data items are added or removed or the

* size of the items are altered.

* This routine assumes that SetLayoutL has been called.

* This will not leave if scrollbars have both been turned off.

*/

EXPORT_C void CAknGrid::CalcGridSizeL()

    {

    _AKNTRACE_FUNC_ENTER;

    __TEST_INVARIANT;

    CAknGridView* gridView = GridView();

    TSize gridSize = gridView->GridCellDimensions();

    TInt definedItems = GridModel()->IndexOfLastDataItem() + 1;

    if (definedItems > 0)

        {

        // item height determines iHeight

        if (iItemHeight < 1)

            {

            // item height must exist - so set to default value

            // for now

            CEikListBox::SetItemHeightL(KDefaultLineHeightForHorizontalGrid);

            }

        if(iOrientationFlags.IsSet(EGridOrientationVertical))

            {

            gridSize.iHeight = iNumOfRowsInView;

            gridSize.iWidth = definedItems / gridSize.iHeight; 

            if (definedItems % gridSize.iHeight)

                gridSize.iWidth++;

            }

        else

            {

            gridSize.iWidth = iNumOfColsInView;

            gridSize.iHeight = definedItems / gridSize.iWidth; 

            if (definedItems % gridSize.iWidth)

                gridSize.iHeight++;

            }

        }

    else

        {

        //no defined items so grid empty

        gridSize.iWidth = 1;

        gridSize.iHeight = 1;

        if (iOrientationFlags.IsSet(EGridOrientationVertical))

            gridSize.iHeight = iNumOfRowsInView;

        else

            gridSize.iWidth = iNumOfColsInView;

        }

    // set number of cells in grid

    gridView->SetGridCellDimensions(gridSize);

    _AKNTRACE_FUNC_EXIT;

    }

/**

* Creates a formatted list item drawer.

*/

EXPORT_C void CAknGrid::CreateItemDrawerL()

    {

    CFormattedCellListBoxData* data=CFormattedCellGridData::NewL();

    CleanupStack::PushL(data);

    data->SetControl( this );

    data->CreatePictographInterfaceL();

    iItemDrawer=new(ELeave) CFormattedCellListBoxItemDrawer(Model(), iEikonEnv->NormalFont(), data);

    CleanupStack::Pop( data );

    }

/**

* Gives the formatted list item drawer being used by the grid.

*/

EXPORT_C CFormattedCellListBoxItemDrawer* CAknGrid::ItemDrawer() const

    {

    return STATIC_CAST(CFormattedCellListBoxItemDrawer*,iItemDrawer);

    }

/**

* Informs the grid that the data in the model has altered.

* It is assumed that the grid has been initialised by a call to SetLayoutL

* before this function is called for the first time.

*/

EXPORT_C void CAknGrid::HandleItemAdditionL()

    {

    _AKNTRACE_FUNC_ENTER;

    __TEST_INVARIANT;

    if (GridModel()->NumberOfData() <= 0)

        return;

    TInt currentDataIndex = 0;

    CAknGridView* gridView = GridView();

    if (iCurrentIsValid)

        {

        // remember current position

        currentDataIndex = gridView->CurrentDataIndex();

        }

    CalcGridSizeL();

    CEikListBox::HandleItemAdditionL();

    // check the current marker is set to the first item in the 

    // grid if it hasn't been set yet otherwise ensure current marker still

    // on cell item before new items were added. 

    if (!iCurrentIsValid)

        SetStartPositionL(PositionAtIndex(0));

    else

        gridView->SetCurrentDataIndex(currentDataIndex);

    iCurrentIsValid = ETrue;

    // redraw everything visible since all/most will have been affected

    DrawNow();

    UpdateScrollBarsL();

    _AKNTRACE_FUNC_EXIT;

    }

/**

* Informs the  grid that the data in the model has altered.

* It is assumed that the grid has been initialised by a call to SetLayoutL

* before this function is called for the first time.

*/

EXPORT_C void CAknGrid::HandleItemRemovalL()

    {

    _AKNTRACE_FUNC_ENTER;

    __TEST_INVARIANT;

    if (!iCurrentIsValid)

        return;

    CAknGridView* gridView = GridView();

    TInt currentDataIndex = gridView->CurrentDataIndex();

    CalcGridSizeL();

    CEikListBox::HandleItemRemovalL();

    // check if need to reposition current index since may have been

    // on one of those just deleted.

    CAknGridM* gridModel = GridModel();

    if (!gridModel->IndexContainsData(currentDataIndex))

        currentDataIndex = gridModel->IndexOfLastDataItem();

    gridView->SetCurrentDataIndex(currentDataIndex);

    // redraw everything visible since all/most will have been affected

    DrawNow();

    UpdateScrollBarsL();

    _AKNTRACE_FUNC_EXIT;

    }

/**

* Sets the orientation of the grid, either vertical or horizontal, the

* ordering of the data and the size of the primary dimension of the

* grid.

* Note: The value for the parameter aNumOfItemsInPrimaryOrient must be

* greater than zero since this determines the number of items (be it rows

* or columns) in the primary orientation of the grid.

*/

EXPORT_C void CAknGrid::SetLayoutL(TBool aVerticalOrientation,

                                   TBool aLeftToRight,

                                   TBool aTopToBottom,

                                   TInt aNumOfItemsInPrimaryOrient,

                                   TInt aNumOfItemsInSecondaryOrient,

                                   TSize aSizeOfItems,

                                   TInt aWidthOfSpaceBetweenItems,

                                   TInt aHeightOfSpaceBetweenItems)

    {

    _AKNTRACE_FUNC_ENTER;

    TGridOrientation gridOrientation = EGridOrientationHorizontal;

    if (aVerticalOrientation)

        gridOrientation = EGridOrientationVertical;

    TGridHorizontal gridHorizontal = EGridHorizontalWritingDirection;

    if (aLeftToRight)

        gridHorizontal = EGridHorizontalLeftToRight;

    else

        gridHorizontal = EGridHorizontalRightToLeft;

    TGridVertical gridVertical = EGridVerticalBottomToTop;

    if (aTopToBottom)

        gridVertical = EGridVerticalTopToBottom;

    DoSetLayoutL(gridOrientation,

                 gridHorizontal,

                 gridVertical,

                 aNumOfItemsInPrimaryOrient,

                 aNumOfItemsInSecondaryOrient,

                 aSizeOfItems,