/*

* Copyright (c) 1997-1999 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:

*

*/

#include <eiksbfrm.h>

#include <eikpanic.h>

#include <eikbtgpc.h>

#include <eikcba.h>

#include <eikenv.h>

#include <eikappui.h>

#include <aknenv.h>

#include <aknappui.h>

#include <AknLayout.lag>

#include <AknUtils.h>

#include "EIKSBEXT.H"

// const TInt KCbaScrollBarWidth=9;

//

// TEikScrollBarFrameLayout

//

EXPORT_C TEikScrollBarFrameLayout::TEikScrollBarFrameLayout()

	//

	// default constructor

	//

	{

    iInclusiveMargin.iTop = 0;

    iInclusiveMargin.iBottom = 0;

    iInclusiveMargin.iLeft = 0;

    iInclusiveMargin.iRight = 0;

    iClientMargin.iTop = 0;

    iClientMargin.iBottom = 0;

    iClientMargin.iLeft = 0;

    iClientMargin.iRight = 0;

    iClientAreaGranularity = TSize(0,0);

    iTilingMode = EClientRectConstant;

	}

EXPORT_C void TEikScrollBarFrameLayout::SetInclusiveMargin(TInt aMargin)

	//

	// sets all inclusive margins to aMargin

	//

	{

    iInclusiveMargin.iTop = aMargin;

    iInclusiveMargin.iBottom = aMargin;

    iInclusiveMargin.iLeft = aMargin;

    iInclusiveMargin.iRight = aMargin;

	}

EXPORT_C void TEikScrollBarFrameLayout::SetClientMargin(TInt aMargin)

	//

	// sets all client margins to aMargin

	//

	{

    iClientMargin.iTop = aMargin;

    iClientMargin.iBottom = aMargin;

    iClientMargin.iLeft = aMargin;

    iClientMargin.iRight = aMargin;

	}

CEikScrollBarFrameExtension::CEikScrollBarFrameExtension()

    {

    }

CEikScrollBarFrameExtension::~CEikScrollBarFrameExtension()

    {

    }

//

// CEikScrollBarFrame

//

enum TEikScrollBarFramePanic

	{

	ENoScrollBarFrame	=0x01,

	EFailedToRemoveExternalScrollBar,

	EUnexpectedExternalScrollBarDisconnectRequest

	};

GLDEF_C void SbfPanic(TEikScrollBarFramePanic aPanic)

    {

	_LIT(KPanicCategory, "UIKON - Scrollbar Frame");

    User::Panic(KPanicCategory, aPanic);

    }

// const TInt KTypeOfScrollBarMask=0x0300;

// const TInt KSideOfScrollBarMask=0x0c00;

enum // private flags

	{

	EDisplayHScrollBar			=0x01,

	EDisplayVScrollBar			=0x02,

	EDoNotAdjustHorizontalModel	=0x04,

	EDoNotAdjustVerticalModel	=0x08,

	EPreAllocScrollBars			=0x10

	};

EXPORT_C CEikScrollBarFrame::~CEikScrollBarFrame()

	{

    DeleteScrollBars();

    delete iExtension;

	}

EXPORT_C CEikScrollBarFrame::CEikScrollBarFrame(CCoeControl* aParentWindow, MEikScrollBarObserver* aObserver, TBool /*aPreAlloc*/)

	{

    InitExtension(aParentWindow,aObserver);

	GetScrollBars(EFalse);	

	}

CEikScrollBarFrame::CEikScrollBarFrame(CCoeControl* aParentWindow, MEikScrollBarObserver* aObserver, TBool /*aPreAlloc*/, TBool aDoubleSpan)

	{

    InitExtension(aParentWindow,aObserver);

	GetScrollBars(aDoubleSpan);

	}

void CEikScrollBarFrame::InitExtension(CCoeControl* aParentWindow, MEikScrollBarObserver* aObserver)

    {

    iExtension = new CEikScrollBarFrameExtension();

    if (iExtension)

        {

        iExtension->iParentWindow = aParentWindow;

        iExtension->iH.iModel = TAknDoubleSpanScrollBarModel();

        iExtension->iH.iBar = NULL;

        iExtension->iH.iExternalScrollBarAttached = EFalse;

        iExtension->iH.iVisibility = EOff; 

        if(AknLayoutUtils::PenEnabled())

            {

            iExtension->iScrollBarObserver = aObserver;

            }

        }

    }

void CEikScrollBarFrame::DisconnectExternalScrollBar(CEikScrollBar* aScrollBar)

	{

	if (iV.iExternalScrollBarAttached && iV.iBar == aScrollBar)

        {

        iV.iExternalScrollBarAttached = EFalse;

	    iV.iBar = NULL;

        }

    if (iExtension && iExtension->iH.iExternalScrollBarAttached && iExtension->iH.iBar == aScrollBar) 

        {

    	iExtension->iH.iExternalScrollBarAttached = EFalse;

	    iExtension->iH.iBar = NULL;

        }

    }

void CEikScrollBarFrame::GetScrollBars(TBool aDoubleSpan)

	{

	if (!iV.iBar)

		{

		CEikCba* cba=GetCurrentCba();

		if (cba)

			{

			// If aDoubleSpan is true, we will optimize and do not create arrow heads at all.

			// There will come CreateDoubleSpanScrollBarsL call, and arrow heads are not needed.

			if ( !(aDoubleSpan && (AknLayoutUtils::DefaultScrollBarType(iAvkonAppUi) == CEikScrollBarFrame::EDoubleSpan)) )

			    {

			    TRAP_IGNORE(cba->CreateArrowHeadScrollBarL());  

			    }

			// returns the vertical scroll bar from the top scroll bar host

			iV.iBar=cba->VScrollBarAsControl();

			iV.iExternalScrollBarAttached=ETrue;

			TRAPD(err, iV.iBar->AddExternalFrameL(this));

			if (err)

				{

				iV.iExternalScrollBarAttached = EFalse;

				iV.iBar = NULL;

				}

			}

		}

	}

EXPORT_C void CEikScrollBarFrame::DrawScrollBarsNow() const

// Force a redraw of any scrollbars

	{	

	if (iV.iBar && iExtension && iExtension->iParentWindow->IsVisible())

		iV.iBar->DrawNow();

	if (iExtension && iExtension->iH.iBar && iExtension->iParentWindow->IsVisible())

		iExtension->iH.iBar->DrawNow();

	}

void CEikScrollBarFrame::DrawScrollBarsDeferred() const

    {

    if (iV.iBar && iExtension && iExtension->iParentWindow->IsVisible())

	    {	   

	    iV.iBar->DrawDeferred();	    

	    }		

	if (iExtension && iExtension->iH.iBar && iExtension->iParentWindow->IsVisible())

	    {

	    iExtension->iH.iBar->DrawDeferred();	    

	    }    

    }

const TInt KLongEnoughToCauseComponentsToBeCreated=200;

EXPORT_C void CEikScrollBarFrame::SetScrollBarVisibilityL(TScrollBarVisibility aHVisibility, TScrollBarVisibility aVVisibility)

// Set the visibility state for both scrollbars to be used when tiling

	{

	__ASSERT_DEBUG(this, SbfPanic(ENoScrollBarFrame));

    // Vertical scrollbar

	iV.iVisibility=aVVisibility;

    if (iV.iBar && TypeOfVScrollBar() == EDoubleSpan && aVVisibility==EOff)

        {

       	iScrollBarFrameFlags&=(~EDisplayVScrollBar);

        MakeSBarVisible(iV, EFalse);

        }

    // Horizontal scrollbar

    if (iExtension)

        {

    	iExtension->iH.iVisibility=aHVisibility;

        if (iExtension->iH.iBar && TypeOfHScrollBar() == EDoubleSpan && aHVisibility==EOff)

            {

       	    iScrollBarFrameFlags&=(~EDisplayHScrollBar);

            MakeSBarVisible(iExtension->iH, EFalse);

            }

        }

	}

EXPORT_C TBool CEikScrollBarFrame::Tile(TEikScrollBarModel* aVModel)

	//

	// The main function which provides the necessary scrollbars according to visibilities and size considerations

	// returns ETrue if the "output rect" was changed

	//

	{

	GetScrollBars(EFalse);

	CalcTheoreticalScrollBarVisibility(aVModel);

	if (iV.iVisibility!=EOff)

		iV.iModel = *aVModel;

	MakeSBarVisible(iV, iScrollBarFrameFlags&EDisplayVScrollBar);

	return EFalse;

	}

EXPORT_C TBool CEikScrollBarFrame::TileL(TEikScrollBarModel* aHModel, TEikScrollBarModel* aVModel,

			  TRect& aClientRect, TRect& aInclusiveRect, const TEikScrollBarFrameLayout& aLayout)

	{

	TRect tempRect(aClientRect);

	if(aClientRect.Height() < 0 )

	    {

	    aClientRect.iTl.iY = aClientRect.iBr.iY;

	    aClientRect.iBr.iY = tempRect.iTl.iY;

	    }

	if(aClientRect.Width() < 0 )

        {

        aClientRect.iTl.iX = aClientRect.iBr.iX;

        aClientRect.iBr.iX = tempRect.iTl.iX;

        }

	tempRect = aInclusiveRect;

	if(aInclusiveRect.Height() < 0 )

        {

        aInclusiveRect.iTl.iY = aInclusiveRect.iBr.iY;

        aInclusiveRect.iBr.iY = tempRect.iTl.iY;

        }

    if(aInclusiveRect.Width() < 0 )

        {

        aInclusiveRect.iTl.iX = aInclusiveRect.iBr.iX;

        aInclusiveRect.iBr.iX = tempRect.iTl.iX;

        }

    if (iExtension && iExtension->iH.iVisibility!=EOff)

        {

        if(aClientRect.Height() < ScrollBarBreadth( CEikScrollBar::EHorizontal) )

            {

            aClientRect.SetHeight( ScrollBarBreadth(CEikScrollBar::EHorizontal) );

            }

        if(aInclusiveRect.Height() < ScrollBarBreadth( CEikScrollBar::EHorizontal) )

            {

            aInclusiveRect.SetHeight( ScrollBarBreadth(CEikScrollBar::EHorizontal) );

            }

        }

    TBool sizeChanged = EFalse;

	GetScrollBars(EFalse);

	CalcTheoreticalScrollBarVisibility(aVModel,aHModel);

	if (iV.iVisibility!=EOff)

		iV.iModel = *aVModel;

	MakeSBarVisible(iV, iScrollBarFrameFlags&EDisplayVScrollBar);

    if (iExtension && iExtension->iH.iBar)

        {

        if (iExtension->iH.iVisibility!=EOff)

	        iExtension->iH.iModel = *aHModel;   

        MakeSBarVisible(iExtension->iH, iScrollBarFrameFlags&EDisplayHScrollBar);

        }

    // Vertical Double span scollbar

    if (iV.iBar && TypeOfVScrollBar() == EDoubleSpan && iV.iExternalScrollBarAttached==EFalse )

        {        

        TInt scrollBarWidth = ScrollBarBreadth(CEikScrollBar::EVertical); // is 0 if SB not visible !

        TInt horizontalScrollBarWidth = 0;

        if (iExtension && iExtension->iH.iVisibility!=EOff)

            {

            horizontalScrollBarWidth = ScrollBarBreadth(CEikScrollBar::EHorizontal);

            }

        CAknDoubleSpanScrollBar* scrollbar = static_cast <CAknDoubleSpanScrollBar*> (iV.iBar);

        if (scrollbar->FixedLayoutRect().Size() == TSize(0,0))

            {

            TMargins checkedClientMargin(aLayout.iClientMargin);

            TMargins checkedInclusiveMargin(aLayout.iInclusiveMargin);

            checkedClientMargin.iTop = Max(0,checkedClientMargin.iTop);

            checkedClientMargin.iBottom = Max(0,checkedClientMargin.iBottom);

            checkedClientMargin.iRight = Max(0,checkedClientMargin.iRight);

            checkedClientMargin.iLeft = Max(0,checkedClientMargin.iLeft);

            checkedInclusiveMargin.iTop = Max(0,checkedInclusiveMargin.iTop);

            checkedInclusiveMargin.iBottom = Max(0,checkedInclusiveMargin.iBottom);

            checkedInclusiveMargin.iRight = Max(0,checkedInclusiveMargin.iRight);

            checkedInclusiveMargin.iLeft = Max(0,checkedInclusiveMargin.iLeft);

            TInt width  = 0;                

            TInt xPos   = 0;

            TInt yPos   = 0;

            TInt height = 0;

            if (!AknLayoutUtils::LayoutMirrored())

                {

                if (aLayout.iTilingMode == TEikScrollBarFrameLayout::EInclusiveRectConstant)

                    {

                    width = scrollBarWidth + checkedInclusiveMargin.iRight;                

                    xPos = aInclusiveRect.iBr.iX - width;

                    yPos = aInclusiveRect.iTl.iY + checkedInclusiveMargin.iTop;

                    height = aInclusiveRect.Size().iHeight - (checkedInclusiveMargin.iTop + checkedInclusiveMargin.iBottom) - horizontalScrollBarWidth;

                    if ((aClientRect.iBr.iX + width > aInclusiveRect.iBr.iX) || (aInclusiveRect.iBr.iX - width > aClientRect.iBr.iX))

                        {

                        aClientRect.iBr.iX = aInclusiveRect.iBr.iX - width;

                        sizeChanged = ETrue;

                        }

                    }

                else

                    {

                    width = scrollBarWidth + checkedClientMargin.iRight;                

                    xPos = aClientRect.iBr.iX + checkedClientMargin.iRight;

                    yPos = aInclusiveRect.iTl.iY + checkedInclusiveMargin.iTop;

                    height = aInclusiveRect.Size().iHeight - (checkedInclusiveMargin.iTop + checkedInclusiveMargin.iBottom) - horizontalScrollBarWidth;

                    if ((aClientRect.iBr.iX + width + checkedInclusiveMargin.iRight > aInclusiveRect.iBr.iX) || 

                        (aInclusiveRect.iBr.iX - (width + checkedInclusiveMargin.iRight) > aClientRect.iBr.iX))

                        {

                        aInclusiveRect.iBr.iX = aClientRect.iBr.iX + width + checkedInclusiveMargin.iRight;

                        sizeChanged = ETrue;

                        }

                    }

                }

            else

                {

                // Mirrored Left & Right

                if (aLayout.iTilingMode == TEikScrollBarFrameLayout::EInclusiveRectConstant)

                    {

                    width = scrollBarWidth + checkedInclusiveMargin.iRight;                

                    xPos = aInclusiveRect.iTl.iX + checkedInclusiveMargin.iRight;

                    yPos = aInclusiveRect.iTl.iY + checkedInclusiveMargin.iTop;

                    height = aInclusiveRect.Size().iHeight - (checkedInclusiveMargin.iTop + checkedInclusiveMargin.iBottom) - horizontalScrollBarWidth;

                    if ((aClientRect.iTl.iX - width < aInclusiveRect.iTl.iX) || (aInclusiveRect.iTl.iX + width > aClientRect.iTl.iX))

                        {

                        aClientRect.iTl.iX = aInclusiveRect.iTl.iX + width;

                        xPos = aInclusiveRect.iTl.iX + checkedInclusiveMargin.iRight;

                        sizeChanged = ETrue;

                        }

                    }

                else

                    {

                    width = scrollBarWidth + checkedClientMargin.iRight;                

                    xPos = aClientRect.iTl.iX - checkedClientMargin.iRight;

                    yPos = aInclusiveRect.iTl.iY + checkedInclusiveMargin.iTop;

                    height = aInclusiveRect.Size().iHeight - (checkedInclusiveMargin.iTop + checkedInclusiveMargin.iBottom) - horizontalScrollBarWidth;

                    if ((aClientRect.iTl.iX - width - checkedInclusiveMargin.iRight > aInclusiveRect.iTl.iX) || 

                        (aInclusiveRect.iTl.iX - (width + checkedInclusiveMargin.iRight) < aClientRect.iTl.iX))

                        {

                        aInclusiveRect.iTl.iX = aClientRect.iTl.iX - width - checkedInclusiveMargin.iRight;

                        xPos = aInclusiveRect.iTl.iX + checkedInclusiveMargin.iRight;

                        sizeChanged = ETrue;

                        }

                    }

                }

            TRect newRect = TRect(TPoint(xPos, yPos), TSize(width, height ));

            if (iV.iBar->IsVisible() && (newRect != TRect(iV.iBar->Position(), iV.iBar->Size())))

                {

                iV.iBar->SetRect(newRect);                     

                }

            }

        }

    // Horizontal Double span scollbar

    if (iExtension && 

        iExtension->iH.iBar && 

        TypeOfHScrollBar() == EDoubleSpan && 

        iExtension->iH.iExternalScrollBarAttached==EFalse )

        {                

        TInt scrollBarWidth = ScrollBarBreadth(CEikScrollBar::EHorizontal); // is 0 if SB not visible !

        TInt verticalScrollBarWidth = 0;

        if (iV.iVisibility!=EOff)

            {

            verticalScrollBarWidth = ScrollBarBreadth(CEikScrollBar::EVertical);

            }

        CAknDoubleSpanScrollBar* scrollbar = static_cast <CAknDoubleSpanScrollBar*> (iExtension->iH.iBar);

        if (scrollbar->FixedLayoutRect().Size() == TSize(0,0))

            {

            TMargins checkedClientMargin(aLayout.iClientMargin);

            TMargins checkedInclusiveMargin(aLayout.iInclusiveMargin);

            checkedClientMargin.iTop = Max(0,checkedClientMargin.iTop);

            checkedClientMargin.iBottom = Max(0,checkedClientMargin.iBottom);

            checkedClientMargin.iRight = Max(0,checkedClientMargin.iRight);

            checkedClientMargin.iLeft = Max(0,checkedClientMargin.iLeft);

            checkedInclusiveMargin.iTop = Max(0,checkedInclusiveMargin.iTop);

            checkedInclusiveMargin.iBottom = Max(0,checkedInclusiveMargin.iBottom);

            checkedInclusiveMargin.iRight = Max(0,checkedInclusiveMargin.iRight);

            checkedInclusiveMargin.iLeft = Max(0,checkedInclusiveMargin.iLeft);

            TInt width  = 0;                

            TInt xPos   = 0;

            TInt yPos   = 0;

            TInt height = 0;

            if (aLayout.iTilingMode == TEikScrollBarFrameLayout::EInclusiveRectConstant)

                {

                width = scrollBarWidth + checkedInclusiveMargin.iBottom; // width as vertical direction (height).               

                xPos = aInclusiveRect.iTl.iX + checkedInclusiveMargin.iLeft;

                if (AknLayoutUtils::LayoutMirrored())

                    {

                    xPos += verticalScrollBarWidth;

                    }

                yPos = aInclusiveRect.iBr.iY - checkedInclusiveMargin.iBottom - width;

                height = aInclusiveRect.Size().iWidth - (checkedInclusiveMargin.iLeft + checkedInclusiveMargin.iRight) - verticalScrollBarWidth; // height as horizontal (width).

                if ((aClientRect.iBr.iY + width > aInclusiveRect.iBr.iY) || (aInclusiveRect.iBr.iY - width > aClientRect.iBr.iY))

                    {

                    aClientRect.iBr.iY = aInclusiveRect.iBr.iY - width;

                    sizeChanged = ETrue;

                    }

                }

            else

                {

                width = scrollBarWidth + checkedClientMargin.iBottom; // width as vertical direction (height).               

                xPos = aInclusiveRect.iTl.iX + checkedInclusiveMargin.iLeft;

                if (AknLayoutUtils::LayoutMirrored())

                    {

                    xPos += verticalScrollBarWidth;

                    }

                yPos = aClientRect.iBr.iY + checkedClientMargin.iBottom;

                height = aInclusiveRect.Size().iWidth - (checkedInclusiveMargin.iLeft + checkedInclusiveMargin.iRight) - verticalScrollBarWidth; // height as horizontal (width).

                if ((aClientRect.iBr.iY + width + checkedClientMargin.iBottom > aInclusiveRect.iBr.iY) || 

                    (aInclusiveRect.iBr.iY - (width + checkedInclusiveMargin.iBottom) > aClientRect.iBr.iY))

                    {

                    aInclusiveRect.iBr.iY = aClientRect.iBr.iY + width + checkedInclusiveMargin.iBottom;

                    sizeChanged = ETrue;

                    }

                }

            TRect newRect = TRect(TPoint(xPos, yPos), TSize(height, width ));  // height & width swapped 

            if (iExtension->iH.iBar->IsVisible() && (newRect != TRect(iV.iBar->Position(), iV.iBar->Size())))

                {

                iExtension->iH.iBar->SetRect(newRect);                   

                }

            }

        }

    return sizeChanged;

	}

EXPORT_C void CEikScrollBarFrame::MoveThumbsBy(TInt aDeltaX, TInt aDeltaY)

	//

 	// Used to update any scrollbar(s) after an external scroll

	// values in terms of the model, presumed not to have changed spans.

	//

	{

    // Vertical scrollbar

    if (aDeltaY && iV.iBar)

        {

        if (TypeOfVScrollBar() == TScrollBarType(EArrowHead))

            {

		    iV.iModel.iThumbPosition += aDeltaY;

            }

        else

            {

            // EDoubleSpan has different model.

            if (iV.iModel.ScrollBarModelType() == TEikScrollBarModel::EAknDoubleSpanScrollBarModel)

                {

                TAknDoubleSpanScrollBarModel* model = static_cast <TAknDoubleSpanScrollBarModel*> (&iV.iModel);

                // Note that for a large scroll span and small delta this may not actually change focusposition

                // because of the 15 bit accuracy of TAknDoubleSpanScrollBarModel values.

                model->SetFocusPosition(model->FocusPosition() + aDeltaY);    

                }

            else

                {

                // Error. User of the API is perhaps assigning values directly to TEikScrollBarModel

                // member variables which is not allowed with EAknDoubleSpanScrollBarModel.

                // #ifdef _DEBUG

                // RDebug::Print(_L("CEikScrollBarFrame: Please, use TAknDoubleSpanScrollBarModel instead of TEikScrollBarModel"));