include/editeng/colritem.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 #ifndef INCLUDED_EDITENG_COLRITEM_HXX
  20 #define INCLUDED_EDITENG_COLRITEM_HXX
  21
  22 #include <svl/poolitem.hxx>
  23 #include <tools/color.hxx>
  24 #include <editeng/editengdllapi.h>
  25 #include <docmodel/color/ComplexColor.hxx>
  26
  27 #define VERSION_USEAUTOCOLOR    1
  28
  29 /** SvxColorItem item describes a color.
  30 */
  31 class EDITENG_DLLPUBLIC SvxColorItem final : public SfxPoolItem
  32 {
  33 private:
  34     Color mColor;
  35     model::ComplexColor maComplexColor;
  36
  37 public:
  38     static SfxPoolItem* CreateDefault();
  39
  40     explicit SvxColorItem(const sal_uInt16 nId);
  41     SvxColorItem(const Color& aColor, const sal_uInt16 nId);
  42     SvxColorItem(const Color& aColor, model::ComplexColor const& rComplexColor, const sal_uInt16 nId);
  43     virtual ~SvxColorItem() override;
  44
  45     // "pure virtual Methods" from SfxPoolItem
  46     virtual bool operator==(const SfxPoolItem& rPoolItem) const override;
  47     virtual bool supportsHashCode() const override { return true; }
  48     virtual size_t hashCode() const override;
  49     virtual bool QueryValue(css::uno::Any& rVal, sal_uInt8 nMemberId = 0) const override;
  50     virtual bool PutValue(const css::uno::Any& rVal, sal_uInt8 nMemberId) override;
  51
  52     virtual bool GetPresentation(SfxItemPresentation ePres,
  53                                  MapUnit eCoreMetric, MapUnit ePresMetric,
  54                                  OUString &rText, const IntlWrapper& rIntlWrapper) const override;
  55
  56     virtual SvxColorItem* Clone(SfxItemPool* pPool = nullptr) const override;
  57     SvxColorItem(SvxColorItem const &) = default; // SfxPoolItem copy function dichotomy
  58
  59     const Color& GetValue() const
  60     {
  61         return mColor;
  62     }
  63     void SetValue(const Color& rNewColor)
  64     {
  65         ASSERT_CHANGE_REFCOUNTED_ITEM;
  66         mColor = rNewColor;
  67     }
  68
  69     const Color& getColor() const
  70     {
  71         return mColor;
  72     }
  73     void setColor(const Color& rNewColor)
  74     {
  75         ASSERT_CHANGE_REFCOUNTED_ITEM;
  76         mColor = rNewColor;
  77     }
  78
  79     model::ComplexColor const& getComplexColor() const { return maComplexColor; }
  80     void setComplexColor(model::ComplexColor const& rComplexColor) { ASSERT_CHANGE_REFCOUNTED_ITEM; maComplexColor = rComplexColor; }
  81
  82     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  83 };
  84
  85 #endif
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */