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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
|
/* -*- 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_SVL_STYLE_HXX
#define INCLUDED_SVL_STYLE_HXX
#include <com/sun/star/style/XStyle.hpp>
#include <com/sun/star/lang/XUnoTunnel.hpp>
#include <rtl/ref.hxx>
#include <comphelper/weak.hxx>
#include <cppuhelper/implbase2.hxx>
#include <svl/svldllapi.h>
#include <rsc/rscsfx.hxx>
#include <svl/hint.hxx>
#include <svl/lstner.hxx>
#include <svl/poolitem.hxx>
#include <svl/SfxBroadcaster.hxx>
#include <svl/stylesheetuser.hxx>
#include <svl/style.hrc>
#include <memory>
class SfxItemSet;
class SfxItemPool;
class SfxStyleSheetBasePool;
class SvStream;
namespace svl { class IndexedStyleSheets; }
/*
Everyone changing instances of SfxStyleSheetBasePool or SfxStyleSheetBase
must broadcast this using <SfxStyleSheetBasePool::GetBroadcaster()> broadcasts.
The class <SfxStyleSheetHint> is used for this, it contains an Action-Id and a
pointer to the <SfxStyleSheetBase>. The actions are:
#define SfxStyleSheetHintId::CREATED // style is created
#define SfxStyleSheetHintId::MODIFIED // style is modified
#define SfxStyleSheetHintId::CHANGED // style is replaced
#define SfxStyleSheetHintId::ERASED // style is deleted
The following methods already broadcast themself
SfxSimpleHint(SFX_HINT_DYING) from:
SfxStyleSheetBasePool::~SfxStyleSheetBasePool()
SfxStyleSheetHint( SfxStyleSheetHintId::CREATED, *p ) from:
SfxStyleSheetBasePool::Make( const String& rName,
SfxStyleFamily eFam, sal_uInt16 mask)
SfxStyleSheetHint( SfxStyleSheetHintId::CHANGED, *pNew ) from:
SfxStyleSheetBasePool::Add( SfxStyleSheetBase& rSheet )
SfxStyleSheetHint( SfxStyleSheetHintId::ERASED, *p ) from:
SfxStyleSheetBasePool::Erase( SfxStyleSheetBase* p )
SfxStyleSheetBasePool::Clear()
*/
class SVL_DLLPUBLIC SfxStyleSheetBase : public comphelper::OWeakTypeObject
{
private:
friend class SfxStyleSheetBasePool;
SVL_DLLPRIVATE static SfxStyleSheetBasePool& implGetStaticPool();
protected:
SfxStyleSheetBasePool* pPool; // related pool
SfxStyleFamily nFamily;
OUString aName, aParent, aFollow;
OUString maDisplayName;
OUString aHelpFile; // name of the help file
SfxItemSet* pSet; // ItemSet
sal_uInt16 nMask; // Flags
sal_uLong nHelpId; // help ID
bool bMySet; // sal_True: delete Set in dtor
bool bHidden;
SfxStyleSheetBase( const OUString&, SfxStyleSheetBasePool*, SfxStyleFamily eFam, sal_uInt16 mask );
SfxStyleSheetBase( const SfxStyleSheetBase& );
virtual ~SfxStyleSheetBase();
virtual void Load( SvStream&, sal_uInt16 );
virtual void Store( SvStream& );
public:
TYPEINFO();
// returns the internal name of this style
virtual const OUString& GetName() const;
// sets the internal name of this style.
//
// If the name of a style is changed, then the styles container needs to be
// reindexed (see IndexedStyleSheets). If you set bReindexNow to false to
// defer that indexing, then you must call the Reindex manually on the
// SfxStyleSheetBasePool parent.
virtual bool SetName(const OUString& rNewName, bool bReindexNow = true);
/** returns the display name of this style, it is used at the user interface.
If the display name is empty, this method returns the internal name. */
OUString GetDisplayName() const;
virtual const OUString& GetParent() const;
virtual bool SetParent( const OUString& );
virtual const OUString& GetFollow() const;
virtual bool SetFollow( const OUString& );
virtual bool HasFollowSupport() const; // Default true
virtual bool HasParentSupport() const; // Default true
virtual bool HasClearParentSupport() const; // Default false
virtual bool IsUsed() const; // Default true
virtual OUString GetDescription( SfxMapUnit eMetric );
SfxStyleSheetBasePool& GetPool() { return *pPool; }
SfxStyleFamily GetFamily() const { return nFamily; }
sal_uInt16 GetMask() const { return nMask; }
void SetMask( sal_uInt16 mask) { nMask = mask; }
bool IsUserDefined() const
{ return ( nMask & SFXSTYLEBIT_USERDEF) != 0; }
virtual bool IsHidden() const { return bHidden; }
virtual void SetHidden( bool bValue );
virtual sal_uLong GetHelpId( OUString& rFile );
virtual void SetHelpId( const OUString& r, sal_uLong nId );
virtual SfxItemSet& GetItemSet();
};
/* Class to iterate and search on a SfxStyleSheetBasePool */
class SVL_DLLPUBLIC SfxStyleSheetIterator
{
public:
/** Constructor.
* The iterator will only iterate over style sheets which have the family \p eFam
*/
SfxStyleSheetIterator(SfxStyleSheetBasePool *pBase,
SfxStyleFamily eFam, sal_uInt16 n=SFXSTYLEBIT_ALL );
sal_uInt16 GetSearchMask() const;
SfxStyleFamily GetSearchFamily() const;
virtual sal_uInt16 Count();
virtual SfxStyleSheetBase *operator[](sal_uInt16 nIdx);
virtual SfxStyleSheetBase* First();
virtual SfxStyleSheetBase* Next();
virtual SfxStyleSheetBase* Find(const OUString& rStr);
virtual ~SfxStyleSheetIterator();
bool SearchUsed() const { return bSearchUsed; }
protected:
SfxStyleSheetBasePool* pBasePool;
SfxStyleFamily nSearchFamily;
sal_uInt16 nMask;
private:
SVL_DLLPRIVATE bool IsTrivialSearch();
SfxStyleSheetBase* pAktStyle;
sal_uInt16 nAktPosition;
bool bSearchUsed;
friend class SfxStyleSheetBasePool;
};
typedef std::shared_ptr< SfxStyleSheetIterator > SfxStyleSheetIteratorPtr;
class SfxStyleSheetBasePool_Impl;
class SVL_DLLPUBLIC SfxStyleSheetBasePool: public SfxBroadcaster, public comphelper::OWeakTypeObject
{
friend class SfxStyleSheetIterator;
friend class SfxStyleSheetBase;
SfxStyleSheetBasePool_Impl *pImp;
protected:
SfxStyleSheetIterator& GetIterator_Impl();
OUString aAppName;
SfxItemPool& rPool;
SfxStyleFamily nSearchFamily;
sal_uInt16 nMask;
void ChangeParent( const OUString&, const OUString&, bool bVirtual = true );
virtual SfxStyleSheetBase* Create( const OUString&, SfxStyleFamily, sal_uInt16 );
virtual SfxStyleSheetBase* Create( const SfxStyleSheetBase& );
virtual ~SfxStyleSheetBasePool();
void StoreStyleSheet(rtl::Reference< SfxStyleSheetBase >);
/** Obtain the indexed style sheets.
*/
const svl::IndexedStyleSheets&
GetIndexedStyleSheets() const;
rtl::Reference<SfxStyleSheetBase>
GetStyleSheetByPositionInIndex(unsigned pos);
public:
SfxStyleSheetBasePool( SfxItemPool& );
SfxStyleSheetBasePool( const SfxStyleSheetBasePool& );
const OUString& GetAppName() const { return aAppName; }
SfxItemPool& GetPool() { return rPool;}
const SfxItemPool& GetPool() const { return rPool;}
virtual SfxStyleSheetIteratorPtr CreateIterator(SfxStyleFamily, sal_uInt16 nMask);
sal_uInt16 Count();
SfxStyleSheetBase* operator[](sal_uInt16 nIdx);
virtual SfxStyleSheetBase& Make(const OUString&,
SfxStyleFamily eFam,
sal_uInt16 nMask = SFXSTYLEBIT_ALL);
virtual void Remove( SfxStyleSheetBase* );
void Insert( SfxStyleSheetBase* );
void Clear();
SfxStyleSheetBasePool& operator=( const SfxStyleSheetBasePool& );
SfxStyleSheetBasePool& operator+=( const SfxStyleSheetBasePool& );
SfxStyleSheetBase* First();
SfxStyleSheetBase* Next();
virtual SfxStyleSheetBase* Find( const OUString&, SfxStyleFamily eFam, sal_uInt16 n=SFXSTYLEBIT_ALL );
virtual bool SetParent(SfxStyleFamily eFam,
const OUString &rStyle,
const OUString &rParent);
SfxStyleSheetBase* Find(const OUString& rStr)
{ return Find(rStr, nSearchFamily, nMask); }
void SetSearchMask(SfxStyleFamily eFam, sal_uInt16 n=SFXSTYLEBIT_ALL );
sal_uInt16 GetSearchMask() const { return nMask;}
SfxStyleFamily GetSearchFamily() const { return nSearchFamily; }
void Reindex();
/** Add a style sheet.
* Not an actual public function. Do not call it from non-subclasses.
*/
SfxStyleSheetBase& Add( const SfxStyleSheetBase& );
};
class SVL_DLLPUBLIC SfxStyleSheet: public SfxStyleSheetBase,
public SfxListener, public SfxBroadcaster, public svl::StyleSheetUser
{
public:
TYPEINFO_OVERRIDE();
SfxStyleSheet( const OUString&, const SfxStyleSheetBasePool&, SfxStyleFamily, sal_uInt16 );
SfxStyleSheet( const SfxStyleSheet& );
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) SAL_OVERRIDE;
virtual bool isUsedByModel() const SAL_OVERRIDE;
virtual bool SetParent( const OUString& ) SAL_OVERRIDE;
protected:
SfxStyleSheet() // do not use! needed by MSVC at compile time to satisfy ImplInheritanceHelper2
: SfxStyleSheetBase(OUString("dummy"), NULL, SFX_STYLE_FAMILY_ALL, 0)
{
assert(false);
}
virtual ~SfxStyleSheet();
};
class SVL_DLLPUBLIC SfxStyleSheetPool: public SfxStyleSheetBasePool
{
protected:
using SfxStyleSheetBasePool::Create;
virtual SfxStyleSheetBase* Create(const OUString&, SfxStyleFamily, sal_uInt16 mask) SAL_OVERRIDE;
public:
SfxStyleSheetPool( SfxItemPool const& );
};
enum SfxStyleSheetHintId
{
CREATED = 1, // new
MODIFIED = 2, // changed
CHANGED = 3, // erased and re-created (replaced)
ERASED = 4, // erased
INDESTRUCTION = 5, // in the process of being destructed
};
class SVL_DLLPUBLIC SfxStyleSheetPoolHint : public SfxHint
{
public:
SfxStyleSheetPoolHint(SfxStyleSheetHintId ) {}
};
class SVL_DLLPUBLIC SfxStyleSheetHint: public SfxHint
{
SfxStyleSheetBase* pStyleSh;
sal_uInt16 nHint;
public:
SfxStyleSheetHint( sal_uInt16, SfxStyleSheetBase& );
SfxStyleSheetBase* GetStyleSheet() const
{ return pStyleSh; }
sal_uInt16 GetHint() const
{ return nHint; }
};
class SVL_DLLPUBLIC SfxStyleSheetHintExtended: public SfxStyleSheetHint
{
OUString aName;
public:
SfxStyleSheetHintExtended( sal_uInt16, const OUString& rOld,
SfxStyleSheetBase& );
const OUString& GetOldName() const { return aName; }
};
class SVL_DLLPUBLIC SfxUnoStyleSheet : public ::cppu::ImplInheritanceHelper2< SfxStyleSheet, ::com::sun::star::style::XStyle, ::com::sun::star::lang::XUnoTunnel >
{
public:
SfxUnoStyleSheet( const OUString& _rName, const SfxStyleSheetBasePool& _rPool, SfxStyleFamily _eFamily, sal_uInt16 _nMaske );
static SfxUnoStyleSheet* getUnoStyleSheet( const ::com::sun::star::uno::Reference< ::com::sun::star::style::XStyle >& xStyle );
// XUnoTunnel
virtual ::sal_Int64 SAL_CALL getSomething( const ::com::sun::star::uno::Sequence< ::sal_Int8 >& aIdentifier ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
private:
SfxUnoStyleSheet(); // not implemented
static const ::com::sun::star::uno::Sequence< ::sal_Int8 >& getIdentifier();
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|