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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: propertysetaccess.hxx,v $
* $Revision: 1.7 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef CONFIGMGR_API_PROPERTYSET_HXX_
#define CONFIGMGR_API_PROPERTYSET_HXX_
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/beans/XHierarchicalPropertySet.hpp>
#include <com/sun/star/beans/XMultiPropertySet.hpp>
#include <com/sun/star/beans/XMultiHierarchicalPropertySet.hpp>
#include <com/sun/star/beans/XPropertyState.hpp>
#include <com/sun/star/beans/XMultiPropertyStates.hpp>
#include <cppuhelper/implbase6.hxx>
namespace configmgr
{
/////////////////////////////////////////////////////////////////////////////////////////////
namespace css = ::com::sun::star;
namespace uno = css::uno;
namespace lang = css::lang;
namespace beans = css::beans;
using rtl::OUString;
namespace configapi
{
class NodeGroupAccess;
class NodeGroupInfoAccess;
}
/////////////////////////////////////////////////////////////////////////////////////////////
/** implements the interfaces supported by a group node, viewed as a property set
within the configuration tree.
<p> Is an interface adapter around <type scope='configmgr::configapi'>NodeGroup(Info)Access</type>.</p>
*/
class BasicPropertySet
: public ::cppu::ImplHelper6
< beans::XPropertySet
, beans::XMultiPropertySet
, beans::XHierarchicalPropertySet
, beans::XMultiHierarchicalPropertySet
, beans::XPropertyState
, beans::XMultiPropertyStates
>
{
protected:
// Constructors & Destructors
virtual ~BasicPropertySet() {}
public:
// getting Property Metadata
// XPropertySet & XMultiPropertySet
virtual uno::Reference< beans::XPropertySetInfo > SAL_CALL
getPropertySetInfo( )
throw(uno::RuntimeException);
// XHierarchicalPropertySet & XHierarchicalMultiPropertySet
virtual uno::Reference< beans::XHierarchicalPropertySetInfo > SAL_CALL
getHierarchicalPropertySetInfo( )
throw(uno::RuntimeException);
// setting values - may all throw (PropertyVeto)Exceptions on read-only property sets
// XPropertySet
virtual void SAL_CALL
setPropertyValue( const OUString& aPropertyName, const uno::Any& aValue )
throw(beans::UnknownPropertyException, beans::PropertyVetoException, lang::IllegalArgumentException,
lang::WrappedTargetException, uno::RuntimeException);
// XMultiPropertySet
virtual void SAL_CALL
setPropertyValues( const uno::Sequence< OUString >& PropertyNames, const uno::Sequence< uno::Any >& Values )
throw(beans::PropertyVetoException, lang::IllegalArgumentException,
lang::WrappedTargetException, uno::RuntimeException);
// XHierarchicalPropertySet
virtual void SAL_CALL
setHierarchicalPropertyValue( const OUString& aPropertyName, const uno::Any& aValue )
throw(beans::UnknownPropertyException, beans::PropertyVetoException, lang::IllegalArgumentException,
lang::WrappedTargetException, uno::RuntimeException);
// XMultiHierarchicalPropertySet
virtual void SAL_CALL
setHierarchicalPropertyValues( const uno::Sequence< OUString >& PropertyNames, const uno::Sequence< uno::Any >& Values )
throw(beans::PropertyVetoException, lang::IllegalArgumentException,
lang::WrappedTargetException, uno::RuntimeException);
// getting values
// XPropertySet
virtual uno::Any SAL_CALL
getPropertyValue( const OUString& PropertyName )
throw(beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException);
// XMultiPropertySet
virtual uno::Sequence< uno::Any > SAL_CALL
getPropertyValues( const uno::Sequence< OUString >& aPropertyNames )
throw(uno::RuntimeException);
// XHierarchicalPropertySet
virtual uno::Any SAL_CALL
getHierarchicalPropertyValue( const OUString& PropertyName )
throw(beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException);
// XMultiHierarchicalPropertySet
virtual uno::Sequence< uno::Any > SAL_CALL
getHierarchicalPropertyValues( const uno::Sequence< OUString >& aPropertyNames )
throw(uno::RuntimeException);
// adding listeners
// XPropertySet
virtual void SAL_CALL
addPropertyChangeListener( const OUString& aPropertyName, const uno::Reference< beans::XPropertyChangeListener >& xListener )
throw(beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException);
// XMultiPropertySet
virtual void SAL_CALL
addPropertiesChangeListener( const uno::Sequence< OUString >& aPropertyNames, const uno::Reference< beans::XPropertiesChangeListener >& xListener )
throw(uno::RuntimeException);
// removing listeners
// XPropertySet
virtual void SAL_CALL
removePropertyChangeListener( const OUString& aPropertyName, const uno::Reference< beans::XPropertyChangeListener >& aListener )
throw(beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException);
// XMultiPropertySet
virtual void SAL_CALL
removePropertiesChangeListener( const uno::Reference< beans::XPropertiesChangeListener >& Listener )
throw(uno::RuntimeException);
// SPECIAL: support for VetoableChangeListeners
// XPropertySet
virtual void SAL_CALL
addVetoableChangeListener( const OUString& PropertyName, const uno::Reference< beans::XVetoableChangeListener >& aListener )
throw(beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException);
virtual void SAL_CALL
removeVetoableChangeListener( const OUString& PropertyName, const uno::Reference< beans::XVetoableChangeListener >& aListener )
throw(beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException);
// SPECIAL: firePropertiesChangeEvent
// XMultiPropertySet
virtual void SAL_CALL
firePropertiesChangeEvent( const uno::Sequence< OUString >& aPropertyNames, const uno::Reference< beans::XPropertiesChangeListener >& xListener )
throw(uno::RuntimeException);
// XPropertyState
virtual beans::PropertyState SAL_CALL
getPropertyState( const OUString& PropertyName )
throw(beans::UnknownPropertyException, uno::RuntimeException);
// see below:
// virtual uno::Sequence< beans::PropertyState > SAL_CALL
// getPropertyStates( const uno::Sequence< OUString >& aPropertyName )
// throw(beans::UnknownPropertyException, uno::RuntimeException);
virtual void SAL_CALL
setPropertyToDefault( const OUString& PropertyName )
throw(beans::UnknownPropertyException, uno::RuntimeException);
virtual uno::Any SAL_CALL
getPropertyDefault( const OUString& aPropertyName )
throw(beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException);
// XMultiPropertyStates
virtual uno::Sequence< beans::PropertyState > SAL_CALL
getPropertyStates( const uno::Sequence< OUString >& aPropertyName )
throw (beans::UnknownPropertyException, uno::RuntimeException);
virtual void SAL_CALL
setAllPropertiesToDefault( )
throw (uno::RuntimeException);
virtual void SAL_CALL
setPropertiesToDefault( const uno::Sequence< OUString >& aPropertyNames )
throw (beans::UnknownPropertyException, uno::RuntimeException);
virtual uno::Sequence< uno::Any > SAL_CALL
getPropertyDefaults( const uno::Sequence< OUString >& aPropertyNames )
throw (beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException);
protected:
virtual configapi::NodeGroupInfoAccess& getNode() = 0;
configapi::NodeGroupAccess& getGroupNode();
virtual configapi::NodeGroupAccess* maybeGetUpdateAccess() = 0;
};
//--------------------------------------------------------------------------
}
#endif // CONFIGMGR_API_PROPERTYSET_HXX_
|
