include/drawinglayer/primitive2d/pagepreviewprimitive2d.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <drawinglayer/drawinglayerdllapi.h>
  23
  24 #include <drawinglayer/primitive2d/BufferedDecompositionPrimitive2D.hxx>
  25 #include <basegfx/matrix/b2dhommatrix.hxx>
  26
  27 namespace com::sun::star::drawing { class XDrawPage; }
  28
  29
  30 namespace drawinglayer::primitive2d
  31 {
  32         /** PagePreviewPrimitive2D class
  33
  34             This primitive is needed to have the correct XDrawPage as ViewInformation for decomposing
  35             the page contents (given as PageContent here) if these contain e.g.
  36             view-dependent (in this case XDrawPage-dependent) text fields like PageNumber. If You want
  37             those primitives to be visualized correctly, Your renderer needs to locally correct its
  38             ViewInformation2D to reference the new XDrawPage.
  39          */
  40         class DRAWINGLAYER_DLLPUBLIC PagePreviewPrimitive2D final : public BufferedDecompositionPrimitive2D
  41         {
  42         private:
  43             /** the XDrawPage visualized by this primitive. When we go forward with primitives
  44                 this will not only be used by the renderers to provide the correct decompose
  45                 graphic attribute context, but also to completely create the page's sub-content.
  46              */
  47             const css::uno::Reference< css::drawing::XDrawPage > mxDrawPage;
  48
  49             /// the PageContent
  50             Primitive2DContainer                           maPageContent;
  51
  52             /// the own geometry
  53             basegfx::B2DHomMatrix                       maTransform;
  54
  55             /// content width and height
  56             double                                      mfContentWidth;
  57             double                                      mfContentHeight;
  58
  59             /// local decomposition. Implementation will just return children
  60             virtual Primitive2DReference create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const override;
  61
  62         public:
  63             /// constructor
  64             PagePreviewPrimitive2D(
  65                 css::uno::Reference< css::drawing::XDrawPage > xDrawPage,
  66                 basegfx::B2DHomMatrix aTransform,
  67                 double fContentWidth,
  68                 double fContentHeight,
  69                 Primitive2DContainer&& rPageContent);
  70
  71             /// data read access
  72             const css::uno::Reference< css::drawing::XDrawPage >& getXDrawPage() const { return mxDrawPage; }
  73             const Primitive2DContainer& getPageContent() const { return maPageContent; }
  74             const basegfx::B2DHomMatrix& getTransform() const { return maTransform; }
  75             double getContentWidth() const { return mfContentWidth; }
  76             double getContentHeight() const { return mfContentHeight; }
  77
  78             /// compare operator
  79             virtual bool operator==(const BasePrimitive2D& rPrimitive) const override;
  80
  81             /// own getB2DRange
  82             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const override;
  83
  84             /// provide unique ID
  85             virtual sal_uInt32 getPrimitive2DID() const override;
  86         };
  87 } // end of namespace drawinglayer::primitive2d
  88
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */