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
|
/*************************************************************************
*
* $RCSfile: property.hxx,v $
*
* $Revision: 1.1.1.1 $
*
* last change: $Author: fs $ $Date: 2000-09-29 11:28:15 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _COMPHELPER_PROPERTY_HXX_
#define _COMPHELPER_PROPERTY_HXX_
#ifndef _CPPUHELPER_PROPTYPEHLP_HXX
#include <cppuhelper/proptypehlp.hxx>
#endif
#ifndef _COM_SUN_STAR_BEANS_PROPERTY_HPP_
#include <com/sun/star/beans/Property.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_
#include <com/sun/star/beans/XPropertySet.hpp>
#endif
//=========================================================================
//= property helper classes
//=========================================================================
//... namespace comphelper .......................................................
namespace comphelper
{
//.........................................................................
namespace starbeans = ::com::sun::star::beans;
namespace staruno = ::com::sun::star::uno;
/** compare two properties by name
*/
extern int
#if defined( WNT )
__cdecl
#endif
#if defined( ICC ) && defined( OS2 )
_Optlink
#endif
PropertyCompare( const void* pFirst, const void* pSecond);
//------------------------------------------------------------------
/// remove the property with the given name from the given sequence
void RemoveProperty(staruno::Sequence<starbeans::Property>& seqProps, const ::rtl::OUString& _rPropName);
//------------------------------------------------------------------
/** within the given property sequence, modify attributes of a special property
@param _rProps the sequence of properties to search in
@param _sPropName the name of the property which's attributes should be modified
@param _nAddAttrib the attributes which should be added
@param _nRemoveAttrib the attributes which should be removed
*/
void ModifyPropertyAttributes(staruno::Sequence<starbeans::Property>& _rProps, const ::rtl::OUString& _sPropName, sal_Int16 _nAddAttrib, sal_Int16 _nRemoveAttrib);
//------------------------------------------------------------------
/** check if the given set has the given property.
*/
sal_Bool hasProperty(const rtl::OUString& _rName, const staruno::Reference<starbeans::XPropertySet>& _rxSet);
//------------------------------------------------------------------
/** copy properties between property sets, in compliance with the property
attributes of the target object
*/
void copyProperties(const staruno::Reference<starbeans::XPropertySet>& _rxSource,
const staruno::Reference<starbeans::XPropertySet>& _rxDest);
//==================================================================
//= property conversion helpers
//==================================================================
/** helper for implementing ::cppu::OPropertySetHelper::convertFastPropertyValue
@param _rConvertedValue the conversion result (if successfull)
@param _rOldValue the old value of the property, calculated from _rCurrentValue
@param _rValueToSet the new value which is about to be set
@param _rCurrentValue the current value of the property
@return sal_True, if the value could be converted and has changed
sal_False, if the value could be converted and has not changed
@exception InvalidArgumentException thrown if the value could not be converted to the requested type (which is the template argument)
*/
template <class TYPE>
sal_Bool tryPropertyValue(staruno::Any& /*out*/_rConvertedValue, staruno::Any& /*out*/_rOldValue, const staruno::Any& _rValueToSet, const TYPE& _rCurrentValue)
{
sal_Bool bModified(sal_False);
TYPE aNewValue;
::cppu::convertPropertyValue(aNewValue, _rValueToSet);
if (aNewValue != _rCurrentValue)
{
_rConvertedValue <<= aNewValue;
_rOldValue <<= _rCurrentValue;
bModified = sal_True;
}
return bModified;
}
/** helper for implementing ::cppu::OPropertySetHelper::convertFastPropertyValue for boolean properties
@param _rConvertedValue the conversion result (if successfull)
@param _rOldValue the old value of the property, calculated from _rCurrentValue
@param _rValueToSet the new value which is about to be set
@param _rCurrentValue the current value of the property
@return sal_True, if the value could be converted and has changed
sal_False, if the value could be converted and has not changed
@exception InvalidArgumentException thrown if the value could not be converted to a boolean type
*/
inline sal_Bool tryPropertyValue(staruno::Any& /*out*/_rConvertedValue, staruno::Any& /*out*/_rOldValue, const staruno::Any& _rValueToSet, sal_Bool _bCurrentValue)
{
sal_Bool bModified(sal_False);
sal_Bool bNewValue;
::cppu::convertPropertyValue(bNewValue, _rValueToSet);
if (bNewValue != _bCurrentValue)
{
_rConvertedValue.setValue(&bNewValue, ::getBooleanCppuType());
_rOldValue.setValue(&_bCurrentValue, ::getBooleanCppuType());
bModified = sal_True;
}
return bModified;
}
/** helper for implementing ::cppu::OPropertySetHelper::convertFastPropertyValue
@param _rConvertedValue the conversion result (if successfull)
@param _rOldValue the old value of the property, calculated from _rCurrentValue
@param _rValueToSet the new value which is about to be set
@param _rCurrentValue the current value of the property
@param _rExpectedType the type which the property should have (if not void)
@return sal_True, if the value could be converted and has changed
sal_False, if the value could be converted and has not changed
@exception InvalidArgumentException thrown if the value could not be converted to the requested type (which is the template argument)
*/
sal_Bool tryPropertyValue(staruno::Any& _rConvertedValue, staruno::Any& _rOldValue, const staruno::Any& _rValueToSet, staruno::Any& _rCurrentValue, const staruno::Type& _rExpectedType);
//.........................................................................
}
//... namespace comphelper .......................................................
#endif // _COMPHELPER_PROPERTY_HXX_
|
