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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
/*************************************************************************
*
* $RCSfile: fapihelper.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: hr $ $Date: 2003-03-26 18:05:01 $
*
* 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 SC_FAPIHELPER_HXX
#define SC_FAPIHELPER_HXX
#ifndef _COM_SUN_STAR_UNO_ANY_HXX_
#include <com/sun/star/uno/Any.hxx>
#endif
#ifndef _COM_SUN_STAR_UNO_REFERENCE_HXX_
#include <com/sun/star/uno/Reference.hxx>
#endif
#ifndef _COM_SUN_STAR_UNO_SEQUENCE_HXX_
#include <com/sun/star/uno/Sequence.hxx>
#endif
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_
#include <com/sun/star/beans/XPropertySet.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_XMULTIPROPERTYSET_HPP_
#include <com/sun/star/beans/XMultiPropertySet.hpp>
#endif
#ifndef _TOOLS_DEBUG_HXX
#include <tools/debug.hxx>
#endif
#ifndef _COMPHELPER_TYPES_HXX_
#include <comphelper/types.hxx>
#endif
// ============================================================================
#define CSS ::com::sun::star
#define PROPNAME( constascii ) ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( constascii ) )
// Set properties =============================================================
/** Sets the value of an Any to an XPropertySet. The XPropertySet must be valid. */
void setPropAny(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xProp,
const ::rtl::OUString& rName,
const ::com::sun::star::uno::Any& rAny );
/** Template for setting values to an XPropertySet. The XPropertySet must be valid. */
template< typename Type >
inline void setPropValue(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xProp,
const ::rtl::OUString& rName,
const Type& rValue )
{
::setPropAny( xProp, rName, ::com::sun::star::uno::makeAny( rValue ) );
}
/** Sets a Boolean value to an XPropertySet. The XPropertySet must be valid. */
inline void setPropBool(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xProp,
const ::rtl::OUString& rName,
sal_Bool bValue )
{
::setPropAny( xProp, rName, ::comphelper::makeBoolAny( bValue ) );
}
/** Sets a string to an XPropertySet. The XPropertySet must be valid. */
inline void setPropString(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xProp,
const ::rtl::OUString& rName,
const String& rText )
{
::setPropValue( xProp, rName, ::rtl::OUString( rText ) );
}
// Get properties =============================================================
/** Puts the value of a property into an Any. The XPropertySet must be valid.
@return sal_True, if the Any could be filled. */
bool getPropAny(
::com::sun::star::uno::Any& rAny,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& rxProp,
const ::rtl::OUString& rName );
/** Template for getting data from a property. The XPropertySet must be valid.
@return true, if the struct could be filled. */
template< typename Type >
inline bool getPropValue(
Type& rValue,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& rxProp,
const ::rtl::OUString& rName )
{
::com::sun::star::uno::Any aAny;
return ::getPropAny( aAny, rxProp, rName ) && (aAny >>= rValue);
}
/** Gets a boolean value from an XPropertySet. The XPropertySet must be valid.
@return true, if the boolean could be filled. */
inline bool getPropBool(
bool& rbValue,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& rxProp,
const ::rtl::OUString& rName )
{
::com::sun::star::uno::Any aAny;
bool bRet = ::getPropAny( aAny, rxProp, rName ) && (aAny.getValueTypeClass() == ::com::sun::star::uno::TypeClass_BOOLEAN);
if( bRet )
rbValue = (*static_cast< const sal_Bool* >( aAny.getValue() ) == sal_True);
return bRet;
}
/** Gets a boolean value from an XPropertySet.
@descr The XPropertySet must be valid. This is the short version, it returns
false on a property with value sal_False and on error.
@return true = if the property contains sal_True; false = sal_False or error. */
inline bool getPropBool(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& rxProp,
const ::rtl::OUString& rName )
{
bool bRet;
return ::getPropBool( bRet, rxProp, rName ) && bRet;
}
// MultiPropertySets ==========================================================
/** Generic helper class for reading from and writing to XMultiPropertySets.
@descr Derived classes have to call the constructor with an array of ASCII
strings ordered alphabetically. Note: The correct order is required by the
XMultiPropertySet. It will not be checked here!
*/
class ScfMultiPSHelper
{
private:
typedef ::com::sun::star::uno::Sequence< ::rtl::OUString > OUStringVec;
typedef ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > AnyVec;
typedef ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySet > XPropertySetRef;
typedef ::com::sun::star::uno::Reference<
::com::sun::star::beans::XMultiPropertySet > XMultiPropertySetRef;
OUStringVec maNameSeq; /// Sequence of property names.
AnyVec maValueSeq; /// Sequence of property values.
public:
/** @param ppPropNames An array of ASCII property names.
@param nPropCount Count of property names contained in ppPropNames. */
ScfMultiPSHelper( const sal_Char** ppPropNames, sal_Int32 nPropCount );
/** Returns the property name. */
inline const ::rtl::OUString& getName( sal_Int32 nIndex ) const;
/** Returns a reference to the Any containing a property value. */
inline ::com::sun::star::uno::Any& getAny( sal_Int32 nIndex );
/** Reads all values from the XMultiPropertySet.
@descr Tries to read all properties from the XPropertySet, if the XMultiPropertySet is not valid.
@return true on success. */
bool getPropertyValues(
const XMultiPropertySetRef& xMultiPS,
const XPropertySetRef& xPropSet );
/** Applies all values to the XMultiPropertySet.
@descr Tries to set all properties to the XPropertySet, if the XMultiPropertySet is not valid.
@return true on success. */
bool setPropertyValues(
const XMultiPropertySetRef& xMultiPS,
const XPropertySetRef& xPropSet );
};
inline const ::rtl::OUString& ScfMultiPSHelper::getName( sal_Int32 nIndex ) const
{
DBG_ASSERT( (0 <= nIndex) && (nIndex < maNameSeq.getLength()), "ScfMultiPSHelper::getName - invalid index" );
return maNameSeq[ nIndex ];
}
inline ::com::sun::star::uno::Any& ScfMultiPSHelper::getAny( sal_Int32 nIndex )
{
DBG_ASSERT( (0 <= nIndex) && (nIndex < maValueSeq.getLength()), "ScfMultiPSHelper::getValue - invalid index" );
return maValueSeq[ nIndex ];
}
// ============================================================================
#endif
|
