pagepreviewlayout.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_SW_INC_PAGEPREVIEWLAYOUT_HXX
#define INCLUDED_SW_INC_PAGEPREVIEWLAYOUT_HXX

// template class <std::vector>
#include <vector>
// datatypes sal_xyz
#include <sal/types.h>
// classes <Point>, <Size> and <Rectangle>
#include <tools/gen.hxx>
// RenderContext type
#include <vcl/outdev.hxx>
// datatype <SwTwips>
#include "swtypes.hxx"
#include <prevwpage.hxx>

class SwViewShell;
class SwRootFrame;
class SwPageFrame;
class Fraction;
struct PreviewPage;

class SwPagePreviewLayout
{
private:
    friend class SwViewShell;

    static constexpr SwTwips gnXFree = 4 * 142;
    static constexpr SwTwips gnYFree = 4 * 142;

    SwViewShell& mrParentViewShell;
    const SwRootFrame& mrLayoutRootFrame;

    bool        mbLayoutInfoValid;
    bool        mbLayoutSizesValid;
    bool        mbPaintInfoValid;

    Size        maWinSize;
    sal_uInt16  mnCols;
    sal_uInt16  mnRows;
    sal_uInt16  mnPages;
    // #i18143# - the book preview is controlled by this flag
    bool        mbBookPreview;
    bool        mbBookPreviewModeToggled;

    Size        maMaxPageSize;
    tools::Rectangle   maPreviewDocRect;
    SwTwips     mnColWidth;
    SwTwips     mnRowHeight;
    SwTwips     mnPreviewLayoutWidth;
    SwTwips     mnPreviewLayoutHeight;
    bool        mbDoesLayoutColsFitIntoWindow;
    bool        mbDoesLayoutRowsFitIntoWindow;

    sal_uInt16  mnPaintPhyStartPageNum;
    sal_uInt16  mnPaintStartCol;
    sal_uInt16  mnPaintStartRow;
    bool        mbNoPageVisible;
    Point       maPaintStartPageOffset;
    Point       maPaintPreviewDocOffset;
    Point       maAdditionalPaintOffset;
    tools::Rectangle   maPaintedPreviewDocRect;
    sal_uInt16  mnSelectedPageNum;

    std::vector<std::unique_ptr<PreviewPage>> maPreviewPages;

    mutable bool mbInPaint;
    mutable bool mbNewLayoutDuringPaint;

    bool mbPrintEmptyPages;

    void Clear_();

    void ClearPreviewLayoutSizes();

    void ClearPreviewPageData();

    void CalcPreviewLayoutSizes();

    void ApplyNewZoomAtViewShell( sal_uInt8 _aNewZoom );

    void CalcAdditionalPaintOffset();

    void CalcDocPreviewPaintRect();

    void CalcPreviewDataForPage( const SwPageFrame& _rPage,
                                  const Point& _rPreviewOffset,
                                  PreviewPage* _opPreviewPage );

    void CalcPreviewPages();

    const PreviewPage* GetPreviewPageByPageNum( const sal_uInt16 _nPageNum ) const;

    void PaintSelectMarkAtPage(vcl::RenderContext& rRenderContext, const PreviewPage* _aSelectedPreviewPage) const;

public:
    SwPagePreviewLayout( SwViewShell& _rParentViewShell,
                         const SwRootFrame&    _rLayoutRootFrame );

    ~SwPagePreviewLayout()
    {
        ClearPreviewPageData();
    }

    void Init( const sal_uInt16 _nCols,
               const sal_uInt16 _nRows,
               const Size&      _rPxWinSize
              );

    void ReInit();

    bool Prepare( const sal_uInt16 _nProposedStartPageNum,
                  const Point&      rProposedStartPos,
                  const Size&      _rPxWinSize,
                  sal_uInt16&      _onStartPageNum,
                  tools::Rectangle&       _orDocPreviewPaintRect,
                  const bool       _bStartWithPageAtFirstCol = true
                );

    sal_uInt16 SelectedPage()
    {
        return mnSelectedPageNum;
    }

    void SetSelectedPage( sal_uInt16 _nSelectedPageNum )
    {
        mnSelectedPageNum = _nSelectedPageNum;
    }

    bool Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rOutRect) const;

    void Repaint(const tools::Rectangle& rInvalidCoreRect) const;

    void MarkNewSelectedPage( const sal_uInt16 _nSelectedPage );

    Point GetPreviewStartPosForNewScale( const Fraction& _aNewScale,
                                         const Fraction& _aOldScale,
                                         const Size&     _aNewWinSize ) const;

    bool IsPageVisible( const sal_uInt16 _nPageNum ) const;

    void CalcStartValuesForSelectedPageMove( const sal_Int16  _nHoriMove,
                                             const sal_Int16  _nVertMove,
                                             sal_uInt16&      _orNewSelectedPage,
                                             sal_uInt16&      _orNewStartPage,
                                             Point&           _orNewStartPos ) const;

    bool IsPreviewPosInDocPreviewPage( const Point& rPreviewPos,
                                   Point&       _orDocPos,
                                   bool&        _obPosInEmptyPage,
                                   sal_uInt16&  _onPageNum ) const;

    bool DoesPreviewLayoutRowsFitIntoWindow() const
    {
        return mbDoesLayoutRowsFitIntoWindow;
    }

    bool DoesPreviewLayoutColsFitIntoWindow() const
    {
        return mbDoesLayoutColsFitIntoWindow;
    }

    bool PreviewLayoutValid() const
    {
        return mbLayoutInfoValid && mbLayoutSizesValid && mbPaintInfoValid;
    }

    SwTwips GetWinPagesScrollAmount( const sal_Int16 _nWinPagesToScroll ) const;

    sal_uInt16 GetRowOfPage( sal_uInt16 _nPageNum ) const;

    sal_uInt16 GetColOfPage( sal_uInt16 _nPageNum ) const;

    Size GetPreviewDocSize() const;

    Size GetPreviewPageSizeByPageNum( sal_uInt16 _nPageNum ) const;

    sal_uInt16 GetVirtPageNumByPageNum( sal_uInt16 _nPageNum ) const;

    bool SetBookPreviewMode( const bool  _bEnableBookPreview,
                             sal_uInt16& _onStartPageNum,
                             tools::Rectangle&  _orDocPreviewPaintRect );

    sal_uInt16 ConvertRelativeToAbsolutePageNum( sal_uInt16 _nRelPageNum ) const;

    sal_uInt16 ConvertAbsoluteToRelativePageNum( sal_uInt16 _nAbsPageNum ) const;

    SwViewShell& GetParentViewShell()
    {
        return mrParentViewShell;
    }
};

#endif // INCLUDED_SW_INC_PAGEPREVIEWLAYOUT_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */