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
|
/* -*- 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_FRAMEWORK_INC_CLASSES_PROPERTYSETHELPER_HXX
#define INCLUDED_FRAMEWORK_INC_CLASSES_PROPERTYSETHELPER_HXX
#include <threadhelp/transactionbase.hxx>
#include <general.h>
#include <stdtypes.h>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/beans/XPropertySetInfo.hpp>
#include <com/sun/star/beans/PropertyExistException.hpp>
#include <com/sun/star/beans/UnknownPropertyException.hpp>
#include <cppuhelper/weakref.hxx>
#include <fwidllapi.h>
namespace framework{
/** supports the API XPropertySet and XPropertySetInfo.
*
* It must be used as baseclass. The internal list of supported
* properties can be changed every time so dynamic property set's
* can be implemented.
*
* Further the derived and this base class share the same lock.
* So it's possible to be threadsafe if it's needed.
*/
class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet
, public css::beans::XPropertySetInfo
{
/* types */
protected:
typedef BaseHash< css::beans::Property > TPropInfoHash;
/* member */
protected:
PropertySetHelper::TPropInfoHash m_lProps;
ListenerHash m_lSimpleChangeListener;
ListenerHash m_lVetoChangeListener;
bool m_bReleaseLockOnCall;
// hold it weak ... otherwise this helper has to be "killed" explicitly .-)
css::uno::WeakReference< css::uno::XInterface > m_xBroadcaster;
TransactionManager& m_rTransactionManager;
/* native interface */
public:
/** initialize new instance of this helper.
*
* @param pExternalTransactionManager
* this helper must be used as a baseclass ...
* but then it should synchronize its own calls
* with the same transaction manager then it's superclass.
*
* @param bReleaseLockOnCall
* see member m_bReleaseLockOnCall
*/
PropertySetHelper( osl::Mutex & mutex,
TransactionManager* pExternalTransactionManager ,
bool bReleaseLockOnCall );
/** free all needed memory.
*/
virtual ~PropertySetHelper();
/** set a new owner for this helper.
*
* This owner is used as source for all broadcasted events.
* Further we hold it weak, because we dont wish to be disposed() .-)
*/
void impl_setPropertyChangeBroadcaster(const css::uno::Reference< css::uno::XInterface >& xBroadcaster);
/** add a new property info to the set of supported ones.
*
* @param aProperty
* describes the new property.
*
* @throw [com::sun::star::beans::PropertyExistException]
* if a property with the same name already exists.
*
* Note: The consistence of the whole set of properties is not checked here.
* Means e.g. ... a handle which exists more then once is not detected.
* The owner of this class has to be sure, that every new property does
* not clash with any existing one.
*/
virtual void SAL_CALL impl_addPropertyInfo(const css::beans::Property& aProperty)
throw(css::beans::PropertyExistException,
css::uno::Exception );
/** remove an existing property info from the set of supported ones.
*
* @param sProperty
* the name of the property.
*
* @throw [com::sun::star::beans::UnknownPropertyException]
* if no property with the specified name exists.
*/
virtual void SAL_CALL impl_removePropertyInfo(const OUString& sProperty)
throw(css::beans::UnknownPropertyException,
css::uno::Exception );
/** mark the object as "useable for working" or "dead".
*
* This correspond to the lifetime handling implemented by the base class TransactionBase.
* There is no chance to reactive a "dead" object by calling impl_enablePropertySet()
* again!
*/
virtual void SAL_CALL impl_enablePropertySet();
virtual void SAL_CALL impl_disablePropertySet();
/**
*/
virtual void SAL_CALL impl_setPropertyValue(const OUString& sProperty,
sal_Int32 nHandle ,
const css::uno::Any& aValue ) = 0;
virtual css::uno::Any SAL_CALL impl_getPropertyValue(const OUString& sProperty,
sal_Int32 nHandle ) = 0;
/* uno interface */
public:
// XPropertySet
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo()
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL setPropertyValue(const OUString& sProperty,
const css::uno::Any& aValue )
throw(css::beans::UnknownPropertyException,
css::beans::PropertyVetoException ,
css::lang::IllegalArgumentException ,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual css::uno::Any SAL_CALL getPropertyValue(const OUString& sProperty)
throw(css::beans::UnknownPropertyException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL addPropertyChangeListener(const OUString& sProperty,
const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener)
throw(css::beans::UnknownPropertyException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL removePropertyChangeListener(const OUString& sProperty,
const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener)
throw(css::beans::UnknownPropertyException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL addVetoableChangeListener(const OUString& sProperty,
const css::uno::Reference< css::beans::XVetoableChangeListener >& xListener)
throw(css::beans::UnknownPropertyException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL removeVetoableChangeListener(const OUString& sProperty,
const css::uno::Reference< css::beans::XVetoableChangeListener >& xListener)
throw(css::beans::UnknownPropertyException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// XPropertySetInfo
virtual css::uno::Sequence< css::beans::Property > SAL_CALL getProperties()
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual css::beans::Property SAL_CALL getPropertyByName(const OUString& sName)
throw(css::beans::UnknownPropertyException,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL hasPropertyByName(const OUString& sName)
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/* internal helper */
private:
bool impl_existsVeto(const css::beans::PropertyChangeEvent& aEvent);
void impl_notifyChangeListener(const css::beans::PropertyChangeEvent& aEvent);
};
} // namespace framework
#endif // INCLUDED_FRAMEWORK_INC_CLASSES_PROPERTYSETHELPER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
