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