include/svx/sdr/properties/defaultproperties.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_SVX_SDR_PROPERTIES_DEFAULTPROPERTIES_HXX
  21 #define INCLUDED_SVX_SDR_PROPERTIES_DEFAULTPROPERTIES_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <memory>
  26
  27 #include <svx/sdr/properties/properties.hxx>
  28 #include <svx/svxdllapi.h>
  29
  30 struct _xmlTextWriter;
  31 typedef struct _xmlTextWriter* xmlTextWriterPtr;
  32
  33 namespace sdr::properties
  34     {
  35         class SVXCORE_DLLPUBLIC DefaultProperties : public BaseProperties
  36         {
  37         protected:
  38             // the to be used ItemSet
  39             std::unique_ptr<SfxItemSet> mpItemSet;
  40
  41             // create a new itemset
  42             virtual std::unique_ptr<SfxItemSet> CreateObjectSpecificItemSet(SfxItemPool& rPool) override;
  43
  44             // test changeability for a single item
  45             virtual bool AllowItemChange(const sal_uInt16 nWhich, const SfxPoolItem* pNewItem = nullptr) const override;
  46
  47             // Do the ItemChange, may do special handling
  48             virtual void ItemChange(const sal_uInt16 nWhich, const SfxPoolItem* pNewItem = nullptr) override;
  49
  50             // Called after ItemChange() is done for all items.
  51             virtual void PostItemChange(const sal_uInt16 nWhich) override;
  52
  53             // react on ItemSet changes
  54             virtual void ItemSetChanged(const SfxItemSet& rSet) override;
  55
  56             // check if SfxItemSet exists
  57             bool HasSfxItemSet() const { return bool(mpItemSet); }
  58
  59         public:
  60             // basic constructor
  61             explicit DefaultProperties(SdrObject& rObj);
  62
  63             // constructor for copying, but using new object
  64             DefaultProperties(const DefaultProperties& rProps, SdrObject& rObj);
  65
  66             // destructor
  67             virtual ~DefaultProperties() override;
  68
  69             void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  70
  71             // Clone() operator, normally just calls the local copy constructor
  72             virtual std::unique_ptr<BaseProperties> Clone(SdrObject& rObj) const override;
  73
  74             // get itemset
  75             virtual const SfxItemSet& GetObjectItemSet() const override;
  76
  77             // set single item
  78             virtual void SetObjectItem(const SfxPoolItem& rItem) override;
  79
  80             // set single item direct, do not do any notifies or things like that
  81             virtual void SetObjectItemDirect(const SfxPoolItem& rItem) override;
  82
  83             // clear single item
  84             virtual void ClearObjectItem(const sal_uInt16 nWhich = 0) override;
  85
  86             // clear single item direct, do not do any notifies or things like that.
  87             // Also supports complete deletion of items when default parameter 0 is used.
  88             virtual void ClearObjectItemDirect(const sal_uInt16 nWhich) override;
  89
  90             // set complete item set
  91             virtual void SetObjectItemSet(const SfxItemSet& rSet) override;
  92
  93             // set a new StyleSheet and broadcast
  94             virtual void SetStyleSheet(SfxStyleSheet* pNewStyleSheet, bool bDontRemoveHardAttr) override;
  95
  96             // get the installed StyleSheet
  97             virtual SfxStyleSheet* GetStyleSheet() const override;
  98
  99             // force default attributes for a specific object type, called from
 100             // DefaultProperties::GetObjectItemSet() if a new ItemSet is created.
 101             // Default implementation does nothing.
 102             virtual void ForceDefaultAttributes();
 103         };
 104
 105 } // end of namespace sdr::properties
 106
 107 #endif // INCLUDED_SVX_SDR_PROPERTIES_DEFAULTPROPERTIES_HXX
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */