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