include/drawinglayer/attribute/fillgradientattribute.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_DRAWINGLAYER_ATTRIBUTE_FILLGRADIENTATTRIBUTE_HXX
  21 #define INCLUDED_DRAWINGLAYER_ATTRIBUTE_FILLGRADIENTATTRIBUTE_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24 #include <o3tl/cow_wrapper.hxx>
  25
  26
  27 // predefines
  28
  29 namespace basegfx {
  30     class BColor;
  31 }
  32
  33 namespace drawinglayer::attribute {
  34     class ImpFillGradientAttribute;
  35 }
  36
  37
  38 namespace drawinglayer::attribute
  39     {
  40         enum class GradientStyle
  41         {
  42             Linear,
  43             Axial,
  44             Radial,
  45             Elliptical,
  46             Square,
  47             Rect
  48         };
  49
  50 } // end of namespace drawinglayer::attribute
  51
  52
  53 namespace drawinglayer::attribute
  54     {
  55         class DRAWINGLAYER_DLLPUBLIC FillGradientAttribute
  56         {
  57         public:
  58             typedef o3tl::cow_wrapper< ImpFillGradientAttribute > ImplType;
  59
  60         private:
  61             ImplType mpFillGradientAttribute;
  62
  63         public:
  64             /// constructors/assignmentoperator/destructor
  65             FillGradientAttribute(
  66                 GradientStyle eStyle,
  67                 double fBorder,
  68                 double fOffsetX,
  69                 double fOffsetY,
  70                 double fAngle,
  71                 const basegfx::BColor& rStartColor,
  72                 const basegfx::BColor& rEndColor,
  73                 sal_uInt16 nSteps);
  74             FillGradientAttribute();
  75             FillGradientAttribute(const FillGradientAttribute&);
  76             FillGradientAttribute(FillGradientAttribute&&);
  77             FillGradientAttribute& operator=(const FillGradientAttribute&);
  78             FillGradientAttribute& operator=(FillGradientAttribute&&);
  79             ~FillGradientAttribute();
  80
  81             // checks if the incarnation is default constructed
  82             bool isDefault() const;
  83
  84             // compare operator
  85             bool operator==(const FillGradientAttribute& rCandidate) const;
  86
  87             // data read access
  88             GradientStyle getStyle() const;
  89             double getBorder() const;
  90             double getOffsetX() const;
  91             double getOffsetY() const;
  92             double getAngle() const;
  93             const basegfx::BColor& getStartColor() const;
  94             const basegfx::BColor& getEndColor() const;
  95             sal_uInt16 getSteps() const;
  96         };
  97
  98 } // end of namespace drawinglayer::attribute
  99
 100
 101 #endif //INCLUDED_DRAWINGLAYER_ATTRIBUTE_FILLGRADIENTATTRIBUTE_HXX
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */