1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SVX_SDR_PROPERTIES_PROPERTIES_HXX
#define INCLUDED_SVX_SDR_PROPERTIES_PROPERTIES_HXX
#include <sal/config.h>
#include <memory>
#include <sal/types.h>
#include <svx/svxdllapi.h>
#include <svl/typedwhich.hxx>
class SdrObject;
class SfxItemSet;
class SfxPoolItem;
class SfxStyleSheet;
class Fraction;
class SfxItemPool;
class SdrModel;
namespace sdr
{
namespace properties
{
class ItemChangeBroadcaster;
}
}
namespace sdr
{
namespace properties
{
class SVX_DLLPUBLIC BaseProperties
{
private:
// the owner of this Properties. Set from constructor and not
// to be changed in any way.
SdrObject& mrObject;
protected:
// create a new object specific itemset with object specific ranges.
virtual std::unique_ptr<SfxItemSet> CreateObjectSpecificItemSet(SfxItemPool& pPool) = 0;
// internal access to SdrObject
const SdrObject& GetSdrObject() const;
SdrObject& GetSdrObject();
// Test changeability for a single item. If a implementation wants to prevent
// changing an item it should override this method.
virtual bool AllowItemChange(const sal_uInt16 nWhich, const SfxPoolItem* pNewItem = nullptr) const = 0;
// Do the internal ItemChange. If only nWhich is given, the item needs to be cleared.
// Also needs to handle if nWhich and pNewItem is 0, which means to clear all items.
virtual void ItemChange(const sal_uInt16 nWhich, const SfxPoolItem* pNewItem = nullptr) = 0;
// Called after ItemChange() is done for all items. Allows local reactions on
// specific item changes
virtual void PostItemChange(const sal_uInt16 nWhich) = 0;
// Internally react on ItemSet changes. The given ItemSet contains all changed items, the new ones.
virtual void ItemSetChanged(const SfxItemSet& rSet) = 0;
public:
// basic constructor, used from SdrObject.
explicit BaseProperties(SdrObject& rObj);
// destructor
virtual ~BaseProperties();
// Clone() operator, normally just calls the local copy constructor,
// see above.
virtual BaseProperties& Clone(SdrObject& rObj) const = 0;
// Get the local ItemSet. This directly returns the local ItemSet of the object. No
// merging of ItemSets is done for e.g. Group objects.
virtual const SfxItemSet& GetObjectItemSet() const = 0;
// get merged ItemSet. Normally, this maps directly to GetObjectItemSet(), but may
// be overridden e.g for group objects to return a merged ItemSet of the object.
// When using this method the returned ItemSet may contain items in the state
// SfxItemState::DONTCARE which means there were several such items with different
// values.
virtual const SfxItemSet& GetMergedItemSet() const;
// Sets all items which are on state SfxItemState::SET in rSet at the local ItemSet.
// Uses AllowItemChange(), ItemChange(), PostItemChange() and ItemSetChanged() calls.
virtual void SetObjectItemSet(const SfxItemSet& rSet) = 0;
// Set merged ItemSet. Normally, this maps to SetObjectItemSet().
virtual void SetMergedItemSet(const SfxItemSet& rSet, bool bClearAllItems = false);
// Set single item at the local ItemSet. Uses AllowItemChange(),
// ItemChange(), PostItemChange() and ItemSetChanged() calls.
virtual void SetObjectItem(const SfxPoolItem& rItem) = 0;
// Set a single item direct. Only uses AllowItemChange() and ItemChange(),
// but not PostItemChange() and ItemSetChanged() calls.
virtual void SetObjectItemDirect(const SfxPoolItem& rItem) = 0;
// Clear a single local item. Uses AllowItemChange(),
// ItemChange(), PostItemChange() and ItemSetChanged() calls.
virtual void ClearObjectItem(const sal_uInt16 nWhich = 0) = 0;
// Set a single item, iterate over hierarchies if necessary. Default
// Implementation falls back to ClearObjectItem().
virtual void SetMergedItem(const SfxPoolItem& rItem);
// Clear a single item, iterate over hierarchies if necessary. Default
// Implementation falls back to ClearObjectItem().
virtual void ClearMergedItem(const sal_uInt16 nWhich);
// Clear single item direct. Only uses AllowItemChange() and ItemChange(),
// but not PostItemChange() and ItemSetChanged() calls.
// Also supports complete deletion of items when default parameter 0 is used.
virtual void ClearObjectItemDirect(const sal_uInt16 nWhich) = 0;
// Set a new StyleSheet. Registers as listener at the StyleSheet to get knowledge
// of StyleSheet changes.
virtual void SetStyleSheet(SfxStyleSheet* pNewStyleSheet, bool bDontRemoveHardAttr) = 0;
// Get the installed StyleSheet.
virtual SfxStyleSheet* GetStyleSheet() const = 0;
// Move local items to a new ItemPool.
// Override this to do it for hierarchical objects like e.g. groups.
virtual void MoveToItemPool(SfxItemPool* pSrcPool, SfxItemPool* pDestPool, SdrModel* pNewModel);
// Set new model.
virtual void SetModel(SdrModel* pOldModel, SdrModel* pNewModel);
// force all attributes which come from styles to hard attributes
// to be able to live without the style.
virtual void ForceStyleToHardAttributes();
// syntactical sugar for ItemSet accesses. Broadcasts before and after the changes
// to invalidate views in old and new BoundRects. As soon as the repaint mechanism
// will be changed these broadcasts will no longer be needed.
//void SetItemAndBroadcast(const SfxPoolItem& rItem);
//void ClearItemAndBroadcast(const sal_uInt16 nWhich = 0);
void SetMergedItemSetAndBroadcast(const SfxItemSet& rSet, bool bClearAllItems = false);
// Just a convenient shortcut for GetObjectItemSet().Get(nWhich).
const SfxPoolItem& GetItem(const sal_uInt16 nWhich) const;
template<class T> const T& GetItem(TypedWhichId<T> nWhich) const
{
return static_cast<const T&>(GetItem(sal_uInt16(nWhich)));
}
// support for convenient broadcasting. Used from SetMergedItemAndBroadcast(),
// ClearItemAndBroadcast() and SetItemSetAndBroadcast(), see above.
// But also from inside SdrObjects.
void BroadcastItemChange(const ItemChangeBroadcaster& rChange);
// #i101556# add versioning mechanism; used from e.g. text attribute set to
// allow detection of e.g. style sheet or single text attribute changes. The
// default implementation returns 0 (zero)
virtual sal_uInt32 getVersion() const;
};
// checks the FillStyle item and removes unneeded Gradient, FillBitmap and Hatch items
void SVX_DLLPUBLIC CleanupFillProperties( SfxItemSet& rItemSet );
} // end of namespace properties
} // end of namespace sdr
#endif // INCLUDED_SVX_SDR_PROPERTIES_PROPERTIES_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
