cppcanvas/source/mtfrenderer/transparencygroupaction.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 #ifndef INCLUDED_CPPCANVAS_SOURCE_MTFRENDERER_TRANSPARENCYGROUPACTION_HXX
  21 #define INCLUDED_CPPCANVAS_SOURCE_MTFRENDERER_TRANSPARENCYGROUPACTION_HXX
  22
  23 #include <cppcanvas/canvas.hxx>
  24 #include <cppcanvas/renderer.hxx>
  25 #include <action.hxx>
  26
  27 #include <memory>
  28
  29 namespace basegfx {
  30     class B2DPoint;
  31     class B2DVector;
  32 }
  33
  34 class GDIMetaFile;
  35 class Gradient;
  36
  37
  38 /* Definition of internal::TransparencyGroupActionFactory */
  39
  40 namespace cppcanvas
  41 {
  42     namespace internal
  43     {
  44         struct OutDevState;
  45
  46         typedef ::std::unique_ptr< GDIMetaFile >  MtfAutoPtr;
  47         typedef ::std::unique_ptr< Gradient >     GradientAutoPtr;
  48
  49         /** Transparency group action.
  50
  51             This action groups a bunch of other actions, to be
  52             rendered with the given transparency setting against the
  53             background.
  54
  55             Creates encapsulated converters between GDIMetaFile and
  56             XCanvas. The Canvas argument is deliberately placed at the
  57             constructor, to force reconstruction of this object for a
  58             new canvas. This considerably eases internal state
  59             handling, since a lot of the internal state (e.g. fonts,
  60             text layout) is Canvas-dependent.
  61          */
  62         namespace TransparencyGroupActionFactory
  63         {
  64             /** Create new transparency group action.
  65
  66                 @param rGroupMtf
  67                 Metafile that groups all actions to be rendered
  68                 transparent.
  69
  70                 @param rAlphaGradient
  71                 VCL gradient, to be rendered into the action's alpha
  72                 channel.
  73
  74                 @param rParms
  75                 Render parameters
  76
  77                 @param rDstPoint
  78                 Left, top edge of destination, in current state
  79                 coordinate system
  80
  81                 @param rDstSize
  82                 Size of the transparency group object, in current
  83                 state coordinate system.
  84              */
  85             ActionSharedPtr createTransparencyGroupAction( MtfAutoPtr&&                  rGroupMtf,
  86                                                                   GradientAutoPtr&&             rAlphaGradient,
  87                                                                   const Renderer::Parameters&   rParms,
  88                                                                   const ::basegfx::B2DPoint&    rDstPoint,
  89                                                                   const ::basegfx::B2DVector&   rDstSize,
  90                                                                   const CanvasSharedPtr&        rCanvas,
  91                                                                   const OutDevState&            rState );
  92         }
  93     }
  94 }
  95
  96 #endif // INCLUDED_CPPCANVAS_SOURCE_MTFRENDERER_TRANSPARENCYGROUPACTION_HXX
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */