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