include/drawinglayer/attribute/fillhatchattribute.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_FILLHATCHATTRIBUTE_HXX
  21 #define INCLUDED_DRAWINGLAYER_ATTRIBUTE_FILLHATCHATTRIBUTE_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 ImpFillHatchAttribute;
  35 }
  36
  37
  38 namespace drawinglayer::attribute
  39     {
  40         enum class HatchStyle
  41         {
  42             Single,
  43             Double,
  44             Triple
  45         };
  46
  47 } // end of namespace drawinglayer::attribute
  48
  49
  50 namespace drawinglayer::attribute
  51     {
  52         class DRAWINGLAYER_DLLPUBLIC FillHatchAttribute
  53         {
  54         public:
  55             typedef o3tl::cow_wrapper< ImpFillHatchAttribute > ImplType;
  56
  57         private:
  58             ImplType mpFillHatchAttribute;
  59
  60         public:
  61             /// constructors/assignmentoperator/destructor
  62             FillHatchAttribute(
  63                 HatchStyle eStyle,
  64                 double fDistance,
  65                 double fAngle,
  66                 const basegfx::BColor& rColor,
  67                 sal_uInt32 nMinimalDiscreteDistance,
  68                 bool bFillBackground);
  69             FillHatchAttribute();
  70             FillHatchAttribute(const FillHatchAttribute&);
  71             FillHatchAttribute(FillHatchAttribute&&);
  72             FillHatchAttribute& operator=(const FillHatchAttribute&);
  73             FillHatchAttribute& operator=(FillHatchAttribute&&);
  74             ~FillHatchAttribute();
  75
  76             // checks if the incarnation is default constructed
  77             bool isDefault() const;
  78
  79             // compare operator
  80             bool operator==(const FillHatchAttribute& rCandidate) const;
  81
  82             // data read access
  83             HatchStyle getStyle() const;
  84             double getDistance() const;
  85             double getAngle() const;
  86             const basegfx::BColor& getColor() const;
  87
  88             // #i120230# If a minimal discrete distance is wanted (VCL used 3,
  89             // this is the default for the global instance, too), set this
  90             // unequal to zero. Zero means not to use it. If set bigger zero
  91             // (should be at least two, one leads to a full plane filled with
  92             // lines when Distance in discrete views is smaller than one) this
  93             // will be used when the discrete value is less than the given one.
  94             // This is used to 'emulate' old VCL behaviour which makes hatches
  95             // look better by not making distances as small as needed, but
  96             // keeping them on a minimal discrete value for more appealing
  97             // visualisation.
  98             sal_uInt32 getMinimalDiscreteDistance() const;
  99
 100             bool isFillBackground() const;
 101         };
 102
 103 } // end of namespace drawinglayer::attribute
 104
 105
 106 #endif //INCLUDED_DRAWINGLAYER_ATTRIBUTE_FILLHATCHATTRIBUTE_HXX
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */