libreoffice/sd/source/ui/slidesorter/controller/SlsScrollBarManager.cxx

/*************************************************************************
 *
 *  $RCSfile: SlsScrollBarManager.cxx,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: rt $ $Date: 2004-07-13 14:15:32 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#include "controller/SlsScrollBarManager.hxx"

#include "SlideSorterViewShell.hxx"
#include "controller/SlideSorterController.hxx"
#include "model/SlideSorterModel.hxx"
#include "model/SlsPageDescriptor.hxx"
#include "view/SlideSorterView.hxx"
#include "view/SlsLayouter.hxx"
#include "view/SlsViewOverlay.hxx"
#include "Window.hxx"
#include "sdpage.hxx"


#include <vcl/scrbar.hxx>

namespace sd { namespace slidesorter { namespace controller {

ScrollBarManager::ScrollBarManager (
    SlideSorterController& rController,
    ::Window* pParentWindow,
    ::Window* pContentWindow,
    ScrollBar* pHorizontalScrollBar,
    ScrollBar* pVerticalScrollBar,
    ScrollBarBox* pScrollBarFiller)
    : mrController (rController),
      mpHorizontalScrollBar (pHorizontalScrollBar),
      mpVerticalScrollBar (pVerticalScrollBar),
      mnHorizontalPosition (0),
      mnVerticalPosition (0),
      mpScrollBarFiller (pScrollBarFiller),
      maScrollBorder (10,10),
      mnHorizontalScrollFactor (0.1),
      mnVerticalScrollFactor (0.1),
      mbUseVerticalScrollBar (true),
      mpContentWindow (pContentWindow)
{
    maAutoScrollTimer.SetTimeout(50);
    maAutoScrollTimer.SetTimeoutHdl (
        LINK(this, ScrollBarManager, AutoScrollTimeoutHandler));
    Timer maAutoScrollTimer;
}




ScrollBarManager::~ScrollBarManager (void)
{
    if (mpVerticalScrollBar != NULL)
        mpVerticalScrollBar->SetScrollHdl (Link());
    if (mpHorizontalScrollBar != NULL)
        mpHorizontalScrollBar->SetScrollHdl (Link());
}




void ScrollBarManager::LateInitialization (void)
{
    if (mpVerticalScrollBar != NULL)
        mpVerticalScrollBar->SetScrollHdl (
            LINK(
                this,
                ScrollBarManager,
                VerticalScrollBarHandler));
    if (mpHorizontalScrollBar != NULL)
        mpHorizontalScrollBar->SetScrollHdl (
            LINK(
                this,
                ScrollBarManager,
                HorizontalScrollBarHandler));
}




void ScrollBarManager::UseVerticalScrollBar (bool bUseVerticalScrollBar)
{
    mbUseVerticalScrollBar = bUseVerticalScrollBar;
}




/** Placing the scroll bars is an iterative process.  The visibility of one
    scroll bar affects the remaining size and thus may lead to the other
    scroll bar becoming visible.

    First we determine the visibility of the horizontal scroll bar.  After
    that we do the same for the vertical scroll bar.  To have an initial
    value for the required size we call the layouter before that.  When one
    of the two scroll bars is made visible then the size of the browser
    window changes and a second call to the layouter becomes necessary.
    That call is made anyway after this method returns.
*/
Rectangle ScrollBarManager::PlaceScrollBars (const Rectangle& rAvailableArea)
{
    Rectangle aAvailableArea (rAvailableArea);

    PlaceHorizontalScrollBar (aAvailableArea);
    PlaceVerticalScrollBar (aAvailableArea);
    PlaceFiller (aAvailableArea);

    UpdateScrollBars (false);

    return aAvailableArea;
}




void ScrollBarManager::PlaceHorizontalScrollBar (Rectangle& aAvailableArea)
{
    if (mpHorizontalScrollBar != NULL)
    {
        // To be on the safe side we assume that the vertical scroll bar
        // will be shown.
        int nVerticalScrollBarWidth = GetVerticalScrollBarWidth();
        Size aBrowserSize (
            aAvailableArea.GetWidth() - nVerticalScrollBarWidth,
            aAvailableArea.GetHeight());
        bool bShowHorizontalScrollBar = false;
        if (mrController.GetModel().GetPageCount() > 0)
        {
            if (mrController.GetView().GetLayouter().Rearrange (
                aBrowserSize,
                mrController.GetModel().GetPageDescriptor(0)
                ->GetPage()->GetSize(),
                mpContentWindow))
            {
                Size aPageSize
                    = mrController.GetView().GetLayouter().GetPageBox (
                        mrController.GetModel().GetPageCount()).GetSize();
                Size aWindowModelSize = mpContentWindow->PixelToLogic(
                    aAvailableArea.GetSize());
                bShowHorizontalScrollBar
                    = (aWindowModelSize.Width() < aPageSize.Width());
            }
        }


        if (bShowHorizontalScrollBar)
        {
            // Save the current relative position.
            mnHorizontalPosition =
                double(mpHorizontalScrollBar->GetThumbPos())
                / double(mpHorizontalScrollBar->GetRange().Len());

            // Place the scroll bar.
            Size aScrollBarSize (mpHorizontalScrollBar->GetSizePixel());
            aAvailableArea.Bottom() -= aScrollBarSize.Height();
            mpHorizontalScrollBar->SetPosSizePixel (
                Point(aAvailableArea.Left(), aAvailableArea.Bottom()+1),
                Size (aAvailableArea.GetWidth() - nVerticalScrollBarWidth,
                    aScrollBarSize.Height()));

            // Restore the relative position.
            mpHorizontalScrollBar->SetThumbPos(
                (long)(0.5 + mnHorizontalPosition
                    * mpHorizontalScrollBar->GetRange().Len()));

            mpHorizontalScrollBar->Show();
        }
        else
            mpHorizontalScrollBar->Hide();
    }
}




void ScrollBarManager::PlaceVerticalScrollBar (Rectangle& aArea)
{
    if (mpVerticalScrollBar != NULL)
    {
        if (mbUseVerticalScrollBar)
        {
            view::Layouter::DoublePoint aLayouterPosition
                = mrController.GetView().GetLayouter()
                .ConvertModelToLayouterCoordinates (
                    Point (0, mpVerticalScrollBar->GetThumbPos()));

            // Place the scroll bar.
            Size aScrollBarSize (mpVerticalScrollBar->GetSizePixel());
            aArea.Right() -= aScrollBarSize.Width();
            mpVerticalScrollBar->SetPosSizePixel (
                Point (aArea.Right()+1, aArea.Top()),
                Size (aScrollBarSize.Width(), aArea.GetHeight()));

            // Restore the position.
            mpVerticalScrollBar->SetThumbPos(
                mrController.GetView().GetLayouter()
                .ConvertLayouterToModelCoordinates(
                    aLayouterPosition).Y());
            mnVerticalPosition =
                double(mpVerticalScrollBar->GetThumbPos())
                / double(mpVerticalScrollBar->GetRange().Len());

            mpVerticalScrollBar->Show();
        }
        else
        {
            mpVerticalScrollBar->Hide();
            if ( ! mbUseVerticalScrollBar)
                AdaptWindowSize (aArea);
        }
    }
}




void ScrollBarManager::PlaceFiller (Rectangle& aArea)
{
    // Place the filler when both scroll bars are visible.
    if (mpHorizontalScrollBar != NULL
        && mpVerticalScrollBar != NULL
        && mpHorizontalScrollBar->IsVisible()
        && mpVerticalScrollBar->IsVisible())
    {
        mpScrollBarFiller->SetPosSizePixel(
            Point(
                aArea.Right()+1,
                aArea.Bottom()+1),
            Size (
                mpVerticalScrollBar->GetSizePixel().Width(),
                mpHorizontalScrollBar->GetSizePixel().Height()));
        mpScrollBarFiller->Show();
    }
    else
        mpScrollBarFiller->Hide();
}




void ScrollBarManager::AdaptWindowSize (const Rectangle& rArea)
{
    Size aPixelContentSize (mpContentWindow->LogicToPixel(
        mrController.GetView().GetLayouter().GetPageBox (
            mrController.GetModel().GetPageCount()).GetSize()));
    int nHeightDifference = aPixelContentSize.Height() - rArea.GetHeight();
    ::Window* pParentWindow = mpContentWindow->GetParent();
    Size aNewWindowSize (pParentWindow->GetSizePixel());
    if (nHeightDifference != 0)
    {
        aNewWindowSize.Height() += nHeightDifference;
        pParentWindow->SetPosSizePixel(
            pParentWindow->GetPosPixel(),
            aNewWindowSize);
    }
}




void ScrollBarManager::UpdateScrollBars (bool bResetThumbPosition)
{
    Rectangle aModelArea (mrController.GetView().GetModelArea());
    ::sd::Window* pWindow = mrController.GetView().GetWindow();
    Size aWindowModelSize (pWindow->PixelToLogic(pWindow->GetSizePixel()));

    double nOldHorizontalPosition = mnHorizontalPosition;
    double nOldVerticalPosition = mnVerticalPosition;

    // The horizontal scroll bar is only shown when the window is
    // horizontally smaller than the view.
    if (mpHorizontalScrollBar != NULL && mpHorizontalScrollBar->IsVisible())
    {
        mpHorizontalScrollBar->Show();
        mpHorizontalScrollBar->SetRange (
            Range(aModelArea.Left(), aModelArea.Right()));
        if (bResetThumbPosition)
        {
            mpHorizontalScrollBar->SetThumbPos (0);
            mnHorizontalPosition = 0;
        }
        else
            mnHorizontalPosition =
                double(mpHorizontalScrollBar->GetThumbPos())
                / double(mpHorizontalScrollBar->GetRange().Len());

        mpHorizontalScrollBar->SetVisibleSize (aWindowModelSize.Width());

        mpHorizontalScrollBar->SetLineSize (1000);
        // Make the page size about 90% of the visible width.
        mpHorizontalScrollBar->SetPageSize (
            mpContentWindow->PixelToLogic(
                mpContentWindow->GetSizePixel()).Width() * 9 / 10);
    }

    // The vertical scroll bar is always shown.
    if (mpVerticalScrollBar != NULL && mpVerticalScrollBar->IsVisible())
    {
        mpVerticalScrollBar->SetRange (
            Range(aModelArea.Top(), aModelArea.Bottom()));
        if (bResetThumbPosition)
        {
            mpVerticalScrollBar->SetThumbPos (0);
            mnVerticalPosition = 0;
        }
        else
            mnVerticalPosition =
                double(mpVerticalScrollBar->GetThumbPos())
                / double(mpVerticalScrollBar->GetRange().Len());

        mpVerticalScrollBar->SetVisibleSize (aWindowModelSize.Height());

        mpVerticalScrollBar->SetLineSize (1000);
        // Make the page size about 90% of the visible height.
        mpVerticalScrollBar->SetPageSize (
            (mpContentWindow->PixelToLogic(
                mpContentWindow->GetSizePixel()).Height() * 9) / 10);
    }

    mrController.GetView().InvalidatePageObjectVisibilities();
    if (nOldHorizontalPosition != mnHorizontalPosition
        || nOldVerticalPosition != mnVerticalPosition)
        pWindow->SetVisibleXY (
            mnHorizontalPosition, mnVerticalPosition);
}




IMPL_LINK(ScrollBarManager, VerticalScrollBarHandler, ScrollBar*, pScrollBar)
{
    if (pScrollBar!=NULL && mrController.GetView().GetWindow()!=NULL)
    {
        double nRelativePosition = double(pScrollBar->GetThumbPos())
            / double(pScrollBar->GetRange().Len());
        mrController.GetView().InvalidatePageObjectVisibilities();
        mrController.GetView().GetWindow()->SetVisibleXY (
            -1,
            nRelativePosition);
    }
    return TRUE;
}




IMPL_LINK(ScrollBarManager, HorizontalScrollBarHandler, ScrollBar*, pScrollBar)
{
    if (pScrollBar!=NULL && mrController.GetView().GetWindow()!=NULL)
    {
        double nRelativePosition = double(pScrollBar->GetThumbPos())
            / double(pScrollBar->GetRange().Len());
        mrController.GetView().InvalidatePageObjectVisibilities();
        mrController.GetView().GetWindow()->SetVisibleXY (nRelativePosition, -1);
    }
    return TRUE;
}




void ScrollBarManager::SetWindowOrigin (
    double nHorizontalPosition,
    double nVerticalPosition)
{
    mnHorizontalPosition = nHorizontalPosition;
    mnVerticalPosition = nVerticalPosition;

    ::sd::Window* pWindow = mrController.GetView().GetWindow();
    Size aViewSize (pWindow->GetViewSize());
    Point aOrigin (
        (long int) (mnHorizontalPosition * aViewSize.Width()),
        (long int) (mnVerticalPosition * aViewSize.Height()));

    pWindow->SetWinViewPos (aOrigin);
    pWindow->UpdateMapMode ();
    pWindow->Invalidate ();
}




