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