/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: SlsViewCacheContext.hxx,v $
 *
 * $Revision: 1.3 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#include "view/SlsPageObjectLayouter.hxx"

#include "model/SlsPageDescriptor.hxx"
#include "view/SlsFontProvider.hxx"
#include "tools/IconCache.hxx"
#include "Window.hxx"
#include "res_bmp.hrc"

namespace sd { namespace slidesorter { namespace view {

const sal_Int32 PageObjectLayouter::mnSelectionIndicatorOffset = 0;
const sal_Int32 PageObjectLayouter::mnSelectionIndicatorThickness = 3;
const sal_Int32 PageObjectLayouter::mnFocusIndicatorOffset = 3;
const sal_Int32 PageObjectLayouter::mnPageNumberOffset = 9;
const sal_Int32 PageObjectLayouter::mnOuterBorderWidth = 5;
const Size PageObjectLayouter::maButtonSize (32,32);
const sal_Int32 PageObjectLayouter::mnButtonGap (5);


PageObjectLayouter::PageObjectLayouter (
    const Size& rPageObjectWindowSize,
    const Size& rPageSize,
    const ::boost::shared_ptr< ::Window>& rpWindow,
    const int nPageCount)
    : mpWindow(rpWindow),
      maPageObjectSize(rPageObjectWindowSize.Width(), rPageObjectWindowSize.Height()),
      mnModelToWindowScale(1),
      maPageObjectBoundingBox(),
      maPageNumberAreaBoundingBox(),
      maPreviewBoundingBox(),
      maFocusIndicatorBoundingBox(),
      maSelectionIndicatorBoundingBox(),
      maTransitionEffectBoundingBox(),
      maButtonAreaBoundingBox(),
      maTransitionEffectIcon(IconCache::Instance().GetIcon(BMP_FADE_EFFECT_INDICATOR))
{
    const Size aPageNumberAreaSize (GetPageNumberAreaSize(nPageCount));

    const int nMaximumBorderWidth (mnSelectionIndicatorOffset + mnOuterBorderWidth);

    maPageNumberAreaBoundingBox = Rectangle(
        mnPageNumberOffset,
        nMaximumBorderWidth,
        mnPageNumberOffset + aPageNumberAreaSize.Width(),
        nMaximumBorderWidth + aPageNumberAreaSize.Height());

    maPreviewBoundingBox = CalculatePreviewBoundingBox(
        maPageObjectSize,
        Size(rPageSize.Width(), rPageSize.Height()),
        aPageNumberAreaSize);
    maPageObjectBoundingBox = Rectangle(Point(0,0), maPageObjectSize);

    maFocusIndicatorBoundingBox = maPreviewBoundingBox;
    maFocusIndicatorBoundingBox.Left() -= mnFocusIndicatorOffset;
    maFocusIndicatorBoundingBox.Top() -= mnFocusIndicatorOffset;
    maFocusIndicatorBoundingBox.Right() += mnFocusIndicatorOffset;
    maFocusIndicatorBoundingBox.Bottom() += mnFocusIndicatorOffset;

    maSelectionIndicatorBoundingBox = maPreviewBoundingBox;
    maSelectionIndicatorBoundingBox.Left() -= mnSelectionIndicatorOffset;
    maSelectionIndicatorBoundingBox.Top() -= mnSelectionIndicatorOffset;
    maSelectionIndicatorBoundingBox.Right() += mnSelectionIndicatorOffset;
    maSelectionIndicatorBoundingBox.Bottom() += mnSelectionIndicatorOffset;

    const Size aIconSize (maTransitionEffectIcon.GetSizePixel());
    const int nLeft (maPreviewBoundingBox.Left()
        - mnPageNumberOffset - aIconSize.Width() - nMaximumBorderWidth);
    const int nTop (maPreviewBoundingBox.Bottom() - aIconSize.Height());
    maTransitionEffectBoundingBox = Rectangle(
        nLeft,
        nTop,
        nLeft + aIconSize.Width(),
        nTop + aIconSize.Height());

    maButtonAreaBoundingBox = Rectangle(
        0,
        maPageObjectBoundingBox.Bottom() - maButtonSize.Height() - mnButtonGap,
        maPageObjectBoundingBox.Right() - mnButtonGap,
        maPageObjectBoundingBox.Bottom() - mnButtonGap);
}




Rectangle PageObjectLayouter::CalculatePreviewBoundingBox (
    Size& rPageObjectSize,
    const Size& rPageSize,
    const Size& rPageNumberAreaSize)
{
    const int nMaximumBorderWidth (mnSelectionIndicatorOffset + mnOuterBorderWidth);
    const int nLeftAreaWidth (
        2*mnPageNumberOffset
            + ::std::max(
                rPageNumberAreaSize.Width(),
                maTransitionEffectIcon.GetSizePixel().Width()));
    int nPreviewWidth;
    int nPreviewHeight;
    const double nPageAspectRatio (double(rPageSize.Width()) / double(rPageSize.Height()));
    if (rPageObjectSize.Height() == 0)
    {
        // Calculate height so that the preview fills the available
        // horizontal space completely while observing the aspect ratio of
        // the preview.
        nPreviewWidth = rPageObjectSize.Width() - nLeftAreaWidth - 2*nMaximumBorderWidth - 1;
        nPreviewHeight = ::basegfx::fround(nPreviewWidth / nPageAspectRatio);
        rPageObjectSize.setHeight(nPreviewHeight + 2*nMaximumBorderWidth + 1);
    }
    else if (rPageObjectSize.Width() == 0)
    {
        // Calculate the width of the page object so that the preview fills
        // the available vertical space completely while observing the
        // aspect ratio of the preview.
        nPreviewHeight = rPageObjectSize.Height() - 2*nMaximumBorderWidth - 1;
        nPreviewWidth = ::basegfx::fround(nPreviewHeight * nPageAspectRatio);
        rPageObjectSize.setWidth(nPreviewWidth + nLeftAreaWidth + 2*nMaximumBorderWidth + 1);

    }
    else
    {
        // The size of the page object is given.  Calculate the size of the
        // preview.
        nPreviewWidth = rPageObjectSize.Width() - nLeftAreaWidth - 2*nMaximumBorderWidth - 1;
        nPreviewHeight = rPageObjectSize.Height() - 2*nMaximumBorderWidth - 1;
        if (double(nPreviewWidth)/double(nPreviewHeight) > nPageAspectRatio)
            nPreviewWidth = ::basegfx::fround(nPreviewHeight * nPageAspectRatio);
        else
            nPreviewHeight = ::basegfx::fround(nPreviewWidth / nPageAspectRatio);
    }
    // When the preview does not fill the available space completely then
    // place it flush right and vertically centered.
    const int nLeft (rPageObjectSize.Width() - nMaximumBorderWidth - nPreviewWidth - 1);
    const int nTop (nMaximumBorderWidth
        + (rPageObjectSize.Height() - 2*nMaximumBorderWidth - nPreviewHeight)/2);
    return Rectangle(
        nLeft,
        nTop,
        nLeft + nPreviewWidth,
        nTop + nPreviewHeight);
}




Rectangle PageObjectLayouter::GetBoundingBox (
    const model::SharedPageDescriptor& rpPageDescriptor,
    const Part ePart,
    const CoordinateSystem eCoordinateSystem,
    const sal_Int32 nIndex)
{
    if ( ! rpPageDescriptor)
    {
        OSL_ASSERT(rpPageDescriptor);
        return Rectangle();
    }

    Rectangle aBoundingBox;
    switch (ePart)
    {
        case PageObject:
        case MouseOverIndicator:
            aBoundingBox = maPageObjectBoundingBox;
            break;

        case Preview:
            aBoundingBox = maPreviewBoundingBox;
            break;

        case FocusIndicator:
            aBoundingBox = maFocusIndicatorBoundingBox;
            break;

        case SelectionIndicator:
            aBoundingBox = maSelectionIndicatorBoundingBox;
            break;

        case PageNumber:
            aBoundingBox = maPageNumberAreaBoundingBox;
            break;

        case Name:
            aBoundingBox = maPageNumberAreaBoundingBox;
            break;

        case TransitionEffectIndicator:
            aBoundingBox = maTransitionEffectBoundingBox;
            break;

        case ButtonArea:
            aBoundingBox = maButtonAreaBoundingBox;
            break;

        case Button:
            aBoundingBox = Rectangle(
                maPageObjectBoundingBox.BottomRight()
                    - Point(
                        (nIndex+1)*(maButtonSize.Width() + mnButtonGap),
                        maButtonSize.Height() + mnButtonGap),
                maButtonSize);
            break;
    }

    Point aLocation (rpPageDescriptor->GetLocation());
    if (eCoordinateSystem == ScreenCoordinateSystem)
        aLocation += mpWindow->GetMapMode().GetOrigin();

    return  Rectangle(
        aBoundingBox.TopLeft() + aLocation,
        aBoundingBox.BottomRight() + aLocation);
}




Size PageObjectLayouter::GetPageObjectSize (void) const
{
    return maPageObjectSize;
}




Size PageObjectLayouter::GetPreviewSize (void) const
{
    return maPreviewBoundingBox.GetSize();
}




Size PageObjectLayouter::GetPageNumberAreaSize (const int nPageCount)
{
    OSL_ASSERT(mpWindow);

    // Set the correct font.
    Font aOriginalFont (mpWindow->GetFont());
    mpWindow->SetFont(*FontProvider::Instance().GetFont(*mpWindow));

    String sPageNumberTemplate;
    if (nPageCount < 10)
        sPageNumberTemplate = String::CreateFromAscii("9");
    else if (nPageCount < 100)
        sPageNumberTemplate = String::CreateFromAscii("99");
    else if (nPageCount < 200)
        // Just for the case that 1 is narrower than 9.
        sPageNumberTemplate = String::CreateFromAscii("199");
    else if (nPageCount < 1000)
        sPageNumberTemplate = String::CreateFromAscii("999");
    else
        sPageNumberTemplate = String::CreateFromAscii("9999");
    // More then 9999 pages are not handled.

    const Size aSize (
        mpWindow->GetTextWidth(sPageNumberTemplate),
        mpWindow->GetTextHeight());

    mpWindow->SetFont(aOriginalFont);

    return aSize;
}




Image PageObjectLayouter::GetTransitionEffectIcon (void) const
{
    return maTransitionEffectIcon;
}




sal_Int32 PageObjectLayouter::GetButtonIndexAt (
    const model::SharedPageDescriptor& rpPageDescriptor,
    const Point& rWindowLocation)
{
    if ( ! GetBoundingBox(rpPageDescriptor, ButtonArea, WindowCoordinateSystem)
        .IsInside(rWindowLocation))
    {
        return -1;
    }
    for (sal_Int32 nIndex=0; nIndex<3; ++nIndex)
    {
        if (GetBoundingBox(rpPageDescriptor, Button, WindowCoordinateSystem, nIndex)
            .IsInside(rWindowLocation))
        {
            return nIndex;
        }
    }
    return -1;
}



} } } // end of namespace ::sd::slidesorter::view