bool ScrollBarManager::IsHorizontalScrollBarVisible (void)
{
    ::sd::Window* pWindow = mrController.GetView().GetWindow();
    Rectangle aPixelViewArea (pWindow->LogicToPixel(mrController.GetView().GetModelArea()));
    Size aWindowPixelSize (pWindow->GetSizePixel());
    // Return whether the window is smaller then the view.  Allow for some
    // minor rounding error.
    return (aWindowPixelSize.Width() < aPixelViewArea.GetWidth()-1);
}




void ScrollBarManager::SetTop (long nNewTop)
{
    if (mpVerticalScrollBar != NULL
        && mpVerticalScrollBar->GetThumbPos() != nNewTop)
    {
        mpVerticalScrollBar->SetThumbPos (nNewTop);
        mnVerticalPosition =
            double(nNewTop)
            / double(mpVerticalScrollBar->GetRange().Len());
        mrController.GetView().GetWindow()->SetVisibleXY (
            mnHorizontalPosition, mnVerticalPosition);
    }
}




int ScrollBarManager::GetVerticalScrollBarWidth (void) const
{
    if (mpVerticalScrollBar != NULL && mbUseVerticalScrollBar)
        return mpVerticalScrollBar->GetSizePixel().Width();
    else
        return 0;
}




void ScrollBarManager::CalcAutoScrollOffset (const Point& rMouseWindowPosition)
{
    bool bResult = false;
    ::sd::Window* pWindow = mrController.GetView().GetWindow();

    int nDx = 0;
    int nDy = 0;

    Size aWindowSize = pWindow->GetOutputSizePixel();
    Rectangle aViewPixelArea (
        pWindow->LogicToPixel(mrController.GetView().GetModelArea()));

    if (aWindowSize.Width() > maScrollBorder.Width() * 3
        && mpHorizontalScrollBar != NULL
        && mpHorizontalScrollBar->IsVisible())
    {
        if (rMouseWindowPosition.X() < maScrollBorder.Width())
        {
            nDx = -1 + (int)(mnHorizontalScrollFactor
                * (rMouseWindowPosition.X() - maScrollBorder.Width()));
        }

        if (rMouseWindowPosition.X()
            >= aWindowSize.Width() - maScrollBorder.Width())
        {
            nDx = 1 + (int)(mnHorizontalScrollFactor
                * (rMouseWindowPosition.X() - aWindowSize.Width()
                    + maScrollBorder.Width()));
        }
    }

    if (aWindowSize.Height() > maScrollBorder.Height() * 3
        && aWindowSize.Height() < aViewPixelArea.GetHeight())
    {
        if (rMouseWindowPosition.Y() < maScrollBorder.Height())
        {
            nDy = -1 + (int)(mnVerticalScrollFactor
                * (rMouseWindowPosition.Y() - maScrollBorder.Height()));
        }

        if (rMouseWindowPosition.Y()
            >= aWindowSize.Height() - maScrollBorder.Height())
        {
            nDy = 1 + (int)(mnVerticalScrollFactor
                * (rMouseWindowPosition.Y() - aWindowSize.Height()
                    + maScrollBorder.Height()));
        }
    }

    maAutoScrollOffset = Size(nDx,nDy);
}




bool ScrollBarManager::AutoScroll (const Point& rMouseWindowPosition)
{
    CalcAutoScrollOffset (rMouseWindowPosition);
    bool bResult = RepeatAutoScroll();
    if (bResult)
    {
        maAutoScrollTimer.Start();
    }
    return bResult;
}




void ScrollBarManager::StopAutoScroll (void)
{
    maAutoScrollTimer.Stop();
}




bool ScrollBarManager::RepeatAutoScroll (void)
{
    if (maAutoScrollOffset != Size(0,0))
    {
        mrController.GetView().GetOverlay().HideAndSave();
        mrController.GetViewShell().ScrollLines(
            maAutoScrollOffset.Width(),
            maAutoScrollOffset.Height());
        mrController.GetView().GetOverlay().Restore();
        return true;
    }
    else
        return false;
}




IMPL_LINK(ScrollBarManager, AutoScrollTimeoutHandler, Timer *, pTimer)
{
    RepeatAutoScroll();

    return 0;
}


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