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