Line data Source code
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 : #ifndef INCLUDED_SVL_POOLITEM_HXX
20 : #define INCLUDED_SVL_POOLITEM_HXX
21 :
22 : #include <svl/svldllapi.h>
23 : #include <com/sun/star/uno/Any.hxx>
24 :
25 : #include <sal/config.h>
26 : #include <tools/rtti.hxx>
27 : #include <limits.h>
28 : #include <tools/solar.h>
29 : #include <tools/debug.hxx>
30 : #include <svl/hint.hxx>
31 :
32 : class SbxVariable;
33 : class SbxObject;
34 : class SvStream;
35 : class Color;
36 : class IntlWrapper;
37 :
38 : namespace com { namespace sun { namespace star { namespace uno { class Any; } } } }
39 :
40 : enum SfxItemKind {
41 : SFX_ITEMS_NONE,
42 : SFX_ITEMS_DELETEONIDLE,
43 : SFX_ITEMS_STATICDEFAULT,
44 : SFX_ITEMS_POOLDEFAULT
45 : };
46 :
47 : #define SFX_ITEMS_OLD_MAXREF 0xffef
48 : #define SFX_ITEMS_MAXREF 0xfffffffe
49 : #define SFX_ITEMS_SPECIAL 0xffffffff
50 :
51 : #define CONVERT_TWIPS 0x80 //Uno-Konvertierung fuer Massangaben (fuer MemberId)
52 :
53 :
54 :
55 : // UNO3 shortcuts
56 :
57 : // warning, if there is no boolean inside the any this will always return the value false
58 40928 : inline bool Any2Bool( const ::com::sun::star::uno::Any&rValue )
59 : {
60 40928 : bool nValue = false;
61 40928 : if( rValue.hasValue() )
62 : {
63 40928 : if( rValue.getValueType() == ::getCppuBooleanType() )
64 : {
65 40928 : nValue = *(sal_Bool*)rValue.getValue();
66 : }
67 : else
68 : {
69 0 : sal_Int32 nNum = 0;
70 0 : if( rValue >>= nNum )
71 0 : nValue = nNum != 0;
72 : }
73 : }
74 :
75 40928 : return nValue;
76 : }
77 :
78 9402 : inline ::com::sun::star::uno::Any Bool2Any( bool bValue )
79 : {
80 9402 : return ::com::sun::star::uno::Any( &bValue, ::getCppuBooleanType() );
81 : }
82 :
83 :
84 :
85 : //! Notloesung!!!
86 : enum SfxFieldUnit
87 : {
88 : SFX_FUNIT_NONE, SFX_FUNIT_TWIP
89 : };
90 :
91 : enum SfxMapUnit
92 : {
93 : SFX_MAPUNIT_100TH_MM,
94 : SFX_MAPUNIT_10TH_MM,
95 : SFX_MAPUNIT_MM,
96 : SFX_MAPUNIT_CM,
97 : SFX_MAPUNIT_1000TH_INCH,
98 : SFX_MAPUNIT_100TH_INCH,
99 : SFX_MAPUNIT_10TH_INCH,
100 : SFX_MAPUNIT_INCH,
101 : SFX_MAPUNIT_POINT,
102 : SFX_MAPUNIT_TWIP,
103 : SFX_MAPUNIT_PIXEL,
104 : SFX_MAPUNIT_SYSFONT,
105 : SFX_MAPUNIT_APPFONT,
106 : SFX_MAPUNIT_RELATIVE,
107 : SFX_MAPUNIT_ABSOLUTE
108 : };
109 :
110 :
111 :
112 : enum SfxItemPresentation
113 :
114 : /* [Beschreibung]
115 :
116 : Die Werte dieses Enums bezeichnen den Grad der textuellen
117 : Presentation eines Items nach Aufruf der virtuellen Methode
118 : <SfxPoolItem::GetPresentation()const>.
119 : */
120 :
121 : {
122 : SFX_ITEM_PRESENTATION_NAMELESS,
123 : SFX_ITEM_PRESENTATION_COMPLETE
124 : };
125 :
126 :
127 :
128 : enum class SfxItemState {
129 : // These values have to match the values in the com::sun::star::frame::status::ItemState IDL
130 : UNKNOWN = 0,
131 : DISABLED = 0x0001,
132 : READONLY = 0x0002,
133 : DONTCARE = 0x0010,
134 : DEFAULT = 0x0020,
135 : SET = 0x0030
136 : };
137 :
138 : class SvXMLUnitConverter;
139 : class SfxItemPool;
140 : class SfxItemSet;
141 :
142 :
143 :
144 :
145 : class SVL_DLLPUBLIC SfxPoolItem
146 : {
147 : friend class SfxItemPool;
148 : friend class SfxItemDisruptor_Impl;
149 : friend class SfxItemPoolCache;
150 : friend class SfxItemSet;
151 : friend class SfxVoidItem;
152 :
153 : mutable sal_uLong m_nRefCount;
154 : sal_uInt16 m_nWhich;
155 : SfxItemKind m_nKind;
156 :
157 : private:
158 : inline void SetRefCount( sal_uLong n );
159 : inline void SetKind( SfxItemKind n );
160 : public:
161 : inline void AddRef( sal_uLong n = 1 ) const;
162 : private:
163 : inline sal_uLong ReleaseRef( sal_uLong n = 1 ) const;
164 :
165 : protected:
166 : explicit SfxPoolItem( sal_uInt16 nWhich = 0 );
167 : SfxPoolItem( const SfxPoolItem& );
168 :
169 : public:
170 : TYPEINFO();
171 : virtual ~SfxPoolItem();
172 :
173 8072477 : void SetWhich( sal_uInt16 nId ) { m_nWhich = nId; }
174 231701690 : sal_uInt16 Which() const { return m_nWhich; }
175 : virtual bool operator==( const SfxPoolItem& ) const = 0;
176 356435 : bool operator!=( const SfxPoolItem& rItem ) const
177 356435 : { return !(*this == rItem); }
178 : virtual int Compare( const SfxPoolItem &rWith ) const;
179 : virtual int Compare( const SfxPoolItem &rWith, const IntlWrapper& rIntlWrapper ) const;
180 :
181 : /** @return true if it has a valid string representation */
182 : virtual bool GetPresentation( SfxItemPresentation ePresentation,
183 : SfxMapUnit eCoreMetric,
184 : SfxMapUnit ePresentationMetric,
185 : OUString &rText,
186 : const IntlWrapper * pIntlWrapper = 0 ) const;
187 :
188 : virtual sal_uInt16 GetVersion( sal_uInt16 nFileFormatVersion ) const;
189 : virtual bool ScaleMetrics( long lMult, long lDiv );
190 : virtual bool HasMetrics() const;
191 :
192 : virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const;
193 : virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 );
194 :
195 : virtual SfxPoolItem* Create( SvStream &, sal_uInt16 nItemVersion ) const;
196 : virtual SvStream& Store( SvStream &, sal_uInt16 nItemVersion ) const;
197 : virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const = 0;
198 :
199 115293099 : sal_uLong GetRefCount() const { return m_nRefCount; }
200 132850340 : inline SfxItemKind GetKind() const { return m_nKind; }
201 :
202 : private:
203 : SfxPoolItem& operator=( const SfxPoolItem& ); // not implemented!!
204 : };
205 :
206 :
207 :
208 2352989 : inline void SfxPoolItem::SetRefCount( sal_uLong n )
209 : {
210 2352989 : m_nRefCount = n;
211 2352989 : m_nKind = SFX_ITEMS_NONE;
212 2352989 : }
213 :
214 8292742 : inline void SfxPoolItem::SetKind( SfxItemKind n )
215 : {
216 8292742 : m_nRefCount = SFX_ITEMS_SPECIAL;
217 8292742 : m_nKind = n;
218 8292742 : }
219 :
220 51957626 : inline void SfxPoolItem::AddRef( sal_uLong n ) const
221 : {
222 : DBG_ASSERT(m_nRefCount <= SFX_ITEMS_MAXREF, "AddRef with non-Pool-Item");
223 : DBG_ASSERT(ULONG_MAX - m_nRefCount > n, "AddRef: refcount overflow");
224 51957626 : m_nRefCount += n;
225 51957626 : }
226 :
227 51881335 : inline sal_uLong SfxPoolItem::ReleaseRef( sal_uLong n ) const
228 : {
229 : DBG_ASSERT(m_nRefCount <= SFX_ITEMS_MAXREF, "AddRef with non-Pool-Item");
230 : DBG_ASSERT(m_nRefCount >= n, "AddRef: refcount underflow");
231 51881335 : m_nRefCount -= n;
232 51881335 : return m_nRefCount;
233 : }
234 :
235 :
236 :
237 2463298 : inline bool IsPoolDefaultItem(const SfxPoolItem *pItem )
238 : {
239 2463298 : return pItem && pItem->GetKind() == SFX_ITEMS_POOLDEFAULT;
240 : }
241 :
242 25498169 : inline bool IsStaticDefaultItem(const SfxPoolItem *pItem )
243 : {
244 25498169 : return pItem && pItem->GetKind() == SFX_ITEMS_STATICDEFAULT;
245 : }
246 :
247 46560439 : inline bool IsDefaultItem( const SfxPoolItem *pItem )
248 : {
249 46560439 : return pItem && (pItem->GetKind() == SFX_ITEMS_STATICDEFAULT || pItem->GetKind() == SFX_ITEMS_POOLDEFAULT);
250 : }
251 :
252 25146634 : inline bool IsPooledItem( const SfxPoolItem *pItem )
253 : {
254 25146634 : return pItem && pItem->GetRefCount() > 0 && pItem->GetRefCount() <= SFX_ITEMS_MAXREF;
255 : }
256 :
257 149512137 : inline bool IsInvalidItem(const SfxPoolItem *pItem)
258 : {
259 149512137 : return pItem == reinterpret_cast<SfxPoolItem *>(-1);
260 : }
261 :
262 :
263 :
264 : class SVL_DLLPUBLIC SfxVoidItem: public SfxPoolItem
265 : {
266 : SfxVoidItem & operator=( const SfxVoidItem& ); // not implemented.
267 : public:
268 : TYPEINFO_OVERRIDE();
269 : explicit SfxVoidItem( sal_uInt16 nWhich );
270 : SfxVoidItem( sal_uInt16 nWhich, SvStream & );
271 : SfxVoidItem( const SfxVoidItem& );
272 : virtual ~SfxVoidItem();
273 :
274 : virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
275 :
276 : virtual bool GetPresentation( SfxItemPresentation ePres,
277 : SfxMapUnit eCoreMetric,
278 : SfxMapUnit ePresMetric,
279 : OUString &rText,
280 : const IntlWrapper * = 0 ) const SAL_OVERRIDE;
281 :
282 : // create a copy of itself
283 : virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
284 : void SetWhich(sal_uInt16 nWh) { m_nWhich = nWh; }
285 : };
286 :
287 :
288 :
289 : class SVL_DLLPUBLIC SfxSetItem: public SfxPoolItem
290 : {
291 : SfxItemSet *pSet;
292 :
293 : SfxSetItem & operator=( const SfxSetItem& ); // not implemented.
294 :
295 : public:
296 : TYPEINFO_OVERRIDE();
297 : SfxSetItem( sal_uInt16 nWhich, SfxItemSet *pSet );
298 : SfxSetItem( sal_uInt16 nWhich, const SfxItemSet &rSet );
299 : SfxSetItem( const SfxSetItem&, SfxItemPool *pPool = 0 );
300 : virtual ~SfxSetItem();
301 :
302 : virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
303 :
304 : virtual bool GetPresentation( SfxItemPresentation ePres,
305 : SfxMapUnit eCoreMetric,
306 : SfxMapUnit ePresMetric,
307 : OUString &rText,
308 : const IntlWrapper * = 0 ) const SAL_OVERRIDE;
309 :
310 : // create a copy of itself
311 : virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE = 0;
312 : virtual SfxPoolItem* Create(SvStream &, sal_uInt16 nVersion) const SAL_OVERRIDE = 0;
313 : virtual SvStream& Store(SvStream &, sal_uInt16 nVer) const SAL_OVERRIDE;
314 :
315 97567072 : const SfxItemSet& GetItemSet() const
316 97567072 : { return *pSet; }
317 1034560 : SfxItemSet& GetItemSet()
318 1034560 : { return *pSet; }
319 : };
320 :
321 :
322 : // Handle class for PoolItems
323 :
324 : class SVL_DLLPUBLIC SfxItemHandle
325 : {
326 : sal_uInt16 *pRef;
327 : SfxPoolItem *pItem;
328 : public:
329 : explicit SfxItemHandle( SfxPoolItem& );
330 : SfxItemHandle( const SfxItemHandle& );
331 : ~SfxItemHandle();
332 :
333 : const SfxItemHandle &operator=(const SfxItemHandle &);
334 0 : const SfxPoolItem &GetItem() const { return *pItem; }
335 : };
336 :
337 :
338 :
339 0 : DECL_PTRHINT(SVL_DLLPUBLIC, SfxPoolItemHint, SfxPoolItem);
340 :
341 :
342 :
343 : #endif // INCLUDED_SVL_POOLITEM_HXX
344 :
345 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
