Line data    Source code

       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             : 
      21             : 
      22             : #ifndef INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MODIFIEDCOLORPRIMITIVE2D_HXX
      23             : #define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MODIFIEDCOLORPRIMITIVE2D_HXX
      24             : 
      25             : #include <drawinglayer/drawinglayerdllapi.h>
      26             : 
      27             : #include <drawinglayer/primitive2d/groupprimitive2d.hxx>
      28             : #include <basegfx/color/bcolormodifier.hxx>
      29             : 
      30             : 
      31             : 
      32             : namespace drawinglayer
      33             : {
      34             :     namespace primitive2d
      35             :     {
      36             :         /** ModifiedColorPrimitive2D class
      37             : 
      38             :             This primitive is a grouping primitive and allows to define
      39             :             how the colors of its child content shall be modified for
      40             :             visualisation. This can be (and is) used e.g. for generic shadow
      41             :             visualisation by forcing all color usages of the contained
      42             :             sub-content to the shadow color.
      43             : 
      44             :             For the possibilities of color modifications, please refer
      45             :             to the basegfx::BColorModifier definitions in basegfx. For
      46             :             processing there is tooling in basegfx to build a stack of
      47             :             BColorModifierSharedPtrs to always be able to proccess the correct
      48             :             colors.
      49             : 
      50             :             If a renderer does not handle this primitive, the content will
      51             :             be visualized unchanged.
      52             :          */
      53           0 :         class DRAWINGLAYER_DLLPUBLIC ModifiedColorPrimitive2D : public GroupPrimitive2D
      54             :         {
      55             :         private:
      56             :             /// The ColorModifier to use
      57             :             basegfx::BColorModifierSharedPtr    maColorModifier;
      58             : 
      59             :         public:
      60             :             /// constructor
      61             :             ModifiedColorPrimitive2D(
      62             :                 const Primitive2DSequence& rChildren,
      63             :                 const basegfx::BColorModifierSharedPtr& rColorModifier);
      64             : 
      65             :             /// data read access
      66           0 :             const basegfx::BColorModifierSharedPtr& getColorModifier() const { return maColorModifier; }
      67             : 
      68             :             /// compare operator
      69             :             virtual bool operator==(const BasePrimitive2D& rPrimitive) const SAL_OVERRIDE;
      70             : 
      71             :             /// provide unique ID
      72             :             DeclPrimitive2DIDBlock()
      73             :         };
      74             :     } // end of namespace primitive2d
      75             : } // end of namespace drawinglayer
      76             : 
      77             : 
      78             : 
      79             : #endif //INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MODIFIEDCOLORPRIMITIVE2D_HXX
      80             : 
      81             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */