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
  26 class SvXMLUnitConverter;
  27
  28 #define VERSION_USEAUTOCOLOR    1
  29
  30 /** SvxColorItem item describes a color.
  31 */
  32 class EDITENG_DLLPUBLIC SvxColorItem : public SfxPoolItem
  33 {
  34 private:
  35     Color mColor;
  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(SvStream& rStream, const sal_uInt16 nId);
  43     SvxColorItem(const SvxColorItem& rCopy);
  44     virtual ~SvxColorItem() override;
  45
  46     // "pure virtual Methods" from SfxPoolItem
  47     virtual bool operator==(const SfxPoolItem& rPoolItem) const override;
  48     virtual bool QueryValue(css::uno::Any& rVal, sal_uInt8 nMemberId = 0) const override;
  49     virtual bool PutValue(const css::uno::Any& rVal, sal_uInt8 nMemberId) override;
  50     virtual sal_uInt16 GetVersion(sal_uInt16 nFileVersion) const override;
  51
  52     virtual bool GetPresentation(SfxItemPresentation ePres,
  53                                  MapUnit eCoreMetric, MapUnit ePresMetric,
  54                                  OUString &rText, const IntlWrapper* pIntlWrapper = nullptr) const override;
  55
  56     virtual SfxPoolItem* Clone(SfxItemPool* pPool = nullptr) const override;
  57     virtual SfxPoolItem* Create(SvStream& rStream, sal_uInt16 nVersion) const override;
  58     virtual SvStream& Store(SvStream& rStream, sal_uInt16 nVersion) const override;
  59
  60     SvxColorItem& operator=(const SvxColorItem& rColor)
  61     {
  62         SetValue(rColor.GetValue());
  63         return *this;
  64     }
  65
  66     const Color& GetValue() const
  67     {
  68         return mColor;
  69     }
  70     void SetValue(const Color& rNewColor);
  71 };
  72
  73 // XXX: to be moved in a separate header.
  74 class EDITENG_DLLPUBLIC SvxBackgroundColorItem : public SvxColorItem
  75 {
  76     public:
  77         static SfxPoolItem* CreateDefault();
  78
  79         SvxBackgroundColorItem(const sal_uInt16 nId);
  80         SvxBackgroundColorItem(const Color& rCol, const sal_uInt16 nId);
  81         SvxBackgroundColorItem(SvStream& rStrm, const sal_uInt16 nId);
  82         SvxBackgroundColorItem(const SvxBackgroundColorItem& rCopy);
  83
  84         virtual SfxPoolItem* Clone(SfxItemPool* pPool = nullptr) const override;
  85         virtual SvStream& Store(SvStream& rStream, sal_uInt16 nVersion) const override;
  86         virtual SfxPoolItem* Create(SvStream &, sal_uInt16) const override;
  87         virtual bool QueryValue(css::uno::Any& rVal, sal_uInt8 nMemberId = 0) const override;
  88         virtual bool PutValue(const css::uno::Any& rVal, sal_uInt8 nMemberId) override;
  89 };
  90
  91 #endif
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */