Branch data     Line data    Source code

       1                 :            : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2                 :            : /*************************************************************************
       3                 :            :  *
       4                 :            :  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
       5                 :            :  *
       6                 :            :  * Copyright 2000, 2010 Oracle and/or its affiliates.
       7                 :            :  *
       8                 :            :  * OpenOffice.org - a multi-platform office productivity suite
       9                 :            :  *
      10                 :            :  * This file is part of OpenOffice.org.
      11                 :            :  *
      12                 :            :  * OpenOffice.org is free software: you can redistribute it and/or modify
      13                 :            :  * it under the terms of the GNU Lesser General Public License version 3
      14                 :            :  * only, as published by the Free Software Foundation.
      15                 :            :  *
      16                 :            :  * OpenOffice.org is distributed in the hope that it will be useful,
      17                 :            :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      18                 :            :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      19                 :            :  * GNU Lesser General Public License version 3 for more details
      20                 :            :  * (a copy is included in the LICENSE file that accompanied this code).
      21                 :            :  *
      22                 :            :  * You should have received a copy of the GNU Lesser General Public License
      23                 :            :  * version 3 along with OpenOffice.org.  If not, see
      24                 :            :  * <http://www.openoffice.org/license.html>
      25                 :            :  * for a copy of the LGPLv3 License.
      26                 :            :  *
      27                 :            :  ************************************************************************/
      28                 :            : 
      29                 :            : #ifndef INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MODIFIEDCOLORPRIMITIVE2D_HXX
      30                 :            : #define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MODIFIEDCOLORPRIMITIVE2D_HXX
      31                 :            : 
      32                 :            : #include <drawinglayer/drawinglayerdllapi.h>
      33                 :            : 
      34                 :            : #include <drawinglayer/primitive2d/groupprimitive2d.hxx>
      35                 :            : #include <basegfx/color/bcolormodifier.hxx>
      36                 :            : 
      37                 :            : //////////////////////////////////////////////////////////////////////////////
      38                 :            : 
      39                 :            : namespace drawinglayer
      40                 :            : {
      41                 :            :     namespace primitive2d
      42                 :            :     {
      43                 :            :         /** ModifiedColorPrimitive2D class
      44                 :            : 
      45                 :            :             This primitive is a grouping primitive and allows to define
      46                 :            :             how the colors of it's child content shall be modified for
      47                 :            :             visualisation. This can be (and is) used e.g. for generic shadow
      48                 :            :             visualisation by forcing all color usages of the contained
      49                 :            :             sub-content to the shadow color.
      50                 :            : 
      51                 :            :             For the possibilities of color modifications, please refer
      52                 :            :             to the basegfx::BColorModifier definitions in basegfx. For
      53                 :            :             processing there is tooling in basegfx to build a stack of
      54                 :            :             BColorModifiers to always be able to proccess the correct
      55                 :            :             colors.
      56                 :            : 
      57                 :            :             If a renderer does not handle this primitive, the content will
      58                 :            :             be visualized unchanged.
      59                 :            :          */
      60 [ +  - ][ -  + ]:       1360 :         class DRAWINGLAYER_DLLPUBLIC ModifiedColorPrimitive2D : public GroupPrimitive2D
      61                 :            :         {
      62                 :            :         private:
      63                 :            :             /// The ColorModifier to use
      64                 :            :             basegfx::BColorModifier                 maColorModifier;
      65                 :            : 
      66                 :            :         public:
      67                 :            :             /// constructor
      68                 :            :             ModifiedColorPrimitive2D(
      69                 :            :                 const Primitive2DSequence& rChildren,
      70                 :            :                 const basegfx::BColorModifier& rColorModifier);
      71                 :            : 
      72                 :            :             /// data read access
      73                 :        726 :             const basegfx::BColorModifier& getColorModifier() const { return maColorModifier; }
      74                 :            : 
      75                 :            :             /// compare operator
      76                 :            :             virtual bool operator==(const BasePrimitive2D& rPrimitive) const;
      77                 :            : 
      78                 :            :             /// provide unique ID
      79                 :            :             DeclPrimitrive2DIDBlock()
      80                 :            :         };
      81                 :            :     } // end of namespace primitive2d
      82                 :            : } // end of namespace drawinglayer
      83                 :            : 
      84                 :            : //////////////////////////////////////////////////////////////////////////////
      85                 :            : 
      86                 :            : #endif //INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MODIFIEDCOLORPRIMITIVE2D_HXX
      87                 :            : 
      88                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */