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