1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski // MARKER(update_precomp.py): autogen include statement, do not remove
25*b1cdbd2cSJim Jagielski #include "precompiled_unotools.hxx"
26*b1cdbd2cSJim Jagielski #include <tools/debug.hxx>
27*b1cdbd2cSJim Jagielski
28*b1cdbd2cSJim Jagielski #include "unotools/propertysetinfo.hxx"
29*b1cdbd2cSJim Jagielski #include "unotools/propertysethelper.hxx"
30*b1cdbd2cSJim Jagielski
31*b1cdbd2cSJim Jagielski ///////////////////////////////////////////////////////////////////////
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski using namespace ::utl;
34*b1cdbd2cSJim Jagielski using namespace ::rtl;
35*b1cdbd2cSJim Jagielski using namespace ::com::sun::star;
36*b1cdbd2cSJim Jagielski using namespace ::com::sun::star::uno;
37*b1cdbd2cSJim Jagielski using namespace ::com::sun::star::beans;
38*b1cdbd2cSJim Jagielski using namespace ::com::sun::star::lang;
39*b1cdbd2cSJim Jagielski
40*b1cdbd2cSJim Jagielski namespace utl
41*b1cdbd2cSJim Jagielski {
42*b1cdbd2cSJim Jagielski class PropertySetHelperImpl
43*b1cdbd2cSJim Jagielski {
44*b1cdbd2cSJim Jagielski public:
45*b1cdbd2cSJim Jagielski PropertyMapEntry* find( const OUString& aName ) const throw();
46*b1cdbd2cSJim Jagielski
47*b1cdbd2cSJim Jagielski PropertySetInfo* mpInfo;
48*b1cdbd2cSJim Jagielski };
49*b1cdbd2cSJim Jagielski }
50*b1cdbd2cSJim Jagielski
find(const OUString & aName) const51*b1cdbd2cSJim Jagielski PropertyMapEntry* PropertySetHelperImpl::find( const OUString& aName ) const throw()
52*b1cdbd2cSJim Jagielski {
53*b1cdbd2cSJim Jagielski PropertyMap::const_iterator aIter = mpInfo->getPropertyMap()->find( aName );
54*b1cdbd2cSJim Jagielski
55*b1cdbd2cSJim Jagielski if( mpInfo->getPropertyMap()->end() != aIter )
56*b1cdbd2cSJim Jagielski {
57*b1cdbd2cSJim Jagielski return (*aIter).second;
58*b1cdbd2cSJim Jagielski }
59*b1cdbd2cSJim Jagielski else
60*b1cdbd2cSJim Jagielski {
61*b1cdbd2cSJim Jagielski return NULL;
62*b1cdbd2cSJim Jagielski }
63*b1cdbd2cSJim Jagielski }
64*b1cdbd2cSJim Jagielski
65*b1cdbd2cSJim Jagielski ///////////////////////////////////////////////////////////////////////
66*b1cdbd2cSJim Jagielski
PropertySetHelper(utl::PropertySetInfo * pInfo)67*b1cdbd2cSJim Jagielski PropertySetHelper::PropertySetHelper( utl::PropertySetInfo* pInfo ) throw()
68*b1cdbd2cSJim Jagielski {
69*b1cdbd2cSJim Jagielski mp = new PropertySetHelperImpl;
70*b1cdbd2cSJim Jagielski mp->mpInfo = pInfo;
71*b1cdbd2cSJim Jagielski pInfo->acquire();
72*b1cdbd2cSJim Jagielski }
73*b1cdbd2cSJim Jagielski
~PropertySetHelper()74*b1cdbd2cSJim Jagielski PropertySetHelper::~PropertySetHelper() throw()
75*b1cdbd2cSJim Jagielski {
76*b1cdbd2cSJim Jagielski mp->mpInfo->release();
77*b1cdbd2cSJim Jagielski delete mp;
78*b1cdbd2cSJim Jagielski }
79*b1cdbd2cSJim Jagielski
80*b1cdbd2cSJim Jagielski // XPropertySet
getPropertySetInfo()81*b1cdbd2cSJim Jagielski Reference< XPropertySetInfo > SAL_CALL PropertySetHelper::getPropertySetInfo( ) throw(RuntimeException)
82*b1cdbd2cSJim Jagielski {
83*b1cdbd2cSJim Jagielski return mp->mpInfo;
84*b1cdbd2cSJim Jagielski }
85*b1cdbd2cSJim Jagielski
setPropertyValue(const::rtl::OUString & aPropertyName,const Any & aValue)86*b1cdbd2cSJim Jagielski void SAL_CALL PropertySetHelper::setPropertyValue( const ::rtl::OUString& aPropertyName, const Any& aValue ) throw(UnknownPropertyException, PropertyVetoException, IllegalArgumentException, WrappedTargetException, RuntimeException)
87*b1cdbd2cSJim Jagielski {
88*b1cdbd2cSJim Jagielski PropertyMapEntry* aEntries[2];
89*b1cdbd2cSJim Jagielski aEntries[0] = mp->find( aPropertyName );
90*b1cdbd2cSJim Jagielski
91*b1cdbd2cSJim Jagielski if( NULL == aEntries[0] )
92*b1cdbd2cSJim Jagielski throw UnknownPropertyException();
93*b1cdbd2cSJim Jagielski
94*b1cdbd2cSJim Jagielski aEntries[1] = NULL;
95*b1cdbd2cSJim Jagielski
96*b1cdbd2cSJim Jagielski _setPropertyValues( (const PropertyMapEntry**)aEntries, &aValue );
97*b1cdbd2cSJim Jagielski }
98*b1cdbd2cSJim Jagielski
getPropertyValue(const::rtl::OUString & PropertyName)99*b1cdbd2cSJim Jagielski Any SAL_CALL PropertySetHelper::getPropertyValue( const ::rtl::OUString& PropertyName ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
100*b1cdbd2cSJim Jagielski {
101*b1cdbd2cSJim Jagielski PropertyMapEntry* aEntries[2];
102*b1cdbd2cSJim Jagielski aEntries[0] = mp->find( PropertyName );
103*b1cdbd2cSJim Jagielski
104*b1cdbd2cSJim Jagielski if( NULL == aEntries[0] )
105*b1cdbd2cSJim Jagielski throw UnknownPropertyException();
106*b1cdbd2cSJim Jagielski
107*b1cdbd2cSJim Jagielski aEntries[1] = NULL;
108*b1cdbd2cSJim Jagielski
109*b1cdbd2cSJim Jagielski Any aAny;
110*b1cdbd2cSJim Jagielski _getPropertyValues( (const PropertyMapEntry**)aEntries, &aAny );
111*b1cdbd2cSJim Jagielski
112*b1cdbd2cSJim Jagielski return aAny;
113*b1cdbd2cSJim Jagielski }
114*b1cdbd2cSJim Jagielski
addPropertyChangeListener(const::rtl::OUString &,const Reference<XPropertyChangeListener> &)115*b1cdbd2cSJim Jagielski void SAL_CALL PropertySetHelper::addPropertyChangeListener( const ::rtl::OUString& /*aPropertyName*/, const Reference< XPropertyChangeListener >& /*xListener*/ ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
116*b1cdbd2cSJim Jagielski {
117*b1cdbd2cSJim Jagielski // todo
118*b1cdbd2cSJim Jagielski }
119*b1cdbd2cSJim Jagielski
removePropertyChangeListener(const::rtl::OUString &,const Reference<XPropertyChangeListener> &)120*b1cdbd2cSJim Jagielski void SAL_CALL PropertySetHelper::removePropertyChangeListener( const ::rtl::OUString& /*aPropertyName*/, const Reference< XPropertyChangeListener >& /*aListener*/ ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
121*b1cdbd2cSJim Jagielski {
122*b1cdbd2cSJim Jagielski // todo
123*b1cdbd2cSJim Jagielski }
124*b1cdbd2cSJim Jagielski
addVetoableChangeListener(const::rtl::OUString &,const Reference<XVetoableChangeListener> &)125*b1cdbd2cSJim Jagielski void SAL_CALL PropertySetHelper::addVetoableChangeListener( const ::rtl::OUString& /*PropertyName*/, const Reference< XVetoableChangeListener >& /*aListener*/ ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
126*b1cdbd2cSJim Jagielski {
127*b1cdbd2cSJim Jagielski // todo
128*b1cdbd2cSJim Jagielski }
129*b1cdbd2cSJim Jagielski
removeVetoableChangeListener(const::rtl::OUString &,const Reference<XVetoableChangeListener> &)130*b1cdbd2cSJim Jagielski void SAL_CALL PropertySetHelper::removeVetoableChangeListener( const ::rtl::OUString& /*PropertyName*/, const Reference< XVetoableChangeListener >& /*aListener*/ ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
131*b1cdbd2cSJim Jagielski {
132*b1cdbd2cSJim Jagielski // todo
133*b1cdbd2cSJim Jagielski }
134*b1cdbd2cSJim Jagielski
135*b1cdbd2cSJim Jagielski // XMultiPropertySet
setPropertyValues(const Sequence<::rtl::OUString> & aPropertyNames,const Sequence<Any> & aValues)136*b1cdbd2cSJim Jagielski void SAL_CALL PropertySetHelper::setPropertyValues( const Sequence< ::rtl::OUString >& aPropertyNames, const Sequence< Any >& aValues ) throw(PropertyVetoException, IllegalArgumentException, WrappedTargetException, RuntimeException)
137*b1cdbd2cSJim Jagielski {
138*b1cdbd2cSJim Jagielski const sal_Int32 nCount = aPropertyNames.getLength();
139*b1cdbd2cSJim Jagielski
140*b1cdbd2cSJim Jagielski if( nCount != aValues.getLength() )
141*b1cdbd2cSJim Jagielski throw IllegalArgumentException();
142*b1cdbd2cSJim Jagielski
143*b1cdbd2cSJim Jagielski if( nCount )
144*b1cdbd2cSJim Jagielski {
145*b1cdbd2cSJim Jagielski PropertyMapEntry** pEntries = new PropertyMapEntry*[nCount+1];
146*b1cdbd2cSJim Jagielski const OUString* pNames = aPropertyNames.getConstArray();
147*b1cdbd2cSJim Jagielski
148*b1cdbd2cSJim Jagielski sal_Bool bUnknown = sal_False;
149*b1cdbd2cSJim Jagielski sal_Int32 n;
150*b1cdbd2cSJim Jagielski for( n = 0; !bUnknown && ( n < nCount ); n++, pNames++ )
151*b1cdbd2cSJim Jagielski {
152*b1cdbd2cSJim Jagielski pEntries[n] = mp->find( *pNames );
153*b1cdbd2cSJim Jagielski bUnknown = NULL == pEntries[n];
154*b1cdbd2cSJim Jagielski }
155*b1cdbd2cSJim Jagielski
156*b1cdbd2cSJim Jagielski if( !bUnknown )
157*b1cdbd2cSJim Jagielski _setPropertyValues( (const PropertyMapEntry**)pEntries, aValues.getConstArray() );
158*b1cdbd2cSJim Jagielski
159*b1cdbd2cSJim Jagielski delete [] pEntries;
160*b1cdbd2cSJim Jagielski
161*b1cdbd2cSJim Jagielski if( bUnknown )
162*b1cdbd2cSJim Jagielski throw UnknownPropertyException();
163*b1cdbd2cSJim Jagielski }
164*b1cdbd2cSJim Jagielski }
165*b1cdbd2cSJim Jagielski
getPropertyValues(const Sequence<::rtl::OUString> & aPropertyNames)166*b1cdbd2cSJim Jagielski Sequence< Any > SAL_CALL PropertySetHelper::getPropertyValues( const Sequence< ::rtl::OUString >& aPropertyNames ) throw(RuntimeException)
167*b1cdbd2cSJim Jagielski {
168*b1cdbd2cSJim Jagielski const sal_Int32 nCount = aPropertyNames.getLength();
169*b1cdbd2cSJim Jagielski
170*b1cdbd2cSJim Jagielski Sequence< Any > aValues;
171*b1cdbd2cSJim Jagielski if( nCount )
172*b1cdbd2cSJim Jagielski {
173*b1cdbd2cSJim Jagielski PropertyMapEntry** pEntries = new PropertyMapEntry*[nCount+1];
174*b1cdbd2cSJim Jagielski const OUString* pNames = aPropertyNames.getConstArray();
175*b1cdbd2cSJim Jagielski
176*b1cdbd2cSJim Jagielski sal_Bool bUnknown = sal_False;
177*b1cdbd2cSJim Jagielski sal_Int32 n;
178*b1cdbd2cSJim Jagielski for( n = 0; !bUnknown && ( n < nCount ); n++, pNames++ )
179*b1cdbd2cSJim Jagielski {
180*b1cdbd2cSJim Jagielski pEntries[n] = mp->find( *pNames );
181*b1cdbd2cSJim Jagielski bUnknown = NULL == pEntries[n];
182*b1cdbd2cSJim Jagielski }
183*b1cdbd2cSJim Jagielski
184*b1cdbd2cSJim Jagielski if( !bUnknown )
185*b1cdbd2cSJim Jagielski _getPropertyValues( (const PropertyMapEntry**)pEntries, aValues.getArray() );
186*b1cdbd2cSJim Jagielski
187*b1cdbd2cSJim Jagielski delete [] pEntries;
188*b1cdbd2cSJim Jagielski
189*b1cdbd2cSJim Jagielski if( bUnknown )
190*b1cdbd2cSJim Jagielski throw UnknownPropertyException();
191*b1cdbd2cSJim Jagielski }
192*b1cdbd2cSJim Jagielski
193*b1cdbd2cSJim Jagielski return aValues;
194*b1cdbd2cSJim Jagielski }
195*b1cdbd2cSJim Jagielski
addPropertiesChangeListener(const Sequence<::rtl::OUString> &,const Reference<XPropertiesChangeListener> &)196*b1cdbd2cSJim Jagielski void SAL_CALL PropertySetHelper::addPropertiesChangeListener( const Sequence< ::rtl::OUString >& /*aPropertyNames*/, const Reference< XPropertiesChangeListener >& /*xListener*/ ) throw(RuntimeException)
197*b1cdbd2cSJim Jagielski {
198*b1cdbd2cSJim Jagielski // todo
199*b1cdbd2cSJim Jagielski }
200*b1cdbd2cSJim Jagielski
removePropertiesChangeListener(const Reference<XPropertiesChangeListener> &)201*b1cdbd2cSJim Jagielski void SAL_CALL PropertySetHelper::removePropertiesChangeListener( const Reference< XPropertiesChangeListener >& /*xListener*/ ) throw(RuntimeException)
202*b1cdbd2cSJim Jagielski {
203*b1cdbd2cSJim Jagielski // todo
204*b1cdbd2cSJim Jagielski }
205*b1cdbd2cSJim Jagielski
firePropertiesChangeEvent(const Sequence<::rtl::OUString> &,const Reference<XPropertiesChangeListener> &)206*b1cdbd2cSJim Jagielski void SAL_CALL PropertySetHelper::firePropertiesChangeEvent( const Sequence< ::rtl::OUString >& /*aPropertyNames*/, const Reference< XPropertiesChangeListener >& /*xListener*/ ) throw(RuntimeException)
207*b1cdbd2cSJim Jagielski {
208*b1cdbd2cSJim Jagielski // todo
209*b1cdbd2cSJim Jagielski }
210*b1cdbd2cSJim Jagielski
211*b1cdbd2cSJim Jagielski // XPropertyState
getPropertyState(const::rtl::OUString & PropertyName)212*b1cdbd2cSJim Jagielski PropertyState SAL_CALL PropertySetHelper::getPropertyState( const ::rtl::OUString& PropertyName ) throw(UnknownPropertyException, RuntimeException)
213*b1cdbd2cSJim Jagielski {
214*b1cdbd2cSJim Jagielski PropertyMapEntry* aEntries[2];
215*b1cdbd2cSJim Jagielski
216*b1cdbd2cSJim Jagielski aEntries[0] = mp->find( PropertyName );
217*b1cdbd2cSJim Jagielski if( aEntries[0] == NULL )
218*b1cdbd2cSJim Jagielski throw UnknownPropertyException();
219*b1cdbd2cSJim Jagielski
220*b1cdbd2cSJim Jagielski aEntries[1] = NULL;
221*b1cdbd2cSJim Jagielski
222*b1cdbd2cSJim Jagielski PropertyState aState;
223*b1cdbd2cSJim Jagielski _getPropertyStates( (const PropertyMapEntry**)aEntries, &aState );
224*b1cdbd2cSJim Jagielski
225*b1cdbd2cSJim Jagielski return aState;
226*b1cdbd2cSJim Jagielski }
227*b1cdbd2cSJim Jagielski
getPropertyStates(const Sequence<::rtl::OUString> & aPropertyName)228*b1cdbd2cSJim Jagielski Sequence< PropertyState > SAL_CALL PropertySetHelper::getPropertyStates( const Sequence< ::rtl::OUString >& aPropertyName ) throw(UnknownPropertyException, RuntimeException)
229*b1cdbd2cSJim Jagielski {
230*b1cdbd2cSJim Jagielski const sal_Int32 nCount = aPropertyName.getLength();
231*b1cdbd2cSJim Jagielski
232*b1cdbd2cSJim Jagielski Sequence< PropertyState > aStates( nCount );
233*b1cdbd2cSJim Jagielski
234*b1cdbd2cSJim Jagielski if( nCount )
235*b1cdbd2cSJim Jagielski {
236*b1cdbd2cSJim Jagielski const OUString* pNames = aPropertyName.getConstArray();
237*b1cdbd2cSJim Jagielski
238*b1cdbd2cSJim Jagielski sal_Bool bUnknown = sal_False;
239*b1cdbd2cSJim Jagielski
240*b1cdbd2cSJim Jagielski PropertyMapEntry** pEntries = new PropertyMapEntry*[nCount+1];
241*b1cdbd2cSJim Jagielski
242*b1cdbd2cSJim Jagielski sal_Int32 n;
243*b1cdbd2cSJim Jagielski for( n = 0; !bUnknown && (n < nCount); n++, pNames++ )
244*b1cdbd2cSJim Jagielski {
245*b1cdbd2cSJim Jagielski pEntries[n] = mp->find( *pNames );
246*b1cdbd2cSJim Jagielski bUnknown = NULL == pEntries[n];
247*b1cdbd2cSJim Jagielski }
248*b1cdbd2cSJim Jagielski
249*b1cdbd2cSJim Jagielski pEntries[nCount] = NULL;
250*b1cdbd2cSJim Jagielski
251*b1cdbd2cSJim Jagielski if( !bUnknown )
252*b1cdbd2cSJim Jagielski _getPropertyStates( (const PropertyMapEntry**)pEntries, aStates.getArray() );
253*b1cdbd2cSJim Jagielski
254*b1cdbd2cSJim Jagielski delete [] pEntries;
255*b1cdbd2cSJim Jagielski
256*b1cdbd2cSJim Jagielski if( bUnknown )
257*b1cdbd2cSJim Jagielski throw UnknownPropertyException();
258*b1cdbd2cSJim Jagielski }
259*b1cdbd2cSJim Jagielski
260*b1cdbd2cSJim Jagielski return aStates;
261*b1cdbd2cSJim Jagielski }
262*b1cdbd2cSJim Jagielski
setPropertyToDefault(const::rtl::OUString & PropertyName)263*b1cdbd2cSJim Jagielski void SAL_CALL PropertySetHelper::setPropertyToDefault( const ::rtl::OUString& PropertyName ) throw(UnknownPropertyException, RuntimeException)
264*b1cdbd2cSJim Jagielski {
265*b1cdbd2cSJim Jagielski PropertyMapEntry *pEntry = mp->find( PropertyName );
266*b1cdbd2cSJim Jagielski if( NULL == pEntry )
267*b1cdbd2cSJim Jagielski throw UnknownPropertyException();
268*b1cdbd2cSJim Jagielski
269*b1cdbd2cSJim Jagielski _setPropertyToDefault( pEntry );
270*b1cdbd2cSJim Jagielski }
271*b1cdbd2cSJim Jagielski
getPropertyDefault(const::rtl::OUString & aPropertyName)272*b1cdbd2cSJim Jagielski Any SAL_CALL PropertySetHelper::getPropertyDefault( const ::rtl::OUString& aPropertyName ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
273*b1cdbd2cSJim Jagielski {
274*b1cdbd2cSJim Jagielski PropertyMapEntry* pEntry = mp->find( aPropertyName );
275*b1cdbd2cSJim Jagielski if( NULL == pEntry )
276*b1cdbd2cSJim Jagielski throw UnknownPropertyException();
277*b1cdbd2cSJim Jagielski
278*b1cdbd2cSJim Jagielski return _getPropertyDefault( pEntry );
279*b1cdbd2cSJim Jagielski }
280*b1cdbd2cSJim Jagielski
_getPropertyStates(const utl::PropertyMapEntry **,PropertyState *)281*b1cdbd2cSJim Jagielski void PropertySetHelper::_getPropertyStates( const utl::PropertyMapEntry** /*ppEntries*/, PropertyState* /*pStates*/ ) throw(UnknownPropertyException )
282*b1cdbd2cSJim Jagielski {
283*b1cdbd2cSJim Jagielski DBG_ERROR( "you have to implement this yourself!" );
284*b1cdbd2cSJim Jagielski }
285*b1cdbd2cSJim Jagielski
_setPropertyToDefault(const utl::PropertyMapEntry *)286*b1cdbd2cSJim Jagielski void PropertySetHelper::_setPropertyToDefault( const utl::PropertyMapEntry* /*pEntry*/ ) throw(UnknownPropertyException )
287*b1cdbd2cSJim Jagielski {
288*b1cdbd2cSJim Jagielski DBG_ERROR( "you have to implement this yourself!" );
289*b1cdbd2cSJim Jagielski }
290*b1cdbd2cSJim Jagielski
_getPropertyDefault(const utl::PropertyMapEntry *)291*b1cdbd2cSJim Jagielski Any PropertySetHelper::_getPropertyDefault( const utl::PropertyMapEntry* /*pEntry*/ ) throw(UnknownPropertyException, WrappedTargetException )
292*b1cdbd2cSJim Jagielski {
293*b1cdbd2cSJim Jagielski DBG_ERROR( "you have to implement this yourself!" );
294*b1cdbd2cSJim Jagielski
295*b1cdbd2cSJim Jagielski Any aAny;
296*b1cdbd2cSJim Jagielski return aAny;
297*b1cdbd2cSJim Jagielski }
298